1. 源码简介

官网简介：Easily load and persist config without having to think about where and how
翻译：轻松加载和保持配置，而不必考虑在哪里以及如何加载和保持。
其实就是方便加载和持久化用户配置。它会在用户配置目录下生成对应的json文件。

2. 使用

  1. import Configstore from 'configstore';
  3. const packageJson = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
  5. // 实例化配置存储实例
  6. const config = new Configstore(packageJson.name, {foo: 'bar'});
  7. // get方法获取配置
  8. console.log(config.get('foo')); //=> 'bar'
  10. // set方法设置配置
  11. config.set('awesome', true);
  12. console.log(config.get('awesome')); //=> true
  15. // 设置嵌套属性
  16. config.set('bar.baz', true);
  17. console.log(config.get('bar')); //=> {baz: true}
  19. // 删除属性
  20. config.delete('awesome');
  21. console.log(config.get('awesome')); //=> undefined

3. 读源码

源码大概100来行，源码链接：

这里用到了一些没怎么见过的依赖包，奇奇怪怪可可爱爱：

  1. // 是fs模块的增强版，旨在规范跨不同平台和环境的行为，并使文件系统访问对错误更友好
  2. import fs from 'graceful-fs';
  3. // 获取 XDG 基本目录路径，xdgConfig 是用户特定配置文件的目录(这个包适用于Linux)
  4. import { xdgConfig } from 'xdg-basedir';
  5. // fs.writeFile这个API的扩展包，使得它的操作是原子性的，且允许设置所有权
  6. import writeFileAtomic from 'write-file-atomic';
  7. // 从嵌套对象中获取、设置或删除属性
  8. import dotProp from 'dot-prop';
  9. // 生成唯一的随机字符串
  10. import uniqueString from 'unique-string';

引入包之后就是一些全局配置了：

  1. // 如果是linux，获取xdgConfig；
  2. // 否则 os.tmpdir() 操作系统默认的临时文件的目录，uniqueString() 唯一字符串
  3. // 总之就是获取目录
  4. const configDirectory = xdgConfig || path.join(os.tmpdir(), uniqueString());
  5. // error 提示信息
  6. const permissionError = 'You don\'t have access to this file.';
  7. // 这里两个配置都是关于读写文件权限，这里是用八进制表示，options可以参考node读写文件配置
  8. const mkdirOptions = {mode: 0o0700, recursive: true};
  9. const writeFileOptions = {mode: 0o0600};

image.png

Configstore 构造函数源码

  1. export default class Configstore {
  2.   constructor(id, defaults, options = {}) {
  3.     // 设置文件前缀路径
  4.     const pathPrefix = options.globalConfigPath ? path.join(id, 'config.json') : path.join('configstore', `${id}.json`);
  5.     // 最终存储在本地的文件路径
  6.     this._path = options.configPath || path.join(configDirectory, pathPrefix);
  8.     // defaults的意思是创建Store的时候就赋值
  9.     if (defaults) {
  10.       // 对all属性赋值，会触发下面all属性的set方法
  11.       this.all = {
  12.         ...defaults,
  13.         ...this.all
  14.       };
  15.     }
  16.   }
  18.   // all属性的get方法
  19.   get all() {
  20.     try {
  21.       // 直接读取本地文件
  22.       return JSON.parse(fs.readFileSync(this._path, 'utf8'));
  23.     } catch (error) {
  24.       // / 如果不存在，返回空对象
  25.       if (error.code === 'ENOENT') {
  26.         return {};
  27.       }
  29.       // 如果没有读取权限，赋值错误信息
  30.       if (error.code === 'EACCES') {
  31.         error.message = `${error.message}\n${permissionError}\n`;
  32.       }
  34.       // 如果是无效的json文件，清空文件，返回空对象
  35.       if (error.name === 'SyntaxError') {
  36.         writeFileAtomic.sync(this._path, '', writeFileOptions);
  37.         return {};
  38.       }
  40.       // 抛出错误
  41.       throw error;
  42.     }
  43.   }
  45.   // all属性的set方法
  46.   set all(value) {
  47.     try {
  48.       /// 确保目录存在
  49.       fs.mkdirSync(path.dirname(this._path), mkdirOptions);
  50.       // 写入文件
  51.       // 注意这里的JSON.stringify(value, undefined, '\t')
  52.       // MDN链接：https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
  53.       writeFileAtomic.sync(this._path, JSON.stringify(value, undefined, '\t'), writeFileOptions);
  54.     } catch (error) {
  55.       if (error.code === 'EACCES') {
  56.         error.message = `${error.message}\n${permissionError}\n`;
  57.       }
  58.       throw error;
  59.     }
  60.   }
  62.   // all对象键的length
  63.   get size() {
  64.     return Object.keys(this.all || {}).length;
  65.   }
  67.   // configstore的get方法，其实就是传入key返回对应的值
  68.   get(key) {
  69.     return dotProp.get(this.all, key);
  70.   }
  72.   set(key, value) {
  73.     const config = this.all;
  74.     // 这里做了一个重载
  75.     // 如果只传了一个参数(key)，例如这个情况 config.set({foo: 'bar'})
  76.     if (arguments.length === 1) {
  77.       // 表示这个key是一个对象，循环这个对象赋值到config对象(也就是this.all)上
  78.       for (const k of Object.keys(key)) {
  79.         dotProp.set(config, k, key[k]);
  80.       }
  81.     } else {
  82.       dotProp.set(config, key, value);
  83.     }
  85.     this.all = config;
  86.   }
  88.   // 判断有没有这个属性值
  89.   has(key) {
  90.     return dotProp.has(this.all, key);
  91.   }
  93.   // 删除键值
  94.   delete(key) {
  95.     const config = this.all;
  96.     // 删除对应的键值
  97.     dotProp.delete(config, key);
  98.     this.all = config;
  99.   }
  101.   // 清空
  102.   clear() {
  103.     this.all = {};
  104.   }
  106.   // 获取文件路径path
  107.   get path() {
  108.     return this._path;
  109.   }
  110. }

4. 总结和收获

读完源码之后，我们会发现这是一个方便持久化和获取值的包，这里持久化的位置是在用户目录，所以它的使用场景可能是在服务端或者客户端(浏览器端没有读取文件的权限)。
configstore.png
收获：

  • 通过触发对象 all 的 get( )和 set() ，来做一些额外的操作
  • dot-prop 这个包能快速读取/设置/删除嵌套属性的值
  • fs模块的替代包：graceful-fs
  • fs.writeFile的扩展包：write-file-atomic
  • JSON.stringfy() 第二第三个参数