apache commons工具集代码详解
apache commons包含了很多开源的工具,用于解决平时编程经常会遇到的问题,减少重复劳动。下面是我这几年做开发过程中自己用过的工具类做简单介绍。
组件 | 功能介绍 |
beanutils | 提供了对于javabean进行各种操作,克隆对象,属性等等. |
betwixt | xml与java对象之间相互转换. |
codec | 处理常用的编码方法的工具类包 例如des、sha1、md5、base64等. |
collections | java集合框架操作. |
compress | java提供文件打包 压缩类库. |
configuration | 一个java应用程序的配置管理类库. |
dbcp | 提供数据库连接池服务. |
dbutils | 提供对jdbc 的操作封装来简化数据查询和记录读取操作. |
java发送邮件 对javamail的封装. | |
fileupload | 提供文件上传功能. |
httpclien | 提供http客户端与服务器的各种通讯操作. 现在已改成httpcomponents |
io | io工具的封装. |
lang | java基本对象方法的工具类包 如:stringutils,arrayutils等等. |
logging | 提供的是一个java 的日志接口. |
validator | 提供了客户端和服务器端的数据验证框架. |
1、beanutils 提供了对于javabean进行各种操作, 比如对象,属性复制等等。
//1、 克隆对象 // 新创建一个普通java bean,用来作为被克隆的对象 public class person { private string name = ""; private string email = ""; private int age; //省略 set,get方法 } // 再创建一个test类,其中在main方法中代码如下: import java.lang.reflect.invocationtargetexception; import java.util.hashmap; import java.util.map; import org.apache.commons.beanutils.beanutils; import org.apache.commons.beanutils.convertutils; public class test { /** * @param args */ public static void main(string[] args) { person person = new person(); person.setname("tom"); person.setage(21); try { //克隆 person person2 = (person)beanutils.clonebean(person); system.out.println(person2.getname()+">>"+person2.getage()); } catch (illegalaccessexception e) { e.printstacktrace(); } catch (instantiationexception e) { e.printstacktrace(); } catch (invocationtargetexception e) { e.printstacktrace(); } catch (nosuchmethodexception e) { e.printstacktrace(); } } } // 原理也是通过java的反射机制来做的。 // 2、 将一个map对象转化为一个bean // 这个map对象的key必须与bean的属性相对应。 map map = new hashmap(); map.put("name","tom"); map.put("email","tom@"); map.put("age","21"); //将map转化为一个person对象 person person = new person(); beanutils.populate(person,map); // 通过上面的一行代码,此时person的属性就已经具有了上面所赋的值了。 // 将一个bean转化为一个map对象了,如下: map map = beanutils.describe(person)
2、betwixt xml与java对象之间相互转换。
//1、 将javabean转为xml内容 // 新创建一个person类 public class person{ private string name; private int age; /** need to allow bean to be created via reflection */ public personbean() { } public personbean(string name, int age) { this.name = name; this.age = age; } //省略set, get方法 public string tostring() { return "personbean[name='" + name + "',age='" + age + "']"; } } //再创建一个writeapp类: import java.io.stringwriter; import org.apache.commons.betwixt.io.beanwriter; public class writeapp { /** * 创建一个例子bean,并将它转化为xml. */ public static final void main(string [] args) throws exception { // 先创建一个stringwriter,我们将把它写入为一个字符串 stringwriter outputwriter = new stringwriter(); // betwixt在这里仅仅是将bean写入为一个片断 // 所以如果要想完整的xml内容,我们应该写入头格式 outputwriter.write(“<?xml version='1.0′ encoding='utf-8′ ?>\n”); // 创建一个beanwriter,其将写入到我们预备的stream中 beanwriter beanwriter = new beanwriter(outputwriter); // 配置betwixt // 更多详情请参考java docs 或最新的文档 beanwriter.getxmlintrospector().getconfiguration().setattributesforprimitives(false); beanwriter.getbindingconfiguration().setmapids(false); beanwriter.enableprettyprint(); // 如果这个地方不传入xml的根节点名,betwixt将自己猜测是什么 // 但是让我们将例子bean名作为根节点吧 beanwriter.write(“person”, new personbean(“john smith”, 21)); //输出结果 system.out.println(outputwriter.tostring()); // betwixt写的是片断而不是一个文档,所以不要自动的关闭掉writers或者streams, //但这里仅仅是一个例子,不会做更多事情,所以可以关掉 outputwriter.close(); } } //2、 将xml转化为javabean import java.io.stringreader; import org.apache.commons.betwixt.io.beanreader; public class readapp { public static final void main(string args[]) throws exception{ // 先创建一个xml,由于这里仅是作为例子,所以我们硬编码了一段xml内容 stringreader xmlreader = new stringreader( "<?xml version='1.0′ encoding='utf-8′ ?> <person><age>25</age><name>james smith</name></person>"); //创建beanreader beanreader beanreader = new beanreader(); //配置reader beanreader.getxmlintrospector().getconfiguration().setattributesforprimitives(false); beanreader.getbindingconfiguration().setmapids(false); //注册beans,以便betwixt知道xml将要被转化为一个什么bean beanreader.registerbeanclass("person", personbean.class); //现在我们对xml进行解析 personbean person = (personbean) beanreader.parse(xmlreader); //输出结果 system.out.println(person); } }
3、codec 提供了一些公共的编解码实现,比如base64, hex, md5,phonetic and urls等等。
//base64编解码 private static string encodetest(string str){ base64 base64 = new base64(); try { str = base64.encodetostring(str.getbytes("utf-8")); } catch (unsupportedencodingexception e) { e.printstacktrace(); } system.out.println("base64 编码后:"+str); return str; } private static void decodetest(string str){ base64 base64 = new base64(); //str = arrays.tostring(base64.decodebase64(str)); str = new string(base64.decodebase64(str)); system.out.println("base64 解码后:"+str); }
4、collections 对java.util的扩展封装,处理数据还是挺灵活的。
org.apache.commons.collections – commons collections自定义的一组公用的接口和工具类
org.apache.commons.collections.bag – 实现bag接口的一组类
org.apache.commons.collections.bidimap – 实现bidimap系列接口的一组类
org.apache.commons.collections.buffer – 实现buffer接口的一组类
org.apache.commons.collections.collection – 实现java.util.collection接口的一组类
org.apache.commons.collections.comparators – 实现java.util.comparator接口的一组类
org.apache.commons.collections.functors – commons collections自定义的一组功能类
org.apache.commons.collections.iterators – 实现java.util.iterator接口的一组类
org.apache.commons.collections.keyvalue – 实现集合和键/值映射相关的一组类
org.apache.commons.collections.list – 实现java.util.list接口的一组类
org.apache.commons.collections.map – 实现map系列接口的一组类
org.apache.commons.collections.set – 实现set系列接口的一组类
/** * 得到集合里按顺序存放的key之后的某一key */ orderedmap map = new linkedmap(); map.put("five", "5"); map.put("six", "6"); map.put("seven", "7"); map.firstkey(); // returns "five" map.nextkey("five"); // returns "six" map.nextkey("six"); // returns "seven" /** * 通过key得到value * 通过value得到key * 将map里的key和value对调 */ bidimap bidi = new treebidimap(); bidi.put("six", "6"); bidi.get("six"); // returns "6" bidi.getkey("6"); // returns "six" // bidi.removevalue("6"); // removes the mapping bidimap inverse = bidi.inversebidimap(); // returns a map with keys and values swapped system.out.println(inverse); /** * 得到两个集合中相同的元素 */ list<string> list1 = new arraylist<string>(); list1.add("1"); list1.add("2"); list1.add("3"); list<string> list2 = new arraylist<string>(); list2.add("2"); list2.add("3"); list2.add("5"); collection c = collectionutils.retainall(list1, list2); system.out.println(c);
5、compress commons compress中的打包、压缩类库。
//创建压缩对象 ziparchiveentry entry = new ziparchiveentry("compresstest"); //要压缩的文件 file f=new file("e:\\test.pdf"); fileinputstream fis=new fileinputstream(f); //输出的对象 压缩的文件 ziparchiveoutputstream zipoutput=new ziparchiveoutputstream(new file("e:\\test.zip")); zipoutput.putarchiveentry(entry); int i=0,j; while((j=fis.read()) != -1) { zipoutput.write(j); i++; system.out.println(i); } zipoutput.closearchiveentry(); zipoutput.close(); fis.close();
6、configuration 用来帮助处理配置文件的,支持很多种存储方式。
1. properties files
2. xml documents
3. property list files (.plist)
4. jndi
5. jdbc datasource
6. system properties
7. applet parameters
8. servlet parameters
//举一个properties的简单例子 # usergui.properties colors.background = #ffffff colors.foreground = #000080 window.width = 500 window.height = 300 propertiesconfiguration config = new propertiesconfiguration("usergui.properties"); config.setproperty("colors.background", "#000000); config.save(); config.save("usergui.backup.properties); //save a copy integer integer = config.getinteger("window.width");
7、dbcp (database connection pool)是一个依赖jakarta commons-pool对象池机制的数据库连接池,tomcat的数据源使用的就是dbcp。
import javax.sql.datasource; import java.sql.connection; import java.sql.statement; import java.sql.resultset; import java.sql.sqlexception; import org.apache.commons.pool.objectpool; import org.apache.commons.pool.impl.genericobjectpool; import org.apache.commons.dbcp.connectionfactory; import org.apache.commons.dbcp.poolingdatasource; import org.apache.commons.dbcp.poolableconnectionfactory; import org.apache.commons.dbcp.drivermanagerconnectionfactory; //官方示例 public class poolingdatasources { public static void main(string[] args) { system.out.println("加载jdbc驱动"); try { class.forname("oracle.jdbc.driver.oracledriver"); } catch (classnotfoundexception e) { e.printstacktrace(); } system.out.println("done."); // system.out.println("设置数据源"); datasource datasource = setupdatasource("jdbc:oracle:thin:@localhost:1521:test"); system.out.println("done."); // connection conn = null; statement stmt = null; resultset rset = null; try { system.out.println("creating connection."); conn = datasource.getconnection(); system.out.println("creating statement."); stmt = conn.createstatement(); system.out.println("executing statement."); rset = stmt.executequery("select * from person"); system.out.println("results:"); int numcols = rset.getmetadata().getcolumncount(); while(rset.next()) { for (int i=0;i<=numcols;i++) { system.out.print("\t" + rset.getstring(i)); } system.out.println(""); } } catch(sqlexception e) { e.printstacktrace(); } finally { try { if (rset != null) rset.close(); } catch(exception e) { } try { if (stmt != null) stmt.close(); } catch(exception e) { } try { if (conn != null) conn.close(); } catch(exception e) { } } } public static datasource setupdatasource(string connecturi) { //设置连接地址 connectionfactory connectionfactory = new drivermanagerconnectionfactory( connecturi, null); // 创建连接工厂 poolableconnectionfactory poolableconnectionfactory = new poolableconnectionfactory( connectionfactory); //获取genericobjectpool 连接的实例 objectpool connectionpool = new genericobjectpool( poolableconnectionfactory); // 创建 poolingdriver poolingdatasource datasource = new poolingdatasource(connectionpool); return datasource; } }
8、dbutilsapache组织提供的一个资源jdbc工具类库,它是对jdbc的简单封装,对传统操作数据库的类进行二次封装,可以把结果集转化成list。,同时也不影响程序的性能。
dbutils类:启动类
resultsethandler接口:转换类型接口
maplisthandler类:实现类,把记录转化成list
beanlisthandler类:实现类,把记录转化成list,使记录为javabean类型的对象
qreryrunner类:执行sql语句的类
import org.apache.commons.dbutils.dbutils; import org.apache.commons.dbutils.queryrunner; import org.apache.commons.dbutils.handlers.beanlisthandler; import java.sql.connection; import java.sql.drivermanager; import java.sql.sqlexception; import java.util.list; //转换成list public class beanlists { public static void main(string[] args) { connection conn = null; string url = "jdbc:mysql://localhost:3306/ptest"; string jdbcdriver = "com.mysql.jdbc.driver"; string user = "root"; string password = "ptest"; dbutils.loaddriver(jdbcdriver); try { conn = drivermanager.getconnection(url, user, password); queryrunner qr = new queryrunner(); list results = (list) qr.query(conn, "select id,name from person", new beanlisthandler(person.class)); for (int i = 0; i < results.size(); i++) { person p = (person) results.get(i); system.out.println("id:" + p.getid() + ",name:" + p.getname()); } } catch (sqlexception e) { e.printstacktrace(); } finally { dbutils.closequietly(conn); } } } public class person{ private integer id; private string name; //省略set, get方法 } import org.apache.commons.dbutils.dbutils; import org.apache.commons.dbutils.queryrunner; import org.apache.commons.dbutils.handlers.maplisthandler; import java.sql.connection; import java.sql.drivermanager; import java.sql.sqlexception; import java.util.list; import java.util.map; //转换成map public class maplists { public static void main(string[] args) { connection conn = null; string url = "jdbc:mysql://localhost:3306/ptest"; string jdbcdriver = "com.mysql.jdbc.driver"; string user = "root"; string password = "ptest"; dbutils.loaddriver(jdbcdriver); try { conn = drivermanager.getconnection(url, user, password); queryrunner qr = new queryrunner(); list results = (list) qr.query(conn, "select id,name from person", new maplisthandler()); for (int i = 0; i < results.size(); i++) { map map = (map) results.get(i); system.out.println("id:" + map.get("id") + ",name:" + map.get("name")); } } catch (sqlexception e) { e.printstacktrace(); } finally { dbutils.closequietly(conn); } } }
9、email 提供的一个开源的api,是对javamail的封装。
//用commons email发送邮件 public static void main(string args[]){ email email = new simpleemail(); email.sethostname("smtp.googlemail.com"); email.setsmtpport(465); email.setauthenticator(new defaultauthenticator("username", "password")); email.setsslonconnect(true); email.setfrom("user@gmail.com"); email.setsubject("testmail"); email.setmsg("this is a test mail ... :-)"); email.addto("foo@bar.com"); email.send(); }
10、fileupload java web文件上传功能。
//官方示例: //* 检查请求是否含有上传文件 // check that we have a file upload request boolean ismultipart = servletfileupload.ismultipartcontent(request); //现在我们得到了items的列表 //如果你的应用近于最简单的情况,上面的处理就够了。但我们有时候还是需要更多的控制。 //下面提供了几种控制选择: // create a factory for disk-based file items diskfileitemfactory factory = new diskfileitemfactory(); // set factory constraints factory.setsizethreshold(yourmaxmemorysize); factory.setrepository(yourtempdirectory); // create a new file upload handler servletfileupload upload = new servletfileupload(factory); // 设置最大上传大小 upload.setsizemax(yourmaxrequestsize); // 解析所有请求 list /* fileitem */ items = upload.parserequest(request); // create a factory for disk-based file items diskfileitemfactory factory = new diskfileitemfactory( yourmaxmemorysize, yourtempdirectory); //一旦解析完成,你需要进一步处理item的列表。 // process the uploaded items iterator iter = items.iterator(); while (iter.hasnext()) { fileitem item = (fileitem) iter.next(); if (item.isformfield()) { processformfield(item); } else { processuploadedfile(item); } } //区分数据是否为简单的表单数据,如果是简单的数据: // processformfield if (item.isformfield()) { string name = item.getfieldname(); string value = item.getstring(); //...省略步骤 } //如果是提交的文件: // processuploadedfile if (!item.isformfield()) { string fieldname = item.getfieldname(); string filename = item.getname(); string contenttype = item.getcontenttype(); boolean isinmemory = item.isinmemory(); long sizeinbytes = item.getsize(); //...省略步骤 } //对于这些item,我们通常要把它们写入文件,或转为一个流 // process a file upload if (writetofile) { file uploadedfile = new file(...); item.write(uploadedfile); } else { inputstream uploadedstream = item.getinputstream(); //...省略步骤 uploadedstream.close(); } //或转为字节数组保存在内存中: // process a file upload in memory byte[] data = item.get(); //...省略步骤 //如果这个文件真的很大,你可能会希望向用户报告到底传了多少到服务端,让用户了解上传的过程 //create a progress listener progresslistener progresslistener = new progresslistener(){ public void update(long pbytesread, long pcontentlength, int pitems) { system.out.println("we are currently reading item " + pitems); if (pcontentlength == -1) { system.out.println("so far, " + pbytesread + " bytes have been read."); } else { system.out.println("so far, " + pbytesread + " of " + pcontentlength + " bytes have been read."); } } } ; upload.setprogresslistener(progresslistener);
11、httpclien 基于httpcore实 现的一个http/1.1兼容的http客户端,它提供了一系列可重用的客户端身份验证、http状态保持、http连接管理module。
//get方法 import java.io.ioexception; import org.apache.commons.httpclient.*; import org.apache.commons.httpclient.methods.getmethod; import org.apache.commons.httpclient.params.httpmethodparams; public class getsample{ public static void main(string[] args) { // 构造httpclient的实例 httpclient httpclient = new httpclient(); // 创建get方法的实例 getmethod getmethod = new getmethod("http://www.ibm.com"); // 使用系统提供的默认的恢复策略 getmethod.getparams().setparameter(httpmethodparams.retry_handler, new defaulthttpmethodretryhandler()); try { // 执行getmethod int statuscode = httpclient.executemethod(getmethod); if (statuscode != httpstatus.sc_ok) { system.err.println("method failed: " + getmethod.getstatusline()); } // 读取内容 byte[] responsebody = getmethod.getresponsebody(); // 处理内容 system.out.println(new string(responsebody)); } catch (httpexception e) { // 发生致命的异常,可能是协议不对或者返回的内容有问题 system.out.println("please check your provided http address!"); e.printstacktrace(); } catch (ioexception e) { // 发生网络异常 e.printstacktrace(); } finally { // 释放连接 getmethod.releaseconnection(); } } } //post方法 import java.io.ioexception; import org.apache.commons.httpclient.*; import org.apache.commons.httpclient.methods.postmethod; import org.apache.commons.httpclient.params.httpmethodparams; public class postsample{ public static void main(string[] args) { // 构造httpclient的实例 httpclient httpclient = new httpclient(); // 创建post方法的实例 string url = "http://www.oracle.com/"; postmethod postmethod = new postmethod(url); // 填入各个表单域的值 namevaluepair[] data = { new namevaluepair("id", "youusername"), new namevaluepair("passwd", "yourpwd") } ; // 将表单的值放入postmethod中 postmethod.setrequestbody(data); // 执行postmethod int statuscode = httpclient.executemethod(postmethod); // httpclient对于要求接受后继服务的请求,象post和put等不能自动处理转发 // 301或者302 if (statuscode == httpstatus.sc_moved_permanently || statuscode == httpstatus.sc_moved_temporarily) { // 从头中取出转向的地址 header locationheader = postmethod.getresponseheader("location"); string location = null; if (locationheader != null) { location = locationheader.getvalue(); system.out.println("the page was redirected to:" + location); } else { system.err.println("location field value is null."); } return; } } }
12、io 对java.io的扩展 操作文件非常方便。
//1.读取stream //标准代码: inputstream in = new url( "http://jakarta.apache.org" ).openstream(); try { inputstreamreader inr = new inputstreamreader( in ); bufferedreader buf = new bufferedreader( inr ); string line; while ( ( line = buf.readline() ) != null ) { system.out.println( line ); } } finally { in.close(); } //使用ioutils inputstream in = new url( "http://jakarta.apache.org" ).openstream(); try { system.out.println( ioutils.tostring( in ) ); } finally { ioutils.closequietly(in); } //2.读取文件 file file = new file("/commons/io/project.properties"); list lines = fileutils.readlines(file, "utf-8"); //3.察看剩余空间 long freespace = filesystemutils.freespace("c:/");
13、lang 主要是一些公共的工具集合,比如对字符、数组的操作等等。
// 1 合并两个数组: org.apache.commons.lang. arrayutils // 有时我们需要将两个数组合并为一个数组,用arrayutils就非常方便,示例如下: private static void testarr() { string[] s1 = new string[] { "1", "2", "3" }; string[] s2 = new string[] { "a", "b", "c" }; string[] s = (string[]) arrayutils.addall(s1, s2); for (int i = 0; i < s.length; i++) { system.out.println(s[i]); } string str = arrayutils.tostring(s); str = str.substring(1, str.length() - 1); system.out.println(str + ">>" + str.length()); } //2 截取从from开始字符串 stringutils.substringafter("select * from person ", "from"); //3 判断该字符串是不是为数字(0~9)组成,如果是,返回true 但该方法不识别有小数点和 请注意 stringutils.isnumeric("454534"); //返回true //4.取得类名 system.out.println(classutils.getshortclassname(test.class)); //取得其包名 system.out.println(classutils.getpackagename(test.class)); //5.numberutils system.out.println(numberutils.stringtoint("6")); //6.五位的随机字母和数字 system.out.println(randomstringutils.randomalphanumeric(5)); //7.stringescapeutils system.out.println(stringescapeutils.escapehtml("<html>")); //输出结果为<html> system.out.println(stringescapeutils.escapejava("string")); //8.stringutils,判断是否是空格字符 system.out.println(stringutils.isblank(" ")); //将数组中的内容以,分隔 system.out.println(stringutils.join(test,",")); //在右边加下字符,使之总长度为6 system.out.println(stringutils.rightpad("abc", 6, 't')); //首字母大写 system.out.println(stringutils.capitalize("abc")); //deletes all whitespaces from a string 删除所有空格 system.out.println( stringutils.deletewhitespace(" ab c ")); //判断是否包含这个字符 system.out.println( stringutils.contains("abc", "ba")); //表示左边两个字符 system.out.println( stringutils.left("abc", 2)); system.out.println(numberutils.stringtoint("33"));
14、logging 提供的是一个java 的日志接口,同时兼顾轻量级和不依赖于具体的日志实现工具。
import org.apache.commons.logging.log; import org.apache.commons.logging.logfactory; public class commonlogtest { private static log log = logfactory.getlog(commonlogtest.class); //日志打印 public static void main(string[] args) { log.error("error"); log.debug("debug"); log.warn("warn"); log.info("info"); log.trace("trace"); system.out.println(log.getclass()); } }
15、validator 通用验证系统,该组件提供了客户端和服务器端的数据验证框架。
验证日期
// 获取日期验证 datevalidator validator = datevalidator.getinstance(); // 验证/转换日期 date foodate = validator.validate(foostring, "dd/mm/yyyy"); if (foodate == null) { // 错误 不是日期 return; }
表达式验证
// 设置参数 boolean casesensitive = false; string regex1 = "^([a-z]*)(?:\\-)([a-z]*)*$" string regex2 = "^([a-z]*)$"; string[] regexs = new string[] {regex1, regex1}; // 创建验证 regexvalidator validator = new regexvalidator(regexs, casesensitive); // 验证返回boolean boolean valid = validator.isvalid("abc-def"); // 验证返回字符串 string result = validator.validate("abc-def"); // 验证返回数组 string[] groups = validator.match("abc-def");
配置文件中使用验证
<form-validation> <global> <validator name="required" classname="org.apache.commons.validator.testvalidator" method="validaterequired" methodparams="java.lang.object, org.apache.commons.validator.field"/> </global> <formset> </formset> </form-validation> 添加姓名验证. <form-validation> <global> <validator name="required" classname="org.apache.commons.validator.testvalidator" method="validaterequired" methodparams="java.lang.object, org.apache.commons.validator.field"/> </global> <formset> <form name="nameform"> <field property="firstname" depends="required"> <arg0 key="nameform.firstname.displayname"/> </field> <field property="lastname" depends="required"> <arg0 key="nameform.lastname.displayname"/> </field> </form> </formset> </form-validation>
验证类
excerpts from org.apache.commons.validator.requirednametest //加载验证配置文件 inputstream in = this.getclass().getresourceasstream("validator-name-required.xml"); validatorresources resources = new validatorresources(in); //这个是自己创建的bean 我这里省略了 name name = new name(); validator validator = new validator(resources, "nameform"); //设置参数 validator.setparameter(validator.bean_param, name); map results = null; //验证 results = validator.validate(); if (results.get("firstname") == null) { //验证成功 } else { //有错误 int errors = ((integer)results.get("firstname")).intvalue(); }
总结
以上就是本文关于apache commons工具集代码详解的全部内容,希望对大家有所帮助。感兴趣的朋友可以继续参阅本站其他相关专题,如有不足之处,欢迎留言指出。感谢朋友们对本站的支持!