发版配置及脚本示例

SQL脚本

  • 放置目录:src/main/resources/meta/sql

  • 命名规范:V<YYYYMMDD><NN>__<DESC>.sql -> V<日期><序号>__<描述>.sql -> V2021010101__init.sql

    • V : 固定大写值
    • YYYYMMDD : 取当前时间年月日
    • NN :根据目前已知的提交文件编序号从 01 开始, 01,02,03…
    • DESC : 当前SQL文件变更摘要说明(英文单词或缩写),便于查看定位
  • 注意1:版本和描述之间是两个下划线分隔

  • 注意2:SQL语句是以分号结束,表的描述和字段描述不要出现半角分号;,SQL语句结束须加上

  • 注意3:pai版本2.1.0.0-SNAPSHOT起,支持根据数据库类型放置脚本。如:达梦,src/main/resources/meta/dameng,并在该目录基础上支持多级目录归类脚本,如:<年/脚本>或<年/月/脚本>

  • 目的:

    • 维持工程的完整性
    • 便于部署。部署正式环境,工程服务启动时会自动扫描该目录并根据版本顺序执行脚本
  • 可执行性:执行时不能报错,必须可重复执行。若因脚本执行失败,工程服务不会启动

      create table if not exists <table_name>....

    具体查找SQL官方资料

nacos配置

  • 放置目录:src/main/resources/meta/nacos.yml
  • 目的:
    • 维持工程的完整性
    • 便于部署。部署正式环境,工程服务启动时会取该文件并替换数据库连接等配置(前置:此文件有对应配置)
  • 注意1:配置参数需能即时生效(使用@ConfigurationProperties@RefreshScope注解或其他监听)
  • 注意2:开发时修改配置参数还是在开发者后台-开发中心-我的工程-Nacos
  • 注意3:对于使用@Value读取的参数,置空时要注意设置默认值(用引号或在注解时加冒号),避免未配置报错启动不了,同时要在类上注解@RefreshScope中实现即时刷新配置, 如:pai.demo.key: ''@Value("${pai.demo.key:}")

服务启动自动执行SQL脚本及发布NACOS说明

  • 一般在边端安装时增加环境变量paideploy.enabled启用
  • 某些情况下不需要自动发布nacos配置,增加环境变量paideploy.pushNacosConfig=flase即可
文档更新时间: 2023-11-02 16:39   作者:管理员