服务配置手册

所有服务的可配置选项

全局配置

可以放到common.yaml中设置,每个服务都一样

spring:
  #上传文件大小配置
  servlet:
    multipart:
      max-file-size: xxMB
      max-qequest-size: xxMB
  # 数据库配置
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: xxxx
  # 消息队列配置
  rabbitmq:
    host: x.x.x.x
    port: 5672
    username: admin
    password: xxxx
  # redis配置
  redis:
    host: x.x.x.x
    port: 6379
# 授权服务信息
hvisions:
  license:
    local:
      # local-license服务对前端暴露的端口
      httpUrl: http://127.0.0.1:8080
      # 授权服务地址
      server: https://x.x.x.x:9835  

通用配置

每个服务都有如下的相关配置,每个服务可以独立配置

h-visions:
  #日志配置
  log:
    #是否开启
    enable: true
  # swagger配置
  swagger:
    enable: true
  # 数据审计功能配置
  data-audit:
    # 审计数据过期时间
    audit-clear-day: 30     
    #服务名称,作为数据的区分字段,默认是spring.application.name
    serviceName: ${h-visions.service-name}
    #是否开启数据历史审计总开关,如果设置为false,则功能不启用,默认false
    enable: false
    #是否审计所有实体,如果设置为true,所有实体都会审计,如果想要单独审计,需要设置为false,默认false
    audit-all-entity: false
    #是否审计实体的所有操作。如果不想记录所有的操作,需要设置为false,默认false
    audit-all-operation: true
    #审计实体的操作类型,当audit-all-operation设置为false的时候生效。只能设置如下三种操作,默认为空数组
    operation: INSERT,UPDATE,DELETE
    #按照实体来进行分别的设置,需要audit-all-entity设置为false
    audit-config: 
        # 实体类名
      - entity: SysUser
        # 是否记录所有的操作
        all-option: true
      - entity: SysRole
        all-option: true

授权服务 local-license

server:
  # 给前端使用的接口端口号
  port: 8081

基础架构 framework

spring:
# 如果要使得消息通知可以同步发送邮件可以配置以下的邮件配置项目
  mail:
    #发送邮件服务器地址
    host: smtp.mxhichina.com 
    #发送邮件的邮箱地址
    username: smtp@h-visions.cn 
    password: xxxxx
    #发送邮件的邮箱地址
    from: smtp@h-visions.cn 
    #字符编码格式
    default-encoding: utf-8 
    #服务器端口号
    port: 25 
h-visions:
  dingTalk:
    # 是否开启钉钉对接功能
    enable: false
    # 初始化时候默认的用户角色编码,可以多个
    defaultUserRole: default
    # 钉钉组织的appkey
    appKey: xxxxx
    # 钉钉组织的appSecret
    appSecret: xxxxx
    # 钉钉组织内部应用的aesKey
    aesKey: xxxx
    # 钉钉组织内部应用的token
    token: xxx
  # 登录相关内容
  login:
    # 默认的token过期事件
    tokenExpire: 7200
    # jwttoken加密的secret
    jwt-secret: xxxxxx
    # 是否开启cas登录
    enableCasLogin: false
    # cas 单点登录注册中心的url
    cas-url: http://localhost:9022
    # 注册中心上面分配的client-it
    cas-client-id: hipermatic
    # 注册中心登出消息处理队列的名字
    cas-logout-queue: hipermatic
    # cas的前端登录页面地址
    casClientUrl: http://x.x.x.x:3000
  # 是否开启接口日志
  log:
    enable: false
  service-name: 基础服务
  auth:
    # 前端接收消息用到的mq信息
    mqHost: x.x.x.x
    mqPort: 15674
    mqUserName: ${spring.rabbitmq.username}
    mqPassword: ${spring.rabbitmq.password}
    # 判断是否要求用户初始化或者被重置密码后需要强制用户设置自己的密码,开启的时候第一次登录需要重置密码
    force-password-change: true
    # 登录接口尝试设置
    attempts:
      # 是否开启登录接口尝试模式
      enable: true
      # 是否尝试全部失败后锁定账号
      lock-account: true
      # 最大尝试次数
      max-time: 5
      # 多长时间内的尝试次数会计算其中,单位:分钟
      in-time: 10
    # 默认的用户密码和重置后的用户密码
    password: 111111
    message:
      #是否开启自动清理过期消息功能
      auto-clean: true
      #消息过期删除,0为不过期,单位为天
      expire-time: 30
      #是否开启发送邮件功能,开启后需要配置spring.mail信息
      send-message: true
    #指定菜单文件路径,系统启动的时候会读取这个文件并初始化菜单信息
    moduleFilePath: module.json
    # 密码正则规则
    password-regex: .*
    # 密码不符合正则规则时候的报错信息
    password-regex-error-message: 密码规则校验失败
    # 用户信息是否自动清理
    useractivity:
      auto-clean: true
  # 文件相关配置
  file:
    #默认分段上传的时候给与的文件类型(用于文件夹分类和查询)
    type: files
     # 用什么存储介质,目前支持local(本地硬盘)minio(minio作为分布式存储介质)
    storage: local
    # 当设置storage为local的时候,本地硬盘的存储地址 默认System.getProperty("user.dir") + "/files"
    path: /home/file  
    # storeage设置为minio的时候需要配置以下信息
    minio:
      #minio节点信息
      endpoints: http://10.0.0.1:8080,http://10.0.0.2:8080
      # minio 通讯key
      accessKey: xxxx
      # minio 通讯密钥
      secretKey: xxxx
      # minio 默认的桶名称
      bucket: file
      # minio 单节点(standalone)还是集群模式(cluster)
      mode: cluster
    # 支持的文件后缀
    support: txt,xls,xlsx,doc,docx,pdf,jpg,png,jpeg,bmp,gif,mp4
    # 上传图片压缩功能
    compress:
      # 是否开启此功能 false
      enable: false
      # 压缩类型
      support: jpg,png,jpeg,bmp
      # 压缩比例 取值范围为 0.0-1.0
      compression-ratio: 0.5
      # 当大于此size时开始压缩 单位:KB
      start-size: 200
    # 文件上传添加水印
    watermark:
      # 是否开启此功能 false
      enable: false
      # 水印物理地址 注:目前仅支持jpg格式
      watermarkPath: /home/jenkinsFiles/filemanagement/logo.jpg
      # 水印透明度 取值范围为 (0.0f-1.0f]
      transparency: 0.5f
      # 水印添加的位置 [1-9]
      # 1 [TOP_LEFT]     2 [TOP_CENTER]    3 [TOP_RIGHT]
      # 4 [CENTER_LEFT]  5 [CENTER]        6 [CENTER_RIGHT]
      # 7 [BOTTOM_LEFT]  8 [BOTTOM_CENTER] 9 [BOTTOM_RIGHT]
      positions: 9  
  # 日志相关配置
  logCapture:
    #定时清除日志的参数配置  day 天数
    log-clear-day: 30 
  # 数据审计功能配置
  data-audit:
    # 审计数据过期时间
    audit-clear-day: 30     
    #服务名称,作为数据的区分字段,默认是spring.application.name
    serviceName: ${h-visions.service-name}
    #是否开启数据历史审计总开关,如果设置为false,则功能不启用,默认false
    enable: false
    #是否审计所有实体,如果设置为true,所有实体都会审计,如果想要单独审计,需要设置为false,默认false
    audit-all-entity: false
    #是否审计实体的所有操作。如果不想记录所有的操作,需要设置为false,默认false
    audit-all-operation: true
    #审计实体的操作类型,当audit-all-operation设置为false的时候生效。只能设置如下三种操作,默认为空数组
    operation: INSERT,UPDATE,DELETE
    #按照实体来进行分别的设置,需要audit-all-entity设置为false
    audit-config: 
        # 实体类名
      - entity: SysUser
        # 是否记录所有的操作
        all-option: true
      - entity: SysRole
        all-option: true
  # springbootadmin的部署地址,用于给前端跳转到监控界面使用
  admin:
    url: http://192.168.10.5:9899/wallboard        

网关服务 gateway

spring:
  cloud:
    gateway:
      globalcors:
        # cors配置
        cors-configurations:
        # 仅在开发环境设置为*
          '[/**]':
            allowedOrigins: "*"
            allowedHeaders: "*"
            allowedMethods: "*"
      enable: true
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
h-visions:
  swagger:
    # 如果为false或者没有此属性。swagger界面将不会加载
    enable: true
  gateway:
    # 是否开启只要有请求,token就不会失效
    enableTimeOutLogOut: true
    # 多长时间不请求,就会失效
    timeOut: 60
    #    规定是否验证请求,如果开启,则需要登录后访问,并且开启后无法看到所有的swagger地址。
    valid: true
    #跳过验证的uri,可用逗号分割多个uri,请仔细检查添加的数据格式
    skip: /framework/file/downloadFile,/activiti/editor,/activiti/service,/framework/sysConfig/getConfig,/framework/dingTalk/callback,/framework/authority
  service-name: 网关

工具服务 hiper-tool

暂无

基础数据服务 hiper-base

暂无

仓储管理服务 wms

h-visions:
  #是否开启对选择库位的校验,true: 只能选择库位一级,false: 可以选择库房
  location:
    valid: true  
  quality:
    name: QA
  receipt:
    frozen: true
  supplier:
    name: '医疗科技'
    code: 'MedicalTechnology'

生产管理服务 pms

h-visions:
  #当配置为true验证产出料是否与配置一致
  outPutMaterial: true
  log:
    enable: false
  materialBatchNum: "(?<code>{8})"
  service-name: 工单管理服务
  extend:
    schema: pms
  datasource: mysql
  work-order:
    lock:
      task: true
  change:
    crew: false
  order-type: "default"
  order-type-name: "默认工单类型"

质量管理服务 qms

暂无

设备管理服务 eam

h-visions:
  datasource: mysql
  #是否添加所有控制器请求记录到log服务
  log:
    enable: false
  # 备件的解析格式
  materialBatchNum: "(.*[spare].*)"
  #是否开启审批  false为关闭审批 true为开启审批
  approve: true
  #流程文件是否强制更新 false
  bpmn-update: false
  maintain:
    #工作流服务器的数据库名称。为了以后可能的调整增加的
    activiti-database: activiti
  equipmentInspect:
    # 点巡检地图中最长的查询时间段
    taskTime: 60    

培训管理服务 training

暂无

认证中心服务 cas

h-visions:
  cas:
    # token过期时间
    expiration: 720
    # jwt密钥
    jwt-secret-key: hvisions

监控中心 springbootadmin

server:
  security:
    # 账号密码
    user:
      name: "admin"
      password: "admin"

工作流服务 activiti

h-visions:
  # 消息记录
  activiti:
    #是否在任务创建时发送消息
    send-message: true
  #服务名称,可以使用中文,日志服务会使用
  service-name: 工作流服务
2023-08-30
0