Torque:Apache又一O/R Mapping框架

官方主页：http://db.apache.org/torque/index.html

本文是在阅读http://www.blogjava.net/fanyingjie/archive/2008/05/22/202109.html的基础上进行的一些补充。

使用的版本是：3.3。

 

这个O/R Mapping框架虽然不像Hibernate那样实现强大，但在很多方面都体现出他的易用性。

步骤如下：

首先:使用Torque的Generator生成PO和数据表。假设想要新建的数据库名为torquedb.

下载Generator：http://db.apache.org/torque/download.html,并解压。

定义torquedb-schema.xml文件如下(注意：貌似必须以-schema.xml结尾)：

1. <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
2. <!DOCTYPE database SYSTEM
3.  "http://db.apache.org/torque/dtd/database_3_1.dtd">
4. <database name="torquedb" defaultIdMethod="idbroker">
5.  <table name="book" description="Book Table">
6.     <column
7.       name="book_id"
8.       required="true"
9.       primaryKey="true"
10.       type="INTEGER"
11.       description="Book Id"/>
12.     <column
13.       name="title"
14.       required="true"
15.       type="VARCHAR"
16.       size="255"
17.       description="Book Title"/>
18.     <column
19.       name="isbn"
20.       required="true"
21.       type="VARCHAR"
22.       size="24"
23.       javaName="ISBN"
24.       description="ISBN Number"/>
25.     <column
26.       name="publisher_id"
27.       required="true"
28.       type="INTEGER"
29.       description="Foreign Key Publisher"/>
30.     <column
31.       name="author_id"
32.       required="true"
33.       type="INTEGER"
34.       description="Foreign Key Author"/>
35.     <foreign-key foreignTable="publisher" onDelete="cascade">
36.       <reference
37.         local="publisher_id"
38.         foreign="publisher_id"/>
39.     </foreign-key>
40.     <foreign-key foreignTable="author" onDelete="cascade">
41.       <reference
42.         local="author_id"
43.         foreign="author_id"/>
44.     </foreign-key>
45.  </table>
46.  <table name="publisher" description="Publisher Table">
47.     <column
48.       name="publisher_id"
49.       required="true"
50.       primaryKey="true"
51.       type="INTEGER"
52.       description="Publisher Id"/>
53.     <column
54.       name="name"
55.       required="true"
56.       type="VARCHAR"
57.       size="128"
58.      description="Publisher Name"/>
59.  </table>
60.  <table name="author" description="Author Table">
61.     <column
62.       name="author_id"
63.       required="true"
64.       primaryKey="true"
65.       type="INTEGER"
66.       description="Author Id"/>
67.     <column
68.       name="first_name"
69.       required="true"
70.       type="VARCHAR"
71.       size="128"
72.       description="First Name"/>
73.     <column
74.       name="last_name"
75.       required="true"
76.       type="VARCHAR"
77.       size="128"
78.       description="Last Name"/>
79.  </table>
80. </database>

把torquedb-schema.xml放置到刚刚下载的Generator的解压文件夹/src/schema下，默认应该已经有一个id-table-schema.xml文件，这个文件是用来生成一个用以保存所有业务表的自增主键的数据表。

修改build.properties文件：

1. # Licensed to the Apache Software Foundation (ASF) under one
2. # or more contributor license agreements.  See the NOTICE file
3. # distributed with this work for additional information
4. # regarding copyright ownership.  The ASF licenses this file
5. # to you under the Apache License, Version 2.0 (the
6. # "License"); you may not use this file except in compliance
7. # with the License.  You may obtain a copy of the License at
8. #
9. #   http://www.apache.org/licenses/LICENSE-2.0
10. #
11. # Unless required by applicable law or agreed to in writing,
12. # software distributed under the License is distributed on an
13. # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14. # KIND, either express or implied.  See the License for the
15. # specific language governing permissions and limitations
16. # under the License.
18. # -------------------------------------------------------------------
19. #
20. # T O R Q U E  C O N F I G U R A T I O N  F I L E
21. #
22. # $Id: build.properties 591077 2007-11-01 16:42:56Z tv $
23. #
24. # -------------------------------------------------------------------
25. # This file contains the most commonly used properties. For a
26. # a complete list of build properties, please refer to:
27. #   http://db.apache.org/torque/releases/torque-3.3/generator/properties-reference.html
28. # -------------------------------------------------------------------
30. # -------------------------------------------------------------------
31. #
32. #  P R O J E C T
33. #
34. # -------------------------------------------------------------------
35. # This is the name of your Torque project. Your non-Java generated
36. # files will be named using the project name selected below. If your
37. # project=killerapp then you will have a generated:
38. #
39. #   killerapp-schema.sql
40. #
41. # The custom is then to also rename your project XML schema from
42. # project-schema.xml to killerapp-schema.xml. This is required
43. # for a few targets such as datasql, datadump, and datadtd.
44. # -------------------------------------------------------------------
46. torque.project = torque_tutorial
49. # -------------------------------------------------------------------
50. #
51. #  T A R G E T  D A T A B A S E
52. #
53. # -------------------------------------------------------------------
54. # This is the target database, only considered when generating
55. # the SQL for your Torque project. Your possible choices are:
56. #
57. #   axion, cloudscape, db2, db2400, hypersonic, interbase, msaccess
58. #   mssql, mysql, oracle, postgresql, sapdb, sybase
59. # -------------------------------------------------------------------
61. torque.database = mysql
64. # -------------------------------------------------------------------
65. #
66. #  O B J E C T  M O D E L  I N F O R M A T I O N
67. #
68. # -------------------------------------------------------------------
69. # These settings will allow you to customize the way your
70. # Peer-based object model is created.
71. # -------------------------------------------------------------------
72. # addGetByNameMethod
73. #   If true, Torque adds methods to get database fields by name/position.
74. #
75. # addIntakeRetrievable
76. #   If true, the data objects will implement Intake's Retrievable
77. #   interface
78. #
79. # addSaveMethod
80. #   If true, Torque adds tracking code to determine how to save objects.
81. #
82. # addTimeStamp
83. #   If true, Torque true puts time stamps in generated om files.
84. #
85. # basePrefix
86. #   A string to pre-pend to the file names of base data and peer objects.
87. #
88. # complexObjectModel
89. #   If true, Torque generates data objects with collection support and
90. #   methods to easily retreive foreign key relationships.
91. #
92. # targetPackage
93. #   Sets the Java package the om files will generated to, e.g.
94. #   "com.company.project.om".
95. #
96. # useClasspath
97. #   If true, Torque will not look in the <code>templatePath</code> directory,
98. #   for templates, but instead load them from the classpath, allowing you to
99. #   use Torque without extracted it from the jar.
100. #
101. # useManagers
102. #   If true, Torque will generate Manager classes that use JCS for caching.
103. #   Still considered experimental.
104. #
105. # objectIsCaching
106. #   If true, Torque generates data objects that cache their foreign
107. #   key relationships. If this is not desired (because the underlying objects
108. #   can be manipulated from other code), set this property to false. This currently
109. #   cannot combined with the manager setting from above.
110. #
111. # silentDbFetch
112. #   If true, the getXXX() methods which retrieve associated objects
113. #   will fetch the associated objects silently. If false, only the
114. #   methods where a connection is specified explicitly will
115. #   fetch the associated objects silently; the methods where no connection
116. #   is specified will not do a silent fetch and return null if no previous
117. #   explicit fetch was made.
118. #   This setting has no effect if objectIsCaching is set to false.
119. #
120. #
121. # generateBeans
122. #   If true, Torque will generate an additional bean for each data object,
123. #   plus methods to create beans from data objects and vice versa
124. #
125. # beanSuffix
126. #   A String to append to the class name of generated beans (if they are generated)
127. #
128. # enableJava5Features
129. #   If true, the generator will use Java5 generics in the generated code.
133. # -------------------------------------------------------------------
135. torquetorque.targetPackage = torque.generated
137. torque.addGetByNameMethod = true
138. torque.addIntakeRetrievable = false
139. torque.addSaveMethod = true
140. torque.addTimeStamp = true
141. torque.basePrefix = Base
142. torque.complexObjectModel = true
143. torque.useClasspath = true
144. torque.useManagers = false
145. torque.objectIsCaching = true
146. torque.silentDbFetch = true
147. torque.generateBeans = false
148. torque.beanSuffix = Bean
149. torque.enableJava5Features = false
151. # -------------------------------------------------------------------
152. #
153. #  D A T A B A S E  S E T T I N G S
154. #
155. # -------------------------------------------------------------------
156. # JDBC connection settings. This is used by the JDBCToXML task that
157. # will create an XML database schema from JDBC metadata. These
158. # settings are also used by the SQL Ant task to initialize your
159. # Torque system with the generated SQL.
160. #
161. # sameJavaName
162. #   If true, the JDBC task will set the javaName attribute for the tables
163. #   and columns to be the same as SQL name.
164. # -------------------------------------------------------------------
166. torque.targetPackage=examples.torque.peer
167. torque.database.createUrl = jdbc:mysql://127.0.0.1:3306/mysql
168. torque.database.buildUrl = jdbc:mysql://127.0.0.1:3306/torquedb
169. torque.database.url = jdbc:mysql://127.0.0.1:3306/torquedb
170. torque.database.driver = com.mysql.jdbc.Driver
171. torque.database.user = root
172. torque.database.password = root
173. torque.database.host = 127.0.0.1
175. torque.sameJavaName = false

注意上面粗体部分的修改内容。

运行Ant,命令如下(参考：http://db.apache.org/torque/releases/torque-3.3/generator/index.html)：

ant -f build-torque.xml

此时在刚刚下载的Generator的解压文件夹/src/java下生成了工程需要PO,pachkage由上述配置文件torque.targetPackage所指定。

 

资料上说运行ant -f build-torque.xml create-db可新建数据库，我没有成功，这里把DDL晒出来：

1. SET FOREIGN_KEY_CHECKS=0;
2. -- ----------------------------
3. -- Table structure for author
4. -- ----------------------------
5. CREATE TABLE `author` (
6.   `author_id` int(11) NOT NULL,
7.   `first_name` varchar(128) NOT NULL,
8.   `last_name` varchar(128) NOT NULL,
9.   PRIMARY KEY  (`author_id`)
10. ) ENGINE=InnoDB DEFAULT CHARSET=latin1;
12. -- ----------------------------
13. -- Table structure for book
14. -- ----------------------------
15. CREATE TABLE `book` (
16.   `book_id` int(11) NOT NULL,
17.   `title` varchar(255) NOT NULL,
18.   `isbn` varchar(24) NOT NULL,
19.   `publisher_id` int(11) NOT NULL,
20.   `author_id` int(11) NOT NULL,
21.   PRIMARY KEY  (`book_id`),
22.   KEY `book_FK_1` (`publisher_id`),
23.   KEY `book_FK_2` (`author_id`),
24.   CONSTRAINT `book_FK_2` FOREIGN KEY (`author_id`) REFERENCES `author` (`author_id`) ON DELETE CASCADE,
25.   CONSTRAINT `book_FK_1` FOREIGN KEY (`publisher_id`) REFERENCES `publisher` (`publisher_id`) ON DELETE CASCADE
26. ) ENGINE=InnoDB DEFAULT CHARSET=latin1;
28. -- ----------------------------
29. -- Table structure for id_table
30. -- ----------------------------
31. CREATE TABLE `id_table` (
32.   `ID_TABLE_ID` int(11) NOT NULL,
33.   `TABLE_NAME` varchar(255) NOT NULL,
34.   `NEXT_ID` int(11) default NULL,
35.   `QUANTITY` int(11) default NULL,
36.   PRIMARY KEY  (`ID_TABLE_ID`),
37.   UNIQUE KEY `TABLE_NAME` (`TABLE_NAME`)
38. ) ENGINE=InnoDB DEFAULT CHARSET=latin1;
40. -- ----------------------------
41. -- Table structure for publisher
42. -- ----------------------------
43. CREATE TABLE `publisher` (
44.   `publisher_id` int(11) NOT NULL,
45.   `name` varchar(128) NOT NULL,
46.   PRIMARY KEY  (`publisher_id`)
47. ) ENGINE=InnoDB DEFAULT CHARSET=latin1;
49. -- ----------------------------
50. -- Records 
51. -- ----------------------------
52. INSERT INTO `id_table` VALUES ('1', 'author', '1', '1');
53. INSERT INTO `id_table` VALUES ('2', 'book', '1', '1');
54. INSERT INTO `id_table` VALUES ('3', 'publisher', '1', '1');

下载Torque运行包Runtime：http://db.apache.org/torque/download.html并解压，修改Torque.properties文件：

1. # Licensed to the Apache Software Foundation (ASF) under one
2. # or more contributor license agreements.  See the NOTICE file
3. # distributed with this work for additional information
4. # regarding copyright ownership.  The ASF licenses this file
5. # to you under the Apache License, Version 2.0 (the
6. # "License"); you may not use this file except in compliance
7. # with the License.  You may obtain a copy of the License at
8. #
9. #   http://www.apache.org/licenses/LICENSE-2.0
10. #
11. # Unless required by applicable law or agreed to in writing,
12. # software distributed under the License is distributed on an
13. # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14. # KIND, either express or implied.  See the License for the
15. # specific language governing permissions and limitations
16. # under the License.
18. torque.applicationRoot = .
20. # -------------------------------------------------------------------
21. #
22. #  L O G G I N G
23. #
24. # -------------------------------------------------------------------
25. # We use Log4J for all Torque logging and we embed the log4j
26. # properties within our application configuration.
27. # -------------------------------------------------------------------
29. # This first category is required and the category
30. # must be named 'default'. This is used for all logging
31. # where an explicit category is not specified.
33. log4j.category.org.apache.torque = ALL, org.apache.torque
34. log4j.appender.org.apache.torque = org.apache.log4j.FileAppender
35. log4j.appender.org.apache.torque.file = ${torque.applicationRoot}/logs/torque.log
36. log4j.appender.org.apache.torque.layout = org.apache.log4j.PatternLayout
37. log4j.appender.org.apache.torque.layout.conversionPattern = %d [%t] %-5p %c - %m%n
38. log4j.appender.org.apache.torque.append = false
40. # -------------------------------------------------------------------
41. #
42. #  D E F A U L T S
43. #
44. # -------------------------------------------------------------------
45. #
46. # These values kick in, if you don't explicitly override them in your
47. # various database settings. At the moment they're only used if you
48. # configure the SharedPoolDataSourceFactory of the PerUserDataSourceFactory
49. # as your data source provider. It does not work with JNDI.
50. #
51. # The example is shown for SharedPoolDataSource.
52. #
53. # -------------------------------------------------------------------
55. # Time to wait for a connection to the database in milliseconds.
56. torque.defaults.pool.maxWait = 10000
58. # Maximum number of idle and active connections cached in a database
59. # definition.
60. # Note that, if you have multiple database definitions which access the
61. # same database URL, they don't share the connections but you have
62. # multiple pools and each has this maximum number. So if you have a
63. # connection licensed database engine, you must multiply this number by
64. # the number of times you use a specific database URL.
65. torque.defaults.pool.maxIdle = 8
66. torque.defaults.pool.maxActive = 10
68. # How often the pool is checked for connection which stayed in the pool
69. # for too long. Defaults to 5 minutes (5 * 60 * 1000)
70. # remove property if the idle object evictor should not be run
71. torque.defaults.pool.timeBetweenEvictionRunsMillis= 300000
73. # Lifetime of an idle connection in the pool in milliseconds.
74. # Defaults to one hour (1000 * 60 * 60)
75. torque.defaults.pool.minEvictableIdleTimeMillis = 3600000
77. # Sets the driver for the data sources.
78. torque.defaults.connection.driver = com.mysql.jdbc.Driver
80. # Sets the URL for the datasources
81. torque.defaults.connection.url = jdbc:mysql://localhost:3306/torquedb
83. # Sets login and password for the data sources.
84. torque.defaults.connection.user = root
85. torque.defaults.connection.password = root
87. # -------------------------------------------------------------------
88. #
89. #  T O R Q U E  P R O P E R T I E S
90. #
91. # -------------------------------------------------------------------
92. # These are your database settings. Look in the
93. # org.apache.torque.pool.* packages for more information.
94. #
95. # The parameters to connect to the default database.  You MUST
96. # configure these properly.
97. # -------------------------------------------------------------------
99. torque.database.default=torquedb
100. torque.database.torquedb.adapter=mysql
102. # # Using commons-dbcp
103. torque.dsfactory.torquedb.factory=org.apache.torque.dsfactory.SharedPoolDataSourceFactory
104. # torque.dsfactory.bookstore.factory=org.apache.torque.dsfactory.PerUserPoolDataSourceFactory
105. torque.dsfactory.torquedb.pool.maxIdle=8
106. torque.dsfactory.torquedb.pool.maxActive=10
107. torque.dsfactory.torquedb.pool.testOnBorrow=true
108. torque.dsfactory.torquedb.pool.validationQuery=SELECT 1
109. torque.dsfactory.torquedb.connection.driver = com.mysql.jdbc.Driver
110. torque.dsfactory.torquedb.connection.url = jdbc:mysql://localhost:3306/torquedb
111. torque.dsfactory.torquedb.connection.user = root
112. torque.dsfactory.torquedb.connection.password = root
115. # # Using jndi
116. # torque.dsfactory.bookstore.factory=org.apache.torque.dsfactory.JndiDataSourceFactory
117. # torque.dsfactory.bookstore.jndi.path=jdbc/bookstore
118. # torque.dsfactory.bookstore.jndi.java.naming.factory.initial = org.apache.naming.java.javaURLContextFactory
119. # torque.dsfactory.bookstore.jndi.java.naming.factory.url.pkgs = org.apache.naming
121. # torque.dsfactory.bookstore.datasource.dataSourceName=jdbc/DBbookstore
122. # torque.dsfactory.bookstore.datasource.jndiEnvironment.java.naming.factory.initial = org.apache.naming.java.javaURLContextFactory
123. # torque.dsfactory.bookstore.datasource.jndiEnvironment.java.naming.factory.url.pkgs = org.apache.naming
124. # torque.dsfactory.bookstore.datasource.maxIdle=8
125. # torque.dsfactory.bookstore.datasource.maxActive=10
127. # # ConnectionPoolDataSource
128. # torque.dsfactory.bookstore.factory=org.apache.torque.dsfactory.JndiDataSourceFactory
129. # torque.dsfactory.bookstore.jndi.path=jdbc/DBbookstore
130. # torque.dsfactory.bookstore.jndi.java.naming.factory.initial = org.apache.naming.java.javaURLContextFactory
131. # torque.dsfactory.bookstore.jndi.java.naming.factory.url.pkgs = org.apache.naming
132. # torque.dsfactory.bookstore.datasource.classname=org.apache.commons.dbcp.cpdsadapter.DriverAdapterCPDS
133. # torque.dsfactory.bookstore.datasource.driver = org.gjt.mm.mysql.Driver
134. # torque.dsfactory.bookstore.datasource.url = jdbc:mysql://localhost:3306/torque
135. # torque.dsfactory.bookstore.datasource.user = user
136. # torque.dsfactory.bookstore.datasource.password = password
138. # Determines if the quantity column of the IDBroker's id_table should
139. # be increased automatically if requests for ids reaches a high
140. # volume.
142. torque.idbroker.clever.quantity=true
144. # Determines whether the managers cache instances of the business objects.
145. # And also whether the MethodResultCache will really cache results.
147. torque.manager.useCache = true

注意：设置torque.database.default=torquedb后,下面的配置都要把属性中的bookstore改为torquedb。

 

这样可以把生成的PO以及配置文件组成工程，结构如下：

 

测试文件TestMain.java

1. package examples.torque;
3. import java.sql.Connection;
4. import java.util.List;
6. import org.apache.commons.configuration.PropertiesConfiguration;
7. import org.apache.torque.Torque;
8. import org.apache.torque.util.BasePeer;
9. import org.apache.torque.util.Criteria;
10. import org.apache.torque.util.Transaction;
12. import com.workingdogs.village.Record;
14. import examples.torque.peer.Author;
15. import examples.torque.peer.AuthorPeer;
16. import examples.torque.peer.Book;
17. import examples.torque.peer.Publisher;
19. public class TestMain {
21.     public static void main(String[] args) throws Exception {
22.         
23.         PropertiesConfiguration dbConfig = new PropertiesConfiguration();
24.         dbConfig.load("torque.properties");
25.         Torque.init(dbConfig);
26.         
27.         //Transaction
28.         Author author = new Author();
29.         author.setFirstName("shen");
30.         author.setLastName("bin");
31.         Publisher publisher = new Publisher();
32.         publisher.setName("publisherA");
33.         Book book = new Book();
34.         book.setTitle("titleA");
35.         book.setISBN("ISBNA");
36.         Connection conn = Transaction.begin(Torque.getDefaultDB());
37.         try {
38.             author.save(conn);//AuthorPeer.doInsert(author);
39.             publisher.save(conn);
40.             book.setPublisher(publisher);
41.             book.setAuthor(author);
42.             book.save(conn);
43.         } catch (Exception e) {
44.             Transaction.rollback(conn);
45.         } finally {
46.             Transaction.commit(conn);
47.         }
48.         
49.         //SQL Search
50.         List<?> list = BasePeer.executeQuery("select * from author");
51.         for (int i = 0; i < list.size(); i++) {
52.             Record record = (Record)list.get(i);
53.             System.out.println(record.getValue(3).asString());
54.         }
55.         
56.         //Criteria Search
57.         Criteria criteria = new Criteria();
58.         criteria.add(AuthorPeer.AUTHOR_ID, 1);
59.         list = AuthorPeer.doSelect(criteria);
60.         for (int i = 0; i < list.size(); i++) {
61.             System.out.println(list.get(i));
62.         }
63.         
64.         //Update
65.         author = (Author)list.get(0);
66.         author.setLastName("yan");
67.         author.save();
68.     }
69. }

其他资料：

http://blog.csdn.net/keepeye/archive/2005/05/26/381681.aspx

http://betterman-zeng.blogbus.com/logs/6360701.html

Criteria用法：

http://db.apache.org/torque/releases/torque-3.3/runtime/reference/read-from-db.html