EasyCode-MybatisCodeHelper(Idea插件代码生成神器)
提示:EasyCode是代码生成神器,EasyCode-MybatisCodeHelper是为了和MybatisCodeHelper兼容的插件。
1.安装
方法一:打开idea,一次到开File–Settings–Plugins搜索插件“EasyCode-MybatisCodeHelper"。
方法二:到idea官网下载插件,然后在idea中离线安装插件。
官网下载地址
2.在idea中配置数据源
配置mysql数据源步骤:在idea的右侧单击DataBase–在展开的页面左上角点击“+”–选择Data Source–选择Mysql–填写好相应的信息–点击Test Connection测试连接是否成功,成功的话点击OK
3.使用插件生成代码
1)分别如图所示展开需要生成代码的数据表
2)右键如图所示选择EasyCodeMybatisCodeHelper–Generate Code
3) 填写好相应的信息,勾选需要生成哪些文件
Module: 代码生成到哪个模块中
Package:生成的包名
Path: 代码放在哪个路径下面
4.定制代码生成的模板
1)依次打开File–Settings–Other Settings-- EasyCode-MybaitisCodeHelper–Template Settings。如图圈的就是生成的模板,可以根据自己需要修改
2) 修改作者信息。
2.1) 单击Global Config然后点击+,输入author,点击OK
2.2) 点击author,然后输入作者名称,点击确定即可,下次在生成代码的时候就会将作者信息换成你修改的了。
5.个人定制了有些模板,有需要的可以在自行更换模板中的内容
1)controller.java:增加了swagger的@Api注解,如果你没导入swagger的包就在pom中加入swagger的依赖
##定义初始变量
#set($tableName = $tool.append($tableInfo.name, "Controller"))
##设置回调
$!callback.setFileName($tool.append($tableName, ".java"))
$!callback.setSavePath($tool.append($tableInfo.savePath, "/controller"))
##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
#set($pk = $tableInfo.pkColumn.get(0))
#end
#if($tableInfo.savePackageName)package $!{tableInfo.savePackageName}.#{end}controller;
import $!{tableInfo.savePackageName}.entity.$!{tableInfo.name};
import $!{tableInfo.savePackageName}.service.$!{tableInfo.name}Service;
import org.springframework.web.bind.annotation.*;
import io.swagger.annotations.Api;
import $!{tableInfo.savePackageName}.bean.R;
import $!{tableInfo.savePackageName}.bean.DataPage;
import java.util.List;
import javax.annotation.Resource;
/**
* $!{tableInfo.comment}($!{tableInfo.name})表控制层
*
* @author $!author
* @since $!time.currTime()
*/
@RestController
@Api(tags="$!{tableInfo.comment}")
@CrossOrigin(origins = "*")
@RequestMapping("$!tool.firstLowerCase($tableInfo.name)")
public class $!{tableName} {
/**
* 服务对象
*/
@Resource
private $!{tableInfo.name}Service $!tool.firstLowerCase($tableInfo.name)Service;
/**
* 通过主键查询单条数据
*
* @param id 主键
* @return 单条数据
*/
@GetMapping("selectOne")
public R<$!{tableInfo.name}> selectOne($!pk.shortType id) {
$!{tableInfo.name} $!{tool.firstLowerCase($tableInfo.name)} = this.$!{tool.firstLowerCase($tableInfo.name)}Service.queryById(id);
return R.ok($!{tool.firstLowerCase($tableInfo.name)});
}
/**
* 查询多条数据
*
* @param pageNum 查询起始位置
* @param pageSize 查询条数
*/
@PostMapping("queryAllByPage")
public DataPage<$!{tableInfo.name}> queryAllByPage(int pageNum, int pageSize, $!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
DataPage<$!{tableInfo.name}> $!{tool.firstLowerCase($!{tableInfo.name})}DataPage = this.$!{tool.firstLowerCase($tableInfo.name)}Service.queryAllByPage(pageNum, pageSize, $!tool.firstLowerCase($!{tableInfo.name}));
return $!{tool.firstLowerCase($!{tableInfo.name})}DataPage;
}
/**
* 查询所有数据
*
*/
@PostMapping("queryAll")
public R<List<$!{tableInfo.name}>> queryAll(@RequestBody $!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
List<$!{tableInfo.name}> $!{tool.firstLowerCase($!{tableInfo.name})}List = this.$!{tool.firstLowerCase($tableInfo.name)}Service.queryAll($!tool.firstLowerCase($!{tableInfo.name}));
return R.ok($!{tool.firstLowerCase($!{tableInfo.name})}List);
}
/**
* 新增数据
*
* @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
* @return 实例对象
*/
@PostMapping("insert")
public R insert(@RequestBody $!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
this.$!{tool.firstLowerCase($tableInfo.name)}Service.insert($!tool.firstLowerCase($!tool.firstLowerCase($!{tableInfo.name})));
return R.ok();
}
/**
* 修改数据
*
* @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
*/
@PostMapping("update")
public R update(@RequestBody $!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
this.$!{tool.firstLowerCase($tableInfo.name)}Service.update($!tool.firstLowerCase($!{tableInfo.name}));
return R.ok();
}
/**
* 通过主键删除数据
*
* @param $!pk.name 主键
*/
@PostMapping("deleteById")
public R deleteById($!pk.shortType $!pk.name) {
this.$!{tool.firstLowerCase($tableInfo.name)}Service.deleteById($!pk.name);
return R.ok();
}
}
2)dao.java:增加了一个批量增加数据的方法
##定义初始变量
#set($tableName = $tool.append($tableInfo.name, "Dao"))
##设置回调
$!callback.setFileName($tool.append($tableName, ".java"))
$!callback.setSavePath($tool.append($tableInfo.savePath, "/dao"))
##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
#set($pk = $tableInfo.pkColumn.get(0))
#end
#if($tableInfo.savePackageName)package $!{tableInfo.savePackageName}.#{end}dao;
import $!{tableInfo.savePackageName}.entity.$!{tableInfo.name};
import org.apache.ibatis.annotations.Param;
import java.util.List;
import org.apache.ibatis.annotations.Mapper;
/**
* $!{tableInfo.comment}($!{tableInfo.name})表数据库访问层
*
* @author $!author
* @since $!time.currTime()
*/
@Mapper
public interface $!{tableName} {
/**
* 通过ID查询单条数据
*
* @param $!pk.name 主键
* @return 实例对象
*/
$!{tableInfo.name} queryById($!pk.shortType $!pk.name);
/**
* 查询指定行数据
*
* @return 对象列表
*/
List<$!{tableInfo.name}> queryAllByPage($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
/**
* 通过实体作为筛选条件查询
*
* @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
* @return 对象列表
*/
List<$!{tableInfo.name}> queryAll($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
/**
* 新增数据
*
* @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
* @return 影响行数
*/
int insert($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
/**
* 批量新增
*
* @param $!tool.firstLowerCase($!{tableInfo.name})s 实例对象的集合
* @return 影响行数
*/
int insertBatch(List<$!{tableInfo.name}> $!tool.firstLowerCase($!{tableInfo.name})s);
/**
* 修改数据
*
* @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
* @return 影响行数
*/
int update($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
/**
* 通过主键删除数据
*
* @param $!pk.name 主键
* @return 影响行数
*/
int deleteById($!pk.shortType $!pk.name);
}
3) entity.java:增加了@Data,@ApiModel,@ApiModelProperty注解,同样的你应该引入对应的依赖
##引入宏定义
$!define
##使用宏定义设置回调(保存位置与文件后缀)
#save("/entity", ".java")
##使用宏定义设置包后缀
#setPackageSuffix("entity")
##使用全局变量实现默认包导入
$!autoImport
import java.io.Serializable;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
##使用宏定义实现类注释信息
#tableComment("实体类")
@Data
@ApiModel(value = "${tableInfo.comment}")
public class $!{tableInfo.name} implements Serializable {
private static final long serialVersionUID = $!tool.serial();
#foreach($column in $tableInfo.fullColumn)
#if(${column.comment})/**
* ${column.comment}
*/#end
@ApiModelProperty(value="${column.comment}")
private $!{tool.getClsNameByFullName($column.type)} $!{column.name};
#end
}
}
4) mapper.xml:
1)修改了insert的sql语句,将insert改成了动态sql
2) 增加了批量插入的sql
##引入mybatis支持
$!mybatisSupport
##设置保存名称与保存位置
$!callback.setFileName($tool.append($!{tableInfo.name}, "Dao.xml"))
$!callback.setSavePath($tool.append($modulePath, "/src/main/resources/mapper"))
##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
#set($pk = $tableInfo.pkColumn.get(0))
#end
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="$!{tableInfo.savePackageName}.dao.$!{tableInfo.name}Dao">
<resultMap id="BaseResultMap" type="$!{tableInfo.savePackageName}.entity.$!{tableInfo.name}">
<!--@Table $!{tableInfo.originTableName}-->
#foreach($column in $tableInfo.fullColumn)
<result property="$!column.name" column="$!column.obj.name" jdbcType="$!column.ext.jdbcType"/>
#end
</resultMap>
<!--查询单个-->
<select id="queryById" resultMap="BaseResultMap">
select
#allSqlColumn()
from $!tableInfo.obj.name
where $!pk.obj.name = #{$!pk.name}
</select>
<!--查询指定行数据-->
<select id="queryAllByPage" resultMap="BaseResultMap">
select
#allSqlColumn()
from $!tableInfo.obj.name
<where>
#foreach($column in $tableInfo.fullColumn)
<if test="$!column.name != null#if($column.type.equals(
"java.lang.String")) and $!column.name != ''#end">
and $!column.obj.name = #{$!column.name}
</if>
#end
</where>
</select>
<!--通过实体作为筛选条件查询-->
<select id="queryAll" resultMap="BaseResultMap">
select
#allSqlColumn()
from $!tableInfo.obj.name
<where>
#foreach($column in $tableInfo.fullColumn)
<if test="$!column.name != null#if($column.type.equals(
"java.lang.String")) and $!column.name != ''#end">
and $!column.obj.name = #{$!column.name}
</if>
#end
</where>
</select>
<!--新增-->
<insert id="insert" keyProperty="$!pk.name" useGeneratedKeys="true">
insert into $!{tableInfo.obj.name}(
<trim suffixOverrides="," suffix="">
#foreach($column in $tableInfo.otherColumn)
<if test="$!column.name != null#if($column.type.equals("java.lang.String")) and $!column.name != ''#end">
$!column.obj.name#if($velocityHasNext), #end
</if>
#end
</trim>
)
values (
<trim suffixOverrides="," suffix="">
#foreach($column in $tableInfo.otherColumn)
<if test="$!column.name != null#if($column.type.equals("java.lang.String")) and $!column.name != ''#end">
#{$!{column.name}}#if($velocityHasNext), #end
</if>
#end
</trim>)
</insert>
<!-- 批量新增 -->
<insert id="insertBatch">
insert into $!{tableInfo.obj.name}(#foreach($column in $tableInfo.fullColumn)$!column.obj.name#if($velocityHasNext), #end#end)
values
<foreach collection="list" item="item" index="index" separator=",">
(
#foreach($column in $tableInfo.fullColumn)
#{item.$!{column.name}}#if($velocityHasNext), #end
#end
)
</foreach>
</insert>
<!--通过主键修改数据-->
<update id="update">
update $!{tableInfo.obj.name}
<set>
#foreach($column in $tableInfo.otherColumn)
<if test="$!column.name != null#if($column.type.equals(
"java.lang.String")) and $!column.name != ''#end">
$!column.obj.name = #{$!column.name},
</if>
#end
</set>
where $!pk.obj.name = #{$!pk.name}
</update>
<!--通过主键删除-->
<delete id="deleteById">
delete from $!{tableInfo.obj.name} where $!pk.obj.name = #{$!pk.name}
</delete>
</mapper>
- service.java
##定义初始变量
#set($tableName = $tool.append($tableInfo.name, "Service"))
##设置回调
$!callback.setFileName($tool.append($tableName, ".java"))
$!callback.setSavePath($tool.append($tableInfo.savePath, "/service"))
##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
#set($pk = $tableInfo.pkColumn.get(0))
#end
#if($tableInfo.savePackageName)package $!{tableInfo.savePackageName}.#{end}service;
import $!{tableInfo.savePackageName}.entity.$!{tableInfo.name};
import $!{tableInfo.savePackageName}.bean.DataPage;
import java.util.List;
/**
* $!{tableInfo.comment}($!{tableInfo.name})表服务接口
*
* @author $!author
* @since $!time.currTime()
*/
public interface $!{tableName} {
/**
* 通过ID查询单条数据
*
* @param $!pk.name 主键
* @return 实例对象
*/
$!{tableInfo.name} queryById($!pk.shortType $!pk.name);
/**
* 查询多条数据
*
* @param pageNum 查询起始位置
* @param pageSize 查询条数
* @return 对象列表
*/
DataPage<$!{tableInfo.name}> queryAllByPage(int pageNum, int pageSize, $!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
/**
* 查询所有数据
*
* @return 对象列表
*/
List<$!{tableInfo.name}> queryAll($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
/**
* 新增数据
*
* @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
* @return 实例对象
*/
$!{tableInfo.name} insert($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
/**
* 修改数据
*
* @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
* @return 实例对象
*/
$!{tableInfo.name} update($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
/**
* 通过主键删除数据
*
* @param $!pk.name 主键
* @return 是否成功
*/
boolean deleteById($!pk.shortType $!pk.name);
}
6.seviceImpl
##定义初始变量
#set($tableName = $tool.append($tableInfo.name, "ServiceImpl"))
##设置回调
$!callback.setFileName($tool.append($tableName, ".java"))
$!callback.setSavePath($tool.append($tableInfo.savePath, "/service/impl"))
##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
#set($pk = $tableInfo.pkColumn.get(0))
#end
#if($tableInfo.savePackageName)package $!{tableInfo.savePackageName}.#{end}service.impl;
import $!{tableInfo.savePackageName}.entity.$!{tableInfo.name};
import $!{tableInfo.savePackageName}.dao.$!{tableInfo.name}Dao;
import $!{tableInfo.savePackageName}.service.$!{tableInfo.name}Service;
import $!{tableInfo.savePackageName}.bean.DataPage;
import org.springframework.stereotype.Service;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import $!{tableInfo.savePackageName}.bean.DataPage;
import javax.annotation.Resource;
import $!{tableInfo.savePackageName}.bean.DataPage;
import java.util.List;
/**
* $!{tableInfo.comment}($!{tableInfo.name})表服务实现类
*
* @author $!author
* @since $!time.currTime()
*/
@Service("$!tool.firstLowerCase($!{tableInfo.name})Service")
public class $!{tableName} implements $!{tableInfo.name}Service {
@Resource
private $!{tableInfo.name}Dao $!tool.firstLowerCase($!{tableInfo.name})Dao;
/**
* 通过ID查询单条数据
*
* @param $!pk.name 主键
* @return 实例对象
*/
@Override
public $!{tableInfo.name} queryById($!pk.shortType $!pk.name) {
return this.$!{tool.firstLowerCase($!{tableInfo.name})}Dao.queryById($!pk.name);
}
/**
* 查询多条数据
*
* @param pageNum 查询起始位置
* @param pageSize 查询条数
* @return 对象列表
*/
@Override
public DataPage<$!{tableInfo.name}> queryAllByPage(int pageNum, int pageSize, $!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
PageHelper.startPage(pageNum, pageSize);
List<$!{tableInfo.name}> $!{tool.firstLowerCase($!{tableInfo.name})}s = this.$!{tool.firstLowerCase($!{tableInfo.name})}Dao.queryAllByPage($!tool.firstLowerCase($!{tableInfo.name}));
PageInfo<$!{tableInfo.name}> pageInfo = new PageInfo<$!{tableInfo.name}>($!{tool.firstLowerCase($!{tableInfo.name})}s);
DataPage<$!{tableInfo.name}> $!{tool.firstLowerCase($!{tableInfo.name})}DataPage = new DataPage<$!{tableInfo.name}>();
$!{tool.firstLowerCase($!{tableInfo.name})}DataPage.setPageNum(pageNum);
$!{tool.firstLowerCase($!{tableInfo.name})}DataPage.setPageSize(pageInfo.getList().size());
$!{tool.firstLowerCase($!{tableInfo.name})}DataPage.setData(pageInfo.getList());
$!{tool.firstLowerCase($!{tableInfo.name})}DataPage.setTotal(pageInfo.getTotal());
return $!{tool.firstLowerCase($!{tableInfo.name})}DataPage;
}
/**
* 查询所有数据
*
* @return 对象列表
*/
@Override
public List<$!{tableInfo.name}> queryAll($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
List<$!{tableInfo.name}> $!{tool.firstLowerCase($!{tableInfo.name})}List = this.$!{tool.firstLowerCase($!{tableInfo.name})}Dao.queryAll($!tool.firstLowerCase($!{tableInfo.name}));
return $!{tool.firstLowerCase($!{tableInfo.name})}List;
}
/**
* 新增数据
*
* @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
* @return 实例对象
*/
@Override
public $!{tableInfo.name} insert($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
this.$!{tool.firstLowerCase($!{tableInfo.name})}Dao.insert($!tool.firstLowerCase($!{tableInfo.name}));
return $!tool.firstLowerCase($!{tableInfo.name});
}
/**
* 修改数据
*
* @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
* @return 实例对象
*/
@Override
public $!{tableInfo.name} update($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
this.$!{tool.firstLowerCase($!{tableInfo.name})}Dao.update($!tool.firstLowerCase($!{tableInfo.name}));
return this.queryById($!{tool.firstLowerCase($!{tableInfo.name})}.get$!tool.firstUpperCase($pk.name)());
}
/**
* 通过主键删除数据
*
* @param $!pk.name 主键
* @return 是否成功
*/
@Override
public boolean deleteById($!pk.shortType $!pk.name) {
return this.$!{tool.firstLowerCase($!{tableInfo.name})}Dao.deleteById($!pk.name) > 0;
}
}
附加:
R.java
package com.example.springvue.bean;
import lombok.Data;
@Data
public class R<T> {
private Integer code;
private String msg;
private T data;
public static R error() {
return error(500, "未知异常,请联系管理员");
}
public static R error(String msg) {
return error(500, msg);
}
public static R error(int code, String msg) {
R r = new R();
r.setCode(code);
r.setMsg(msg);
return r;
}
public static R ok() {
return ok("操作成功", null);
}
public static R ok(String msg) {
return ok(msg, null);
}
public static <T> R ok(T data) {
return ok("操作成功!", data);
}
public static <T> R ok(String msg, T data) {
R r = new R();
r.setCode(200);
r.setMsg(msg);
r.setData(data);
return r;
}
}
DataPage.java
package com.example.springvue.bean;
import java.util.List;
public class DataPage<T> {
private static final long serialVersionUID = 1L;
private long total;
private int pageSize;
private int totalPage;
private int pageNum;
private List<T> data;
public DataPage() {
}
public DataPage(List<T> list, int total, int pageSize, int pageNum) {
this.data = list;
this.total = total;
this.pageSize = pageSize;
this.pageNum = pageNum;
this.totalPage = (int)Math.ceil((double) total /pageSize);
}
public long getTotal() {
return total;
}
public void setTotal(long total) {
this.total = total;
}
public int getPageSize() {
return pageSize;
}
public void setPageSize(int pageSize) {
this.pageSize = pageSize;
}
public int getTotalPage() {
return totalPage;
}
public void setTotalPage(int totalPage) {
this.totalPage = totalPage;
}
public int getPageNum() {
return pageNum;
}
public void setPageNum(int pageNum) {
this.pageNum = pageNum;
}
public List<T> getData() {
return data;
}
public void setData(List<T> data) {
this.data = data;
}
}
Tip: 上述生成代码还需引入pagehelper和swagger两个框架
笔者的pom.xml如下:
<dependencies>
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.7.20</version>
</dependency>
<dependency>
<groupId>com.auth0</groupId>
<artifactId>java-jwt</artifactId>
<version>3.19.0</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.30</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.3.0</version>
</dependency>
<!-- 引入swagger相关的jar -->
<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>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.3.0</version>
</dependency>
</dependencies>