MP實戰系列(六)之代碼生成器講解

MP的代碼生成器可謂用"簡潔"二字，來形容。

我我的以爲jeesite的代碼生成器都不必定比它好用。固然也是因爲我我的的習慣。

只需一鍵執行main方法，就能夠生成對應的項目文件，含entity,dao,service,serviceImpl,Controller及其xml文件。

固然這裏我要提一下，自動生成的entity繼承的是一個Model類。

下面先貼一下代碼生成器如何生成代碼的步驟:

1.導入依賴

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>cn.mybatis-plus</groupId>
<artifactId>mybaits-plus-generator</artifactId>
<version>0.0.1-SNAPSHOT</version>
<dependencies>
<!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus</artifactId>
<version>2.1.8</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.velocity/velocity -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity</artifactId>
<version>1.6.4</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.19</version>
</dependency>
<!-- Mysql -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.38</version>
</dependency>

</dependencies>

<build>
<plugins>

<!-- 指定編譯版本 -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>

</plugins>
<finalName>${project.artifactId}</finalName>
</build>

</project>

 

2.建立類

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.baomidou.mybatisplus.enums.FieldFill;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.FileOutConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.TemplateConfig;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import com.baomidou.mybatisplus.generator.config.rules.DbType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

/**
 * Created by ehomeud on 2017/4/26.
 */

public class AutoGeneratorHelper{
       public static void main(String[] args) {
            // 自定義須要填充的字段
            List<TableFill> tableFillList = new ArrayList<>();
            tableFillList.add(new TableFill("ASDD_SS", FieldFill.INSERT_UPDATE));

            // 代碼生成器
            AutoGenerator mpg = new AutoGenerator().setGlobalConfig(
                    // 全局配置
                    new GlobalConfig()
                            .setOutputDir("D://代碼生成器")//輸出目錄
                            .setFileOverride(true)// 是否覆蓋文件
                            .setActiveRecord(true)// 開啓 activeRecord 模式
                            .setEnableCache(false)// XML 二級緩存
                            .setBaseResultMap(true)// XML ResultMap
                            .setBaseColumnList(true)// XML columList
                            .setAuthor("youcong")
                    // 自定義文件命名，注意 %s 會自動填充表實體屬性！
                     
                     .setMapperName("%sDao")
                     .setXmlName("%sDao")
                     .setServiceName("%sService")
                     .setServiceImplName("%sServiceImpl")
                     .setControllerName("%sController")
            ).setDataSource(
                    // 數據源配置
                    new DataSourceConfig()
                            .setDbType(DbType.MYSQL)// 數據庫類型
                            .setTypeConvert(new MySqlTypeConvert() {
                                // 自定義數據庫表字段類型轉換【可選】
                                @Override
                                public DbColumnType processTypeConvert(String fieldType) {
                                    System.out.println("轉換類型：" + fieldType);
                                    // if ( fieldType.toLowerCase().contains( "tinyint" ) ) {
                                    //    return DbColumnType.BOOLEAN;
                                    // }
                                    return super.processTypeConvert(fieldType);
                                }
                            })
                            .setDriverName("com.mysql.jdbc.Driver")
                            .setUsername("root")
                            .setPassword("1234")
                            .setUrl("jdbc:mysql://127.0.0.1:3306/test?characterEncoding=utf8")
            ).setStrategy(
                    // 策略配置
                    new StrategyConfig()
                            // .setCapitalMode(true)// 全局大寫命名
                            // .setDbColumnUnderline(true)//全局下劃線命名
                            .setTablePrefix(new String[]{"sys_", "tb_"})// 此處能夠修改成您的表前綴
                            .setNaming(NamingStrategy.underline_to_camel)// 表名生成策略
                            
                            // .setInclude(new String[] { "user" }) // 須要生成的表
                            // .setExclude(new String[]{"test"}) // 排除生成的表
                            // 自定義實體父類
                            // .setSuperEntityClass("com.baomidou.demo.TestEntity")
                            // 自定義實體，公共字段
                            
                           // .setSuperEntityColumns(new String[]{"id"})
                            .setTableFillList(tableFillList)
                    // 自定義 mapper 父類
                    // .setSuperMapperClass("com.baomidou.demo.TestMapper")
                    // 自定義 service 父類
                   //  .setSuperServiceClass("com.baomidou.demo.TestService")
                    // 自定義 service 實現類父類
                  //    .setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl")
                    // 自定義 controller 父類
                //      .setSuperControllerClass("com.baomidou.demo.TestController")
                    // 【實體】是否生成字段常量（默認 false）
                    // public static final String ID = "test_id";
                    // .setEntityColumnConstant(true)
                    // 【實體】是否爲構建者模型（默認 false）
                    // public User setName(String name) {this.name = name; return this;}
                    // .setEntityBuilderModel(true)
                    // 【實體】是否爲lombok模型（默認 false）<a href="https://projectlombok.org/">document</a>
                    // .setEntityLombokModel(true)
                    // Boolean類型字段是否移除is前綴處理
                    // .setEntityBooleanColumnRemoveIsPrefix(true)
                    // .setRestControllerStyle(true)
                    // .setControllerMappingHyphenStyle(true)
            ).setPackageInfo(
                    // 包配置
                    new PackageConfig()
                    /*        .setModuleName("test")*/
                            .setParent("com.lms")// 自定義包路徑
                            .setController("controller")// 這裏是控制器包名，默認 web
            ).setCfg(
                    // 注入自定義配置，能夠在 VM 中使用 cfg.abc 設置的值
                    new InjectionConfig() {
                        @Override
                        public void initMap() {
                            Map<String, Object> map = new HashMap<>();
                            map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
                            this.setMap(map);
                        }
                    }.setFileOutConfigList(Collections.<FileOutConfig>singletonList(new FileOutConfig("/templates/mapper.xml.vm") {
                        // 自定義輸出文件目錄
                        @Override
                        public String outputFile(TableInfo tableInfo) {
                            return "D://代碼生成器//xml/" + tableInfo.getEntityName() + ".xml";
                        }
                    }))
            ).setTemplate(
                    // 關閉默認 xml 生成，調整生成 至 根目錄
                    new TemplateConfig().setXml(null)
                    // 自定義模板配置，模板能夠參考源碼 /mybatis-plus/src/main/resources/template 使用 copy
                    // 至您項目 src/main/resources/template 目錄下，模板名稱也可自定義以下配置：
                    // .setController("...");
                    // .setEntity("...");
                    // .setMapper("...");
                    // .setXml("...");
                    // .setService("...");
                    // .setServiceImpl("...");
            );

            // 執行生成
            mpg.execute();

            // 打印注入設置，這裏演示模板裏面怎麼獲取注入內容【可無】
            System.err.println(mpg.getCfg().getMap().get("abc"));
        }

}

 

總而言之，一共兩步，導入依賴，建立類，這個類主要是執行main方法，生成一系列代碼。

導入的依賴，簡單的說，一個是java鏈接mysql必須的，另一個是日誌，再另一個是咱們的mybatis plus,還有一個就是咱們的velocity。

volocity模板引擎，同freemarker同樣，均可以作一個模板，像entity,dao,service,serviceImpl及其Controller，就那三板斧，直接可經過模板生成。

生成的代碼幾乎和本身經過手寫基本是同樣的，惟一不同的就是速度。固然還有一個區別就是實體，文章開頭我也強調過，實體繼承一個model類，這個model類我想裏面應該封裝不了很多玩意。