Hibernate Tools 自定义模板

最新推荐文章于 2021-10-08 00:10:25 发布
原创 最新推荐文章于 2021-10-08 00:10:25 发布 · 2k 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #hibernate

本文介绍了如何自定义Hibernate Tools的模板。首先，找到默认模板的存放位置，并复制到外部进行修改，特别是针对daodaohome.ftl的调整。然后在Hibernate Code Generation中选择使用自定义模板并指定修改后的目录。同时，要注意在Hibernate配置文件中设置`hibernate.current_session_context_class`为`thread`，避免给`session-factory`命名以防止错误。最后提供了一个修改后的daohome.ftl示例，包含了SessionFactory获取、插入操作和事务处理功能。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

1，默认使用的模板文件位置

eclipse home/plugins/org.jboss.tools.hibernate3_6_3.7.0.Beta2-v20130614-1624-B67.jar  将此jar包解开，\lib\tools\hibernate-tools-3.6.0.CR1

全路径：eclipse home\plugins\org.jboss.tools.hibernate3_6_3.7.0.Beta2-v20130614-1624-B67\lib\tools\hibernate-tools-3.6.0.CR1

 

2，将此目录COPY出来，保持目录结构，修改相应目录下的ftl文件即可，主要修改dao\daohome.ftl

 

3，使用方式，在Hibernate Code Generation 的时候选择 use custom templates ， 定位到step 2的目录即可。

 

4，注意，当使用sessionFactory.getCurrentSession()获取session时，需要在Hibernate配置文件中增加 <property name="hibernate.current_session_context_class">thread</property>

 

5，注意，Hibernate配置文件中不能给session-factory命名，如<session-factory name="xxxxx"> 这样会报错，保持<session-factory> ，不要名字

 

一个修改了SessionFactory获取方式，增加了insert和批量insert以及事务处理的daohome.ftl如下：

 

${pojo.getPackageDeclaration()}
// Generated ${date} by Hibernate Tools ${version}

<#assign classbody>
<#assign declarationName = pojo.importType(pojo.getDeclarationName())>/**
 * Home object for domain model class ${declarationName}.
 * @see ${pojo.getQualifiedDeclarationName()}
 * @author Hibernate Tools
 */
<#if ejb3>
@${pojo.importType("javax.ejb.Stateless")}
</#if>

public class ${declarationName}Home {

    private static final ${pojo.importType("org.apache.commons.logging.Log")} log = ${pojo.importType("org.apache.commons.logging.LogFactory")}.getLog(${pojo.getDeclarationName()}Home.class);

<#if ejb3>
    @${pojo.importType("javax.persistence.PersistenceContext")} private ${pojo.importType("javax.persistence.EntityManager")} entityManager;
    
    public void persist(${declarationName} transientInstance) {
        log.debug("persisting ${declarationName} instance");
        try {
            entityManager.persist(transientInstance);
            log.debug("persist successful");
        }
        catch (RuntimeException re) {
            log.error("persist failed", re);
            throw re;
        }
    }
    
    public void remove(${declarationName} persistentInstance) {
        log.debug("removing ${declarationName} instance");
        try {
            entityManager.remove(persistentInstance);
            log.debug("remove successful");
        }
        catch (RuntimeException re) {
            log.error("remove failed", re);
            throw re;
        }
    }
    
    public ${declarationName} merge(${declarationName} detachedInstance) {
        log.debug("merging ${declarationName} instance");
        try {
            ${declarationName} result = entityManager.merge(detachedInstance);
            log.debug("merge successful");
            return result;
        }
        catch (RuntimeException re) {
            log.error("merge failed", re);
            throw re;
        }
    }
    
<#if clazz.identifierProperty?has_content>    
    public ${declarationName} findById( ${pojo.getJavaTypeName(clazz.identifierProperty, jdk5)} id) {
        log.debug("getting ${declarationName} instance with id: " + id);
        try {
            ${declarationName} instance = entityManager.find(${pojo.getDeclarationName()}.class, id);
            log.debug("get successful");
            return instance;
        }
        catch (RuntimeException re) {
            log.error("get failed", re);
            throw re;
        }
    }
</#if>
<#else>    
    private final ${pojo.importType("org.hibernate.SessionFactory")} sessionFactory = getSessionFactory();
    private ${pojo.importType("org.hibernate.Transaction")} sessionTrans = null;
    private ${pojo.importType("org.hibernate.Session")} session = null;
    
    protected ${pojo.importType("org.hibernate.SessionFactory")} getSessionFactory() {
        try {
            return (${pojo.importType("org.hibernate.SessionFactory")})new ${pojo.importType("org.hibernate.cfg.Configuration")}().configure().buildSessionFactory();
        }
        catch (Exception e) {
            log.error("Could not buildSessionFactory", e);
            throw new IllegalStateException("Could not buildSessionFactory");
        }
    }
    
    public void persist(${declarationName} transientInstance) {
        log.debug("persisting ${declarationName} instance");
        try {
            sessionFactory.getCurrentSession().persist(transientInstance);
            log.debug("persist successful");
        }
        catch (RuntimeException re) {
            log.error("persist failed", re);
            throw re;
        }
    }
    
    public void attachDirty(${declarationName} instance) {
        log.debug("attaching dirty ${declarationName} instance");
        try {
            sessionFactory.getCurrentSession().saveOrUpdate(instance);
            log.debug("attach successful");
        }
        catch (RuntimeException re) {
            log.error("attach failed", re);
            throw re;
        }
    }
    
    public void insert(${declarationName} instance) {
        log.debug("insert ${declarationName} instance");
        try {
        	 session = sessionFactory.getCurrentSession();
        	 sessionTrans = session.beginTransaction();
        	 
            session.saveOrUpdate(instance);
            
            sessionTrans.commit();
            log.debug("insert successful");
        }
        catch (RuntimeException re) {
            log.error("insert failed", re);
            throw re;
        }
    }
    
    /**
    *Use Transaction， Success or Fail together
    */
    public void insert(List<${declarationName}> instances) {
        log.debug("insert ${declarationName} instances");
        try {
        	 session = sessionFactory.getCurrentSession();
        	 sessionTrans = session.beginTransaction();
        	 
        	 for (${declarationName} instance : instances)
        	 {
            	session.saveOrUpdate(instance);
            }
            
            sessionTrans.commit();
            log.debug("insert successful");
        }
        catch (RuntimeException re) {
        	 sessionTrans.rollback();
            log.error("insert failed", re);
            throw re;
        }
    }
    
    /**
    *Insert one by one, some success and some fail
    */
    public void insertDirty(List<${declarationName}> instances) {
        log.debug("insert ${declarationName} instances");
        session = sessionFactory.getCurrentSession();
        sessionTrans = session.beginTransaction();
        
        for (${declarationName} instance : instances)
        {
	        try {
	            session.saveOrUpdate(instance);
	        }
	        catch (RuntimeException re) {
	            log.error("insert failed", re);
	        }
	    }
	    
	    sessionTrans.commit();
    }
    
    public void attachClean(${declarationName} instance) {
        log.debug("attaching clean ${declarationName} instance");
        try {
            sessionFactory.getCurrentSession().lock(instance, ${pojo.importType("org.hibernate.LockMode")}.NONE);
            log.debug("attach successful");
        }
        catch (RuntimeException re) {
            log.error("attach failed", re);
            throw re;
        }
    }
    
    public void delete(${declarationName} persistentInstance) {
        log.debug("deleting ${declarationName} instance");
        try {
            sessionFactory.getCurrentSession().delete(persistentInstance);
            log.debug("delete successful");
        }
        catch (RuntimeException re) {
            log.error("delete failed", re);
            throw re;
        }
    }
    
    public ${declarationName} merge(${declarationName} detachedInstance) {
        log.debug("merging ${declarationName} instance");
        try {
            ${declarationName} result = (${declarationName}) sessionFactory.getCurrentSession()
                    .merge(detachedInstance);
            log.debug("merge successful");
            return result;
        }
        catch (RuntimeException re) {
            log.error("merge failed", re);
            throw re;
        }
    }
    
<#if clazz.identifierProperty?has_content>
    public ${declarationName} findById( ${c2j.getJavaTypeName(clazz.identifierProperty, jdk5)} id) {
        log.debug("getting ${declarationName} instance with id: " + id);
        try {
            ${declarationName} instance = (${declarationName}) sessionFactory.getCurrentSession()
                    .get("${clazz.entityName}", id);
            if (instance==null) {
                log.debug("get successful, no instance found");
            }
            else {
                log.debug("get successful, instance found");
            }
            return instance;
        }
        catch (RuntimeException re) {
            log.error("get failed", re);
            throw re;
        }
    }
</#if>
    
<#if clazz.hasNaturalId()>
    public ${declarationName} findByNaturalId(${c2j.asNaturalIdParameterList(clazz)}) {
        log.debug("getting ${declarationName} instance by natural id");
        try {
            ${declarationName} instance = (${declarationName}) sessionFactory.getCurrentSession()
                    .createCriteria("${clazz.entityName}")
<#if jdk5>
                    .add( ${pojo.staticImport("org.hibernate.criterion.Restrictions", "naturalId")}()
<#else>
                   .add( ${pojo.importType("org.hibernate.criterion.Restrictions")}.naturalId()
</#if>                    
<#foreach property in pojo.getAllPropertiesIterator()>
<#if property.isNaturalIdentifier()>
                            .set("${property.name}", ${property.name})
</#if>
</#foreach>
                        )
                    .uniqueResult();
            if (instance==null) {
                log.debug("get successful, no instance found");
            }
            else {
                log.debug("get successful, instance found");
            }
            return instance;
        }
        catch (RuntimeException re) {
            log.error("query failed", re);
            throw re;
        }
    }
</#if>    
<#if jdk5>
    public ${pojo.importType("java.util.List")}<${declarationName}> findByExample(${declarationName} instance) {
<#else>
    public ${pojo.importType("java.util.List")} findByExample(${declarationName} instance) {
</#if>
        log.debug("finding ${declarationName} instance by example");
        try {
<#if jdk5>
            ${pojo.importType("java.util.List")}<${declarationName}> results = (List<${declarationName}>) sessionFactory.getCurrentSession()
<#else>
            ${pojo.importType("java.util.List")} results = sessionFactory.getCurrentSession()
</#if>
                    .createCriteria("${clazz.entityName}")
<#if jdk5>
                    .add( ${pojo.staticImport("org.hibernate.criterion.Example", "create")}(instance) )
<#else>
                    .add(${pojo.importType("org.hibernate.criterion.Example")}.create(instance))
</#if>
            .list();
            log.debug("find by example successful, result size: " + results.size());
            return results;
        }
        catch (RuntimeException re) {
            log.error("find by example failed", re);
            throw re;
        }
    } 
<#foreach queryName in cfg.namedQueries.keySet()>
<#if queryName.startsWith(clazz.entityName + ".")>
<#assign methname = c2j.unqualify(queryName)>
<#assign params = cfg.namedQueries.get(queryName).parameterTypes><#assign argList = c2j.asFinderArgumentList(params, pojo)>
<#if jdk5 && methname.startsWith("find")>
    public ${pojo.importType("java.util.List")}<${declarationName}> ${methname}(${argList}) {
<#elseif methname.startsWith("count")>
    public int ${methname}(${argList}) {
<#else>
    public ${pojo.importType("java.util.List")} ${methname}(${argList}) {
</#if>
        ${pojo.importType("org.hibernate.Query")} query = sessionFactory.getCurrentSession()
                .getNamedQuery("${queryName}");
<#foreach param in params.keySet()>
<#if param.equals("maxResults")>
		query.setMaxResults(maxResults);
<#elseif param.equals("firstResult")>
        query.setFirstResult(firstResult);
<#else>
        query.setParameter("${param}", ${param});
</#if>
</#foreach>
<#if jdk5 && methname.startsWith("find")>
        return (List<${declarationName}>) query.list();
<#elseif methname.startsWith("count")>
        return ( (Integer) query.uniqueResult() ).intValue();
<#else>
        return query.list();
</#if>
    }
</#if>
</#foreach></#if>
}
</#assign>

${pojo.generateImports()}
${classbody}


 

自定义 Hibernate Tools 的模板
07-01
eclipse下使用hibernate tools实现hibernate逆向工程时 生成实体类时可以自动添加数据库中的注释
hibernate tools 实现定制
xly_971223的专栏
12-13 135
[code]package tt; import org.hibernate.cfg.reveng.DelegatingReverseEngineeringStrategy; import org.hibernate.cfg.reveng.ReverseEngineeringStrategy; import org.hibernate.cfg.reveng.TableIdentifier; ...
MyEclipse利用自定义模板生成hibernate的dao或实体
yushuainihao的博客
10-19 2608
最近一直在学习SSH(Spring+Strucs+hibernate)相关知识，自己尝试着利用这三大框架定制适合自己业务的框架架构，其中就遇到过如何生成自己的想要的dao，下面给大家分享一下，我的经验： 1.新建一个包，分别建有dao，hbm，pojo文件夹，其实想想就知道，这就是对应的生成的三类文件。 2.以定制自己的dao为例，新建一个daohome.vm(不能随意更改)，
自己的修改hibernate-tools的模板和修复Comment乱码问题
EternalSnow
11-02 434
关于自定义   之前一直用hibernate-tools来生成PO和映射的HBM文件，觉得确实挺方便的。但久而久之就有更懒的念头，就是把DAO也同时根据PO来生成了，这样工作量可以更加减少。   实际上之前用MyEclipse来做反向生成PO和DAO的话是比默认的hibernate-tools要好，要更符合我们使用习惯一些。其实这一切就是MyEclipse做了他自己的修改所致。   默...
掌握Hibernate Tools模板的自定义方法
自定义Hibernate Tools的模板，意味着我们能够在Hibernate Tools的基础上，根据自己的项目需求或者个人喜好，定制特定的代码生成规则。比如，对于实体类命名习惯、数据库表映射方式、以及服务层代码等，都可以按照...
优化 Hibernate Tools 模板以自动添加数据库注释
在自定义模板时，需要使用Hibernate Tools提供的变量和标记来引用数据库的元数据。例如，`${table.comment}`可以用于引用当前数据库表的注释信息。 5. **模板中的逻辑和控制语句** 模板不仅包含静态文本，还可以...
Hibernate Tools使用指南
03-19
在Eclipse中，右键选择项目，依次点击“Hibernate” -> “Generate Hibernate Artifacts”，然后选择相应的模板进行代码生成。 **5. 数据库同步** 当数据库表结构发生变化时，Hibernate Tools的数据库同步功能可以...
hibernate-tools maven插件
houjguang的专栏
09-03 449
&lt;plugin&gt; &lt;groupId&gt;org.codehaus.mojo&lt;/groupId&gt; &lt;artifactId&gt;hibernate3-maven-plugin&lt;/artifactId&gt; &lt;version&gt;3.1-SNAPSHOT&lt;/version&gt; &lt;!-- &lt;version&a
hibernate反向工程模板（已修改）
10-01
hibernate反向工程模板（已修改）
hibernate3-maven-plugin插件入门
一个菜鸟的博客
03-25 2274
1.在pom.xml中引入和配置hibernate3-maven-plugin插件，并引入Hibernate Tools的依赖项目。配置hibernate3-maven-plugin插件：<plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>hibernate3-maven-
hibernate3-maven-plugin配置
atec2000的专栏
05-23 3120
将以下内容添加到maven的pom.xml中。 build> plugins> plugin> groupId>org.codehaus.mojogroupId> artifactId>hibernate3-maven-pluginartifactId> version>2.2version> configuration> components> component>
eclipse用Hibernate3-maven-plugin插件反转生成实体类
宏微的博客
02-21 2172
eclipse用Hibernate3-maven-plugin插件反转生成实体类
Spring Data JPA--根据表生成代码--方法
IT利刃出鞘的博客
10-08 2753
原文网址：JPA--根据表生成代码_IT利刃出鞘的博客-优快云博客 简介 说明 我们可以根据已有的表来生成代码（Entity、DAO、Service、Controller），省去手写的时间。MybatisPlus的自动生成代码的工程见：Mybatis-Plus--根据表生成代码_IT利刃出鞘的博客-优快云博客。 本文参考Mybatis-Plus的这种方案，来生成我们JPA相关类。本方案优点如下： 不依赖于工具。只要有文本编辑器，有JDK，就可以运行。 可以自......
Eclipse 中Hibernate tools 的安装和使用
坚持学习
10-11 459
eclipse 远程安装hibernate插件 自动生成model、map、dao 类。    一：安装hibernate插件 步骤如下 eclipse-&gt;Help&gt;Install New Software&gt;Find and Install-&gt;add-&gt;  (name:hibernate,URL:http://download.jboss.org/jbosst...
maven hibernate 命令式逆向工程 (不使用主流的Hibernate Tools工具界面操作)
hins
04-24 3663
hibernate总配置文件hibernate.cfg.xml（使用该方法的前提条件） <!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-configuration-3.0.
教你使用Hibernate tools，生成带中文注释的类和hbm文件
lisq037的专栏
06-24 8942
实现效果如下： package com.fsti.ssh.entity.hibernate; // Generated 2013-6-21 18:10:59 by Hibernate Tools 3.4.0.CR1 import java.math.BigDecimal; import java.util.Date; import java.util.LinkedHashMap; i
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值