用ant和xdoclet生成hibernate配置文件可以为我们省去很多配置的操作,废话不多说,直接给栗子:
测试环境:
eclipse:Eclipse Java EE IDE for Web Developers 4.6.0
ant:eclipse自带ant,无需下载配置
xdoclet:xdoclet-1.2.3
hibernate:hibernate-distribution-3.3.2.GA-dist + hibernate-annotations-3.4.0.GA(由于是老版本所以是有两个的)
1,、配置xdoclet
首先解压下载好的xdoclet1.2.3:
打开eclipse,进入window》preferences》javaEE》XDoclet,选择xdoclet版本 Version:1.2.3(自带ant只支持1.2.1-1.2.3)和XDoclet Home:点击浏览选择刚才安装的xdoclet根路径,这里是:E:\softwareForJava\xdoclet\xdoclet-1.2.3 ,点击OK,如下图
2.示例程序
创建一个java project:xdocletTest。
在工程上右键添加一个名为build.xml的文件
在工程上右键添加一个名为lib的文件夹,把hibernate依赖的jar包及mysql驱动jar包都放到lib文件夹下
两个实体类一个为Group(组),一个为(User)
为了更好的显示日志信息,添加log4j.properties文件到src路径下
(1)配置实体类
User.java
- package com.xdoclet.model;
- /**
- * @hibernate.class
- * table="t_user"
- * @author welcome
- */
- public class User {
- private String userId;
- private String userName;
- private Group group;
- /**
- * @hibernate.id column="userId"
- * generator-class="assigned"
- */
- public String getUserId() {
- return userId;
- }
- public void setUserId(String userId) {
- this.userId = userId;
- }
- /**
- * @hibernate.property
- */
- public String getUserName() {
- return userName;
- }
- public void setUserName(String userName) {
- this.userName = userName;
- }
- /**
- * @hibernate.many-to-one
- * column="groupId"
- * cascade="all"
- * class="com.xdoclet.model.Group"
- * @param group
- */
- public Group getGroup() {
- return group;
- }
- public void setGroup(Group group) {
- this.group = group;
- }
- }
Group.java
- package com.xdoclet.model;
- import java.util.Set;
- /**
- * @hibernate.class
- * table="t_group"
- * @author welcome
- */
- public class Group {
- private String groupId;
- private String groupName;
- private Set userSets;
- /**
- * @hibernate.id
- * column="groupId"
- * generator-class="assigned"
- * @return
- */
- public String getGroupId() {
- return groupId;
- }
- public void setGroupId(String groupId) {
- this.groupId = groupId;
- }
- /**
- * @hibernate.property
- * column="groupName"
- * @return
- */
- public String getGroupName() {
- return groupName;
- }
- public void setGroupName(String groupName) {
- this.groupName = groupName;
- }
- /**
- * @hibernate.set inverse="true"
- * @hibernate.collection-key column="groupId"
- * @hibernate.collection-one-to-many
- * class="com.xdoclet.model.User"
- * @return
- */
- public Set getUserSets() {
- return userSets;
- }
- public void setUserSets(Set userSets) {
- this.userSets = userSets;
- }
- }
注意:实体类中的注解是xdoclet的,可以去查看xdoclet关于hibernate的相关文档http://xdoclet.sourceforge.net/xdoclet/tags/hibernate-tags.html
(2)log4j.properties配置文件
- #All level less than INFO will be logged
- log4j.rootLogger=INFO,A1
- #A1 is the output device
- log4j.appender.A1=org.apache.log4j.FileAppender
- log4j.appender.A1.File=e:/log4j.htm
- #use html layout
- log4j.appender.A1.layout=org.apache.log4j.HTMLLayout
此文件会将日志信息记录为html格式的文件,然后输出到E盘下。
(3)build.xml
- <span style="font-size:14px;"><?xml version="1.0" encoding="GBK"?>
- <project name="使用xdoclet映射hibernate" basedir=".">
- <!-- 定义源文件目录变量 -->
- <property name="src.dir" value="${basedir}/src" />
- <!-- 定义xdoclet的目录 -->
- <property name="xdoclet.home" value="E:\softwareForJava\xdoclet\xdoclet-1.2.3">
- </property>
- <!-- 定义构建路径 -->
- <path id="xdoclet.classpath">
- <fileset dir="${xdoclet.home}/lib">
- <include name="*.jar" />
- </fileset>
- </path>
- <path id="lib.classpath">
- <fileset dir="${xdoclet.home}/lib">
- <include name="**/*.jar" />
- </fileset>
- <fileset dir="${basedir}/lib">
- <include name="**/*.jar" />
- </fileset>
- </path>
- <!-- 生成Hibernate的映射文件 -->
- <target name="生成Hibernate的映射文件" unless="hibernatedoclet.unnecessary" description="Generate Hibernate mapping files">
- <taskdef name="hibernatedoclet" classname="xdoclet.modules.hibernate.HibernateDocletTask" classpathref="xdoclet.classpath" />
- <hibernatedoclet destdir="${src.dir}" mergedir="${src.dir}" excludedtags="@version,@author,@todo,@see" verbose="false">
- <fileset dir="${src.dir}">
- <include name="com/xdoclet/model/*.java" />
- </fileset>
- <hibernate version="3.0" />
- </hibernatedoclet>
- </target>
- <!-- 生成Hibernate配置文件 -->
- <target name="生成Hibernate配置文件" depends="生成Hibernate的映射文件">
- <taskdef name="hibernatedoclet" classname="xdoclet.modules.hibernate.HibernateDocletTask" classpathref="xdoclet.classpath" />
- <hibernatedoclet destdir="${src.dir}">
- <fileset dir="${src.dir}">
- <include name="com/xdoclet/model/*.java" />
- </fileset>
- <hibernatecfg destdir="${src.dir}" version="3.0" hbm2ddl="create-update" jdbcUrl="jdbc:mysql://localhost:3306/oa" driver="com.mysql.jdbc.Driver" username="root" password="123456" dialect="org.hibernate.dialect.MySQL5Dialect" showSql="true">
- <otherProperty name="hbm2ddl" value="create-update" />
- <otherProperty name="format_sql" value="true" />
- </hibernatecfg>
- </hibernatedoclet>
- </target>
- <!-- 导出数据库表结构 -->
- <target name="导出数据库表结构" depends="生成Hibernate配置文件">
- <taskdef name="schemaexport" classname="org.hibernate.tool.hbm2ddl.SchemaExportTask" classpathref="lib.classpath" />
- <property name="hibernate.dialect" value="org.hibernate.dialect.MySQL5Dialect" />
- <property name="hibernate.format_sql" value="true" />
- <property name="hibernate.use_sql_comments" value="true" />
- <schemaexport output="schema-export.sql" quiet="no" text="yes" drop="no" delimiter=";">
- <fileset dir="${basedir}/src">
- <include name="com/xdoclet/model/*.hbm.xml" />
- </fileset>
- </schemaexport>
- </target>
- </project></span>
这里需要注意的是这两个元素
<otherProperty name="hbm2ddl" value="create-update" />
<otherProperty name="format_sql" value="true" />
在xdoclet1.0.4以后的版本中hbm2ddl需要以额外的方式来设置,之前我按照1.0.4版本中的方式去设置,此属性死活不会出现在hibernate.cfg.xml中,最后得知这是xdoclet的一个bug。(第一个我玩了大半天。。。)
(4)ExportTable.java (生成数据库表结构)
- package com.xdoclet.export;
- import org.hibernate.cfg.Configuration;
- import org.hibernate.tool.hbm2ddl.SchemaExport;
- public class ExportTable {
- public static void main(String[] args) {
- Configuration configuration=new Configuration().configure("hibernate.cfg.xml");
- SchemaExport export=new SchemaExport(configuration);
- export.create(true, true);
- }
- }
最后你看到的项目结构应该是这样的:
3.生成配置文件
打开mysql,创建一个名为oa的数据库
在eclipse中运行ant:点window->show view->ant,添加我们的ant脚本到eclipse的ant视图中,右键ant视图空白处或者点击下图位置添加构建脚本:
选择build.xml文件,在”导出数据库表结构“上点击run as ant
此时控制台输出:
- Buildfile: E:"JAR"jbpm"jbpm-4.3"workspace"xdoclet"build.xml
- 生成Hibernate的映射文件:
- [hibernatedoclet] (XDocletMain.start 47 ) Running <hibernate/>
- [hibernatedoclet] Generating mapping file for com.xdoclet.model.Group.
- [hibernatedoclet] com.xdoclet.model.Group
- [hibernatedoclet] Generating mapping file for com.xdoclet.model.User.
- [hibernatedoclet] com.xdoclet.model.User
- 生成Hibernate配置文件:
- [hibernatedoclet] addOtherProperty(): name=null, null
- [hibernatedoclet] addOtherProperty(): name=null, null
- [hibernatedoclet] (XDocletMain.start 47 ) Running <hibernatecfg/>
- [hibernatedoclet] Generating hibernate.cfg.xml configuration file
- 导出数据库表结构:
- [schemaexport] (cfg.Environment 500 ) Hibernate 3.2.0
- [schemaexport] (cfg.Environment 533 ) hibernate.properties not found
- [schemaexport] (cfg.Environment 667 ) Bytecode provider name : cglib
- [schemaexport] (cfg.Environment 584 ) using JDK 1.4 java.sql.Timestamp handling
- [schemaexport] (cfg.Configuration 274 ) Reading mappings from file: E:"JAR"jbpm"jbpm-4.3"workspace"xdoclet"src"com"xdoclet"model"Group.hbm.xml
- [schemaexport] (cfg.HbmBinder 300 ) Mapping class: com.xdoclet.model.Group -> t_group
- [schemaexport] (cfg.Configuration 274 ) Reading mappings from file: E:"JAR"jbpm"jbpm-4.3"workspace"xdoclet"src"com"xdoclet"model"User.hbm.xml
- [schemaexport] (cfg.HbmBinder 300 ) Mapping class: com.xdoclet.model.User -> t_user
- [schemaexport] (dialect.Dialect 141 ) Using dialect: org.hibernate.dialect.MySQL5Dialect
- [schemaexport] (cfg.HbmBinder 2375) Mapping collection: com.xdoclet.model.Group.userSets -> t_user
- [schemaexport] (hbm2ddl.SchemaExport 154 ) Running hbm2ddl schema export
- [schemaexport] (hbm2ddl.SchemaExport 174 ) writing generated schema to file: E:"JAR"jbpm"jbpm-4.3"workspace"xdoclet"schema-export.sql
- [schemaexport]
- [schemaexport] alter table t_user
- [schemaexport] drop
- [schemaexport] foreign key FKCB63CCB6CEAB0634;
- [schemaexport]
- [schemaexport] drop table if exists t_group;
- [schemaexport]
- [schemaexport] drop table if exists t_user;
- [schemaexport]
- [schemaexport] create table t_group (
- [schemaexport] groupId varchar(255) not null,
- [schemaexport] groupName varchar(255),
- [schemaexport] primary key (groupId)
- [schemaexport] );
- [schemaexport]
- [schemaexport] create table t_user (
- [schemaexport] userId varchar(255) not null,
- [schemaexport] userName varchar(255),
- [schemaexport] groupId varchar(255),
- [schemaexport] primary key (userId)
- [schemaexport] );
- [schemaexport]
- [schemaexport] alter table t_user
- [schemaexport] add index FKCB63CCB6CEAB0634 (groupId),
- [schemaexport] add constraint FKCB63CCB6CEAB0634
- [schemaexport] foreign key (groupId)
- [schemaexport] references t_group (groupId);
- [schemaexport] (hbm2ddl.SchemaExport 196 ) schema export complete
- BUILD SUCCESSFUL
- Total time: 1 second
此时再刷新工程目录,就会发现已经生成了hibernate的配置文件和映射文件,而且sql 脚本竟然也生成了!最后如下:
再运行ExportTable.java(运行之前要先build path导入hibernate的jar包和MySQL驱动jar包),就生成了数据库表结构了,赶紧打开MySQL看一下吧!
源文件百度云下载:
屠龙宝刀,点击就送》》链接:http://pan.baidu.com/s/1hs2W5q0 密码:x2hp
参考: http://www.blogjava.net/sxyx2008/archive/2010/09/30/333554.html