SpringCloud集成MybatisPlus實(shí)現(xiàn)MySQL多數(shù)據(jù)源配置方法

更新時(shí)間：2024年10月26日 12:17:11 作者：不惑_

本文詳細(xì)介紹了SpringCloud集成MybatisPlus實(shí)現(xiàn)MySQL多數(shù)據(jù)源配置的方法,包括在application.properties中配置多數(shù)據(jù)源,配置MybatisPlus,創(chuàng)建Mapper接口和使用多數(shù)據(jù)源等步驟,此外,還解釋了每一個(gè)配置項(xiàng)目的含義,以便讀者更好地理解和應(yīng)用

引入依賴

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.0</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.15</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

配置多數(shù)據(jù)源

在application.properties中配置多數(shù)據(jù)源：

spring.datasource.master.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.master.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=UTC
spring.datasource.master.username=root
spring.datasource.master.password=root
spring.datasource.slave.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.slave.url=jdbc:mysql://localhost:3306/test1?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=UTC
spring.datasource.slave.username=root
spring.datasource.slave.password=root
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.pool.init-size=10
spring.datasource.pool.max-size=20
spring.datasource.pool.min-size=5
spring.datasource.pool.max-wait=30000
spring.datasource.filters=stat,wall,log4j
spring.datasource.log-enabled=true
spring.datasource.log-prefix=druid.log
spring.datasource.stat-view-servlet.enabled=true
spring.datasource.stat-view-servlet.url-pattern=/druid/*
spring.datasource.web-stat-filter.enabled=true
spring.datasource.web-stat-filter.exclusions=*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*
spring.datasource.max-total=20
spring.datasource.max-idle=10
spring.datasource.min-idle=5
spring.datasource.time-between-eviction-runs-millis=60000
spring.datasource.min-evictable-idle-time-millis=300000
spring.datasource.validation-query=SELECT 1 FROM dual
spring.datasource.test-on-borrow=true
spring.datasource.test-on-return=true
spring.datasource.test-while-idle=true
spring.datasource.remove-abandoned=true
spring.datasource.remove-abandoned-timeout=60000
spring.datasource.log-abandoned=true

配置解釋

這是一個(gè)Spring Boot應(yīng)用程序中用于配置數(shù)據(jù)庫連接的屬性文件。以下是每個(gè)配置項(xiàng)目的解釋：

spring.datasource.master.driver-class-name: 指定主數(shù)據(jù)庫的JDBC驅(qū)動(dòng)程序類名，這里是MySQL數(shù)據(jù)庫的驅(qū)動(dòng)類。
spring.datasource.master.url: 主數(shù)據(jù)庫的JDBC URL，指定了數(shù)據(jù)庫的位置和連接參數(shù)，包括字符編碼、時(shí)區(qū)等。
spring.datasource.master.username: 主數(shù)據(jù)庫的用戶名。
spring.datasource.master.password: 主數(shù)據(jù)庫的密碼。
spring.datasource.slave.driver-class-name: 指定從數(shù)據(jù)庫（副本）的JDBC驅(qū)動(dòng)程序類名，同樣是MySQL數(shù)據(jù)庫的驅(qū)動(dòng)類。
spring.datasource.slave.url: 從數(shù)據(jù)庫的JDBC URL，與主數(shù)據(jù)庫不同的地方可能包括不同的數(shù)據(jù)庫名稱或連接參數(shù)。
spring.datasource.slave.username: 從數(shù)據(jù)庫的用戶名。
spring.datasource.slave.password: 從數(shù)據(jù)庫的密碼。
spring.datasource.type: 數(shù)據(jù)源類型，這里使用了阿里巴巴的Druid數(shù)據(jù)源。
spring.datasource.pool.init-size: 數(shù)據(jù)源的初始連接池大小，表示在啟動(dòng)時(shí)會(huì)創(chuàng)建的數(shù)據(jù)庫連接數(shù)。
spring.datasource.pool.max-size: 數(shù)據(jù)源的最大連接池大小，表示連接池中允許存在的最大連接數(shù)。
spring.datasource.pool.min-size: 數(shù)據(jù)源的最小連接池大小，表示連接池中允許存在的最小連接數(shù)。
spring.datasource.pool.max-wait: 獲取連接時(shí)的最大等待時(shí)間（毫秒），如果連接池中的連接都被占用，且達(dá)到最大連接數(shù)，新請求會(huì)等待一段時(shí)間。
spring.datasource.filters: 數(shù)據(jù)源的過濾器，可以用于監(jiān)控、安全等目的。這里包括了統(tǒng)計(jì)（stat）、SQL防火墻（wall）和日志（log4j）。
spring.datasource.log-enabled: 是否啟用Druid的連接池日志。
spring.datasource.log-prefix: 連接池日志的前綴。
spring.datasource.stat-view-servlet.enabled: 是否啟用Druid的統(tǒng)計(jì)數(shù)據(jù)查看servlet。
spring.datasource.stat-view-servlet.url-pattern: 統(tǒng)計(jì)數(shù)據(jù)查看servlet的URL路徑。
spring.datasource.web-stat-filter.enabled: 是否啟用Druid的Web統(tǒng)計(jì)過濾器。
spring.datasource.web-stat-filter.exclusions: 需要排除統(tǒng)計(jì)的資源路徑，如JavaScript、圖片等。
spring.datasource.max-total: 最大活動(dòng)連接數(shù)，與spring.datasource.pool.max-size相同。
spring.datasource.max-idle: 最大空閑連接數(shù)。
spring.datasource.min-idle: 最小空閑連接數(shù)。
spring.datasource.time-between-eviction-runs-millis: 連接池定期檢查空閑連接的時(shí)間間隔。
spring.datasource.min-evictable-idle-time-millis: 連接池中連接的最小空閑時(shí)間，超過此時(shí)間的連接將被回收。
spring.datasource.validation-query: 用于驗(yàn)證連接是否有效的SQL查詢。
spring.datasource.test-on-borrow: 是否在借用連接時(shí)測試連接的有效性。
spring.datasource.test-on-return: 是否在歸還連接時(shí)測試連接的有效性。
spring.datasource.test-while-idle: 是否在連接空閑時(shí)測試連接的有效性。
spring.datasource.remove-abandoned: 是否移除長時(shí)間未使用的連接。
spring.datasource.remove-abandoned-timeout: 設(shè)置長時(shí)間未使用連接的超時(shí)時(shí)間。
spring.datasource.log-abandoned: 是否記錄移除連接的日志。
這些配置項(xiàng)用于定義應(yīng)用程序與數(shù)據(jù)庫之間的連接池、數(shù)據(jù)庫連接屬性和連接池監(jiān)控等相關(guān)設(shè)置。不同的配置項(xiàng)可以根據(jù)應(yīng)用程序的需求進(jìn)行調(diào)整。

配置MybatisPlus

在application.properties中配置MybatisPlus：

mybatis-plus.mapper-locations=classpath:mapper/*.xml
mybatis-plus.global-config.id-type=auto
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
mybatis-plus.global-config.base-namespace=test
mybatis-plus.global-config.mapper-namespace=test.mapper

配置MybatisPlus解釋

這是一個(gè)MyBatis Plus（通常簡稱為MyBatis+或MP）的配置文件，用于配置MyBatis Plus在Spring Boot應(yīng)用程序中的行為。以下是每個(gè)配置項(xiàng)目的解釋：

mybatis-plus.mapper-locations=classpath:mapper/*.xml: 這個(gè)配置項(xiàng)指定了MyBatis Plus的Mapper XML文件的位置。在這個(gè)例子中，它告訴MyBatis Plus在類路徑下的"mapper"目錄中查找所有以".xml"結(jié)尾的文件，以作為Mapper定義文件。
mybatis-plus.global-config.id-type=auto: 這個(gè)配置項(xiàng)指定了主鍵ID的生成策略。在這里，設(shè)置為"auto"表示使用數(shù)據(jù)庫自動(dòng)生成的主鍵值，這通常是由數(shù)據(jù)庫管理的自增長或唯一標(biāo)識符。
mybatis-plus.global-config.db-config.logic-delete-value=1: 這個(gè)配置項(xiàng)指定了邏輯刪除的值。在MyBatis Plus中，邏輯刪除是一種通過標(biāo)記記錄來表示刪除狀態(tài)的方式，這里設(shè)置為"1"表示已刪除。
mybatis-plus.global-config.db-config.logic-not-delete-value=0: 這個(gè)配置項(xiàng)指定了邏輯未刪除的值。在MyBatis Plus中，這是指記錄未被刪除的狀態(tài)，這里設(shè)置為"0"表示未刪除。
mybatis-plus.global-config.base-namespace=test: 這個(gè)配置項(xiàng)指定了基礎(chǔ)的Mapper命名空間。這個(gè)命名空間將會(huì)被用于生成Mapper接口的全限定名，通常與包名相關(guān)聯(lián)。
mybatis-plus.global-config.mapper-namespace=test.mapper: 這個(gè)配置項(xiàng)指定了Mapper接口的命名空間。在MyBatis Plus中，Mapper接口與XML文件相關(guān)聯(lián)，這個(gè)配置項(xiàng)將會(huì)在生成的Mapper接口中設(shè)置XML文件的命名空間。
這些配置項(xiàng)用于自定義MyBatis Plus的行為，包括主鍵生成策略、邏輯刪除的值、Mapper接口命名空間等。它們允許根據(jù)應(yīng)用程序的需求來配置和控制MyBatis Plus的行為。

配置Mapper

創(chuàng)建一個(gè)Mapper接口，例如UserMapper：

@Mapper
public interface UserMapper extends BaseMapper<User> {
}

使用多數(shù)據(jù)源

在需要使用多數(shù)據(jù)源的地方，使用@MapperScan注解指定Mapper所在包路徑：

@SpringBootApplication
@EnableDiscoveryClient
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
    @MapperScan("com.example.demo.mapper")
    public class MyApp {
        // ...
    }
}

CRUD示例

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapper userMapper;
    @Override
    public User save(User user) {
        return userMapper.save(user);
    }
    @Override
    public User update(User user) {
        return userMapper.updateById(user);
    }
    @Override
    public User findById(Long id) {
        return userMapper.selectById(id);
    }
    @Override
    public void delete(Long id) {
        userMapper.deleteById(id);
    }
}

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;
    @PostMapping
    public User save(@RequestBody User user) {
        return userService.save(user);
    }
    @PutMapping("/{id}")
    public User update(@PathVariable Long id, @RequestBody User user) {
        user.setId(id);
        return userService.update(user);
    }
    @GetMapping("/{id}")
    public User findById(@PathVariable Long id) {
        return userService.findById(id);
    }
    @DeleteMapping("/{id}")
    public void delete(@PathVariable Long id) {
        userService.delete(id);
    }
}

使用不同數(shù)據(jù)源

要使用不同的數(shù)據(jù)源查詢，可以在Mapper接口中使用@MapperScan注解指定需要使用的數(shù)據(jù)源，例如：

@MapperScan("com.example.demo.mapper.master")
public interface UserMapperMaster extends BaseMapper<User> {
}
@MapperScan("com.example.demo.mapper.slave")
public interface UserMapperSlave extends BaseMapper<User> {
}

然后在需要使用不同數(shù)據(jù)源的地方，使用@Autowired注解注入對應(yīng)的Mapper接口，例如：

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapperMaster userMapperMaster;
    @Autowired
    private UserMapperSlave userMapperSlave;
    @Override
    public User save(User user) {
        return userMapperMaster.save(user);
    }
    @Override
    public User update(User user) {
        return userMapperMaster.updateById(user);
    }
    @Override
    public User findById(Long id) {
        return userMapperMaster.selectById(id);
    }
    @Override
    public void delete(Long id) {
        userMapperMaster.deleteById(id);
    }
}

要在某個(gè)方法上使用不同的數(shù)據(jù)源，可以在該方法上使用@MapperScan注解指定需要使用的數(shù)據(jù)源，例如：

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapperMaster userMapperMaster;
    @Autowired
    private UserMapperSlave userMapperSlave;
    @Override
    public User save(User user) {
        return userMapperMaster.save(user);
    }
    @Override
    public User update(User user) {
        return userMapperMaster.updateById(user);
    }
    @Override
    public User findById(Long id) {
        return userMapperMaster.selectById(id);
    }
    @Override
    public void delete(Long id) {
        userMapperMaster.deleteById(id);
    }
    @MapperScan("com.example.demo.mapper.slave")
    @Override
    public User findByIdSlave(Long id) {
        return userMapperSlave.selectById(id);
    }
}

到此這篇關(guān)于SpringCloud集成MybatisPlus實(shí)現(xiàn)MySQL多數(shù)據(jù)源配置的文章就介紹到這了,更多相關(guān)SpringCloud MybatisPlus MySQL多數(shù)據(jù)源內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: