Java開發學習(五十)----MyBatisPlus快速開發之程式碼生成器解析

2023-01-06 06:00:34

1、程式碼生成器原理分析

造句:

我們可以往空白內容進行填詞造句,比如:

在比如:

觀察我們之前寫的程式碼,會發現其中也會有很多重複內容,比如:

那我們就想,如果我想做一個Book模組的開發,是不是隻需要將紅色部分的內容全部更換成Book即可,如:

所以我們會發現,做任何模組的開發,對於這段程式碼,基本上都是對紅色部分的調整,所以我們把去掉紅色內容的東西稱之為模板,紅色部分稱之為引數,以後只需要傳入不同的引數,就可以根據模板建立出不同模組的dao程式碼。

除了Dao可以抽取模組,其實我們常見的類都可以進行抽取,只要他們有公共部分即可。再來看下模型類的模板:

  • ① 可以根據資料庫表的表名來填充

  • ② 可以根據使用者的設定來生成ID生成策略

  • ③到⑨可以根據資料庫表欄位名稱來填充

所以只要我們知道是對哪張表進行程式碼生成,這些內容我們都可以進行填充。

分析完後,我們會發現,要想完成程式碼自動生成,我們需要有以下內容:

  • 模板: MyBatisPlus已經提供了模板,也可以自己提供模板,但是麻煩,不建議

  • 資料庫相關設定:讀取資料庫獲取表和欄位資訊

  • 開發者自定義設定:手工設定,比如ID生成策略

2、程式碼生成器實現

步驟1:建立一個Maven專案

程式碼2:匯入對應的jar包

<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.1</version>
    </parent>
    <groupId>com.itheima</groupId>
    <artifactId>mybatisplus_04_generator</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <!--spring webmvc-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
​
        <!--mybatisplus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.1</version>
        </dependency>
​
        <!--druid-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.16</version>
        </dependency>
​
        <!--mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
​
        <!--test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
​
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
        </dependency>
​
        <!--程式碼生成器-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.1</version>
        </dependency>
​
        <!--velocity模板引擎-->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.3</version>
        </dependency>
​
    </dependencies>
​
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
​
</project>
​

步驟3:編寫引導類

@SpringBootApplication
public class Mybatisplus04GeneratorApplication {
​
    public static void main(String[] args) {
        SpringApplication.run(Mybatisplus04GeneratorApplication.class, args);
    }
​
}

步驟4:建立程式碼生成類

public class CodeGenerator {
    public static void main(String[] args) {
        //1.獲取程式碼生成器的物件
        AutoGenerator autoGenerator = new AutoGenerator();
​
        //設定資料庫相關設定
        DataSourceConfig dataSource = new DataSourceConfig();
        dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/mybatisplus_db?serverTimezone=UTC");
        dataSource.setUsername("root");
        dataSource.setPassword("root");
        autoGenerator.setDataSource(dataSource);
​
        //設定全域性設定
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setOutputDir(System.getProperty("user.dir")+"/mybatisplus_04_generator/src/main/java");    //設定程式碼生成位置
        globalConfig.setOpen(false);    //設定生成完畢後是否開啟生成程式碼所在的目錄
        globalConfig.setAuthor("黑馬程式設計師");    //設定作者
        globalConfig.setFileOverride(true);     //設定是否覆蓋原始生成的檔案
        globalConfig.setMapperName("%sDao");    //設定資料層介面名,%s為預留位置,指代模組名稱
        globalConfig.setIdType(IdType.ASSIGN_ID);   //設定Id生成策略
        autoGenerator.setGlobalConfig(globalConfig);
​
        //設定包名相關設定
        PackageConfig packageInfo = new PackageConfig();
        packageInfo.setParent("com.aaa");   //設定生成的包名,與程式碼所在位置不衝突,二者疊加組成完整路徑
        packageInfo.setEntity("domain");    //設定實體類包名
        packageInfo.setMapper("dao");   //設定資料層包名
        autoGenerator.setPackageInfo(packageInfo);
​
        //策略設定
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig.setInclude("tbl_user");  //設定當前參與生成的表名,引數為可變引數
        strategyConfig.setTablePrefix("tbl_");  //設定資料庫表的字首名稱,模組名 = 資料庫表名 - 字首名  例如: User = tbl_user - tbl_
        strategyConfig.setRestControllerStyle(true);    //設定是否啟用Rest風格
        strategyConfig.setVersionFieldName("version");  //設定樂觀鎖欄位名
        strategyConfig.setLogicDeleteFieldName("deleted");  //設定邏輯刪除欄位名
        strategyConfig.setEntityLombokModel(true);  //設定是否啟用lombok
        autoGenerator.setStrategy(strategyConfig);
        //2.執行生成操作
        autoGenerator.execute();
    }
}

對於程式碼生成器中的程式碼內容,我們可以直接從官方檔案中獲取程式碼進行修改,https://baomidou.com/pages/d357af/

步驟5:執行程式

執行成功後,會在當前專案中生成很多程式碼,程式碼包含controller,servicemapperentity

至此程式碼生成器就已經完成工作,我們能快速根據資料庫表來建立對應的類,簡化我們的程式碼開發。

3、Mybatisplus中Service的CRUD

回顧我們之前業務層程式碼的編寫,編寫介面和對應的實現類:

public interface UserService{
    
}
​
@Service
public class UserServiceImpl implements UserService{
​
}

介面和實現類有了以後,需要在介面和實現類中宣告方法

public interface UserService{
    public List<User> findAll();
}
​
@Service
public class UserServiceImpl implements UserService{
    @Autowired
    private UserDao userDao;
    
    public List<User> findAll(){
        return userDao.selectList(null);
    }
}

Mybatisplus看到上面的程式碼以後就說這些方法也是比較固定和通用的,那來幫你抽取下,所以Mybatisplus提供了一個Service介面和實現類,分別是:IServiceServiceImpl,後者是對前者的一個具體實現。

以後我們自己寫的Service就可以進行如下修改:

public interface UserService extends IService<User>{
    
}
​
@Service
public class UserServiceImpl extends ServiceImpl<UserDao, User> implements UserService{
​
}

修改以後的好處是,Mybatisplus已經幫我們把業務層的一些基礎的增刪改查都已經實現了,可以直接進行使用。

編寫測試類進行測試:

@SpringBootTest
class Mybatisplus04GeneratorApplicationTests {
​
    private IUserService userService;
​
    @Test
    void testFindAll() {
        List<User> list = userService.list();
        System.out.println(list);
    }
​
}

思考:在Mybatisplus封裝的Service層都有哪些方法可以用?

https://baomidou.com/pages/49cc81/