附录

默认配置

  /**
 * 框架默认配置
 * 可以在 App/Conf/config.js 里修改下面的配置值
 * @type {Object}
 */
module.exports = {
  port: 8360, // 监听端口
  host: '', // 监听的 host
  use_proxy: false, // 是否使用代理访问,如:nginx。开启后不能通过 ip+ 端口直接访问
  encoding: 'utf-8', // 输出数据的编码
  url_pathname_prefix: '',  // 不解析的 pathname 前缀
  url_pathname_suffix: '.html', // 不解析的 pathname 后缀,这样利于 seo
  app_tag_on: true, // 是否支持标签功能
  url_resource_on: true,  // 是否监听静态资源类请求
  url_resource_reg: /^(resource\/|static\/|favicon\.ico|robots\.txt)/, // 判断是否是静态资源的正则
  url_route_on: true, // 是否开启自定义路由功能
  filter_data: true, // 主要是安全过滤,强烈建议开启

  post_json_content_type: ['application/json'], //post 数据为 json 时的 content-type
  post_max_file_size: 1024 * 1024 * 1024, // 上传文件大小限制,默认 1G
  post_max_fields: 100, // 最大表单数,默认为 100
  post_max_fields_size: 2 * 1024 * 1024, // 单个表单长度最大值,默认为 2MB
  post_ajax_filename_header: 'x-filename', // 通过 ajax 上传文件时文件名对应的 header,如果有这个 header 表示是文件上传
  post_file_upload_path: APP_PATH + '/Runtime/Temp', // 文件上传的临时目录

  app_group_list: ['Home', 'Admin', 'Restful'], // 分组列表
  deny_group_list: [],
  default_group: 'Home', // 默认分组
  default_controller: 'Index', // 默认模块
  default_action: 'index',  // 默认 Action
  call_controller: 'Home:Index:_404', //controller 不存在时执行方法,此配置表示调用 Home 分组下 IndexController 的_404Action 方法
  call_method: '__call', // 当找不到方法时调用什么方法,这个方法存在时才有效
  before_action: '__before', // 调用一个 action 前调用的方法,会将 action 名传递进去
  after_action: '__after', // 调用一个 action 之后调用的方法,会将 action 名传递进去
  url_params_bind: true, // 方法参数绑定, 将 URL 参数值绑定到 action 的参数上
  action_suffix: 'Action', //action 后缀
  url_callback_name: 'callback', //jsonp 格式的 callback 名字
  json_content_type: 'application/json', // 发送 json 时的 content-type
  auto_send_content_type: true, // 是否自动发送 Content-Type, 默认值为 `tpl_content_type` 配置值
  log_process_pid: true, // 记录进程的 id, 方便其他脚本处理。
  use_cluster: false, // 是否使用 cluster,默认不使用,0:为 cpu 的数量,可以自定义值
  autoload_path: {}, //autoload 查找的 path,用于 thinkRequire 加载自定义库的时候查找
  create_server_fn: '', // 自定义 create server 全局函数名,可以在 Common/common.js 里实现

  restful_group: 'Restful', //RESTFUL API 默认分组

  load_ext_config: [], // 加载额外的配置文件 CONF_PATH
  load_ext_file: [], // 加载额外的文件 COMMON_PATH

  use_websocket: false, // 是否使用 websocket
  websocket_allow_origin: '', // 允许从那里发送过来的 websocket,可以是字符串、数组、回调函数,为空表示不检测
  websocket_sub_protocal: '', //websocket 子协议,可以是个字符串也可以是回调函数
  websocket_message_handle: undefined, //websocket 消息处理函数

  error_tpl_path: THINK_PATH + '/View/error.html', // 错误页模版
  error_code: 500, // 报错时的状态码
  error_no_key: 'errno', // 错误号的 key
  error_no_default_value: 1000, // 错误号默认值
  error_msg_key: 'errmsg', // 错误消息的 key

  cookie_domain: '', //cookie 有效域名
  cookie_path: '/',   //cookie 路径
  cookie_timeout: 0, //cookie 失效时间,0 为浏览器关闭,单位:秒

  session_name: 'ThinkJS', //session 对应的 cookie 名称
  session_type: 'File', //session 存储类型, 空为内存,还可以为 File
  session_path: '', //File 类型下文件存储位置,默认为系统的 tmp 目录
  session_options: {}, //session 对应的 cookie 选项
  session_sign: '', //session 对应的 cookie 使用签名
  session_timeout: 24 * 3600, // 服务器上 session 失效时间,单位:秒

  db_type: 'mysql', // 数据库类型
  db_host: '127.0.0.1', // 服务器地址
  db_port: '', // 端口
  db_name: '', // 数据库名
  db_user: 'root', // 用户名
  db_pwd: '', // 密码
  db_prefix: 'think_', // 数据库表前缀
  db_charset: 'utf8', // 数据库编码默认采用 utf8
  db_ext_config: {}, // 数据库连接时候额外的参数
  db_fieldtype_check: false, // 是否进行字段类型检查
  db_fields_cache: true, // 启用字段缓存
  db_nums_per_page: 20, // 默认每页显示的条数
  db_like_fields: [], // 自动进行模糊查询,| 连接,如: ['title', 'content']
  db_cache_on: true, // 是否启用查询缓存,如果关闭那么 cache 方法则无效
  db_cache_type: '', // 缓存类型,默认为内存缓存
  db_cache_path: CACHE_PATH + '/db', // 缓存路径,File 类型下有效
  db_cache_timeout: 3600, // 缓存时间,默认为 1 个小时
  db_log_sql: false, // 是否打印 sql 语句
  db_buffer_tostring: true, // 是否将 buffer 转为字符串

  tpl_content_type: 'text/html', // 模版输出类型
  tpl_file_suffix: '.html', // 模版文件名后缀
  tpl_file_depr: '_', //controller 和 action 之间的分隔符
  tpl_engine_type: 'ejs', // 模版引擎名称
  tpl_engine_config: {}, 

  token_on: false, // 是否开启 token 功能
  token_name: 'token', //token name
  token_key: '{__TOKEN__}', // 记录 token 在模版中的位置替换用。默认自动查找 <form 和 </head> 标签替换

  log_console: false, // 是否记录日志,开启后会重写 console.error 等系列方法
  log_console_path: LOG_PATH + '/console', // 日志文件存放路径
  log_console_type: ['error'], // 默认只接管 console.error 日志
  log_memory: false, // 记录内存使用和负载
  log_memory_path: LOG_PATH + '/memory', // 日志文件存放路径
  log_memory_interval: 60 * 1000, // 一分钟记录一次

  cache_type: 'File', // 数据缓存类型
  cache_key_prefix: '__ThinkJS__', // 缓存 key 前置 (memcache 和 redis 下有效)
  cache_timeout: 6 * 3600, // 数据缓存有效期,单位: 秒
  cache_path: CACHE_PATH,  // 缓存路径设置 (File 缓存方式有效)
  cache_file_suffix: '.json', //File 缓存方式下文件后缀名
  cache_gc_hour: [4], // 缓存清除的时间点,数据为小时

  html_cache_on: false, //HTML 静态缓存
  html_cache_timeout: 3600, // 缓存时间,单位为秒
  html_cache_rules: {}, // 缓存规则
  html_cache_path: CACHE_PATH + '/html',
  html_cache_file_callback: undefined, // 生成缓存文件的回调函数
  html_cache_file_suffix: '.html', // 缓存文件后缀名

  memcache_host: '127.0.0.1', //memcache host
  memcache_port: 11211, //memecache 端口

  redis_host: '127.0.0.1', //redis host
  redis_port: 6379, // redis port
};

这些配置的值都可以在 App/Conf/config.js 文件里重新设置。

系统常量

系统里定义很多系统常量,方便在项目中使用。

  • APP_DEBUG 开启调试,开发中使用,上线后需要关闭
  • APP_MODE 运行模式
  • THINK_PATH ThinkJS 库的目录
  • THINK_VERSION 当前 ThinkJS 的版本
  • THINK_LIB_PATH ThinkJS 的 lib 路径
  • THINK_EXTEND_PATH ThinkJS 的扩展路径
  • APP_PATH 项目 App 路径,如:/home/welefen/www.test.com/App
  • COMMON_PATH Common 路径,对应为 App/Common
  • LIB_PATH Lib 路径,对应为 App/Lib
  • CONF_PATH 配置路径,对应为 App/Conf
  • VIEW_PATH 模版路径,对应为 App/View
  • RUNTIME_PATH runtime 路径,对应为 App/Runtime
  • DATA_PATH 临时数据路径,对应为 App/Runtime/Data
  • CACHE_PATH 缓存路径,对应为 App/Runtime/Cache
  • RESOURCE_PATH 资源路径,对应为 /www
如发现文档中的错误,请点击这里修改本文档,修改完成后请 pull request,我们会尽快合并、更新。