1 Star 0 Fork 90

fofw / generator

forked from baomidou / generator 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

安装

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>Latest Version</version>
</dependency>

使用(存在对历史版本的不兼容)

快速生成

FastAutoGenerator.create("url", "username", "password")
	.globalConfig(builder -> {
		builder.author("L.cm")
			.dateType(DateType.TIME_PACK)
			.fileOverride()
			.outputDir("目录");
	})
	.packageConfig(builder -> {
		builder.parent("net.xxxx.project")
			.moduleName("system");
	})
	.strategyConfig(builder -> {
		builder.addInclude("sys_xxx")
			.entityBuilder()
			.enableLombok()
			.superClass(BaseModel.class)
			.addSuperEntityColumns("id", "created_by", "created_at", "updated_by", "updated_at")
			.naming(NamingStrategy.underline_to_camel)
			.controllerBuilder()
			.superClass(BaseController.class)
			.enableRestStyle()
			.enableHyphenStyle()
			.mapperBuilder()
			.enableMapperAnnotation()
			.enableBaseResultMap()
			.enableBaseColumnList()
		;
	})
	.templateEngine(new FreemarkerTemplateEngine())
	.execute();

交互式生成

new SimpleAutoGenerator() {
    @Override
    public IConfigBuilder<DataSourceConfig> dataSourceConfigBuilder() {
        return new DataSourceConfig.Builder("jdbc:h2:mem:test;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE;CASE_INSENSITIVE_IDENTIFIERS=TRUE",
        "sa", "");
    }
}.execute();

数据库配置(DataSourceConfig)

基础配置
属性 说明 示例
url jdbc路径 jdbc:mysql://127.0.0.1:3306/mybatis-plus
username 数据库账号 root
password 数据库密码 123456
new DataSourceConfig.
    Builder("jdbc:mysql://127.0.0.1:3306/mybatis-plus","root","123456").build();
可选配置
方法 说明 示例
driver 数据库驱动 Driver.class 或 com.mysql.jdbc.Driver
dbType 数据库类型 DbType.MYSQL
typeConvert 数据库类型转换器 new MySqlTypeConvert()
keyWordsHandler 数据库关键字处理器 new MySqlKeyWordsHandler()
dbQuery 数据库查询 new MySqlQuery()
schema 数据库schema(部分数据库适用) mybatis-plus
new DataSourceConfig
    .Builder("jdbc:mysql://127.0.0.1:3306/mybatis-plus","root","123456")
	.driver(Driver.class)
	.dbType(DbType.MYSQL)
	.typeConvert(new MySqlTypeConvert())
	.keyWordsHandler(new MySqlKeyWordsHandler())
	.dbQuery(new MySqlQuery())
	.schema("mybatis-plus")
	.build();

全局配置(GlobalConfig)

方法 说明 示例
fileOverride 是否覆盖已生成文件 默认值:false
openDir 是否打开生成目录 默认值:true
outputDir 指定输出目录 /opt/baomidou/ 默认值: windows:D:// linux or mac : /tmp
author 作者名 baomidou 默认值:无
kotlin 是否生成kotlin 默认值:false
swagger 是否生成swagger注解 默认值:false
dateType 时间策略 DateType.ONLY_DATE 默认值: DateType.TIME_PACK
commentDate 注释日期 默认值: yyyy-MM-dd
GeneratorBuilder.globalConfigBuilder()
   .fileOverride(true).openDir(true).kotlin(false).swagger(true)
   .outputDir("/opt/baomidou")
   .author("baomidou").dateType(DateType.TIME_PACK).commentDate("yyyy-MM-dd")
   .build();

包配置(PackageConfig)

方法 说明 示例
parent 父包名 默认值:com.baomidou
moduleName 父包模块名 sys 默认值:无
entity Entity包名 默认值:entity
service Service包名 默认值:service
serviceImpl Service Impl包名 默认值:service.impl
mapper Mapper包名 默认值:mapper
xml Mapper XML包名 默认值:mapper.xml
controller Controller包名 默认值:controller
new PackageConfig.Builder().parent("com.baomidou.mybatisplus.samples.generator").moduleName("sys").build();

模板配置(TemplateConfig)

方法 说明 示例
all 激活所有默认模板
entity 使用默认实体模板 /templates/entity
entity(string) 使用自定义实体模板
service 使用默认配套service模板 /templates/service.java,/templates/serviceImpl.java
service(string,string) 使用自定义service模板
mapper 使用默认mapper模板 /templates/mapper.java
mapper(string) 使用自定义mapper模板
mapperXml 使用默认mapperXml模板 /templates/mapper.xml
mapperXml(string) 使用自定义mapperXml模板
controller 使用默认controller模板 /templates/controller.java
controller(string) 使用自定义controller模板
new TemplateConfig.Builder().all().build();	//激活所有默认模板

策略配置(StrategyConfig)

方法 说明 示例
enableCapitalMode 开启大写命名
enableSkipView 开启跳过视图
disableSqlFilter 禁用sql过滤 语法不能支持使用sql过滤表的话,可以考虑关闭此开关.
likeTable 模糊表匹配(sql过滤)
notLikeTable 模糊表排除(sql过滤)
addFieldPrefix(string...) 增加表字段前缀
addInclude(string...) 增加表匹配(内存过滤)
addExclude(string...) 增加表排除匹配(内存过滤)
addTablePrefix(string...) 增加表前缀
entityBuilder 实体策略配置
controllerBuilder controller策略配置
mapperBuilder mapper策略配置
serviceBuilder service策略配置
Entity策略配置
方法 说明 示例
nameConvert 名称转换实现
superClass 父类
enableSerialVersionUID 开启生成serialVersionUID
enableColumnConstant 开启生成字段常量
enableChainModel 开启链式模型
enableLombok 开启lombok模型
enableRemoveIsPrefix 开启Boolean类型字段移除is前缀
enableTableFieldAnnotationEnable 开启生成实体时生成字段注解
versionColumnName(string) 乐观锁字段名(数据库)
versionPropertyName(string) 乐观锁属性名(实体)
logicDeleteColumnName(string) 逻辑删除字段名(数据库)
logicDeletePropertyName(string) 逻辑删除属性名(实体)
naming 数据库表映射到实体的命名策略 默认:NamingStrategy.no_change
columnNaming 数据库表字段映射到实体的命名策略
addSuperEntityColumns(string...) 添加父类公共字段
addTableFills(IFill...) 添加属性填充字段
enableActiveRecord 开启ActiveRecord模型
idType 全局主键类型
convertFileName 转换文件名称
formatFileName 格式化文件名称
Controller策略配置
方法 说明 示例
superClass 父类
enableHyphenStyle 开启驼峰转连字符
enableRestStyle 开启生成@RestController控制器
convertFileName 转换文件名称
formatFileName 格式化文件名称
Service策略配置
方法 说明 示例
superServiceClass 设置service接口父类
superServiceImplClass 设置service实现类父类
convertServiceFileName 转换service接口文件名称
convertServiceImplFileName 转换service实现类文件名称
formatServiceFileName 格式化service接口文件名称
formatServiceImplFileName 格式化service实现类文件名称
Mapper策略配置
方法 说明 示例
superClass 设置父类
enableBaseResultMap 启用BaseResultMap生成
enableBaseColumnList 启用BaseColumnList
cache 设置缓存实现类
formatMapperFileName 格式化mapper文件名称
formatXmlFileName 格式化xml实现类文件名称
convertMapperFileName 转换mapper类文件名称
convertXmlFileName 转换xml文件名称
new StrategyConfig.Builder()
    .enableSqlFilter(true)// 启用sql过滤
    .capitalMode(true)// 是否大写命名
    .entityBuilder()// 实体配置构建者
        .enableLombok()// 开启lombok模型
        .versionColumnName("version") //乐观锁数据库表字段
        .naming(NamingStrategy.underline_to_camel)// 数据库表映射到实体的命名策略
        .addTableFills(new Column("create_time", FieldFill.INSERT))	//基于数据库字段填充
        .addTableFills(new Property("updateTime", FieldFill.INSERT_UPDATE))	//基于模型属性填充
    .controllerBuilder() //控制器属性配置构建
    	.restStyle(true)
    .build();
Apache License Version 2.0, January 2004 https://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2011-2019 hubin. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

文档 http://baomidou.com/ 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/Wuzhengjie/generator.git
git@gitee.com:Wuzhengjie/generator.git
Wuzhengjie
generator
generator
develop

搜索帮助