跳至主要內容

项目配置

Mango Crisp大约 6 分钟代码笔记后端JavaSpringBootSpring Taybct开发框架快速开始项目配置

项目配置

Single

单体架构的配置就比较直接，全都放在了run/src/main/resources/目录下了

bootstrap.yml
# 应用版本号
application:
  version: 3.2.0-alpha.1
#服务器配置
server:
  undertow:
    threads:
      # 设置IO线程数, 它主要执行非阻塞的任务,它们会负责多个连接, 默认设置每个CPU核心一个线程
      io: 4
      # 阻塞任务线程池, 当执行类似servlet请求阻塞操作, undertow会从这个线程池中取得线程,它的值设置取决于系统的负载
      worker: 20
    # 以下的配置会影响buffer,这些buffer会用于服务器连接的IO操作,有点类似netty的池化内存管理
    buffer-size: 1024
    # 是否分配的直接内存
    direct-buffers: true
  compression:
    # 是否开启压缩 开了全局就不要开fegin的压缩请求 互斥
    enabled: true
    # 配置支持压缩的 MIME TYPE
    mime-types: text/html,text/xml,text/plain,application/xml,application/json
  port: 9102
  servlet:
    context-path: /
# Spring
spring:
  main:
    #springCloud 的2.1.0以上版本的，将不再默认支持 FeignClient 的name属性 的相同名字。
    #即 ：多个接口上的@FeignClient(“相同服务名”)会报错，overriding is disabled(覆盖 是 禁止的/关闭的)。
    allow-bean-definition-overriding: true
  application:
    # 应用名称
    name: spring-taybct-single
  profiles:
    # 环境配置
    active: dev
    include:
      - datasource
      - es
      - file
      - global-exception
      - taybct
      - mq
      - mybatis
      - prop
      - redis
      - swagger
      - data-scope
      - scheduled-tasks
  servlet:
    multipart:
      max-file-size: 10MB        # 设置单个文件最大大小为10MB
      max-request-size: 100MB    # 设置多个文件大小为100MB
# 日志文件
logging:
  file:
    name: logs/${spring.application.name}/info.log
#  level:
#    io.github.mangocrisp.spring.taybct.auth: DEBUG
#    org.springframework.security: DEBUG
#    org.springframework.jdbc.core: DEBUG

通过bootstrap.yml里面spring.profiles.include来加入其他的相关的配置

spring.profiles.include

加载 bootstrap.yml或者application.yml同级目录下的application-xxx.yml里面的配置,xxx就是配置在spring.profiles.include里面的数组里面的每个值，例如 redis 就是application-redis.yml

application.yml 和 bootstrap.yml的区别

Cloud

微服务的配置，使用的是 Nacos 作为配置中心，所以你需要先将环境准备好

配置本地的bootstrap.yml

本地配置的一般是不会做修改的固定配置

示例 module-system 的 bootstrap.yml
# 服务器配置
server:
  port: 8101
# Spring
spring:
  main:
    #springCloud 的2.1.0以上版本的，将不再默认支持 FeignClient 的name属性 的相同名字。
    #即 ：多个接口上的@FeignClient(“相同服务名”)会报错，overriding is disabled(覆盖 是 禁止的/关闭的)。
    allow-bean-definition-overriding: true
  application:
    # 应用名称
    name: module-system
  profiles:
    active: dev
  cloud:
    # 使用 nacos 注册发现和配置
    nacos:
      username: nacos
      password: nacos
      discovery:
        # 服务注册地址
        server-addr: 127.0.0.1:8848
        # 命名空间
        namespace: taybct-3-2-x
        # 配置分组
        group: ${spring.profiles.active}
      config:
        # 服务注册地址
        server-addr: 127.0.0.1:8848
        # 命名空间
        namespace: taybct-3-2-x
        # 配置分组
        group: ${spring.profiles.active}
        # 配置文件格式
        file-extension: yml
        # 共享配置
        shared-configs:
          - data-id: ${taybct.config-prefix}.${spring.cloud.nacos.config.file-extension}      # 基本配置
            group: ${spring.cloud.nacos.config.group}
            refresh: true
          - data-id: ${taybct.config-prefix}-global-exception.${spring.cloud.nacos.config.file-extension}     # 全局异常配置
            group: ${spring.cloud.nacos.config.group}
            refresh: true
          - data-id: ${taybct.config-prefix}-swagger.${spring.cloud.nacos.config.file-extension}     # swagger 配置
            group: ${spring.cloud.nacos.config.group}
            refresh: true
          - data-id: ${taybct.config-prefix}-redis.${spring.cloud.nacos.config.file-extension}      # redis 缓存
            group: ${spring.cloud.nacos.config.group}
            refresh: true
          - data-id: ${taybct.config-prefix}-datasource.${spring.cloud.nacos.config.file-extension}      # 数据源
            group: ${spring.cloud.nacos.config.group}
            refresh: true
          - data-id: ${taybct.config-prefix}-mybatis.${spring.cloud.nacos.config.file-extension}     # mybatis-plus 配置
            group: ${spring.cloud.nacos.config.group}
            refresh: true
          - data-id: ${taybct.config-prefix}-mq.${spring.cloud.nacos.config.file-extension}     # rabbit mq 配置
            group: ${spring.cloud.nacos.config.group}
            refresh: true
          - data-id: ${taybct.config-prefix}-dubbo.${spring.cloud.nacos.config.file-extension}     # dubbo 配置
            group: ${spring.cloud.nacos.config.group}
            refresh: true
          - data-id: ${taybct.config-prefix}-data-scope.${spring.cloud.nacos.config.file-extension}     # data-scope 配置
            group: ${spring.cloud.nacos.config.group}
            refresh: true
taybct:
  config-prefix: taybct
  tenant:
    tenant-tables:
      - sys_role
      - sys_dept
  rsa:
    # resources 目录下的证书
    resource: rsa.jks
    # 生成证书的时候配置的 alias
    alias: rsa
    # 生成证书的时候配置的 密码
    password: taybct
    type:
      LIMITED:
        resource: limited.jks
        alias: limited
        password: limited
        expire-check: true
  scheduled:
    pool-size: 20
    await-termination-seconds: 60
    thread-name-prefix: "Scheduler-"
    wait-for-tasks-to-complete-on-shutdown: true
    tasks:
      clearDirtyData:
        task-key: clearDirtyData
        cron: 0 0/1 * * * ?
        description: "清理权限脏数据"
        auto-start: 1
        sort: 0
      clearExpires:
        task-key: clearExpires
        cron: 0 0/1 * * * ?
        description: "清理登录超时用户"
        auto-start: 1
        sort: 1
      iniPermissionConfig:
        task-key: iniPermissionConfig
        cron: 0 0/1 * * * ?
        description: "初始化权限配置"
        auto-start: 1
        sort: 2
      iniParams:
        task-key: iniParams
        cron: 0 0/1 * * * ?
        description: "初始化参数配置"
        auto-start: 1
        sort: 0

在配置中心(Nacos)动态配置

这里默认你已经安装好了Nacos

浏览器打开 http://127.0.0.1:8848/nacos，并登录（账号密码是你自己设置的，默认是 nacos/nacos）

1. 新增命名空间

对应版本的命名空间
对应版本的命名空间

2. 导入配置

  1. 找到项目/_ini目录下有Nacos配置文件
  2. 在Nacos配置列表选择对应的命名空间
  3. 点击导入配置按钮，选择上传文件，将Nacos配置文件导入
  4. 导入成功
  5. 之后就可以像配置单体架构一样的配置每个配置文件了

3. 引入配置到项目

在本地的bootstrap.yml里面配置

spring:
  cloud:
    nacos:
      config:
        shared-configs:
          - data-id: 配置列表的 Data id
            group: 配置列表的 Group
            refresh: true # 是否需要动态刷新

Nacos 动态刷新

只需要在需要动态刷新配置的地方添加@RefreshScope，就可以实现动态刷新配置了参考官方文档

Nacos-opensource中@RefreshScope实现配置自动更新的原理可以依据提供的知识进行如下分析：

  1. 初始化与注册监听器： 当Spring Cloud应用启动时，配置了@RefreshScope的Bean（如示例中的ConfigController）会被Spring容器特殊处理。在这个过程中，Nacos Spring Cloud客户端会根据spring.application.name、spring.profiles.active以及配置文件的扩展名（默认是.properties或.yaml）自动生成dataId。之后，它会向Nacos Server发起请求，获取与dataId匹配的配置内容，并注册一个监听器到Nacos Server上，用于监听此dataId的配置变化。

  2. 配置变更检测： 当Nacos Server上的配置发生变化时，它会立即通知所有订阅了该dataId的客户端。Nacos客户端接收到变更通知后，会触发一个刷新事件。

  3. 动态更新配置值： 接收到刷新事件后，Spring Cloud框架会重新加载受影响的Bean（即那些标记了@RefreshScope的Bean）。在这个过程中，之前通过@Value注入的配置值（如useLocalCache）会被重新解析，获取最新的配置内容。因此，当再次调用相关接口（如/config/get）时，返回的就是更新后的配置值。

  4. 实际操作验证： 示例中通过Nacos Open API手动更改example.properties的useLocalCache值，并通过HTTP请求验证配置自动更新的效果。这一步骤直观展示了配置变更后，应用能即时响应并应用新配置的过程。

总结而言，@RefreshScope通过在Spring Cloud应用启动时注册配置监听器至Nacos Server，并在配置变更时重新初始化受影响的Bean，从而实现了配置的自动更新。这一机制确保了微服务应用能够在不重启的情况下，实时响应外部配置的变化。

Mango Crisp 的小破站
Copyright © 2024 Mango Crisp Apache 2.0 Licensed