跳至主要內容

辅助模块

码匠君大约 6 分钟配置属性

[一]图形验证码配置

前缀：herodotus.assistant.captcha.graphics

length

  • Type: Integer
  • Default: 5

验证码字符个数

width

  • Type: Integer
  • Default: 130

验证码显示宽度。

height

  • Type: Integer
  • Default: 48

验证码显示高度。

complexity

  • Type: Integer
  • Default: 2

算数类型验证码算法复杂度

letter

  • Type: Enum
  • Values: NUM_AND_CHAR，ONLY_NUM，ONLY_CHAR，ONLY_UPPER_CHAR，ONLY_LOWER_CHAR 和 NUM_AND_UPPER_CHAR
  • Default: NUM_AND_CHAR

字符类型。

  • NUM_AND_CHAR：数字和字母混合
  • ONLY_NUM：纯数字
  • ONLY_CHAR：纯字母
  • ONLY_UPPER_CHAR：纯大写字母
  • ONLY_LOWER_CHAR：纯小写字母
  • NUM_AND_UPPER_CHAR：数字和大写字母

font

  • Type: Enum
  • Values: ACTION，BEATAE，EPILOG，FRESNEL，HEADACHE，LEXOGRAPHER，PREFIX，PROG_BOT，ROBOT_TEACHER 和 SCANDAL
  • Default: LEXOGRAPHER

字体类型。

  • ACTION：对应 Action.ttf
  • BEATAE：对应 Beatae.ttf
  • EPILOG：对应 Epilog.ttf
  • FRESNEL：对应 Fresnel.ttf
  • HEADACHE：对应 Headache.ttf
  • LEXOGRAPHER：对应 Lexographer.ttf
  • PREFIX：对应 Prefix.ttf
  • PROG_BOT: 对应 ProgBot.ttf
  • ROBOT_TEACHER：对应 RobotTeacher.ttf
  • SCANDAL: 对应 Scandal.ttf

[二]验证码水印配置

前缀：herodotus.assistant.captcha.watermark

content

  • Type: String
  • Default: Herodotus Cloud

水印内容

font-name

  • Type: String
  • Default: WenQuanZhengHei.ttf

水印字体

font-style

  • Type: String
  • Default: 1

字体样式

  • 0：PLAIN
  • 1：BOLD
  • 2：ITALI

[三]滑块拼图验证码配置

前缀：herodotus.assistant.captcha.jigsaw

original-resource

  • Type: String
  • Default: classpath*:images/jigsaw/original/*.png

拼图滑块验证码原图资源路径

template-resource

  • Type: String
  • Default: classpath*:images/jigsaw/template/*.png

拼图滑块验证码拼图模版资源路径

interference

  • Type: Integer
  • Default: 0

滑动干扰项, 可选值为(0/1/2), 默认值为：0，即无干扰项

deviation

  • Type: Integer
  • Default: 5

偏差值，滑动结果与标准结果间可接受的偏差值。默认：5

[四]文字点选验证码配置

前缀：herodotus.assistant.captcha.word-click

image-resource

  • Type: String
  • Default: classpath*:images/word-click/*.png

文字点选验证码资源路径

word-count

  • Type: Integer
  • Default: 5

文字点选验证码文字个数

random-color

  • Type: Boolean
  • Default: true

随机颜色

font-style

  • Type: String
  • Default: 1

字体样式

  • 0：PLAIN
  • 1：BOLD
  • 2：ITALI

font-name

  • Type: String
  • Default: WenQuanZhengHei.ttf

水印字体

font-size

  • Type: Integer
  • Default: 25

文字点选验证码资源路径字体大小

[五]Ip2Region配置

前缀：herodotus.assistant.ip2region

ipV4Resource

  • Type: String
  • Default: classpath:/db/ip2region.db

Ip V4 地址数据库位置

ipV6Resource

  • Type: String
  • Default: classpath:/db/ipv6wry.db

Ip V6 地址数据库位置

[六]短信接入配置

前缀：herodotus.assistant.access.sms

sandbox

  • Type: Boolean
  • Default: false

开启短信沙盒测试模式

test-code

  • Type: String
  • Default: 123456

短信沙盒测试模式中，创建的默认验证码。使用该验证码无需真正的发送短信，即可登录。

verification-code-template-id

  • Type: String
  • Default: VERIFICATION_CODE

验证码短信模版名称。使用短信厂商通道发送短信，大多需要指定一个已审核的模版。该参数用于指定具体发送短信验证码的模版ID

expire

  • Type: Duration
  • Default: 5m

短信验证码有效期，默认5分钟

注

需要使用 Spring Boot Duration 类型参数配置的格式进行配置

  • ns for nanoseconds (纳秒)
  • us for microseconds (微秒)
  • ms for milliseconds (毫秒)
  • s for seconds (秒)
  • m for minutes (分)
  • h for hours (时)
  • d for days (天)

length

  • Type: Integer
  • Default: 6

手机验证码长度，默认为6位数

[七]JustAuth接入配置

前缀：herodotus.assistant.access.justauth

enabled

  • Type: Boolean
  • Default: false

是否开启 JustAuth。

timeout

  • Type: Duration
  • Default: 5m

State 缓存时长，默认5分钟

注

需要使用 Spring Boot Duration 类型参数配置的格式进行配置

  • ns for nanoseconds (纳秒)
  • us for microseconds (微秒)
  • ms for milliseconds (毫秒)
  • s for seconds (秒)
  • m for minutes (分)
  • h for hours (时)
  • d for days (天)

configs

  • Type: Map<String, AuthConfig>
  • Default: null

第三方系统登录配置信息。这里直接使用的是 JustAuth 的 AuthConfig 对象作为配置信息，所以与 JustAuth 配置完全一致。

binding-redirect-uri

  • Type: String
  • Default: null

用于用户手动绑定的 RedirectUri。

说明

Redirect URI 地址，通常为自己系统中的一个请求地址，可以是前端的地址也可以是后端的地址。OAuth2 协议的授权码模式中，通过跳转到 Redirect URI 地址，将授权码模式的核心参数值 Code 反馈给需要授权的系统，只有接收到这个参数才能保证整个授权码模式的完整性

目前，Dante Cloud 使用到第三方社会化登录的功能有两个：一个是登录页面的社会化账户登录，一个是账户信息中手动绑定社会化账户。这两个功能使用的 Redirect URI 可以是同一个也可以是不同的地址，完全看使用者自己的定义。

  • 如果是同一个地址没有任何问题，JustAuth 的 AuthConfig 中就已经包含了 Redirect URI 参数，直接使用即可。
  • 如果不是同一个地址，那么 AuthConfig 就没法满足需求。所以单独增加了 binding-redirect-uri 参数用于解决这个问题。

在第三方社会化账号绑定功能中，如果没有配置 binding-redirect-uri 参数，就使用 AuthConfig 中配置的 Redirect URI 参数；如果配置了 binding-redirect-uri 参数就使用 binding-redirect-uri 的值。

[八]微信小程序接入配置

前缀：herodotus.assistant.access.wxapp

enabled

  • Type: Boolean
  • Default: false

是否开启微信小程序，默认，不开启。

enabled

  • Type: Boolean
  • Default: false

是否开启微信小程序，默认，不开启。

default-app-id

  • Type: String
  • Default: null

指定默认的小程序 AppId。系统同时支持多个小程序，如果不指定 default-app-id，那么在代码中调用相关API 时，就必须传递 appId 参数；如果指定 default-app-id 了参数，在不指定具体 AppId 时，就默认使用 default-app-id 参数中配置 AppId

configs

  • Type: List<Config>
  • Default: null

小程序配置列表

说明

Config 类型为系统自定义实体，用于指定小程序的参数值，可用的参数如下：

  • appId：设置微信小程序的appid
  • secret：设置微信小程序的Secret
  • token：设置微信小程序消息服务器配置的token
  • aesKey：设置微信小程序消息服务器配置的EncodingAESKey
  • messageDataFormat：消息格式，XML或者JSON

subscribes

  • Type: List<Subscribe>
  • Default: null

小程序订阅消息配置列表

说明

Subscribe 类型为系统自定义实体，用于指定小程序的订阅消息参数值，可用的参数如下：

  • redirectPage：订阅消息指定的小程序跳转页面地址
  • templateId：订阅消息模版ID
  • subscribeId：自定义Message区分ID，用于获取不同的SubscribeMessageHandler
  • miniProgramState：跳转小程序的状态，developer为开发版；trial为体验版；formal为正式版；默认为正式版

[九]对象存储配置

前缀：herodotus.assistant.oss

endpoint

  • Type: String
  • Default: null

对象存储服务或服务器访问端点。

access-key

  • Type: String
  • Default: null

对象存储服务或服务器访问Access Key。

注

不同 OSS 厂商对该参数的叫法或命名可能不同，但是方法都殊途同归。

secret-key

  • Type: String
  • Default: null

对象存储服务或服务器访问Secret Key。

注

不同 OSS 厂商对该参数的叫法或命名可能不同，但是方法都殊途同归。

region

  • Type: String
  • Default: null

对象存储服务默认区域。

pre-signed-expires

  • Type: Duration
  • Default: 5m

对象存储预签名URL有效期，默认：5分钟

注

需要使用 Spring Boot Duration 类型参数配置的格式进行配置

  • ns for nanoseconds (纳秒)
  • us for microseconds (微秒)
  • ms for milliseconds (毫秒)
  • s for seconds (秒)
  • m for minutes (分)
  • h for hours (时)
  • d for days (天)

pool

对象池化配置，参见通用配置 - 【对象池配置】