配置文件

目录

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

描述

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

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

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

读取配置

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

注入配置

  1. public class AopController extends JbootController {
  2. @ConfigValue("undertow.host")
  3. private String host;
  4. @ConfigValue("undertow.port")
  5. private int port;
  6. public void index(){
  7. renderText("host:" + host +" port:" + port);
  8. }
  9. }

注解配置

在应用开发中,我们通常会使用注解,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 的实体类,定义好其属性,如下代码 :

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

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

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

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

设计原因

由于 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
  22. jboot.app.mode
  23. jboot.app.bannerEnable
  24. jboot.app.bannerFile
  25. jboot.app.jfinalConfig
  26. jboot.web.webSocketEndpoint
  27. jboot.web.cookieEncryptKey
  28. jboot.web.session.cookieName
  29. jboot.web.session.cookieDomain
  30. jboot.web.session.cookieContextPath
  31. jboot.web.session.maxInactiveInterval
  32. jboot.web.session.cookieMaxAge
  33. jboot.web.session.cacheName
  34. jboot.web.session.cacheType
  35. jboot.web.jwt.httpHeaderName
  36. jboot.web.jwt.secret
  37. jboot.web.jwt.validityPeriod
  38. jboot.web.cdn.enable
  39. jboot.web.cdn.domain
  40. jboot.datasource.name
  41. jboot.datasource.type
  42. jboot.datasource.url
  43. jboot.datasource.user
  44. jboot.datasource.password
  45. jboot.datasource.driverClassName = "com.mysql.jdbc.Driver"
  46. jboot.datasource.connectionInitSql
  47. jboot.datasource.poolName
  48. jboot.datasource.cachePrepStmts = true
  49. jboot.datasource.prepStmtCacheSize = 500
  50. jboot.datasource.prepStmtCacheSqlLimit = 2048
  51. jboot.datasource.maximumPoolSize = 10
  52. jboot.datasource.maxLifetime
  53. jboot.datasource.idleTimeout
  54. jboot.datasource.minimumIdle = 0
  55. jboot.datasource.sqlTemplatePath
  56. jboot.datasource.sqlTemplate
  57. jboot.datasource.factory
  58. jboot.datasource.shardingConfigYaml
  59. jboot.datasource.dbProFactory
  60. jboot.datasource.containerFactory
  61. jboot.datasource.transactionLevel
  62. jboot.datasource.table //此数据源包含哪些表
  63. jboot.datasource.exTable //该数据源排除哪些表
  64. jboot.datasource.dialectClass
  65. jboot.datasource.activeRecordPluginClass
  66. jboot.datasource.needAddMapping = true //是否需要添加到映射,当不添加映射的时候,只能通过 model.use("xxx").save()这种方式去调用该数据源
  67. jboot.rpc.type
  68. jboot.rpc.callMode
  69. jboot.rpc.requestTimeOut
  70. jboot.rpc.registryType
  71. jboot.rpc.registryAddress
  72. jboot.rpc.registryName
  73. jboot.rpc.registryUserName
  74. jboot.rpc.registryPassword
  75. jboot.rpc.registryFile
  76. jboot.rpc.registryCheck
  77. jboot.rpc.consumerCheck
  78. jboot.rpc.providerCheck
  79. jboot.rpc.directUrl
  80. jboot.rpc.host
  81. jboot.rpc.defaultPort
  82. jboot.rpc.defaultGroup
  83. jboot.rpc.defaultVersion
  84. jboot.rpc.proxy
  85. jboot.rpc.filter
  86. jboot.rpc.serialization
  87. jboot.rpc.retries
  88. jboot.rpc.autoExportEnable
  89. jboot.rpc.dubbo.protocolName
  90. jboot.rpc.dubbo.protocolServer
  91. jboot.rpc.dubbo.protocolContextPath
  92. jboot.rpc.dubbo.protocolTransporter
  93. jboot.rpc.dubbo.protocolThreads
  94. jboot.rpc.dubbo.protocolHost
  95. jboot.rpc.dubbo.protocolPort
  96. jboot.rpc.dubbo.protocolContextpath
  97. jboot.rpc.dubbo.protocolThreadpool
  98. jboot.rpc.dubbo.protocolIothreads
  99. jboot.rpc.dubbo.protocolQueues
  100. jboot.rpc.dubbo.protocolAccepts
  101. jboot.rpc.dubbo.protocolCodec
  102. jboot.rpc.dubbo.protocolSerialization
  103. jboot.rpc.dubbo.protocolCharset
  104. jboot.rpc.dubbo.protocolPayload
  105. jboot.rpc.dubbo.protocolBuffer
  106. jboot.rpc.dubbo.protocolHeartbeat
  107. jboot.rpc.dubbo.protocolAccesslog
  108. jboot.rpc.dubbo.protocolExchanger
  109. jboot.rpc.dubbo.protocolDispatcher
  110. jboot.rpc.dubbo.protocolNetworker
  111. jboot.rpc.dubbo.protocolClient
  112. jboot.rpc.dubbo.protocolTelnet
  113. jboot.rpc.dubbo.protocolPrompt
  114. jboot.rpc.dubbo.protocolStatus
  115. jboot.rpc.dubbo.protocolRegister
  116. jboot.rpc.dubbo.protocolKeepAlive
  117. jboot.rpc.dubbo.protocolOptimizer
  118. jboot.rpc.dubbo.protocolExtension
  119. jboot.rpc.dubbo.protocolIsDefault
  120. jboot.rpc.dubbo.qosEnable
  121. jboot.rpc.dubbo.qosPort
  122. jboot.rpc.dubbo.qosAcceptForeignIp
  123. jboot.rpc.zbus.serviceName
  124. jboot.rpc.zbus.serviceToken
  125. jboot.mq.type
  126. jboot.mq.channel
  127. jboot.mq.serializer
  128. jboot.mq.syncRecevieMessageChannel
  129. jboot.mq.redis.host
  130. jboot.mq.redis.port
  131. jboot.mq.redis.password
  132. jboot.mq.redis.database
  133. jboot.mq.redis.timeout
  134. jboot.mq.redis.clientName
  135. jboot.mq.redis.testOnCreate
  136. jboot.mq.redis.testOnBorrow
  137. jboot.mq.redis.testOnReturn
  138. jboot.mq.redis.testWhileIdle
  139. jboot.mq.redis.minEvictableIdleTimeMillis
  140. jboot.mq.redis.timeBetweenEvictionRunsMillis
  141. jboot.mq.redis.numTestsPerEvictionRun
  142. jboot.mq.redis.maxAttempts
  143. jboot.mq.redis.maxTotal
  144. jboot.mq.redis.maxIdle
  145. jboot.mq.redis.maxWaitMillis
  146. jboot.mq.redis.serializer
  147. jboot.mq.redis.type
  148. jboot.mq.rabbitmq.username
  149. jboot.mq.rabbitmq.password
  150. jboot.mq.rabbitmq.host
  151. jboot.mq.rabbitmq.port
  152. jboot.mq.rabbitmq.virtualHost
  153. jboot.mq.qpid.host
  154. jboot.mq.qpid.username
  155. jboot.mq.qpid.password
  156. jboot.mq.qpid.virtualHost
  157. jboot.mq.aliyun.accessKey
  158. jboot.mq.aliyun.secretKey
  159. jboot.mq.aliyun.addr
  160. jboot.mq.aliyun.producerId
  161. jboot.mq.aliyun.sendMsgTimeoutMillis
  162. jboot.mq.zbus.queue
  163. jboot.mq.zbus.broker
  164. jboot.cache.type
  165. jboot.cache.ehcache.configFileName
  166. jboot.cache.redis.host
  167. jboot.cache.redis.port
  168. jboot.cache.redis.password
  169. jboot.cache.redis.database
  170. jboot.cache.redis.timeout
  171. jboot.cache.redis.clientName
  172. jboot.cache.redis.testOnCreate
  173. jboot.cache.redis.testOnBorrow
  174. jboot.cache.redis.testOnReturn
  175. jboot.cache.redis.testWhileIdle
  176. jboot.cache.redis.minEvictableIdleTimeMillis
  177. jboot.cache.redis.timeBetweenEvictionRunsMillis
  178. jboot.cache.redis.numTestsPerEvictionRun
  179. jboot.cache.redis.maxAttempts
  180. jboot.cache.redis.maxTotal
  181. jboot.cache.redis.maxIdle
  182. jboot.cache.redis.maxWaitMillis
  183. jboot.cache.redis.serializer
  184. jboot.cache.redis.type
  185. jboot.schedule.cron4jFile
  186. jboot.schedule.poolSize
  187. jboot.model.scan
  188. jboot.model.columnCreated
  189. jboot.model.columnModified
  190. jboot.model.idCacheEnable
  191. jboot.model.idCacheType
  192. jboot.model.idCacheTime
  193. jboot.metric.url
  194. jboot.metric.reporter
  195. jboot.metric.reporter.cvr.path
  196. jboot.metric.reporter.graphite.host
  197. jboot.metric.reporter.graphite.port
  198. jboot.metric.reporter.graphite.prefixedWith
  199. jboot.wechat.debug
  200. jboot.wechat.appId
  201. jboot.wechat.appSecret
  202. jboot.wechat.token
  203. jboot.wechat.partner
  204. jboot.wechat.paternerKey
  205. jboot.wechat.cert
  206. jboot.shiro.loginUrl
  207. jboot.shiro.successUrl
  208. jboot.shiro.unauthorizedUrl
  209. jboot.shiro.ini
  210. jboot.shiro.urlMapping
  211. jboot.shiro.invokeListener
  212. jboot.serializer.type
  213. jboot.swagger.path
  214. jboot.swagger.title
  215. jboot.swagger.description
  216. jboot.swagger.version
  217. jboot.swagger.termsOfService
  218. jboot.swagger.host
  219. jboot.swagger.contactName
  220. jboot.swagger.contactEmail
  221. jboot.swagger.contactUrl
  222. jboot.swagger.licenseName
  223. jboot.swagger.licenseUrl
  224. jboot.http.type
  225. jboot.redis.host
  226. jboot.redis.port
  227. jboot.redis.password
  228. jboot.redis.database
  229. jboot.redis.timeout
  230. jboot.redis.clientName
  231. jboot.redis.testOnCreate
  232. jboot.redis.testOnBorrow
  233. jboot.redis.testOnReturn
  234. jboot.redis.testWhileIdle
  235. jboot.redis.minEvictableIdleTimeMillis
  236. jboot.redis.timeBetweenEvictionRunsMillis
  237. jboot.redis.numTestsPerEvictionRun
  238. jboot.redis.maxAttempts
  239. jboot.redis.maxTotal
  240. jboot.redis.maxIdle
  241. jboot.redis.maxWaitMillis
  242. jboot.redis.serializer
  243. jboot.redis.type
  244. jboot.limit.enable
  245. jboot.limit.rule
  246. jboot.limit.fallbackProcesser
  247. jboot.limit.defaultHttpCode
  248. jboot.limit.defaultAjaxContent
  249. jboot.limit.defaultHtmlView