wiki:torque

torque详细配置

Torque是Apache的公开源代码项目,最开始是Turbine框架的组成部分,后面被独立出来作为一个单独的组件,归入了Apache的DB项目下。Torque的主要功能是实现对数据库的访问,Torque 主要包含两部分:一部分 是 Generator,它通过使用xml配置文件,产生应用程序访问数据库的资源,包括创建数据库、表和初始化sql 语句和 java 文件;另外一部分是 Runtime,提供使用这些代码访问数据库的运行时环境。

ORM(Object Relational Mapping,对象角色建模
torque各版本之间的差距还是挺大的,本文以torque3.3的配置为例

 http://db.apache.org/torque/download.html下载torque-gen-3.3.zip,torque-3.3.zip

torque-gen-3.3.zip主要有torque-gen-3.3.jar,build.properties,default.properties和build-torque.xml。torque-gen-3.3.jar自然是提供Generator运行是的包支持,build-torque.xml是ant的运行文件,它读取了build.properties和default.properties两个配置文件,这两个properties设置了生成访问数据库需要的资源文件和java代码需要用到的环境变量。存储数据库系统的属性,主要有项目名称、数据库类型、数据库链接URL、Driver、用户名、密码及主机名等。 torque-3.3.zip解压后有torque-3.3.jar和Torque.properties,torque-3.3.jar提供torque运行时的包支持,Torque.properties是toorque访问数据库时初始化环境需要用到的一些配置内容。

综上,核心的配置文件为:

  1. build.properties
  2. *-schema.xml、id-table-schema.xml
  3. Torque.properties
  4. 一般还会有一个defalt.properties
  5. build-torque.xml 这个是ant的配置文件,参照这个就可了解到以上四个配置文件的作用

id-table-schema.xml是Torque的IDBroker服务调用,用于指导Torque生成id_table表,他保存了project-schema.xml中相关ID自动增长的相关内容,实现类似于Oracle中的Sequence的功能。

torque Genarator的核心任务,可以详细参照build-torque.xml的配置,列举默认常用的如下:

(1).sql 解析%Torque_home%/schema/*.xml,生成对应的$Torque_home/src/sql/*.sql文件;
(2).doc 解析%Torque_home%/schema/*.xml,生成对应的$Torque_home/src/sql/*.html文件,描述数据库结构;
(3).create-db 生成不同平台上产生数据库系统的脚本;
(4).insert-sql 执行%Torque_home%/schema/*-schema.sql文件到指定数据库;
(5).sql2xml 解析%Torque_home%/schema/schema.sql文件,产生Torque对应的数据库文件%Torque_home%/schema/schema.xml;
(6).id-table-init-sql 根据%Torque_home%/schema/id-table-schema.xml文件产生id表的初始化脚本文件;

ANT的运行命令为%Torque_home%/ant -f build-torque.xml $taskname

ant -f build-torque.xml
ant -f build-torque.xml create-db
ant -f build-torque.xml id-table-init-sql
ant -f build-torque.xml insert-sql


实际使用过程中,实际上没必要一定使用torque默认的文件夹结构(即:%Torque%\src\schema),因为所有工作都是有Ant完成的,文件夹的位置也都是在build-torque.xml值指定的。当然,如果你不打算修改build-torque.xml的话,就要使用torque默认的结构和要求的文件名格式。

Torque 3.3 为例:
build.properties文件:

#工程名称
torque.project = torque
#数据库类型
torque.database = mysql
torque.addGetByNameMethod = true
torque.addIntakeRetrievable = false
torque.addSaveMethod = true
torque.addTimeStamp = true
torque.basePrefix = Base
torque.complexObjectModel = true
torque.useClasspath = true
torque.useManagers = false
torque.objectIsCaching = true
torque.silentDbFetch = true
torque.generateBeans = false
torque.beanSuffix = Bean
torque.enableJava5Features = false

#数据库URL,注意数据库名应该和工程名保持一致
torque.database.createUrl = jdbc:mysql://localhost:3306/mydb[[BR]] torque.database.buildUrl = jdbc:mysql://localhost:3306/torque[[BR]] torque.database.url = jdbc:mysql://localhost:3306/torque[[BR]] #数据库驱动类
torque.database.driver = com.mysql.jdbc.Driver
#连接数据库使用的用户名
torque.database.user = root
#连接数据库使用的密码
torque.database.password = 229229
#数据库的主机IP
torque.database.host = 127.0.0.1
torque.sameJavaName = false


project-schema.xml:
随便建了一个最简单的表为例:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<!DOCTYPE database SYSTEM " http://db.apache.org/torque/dtd/database_3_3.dtd">

<database name="torque" defaultIdMethod="idbroker">

<table name="user" description="User Table">

<column name="id" required="true" primaryKey="true" type="INTEGER" description="User ID"/>
<column name="name" required="true" type="VARCHAR" size="40" description="User Name"/>

</table>

</database>


id-table-schema.xml:

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>

<!DOCTYPE database SYSTEM " http://db.apache.org/torque/dtd/database_3_3.dtd">
<database name="torque">

<table name="ID_TABLE" idMethod="idbroker">

<column name="ID_TABLE_ID" required="true" primaryKey="true" type="INTEGER"/>
<column name="TABLE_NAME" required="true" size="255" type="VARCHAR"/>
<column name="NEXT_ID" type="INTEGER"/>
<column name="QUANTITY" type="INTEGER"/>
<unique>

<unique-column name="TABLE_NAME"/>

</unique>

</table>

</database>

这个配置文件让数据库生成一个叫做ID_TABLE的表


torque.properties:

torque.applicationRoot = .

log4j.category.org.apache.torque = ALL, org.apache.torque
log4j.appender.org.apache.torque = org.apache.log4j.FileAppender?
log4j.appender.org.apache.torque.file = ${torque.applicationRoot}/logs/torque.log
log4j.appender.org.apache.torque.layout = org.apache.log4j.PatternLayout?
log4j.appender.org.apache.torque.layout.conversionPattern = %d [%t] %-5p %c - %m%n
log4j.appender.org.apache.torque.append = false
torque.defaults.pool.maxIdle = 8
torque.defaults.pool.maxActive = 10
torque.defaults.pool.timeBetweenEvictionRunsMillis= 300000
torque.defaults.pool.minEvictableIdleTimeMillis = 3600000
以上部分用默认的就可以了,也就是torque-3.3.zip里面自带的
下面灰色背景部分是需要针对自己项目改动的
torque.defaults.connection.driver = com.mysql.jdbc.Driver

torque.defaults.connection.url = jdbc:mysql://localhost:3306/torque[[BR]] torque.defaults.connection.user = root
torque.defaults.connection.password = 229229

torque.database.default=torque
torque.database.torque.adapter=mysql

# # Using commons-dbcp
torque.dsfactory.torque.factory=org.apache.torque.dsfactory.SharedPoolDataSourceFactory?
torque.dsfactory.torque.pool.maxIdle=8
torque.dsfactory.torque.pool.maxActive=10
torque.dsfactory.torque.pool.testOnBorrow=true
torque.dsfactory.torque.pool.validationQuery=SELECT 1
torque.dsfactory.torque.connection.driver = com.mysql.jdbc.Driver
torque.dsfactory.torque.connection.url = jdbc:mysql://localhost:3306/torque[[BR]] torque.dsfactory.torque.connection.user = root
torque.dsfactory.torque.connection.password = 229229

torque.idbroker.clever.quantity=true
torque.manager.useCache = true


defalt.properties:

我使用的是wdw.properties配置文件,需要在build.xml中改动一下,将default.properties的路径改为wdw.properties文件路径即可

torque.home = .

#指定了生成Java文件的包路径
torque.targetPackage = javaTorque.wdwtest
torque.runOnlyOnSchemaChange = false
torque.output.dir = ${torque.home}/src
torque.schema.dir = ${torque.home}/src/schema
torque.templatePath = templates
torque.useClasspath = true

torque.doc.dir = ${torque.output.dir}/doc
torque.java.dir = ${torque.output.dir}
torque.java.base.dir = ${torque.java.dir}
torque.javadoc.dir = ${torque.output.dir}/javadoc
torque.ojb.dir = ${torque.output.dir}/ojb
torque.sql.dir = ${torque.output.dir}/sql
torque.omzip.dir = ${torque.output.dir}

torque.database.manualCreation = false
torque.saveJavaName = false

torque.addGetByNameMethod = true
torque.addIntakeRetrievable = false
torque.retrievableInterface = org.apache.turbine.om.Retrievable
torque.addSaveMethod = true
torque.addTimeStamp = true
torque.basePrefix = Base
torque.complexObjectModel = true
torque.saveException = Exception
torque.useClasspath = false
# Whether to generate Manager classes for JCS-based caching.
torque.useManagers = false
torque.objectIsCaching = true
torque.silentDbFetch = true
torque.generateBeans = false
torque.beanSuffix = Bean

torque.subpackage.base.bean = bean
torque.subpackage.bean = bean
torque.subpackage.map = map

torque.omzip.src.base = false
torque.omzip.src.extension = false
torque.omzip.bin.base = false
torque.omzip.bin.extension = false
torque.omzip.deleteFiles = false

torque.generateDeprecated = true

torque.idTableXMLFile =
torque.initialID = 101
torque.initialIDValue = 1000
torque.initialIDStep = 10

# Doc settings
torque.doc.format = html
torque.doc.html.normalFont = font-family: Verdana; font-size: 10pt;
torque.doc.html.fkColor = afe295

torque.template.sql = sql/base/Control.vm
torque.template.om = om/Control.vm
torque.template.om.base = om/ControlBase.vm
torque.template.idTable = sql/id-table/Control.vm
torque.template.dataDtd = data/Control.vm
torque.template.dataDump = data/dump/Control.vm
torque.template.dataSql = sql/load/Control.vm
torque.template.doc = doc/Control.vm
torque.template.sqlDbInit = sql/db-init/Control.vm
torque.template.ojb = ojb/repository/Control.vm
torque.template.ojbModel = ojb/model/Control.vm

torque.compile.src.dir = ${torque.java.dir}
torque.compile.build.dir = bin/classes
torque.compile.debug = on
torque.compile.deprecation = off
torque.compile.optimize = off

torque.schema.sql.includes = *-schema.xml
torque.schema.sql.excludes =
torque.schema.doc.includes = *-schema.xml
torque.schema.doc.excludes =
torque.schema.create-db.includes = *-schema.xml
torque.schema.create-db.excludes =
torque.schema.init-sql.includes = *-schema.xml
torque.schema.init-sql.excludes = id-table-schema.xml
torque.schema.om.includes = *-schema.xml
torque.schema.om.excludes = id-table-schema.xml
torque.schema.ojb.includes = *-schema.xml
torque.schema.ojb.excludes =


javaTorque.wdwtest包里面的四个类:

User.java就是数据表user的持久层对象
UserPeer?.java封装了持久层的操作
sql包下面是torque生成的建表sql语句
所以,最常见的做法是:写好torque的配置文件*-schema.xml,然后生成其他一切东西,包括数据库
当然,torque也提供根据.sql文件生成xml配置文件的功能

Attachments