实战：一键生成前后端代码，Mybatis-Plus代码生成器让我舒服了
前言
在日常的软件开发中，程序员往往需要花费大量的时间写CRUD，不仅枯燥效率低，而且每个人的代码风格不统一。MyBatis-Plus 代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块及前端页面的代码，极大的提升了开发效率。
项目介绍
本项目将以springboot用演示，前端使用freemaker,数据库持久层用mybatis(考虑到mybatis的使用还是最普遍的，就没有用jpa和mybatisplus)，通过Velocity模板引擎配置各模块的文件模板，通过mybatis-plus代码生成器连接mysql，用商品表为例生成各模块的代码和前端页面。(本项目只演示分页查询和导出功能)。
本项目所有代码和脚本都能都文末找到地址。
实战
数据库脚本
创建一张商品表test_goods
CREATE TABLE `test_goods` (
`id` bigint(20) DEFAULT NULL COMMENT 'id',
`goods_sn` varchar(45) DEFAULT NULL COMMENT '商品编码',
`name` varchar(255) DEFAULT NULL COMMENT '商品名称',
`title` varchar(80) DEFAULT NULL COMMENT '标题',
`price` decimal(10,2) DEFAULT NULL COMMENT '售价',
`status` int(2) DEFAULT NULL COMMENT '商品状态',
`sale_count` int(11) DEFAULT NULL COMMENT '销量',
`create_date` datetime DEFAULT NULL COMMENT '创建时间',
`modify_date` datetime DEFAULT NULL COMMENT '修改时间'
) ENGINE=InnoDB DEFAULT CHARSET=utf8
maven依赖
org.springframework.boot
spring-boot-starter-web
org.mybatis.spring.boot
mybatis-spring-boot-starter
2.1.2
org.springframework.boot
spring-boot-starter-data-redis
com.baomidou
mybatis-plus
2.1.4
org.aspectj
aspectjweaver
provided
org.projectlombok
lombok
1.16.10
provided
org.apache.velocity
velocity-engine-core
2.0
mysql
mysql-connector-java
runtime
com.opencsv
opencsv
3.8
org.springframework.boot
spring-boot-starter-freemarker
配置文件
mybatis:
mapper-locations: classpath:mybatis/*Mapper.xml
type-aliases-package: com.lzn.mybatisplus.codegenerator.entity
spring:
datasource:
username: root
password: 123qwe
url: jdbc:mysql://192.168.0.1:3306/myProject?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC
driver-class-name: com.mysql.jdbc.Driver
redis:
host: 192.168.0.1
password: 1234qwer
port: 6379
freemarker:
template-loader-path: classpath:/templates/pages/
cache: false
charset: UTF-8
check-template-location: true
content-type: text/html
expose-request-attributes: true
expose-session-attributes: true
suffix: .ftl
模板文件
本项目中，所有模块的文件都是用Velocity模板引擎生成，这里简单介绍下Velocity的语法，在Velocity中用 表示变量，例如： {table.entityName} 表示实体名，{author}、 {date} 表示作者，日期等。在Velocity中用#表示语法，例如 #foreach( field in ${table.fields}) #end遍历表字段。下面演示几个类、前端文件、xml文件的模板文件
实体类模板(entity.java.vm)
package ${package.Entity};
import java.math.BigDecimal;
import java.util.Date;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
/**
* 数据库表名 ${table.name}
*
* @author ${author}
* @date ${date}
*/
@Getter
@Setter
@ToString
public class ${table.entityName} {
#foreach($field in ${table.fields})
/**
* 数据库字段名 ${field.name} 类型 ${field.type}
*/
private ${field.propertyType} ${field.propertyName};
#end
}
Controller模板(controller.java.vm)
package ${package.Controller};
import ${package.Entity}.${entity};
import ${package.Service}.${table.serviceName};
import com.lzn.mybatisplus.codegenerator.export.${table.entityName}VO;
import com.lzn.mybatisplus.codegenerator.export.${table.entityName}ExportService;
import com.lzn.mybatisplus.codegenerator.utils.entity.*;
import com.lzn.mybatisplus.codegenerator.utils.export.*;
import org.apache.commons.beanutils.ConvertUtils;
import com.lzn.mybatisplus.codegenerator.utils.ParameterUtil;
import com.lzn.mybatisplus.codegenerator.utils.entity.GridDataModel;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import java.util.List;
import java.util.Map;
/**
*
* ${tablecomment} 前端控制器
*
*
* @author ${author}
* @since ${date}
*/
@Controller
@RequestMapping(value="/admin/${table.entityPath}")
public class ${table.controllerName}{
private static Logger logger = LoggerFactory.getLogger(${table.controllerName}.class);
@Resource
private ${entity}Service ${table.entityPath}Service;
@RequestMapping(value = "list", method = RequestMethod.GET)
public String list(Model model){
return "/admin/${cfg.pageDirName}/list";
}
@RequestMapping(value = "searchList", method = RequestMethod.POST)
@ResponseBody
@ExportMethod(serviceClass = ${entity}ExportService.class, memo = "明细导出")
public String searchList(ServletRequest request,@ModelAttribute("page") OmuiPage page){
try {
Map searchParam = ParameterUtil.getParametersStartingWith(request, "filter_");
GridDataModel<${entity}VO> gd =${table.entityPath}Service.findByPage(searchParam, page);
return JsonMapper.nonDefaultMapper().toJson(gd);
} catch (Exception e) {
logger.error("查询出错了",e);
return JsonMapper.nonDefaultMapper().toJson(new Resp("false", e.getMessage()));
}
}
}
Service类模板(service.java.vm)
package ${package.Service};
import org.springframework.stereotype.Service;
import com.lzn.mybatisplus.codegenerator.dao.${table.mapperName};
import com.lzn.mybatisplus.codegenerator.utils.entity.GridDataModel;
import com.lzn.mybatisplus.codegenerator.utils.entity.OmuiPage;
import com.lzn.mybatisplus.codegenerator.export.${table.entityName}VO;
import javax.annotation.Resource;
import java.math.BigDecimal;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.*;
/**
*
* $!{tablecomment} 服务类
*
*
* @author ${author}
* @since ${date}
*/
@Service
public class ${table.serviceName} {
@Resource
private ${table.mapperName} ${table.entityPath}Dao;
/**
* 分页查询
* */
public GridDataModel<${table.entityName}VO> findByPage(Map searchParams, OmuiPage page){
GridDataModel<${table.entityName}VO> gm = new GridDataModel<${table.entityName}VO>();
searchParams.put("start", page.getStart());
searchParams.put("limit", page.getLimit());
long count = ${table.entityPath}Dao.countForPage(searchParams);
List<${table.entityName}VO> list = ${table.entityPath}Dao.listForPage(searchParams);
gm.setTotal(count);
gm.setRows(list);
return gm;
}
}
Dao类模板(dao.java.vm)
package ${package.Mapper};
import com.lzn.mybatisplus.codegenerator.entity.${table.entityName};
import com.lzn.mybatisplus.codegenerator.export.${table.entityName}VO;
import java.util.List;
import java.util.Map;
public interface ${table.mapperName} {
/**
* 根据主键删除数据库的记录, ${table.name}
*/
int deleteByPrimaryKey(Long id);
/**
* 新写入数据库记录, ${table.name}
*/
int insert(${table.entityName} record);
/**
* 根据指定主键获取一条数据库记录, ${table.name}
*/
${table.entityName} selectByPrimaryKey(Long id);
/**
* 根据主键来更新符合条件的数据库记录, ${table.name}
*/
int updateByPrimaryKey(${table.entityName} record);
/**
* 根据条件分页查询
* */
List<${table.entityName}VO> listForPage(Map searchMap);
/**
* 根据条件分页查询(计数)
* */
long countForPage(Map searchMap);
}
Mapper.xml模板(mapper.xml.vm)
#if(${baseResultMap})
#foreach($field in ${table.fields})
#if(${field.keyFlag})##生成主键排在第一位
#foreach($field in ${table.commonFields})
#if(${field.name} == ${field.propertyName})${field.name}#else${field.name} AS ${field.propertyName}#end,
#end
${table.fieldNames}
#end
delete from ${table.name}
where
#foreach($field in ${table.fields})
#if(${field.keyFlag})## 主键
${field.name} = #{ ${field.propertyName} }
#end
#end
SELECT LAST_INSERT_ID()
insert into ${table.name} (
#foreach($field in ${table.fields})
#if(!${field.keyFlag})##生成普通字段
${field.name}#if($foreach.hasNext),#end
#end
#end
)
values (
#foreach($field in ${table.fields})
#if(!${field.keyFlag})##生成普通字段
#{ ${field.propertyName}}#if($foreach.hasNext),#end
#end
#end
)
update ${table.name}
set
#foreach($field in ${table.fields})
#if(!${field.keyFlag})##生成普通字段
${field.name} = #{ ${field.propertyName}} #if($foreach.hasNext),#end
#end
#end
where
#foreach($field in ${table.fields})
#if(${field.keyFlag})
id = #{ ${field.name} }
#end
#end
select
select
count(*)
from
${table.name}
where 1=1
and create_date =]]> #{beginDate}
and create_date #{endDate}
select
and create_date =]]> #{beginDate}
and create_date #{endDate}
limit #{start}, #{limit}
前端页面list.ftl模板(list.ftl.vm)
<#assign base=request.contextPath>
$!{tablecomment}
$().ready(function(){
//初始化控件
$("#search-panel").omPanel({
title : "条件搜索",collapsible:false
});
//搜索
$('#searchButton').bind('click', function(e) {
var data = $("#listForm").HForm('form2json');
$('#listGrid').omGrid({extraData:data});
});
$("#start-time").omCalendar();
$("#time-end").omCalendar();
$('#searchButton').omButton({
icons : {left : '${base}/static/omui/images/search.png'},width : 70
});
$(".input-select").change(function(){
$('#searchButton').click();
});
$('#buttonbar').omButtonbar({
btns : [{label:"导出Excel",
id:"addbutton" ,
icons : {left : '${base}/static/omui/images/export.png'},
onClick:function()
{
exportUtil({
title : "列表导出",
exportUrl : "${base}/admin/${table.entityPath}/searchList",
extraParam : $("#listForm").HForm('form2json')
});
}
}
]
});
//初始化列表
var height=$(document).height() -$('#search-panel').outerHeight()-$('#buttonbar').outerHeight()-40;
$('#listGrid').omGrid({
height:height,
limit:20,
method:'post',
singleSelect:false,
extraData:$("#listForm").HForm('form2json'),
dataSource : '${base}/admin/${table.entityPath}/searchList',
colModel : [
{header : 'ID', name : 'id', width : 30, align : 'left',sort:'serverSide'},
{header : '创建时间', name : 'createDate', width : 150, align : 'left',sort:'serverSide',renderer :dataFormat1},
{header : '修改时间', name : 'modifyDate', width : 150, align : 'left',sort:'serverSide',renderer :dataFormat1},
#foreach($field in ${table.fields})
#set($comment = "")
#set($type = "")
#set($isNullAble = true)
#set($defaultValue = false)
#set($listIsShow = true)
#set($listIsSearch = false)
#foreach( $e in $field.comment.split(","))
#if( $foreach.count == 1 )
#set($comment = $e)
#elseif( $foreach.count == 2 )
#set($type = $e)
#elseif( $foreach.count == 3)
#if($e == "YES")
#set($isNullAble = true)
#else
#set($isNullAble = false)
#end
#elseif( $foreach.count == 4)
#if($e == "true")
#set($defaultValue = true)
#else
#set($defaultValue = false)
#end
#elseif( $foreach.count == 5)
#if($e == "true")
#set($listIsShow = true)
#else
#set($listIsShow = false)
#end
#elseif( $foreach.count == 6)
#if($e == "true")
#set($listIsSearch = true)
#else
#set($listIsSearch = false)
#end
#end
#end
{header : '#if("$!comment" != "")${comment}#end', name : '${field.propertyName}',width : 90, align : 'left',sort:'serverSide'#if($type == "timer"),renderer :dataFormat1 #end},
#end
],
rowDetailsProvider:function(rowData){
}
});
//初始化控件 end
function getIds(datas) {
var str = "";
for (var i = 0; i < datas.length; i++) {
str += datas[i].id + ",";
}
//去掉最后一个逗号(如果不需要去掉，就不用写)
if (str.length > 0) {
str = str.substr(0, str.length - 1);
}
return str;
}
$('#searchButton').click();
});
状态:
待处理
已处理
全部
手机号：
联系人：
创建时间：
查询