ThinkJS development config example tutorial

Define configuration files by module

thinkjs allows developers to configure their own parameters directly undersrc/common/config/and directly add js files. The file name only needs to comply with json The attribute name is required, and the file content follows the following format:

// 新增文件 assets.js 键入如下内容'use strict';export default { // key: value};

The file content only needs to conform to the definition of a json object format. Let’s look at a log4js configuration definition:

// log4js.js'use strict';export default { appenders: [{ type : "console", category: "console"},// 定义一个日志记录器{ type : "dateFile", // 日志文件类型，可以使用日期作为文件名的占位符 filename : "logs/", // 日志文件名，可以设置相对路径或绝对路径 pattern : "debug/yyyyMMddhh.txt", // 占位符，紧跟在filename后面 absolute : true, // filename是否绝对路径 alwaysIncludePattern: true, // 文件名是否始终包含占位符 category : "logInfo" // 记录器名} ], levels : {logInfo: "DEBUG" } // 设置记录器的默认显示级别，低于这个级别的日志，不会输出}

Configuration files are static settings and generally store setting parameters that do not change frequently (of course, the values of configuration parameters can be changed in memory, as detailed below illustrate).

In addition, the configuration file is a js file that exports variable definitions in ES6 format, not a json file. The advantage here is that you can add comments starting with //.

If you are careful, you must have discovered: In addition tosrc/common/config, there is also aconfigfile under thesrc/home/module folder.

Generally speaking, it is more reasonable to define and arrange according to the scope of the configuration file.

For example: configurations used by all modules are more appropriate to be placed undersrc/common/config, while configurations used only for the home module are placed undersrc/home/ configThe following is more appropriate.

When there are too many configuration files, we need to pay attention to the loading order of multiple configuration files.

Configuration file loading sequence

The official website describes the configuration file loading sequence as follows:

Framework default configuration-> Framework configuration in project mode -> Project public configuration -> Public configuration in project mode -> Configuration under module

Let me ask a question first: Where do these five configurations refer to?

The first two can be ignored. They are the configuration settings of the thinkjs framework itself. Usually there are no configuration parameters that our project will use.

The third and fourth are the default config configuration folders under different project creation modes (for project creation modes, see Node.js Domestic MVC Framework ThinkJS Development Introduction (Jingxiu.com)), the location In:

# normal modethinkjs_normal/src/config/*# module modethinkjs_module/src/common/config/*

The last one refers to the project in module mode. Each module has its own config, located at:

thinkjs_module/src/home/config/*

It should be noted that multiple configuration files will eventually be loaded when thinkjs is running andmerged together(note the bold text).

So when there are multiple configuration files, you need to pay attention toThe key (i.e. attribute name) of the configuration parameter should not be repeated, because according to the loading order, the value of the key loaded later will overwrite the first one. The value of the loaded key leads to undesired results.

Tip: The tutorial mainly explains the development method in module mode.

Automatically switch configuration files

As mentioned earlier, we can place the configuration file undersrc/common/config. All configuration parameters can be placed in one file, or can be spread across multiple files.

There is a common scenario that I believe every developer will encounter:

Some configuration parameters are only used for local development, and some are only used for online operation. When the development was completed and continuous integration was being done, when the configuration parameters were uploaded, it was found that the development parameters and online parameters were mixed together. . .

thinkjs provides three configuration parameter environments undersrc/common/config/env/, namely development configurationdevelopmentand production configurationproduction, test configurationtesting, can save our continuous integration.

We can divide the project configuration into three parameters with the same attribute name and place them in different configuration environments. In this way, thinkjs automatically loads the development configuration during local development, and the production configuration is loaded online after continuous integration. , is it very convenient~

Development configuration

The development configuration file is:src/common/config/env/development.js

As before As mentioned, the development configuration is suitable for local development, so how does thinkjs know which environment it is now?

The answer is: It has been defined in package.json

{ "scripts": {"start": "node www/development.js?1.1.11","compile": "babel src/ --out-dir app/","watch-compile": "node -e \"console.log(' no longer need, use  command direct.');console.log();\"","watch": "npm run watch-compile" }}

You can see that thescripts.startattribute is defined and we use it directly# When ##npm startis executed, thenode www/development.jscommand is actually executed.

var thinkjs = require('thinkjs');var path = require('path');var rootPath = path.dirname(__dirname);var instance = new thinkjs({ APP_PATH: rootPath + path.sep + 'app', RUNTIME_PATH: rootPath + path.sep + 'runtime', ROOT_PATH: rootPath, RESOURCE_PATH: __dirname, env: 'development' // <-- 这里定义了当前的 thinkjs 实例的运行环境});// Build code from src to app directory.instance.compile({ log: true});instance.run();

src/common/config/├── config.js # 可以放置自己的配置├── db.js # 数据库连接├── env # 运行时配置，下面会详述│ ├── development.js│ ├── production.js│ └── testing.js├── error.js # 错误配置├── hook.js # 钩子配置├── locale # 多语言版配置│ └── en.js├── session.js└── view.js # 视图文件配置

// development.js'use strict';export default { site_name: "", site_title: "", site_keywords: "", site_description: "", db: { // 这里的配置替代 db.jstype : 'mysql',log_sql: true, //是否记录 sql 语句adapter: { mysql: {host : '127.0.0.1',port : '3306',database: '',user : '',password: '',prefix : 'thinkjs_',encoding: 'utf8' }} }, jwt: { // 第三方模块的公共定义options: { algorithm: 'HS128', expiresIn: '7d'} }, pay: {// 定义与在线支付接口相关的参数 }, backend: {// 定义管理后台相关的参数 }, home: {// 定义前端网站相关的参数 }, rest: {// 定义 REST API 相关的参数 }, task: {// 定义 crond 相关的参数 }};

// 配置 development.jslet dbOpt = this.config('db');let jwtOpt = this.config('jwt.options');

// 配置 development.jslet jwtOpt = this.config('jwt.options');console.log(jwtOpt);// 读取成功，打印：// {// options: {// algorithm: 'HS128',// expiresIn: '7d'// }// }let jwtOptAlg = this.config('jwt.options.algorithm');console.log(jwtOptAlg);// 超过三层，读取失败，只能读取到两层内容，打印：// {// options: {// algorithm: 'HS128',// expiresIn: '7d'// }// }jwtOptAlg = jwtOpt['algorithm'];console.log(jwtOptAlg);// 正确的读取方式，打印：// HS128

// 配置文件：src/home/config/assets.jslet siteName = think.config('assets.site_name', undefined, 'home');

// src/common/config/assets.jsexport default { "site_title": "my site"};// src/home/config/assets.jsexport default { "site_title": "my test"};// 两个配置参数属性名一样的情况下// 使用不同的读取方式// 注意 config 方法的上下文对象的不同// 会导致读取的结果的不同// src/home/controller/index.jslet assets = this.config('assets');let siteTitle = assets['site_title'];console.log('siteTitle is: ', siteTitle);// 打印：// my test// src/home/controller/index.jslet assets = think.config('assets', undefined, 'common');let siteTitle = assets['site_title'];console.log('siteTitle is: ', siteTitle);// 打印：// my site

let siteTitle = this.config('assets.site_title');console.log(siteTitle);// 打印：// my testthis.config('assets.site_title', 'test 123');siteTitle = this.config('assets.site_title');console.log(siteTitle);// 打印：// test 123

let siteAuthor = this.config('assets.site_author');console.log(siteAuthor);// 打印：// {// name: 'xxuyou.com',// email: 'cap@xxuyou.com'// }siteAuthor['name'] = 'cap';siteAuthor = this.config('assets.site_author');console.log(siteAuthor);// 打印：// {// name: 'cap',// email: 'cap@xxuyou.com'// }

let siteAuthor = think.extend({}, this.config('assets.site_author')); // <-- 不同点在这里console.log(siteAuthor);// 打印：// {// name: 'xxuyou.com',// email: 'cap@xxuyou.com'// }siteAuthor['name'] = 'cap';siteAuthor = this.config('assets.site_author');console.log(siteAuthor);// 打印：// {// name: 'xxuyou.com',// email: 'cap@xxuyou.com'// }