欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

SpringBoot使用MyBatis Generator生成動態(tài)SQL的詳細步驟

 更新時間：2025年06月20日 10:30:10   作者：惜鳥  
這篇文章主要介紹了SpringBoot使用MyBatis Generator生成動態(tài)SQL的詳細步驟,我們將在Spring Boot項目中集成MyBatis Generator,并配置其生成MyBatis Dynamic SQL風格的代碼,需要的朋友可以參考下

概述

我們將在Spring Boot項目中集成MyBatis Generator，并配置其生成MyBatis Dynamic SQL風格的代碼。 MyBatis Dynamic SQL是MyBatis 3的一個特性，它允許使用Java API構建動態(tài)SQL查詢，避免編寫XML或使用Example類。

MyBatis Dynamic SQL 核心優(yōu)勢

  • 類型安全：所有列引用都是類型安全的
  • 流暢的API：鏈式調用構建查詢
  • 動態(tài)SQL：自然處理條件邏輯
  • 無XML：避免XML配置的繁瑣
  • IDE支持：自動補全和類型檢查

步驟概述：

  • 創(chuàng)建Spring Boot項目，添加必要的依賴（包括MyBatis Spring Boot Starter、數(shù)據(jù)庫驅動、MyBatis Generator等）。
  • 配置MyBatis Generator（通過Maven插件方式）。
  • 編寫generatorConfig.xml配置文件，指定生成Dynamic SQL風格的代碼。
  • 運行MyBatis Generator生成代碼。
  • 在Spring Boot中配置MyBatis，使用生成的Mapper。

詳細步驟

一、創(chuàng)建Spring Boot項目并添加依賴

使用Spring Initializr創(chuàng)建一個新項目，選擇以下依賴：

  • Spring Web (如果構建Web應用)
  • MyBatis Framework
  • MySQL Driver (以MySQL為例，或者根據(jù)你的數(shù)據(jù)庫選擇)

然后在pom.xml中添加MyBatis Generator Maven插件以及MyBatis Dynamic SQL依賴：

<dependencies>
    <!-- Spring Boot Starter -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- MyBatis Spring Boot Starter -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>3.0.3</version>
    </dependency>
    <!-- MySQL 驅動 -->
    <dependency>
        <groupId>com.mysql</groupId>
        <artifactId>mysql-connector-j</artifactId>
        <scope>runtime</scope>
    </dependency>
    <!-- Lombok -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <!-- MyBatis Dynamic SQL -->
    <dependency>
        <groupId>org.mybatis.dynamic-sql</groupId>
        <artifactId>mybatis-dynamic-sql</artifactId>
        <version>1.5.0</version>
    </dependency>
</dependencies>

<build>
    <plugins>
        <!-- MyBatis Generator 插件 -->
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.4.2</version>
            <dependencies>
                <dependency>
                    <groupId>com.mysql</groupId>
                    <artifactId>mysql-connector-j</artifactId>
                    <version>8.0.33</version>
                </dependency>
                <!-- 支持生成 Dynamic SQL -->
                <dependency>
                    <groupId>org.mybatis.dynamic-sql</groupId>
                    <artifactId>mybatis-dynamic-sql</artifactId>
                    <version>1.5.0</version>
                </dependency>
            </dependencies>
            <configuration>
                <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                <overwrite>true</overwrite>
                <verbose>true</verbose>
            </configuration>
        </plugin>
    </plugins>
</build>

二、編寫generatorConfig.xml配置文件

在src/main/resources目錄下創(chuàng)建generatorConfig.xml文件。我們需要配置生成Dynamic SQL風格的代碼，這通過設置targetRuntime="MyBatis3DynamicSql"來實現(xiàn)。

示例配置：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "https://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
    <!-- 引入 application.properties 中的配置(可選) -->
    <properties resource="application.properties"/>

    <!-- 數(shù)據(jù)庫驅動路徑（如果未通過Maven依賴管理） -->
    <!-- <classPathEntry location="/path/to/mysql-connector-java-8.0.33.jar"/> -->

    <context id="mysql" targetRuntime="MyBatis3DynamicSql">
        <!-- 生成的Java文件編碼 -->
        <property name="javaFileEncoding" value="UTF-8"/>

        <!-- 生成的Java文件的注釋 -->
        <commentGenerator>
            <!-- 注釋配置：不生成注釋 -->
            <property name="suppressAllComments" value="true"/>
            <!-- 生成注釋 -->
            <!--            <property name="addRemarkComments" value="true"/>-->
        </commentGenerator>
        <!-- 數(shù)據(jù)庫連接信息 -->
        <jdbcConnection driverClass="${spring.datasource.driver-class-name}"
                        connectionURL="${spring.datasource.url}"
                        userId="${spring.datasource.username}"
                        password="${spring.datasource.password}">
        </jdbcConnection>
        <!-- Java模型生成配置 -->
        <javaModelGenerator targetPackage="com.example.demo.model.entity" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- 注意：如果使用Dynamic SQL方式，不需要XML映射文件 -->
        <!-- 生成 SQL Map XML 文件的配置 -->
        <!--        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">-->
        <!--            <property name="enableSubPackages" value="true" />-->
        <!--        </sqlMapGenerator>-->
        <!-- Mapper接口生成配置 -->
        <javaClientGenerator type="ANNOTATEDMAPPER"
                             targetPackage="com.example.demo.repository.generated"
                             targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <!-- 指定要生成的表 -->
        <table tableName="user" domainObjectName="User">
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>
        <table tableName="rule" domainObjectName="RuleEntity" mapperName="RuleMapper">
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>

        <table tableName="rule_version" domainObjectName="RuleVersionEntity" mapperName="RuleVersionMapper">
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>
        <!-- 生成所有表 -->
        <!--         <table tableName="%" />-->
    </context>
</generatorConfiguration>

注意：

  • 我們使用了targetRuntime="MyBatis3DynamicSql"，這會生成Dynamic SQL風格的代碼。
  • 不需要配置sqlMapGenerator，因為Dynamic SQL不生成XML映射文件。
  • javaClientGenerator的type設置為ANNOTATEDMAPPER，表示使用注解方式（實際上Dynamic SQL的Mapper接口是通過Java API構建的，由Dynamic SQL的運行時庫提供支持）。
  • 在jdbcConnection中，我們使用了Spring Boot的application.properties中的數(shù)據(jù)庫配置（通過${}占位符引用）。需要在generatorConfig.xml文件中配置 <properties resource="application.properties"/>，并且確保application.properties中有這些屬性。

三、配置application.properties

在src/main/resources/application.properties中配置數(shù)據(jù)源：

spring.application.name=demo
server.port=8088
# 數(shù)據(jù)源配置
spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase
spring.datasource.username=root
spring.datasource.password=mysecretpassword
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

四、運行MyBatis Generator生成代碼

在項目根目錄下運行命令：

mvn mybatis-generator:generate

或者在IDE中運行Maven插件的mybatis-generator:generate目標。

生成的文件將包括：

  • 實體類（POJO）：在com.example.demo.model.entity包下。
  • Mapper接口：在com.example.demo.repository.generated包下。注意，生成的Mapper接口會繼承MyBatis Dynamic SQL提供的MyBatis3Mapper接口（比如CommonCountMapper, CommonDeleteMapper, CommonUpdateMapper），這些接口提供了一些基本的CRUD方法。

五、在Spring Boot中使用生成的Mapper

  • 在目錄 com.example.demo.config 創(chuàng)建 MyBatisConfig.java 配置類：
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

@Configuration
@MapperScan("com.example.demo.repository")
public class MyBatisConfig {
    @Bean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(dataSource);
        sessionFactory.setTypeAliasesPackage("com.example.demo.model.entity");

        return sessionFactory.getObject();
    }

}

在Spring Boot項目中，使用@MapperScan注解可以方便地掃描并注冊MyBatis的Mapper接口。這樣，我們就不需要在每個Mapper接口上都添加@Mapper注解。

注意事項：

  • @MapperScan與@Mapper：如果使用了@MapperScan，則不需要在每個Mapper接口上再寫@Mapper。但是，如果有些Mapper接口不在掃描路徑下，那么仍然需要在該接口上使用@Mapper。
  • 包路徑：確保@MapperScan指定的包路徑正確，否則Spring容器無法創(chuàng)建Mapper的Bean，導致注入失敗。
  • 多模塊項目：如果項目有多個模塊，并且Mapper接口分布在不同的模塊中，確保這些模塊的包路徑都被掃描到。

在Service中注入Mapper并使用：

@Service
@RequiredArgsConstructor
public class UserService {
    
    private final UserMapper userMapper;
    
    // 創(chuàng)建用戶
    public int createUser(User user) {
        return userMapper.insert(user);
    }
    
    // 根據(jù)ID獲取用戶
    public Optional<User> getUserById(Long id) {
        return userMapper.selectByPrimaryKey(id);
    }
    
    // 更新用戶
    public int updateUser(User user) {
        return userMapper.updateByPrimaryKeySelective(user);
    }
    
    // 刪除用戶
    public int deleteUser(Long id) {
        return userMapper.deleteByPrimaryKey(id);
    }
    
    // 動態(tài)查詢用戶
    public List<User> findUsers(String username, Integer minAge, Integer maxAge) {
        return userMapper.select(c -> c
            .where(UserDynamicSqlSupport.username, isLikeIfPresent(username).map(s -> s + "%")
            .and(UserDynamicSqlSupport.age, isBetweenWhenPresent(minAge, maxAge))
            .orderBy(UserDynamicSqlSupport.createTime.descending())
            .build()
            .execute());
    }
    
    // 輔助方法：條件存在時使用 LIKE
    private Optional<Condition> isLikeIfPresent(String value) {
        return Optional.ofNullable(value)
            .filter(v -> !v.isEmpty())
            .map(v -> UserDynamicSqlSupport.username.like(v));
    }
    
    // 輔助方法：條件存在時使用 BETWEEN
    private Optional<BetweenCondition> isBetweenWhenPresent(Integer min, Integer max) {
        if (min != null && max != null) {
            return Optional.of(UserDynamicSqlSupport.age.between(min, max));
        }
        return Optional.empty();
    }
}

注意：上面的user是一個自動生成的表對應的對象（在UserMapper中有一個靜態(tài)字段user，用于構建查詢）。實際使用時，需要導入生成的Mapper和表對象。

例如，在UserService中導入：

import static com.example.demo.mapper.UserDynamicSqlSupport.*;

import static org.mybatis.dynamic.sql.SqlBuilder.*;
  • 在controller中注入service并使用
@RestController
@RequestMapping("/api/users")
@RequiredArgsConstructor
public class UserController {
    
    private final UserService userService;
    
    @PostMapping
    public ResponseEntity<?> createUser(@RequestBody User user) {
        int result = userService.createUser(user);
        return result > 0 
            ? ResponseEntity.ok("User created")
            : ResponseEntity.badRequest().body("Create failed");
    }
    
    @GetMapping("/{id}")
    public ResponseEntity<User> getUser(@PathVariable Long id) {
        return userService.getUserById(id)
            .map(ResponseEntity::ok)
            .orElse(ResponseEntity.notFound().build());
    }
    
    @PutMapping("/{id}")
    public ResponseEntity<?> updateUser(@PathVariable Long id, @RequestBody User user) {
        user.setId(id);
        int result = userService.updateUser(user);
        return result > 0 
            ? ResponseEntity.ok("User updated")
            : ResponseEntity.badRequest().body("Update failed");
    }
    
    @DeleteMapping("/{id}")
    public ResponseEntity<?> deleteUser(@PathVariable Long id) {
        int result = userService.deleteUser(id);
        return result > 0 
            ? ResponseEntity.ok("User deleted")
            : ResponseEntity.badRequest().body("Delete failed");
    }
    
    @GetMapping("/search")
    public List<User> searchUsers(
            @RequestParam(required = false) String username,
            @RequestParam(required = false) Integer minAge,
            @RequestParam(required = false) Integer maxAge) {
        
        return userService.findUsers(username, minAge, maxAge);
    }
}

六、MyBatis Dynamic SQL 生成代碼的特點

生成的Mapper接口包含的方法：

  • insert：插入記錄
  • insertMultiple：批量插入
  • insertSelective：選擇性插入（忽略null）
  • selectByPrimaryKey：根據(jù)主鍵查詢
  • select：根據(jù)條件查詢（可返回多條）
  • selectOne：根據(jù)條件查詢一條
  • update：更新
  • delete：刪除

同時會生成一個與表同名的輔助類（如UserDynamicSqlSupport），其中包含表的列定義，用于構建動態(tài)SQL。

不需要XML映射文件，所有SQL通過Java API動態(tài)構建。

七、注意事項

  • 確保數(shù)據(jù)庫表有主鍵，否則生成代碼時可能會出現(xiàn)問題。
  • 如果表名或列名是SQL關鍵字，需要在配置中使用<columnOverride>或<table>的delimitIdentifiers屬性處理。
  • 生成的代碼可能會覆蓋已有的文件，注意備份自定義代碼（通常不要修改生成的代碼，而是通過擴展方式）。

八、總結

本方案在 Spring Boot 中集成了 MyBatis Generator，并配置生成 MyBatis Dynamic SQL 風格的代碼，具有以下特點：

  • 代碼簡潔：使用 Lombok 減少樣板代碼
  • 類型安全：Dynamic SQL 提供編譯時檢查
  • 易于維護：無需 XML 配置
  • 動態(tài)查詢：靈活構建復雜查詢
  • 高效開發(fā)：自動生成基礎 CRUD 代碼

通過這種方式，你可以專注于業(yè)務邏輯開發(fā)，而無需手動編寫重復的數(shù)據(jù)訪問層代碼。

以上就是SpringBoot使用MyBatis Generator生成動態(tài)SQL的詳細步驟的詳細內容，更多關于SpringBoot生成動態(tài)SQL的資料請關注腳本之家其它相關文章！

相關文章

最新評論