这篇文章给大家分享的是有关SpringBoot整合freemarker代码自动生成器的示例分析的内容。小编觉得挺实用的，因此分享给大家做个参考，一起跟随小编过来看看吧。技术架构页面是用 Vue ，element-ui开发；网络请求是 Axi
这篇文章给大家分享的是有关SpringBoot整合freemarker代码自动生成器的示例分析的内容。小编觉得挺实用的，因此分享给大家做个参考，一起跟随小编过来看看吧。
页面是用 Vue ，element-ui开发；网络请求是 AxiOS。
服务端是 Spring Boot
页面模版是 Freemarker：
所需包结构
在model包中创建Db类
作用：用于接受前端传来数据库连接相关的值(username，passWord,url)
package com.example.generate_code.model;public class Db { private String username; private String password; private String url; public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } public String getUrl() { return url; } public void setUrl(String url) { this.url = url; }}在model中创建RespBean类
自定义响应类，返回数据更方便
package com.example.generate_code.model;public class RespBean { private Integer status; private String msg; private Object obj; public static RespBean ok(String msg,Object obj) { return new RespBean(200, msg, obj); } public static RespBean ok(String msg) { return new RespBean(200, msg, null); } public static RespBean error(String msg,Object obj) { return new RespBean(500, msg, obj); } public static RespBean error(String msg) { return new RespBean(500, msg, null); } private RespBean() { } private RespBean(Integer status, String msg, Object obj) { this.status = status; this.msg = msg; this.obj = obj; } public Integer getStatus() { return status; } public void setStatus(Integer status) { this.status = status; } public String getMsg() { return msg; } public void setMsg(String msg) { this.msg = msg; } public Object getObj() { return obj; } public void setObj(Object obj) { this.obj = obj; }}在Utils中创建DBUtils
JDBC连接工具类
public class DbUtils { private static Connection connection; public static Connection getConnection() { return connection; } public static Connection initDb(Db db) { if (connection == null) { try { Class.forName("com.mysql.cj.jdbc.Driver"); connection = DriverManager.getConnection(db.getUrl(), db.getUsername(), db.getPassword()); } catch (ClassNotFoundException | sqlException e) { e.printStackTrace(); } } return connection; }}写一个连接接口DbController
连接数据库
@RestControllerpublic class DbController { @PostMapping("/connect") public RespBean connect(@RequestBody Db db) { Connection con = DBUtils.initDb(db); if (con != null) { return RespBean.ok("数据库连接成功"); } return RespBean.error("数据库连接失败"); }}创建index页面
<!DOCTYPE html><html lang="en"><head> <meta charset="UTF-8"> <title>代码生成工具</title> <script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script> <!-- 引入样式 --> <link rel="stylesheet" href="Https://unpkg.com/element-ui/lib/theme-chalk/index.CSS"> <!-- 引入组件库 --> <script src="https://unpkg.com/element-ui/lib/index.js"></script> <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script></head><body><div id="app"> <table> <tr> <td> <el-tag size="mini">数据库用户名：</el-tag> </td> <td> <el-input size="mini" v-model="db.username"></el-input> </td> </tr> <tr> <td> <el-tag size="mini">数据库密码：</el-tag> </td> <td> <el-input size="mini" v-model="db.password"></el-input> </td> </tr> <tr> <td> <el-tag size="mini">数据库连接地址：</el-tag> </td> <td> <el-input size="mini" v-model="db.url"> <template slot="prepend">jdbc:Mysql://</template> <template slot="append"> ?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai </template> </el-input> </td> </tr> </table> <div > <el-button type="primary" size="mini" @click="connect" :disabled="!connectBtnEnabled">连接数据库</el-button> <div >[{{msg}}]</div> <el-input v-model="packageName" size="mini" ></el-input> <el-button type="primary" size="mini" @click="config">配置</el-button> </div></div><script> new Vue({ el: "#app", data: function () { return { packageName: '', msg: '数据库未连接', connectBtnEnabled: true, db: { username: "root", password: "123456", url: "localhost:3306/" } } }, methods: { connect() { let _this = this; this.db.url = "jdbc:mysql://" + this.db.url + "?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai"; axios.post('/connect', this.db) .then(function (response) { _this.msg = response.data.msg; _this.db = { username: "root", password: "123456", url: "localhost:3306/" } _this.connectBtnEnabled = false; }) .catch(function (error) { console.log(error); }); } } })</script></body></html>
服务器端编写
ColumnClass 用来描述表中的每一列
package com.example.generate_code.model;public class ColumnClass { private String propertyName; //对应java属性的名字 private String columnName; //数据库中的名字 private String type; //字段类型 private String remark; //备注 private Boolean isPrimary; //字段是不是一个主键 @Override public String toString() { return "ColumnClass{" + "propertyName='" + propertyName + '\'' + ", columnName='" + columnName + '\'' + ", type='" + type + '\'' + ", remark='" + remark + '\'' + ", isPrimary=" + isPrimary + '}'; } public String getPropertyName() { return propertyName; } public void setPropertyName(String propertyName) { this.propertyName = propertyName; } public String getColumnName() { return columnName; } public void setColumnName(String columnName) { this.columnName = columnName; } public String getType() { return type; } public void setType(String type) { this.type = type; } public String getRemark() { return remark; } public void setRemark(String remark) { this.remark = remark; } public Boolean getPrimary() { return isPrimary; } public void setPrimary(Boolean primary) { isPrimary = primary; }}描述一个具体的表的信息 TableClass
package com.example.generate_code.model;import java.util.List;public class TableClass { private String tableName; //表名 ，以下是生成的名字 private String modelName; private String serviceName; private String mapperName; private String controllerName; private String packageName; private List<ColumnClass> columns; // 字段 @Override public String toString() { return "TableClass{" + "tableName='" + tableName + '\'' + ", modelName='" + modelName + '\'' + ", serviceName='" + serviceName + '\'' + ", mapperName='" + mapperName + '\'' + ", controllerName='" + controllerName + '\'' + ", packageName='" + packageName + '\'' + ", columns=" + columns + '}'; } public String getTableName() { return tableName; } public void setTableName(String tableName) { this.tableName = tableName; } public String getModelName() { return modelName; } public void setModelName(String modelName) { this.modelName = modelName; } public String getServiceName() { return serviceName; } public void setServiceName(String serviceName) { this.serviceName = serviceName; } public String getMapperName() { return mapperName; } public void setMapperName(String mapperName) { this.mapperName = mapperName; } public String getControllerName() { return controllerName; } public void setControllerName(String controllerName) { this.controllerName = controllerName; } public String getPackageName() { return packageName; } public void setPackageName(String packageName) { this.packageName = packageName; } public List<ColumnClass> getColumns() { return columns; } public void setColumns(List<ColumnClass> columns) { this.columns = columns; }}用map来接受前端传来的数据
用到了谷歌提供的工具包guava，需要导入依赖
@PostMapping("/config") public RespBean config(@RequestBody Map<String, String> map) { String packageName = map.get("packageName"); try { Connection connection = DBUtils.getConnection(); DatabaseMetaData metaData = connection.getMetaData(); ResultSet tables = metaData.getTables(connection.getCatalog(), null, null, null); List<TableClass> tableClassList = new ArrayList<>(); while (tables.next()) { TableClass tableClass = new TableClass(); tableClass.setPackageName(packageName); String table_name = tables.getString("TABLE_NAME"); String modelName = CaseFORMat.LOWER_UNDERSCORE.to(CaseFormat.UPPER_CAMEL, table_name); tableClass.setTableName(table_name); tableClass.setModelName(modelName); tableClass.setControllerName(modelName + "Controller"); tableClass.setMapperName(modelName + "Mapper"); tableClass.setServiceName(modelName+"Service"); tableClassList.add(tableClass); } return RespBean.ok("数据库信息读取成功", tableClassList); } catch (Exception e) { e.printStackTrace(); } return RespBean.error("数据库信息读取失败"); }<dependency> <groupId>com.Google.guava</groupId> <artifactId>guava</artifactId> <version>30.1-jre</version> </dependency>完善index页面
<!DOCTYPE html><html lang="en"><head> <meta charset="UTF-8"> <title>代码生成工具</title> <script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script> <!-- 引入样式 --> <link rel="stylesheet" href="https://unpkg.com/element-ui/lib/theme-chalk/index.css"> <!-- 引入组件库 --> <script src="https://unpkg.com/element-ui/lib/index.js"></script> <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script></head><body><div id="app"> <table> <tr> <td> <el-tag size="mini">数据库用户名：</el-tag> </td> <td> <el-input size="mini" v-model="db.username"></el-input> </td> </tr> <tr> <td> <el-tag size="mini">数据库密码：</el-tag> </td> <td> <el-input size="mini" v-model="db.password"></el-input> </td> </tr> <tr> <td> <el-tag size="mini">数据库连接地址：</el-tag> </td> <td> <el-input size="mini" v-model="db.url"> <template slot="prepend">jdbc:mysql://</template> <template slot="append"> ?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai </template> </el-input> </td> </tr> </table> <div > <el-button type="primary" size="mini" @click="connect" :disabled="!connectBtnEnabled">连接数据库</el-button> <div >[{{msg}}]</div> <el-input v-model="packageName" size="mini" ></el-input> <el-button type="primary" size="mini" @click="config">配置</el-button> </div> <el-table :data="tableData" stripe border > <el-table-column prop="tableName" label="表名称" width="180"> </el-table-column> <el-table-column label="实体类名称" width="180"> <template slot-scope="scope"> <el-input v-model="scope.row.modelName"></el-input> </template> </el-table-column> <el-table-column label="Mapper名称"> <template slot-scope="scope"> <el-input v-model="scope.row.mapperName"></el-input> </template> </el-table-column> <el-table-column label="Service名称"> <template slot-scope="scope"> <el-input v-model="scope.row.serviceName"></el-input> </template> </el-table-column> <el-table-column label="Controller名称"> <template slot-scope="scope"> <el-input v-model="scope.row.controllerName"></el-input> </template> </el-table-column> </el-table> <div> <el-button @click="generateCode" type="success">生成代码</el-button> <div >*{{result}}*</div> <div>{{codePath}}</div> </div></div><script> new Vue({ el: "#app", data: function () { return { tableData: [], packageName: 'com.wangze.test', msg: '数据库未连接', connectBtnEnabled: true, db: { username: "root", password: "123456", url: "localhost:3306/" } } }, methods: { generateCode() { let _this = this; axios.post('/generateCode', this.tableData) .then(function (response) { _this.result = response.data.msg; _this.codePath = response.data.obj; }) .catch(function (error) { }); }, config() { let _this = this; axios.post('/config', {packageName: this.packageName}) .then(function (response) { _this.msg = response.data.msg; _this.tableData = response.data.obj; }) .catch(function (error) { console.log(error); }); }, connect() { let _this = this; this.db.url = "jdbc:mysql://" + this.db.url + "?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai"; axios.post('/connect', this.db) .then(function (response) { _this.msg = response.data.msg; _this.db = { username: "root", password: "123456", url: "localhost:3306/" } _this.connectBtnEnabled = false; }) .catch(function (error) { console.log(error); }); } } })</script></body></html>
创建模板 Model.java.ftl
package ${packageName}.model;import java.util.Date;public class ${modelName}{ <#if columns??> <#list columns as column> <#if column.type='VARCHAR'||column.type='TEXT'||column.type='CHAR'> private String ${column.propertyName?uncap_first}; </#if> <#if column.type='INT'> private Integer ${column.propertyName?uncap_first}; </#if> <#if column.type='DATETIME'> private Date ${column.propertyName?uncap_first}; </#if> <#if column.type='BIGINT'> private Long ${column.propertyName?uncap_first}; </#if> <#if column.type='DOUBLE'> private Double ${column.propertyName?uncap_first}; </#if> <#if column.type='BIT'> private Boolean ${column.propertyName?uncap_first}; </#if> </#list> </#if> <#if columns??> <#list columns as column> <#if column.type='VARCHAR'||column.type='TEXT'||column.type='CHAR'> public String get${column.propertyName}(){ return ${column.propertyName?uncap_first}; } public void set${column.propertyName}(String ${column.propertyName?uncap_first}){ this.${column.propertyName?uncap_first}=${column.propertyName?uncap_first}; } </#if> <#if column.type='INT'> public Integer get${column.propertyName}(){ return ${column.propertyName?uncap_first}; } public void set${column.propertyName}(Integer ${column.propertyName?uncap_first}){ this.${column.propertyName?uncap_first}=${column.propertyName?uncap_first}; } </#if> <#if column.type='DATETIME'> public Date get${column.propertyName}(){ return ${column.propertyName?uncap_first}; } public void set${column.propertyName}(Date ${column.propertyName?uncap_first}){ this.${column.propertyName?uncap_first}=${column.propertyName?uncap_first}; } </#if> <#if column.type='BIGINT'> public Long get${column.propertyName}(){ return ${column.propertyName?uncap_first}; } public void set${column.propertyName}(Long ${column.propertyName?uncap_first}){ this.${column.propertyName?uncap_first}=${column.propertyName?uncap_first}; } </#if> <#if column.type='DOUBLE'> public Double get${column.propertyName}(){ return ${column.propertyName?uncap_first}; } public void set${column.propertyName}(Double ${column.propertyName?uncap_first}){ this.${column.propertyName?uncap_first}=${column.propertyName?uncap_first}; } </#if> <#if column.type='BIT'> public Boolean get${column.propertyName}(){ return ${column.propertyName?uncap_first}; } public void set${column.propertyName}(Boolean ${column.propertyName?uncap_first}){ this.${column.propertyName?uncap_first}=${column.propertyName?uncap_first}; } </#if> </#list> </#if>}Service.java.ftl
package ${packageName}.service;import ${packageName}.model.${modelName};import ${packageName}.mapper.${mapperName};import org.springframework.stereotype.Service;import org.springframework.beans.factory.annotation.Autowired;import java.util.List;@Servicepublic class ${serviceName}{ @Autowired ${mapperName} ${mapperName?uncap_first}; public List<${modelName}> getAll${modelName}s(){ return ${mapperName?uncap_first}.getAll${modelName}s(); }}Controller.java.ftl
package ${packageName}.controller;import ${packageName}.model.${modelName};import ${packageName}.service.${serviceName};import org.springframework.beans.factory.annotation.Autowired;import org.springframework.WEB.bind.annotation.RestController;import org.springframework.web.bind.annotation.GetMapping;import java.util.List;@RestControllerpublic class ${controllerName}{ @Autowired ${serviceName} ${serviceName?uncap_first}; @GetMapping("/${modelName?lower_case}s") public List<${modelName}> getAll${modelName}s(){ return ${serviceName?uncap_first}.getAll${modelName}s(); }}Mapper.java.ftl
package ${packageName}.mapper;import ${packageName}.model.${modelName};import org.apache.ibatis.annotations.Mapper;import java.util.List;@Mapperpublic interface ${mapperName}{ List<${modelName}> getAll${modelName}s();}Mapper.xml.ftl
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="${packageName}.mapper.${mapperName}"> <resultMap id="BaseResultMap" type="${packageName}.model.${modelName}"> <#list columns as column> <<#if column.primary??>id<#else>result</#if> column="${column.columnName}" property="${column.propertyName?uncap_first}" jdbcType="<#if column.type='INT'>INTEGER<#elseif column.type='DATETIME'>TIMESTAMP<#elseif column.type='TEXT'>VARCHAR<#else>${column.type}</#if>" /> </#list> </resultMap> <select id="getAll${modelName}s" resultMap="BaseResultMap"> select * from ${tableName}; </select></mapper>代码生成Controller
package com.example.generate_code.controller;import com.example.generate_code.model.RespBean;import com.example.generate_code.model.TableClass;import com.example.generate_code.service.GenerateCodeService;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.web.bind.annotation.PostMapping;import org.springframework.web.bind.annotation.RequestBody;import org.springframework.web.bind.annotation.RestController;import javax.servlet.http.HttpServletRequest;import java.util.List;@RestControllerpublic class GenerateCodeController { @Autowired GenerateCodeService generateCodeService; @PostMapping("/generateCode") public RespBean generateCode(@RequestBody List<TableClass> tableClassList, HttpServletRequest req) { return generateCodeService.generateCode(tableClassList, req.getServletContext().getRealPath("/")); }}编写service
package com.example.generate_code.service;import com.example.generate_code.model.ColumnClass;import com.example.generate_code.model.RespBean;import com.example.generate_code.model.TableClass;import com.example.generate_code.utils.DBUtils;import com.google.common.base.CaseFormat;import freemarker.cache.ClassTemplateLoader;import freemarker.template.Configuration;import freemarker.template.Template;import freemarker.template.TemplateException;import org.springframework.stereotype.Service;import java.io.File;import java.io.FileOutputStream;import java.io.IOException;import java.io.OutputStreamWriter;import java.sql.Connection;import java.sql.DatabaseMetaData;import java.sql.ResultSet;import java.util.ArrayList;import java.util.List;@Servicepublic class GenerateCodeService { Configuration cfg = null; { cfg = new Configuration(Configuration.VERSION_2_3_30); cfg.setTemplateLoader(new ClassTemplateLoader(GenerateCodeService.class, "/templates")); cfg.setDefaultEncoding("UTF-8"); } public RespBean generateCode(List<TableClass> tableClassList, String realPath) { try { Template modelTemplate = cfg.getTemplate("Model.java.ftl"); Template mapperJavaTemplate = cfg.getTemplate("Mapper.java.ftl"); Template mapperXmlTemplate = cfg.getTemplate("Mapper.xml.ftl"); Template serviceTemplate = cfg.getTemplate("Service.java.ftl"); Template controllerTemplate = cfg.getTemplate("Controller.java.ftl"); Connection connection = DBUtils.getConnection(); DatabaseMetaData metaData = connection.getMetaData(); for (TableClass tableClass : tableClassList) { ResultSet columns = metaData.getColumns(connection.getCatalog(), null, tableClass.getTableName(), null); ResultSet primaryKeys = metaData.getPrimaryKeys(connection.getCatalog(), null, tableClass.getTableName()); List<ColumnClass> columnClassList = new ArrayList<>(); while (columns.next()) { String column_name = columns.getString("COLUMN_NAME"); String type_name = columns.getString("TYPE_NAME"); String remarks = columns.getString("REMARKS"); ColumnClass columnClass = new ColumnClass(); columnClass.setRemark(remarks); columnClass.setColumnName(column_name); columnClass.setType(type_name); columnClass.setPropertyName(CaseFormat.LOWER_UNDERSCORE.to(CaseFormat.UPPER_CAMEL, column_name)); primaryKeys.first(); while (primaryKeys.next()) { String pkName = primaryKeys.getString("COLUMN_NAME"); if (column_name.equals(pkName)) { columnClass.setPrimary(true); } } columnClassList.add(columnClass); } tableClass.setColumns(columnClassList); String path = realPath + "/" + tableClass.getPackageName().replace(".", "/"); generate(modelTemplate, tableClass, path + "/model/"); generate(mapperJavaTemplate, tableClass, path + "/mapper/"); generate(mapperXmlTemplate, tableClass, path + "/mapper/"); generate(serviceTemplate, tableClass, path + "/service/"); generate(controllerTemplate, tableClass, path + "/controller/"); } return RespBean.ok("代码已生成", realPath); } catch (Exception e) { e.printStackTrace(); } return RespBean.error("代码生成失败"); } private void generate(Template template, TableClass tableClass, String path) throws IOException, TemplateException { File folder = new File(path); if (!folder.exists()) { folder.mkdirs(); } String fileName = path + "/" + tableClass.getModelName() + template.getName().replace(".ftl", "").replace("Model", ""); FileOutputStream fos = new FileOutputStream(fileName); OutputStreamWriter out = new OutputStreamWriter(fos); template.process(tableClass,out); fos.close(); out.close(); }}
这时候已经找到了，我们来验证一下效果！
修改写配置
spring.datasource.name=rootspring.datasource.password=123456spring.datasource.url=jdbc:mysql://localhost:3306/boot_crm?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghaipom.xml
<resources> <resource> <directory>src/main/java</directory> <includes> <include>**/*.xml</include> </includes> </resource> <resource> <directory>src/main/resources</directory> </resource> </resources>导入生成的代码
运行测试
一个基本的mybatis逆向工程就完成了!
springboot一种全新的编程规范，其设计目的是用来简化新Spring应用的初始搭建以及开发过程，SpringBoot也是一个服务于框架的框架，服务范围是简化配置文件。
感谢各位的阅读！关于“springboot整合freemarker代码自动生成器的示例分析”这篇文章就分享到这里了，希望以上内容可以对大家有一定的帮助，让大家可以学到更多知识，如果觉得文章不错，可以把它分享出去让更多的人看到吧！
--结束END--
本文标题: springboot整合freemarker代码自动生成器的示例分析
本文链接: https://www.lsjlt.com/news/278284.html(转载时请注明来源链接)
有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341
下载Word文档到电脑，方便收藏和打印～
2024-05-22
2024-05-22
2024-05-22
2024-05-21
2024-05-21
2024-05-21
2024-05-21
2024-05-21
2024-05-21
2024-05-21
回答
回答
回答
回答
回答
回答
回答
回答
回答
回答
官方手机版
微信公众号
商务合作
0