BlogJava-guangnian0412's BLOG-随笔分类-Jakarta Commons

[Commons Logging]使用一个抽象的Logging接口（From Jarkata Commons Cookbook 7.10）

guangnian — Mon, 24 Apr 2006 10:32:00 GMT

   （Jarkata 的 Commons Logging 包现在已经被用在几乎所有的开源项目之中，它可以使你开发的系统工作在不同的日志框架下，包括Sun的logging框架和Apache Log4j。现在Commons Logging + Apache Log4j 的身影是随处可见，Commons Logging 的易用与Log4j的强大功能形成了绝配。）

问题：
    你正在写一个可重用的代码库，而你不知道你的代码在哪里并且是如何工作的。你需要一个抽象的日志接口来写入日志信息，因为你不能确定Log4j或者是JDK 1.4 logging的存在性。

解决：
        通过Jakarta Commons Logging 的Log 接口来记录信息，然后依靠Commons Logging自身来决定在运行时使用哪种具体的日志框架。下面的代码使用了Log接口来记录trace，debug，info，warning，error和fatal信息：

1 import org.apache.commons.logging.LogFactory;
2 import org.apache.commons.logging.Log
3
4 Log log = LogFactory.getLog( "com.discursive.jccook.SomeApp" );
5
6 if( log.isTraceEnabled( ) ) {
7 log.trace( "This is a trace message" );
8 }
9
10 if( log.isDebugEnabled( ) ) {
11 log.debug( "This is a debug message" );
12 }
13
14 log.info( "This is an informational message" );
15
16 log.warn( "This is a warning" );
17
18 log.error( "This is an error" );
19
20 log.fatal( "This is fatal" );

      LogFactory.getInstance() 返回一个Log接口的具体实现，这个实现与底层具体的日志框架相对应。例如，如果你的系统是使用Apache Log4j ，一个Log4JLogger将被返回，对应于Log4J category com.discursive.jccook.SomeApp 。

讨论：
        一个可重用代码库的开发者不能预知其代码库将在何时何地被用到，而现在有很多的日志框架可以使用，所以当开发可重用代码库的时候，使用Commons Logging 是非常明智的，例如Jakarta Commons 组件。当调用LogFactory.getInstance()方法的时候，Commons Logging 将通过系统属性和classpath中的类库来决定和管理适当的日志框架。对于一个小型可重用组件的开发者来说，进行日志记录只需要调用Log接口。而配置底层日志框架的负担，就转移到使用其组件库的开发者身上。

参考：
        7.11节详细的说明了Commons Logging在运行时确定适当日志框架的算法。

guangnian 2006-04-24 18:32 发表评论

[HttpClient] 创建一个HTTP POST 请求 (from Jakarta Commons cookbook 11.7 )

guangnian — Tue, 11 Apr 2006 14:41:00 GMT

问题：
你需要使用HTTP POST 方法来向一个servlet传递参数。

讨论：
创建一个 PostMethod 对象，然后调用 setParameter() 或 addParameter() 方法设置参数。 PostMethod 对象将会传送一个 Content-Type 头为 application/x-www-form-urlencoded 的请求，并且参数将在请求body中被传送。在下列的例子中演示了用 PostMethod 对象传递参数的用法：

import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpException;
import org.apache.commons.httpclient.NameValuePair;
import org.apache.commons.httpclient.methods.PostMethod;

HttpClient client = new HttpClient( );

// Create POST method
String url = "http://www.discursive.com/cgi-bin/jccook/param_list.cgi";
PostMethod method = new PostMethod( url );

// Set parameters on POST
method.setParameter( "test1", "Hello World" );
method.addParameter( "test2", "This is a Form Submission" );
method.addParameter( "Blah", "Whoop" );
method.addParameter( new NameValuePair( "Blah", "Whoop2" ) );

// Execute and print response
client.executeMethod( method );
String response = method.getResponseBodyAsString( );
System.out.println( response );

method.releaseConnection( );

param_list.cgi CGI脚本会对所以接收到的参数进行回显，从下面的输出中，你可以看到传递给CGI脚本的三个参数：

These are the parameters I received:

test1:
  Hello World
test2:
  This is a Form Submission
Blah:
  Whoop
  Whoop2

有几种方法来在一个PostMethod对象中设置参数。最直接的方法就是调用setParameter()方法，并传递两个字符串给它：参数的名称和参数值。setParameter()方法将会替代任何已经存在的同名参数。但是，如果一个同名的参数已经存在一个PostMethod对象中，addParameter()将会加入另一个同名参数值；addParameter()方法同样接受两个String：参数名和参数值。另一种方法，这两个方法同样接受一个包装了参数名和参数值的NameValuePair对象。在前面的例子中，通过addParameter()方法，用参数名Blah传递了两个值，第一次用两个String作为参数，第二次用一个NameValuePair对象作为参数。

guangnian 2006-04-11 22:41 发表评论

[HttpClient] 在查询字符串中传送参数（from Jakarta Commons Cookbook 11。4）

guangnian — Tue, 04 Apr 2006 11:19:00 GMT

问题：
你需要在一个URL中传送查询参数。

解答：
使用一个HttpMethod实例的setQueryString()方法来设置查询字符串。使用URIUtil类对包含在URL中的文本进行编码。下面的例子在查询字符串中放入了两个参数：

1 import org.apache.commons.httpclient.HttpClient;
2 import org.apache.commons.httpclient.HttpException;
3 import org.apache.commons.httpclient.HttpMethod;
4 import org.apache.commons.httpclient.NameValuePair;
5 import org.apache.commons.httpclient.methods.GetMethod;
6 import org.apache.commons.httpclient.util.URIUtil;
7
8 HttpClient client = new HttpClient( );
9
10 String url = "http://www.discursive.com/cgi-bin/jccook/param_list.cgi";
11
12 HttpMethod method = new GetMethod( url );
13
14 // 用setQueryString()来设置查询字符串
15 method.setQueryString(URIUtil.encodeQuery("test1=O Reilly&blah=Whoop"));
16 System.out.println( "With Query String: " + method.getURI( ) );
17
18 client.executeMethod( method );
19
20 System.out.println( "Response:\n " + method.getResponseBodyAsString( ) );
21 method.releaseConnection( );

param_list.cgi CGI脚本只是简单的回显接收到的所以参数，在下面的输出中，你可以看到URIUtil如何对第一个参数进行编码：

With Query String: http://www.discursive.com/cgi-bin/jccook/param_list.cgi?test1=O%20Reilly&blah=Whoop
Response:
These are the parameters I received:

test1:
O Reilly
blah:
Whoop

提示：你不必在setQueryString()方法中加入？号，当HttpClient实例执行executeMethod()方法时，它会被自动加入。

讨论：
在前面的例子中，HttpMethod的setQueryString()方法是一次性将整个查询字符串加进去，但是还有另外一种选择：通过一个NameValuePair对象的数组来设置查询字符串。当一个NameValuePair[]传入setQueryString()方法中时，HttpMethod实例会从数组中取出每一个NameValuePair对象，然后创建一系列用&号分割的参数。这种方法使程序代码更加干净，因为你不必连接字符串来传递多个参数。下面的例子用NameValuePair对象，与前一个例子设置了同样的参数：

1 // 用NameValuePair对象设置查询参数
2 HttpMethod method = new GetMethod( url );
3 NameValuePair pair = new NameValuePair( "test1", URIUtil.encodeQuery( "O Reilly" ) );
4NameValuePair pair2 = new NameValuePair( "blah", URIUtil.encodeQuery( "Whoop" ) );
5NameValuePair[] pairs = new NameValuePair[] { pair, pair2 };
6method.setQueryString( pairs );
7System.out.println( "With NameValuePairs: " + method.getURI( ) );
8client.executeMethod( method );
9 System.out.println( "Response:\n " + method.getResponseBodyAsString( ) );
10method.releaseConnection( );

根据RFC1738，URL只能够包含字母和数字字符：[0-9,a-z,A-Z]和一些特殊字符。如果你需要在参数中传送一些URL所不允许的字符，你就需要对你的字符串进行编码，以符合RFC1738的规定。URIUtil类有一个方法encodeQuery()能够对前面例子中的"O Reilly"进行编码。下面的代码展示了用URIUtil类来对包含在URL中的字符串进行编码：

1 String encoded1 = URIUtil.encodeQuery( "=O'Connell" );
2 String encoded2 = URIUtil.encodeQuery( "one:two=thr ee#" );
3
4 String decoded = URIUtil.decode( "Hello%20World%3F" );
5
6 System.out.println( "Encoded: " + encoded1 );
7 System.out.println( "Encoded: " + encoded2 );
8 System.out.println( "Decoded: " + decoded );

这个简单的例子用URIUtil类对两个字符串进行了编码，并对一个经过编码的字符串进行解码。下面的输出展示了每个转换的结果：

Encoded: %3ctest%e3=O'Connell
Encoded: one%3atwo=thr%20ee#23
Decoded: Hello World?

参考：
        在这个例子中，URLUtil对传入的查询字符串的内容进行了编码。最近，HttpClient小组将一些URL编码和解码的逻辑代码移入了Jakarta Commons Codec项目中，对应的类名为URLCodec。需要URLCodec更多的信息，请参考 Jakarta Commons Codec项目主页（http://jakarta.apache.org/codec）。
         RFC1738讨论了URL中的合法字符，并规定了对其他字符进行编码的过程。RFC1738能够在http:// www.zvon.org/tmRFC/RFC2616/Output/index.html中找到。

guangnian 2006-04-04 19:19 发表评论

[HttpClient] 执行HTTP GET方法（from Jakarta Commons Cookbook 11。3）

guangnian — Mon, 03 Apr 2006 16:18:00 GMT

问题：
        你需要通过HTTP GET方法来获取信息。

解答：
        创建一个HttpClient实例，并调用以GetMethod对象为参数的executeMethod方法。然后，响应的内容就可以通过一个InputStream，byte[]，或者是String来获得。下面的例子将获得 http://www.discursive.com /jccook/的内容，并且以一个String来获得响应。

1 import org.apache.commons.httpclient.HttpClient;
2 import org.apache.commons.httpclient.HttpException;
3 import org.apache.commons.httpclient.HttpMethod;
4 import org.apache.commons.httpclient.methods.GetMethod;
5
6 HttpClient client = new HttpClient( );
7 String url = "http://www.discursive.com/jccook/";
8 HttpMethod method = new GetMethod( url );
9
10 try {
11     client.executeMethod( method );
12
13     if( method.getStatusCode( ) == HttpStatus.SC_OK ) {
14         String response = method.getResponseBodyAsString( );
15         System.out.println( response );
16     }
17 } catch( HttpException he ) {
18     System.out.println( "HTTP Problem: " + he.getMessage( ) );
19 } catch( IOException ioe ) {
20     System.out.println( "IO Exeception: " + ioe.getMessage( ) );
21 } finally {
22     method.releaseConnection( );
23     method.recycle( );
24 }

这段代码用HTTP GET方法获得了 http://www.discursive.com/jccook/的内容。如果响应的状态码是HttpStatus.SC_OK(即200），下列响应将被输出到控制台：

<html>
<head>
<title>JCCook Exampletitle>
head>
<body>
<h1>Hello World!h1>
body>
html>

讨论：
        注意这段代码中对异常的处理。执行一个简单的HTTP GET需要捕捉两个异常：HttpException和IOException。如果是发生HTTP协议错误时，将抛出HttpException异常;如果是发生有关网络的错误时，将抛出IOException异常。这一章后面的例子将会忽略对异常的处理。你应该要知道每一次调用executeMethod()都要用适当的try/catch块包裹。
        GetMethod类是HttpMethod接口的一种实现。HttpMethod会被HttpClient所调用。HttpMethod实现类的生命周期是很简单的：一个HttpMethod实例被创建，然后被HttpClient调用；一旦响应被检测到以后，HttpMethod释放连接并被回收使用。当HttpMethod调用了recycle()方法，相当于发送了一个信号给系统表示这个HttpMethod实例可以再被使用。releaseConnection()方法指示HttpClient释放掉与这个HttpMethod相关联的连接。无论在使用HttpMethod实例的过程中发生了什么，都要调用releaseConnection()来释放网络资源。
        一旦HttpClient的executeMethod方法被调用，你可以通过HttpMethod的getStatusCode()方法来获得响应的状态码。这个方法返回一个int，对应于HttpStatus类的public static final 变量。HttpStatus类还包括下面一些常量：SC_OK(200)，SC_NOT_FOUND(404)，SC_INTERNAL_SERVER_ERROR(500)，SC_MOVED_TEMPORARILY (302)，SC_UNAUTHORIZED(401)等等。请参照HttpStatus的Javadoc来获得所有的HTTP状态列表。当服务器返回一个错误的HTTP状态是，通常还会返回一小段信息。这一小段信息可以通过HttpMethod类的getStatusText()方法获得。

参考：
       可以从RFC2616（http://www.zvon.org/tmRFC/RFC2616/Output/index.html)获得HTTP GET方法的官方定义；
       要获得HTTP 状态码的完整列表，请参见 HttpStatus Javadoc (http://jakarta.apache.org/commons/ httpclient/apidocs/index.html）。

guangnian 2006-04-04 00:18 发表评论

Jakarta Commons Cookbook

guangnian — Mon, 03 Apr 2006 15:25:00 GMT

其实Jakarta Commons类库在Java中的地位是很重要的，它为Java程序员提供了很多可重用的工具。最近在看Jakarta Commons Cookbook 这本书，是英文版，忽然有想翻译它的冲动。就从我最近用到的HttpClient开始吧.......

guangnian 2006-04-03 23:25 发表评论