让MyBatis Generator产生的Mapper更简洁
本文提供一种方法，目标是让MyBatis Generator产生的Mapper更简洁。html
主要体如今以下几个方面：java
- 有一个BaseMapper（本身编写）
- 全部产生的Mapper继承BaseMapper，无需每一个Mapper都要定义好多接口方法
- 除了产生的Mapper有改动以外，其他自动产生的Entity、Example、XML文件保持不变
背景
不一样Mapper的内容比较
好比，咱们创建两个测试表，一个是t_user, 一个是t_news。其建表语句以下：sql
CREATE TABLE `t_user` ( `user_id` int(11) NOT NULL AUTO_INCREMENT, `email` varchar(64) DEFAULT NULL, `name` varchar(30) DEFAULT NULL, PRIMARY KEY (`user_id`) ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;
CREATE TABLE `t_news` ( `news_id` int(11) NOT NULL AUTO_INCREMENT, `title` varchar(150) NOT NULL, `content` text NOT NULL, `brief_intro` varchar(255) DEFAULT NULL, `pic_url` varchar(255) DEFAULT NULL, `news_from` varchar(100) DEFAULT NULL, `news_author` varchar(50) DEFAULT NULL, `news_url` varchar(255) DEFAULT NULL, `keywords` varchar(150) DEFAULT NULL, `meta_desc` varchar(150) DEFAULT NULL, `create_time` datetime DEFAULT NULL, PRIMARY KEY (`news_id`) ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8
而后，咱们比较一下自动产生的Mapper有什么区别？数据库
UserMapper.javaapache
import java.util.List;
import my.mybatis.generator.auto.entity.User;
import my.mybatis.generator.auto.entity.UserExample;
import org.apache.ibatis.annotations.Param;
public interface UserMapper {
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table t_user
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int countByExample(UserExample example);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table t_user
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int deleteByExample(UserExample example);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table t_user
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int deleteByPrimaryKey(Integer userId);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table t_user
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int insert(User record);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table t_user
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int insertSelective(User record);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table t_user
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
List<User> selectByExample(UserExample example);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table t_user
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
User selectByPrimaryKey(Integer userId);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table t_user
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int updateByExampleSelective(@Param("record") User record, @Param("example") UserExample example);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table t_user
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int updateByExample(@Param("record") User record, @Param("example") UserExample example);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table t_user
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int updateByPrimaryKeySelective(User record);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table t_user
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int updateByPrimaryKey(User record);
}
NewsMapper.javaapi
import java.util.List;
import my.mybatis.generator.auto.entity.News;
import my.mybatis.generator.auto.entity.NewsExample;
import org.apache.ibatis.annotations.Param;
public interface NewsMapper {
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int countByExample(NewsExample example);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int deleteByExample(NewsExample example);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int deleteByPrimaryKey(Integer newsId);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int insert(News record);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int insertSelective(News record);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
List<News> selectByExampleWithBLOBs(NewsExample example);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
List<News> selectByExample(NewsExample example);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
News selectByPrimaryKey(Integer newsId);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int updateByExampleSelective(@Param("record") News record, @Param("example") NewsExample example);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int updateByExampleWithBLOBs(@Param("record") News record, @Param("example") NewsExample example);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int updateByExample(@Param("record") News record, @Param("example") NewsExample example);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int updateByPrimaryKeySelective(News record);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int updateByPrimaryKeyWithBLOBs(News record);
/**
* This method was generated by MyBatis Generator.
* This method corresponds to the database table m_news
*
* @mbggenerated Wed Nov 09 10:23:34 CST 2016
*/
int updateByPrimaryKey(News record);
}
从上述两个自动产生的Mapper能够看出，session
除了Entity、Entity对应的Example以及Primary Key可能会变化以外，其他全部的方法名都是同样的。mybatis
分析
若是是这样自动产生代码，那么各个Mapper势必有不少重复的代码，不直观。app
那么，问题来了？dom
可不能够将这些通用的方法定义在一个BaseMapper中，而后，其他自动产生的Mapper继承自BaseMapper，且与各自的Entity、Example、Primary KEY绑定在一块儿呢？
好比：
定义一个BaseMapper.java，其中，
- T表示与table表对应的实体类（Entity）
- E表示Entity对应的Example类
- PK表示可能会用到主键 (好比Integer等)
以下所示：
package my.mabatis.example.base;
import java.io.Serializable;
import java.util.List;
import org.apache.ibatis.annotations.Param;
/**
*
* @author wangmengjun
*
*/
public interface BaseMapper<T, E, PK extends Serializable> {
long countByExample(E example);
int deleteByExample(E example);
int deleteByPrimaryKey(PK pk);
int insert(T record);
int insertSelective(T record);
List<T> selectByExample(E example);
T selectByPrimaryKey(PK pk);
int updateByExampleSelective(@Param("record") T record,
@Param("example") E example);
int updateByExample(@Param("record") T record, @Param("example") E example);
int updateByPrimaryKeySelective(T record);
int updateByPrimaryKey(T record);
}
那么，
UserMapper.java就变成相似以下的样子了。
public interface NewsMapper extends BaseMapper<News, NewsExample, Integer> {
}
接下来，咱们就来看看如何完成去达到这样的目标。Let‘s GO~~~~
解决方法
改源代码
改源代码？
若是一个工具，让产生的Dao继承一个BaseMapper，都须要经过源码来完成，那其扩展性可见通常。 不建议使用，这个只能是没有办法的时候才会使用。
由于，上述考虑的都是Mapper，那么，若是改动源代码的话，咱们就在org.mybatis.generator.codegen.mybatis3.javamapper.JavaMapperGenerator类中修改便可。
修改包含两个部分，
- 不在Mapper中添加任何方法，由于这些都在BaseMapper中存在了，只要继承便可。
- 产生Mapper的时候，指定父类接口BaseMapper, 实体类类型、Example类型、主键类型。
具体在JavaMapperGenerator类的getCompilationUnits方法下进行：
public List<CompilationUnit> getCompilationUnits() {
//省略全部方法内容
}
- 移除添加方法的代码
addCountByExampleMethod(interfaze);
addDeleteByExampleMethod(interfaze);
addDeleteByPrimaryKeyMethod(interfaze);
addInsertMethod(interfaze);
addInsertSelectiveMethod(interfaze);
addSelectByExampleWithBLOBsMethod(interfaze);
addSelectByExampleWithoutBLOBsMethod(interfaze);
addSelectByPrimaryKeyMethod(interfaze);
addUpdateByExampleSelectiveMethod(interfaze);
addUpdateByExampleWithBLOBsMethod(interfaze);
addUpdateByExampleWithoutBLOBsMethod(interfaze);
addUpdateByPrimaryKeySelectiveMethod(interfaze);
addUpdateByPrimaryKeyWithBLOBsMethod(interfaze);
addUpdateByPrimaryKeyWithoutBLOBsMethod(interfaze);
- 指定父类接口BaseMapper, 实体类类型等
在上述移除的代码块中添加相似以下代码块。
/**
* 主键默认采用java.lang.Integer
*/
FullyQualifiedJavaType fqjt = new FullyQualifiedJavaType("BaseMapper<"
+ introspectedTable.getBaseRecordType() + ","
+ introspectedTable.getExampleType() + ","
+ "java.lang.Integer" + ">");
FullyQualifiedJavaType imp = new FullyQualifiedJavaType(
"my.mabatis.example.base.BaseMapper");
/**
* 添加 extends MybatisBaseMapper
*/
interfaze.addSuperInterface(fqjt);
/**
* 添加import my.mabatis.example.base.MybatisBaseMapper;
*/
interfaze.addImportedType(imp);
/**
* 方法不须要
*/
interfaze.getMethods().clear();
而后，而后就搞定了。 : )
不改源代码？
尽管修改源代码的方式可行，可是侵入性太强。
其实，MyBatis Generator自动代码产生工具已经提供插件适配扩展的功能，咱们只要继承PluginAdapter便可。而后，重写clientGenerated方法便可。
@Override
public boolean clientGenerated(Interface interfaze,
TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
}
具体代码以下：
默认采用java.lang.Integer做为主键。
package my.mabatis.example.plugin;
import java.util.List;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.api.dom.java.Interface;
import org.mybatis.generator.api.dom.java.TopLevelClass;
/**
* @author wangmengjun
*
*/
public class BaseMapperGeneratorPlugin extends PluginAdapter {
public boolean validate(List<String> warnings) {
return true;
}
/**
* 生成dao
*/
@Override
public boolean clientGenerated(Interface interfaze,
TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
/**
* 主键默认采用java.lang.Integer
*/
FullyQualifiedJavaType fqjt = new FullyQualifiedJavaType("BaseMapper<"
+ introspectedTable.getBaseRecordType() + ","
+ introspectedTable.getExampleType() + ","
+ "java.lang.Integer" + ">");
FullyQualifiedJavaType imp = new FullyQualifiedJavaType(
"my.mabatis.example.base.BaseMapper");
/**
* 添加 extends MybatisBaseMapper
*/
interfaze.addSuperInterface(fqjt);
/**
* 添加import my.mabatis.example.base.MybatisBaseMapper;
*/
interfaze.addImportedType(imp);
/**
* 方法不须要
*/
interfaze.getMethods().clear();
interfaze.getAnnotations().clear();
return true;
}
}
接着，在用于自动产生代码的配置文件中generatorConfig.xml指定自定义的plugin。
如：
<!-- 配置内置的或者自定义的Plugin -->
<plugin type="my.mabatis.example.plugin.BaseMapperGeneratorPlugin" />
详细配置如：
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >
<generatorConfiguration>
<!-- 引入配置文件 -->
<properties resource="jdbc.properties" />
<context id="context1" targetRuntime="MyBatis3">
<!-- 配置内置的或者自定义的Plugin -->
<plugin type="my.mabatis.example.plugin.BaseMapperGeneratorPlugin" />
<!-- 注释产生配置 -->
<commentGenerator>
<property name="suppressAllComments" value="false" />
<property name="suppressDate" value="false" />
</commentGenerator>
<!-- 数据库链接信息 -->
<jdbcConnection driverClass="${jdbc.driverClassName}"
connectionURL="${jdbc.url}" userId="${jdbc.username}" password="${jdbc.password}" />
<!-- 生成Model对象路径配置 -->
<javaModelGenerator targetPackage="my.mybatis.generator.auto.entity"
targetProject="src\main\java">
<property name="enableSubPackages" value="true" />
<property name="trimStrings" value="true" />
</javaModelGenerator>
<!-- 生成sqlXML文件路径配置 -->
<sqlMapGenerator targetPackage="my.mybatis.generator.auto.entity.xml"
targetProject="src\main\java">
<property name="enableSubPackages" value="true" />
</sqlMapGenerator>
<!-- 生成DAO的类文件路径配置 -->
<javaClientGenerator targetPackage="my.mybatis.generator.auto.dao"
targetProject="src\main\java" type="XMLMAPPER">
<property name="enableSubPackages" value="true" />
</javaClientGenerator>
<!--要生成哪些表 -->
<table tableName="t_user" domainObjectName="User" />
<table tableName="t_news" domainObjectName="News" />
</context>
</generatorConfiguration>
通过上述几个步骤，从新生成代码，就能够看到生成的Mapper，包括UserMapper和NewsMapper都已经发生了变化，而这正是咱们所指望的。
public interface NewsMapper extends BaseMapper<News, NewsExample, Integer> {
}
public interface UserMapper extends BaseMapper<User, UserExample, Integer> {
}
自动产生的Mapper继承于BaseMapper，变得相对较为干净。
接下来，咱们就来测试一下，是否管用。
测试验证
建立mybatis-config.xml文件
在src/main/resource目录下建立mybatis-config.xml配置文件。内容以下：
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<properties resource="jdbc.properties" />
<typeAliases>
<typeAlias type="my.mybatis.generator.auto.entity.User"
alias="User" />
</typeAliases>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC" />
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driverClassName}" />
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="my/mybatis/generator/auto/entity/xml/UserMapper.xml" />
</mappers>
</configuration>
建立一个MyBatisUtil工具类
package my.mabatis.example.util;
import java.io.IOException;
import java.io.Reader;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
/**
*
* @author wangmengjun
*
*/
public class MyBatisUtil {
private static SqlSessionFactory factory;
private MyBatisUtil() {
}
static {
Reader reader = null;
try {
reader = Resources.getResourceAsReader("mybatis-config.xml");
} catch (IOException e) {
throw new RuntimeException(e.getMessage());
}
factory = new SqlSessionFactoryBuilder().build(reader);
}
public static SqlSessionFactory getSqlSessionFactory() {
return factory;
}
}
编写Service类
由于只是很简单的操做，因此service就不分接口和实现了，直接上代码。
package my.mabatis.example.service;
import java.util.List;
import my.mabatis.example.util.MyBatisUtil;
import my.mybatis.generator.auto.dao.UserMapper;
import my.mybatis.generator.auto.entity.User;
import my.mybatis.generator.auto.entity.UserExample;
import my.mybatis.generator.auto.entity.UserExample.Criteria;
import org.apache.ibatis.session.SqlSession;
/**
*
* @author wangmengjun
*
*/
public class UserService {
/**
* 保存用户
* @param user 待保存用户对象
*/
public void insertUser(User user) {
SqlSession sqlSession = MyBatisUtil.getSqlSessionFactory()
.openSession();
try {
UserMapper userDao = sqlSession.getMapper(UserMapper.class);
userDao.insert(user);
sqlSession.commit();
} finally {
sqlSession.close();
}
}
/**
* 按照指定email返回用户
* @param email
* @return 按照指定email返回用户
*/
public User findUserByEmail(String email) {
SqlSession sqlSession = MyBatisUtil.getSqlSessionFactory()
.openSession();
try {
UserMapper userDao = sqlSession.getMapper(UserMapper.class);
/**
* 使用Example来操做
*/
UserExample example = new UserExample();
Criteria criteria = example.createCriteria();
criteria.andEmailEqualTo(email);
List<User> users = userDao.selectByExample(example);
/**
* 假定email惟一
*/
return users.isEmpty() ? null : users.get(0);
} finally {
sqlSession.close();
}
}
}
测试类和运行结果
package my.mabatis.example.runner;
import my.mabatis.example.service.UserService;
import my.mybatis.generator.auto.entity.User;
public class Test {
public static void main(String[] args) {
UserService userService = new UserService();
User userToInsert = new User();
userToInsert.setEmail("wmj123456@test.com");
userToInsert.setName("mengjun");
userService.insertUser(userToInsert);
User user = userService.findUserByEmail("wmj123456@test.com");
System.out.println(user.getEmail());
System.out.println(user.getName());
}
}
输出结果：
log4j:WARN No appenders could be found for logger (org.apache.ibatis.logging.LogFactory). log4j:WARN Please initialize the log4j system properly. log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info. wmj123456@test.com mengjun
保存用户信息和查看用户信息都能成功执行，代码可用。至此，整个流程就结束了。
Note:
整个代码都是在上一篇文章<<使用MyBatis Generator自动生成代码>>的基础上改动的，如对generatorConfig.xml等配置文件或者对如何自动产生代码有疑问，能够参考一下。
工程结构
相关文章
- 1. IDEA mybatis generator 生成 pojo,mapper
- 2. mybatis之mybatis-generator生成model、mapper、mapperxml
- 3. MyBatis Generator产生的Example类
- 4. mybatis-generator自动生成Mapper、dao、entity
- 5. idea mybatis-generator table映射Mapper
- 6. 让MyBatis Generator产生的代码支持分页
- 7. Mybatis-generator/通用Mapper/Mybatis-Plus对比
- 8. Bourbon: 让你的sass更简洁
- 9. 使用 MyBatis Generator 工具生成MyBatis相关类和Mapper文件
- 10. MyBatis-使用mybatis-generator-core.jar生成POJO和Mapper文件
- 更多相关文章...
- • MyBatis SqlSession和Mapper接口执行Sql - MyBatis教程
- • RSS
元素 - RSS 教程 - • Github 简明教程
- • Git可视化极简易教程 — Git GUI使用方法
相关标签/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
最新文章
- 1. Appium入门
- 2. Spring WebFlux 源码分析(2)-Netty 服务器启动服务流程 --TBD
- 3. wxpython入门第六步（高级组件）
- 4. CentOS7.5安装SVN和可视化管理工具iF.SVNAdmin
- 5. jedis 3.0.1中JedisPoolConfig对象缺少setMaxIdle、setMaxWaitMillis等方法，问题记录
- 6. 一步一图一代码，一定要让你真正彻底明白红黑树
- 7. 2018-04-12—（重点）源码角度分析Handler运行原理
- 8. Spring AOP源码详细解析
- 9. Spring Cloud（1）
- 10. python简单爬去油价信息发送到公众号
欢迎关注本站公众号,获取更多信息
相关文章
- 1. IDEA mybatis generator 生成 pojo,mapper
- 2. mybatis之mybatis-generator生成model、mapper、mapperxml
- 3. MyBatis Generator产生的Example类
- 4. mybatis-generator自动生成Mapper、dao、entity
- 5. idea mybatis-generator table映射Mapper
- 6. 让MyBatis Generator产生的代码支持分页
- 7. Mybatis-generator/通用Mapper/Mybatis-Plus对比
- 8. Bourbon: 让你的sass更简洁
- 9. 使用 MyBatis Generator 工具生成MyBatis相关类和Mapper文件
- 10. MyBatis-使用mybatis-generator-core.jar生成POJO和Mapper文件