配置

ThinkJS 提供了灵活的配置,可以在不同的模块和不同的项目环境下使用不同的配置,且这些配置在服务启动时就已经生效。

注意:不可将一个 http 请求中的私有值设置到配置中,这将会被下一个 http 设置的值给冲掉。

项目模块

ThinkJS 默认创建的项目是按模块来划分的,可以在每个模块下定义不同的配置。其中 common 模块下定义一些通用的配置,其他模块下配置会继承 common 下的配置。如:home 模块下的最终配置是将 commonhome 模块下配置合并的结果。

项目环境

ThinkJS 默认支持 3 种项目环境,可以根据不同的环境进行配置,以满足不同情况下的配置需要。

  • development 开发环境
  • testing 测试环境
  • production 线上环境
    项目里也可以扩展其他的环境,当前使用哪种环境可以在 入口文件 中设置,设置 env 值即可。

定义配置文件

config/config.js

存放一些基本的配置,如:

  1. export default {
  2. port: 8360,
  3. host: '',
  4. encoding: 'utf-8',
  5. ...
  6. }
config/[name].js

存放具体某个独立功能的配置,如:db.js 为数据库配置,redis 为 redis 配置。

  1. // db.js
  2. export default {
  3. type: 'mysql',
  4. ...
  5. };
config/env/[mode].js

不同项目环境的差异化配置,如:env/development.jsenv/testing.jsenv/production.js

  1. // config/env/development.js
  2. export default {
  3. port: 7777,
  4. db: { //开发模式下数据库配置
  5. type: 'mysql',
  6. adapter: {
  7. mysql: {
  8. host: '127.0.0.1',
  9. port: '',
  10. }
  11. }
  12. ...
  13. }
  14. }

:不同项目环境差异化配置一般不是很多,所以放在一个文件中定义。这时候如果要修改一个独立功能的配置,就需要将独立功能对应的 key 带上。如:上述代码里的修改数据库配置需要将数据库对应的名称 db 带上。

config/locale/[lang].js

国际化语言包配置,如: locale/en.jslocale/zh-cn.js


配置格式采用 key: value 的形式,并且 key 不区分大小写。

加载配置文件

框架支持多种级别的配置文件,会按以下顺序进行读取:

框架默认的配置 -> 项目模式下框架配置 -> 项目公共配置 -> 项目模式下的公共配置 -> 模块下的配置

配置读取

通过 config 方法获取

在 Controller,Logic,Middleware 等地方可以通过 this.config 来获取。如:

  1. let db = this.config('db'); //读取数据库的所有配置
  2. let host = this.config('db.host'); //读取数据库的 host 配置,等同于 db.host

通过 http 对象上的 config 方法获取

http 对象也有 config 方法用来获取相关的配置,如:

  1. let db = http.config('db');

其他地方配置读取

其他地方可以通过 think.config 来读取相关的配置:

  1. let db = think.config('db'); //读取通用模块下的数据库配置
  2. let db1 = think.config('db', undefined, 'home'); //获取 home 模块下数据库配置

:路由解析前,无法通过 config 方法或者 http 对象上的 config 方法来获取非通用模块下的配置,所以路由解析前就使用的配置需要定义在通用模块里。

系统默认配置

env

项目模式下的配置,config/env/development.js

  1. export default {
  2. auto_reload: true,
  3. log_request: true,
  4. gc: {
  5. on: false
  6. },
  7. error: {
  8. detail: true
  9. }
  10. }

config/env/testing.jsconfig/env/produciton.js 无默认配置。

locale

国际化语言包配置,默认的配置如下:

  1. // config/locale/en.js
  2. export default {
  3. CONTROLLER_NOT_FOUND: 'controller `%s` not found. url is `%s`.',
  4. CONTROLLER_INVALID: 'controller `%s` is not valid. url is `%s`',
  5. ACTION_NOT_FOUND: 'action `%s` not found. url is `%s`',
  6. ACTION_INVALID: 'action `%s` is not valid. url is `%s`',
  7. WORKER_DIED: 'worker `%d` died, it will auto restart.',
  8. MIDDLEWARE_NOT_FOUND: 'middleware `%s` not found',
  9. ADAPTER_NOT_FOUND: 'adapter `%s` not found',
  10. GCTYPE_MUST_SET: 'instance must have gcType property',
  11. CONFIG_NOT_FUNCTION: 'config `%s` is not a function',
  12. CONFIG_NOT_VALID: 'config `%s` is not valid',
  13. PATH_EMPTY: '`%s` path muse be set',
  14. PATH_NOT_EXIST: '`%s` is not exist',
  15. TEMPLATE_NOT_EXIST: 'can\'t find template file `%s`',
  16. PARAMS_EMPTY: 'params `%s` value can\'t empty',
  17. PARAMS_NOT_VALID: 'params `{name}` value not valid',
  18. FIELD_KEY_NOT_VALID: 'field `%s` in where condition is not valid',
  19. DATA_EMPTY: 'data can not be empty',
  20. MISS_WHERE_CONDITION: 'miss where condition',
  21. INVALID_WHERE_CONDITION_KEY: 'where condition key is not valid',
  22. WHERE_CONDITION_INVALID: 'where condition `%s`:`%s` is not valid',
  23. TABLE_NO_COLUMNS: 'table `%s` has no columns',
  24. NOT_SUPPORT_TRANSACTION: 'table engine is not support transaction',
  25. DATA_MUST_BE_ARRAY: 'data is not an array list',
  26. PARAMS_TYPE_INVALID: 'params `{name}` type invalid',
  27. DISALLOW_PORT: 'proxy on, cannot visit with port',
  28. SERVICE_UNAVAILABLE: 'Service Unavailable',
  29. validate_required: '{name} can not be blank',
  30. validate_contains: '{name} need contains {args}',
  31. validate_equals: '{name} need match {args}',
  32. validate_different: '{name} nedd not match {args}',
  33. validate_after: '{name} need a date that\'s after the {args} (defaults to now)',
  34. validate_alpha: '{name} need contains only letters (a-zA-Z)',
  35. validate_alphaDash: '{name} need contains only letters and dashes(a-zA-Z_)',
  36. validate_alphaNumeric: '{name} need contains only letters and numeric(a-zA-Z0-9)',
  37. validate_alphaNumericDash: '{name} need contains only letters, numeric and dash(a-zA-Z0-9_)',
  38. validate_ascii: '{name} need contains ASCII chars only',
  39. validate_base64: '{name} need a valid base64 encoded',
  40. validate_before: '{name} need a date that\'s before the {args} (defaults to now)',
  41. validate_byteLength: '{name} need length (in bytes) falls in {args}',
  42. validate_creditcard: '{name} need a valid credit card',
  43. validate_currency: '{name} need a valid currency amount',
  44. validate_date: '{name} need a date',
  45. validate_decimal: '{name} need a decimal number',
  46. validate_divisibleBy: '{name} need a number that\'s divisible by {args}',
  47. validate_email: '{name} need an email',
  48. validate_fqdn: '{name} need a fully qualified domain name',
  49. validate_float: '{name} need a float in {args}',
  50. validate_fullWidth: '{name} need contains any full-width chars',
  51. validate_halfWidth: '{name} need contains any half-width chars',
  52. validate_hexColor: '{name} need a hexadecimal color',
  53. validate_hex: '{name} need a hexadecimal number',
  54. validate_ip: '{name} need an IP (version 4 or 6)',
  55. validate_ip4: '{name} need an IP (version 4)',
  56. validate_ip6: '{name} need an IP (version 6)',
  57. validate_isbn: '{name} need an ISBN (version 10 or 13)',
  58. validate_isin: '{name} need an ISIN (stock/security identifier)',
  59. validate_iso8601: '{name} need a valid ISO 8601 date',
  60. validate_in: '{name} need in an array of {args}',
  61. validate_notIn: '{name} need not in an array of {args}',
  62. validate_int: '{name} need an integer',
  63. validate_min: '{name} need an integer greater than {args}',
  64. validate_max: '{name} need an integer less than {args}',
  65. validate_length: '{name} need length falls in {args}',
  66. validate_minLength: '{name} need length is max than {args}',
  67. validate_maxLength: '{name} need length is min than {args}',
  68. validate_lowercase: '{name} need is lowercase',
  69. validate_mobile: '{name} need is a mobile phone number',
  70. validate_mongoId: '{name} need is a valid hex-encoded representation of a MongoDB ObjectId',
  71. validate_multibyte: '{name} need contains one or more multibyte chars',
  72. validate_url: '{name} need an URL',
  73. validate_uppercase: '{name} need uppercase',
  74. validate_variableWidth: '{name} need contains a mixture of full and half-width chars',
  75. validate_order: '{name} need a valid sql order string',
  76. validate_field: '{name} need a valid sql field string',
  77. validate_image: '{name} need a valid image file',
  78. validate_startWith: '{name} need start with {args}',
  79. validate_endWidth: '{name} need end with {args}',
  80. validate_string: '{name} need a string',
  81. validate_array: '{name} need an array',
  82. validate_boolean: '{name} need a boolean',
  83. validate_object: '{name} need an object'
  84. }

config

基本配置,config/config.js

  1. export default {
  2. port: 8360, //服务监听的端口
  3. host: '', //服务监听的 host
  4. encoding: 'utf-8', //项目编码
  5. pathname_prefix: '', //pathname 去除的前缀,路由解析中使用
  6. pathname_suffix: '.html', //pathname 去除的后缀,路由解析中使用
  7. hook_on: true, //是否开启 hook
  8. cluster_on: false, //是否开启 cluster
  9. timeout: 120, //120 seconds
  10. auto_reload: false, //自动重新加载修改的文件,development 模式下使用
  11. resource_on: true, // 是否处理静态资源请求, porxy_on 开启下可以关闭该配置
  12. resource_reg: /^(static\/|[^\/]+\.(?!js|html)\w+$)/, //静态资源的正则
  13. route_on: true, //是否开启自定义路由
  14. log_error: true, //是否打印错误日志
  15. log_request: false, //是否打印请求的日志
  16. create_server: undefined, //自定义启动服务
  17. output_content: undefined, //自定义输出内容处理方式,可以进行 gzip 处理等
  18. deny_module_list: [], //禁用的模块列表
  19. default_module: 'home', //默认模块
  20. default_controller: 'index', //默认的控制器
  21. default_action: 'index', //默认的 Action
  22. callback_name: 'callback', //jsonp 请求的 callback 名称
  23. json_content_type: 'application/json', //json 输出时设置的 Content-Type
  24. }

cache

缓存配置,config/cache.js

  1. export default {
  2. type: 'file', //缓存方式
  3. adapter: {
  4. file: {
  5. timeout: 6 * 3600, //6 hours
  6. path: think.RUNTIME_PATH + '/cache', //文件缓存模式下缓存内容存放的目录
  7. path_depth: 2, //子目录深度
  8. file_ext: '.json' //缓存文件的扩展名
  9. },
  10. redis: {
  11. prefix: 'thinkjs_', //缓存名称前缀
  12. }
  13. }
  14. };

cookie 配置,config/cookie.js

  1. export default {
  2. domain: '', // cookie domain
  3. path: '/', // cookie path
  4. httponly: false, //是否 httponly
  5. secure: false, //是否在 https 下使用
  6. timeout: 0 //cookie 有效时间
  7. };

db

数据库配置,config/db.js

  1. export default {
  2. type: 'mysql', //数据库类型
  3. log_sql: true, //是否记录 sql 语句
  4. log_connect: true, // 是否记录连接数据库的信息
  5. adapter: {
  6. mysql: {
  7. host: '127.0.0.1', //数据库 host
  8. port: '', //端口
  9. database: '', //数据库名称
  10. user: '', //账号
  11. password: '', //密码
  12. prefix: 'think_', //数据表前缀
  13. encoding: 'utf8', //数据库编码
  14. nums_per_page: 10, //一页默认条数
  15. }
  16. }
  17. };

error

错误信息配置,config/error.js

  1. export default {
  2. key: 'errno', //error number
  3. msg: 'errmsg', //error message
  4. value: 1000 //default errno
  5. };

gc

缓存、Session等垃圾处理配置,config/gc.js

  1. export default {
  2. on: true, //是否开启垃圾回收处理
  3. interval: 3600, // 处理时间间隔,默认为一个小时
  4. filter: function(){ //如果返回 true,则进行垃圾回收处理
  5. let hour = (new Date()).getHours();
  6. if(hour === 4){
  7. return true;
  8. }
  9. }
  10. };

hook

hook 配置,config/hook.js

  1. export default {
  2. request_begin: [],
  3. payload_parse: ['parse_form_payload', 'parse_single_file_payload', 'parse_json_payload', 'parse_querystring_payload'],
  4. payload_validate: ['validate_payload'],
  5. resource: ['check_resource', 'output_resource'],
  6. route_parse: ['rewrite_pathname', 'parse_route'],
  7. logic_before: [],
  8. logic_after: [],
  9. controller_before: [],
  10. controller_after: [],
  11. view_before: [],
  12. view_template: ['locate_template'],
  13. view_parse: ['parse_template'],
  14. view_filter: [],
  15. view_after: [],
  16. response_end: []
  17. };

post

post 请求时的配置,config/post.js

  1. export default {
  2. json_content_type: ['application/json'],
  3. max_file_size: 1024 * 1024 * 1024, //1G
  4. max_fields: 100,
  5. max_fields_size: 2 * 1024 * 1024, //2M,
  6. ajax_filename_header: 'x-filename',
  7. file_upload_path: think.RUNTIME_PATH + '/upload',
  8. file_auto_remove: true
  9. };

redis

redis 配置,config/redis.js

  1. export default {
  2. host: '127.0.0.1',
  3. port: 6379,
  4. password: '',
  5. timeout: 0,
  6. log_connect: true
  7. };

memcache

memcache 配置,config/memcache.js

  1. export default {
  2. host: '127.0.0.1', //memcache host
  3. port: 11211,
  4. username: '', //
  5. password: '',
  6. timeout: 0, //缓存失效时间
  7. log_connect: true
  8. };

session

session 配置,config/session.js

  1. export default {
  2. name: 'thinkjs',
  3. type: 'file',
  4. path: think.RUNTIME_PATH + '/session',
  5. secret: '',
  6. timeout: 24 * 3600,
  7. cookie: { // cookie options
  8. length: 32
  9. }
  10. };

view

视图配置,config/view.js

  1. export default {
  2. content_type: 'text/html',
  3. file_ext: '.html',
  4. file_depr: '_',
  5. root_path: '',
  6. type: 'ejs',
  7. adapter: {
  8. ejs: {
  9. }
  10. }
  11. };

websocket

websocket 配置,config/websocket.js

  1. export default {
  2. on: false, //是否开启 websocket
  3. type: 'think', //websocket 使用的库
  4. allow_origin: '',
  5. sub_protocal: '',
  6. adapter: undefined,
  7. path: '', //url path for websocket
  8. messages: {
  9. // open: 'home/websocket/open',
  10. }
  11. };

扩展配置

项目里可以根据需要扩展配置,扩展配置只需在 src/common/config/ 建立对应的文件即可,如:

  1. // src/common/config/foo.js
  2. export default {
  3. name: 'bar'
  4. }

这样就可以通过 think.config('foo') 来获取对应的配置了。

原文: https://thinkjs.org/zh-cn/doc/2.1/config.html