MyBatis?Generator使用小結(jié)
介紹
MyBatis Generator (MBG) 是 MyBatis 的代碼生成器。它能夠根據(jù)數(shù)據(jù)庫表,自動生成 java 實體類、dao 層接口(mapper 接口)及mapper.xml文件。
具體使用
數(shù)據(jù)準備
創(chuàng)建數(shù)據(jù)庫(8.0版本)mybatis,并添加一張表rbac_user,用于測試
CREATE TABLE `rbac_user` ( `id` int NOT NULL AUTO_INCREMENT COMMENT '主鍵', `name` varchar(100) DEFAULT NULL COMMENT '用戶名', `email` varchar(100) DEFAULT NULL COMMENT '郵箱', `nick_name` varchar(100) DEFAULT NULL COMMENT '昵稱', `remark` varchar(100) DEFAULT NULL COMMENT '備注', `create_time` date DEFAULT NULL COMMENT '創(chuàng)建時間', `status` char(1) DEFAULT NULL COMMENT '狀態(tài)', PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='用戶表';
如圖所示:
插件引入
創(chuàng)建一個SpringBoot項目這里使用的spring boot版本是2.1.3.RELEASE,將mybatis 插件引入
<!--SpringBoot通用依賴模塊--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <!--SpringBoot整合MyBatis--> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.2.2</version> </dependency> <!--MyBatis分頁插件--> <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.4.5</version> </dependency> <!--集成druid連接池--> <dependency> <groupId>com.alibaba</groupId> <artifactId>druid-spring-boot-starter</artifactId> <version>1.2.9</version> </dependency> <!-- MyBatis 生成器 --> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.4.1</version> </dependency> <!--Mysql數(shù)據(jù)庫驅(qū)動--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.15</version> </dependency> <!--springfox swagger官方Starter--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>
配置
1、對項目的application.yml進行配置:
server: port: 8080 spring: datasource: url: jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai username: root password: root mvc: pathmatch: matching-strategy: ANT_PATH_MATCHER mybatis: mapper-locations: - classpath:dao/*.xml configuration: # 下劃線自動轉(zhuǎn)駝峰 map-underscore-to-camel-case: true logging: level: root: info com.sheep: debug
2、創(chuàng)建配置文件為generator.properties,添加數(shù)據(jù)庫配置信息,用于代碼生成器配置使用:
jdbc.driverClass=com.mysql.cj.jdbc.Driver jdbc.connectionURL=jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai jdbc.userId=root jdbc.password=root
3、創(chuàng)建代碼生成器配置文件generatorConfig.xml:
<?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="generator.properties"/> <context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat"> <!-- 配置SQL語句中的前置分隔符 --> <property name="beginningDelimiter" value="`"/> <!-- 配置SQL語句中的后置分隔符 --> <property name="endingDelimiter" value="`"/> <!-- 配置生成Java文件的編碼 --> <property name="javaFileEncoding" value="UTF-8"/> <!-- 為模型生成序列化方法 --> <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/> <!-- 為生成的Java模型創(chuàng)建一個toString方法 --> <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/> <!-- 生成mapper.xml時覆蓋原文件 --> <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" /> <commentGenerator type="com.macro.mall.CommentGenerator"> <!-- 是否阻止生成的注釋 --> <property name="suppressAllComments" value="true"/> <!-- 是否阻止生成的注釋包含時間戳 --> <property name="suppressDate" value="true"/> <!-- 是否添加數(shù)據(jù)庫表的備注信息 --> <property name="addRemarkComments" value="true"/> </commentGenerator> <!--配置數(shù)據(jù)庫連接--> <jdbcConnection driverClass="${jdbc.driverClass}" connectionURL="${jdbc.connectionURL}" userId="${jdbc.userId}" password="${jdbc.password}"> <!--解決mysql驅(qū)動升級到8.0后不生成指定數(shù)據(jù)庫代碼的問題--> <property name="nullCatalogMeansCurrent" value="true"/> </jdbcConnection> <!--指定生成model的路徑--> <javaModelGenerator targetPackage="com.sheep.mbg.model" targetProject="learn-mybatis\src\main\java"/> <!--指定生成mapper.xml的路徑--> <sqlMapGenerator targetPackage="com.sheep..mbg.mapper" targetProject="learn-mybatis\src\main\resources"/> <!--指定生成mapper接口的的路徑--> <javaClientGenerator type="XMLMAPPER" targetPackage="com.sheep.mbg.mapper" targetProject="learn-mybatis\src\main\java"/> <!--配置需要生成的表,生成全部表tableName設(shè)為% 還可以指定統(tǒng)一前綴的表 如 rbac_% 表示所有rbac_開始的所有表--> <table tableName="rbac_%"> <generatedKey column="id" sqlStatement="MySql" identity="true"/> </table> </context> </generatorConfiguration>
4、實際開發(fā)中,有的項目是需要接入swagger-ui的,所以字段注釋就得自定義。建立一個注釋自定義處理類CommentGenerator:
import org.mybatis.generator.api.IntrospectedColumn; import org.mybatis.generator.api.IntrospectedTable; import org.mybatis.generator.api.dom.java.CompilationUnit; import org.mybatis.generator.api.dom.java.Field; import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType; import org.mybatis.generator.internal.DefaultCommentGenerator; import org.mybatis.generator.internal.util.StringUtility; import java.util.Properties; /** * 自定義注釋生成器 */ public class CommentGenerator extends DefaultCommentGenerator { private boolean addRemarkComments = false; private static final String EXAMPLE_SUFFIX = "Example"; private static final String MAPPER_SUFFIX = "Mapper"; private static final String API_MODEL_PROPERTY_FULL_CLASS_NAME = "io.swagger.annotations.ApiModelProperty"; /** * 設(shè)置用戶配置的參數(shù) */ @Override public void addConfigurationProperties(Properties properties) { super.addConfigurationProperties(properties); this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments")); } /** * 給字段添加注釋 */ @Override public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) { String remarks = introspectedColumn.getRemarks(); //根據(jù)參數(shù)和備注信息判斷是否添加swagger注解信息 if (addRemarkComments && StringUtility.stringHasValue(remarks)) { // addFieldJavaDoc(field, remarks); //數(shù)據(jù)庫中特殊字符需要轉(zhuǎn)義 if (remarks.contains("\"")) { remarks = remarks.replace("\"", "'"); } //給model的字段添加swagger注解 field.addJavaDocLine("@ApiModelProperty(value = \"" + remarks + "\")"); } } /** * 給model的字段添加注釋 */ private void addFieldJavaDoc(Field field, String remarks) { //文檔注釋開始 field.addJavaDocLine("/**"); //獲取數(shù)據(jù)庫字段的備注信息 String[] remarkLines = remarks.split(System.getProperty("line.separator")); for (String remarkLine : remarkLines) { field.addJavaDocLine(" * " + remarkLine); } addJavadocTag(field, false); field.addJavaDocLine(" */"); } @Override public void addJavaFileComment(CompilationUnit compilationUnit) { super.addJavaFileComment(compilationUnit); //只在model中添加swagger注解類的導入 if (!compilationUnit.getType().getFullyQualifiedName().contains(MAPPER_SUFFIX) && !compilationUnit.getType().getFullyQualifiedName().contains(EXAMPLE_SUFFIX)) { compilationUnit.addImportedType(new FullyQualifiedJavaType(API_MODEL_PROPERTY_FULL_CLASS_NAME)); } } }
5、添加運行類Generator:
import org.mybatis.generator.api.MyBatisGenerator; import org.mybatis.generator.config.Configuration; import org.mybatis.generator.config.xml.ConfigurationParser; import org.mybatis.generator.internal.DefaultShellCallback; import java.io.InputStream; import java.util.ArrayList; import java.util.List; public class Generator { public static void main(String[] args) throws Exception { //MBG 執(zhí)行過程中的警告信息 List<String> warnings = new ArrayList<String>(); //當生成的代碼重復時,覆蓋原代碼 boolean overwrite = true; //讀取我們的 MBG 配置文件 InputStream is = Generator.class.getResourceAsStream("/generatorConfig.xml"); ConfigurationParser cp = new ConfigurationParser(warnings); Configuration config = cp.parseConfiguration(is); is.close(); DefaultShellCallback callback = new DefaultShellCallback(overwrite); //創(chuàng)建 MBG MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings); //執(zhí)行生成代碼 myBatisGenerator.generate(null); //輸出警告信息 for (String warning : warnings) { System.out.println(warning); } } }
6、運行后看結(jié)果:圖中的路徑是與配置文件相對應(yīng)的。若不存在也會自動創(chuàng)建目錄
7、可以看到model對象中的各個字段的注釋。
8、還有另個自動生成的對象類:此對象是為了配合增刪改查的條件構(gòu)建用的。
9、看下生成的Mapper接口,這里生成了基本增刪改查操作的接口,查詢參數(shù)也應(yīng)用了刪改你的條件構(gòu)建對象。
10、構(gòu)建RbacUserService,RbacUserController。具體講解下這個條件構(gòu)建器如何使用:
public interface RbacUserService { List<RbacUser> listAllUser(); int createUser(RbacUser user); int updateUser(Integer id, RbacUser user); int deleteUser(Integer id); List<RbacUser> listUser(int pageNum, int pageSize); RbacUser getUser(Integer id); }
@Service public class RbacUserServiceImpl implements RbacUserService { @Autowired private RbacUserMapper userMapper; @Override public List<RbacUser> listAllUser() { return userMapper.selectByExample(new RbacUserExample()); } @Override public int createUser(RbacUser user) { return userMapper.insert(user); } @Override public int updateUser(Integer id, RbacUser user) { user.setId(id); return userMapper.updateByPrimaryKeySelective(user); } @Override public int deleteUser(Integer id) { return userMapper.deleteByPrimaryKey(id); } @Override public List<RbacUser> listUser(int pageNum, int pageSize) { PageHelper.startPage(pageNum, pageSize); return userMapper.selectByExample(new RbacUserExample()); } @Override public RbacUser getUser(Integer id) { return userMapper.selectByPrimaryKey(id); } }
@Api("用戶管理") @Controller @RequestMapping("/user") public class RbacUserController { private static final Logger LOGGER = LoggerFactory.getLogger(RbacUserController.class); @Autowired private RbacUserService userService; @ApiOperation("獲取所有用戶列表") @RequestMapping(value = "listAll", method = RequestMethod.GET) @ResponseBody public CommonResult<List<RbacUser>> getUserList() { return CommonResult.success(userService.listAllUser()); } @ApiOperation("添加用戶") @RequestMapping(value = "/create", method = RequestMethod.POST) @ResponseBody public CommonResult createUser(@RequestBody RbacUser user) { CommonResult commonResult; int count = userService.createUser(user); if (count == 1) { commonResult = CommonResult.success(user); LOGGER.debug("createUser success:{}", user); } else { commonResult = CommonResult.failed("操作失敗"); LOGGER.debug("createUser failed:{}", user); } return commonResult; } @ApiOperation("更新指定id用戶信息") @RequestMapping(value = "/update/{id}", method = RequestMethod.POST) @ResponseBody public CommonResult updateUser(@PathVariable("id") Integer id, @RequestBody RbacUser user, BindingResult result) { CommonResult commonResult; int count = userService.updateUser(id, user); if (count == 1) { commonResult = CommonResult.success(user); LOGGER.debug("updateUser success:{}", user); } else { commonResult = CommonResult.failed("操作失敗"); LOGGER.debug("updateUser failed:{}", user); } return commonResult; } @ApiOperation("刪除指定id的用戶") @RequestMapping(value = "/delete/{id}", method = RequestMethod.GET) @ResponseBody public CommonResult deleteUser(@PathVariable("id") Integer id) { int count = userService.deleteUser(id); if (count == 1) { LOGGER.debug("deleteUser success :id={}", id); return CommonResult.success(null); } else { LOGGER.debug("deleteUser failed :id={}", id); return CommonResult.failed("操作失敗"); } } @ApiOperation("分頁查詢用戶列表") @RequestMapping(value = "/list", method = RequestMethod.GET) @ResponseBody public CommonResult<CommonPage<RbacUser>> listUser(@RequestParam(value = "pageNum", defaultValue = "1") Integer pageNum, @RequestParam(value = "pageSize", defaultValue = "10") Integer pageSize) { List<RbacUser> brandList = userService.listUser(pageNum, pageSize); return CommonResult.success(CommonPage.restPage(brandList)); } @ApiOperation("獲取指定id的品牌詳情") @RequestMapping(value = "/{id}", method = RequestMethod.GET) @ResponseBody public CommonResult<RbacUser> user(@PathVariable("id") Integer id) { return CommonResult.success(userService.getUser(id)); } }
11、controller中的返回結(jié)果進行了統(tǒng)一,代碼如下,可以自行修改:
public interface IErrorCode { long getCode(); String getMessage(); }
public enum ResultCode implements IErrorCode { SUCCESS(200, "操作成功"), FAILED(500, "操作失敗"), VALIDATE_FAILED(404, "參數(shù)檢驗失敗"), UNAUTHORIZED(401, "暫未登錄或token已經(jīng)過期"), FORBIDDEN(403, "沒有相關(guān)權(quán)限"); private long code; private String message; private ResultCode(long code, String message) { this.code = code; this.message = message; } public long getCode() { return code; } public String getMessage() { return message; } }
public class CommonPage<T> { private Integer pageNum; private Integer pageSize; private Integer totalPage; private Long total; private List<T> list; /** * 將PageHelper分頁后的list轉(zhuǎn)為分頁信息 */ public static <T> CommonPage<T> restPage(List<T> list) { CommonPage<T> result = new CommonPage<T>(); PageInfo<T> pageInfo = new PageInfo<T>(list); result.setTotalPage(pageInfo.getPages()); result.setPageNum(pageInfo.getPageNum()); result.setPageSize(pageInfo.getPageSize()); result.setTotal(pageInfo.getTotal()); result.setList(pageInfo.getList()); return result; } public Integer getPageNum() { return pageNum; } public void setPageNum(Integer pageNum) { this.pageNum = pageNum; } public Integer getPageSize() { return pageSize; } public void setPageSize(Integer pageSize) { this.pageSize = pageSize; } public Integer getTotalPage() { return totalPage; } public void setTotalPage(Integer totalPage) { this.totalPage = totalPage; } public List<T> getList() { return list; } public void setList(List<T> list) { this.list = list; } public Long getTotal() { return total; } public void setTotal(Long total) { this.total = total; } }
public class CommonResult<T> { private long code; private String message; private T data; protected CommonResult() { } protected CommonResult(long code, String message, T data) { this.code = code; this.message = message; this.data = data; } /** * 成功返回結(jié)果 * * @param data 獲取的數(shù)據(jù) */ public static <T> CommonResult<T> success(T data) { return new CommonResult<T>(ResultCode.SUCCESS.getCode(), ResultCode.SUCCESS.getMessage(), data); } /** * 成功返回結(jié)果 * * @param data 獲取的數(shù)據(jù) * @param message 提示信息 */ public static <T> CommonResult<T> success(T data, String message) { return new CommonResult<T>(ResultCode.SUCCESS.getCode(), message, data); } /** * 失敗返回結(jié)果 * * @param errorCode 錯誤碼 */ public static <T> CommonResult<T> failed(IErrorCode errorCode) { return new CommonResult<T>(errorCode.getCode(), errorCode.getMessage(), null); } /** * 失敗返回結(jié)果 * * @param message 提示信息 */ public static <T> CommonResult<T> failed(String message) { return new CommonResult<T>(ResultCode.FAILED.getCode(), message, null); } /** * 失敗返回結(jié)果 */ public static <T> CommonResult<T> failed() { return failed(ResultCode.FAILED); } /** * 參數(shù)驗證失敗返回結(jié)果 */ public static <T> CommonResult<T> validateFailed() { return failed(ResultCode.VALIDATE_FAILED); } /** * 參數(shù)驗證失敗返回結(jié)果 * * @param message 提示信息 */ public static <T> CommonResult<T> validateFailed(String message) { return new CommonResult<T>(ResultCode.VALIDATE_FAILED.getCode(), message, null); } /** * 未登錄返回結(jié)果 */ public static <T> CommonResult<T> unauthorized(T data) { return new CommonResult<T>(ResultCode.UNAUTHORIZED.getCode(), ResultCode.UNAUTHORIZED.getMessage(), data); } /** * 未授權(quán)返回結(jié)果 */ public static <T> CommonResult<T> forbidden(T data) { return new CommonResult<T>(ResultCode.FORBIDDEN.getCode(), ResultCode.FORBIDDEN.getMessage(), data); } public long getCode() { return code; } public void setCode(long code) { this.code = code; } public String getMessage() { return message; } public void setMessage(String message) { this.message = message; } public T getData() { return data; } public void setData(T data) { this.data = data; } }
@Configuration @EnableSwagger2 public class Swagger2Config { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() //為當前包下controller生成API文檔 .apis(RequestHandlerSelectors.basePackage("com.sheep.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("SwaggerUI演示") .description("learn-mybatis") .contact(new Contact("sheep", "", "123@qq.com")) .version("1.0") .build(); } }
12、運行服務(wù):
13、訪問 http://localhost:8080/swagger-ui.html
成功啟動。
條件構(gòu)建講解
從上面可以看到MyBatis Generator (MBG) 為每個數(shù)據(jù)庫表生成了一個對應(yīng)的 Example 類。它主要用于生成動態(tài) SQL 語句。
Example 類允許你構(gòu)建復雜的 WHERE 子句,而無需直接在 mapper 文件中硬編碼 SQL,它包含了很多用于構(gòu)建 WHERE 子句的方法。每個方法都對應(yīng)一個 SQL 比較運算符,比如 “=”, “<>”, “>”, “<”, “LIKE” 等。你可以動態(tài)地添加、修改或刪除查詢條件。使用 Example 類,你可以構(gòu)建幾乎任何類型的查詢,包括帶有 AND 和 OR 子句的查詢,帶有子查詢的查詢等。
在使用 Example 類時,你需要創(chuàng)建一個 Example 對象,然后通過調(diào)用該對象的 createCriteria() 方法創(chuàng)建一個 Criteria 對象。然后你可以在 Criteria 對象上調(diào)用各種方法來添加查詢條件。
上面的案例基本上都沒用到,下面我們就開始使用這個條件構(gòu)建器:
上面的案例是查詢的所有用戶,我們基于這個進行條件查詢。
比如 對名字進行模糊查詢:
Criteria 對象創(chuàng)建后,可以調(diào)用里面的各個接口進行構(gòu)建參數(shù),這個里面會對每個參數(shù)生成 “=”, “<>”, “>”, “<”, “LIKE” 的查詢接口。如圖所示是上面的接口詳情:可以看到默認的情況,不會加%的
再看addCriterion,可以看到是往全局變量list中插入不同的條件構(gòu)建對象。
看下查詢語句拼接效果:
若我們查詢有多個條件的話,直接繼續(xù)添加即可,例如我可以根據(jù)name模糊查詢,還要查詢小于指定時間創(chuàng)建的用戶
上面的是不同條件進行and拼接的,若使用or進行拼接不同條件的話,需要換個方式:
每個條件都需要通過or創(chuàng)建Criteria 對象,然后再賦值,看下or接口就明白了:
比如 我們查詢的話還需要根據(jù)指定的字段進行排序:
可以看到在mapper中的條件構(gòu)建判斷邏輯:
這個構(gòu)建器只能用來生成簡單的基于單表的 CRUD 操作的代碼。對于更復雜的 SQL 操作,比如子查詢、Group 查詢和 Join 查詢,MBG 并不直接支持。這些復雜查詢需要你自己在 Mapper 的 xml 文件或基于注解編寫相應(yīng)的 SQL。
到此這篇關(guān)于MyBatis Generator使用小結(jié)的文章就介紹到這了,更多相關(guān)MyBatis Generator使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
詳述IntelliJ IDEA提交代碼前的 Code Analysis 機制(小結(jié))
本篇文章主要介紹了詳述IntelliJ IDEA提交代碼前的 Code Analysis 機制(小結(jié)),具有一定的參考價值,感興趣的小伙伴們可以參考一下。2017-11-11SpringCloud URL重定向及轉(zhuǎn)發(fā)代碼實例
這篇文章主要介紹了SpringCloud URL重定向及轉(zhuǎn)發(fā)代碼實例,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-03-03SpringBoot中關(guān)于static和templates的注意事項以及webjars的配置
今天小編就為大家分享一篇關(guān)于SpringBoot中關(guān)于static和templates的注意事項以及webjars的配置,小編覺得內(nèi)容挺不錯的,現(xiàn)在分享給大家,具有很好的參考價值,需要的朋友一起跟隨小編來看看吧2019-01-01Springboot結(jié)合JDBC實現(xiàn)雙數(shù)據(jù)源實例
這篇文章主要為大家介紹了Springboot結(jié)合JDBC實現(xiàn)雙數(shù)據(jù)源實例,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-12-12java基于JDBC連接Oracle 11g Release2實例分析
這篇文章主要介紹了java基于JDBC連接Oracle 11g Release2的方法,實例分析了JDBC連接Oracle 11g Release2容易出現(xiàn)的異常與解決方法,需要的朋友可以參考下2015-06-06