# hibernate-plus

**Repository Path**: tenmg/hibernate-plus

## Basic Information

- **Project Name**: hibernate-plus
- **Description**: 集成hibernate、dsql、sql-paging三个框架，为Java应用提供强大的数据库读写能力
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-05-16
- **Last Updated**: 2023-07-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# hibernate-plus

## 介绍
集成hibernate、dsql和sql-paging三个框架，为Java应用提供强大的数据库读写能力。

## 使用说明

以基于Spring MVC的Maven项目为例

### 1.  pom.xml添加依赖

其中${hibernate-plus.version}为版本号，可定义属性或直接使用版本号替换。这里省略pom.xml的其他配置信息，其他配置请根据自己的项目实际自行添加。

```
<!-- https://mvnrepository.com/artifact/cn.tenmg/hibernate-plus -->
<dependency>
    <groupId>cn.tenmg</groupId>
    <artifactId>hibernate-plus</artifactId>
    <version>${hibernate-plus.version}</version>
</dependency>
```

### 2.  spring-context.xml配置文件

```
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:mvc="http://www.springframework.org/schema/mvc"
	xmlns:aop="http://www.springframework.org/schema/aop"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
            			http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
            			http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd
            			http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">
	<!-- 对cn.tenmg包及子包进行扫描，以完成Bean创建和自动依赖注入的功能 -->
	<context:component-scan base-package="cn.tenmg" />

	<!-- 启用注解驱动器，即开启注解配置的支持 -->
	<mvc:annotation-driven />

	<!-- 支持注解式切面编程 -->
	<aop:aspectj-autoproxy proxy-target-class="true" />

	<!-- 加载属性配置文件 -->
	<context:property-placeholder
		location="classpath:*.properties" ignore-unresolvable="true" />

	<!-- 通用配置 -->
	<import resource="spring-common.xml" />

	<!-- 缓存配置 -->
	<import resource="spring-redis.xml" />

	<!-- 邮件服务配置 -->
	<!-- <import resource="spring-mail.xml" /> -->

	<!-- 数据源配置 -->
	<import resource="spring-datasource.xml" />

	<!-- 事务配置 -->
	<import resource="spring-tx.xml" />

	<!-- hibernate ORM配置 -->
	<import resource="hibernate.xml" />

	<!-- hibernate-plus配置 -->
	<import resource="hibernate-plus.xml" />

	<!-- tenmg-security安全框架配置 -->
	<import resource="tenmg-security.xml" />

</beans>
```

### 3.  hibernate.xml配置文件


```
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:aop="http://www.springframework.org/schema/aop"
	xmlns:tx="http://www.springframework.org/schema/tx"
	xmlns:mvc="http://www.springframework.org/schema/mvc"
	xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd 
	http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
	http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd 
	http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd
	http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">

	<!-- 当前用户帮助类实例，实现cn.tenmg.hibernate.plus.interceptor.EntityInterceptor.CurrentUserGetter接口，为实体拦截器提供当前用户编号 -->
	<bean id="currentUserHelper"
		class="cn.tenmg.com.helper.CurrentUserHelper"></bean>

	<!-- 配置实体拦截器实例 -->
	<bean id="entityInterceptor"
		class="cn.tenmg.hibernate.plus.interceptor.EntityInterceptor">
		<!-- 配置实体对象创建者字段名，用于自动写入实体的创建者（默认为createUser） -->
		<property name="createUserFieldName" value="creUser" />
		<!-- 配置实体对象创建时间字段名，用于自动写入实体的创建时间（默认为createTime） -->
		<property name="createTimeFieldName" value="creTm" />
		<!-- 配置实体对象修改者字段名，用于自动写入实体的最后一次修改者（默认为modifyUser） -->
		<property name="modifyUserFieldName" value="modUser" />
		<!-- 配置实体对象修改时间字段名，用于自动写入实体的最后一次修改时间（默认为modifyTime） -->
		<property name="modifyTimeFieldName" value="modTm" />
		<!-- 配置实体对象创建时，是否更新修改者和修改时间（默认为true） -->
		<property name="updateModifyWhenCreate" value="true" />
		<!-- 配置当前用户获取器，用于获取当前用户信息（默认为cn.tenmg.hibernate.plus.interceptor.EntityInterceptor.EmptyCurrentUserGetter） -->
		<property name="currentUserGetter" ref="currentUserHelper" />
	</bean>

	<!-- 配置LocalSeessionFactoryBean，Hibernate Session工厂 -->
	<bean id="sessionFactory"
		class="org.springframework.orm.hibernate5.LocalSessionFactoryBean">
		<property name="dataSource" ref="masterSlaveDataSource" />
		<property name="hibernateProperties">
			<props>
				<!-- key的名字前面都要加hibernate。hibernate.dialect 只是Hibernate使用的数据库方言,就是要用Hibernate连接那种类型的数据库服务器。 -->
				<prop key="hibernate.dialect">${hibernate.dialect}</prop>
				<!--是否在后台显示Hibernate用到的SQL语句，开发时设置为true，便于查错，程序运行时可以在Eclipse的控制台显示Hibernate的执行Sql语句。 
					项目部署后可以设置为false，提高运行效率 -->
				<prop key="hibernate.show_sql">${hibernate.show_sql}</prop>
				<prop key="hibernate.format_sql">${hibernate.format_sql}</prop>
				<prop key="hibernate.id.new_generator_mappings">${hibernate.id.new_generator_mappings}</prop>
				<prop key="hibernate.hbm2ddl.auto">${hibernate.hbm2ddl.auto}</prop>
				<prop key="hibernate.cache.region.factory_class">${hibernate.cache.region.factory_class}</prop>
				<prop key="hibernate.cache.use_query_cache">${hibernate.cache.use_query_cache}</prop>
				<prop key="hibernate.cache.use_second_level_cache">${hibernate.cache.use_second_level_cache}
				</prop>
				<prop key="hibernate.jdbc.batch_size">${hibernate.jdbc.batch_size}</prop>
				<prop key="hibernate.jdbc.fetch_size">${hibernate.jdbc.fetch_size}</prop>
			</props>
		</property>
		<property name="packagesToScan">
			<value>cn.tenmg</value>
		</property>
		<property name="entityInterceptor" ref="entityInterceptor" />
	</bean>
</beans>
```


### 4.  hibernate-plus.xml配置文件


```
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

	<!-- 动态结构化查询语言(DSQL)工厂 -->
	<bean id="dsqlFactory"
		class="cn.tenmg.plus.factory.XMLFileDSQLFactory">
		<constructor-arg name="basePackages" value="dsql" />
	</bean>

	<!-- Dao配置 -->
	<bean id="dao" class="cn.tenmg.hibernate.plus.dao.impl.DaoImpl">
		<property name="sessionFactory" ref="sessionFactory" />
		<property name="dsqlFactory" ref="dsqlFactory" />
		<property name="dataSource" ref="masterSlaveDataSource" />
	</bean>
</beans>
```

### 5.  编写Controller

```
@Controller
@RequestMapping(value = "sec/user")
public class UserController {

	@Resource
	private UserService userService;

	……

	@RequestMapping(method = RequestMethod.GET, value = "page")
	public @ResponseBody Response page(@RequestParam Long currentPage, @RequestParam Integer pageSize,
			@RequestParam(required = false) String userName, @RequestParam(required = false) String roleId,
			@RequestParam(required = false) String menuId, @RequestParam(required = false) String intfcId) {
		return Response.status(Response.SUCCESS)
				.value(userService.page(currentPage, pageSize, userName, roleId, menuId, intfcId));
	}

	@RequestMapping(method = RequestMethod.POST)
	public @ResponseBody Response post(@RequestBody String body) {
		JSONObject json = JsonUtils.createCheck(body, "userName", "password");
		User user = new User();
		json = JsonUtils.remove(json, "userId", "creUser", "creTm", "modUser", "modTm");
		user.setState(UserState.NORMAL);
		String password = SecurityUtils.getSecurityManager().getEncryptor().encrypt(json.getString("password"));
		json.put("password", password);
		JsonUtils.loadJson(user, json);
		return Response.status(Response.SUCCESS).message("保存成功").value(this.userService.save(user));
	}

        ……

}
```

### 6. 编写Service及实现类

6.1 编写用户服务接口

```
public interface UserService extends Service<User> {

        ……

	Page<User> page(Long currentPage, Integer pageSize, String userName, String roleId, String menuId, String intfcId);

        ……

}
```

6.1 编写用户服务实现类，其中“sec.user.find”为DSQL的全局唯一编号，这样DSQL就可以通过配置文件来管理，如果逻辑发生变更，不需要总是调整java代码。

```
@Service
public class UserServiceImpl extends ServiceImpl<User> implements UserService {

        ……

	@Override
	public Page<User> page(Long currentPage, Integer pageSize, String userName, String roleId, String menuId,
			String intfcId) {
		return this.page(User.class, "sec.user.find", currentPage, pageSize, "valid", State.VALID, "roleId", roleId,
				"menuId", menuId, "intfcId", intfcId, "userName", userName);
	}

        ……
        
}
```

6.3 其中，封装一个基础服务类ServiceImpl，该类继承自cn.tenmg.hibernate.plus.service.impl.AbstractService以便继承对数据库的CURD操作。该类仅需注入配置的Dao并实现getDao方法即可。AbstractService主要是基于Dao的接口实现并指定了所对应的实体类型，以便简化对 Service对应的实体对象 的CURD操作。如果不进行此项封装，也可以每个Service实现类单独注入Dao，并使用Dao的接口执行CURD操作。

```
/**
 * 数据库访问基础服务
 * 
 * @author June
 *
 * @param <P>
 */
public class ServiceImpl<P> extends cn.tenmg.hibernate.plus.service.impl.AbstractService<P> {

	@Autowired
	protected Dao dao;

	@Override
	protected Dao getDao() {
		return dao;
	}

}
```

### 7. 配置DSQL文件

配置`user.dsql.xml`，注意需要将文件放在`XMLFileDSQLFactory`扫描的路径下。

```
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE xml>
<dsqls xmlns="http://www.10mg.cn/schema/dsql"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.10mg.cn/schema/dsql http://www.10mg.cn/schema/dsql.xsd">

	<!-- 查询用户信息 -->
	<dsql id="sec.user.find">
		<filter>
			<blank params="*"/>
		</filter>
		<converter>
			<wrap-string params="userName" formatter="%${value}%"/>
		</converter>
		<script>
			<![CDATA[
			SELECT
			  U.USER_ID userId,
			  U.USER_NAME userName,
			  U.STATE state,
			  U.CRE_TM creTm,
			  U.MOD_TM modTm
			FROM SEC_USER AS U
			WHERE 1=1
			#[AND EXISTS (
			  SELECT
			    *
			  FROM SEC_USER_ROLE R
			  WHERE R.USER_ID = U.USER_ID
			    AND R.STATE = :valid
			    AND R.ROLE_ID = :roleId
			)]
			#[AND EXISTS (
			  SELECT
			    *
			  FROM SEC_USER_ROLE R
			  LEFT JOIN SEC_ROLE_MENU M ON M.ROLE_ID = R.ROLE_ID
			  WHERE R.USER_ID = U.USER_ID
			    AND R.STATE = :valid
			    AND M.STATE = :valid AND M.MENU_ID = :menuId
			)]
			#[AND (
			  EXISTS (
			    SELECT
			      *
			    FROM SEC_USER_ROLE R
			    LEFT JOIN SEC_ROLE_INTFC I ON I.ROLE_ID = R.ROLE_ID
			    WHERE R.USER_ID = U.USER_ID
			      AND R.STATE = :valid
			      AND (R.ROLE_ID = :superRole OR (I.STATE = :valid AND I.INTFC_ID = :intfcId))
			  ) OR EXISTS (
			    SELECT
			      *
			    FROM SEC_USER_ROLE R, SEC_ROLE_MENU M
			    WHERE M.ROLE_ID = R.ROLE_ID
			      AND R.USER_ID = U.USER_ID
			      AND R.STATE = :valid
			      AND M.STATE = :valid
			      AND M.MENU_ID = (SELECT I.MENU_ID FROM SEC_INTFC I WHERE I.AUTHORIZABLE = FALSE AND I.INTFC_ID = :intfcId)
			  )
			)]
			#[AND U.USER_NAME LIKE :userName]
			ORDER BY U.USER_ID
			]]>
		</script>
	</dsql>

</dsqls>

```

##  相关链接

dsql开源地址：https://gitee.com/tenmg/dsql

sql-paging开源地址：https://gitee.com/tenmg/sql-paging