配置

目录

  • 描述
  • 读取配置
  • 注入配置
  • 注解配置
  • 配置实体类
  • 配置内容加密解密
  • 设计原因
  • 常见问题
  • Jboot所有配置参考

描述

在 Jboot 应用中，可以通过几下几种方式给 Jboot 应用进行配置。

  • jboot.properties 配置文件
  • 环境变量
  • Jvm 系统属性
  • 启动参数

注意：如果同一个属性被多处配置，那么 Jboot 读取配置的优先顺序是：启动参数 > Jvm 系统属性 > 环境变量 > jboot.properties 配置

读取配置

  2. String host = Jboot.configValue("undertow.host")
  3. String port = Jboot.configValue("undertow.port")

注入配置

  2. public class AopController extends JbootController {
  4.     @ConfigValue("undertow.host")
  5.     private String host;
  7.     @ConfigValue("undertow.port")
  8.     private int port;
  10.     public void index(){
  11.         renderText("host:" + host +"   port:" + port);
  12.     }
  13. }

注解配置

在应用开发中，我们通常会使用注解，Jboot 内置了多个注解。

例如：

  • @RequestMapping
  • @EnableCORS
  • @RPCInject
  • @RPCBean
  • …等等

在使用注解的时候，我们通常会这样来使用，例如：

  1. @RequestMapping("/user")
  2. public class UserController extends Controller{
  3.     //....
  4. }

或者

  1. @RPCBean(group="myGroup",version="myVersion",port=...)
  2. public class UserServiceProvider extends UserService{
  3.     //....
  4. }

但是，无论是 @RequestMapping("/user") 或者是 @RPCBean(group="myGroup",version="myVersion",port=...) , 其参数配置都是固定的，因此，Jboot 提供了一种动态的配置方法，可以用于读取配置文件的内容。

例如：

  1. @RequestMapping("${user.mapping}")
  2. public class UserController extends Controller{
  3.     //....
  4. }

然后在配置文件 jboot.properties （也可以是启动参数、环境变量等）添加上：

  1. user.mapping = /user

其作用是等效于：

  1. @RequestMapping("/user")
  2. public class UserController extends Controller{
  3.     //....
  4. }

因此，在 Jboot 应用中，注解的值可以通过 ${key} 的方式，读取到配置内容的 key 对于的 value 值。

配置实体类

很多时候，某个功能或组件可能需要 一堆 的配置，而不是一个配置，无论是手动编码读取 或者 是通过注入，就可以让我们的项目产生重复的代码。

Jboot 提供了配置实体类功能，该功能自动把配置信息 映射 给一个 JavaBean 实体类，方便我们 批量 读取配置信息。

例如：

某个组件叫 component1 ，它需要如下几个配置信息。

  • 主机
  • 端口号
  • 账号
  • 密码
  • 超时时间

那么，我们可以创建一个叫 Component1Config 的实体类，定义好其属性，如下代码 ：

  2. @ConfigModel(prefix="component1")
  3. public class Component1Config{
  4.     private String host;
  5.     private int port;
  6.     private String accout;
  7.     private String password;
  8.     private long timeout;
  10.     // 下方应该还有 getter setter， 略
  11. }

这样，我们就可以通过如下代码读 Component1Config 信息。

  2. Component1Config config = Jboot.config(Component1Config.class);

备注：@ConfigModel(prefix="component1") 注解的含义是 Component1Config 的前缀是 component1 ，因此，其属性 host 是来至配置文件的 component1.host 的值。

配置内容加密解密

为了安全起见，很多时候我们需要对配置里的一些安全和隐私内容进行加密，比如数据库的账号密码等，防止web服务器被黑客入侵时保证数据库的安全。

配置的内容加密是由用户自己编写加密算法。此时，Jboot 读取的只是加密的内容，为了能正常还原解密之后的内容，用户需要给 JbootConfigManager 配置上解密的实现 JbootConfigDecryptor。

一般情况下，我们需要在 JbootAppListener 的 onInit() 里去配置。例如：

  1. public MyApplicationListener implements JbootAppListener {
  3.     public void onInit() {
  4.         JbootConfigManager.me().setDecryptor(new MyConfigDecriptor());
  5.     }
  7. }

我们需要在 MyConfigDecriptor 的 decrypt 方法里去实现自己的解密算法。例如：

  1. public MyConfigDecriptor implements JbootConfigDecryptor {
  3.     public String decrypt(String key, String originalContent){
  4.         //在这里实现你自己的解密算法
  5.         //key : 很多时候我们并不是针对所有的配置都进行加密，只是加密了个别配置
  6.         //此时，我们可以通过 key 来判断那些无需加密的内容，不需要加密直接返回 originalContent 即可
  7.     }
  8. }

设计原因

由于 Jboot 定位是微服务框架，同时 Jboot 假设：基于 Jboot 开发的应用部署在 Docker 之上。

因此，在做 Devops 的时候，编排工具（例如：k8s、mesos）会去修改应用的相关配置，而通过环境变量和启动配置，无疑是最方便快捷的。

常见问题

1、如何设置启动参数 ？

答：在 fatjar 模式下，可以通过添加 --（两个中划线） 来指定配置，例如：java -jar —undertow.port=8080 —undertow.host=0.0.0.0

2、如何设置 Jvm 系统属性 ？

答：和启动参数一样，只需要把 -- 换成 -D，例如： java -jar -Dundertow.port=8080 -Dundertow.host=0.0.0.0

2、如何设置系统环境变量 ？

答：在 Docker 下，启动 Docker 容器的时候，只需要添加 -e 参数即可，例如： docker run -e undertow.port=8080 xxxxLinux、Window、Mac 搜索引擎自行搜索关键字： 环境变量配置

Jboot 所有配置参考

  1. undertow.devMode=true # 设置undertow为开发模式
  2. undertow.port=80 #undertow 的端口号，默认 8080，配置 * 为随机端口
  3. undertow.host=0.0.0.0 #默认为localhost
  4. undertow.resourcePath = src/main/webapp, classpath:static
  5. undertow.ioThreads=
  6. undertow.workerThreads=
  7. undertow.gzip.enable=true # gzip 压缩开关
  8. undertow.gzip.level=-1 # 配置压缩级别，默认值 -1。 可配置 1 到 9。 1 拥有最快压缩速度，9 拥有最高压缩率
  9. undertow.gzip.minLength=1024 # 触发压缩的最小内容长度
  10. undertow.session.timeout=1800 # session 过期时间，注意单位是秒
  11. undertow.session.hotSwap=true # 支持 session 热加载，避免依赖于 session 的登录型项目反复登录，默认值为 true。仅用于 devMode，生产环境无影响
  12. undertow.ssl.enable=false # 是否开启 ssl
  13. undertow.ssl.port=443 # ssl 监听端口号，部署环境设置为 443
  14. undertow.ssl.keyStoreType=PKCS12 # 密钥库类型，建议使用 PKCS12
  15. undertow.ssl.keyStore=demo.pfx # 密钥库文件
  16. undertow.ssl.keyStorePassword=123456 # 密钥库密码
  17. undertow.ssl.keyAlias=demo # 别名配置，一般不使用
  18. undertow.http2.enable=true # ssl 开启时，是否开启 http2
  19. undertow.http.toHttps=false # ssl 开启时，http 请求是否重定向到 https
  20. undertow.http.toHttpsStatusCode=302 # ssl 开启时，http 请求跳转到 https 使用的状态码，默认值 302
  21. undertow.http.disable=false # ssl 开启时，是否关闭 http
  23. jboot.app.mode
  24. jboot.app.bannerEnable
  25. jboot.app.bannerFile
  26. jboot.app.jfinalConfig
  28. jboot.web.webSocketEndpoint
  29. jboot.web.cookieEncryptKey
  31. jboot.web.session.cookieName
  32. jboot.web.session.cookieDomain
  33. jboot.web.session.cookieContextPath
  34. jboot.web.session.maxInactiveInterval
  35. jboot.web.session.cookieMaxAge
  36. jboot.web.session.cacheName
  37. jboot.web.session.cacheType
  39. jboot.web.jwt.httpHeaderName
  40. jboot.web.jwt.secret
  41. jboot.web.jwt.validityPeriod
  43. jboot.web.cdn.enable
  44. jboot.web.cdn.domain
  47. jboot.datasource.name
  48. jboot.datasource.type
  49. jboot.datasource.url
  50. jboot.datasource.user
  51. jboot.datasource.password
  52. jboot.datasource.driverClassName = "com.mysql.jdbc.Driver"
  53. jboot.datasource.connectionInitSql
  54. jboot.datasource.poolName
  55. jboot.datasource.cachePrepStmts = true
  56. jboot.datasource.prepStmtCacheSize = 500
  57. jboot.datasource.prepStmtCacheSqlLimit = 2048
  58. jboot.datasource.maximumPoolSize = 10
  59. jboot.datasource.maxLifetime
  60. jboot.datasource.idleTimeout
  61. jboot.datasource.minimumIdle = 0
  62. jboot.datasource.sqlTemplatePath
  63. jboot.datasource.sqlTemplate
  64. jboot.datasource.factory
  65. jboot.datasource.shardingConfigYaml
  66. jboot.datasource.dbProFactory
  67. jboot.datasource.containerFactory
  68. jboot.datasource.transactionLevel
  69. jboot.datasource.table //此数据源包含哪些表
  70. jboot.datasource.exTable //该数据源排除哪些表
  71. jboot.datasource.dialectClass
  72. jboot.datasource.activeRecordPluginClass
  73. jboot.datasource.needAddMapping = true //是否需要添加到映射，当不添加映射的时候，只能通过 model.use("xxx").save()这种方式去调用该数据源
  76. jboot.rpc.type
  77. jboot.rpc.callMode
  78. jboot.rpc.requestTimeOut
  79. jboot.rpc.registryType
  80. jboot.rpc.registryAddress
  81. jboot.rpc.registryName
  82. jboot.rpc.registryUserName
  83. jboot.rpc.registryPassword
  84. jboot.rpc.registryFile
  85. jboot.rpc.registryCheck
  86. jboot.rpc.consumerCheck
  87. jboot.rpc.providerCheck
  88. jboot.rpc.directUrl
  89. jboot.rpc.host
  90. jboot.rpc.defaultPort
  91. jboot.rpc.defaultGroup
  92. jboot.rpc.defaultVersion
  93. jboot.rpc.proxy
  94. jboot.rpc.filter
  95. jboot.rpc.serialization
  96. jboot.rpc.retries
  97. jboot.rpc.autoExportEnable
  99. jboot.rpc.dubbo.protocolName
  100. jboot.rpc.dubbo.protocolServer
  101. jboot.rpc.dubbo.protocolContextPath
  102. jboot.rpc.dubbo.protocolTransporter
  103. jboot.rpc.dubbo.protocolThreads
  104. jboot.rpc.dubbo.protocolHost
  105. jboot.rpc.dubbo.protocolPort
  106. jboot.rpc.dubbo.protocolContextpath
  107. jboot.rpc.dubbo.protocolThreadpool
  108. jboot.rpc.dubbo.protocolIothreads
  109. jboot.rpc.dubbo.protocolQueues
  110. jboot.rpc.dubbo.protocolAccepts
  111. jboot.rpc.dubbo.protocolCodec
  112. jboot.rpc.dubbo.protocolSerialization
  113. jboot.rpc.dubbo.protocolCharset
  114. jboot.rpc.dubbo.protocolPayload
  115. jboot.rpc.dubbo.protocolBuffer
  116. jboot.rpc.dubbo.protocolHeartbeat
  117. jboot.rpc.dubbo.protocolAccesslog
  118. jboot.rpc.dubbo.protocolExchanger
  119. jboot.rpc.dubbo.protocolDispatcher
  120. jboot.rpc.dubbo.protocolNetworker
  121. jboot.rpc.dubbo.protocolClient
  122. jboot.rpc.dubbo.protocolTelnet
  123. jboot.rpc.dubbo.protocolPrompt
  124. jboot.rpc.dubbo.protocolStatus
  125. jboot.rpc.dubbo.protocolRegister
  126. jboot.rpc.dubbo.protocolKeepAlive
  127. jboot.rpc.dubbo.protocolOptimizer
  128. jboot.rpc.dubbo.protocolExtension
  129. jboot.rpc.dubbo.protocolIsDefault
  130. jboot.rpc.dubbo.qosEnable
  131. jboot.rpc.dubbo.qosPort
  132. jboot.rpc.dubbo.qosAcceptForeignIp
  134. jboot.rpc.zbus.serviceName
  135. jboot.rpc.zbus.serviceToken
  137. jboot.mq.type
  138. jboot.mq.channel
  139. jboot.mq.serializer
  140. jboot.mq.syncRecevieMessageChannel
  142. jboot.mq.redis.host
  143. jboot.mq.redis.port
  144. jboot.mq.redis.password
  145. jboot.mq.redis.database
  146. jboot.mq.redis.timeout
  147. jboot.mq.redis.clientName
  148. jboot.mq.redis.testOnCreate
  149. jboot.mq.redis.testOnBorrow
  150. jboot.mq.redis.testOnReturn
  151. jboot.mq.redis.testWhileIdle
  152. jboot.mq.redis.minEvictableIdleTimeMillis
  153. jboot.mq.redis.timeBetweenEvictionRunsMillis
  154. jboot.mq.redis.numTestsPerEvictionRun
  155. jboot.mq.redis.maxAttempts
  156. jboot.mq.redis.maxTotal
  157. jboot.mq.redis.maxIdle
  158. jboot.mq.redis.maxWaitMillis
  159. jboot.mq.redis.serializer
  160. jboot.mq.redis.type
  162. jboot.mq.rabbitmq.username
  163. jboot.mq.rabbitmq.password
  164. jboot.mq.rabbitmq.host
  165. jboot.mq.rabbitmq.port
  166. jboot.mq.rabbitmq.virtualHost
  168. jboot.mq.qpid.host
  169. jboot.mq.qpid.username
  170. jboot.mq.qpid.password
  171. jboot.mq.qpid.virtualHost
  173. jboot.mq.aliyun.accessKey
  174. jboot.mq.aliyun.secretKey
  175. jboot.mq.aliyun.addr
  176. jboot.mq.aliyun.producerId
  177. jboot.mq.aliyun.sendMsgTimeoutMillis
  179. jboot.mq.zbus.queue
  180. jboot.mq.zbus.broker
  182. jboot.cache.type
  183. jboot.cache.ehcache.configFileName
  184. jboot.cache.redis.host
  185. jboot.cache.redis.port
  186. jboot.cache.redis.password
  187. jboot.cache.redis.database
  188. jboot.cache.redis.timeout
  189. jboot.cache.redis.clientName
  190. jboot.cache.redis.testOnCreate
  191. jboot.cache.redis.testOnBorrow
  192. jboot.cache.redis.testOnReturn
  193. jboot.cache.redis.testWhileIdle
  194. jboot.cache.redis.minEvictableIdleTimeMillis
  195. jboot.cache.redis.timeBetweenEvictionRunsMillis
  196. jboot.cache.redis.numTestsPerEvictionRun
  197. jboot.cache.redis.maxAttempts
  198. jboot.cache.redis.maxTotal
  199. jboot.cache.redis.maxIdle
  200. jboot.cache.redis.maxWaitMillis
  201. jboot.cache.redis.serializer
  202. jboot.cache.redis.type
  204. jboot.schedule.cron4jFile
  205. jboot.schedule.poolSize
  207. jboot.model.scan
  208. jboot.model.columnCreated
  209. jboot.model.columnModified
  210. jboot.model.idCacheEnable
  211. jboot.model.idCacheType
  212. jboot.model.idCacheTime
  214. jboot.metric.url
  215. jboot.metric.reporter
  216. jboot.metric.reporter.cvr.path
  217. jboot.metric.reporter.graphite.host
  218. jboot.metric.reporter.graphite.port
  219. jboot.metric.reporter.graphite.prefixedWith
  221. jboot.wechat.debug
  222. jboot.wechat.appId
  223. jboot.wechat.appSecret
  224. jboot.wechat.token
  225. jboot.wechat.partner
  226. jboot.wechat.paternerKey
  227. jboot.wechat.cert
  229. jboot.shiro.loginUrl
  230. jboot.shiro.successUrl
  231. jboot.shiro.unauthorizedUrl
  232. jboot.shiro.ini
  233. jboot.shiro.urlMapping
  234. jboot.shiro.invokeListener
  236. jboot.serializer.type
  238. jboot.swagger.path
  239. jboot.swagger.title
  240. jboot.swagger.description
  241. jboot.swagger.version
  242. jboot.swagger.termsOfService
  243. jboot.swagger.host
  244. jboot.swagger.contactName
  245. jboot.swagger.contactEmail
  246. jboot.swagger.contactUrl
  247. jboot.swagger.licenseName
  248. jboot.swagger.licenseUrl
  250. jboot.http.type
  252. jboot.redis.host
  253. jboot.redis.port
  254. jboot.redis.password
  255. jboot.redis.database
  256. jboot.redis.timeout
  257. jboot.redis.clientName
  258. jboot.redis.testOnCreate
  259. jboot.redis.testOnBorrow
  260. jboot.redis.testOnReturn
  261. jboot.redis.testWhileIdle
  262. jboot.redis.minEvictableIdleTimeMillis
  263. jboot.redis.timeBetweenEvictionRunsMillis
  264. jboot.redis.numTestsPerEvictionRun
  265. jboot.redis.maxAttempts
  266. jboot.redis.maxTotal
  267. jboot.redis.maxIdle
  268. jboot.redis.maxWaitMillis
  269. jboot.redis.serializer
  270. jboot.redis.type
  273. jboot.limit.enable
  274. jboot.limit.rule
  275. jboot.limit.fallbackProcesser
  276. jboot.limit.defaultHttpCode
  277. jboot.limit.defaultAjaxContent
  278. jboot.limit.defaultHtmlView