详解在springboot中使用Mybatis Generator的两种方式

2023-09-05 18:06:06 299

介绍

MybatisGenerator(MBG)是Mybatis的一个代码生成工具。MBG解决了对数据库操作有最大影响的一些CRUD操作，很大程度上提升开发效率。如果需要联合查询仍然需要手写sql。相信很多人都听说过微服务，各个微服务之间是松耦合的。每个微服务仅关注于完成一件任务并很好地完成该任务。在一个微服务的开发过程中很可能只关注对单表的操作。所以MBG在开发过程中可以快速的生成代码提升开发效率。

本文将说到在springboot的项目中如何去配置（XML形式和Java配置类形式）和使用MBG以及MBG生成代码的两种方式（XML形式和注解形式），在springboot中更推荐去使用注解的形式。

MBG配置

1.添加依赖


org.mybatis.generator
mybatis-generator-core
1.3.5

2.XML配置

配置示例：在新建springboot项目的根目录下创建mbg.xml文件。

配置详解

生成代码：

publicclassTestMGB{
publicstaticvoidmain(String[]args)throwsIOException,XMLParserException,InvalidConfigurationException,SQLException,InterruptedException{
Listwarnings=newArrayList();
booleanoverwrite=true;
FileconfigFile=newFile("mgb.xml");
ConfigurationParsercp=newConfigurationParser(warnings);
Configurationconfig=cp.parseConfiguration(configFile);
DefaultShellCallbackcallback=newDefaultShellCallback(overwrite);
MyBatisGeneratormyBatisGenerator=newMyBatisGenerator(config,callback,warnings);
myBatisGenerator.generate(null);
}

}

3.Java配置示例

基于Java的配置是和上面的XML配置是相对应的。直接运行该示例即可生成数据表对于的pojo,mapper接口和一个sqlproviderJava类。

packagecom.mgb.test;

importjava.util.ArrayList;
importjava.util.List;

importorg.mybatis.generator.api.MyBatisGenerator;
importorg.mybatis.generator.config.CommentGeneratorConfiguration;
importorg.mybatis.generator.config.Configuration;
importorg.mybatis.generator.config.Context;
importorg.mybatis.generator.config.JDBCConnectionConfiguration;
importorg.mybatis.generator.config.JavaClientGeneratorConfiguration;
importorg.mybatis.generator.config.JavaModelGeneratorConfiguration;
importorg.mybatis.generator.config.JavaTypeResolverConfiguration;
importorg.mybatis.generator.config.ModelType;
importorg.mybatis.generator.config.PluginConfiguration;
importorg.mybatis.generator.config.SqlMapGeneratorConfiguration;
importorg.mybatis.generator.config.TableConfiguration;
importorg.mybatis.generator.internal.DefaultShellCallback;

publicclassMGBConfig{
publicstaticvoidmain(String[]args)throwsException{
//配置xml配置项
Listwarnings=newArrayList();
booleanoverwrite=true;
Configurationconfig=newConfiguration();
Contextcontext=newContext(ModelType.CONDITIONAL);
context.setTargetRuntime("MyBatis3");
context.setId("defaultContext");

//自动识别数据库关键字，默认false，如果设置为true，
//根据SqlReservedWords中定义的关键字列表；一般保留默认值，遇到数据库关键字（Java关键字），
//使用columnOverride覆盖
context.addProperty("autoDelimitKeywords","true");

//生成的Java文件的编码
context.addProperty("javaFileEncoding","utf-8");
context.addProperty("beginningDelimiter","`");
context.addProperty("endingDelimiter","`");
//格式化java代码
context.addProperty("javaFormatter","org.mybatis.generator.api.dom.DefaultJavaFormatter");
//格式化xml代码
context.addProperty("xmlFormatter","org.mybatis.generator.api.dom.DefaultXmlFormatter");
//格式化信息
PluginConfigurationpluginConfiguration=newPluginConfiguration();
pluginConfiguration.setConfigurationType("org.mybatis.generator.plugins.SerializablePlugin");
pluginConfiguration.setConfigurationType("org.mybatis.generator.plugins.ToStringPlugin");
context.addPluginConfiguration(pluginConfiguration);

//设置是否去除生成注释
CommentGeneratorConfigurationcommentGeneratorConfiguration=newCommentGeneratorConfiguration();
commentGeneratorConfiguration.addProperty("suppressAllComments","true");
//commentGeneratorConfiguration.addProperty("suppressDate","true");
context.setCommentGeneratorConfiguration(commentGeneratorConfiguration);

//设置连接数据库
JDBCConnectionConfigurationjdbcConnectionConfiguration=newJDBCConnectionConfiguration();
jdbcConnectionConfiguration.setDriverClass("com.mysql.jdbc.Driver");
jdbcConnectionConfiguration.setConnectionURL("jdbc:mysql://localhost:3306/definesys");
jdbcConnectionConfiguration.setPassword("welcome1");
jdbcConnectionConfiguration.setUserId("root");
context.setJdbcConnectionConfiguration(jdbcConnectionConfiguration);

JavaTypeResolverConfigurationjavaTypeResolverConfiguration=newJavaTypeResolverConfiguration();
//是否使用bigDecimal，false可自动转化以下类型（Long,Integer,Short,etc.）
javaTypeResolverConfiguration.addProperty("forceBigDecimals","false");
context.setJavaTypeResolverConfiguration(javaTypeResolverConfiguration);

//生成实体类的地址
JavaModelGeneratorConfigurationjavaModelGeneratorConfiguration=newJavaModelGeneratorConfiguration();
javaModelGeneratorConfiguration.setTargetPackage("com.mgb.domain");
javaModelGeneratorConfiguration.setTargetProject("src/main/java");
javaModelGeneratorConfiguration.addProperty("enableSubPackages","true");
javaModelGeneratorConfiguration.addProperty("trimStrings","true");
context.setJavaModelGeneratorConfiguration(javaModelGeneratorConfiguration);

//生成的xml的地址
SqlMapGeneratorConfigurationsqlMapGeneratorConfiguration=newSqlMapGeneratorConfiguration();
sqlMapGeneratorConfiguration.setTargetProject("src/main/java");
sqlMapGeneratorConfiguration.setTargetPackage("com.mgb.mapper");
sqlMapGeneratorConfiguration.addProperty("enableSubPackages","true");
context.setSqlMapGeneratorConfiguration(sqlMapGeneratorConfiguration);

//生成注解接口
JavaClientGeneratorConfigurationjavaClientGeneratorConfiguration=newJavaClientGeneratorConfiguration();
javaClientGeneratorConfiguration.setTargetPackage("com.mgb.dao");
javaClientGeneratorConfiguration.setTargetProject("src/main/java");
//注解形式ANNOTATEDMAPPERxml形式XMLMAPPER
javaClientGeneratorConfiguration.setConfigurationType("ANNOTATEDMAPPER");
javaClientGeneratorConfiguration.addProperty("enableSubPackages","true");
context.setJavaClientGeneratorConfiguration(javaClientGeneratorConfiguration);

TableConfigurationtableConfiguration=newTableConfiguration(context);
tableConfiguration.setTableName("user_info");
tableConfiguration.setCountByExampleStatementEnabled(true);
tableConfiguration.setUpdateByExampleStatementEnabled(true);
tableConfiguration.setDeleteByExampleStatementEnabled(true);
tableConfiguration.setInsertStatementEnabled(true);
tableConfiguration.setDeleteByPrimaryKeyStatementEnabled(true);
context.addTableConfiguration(tableConfiguration);

config.addContext(context);
DefaultShellCallbackcallback=newDefaultShellCallback(overwrite);
MyBatisGeneratormyBatisGenerator=newMyBatisGenerator(config,callback,warnings);
myBatisGenerator.generate(null);
}
}

使用

packagecom.mgb.service;
importjava.util.List;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.stereotype.Service;

importcom.mgb.dao.UserInfoMapper;
importcom.mgb.domain.UserInfo;
importcom.mgb.domain.UserInfoExample;

@Service
publicclassUserService{
@Autowired
privateUserInfoMapperuserInfoMapper;

/**
*按姓名查询
*@paramname
*@return
*/
publicListgetUserByName(Stringname){
UserInfoExampleuerInfoExample=newUserInfoExample();
uerInfoExample.createCriteria().andNameEqualTo(name);
returnuserInfoMapper.selectByExample(uerInfoExample);
}

/**
*有条件的insert
*@paramuserInfo
*@return
*/
publicIntegeraddUser(UserInfouserInfo){
returnuserInfoMapper.insertSelective(userInfo);
}

/**
*根据ID更新用户信息
*@paramuserInfo
*@return
*/
publicIntegerupdateUser(UserInfouserInfo){
returnuserInfoMapper.updateByPrimaryKey(userInfo);
}

/**
*根据ID删除用户
*@paramid
*@return
*/
publicIntegerdeleteUserById(Integerid){
returnuserInfoMapper.deleteByPrimaryKey(id);
}
}

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。

详解在springboot中使用Mybatis Generator的两种方式

热门推荐

随机推荐