模块化-工程设计详细文档

工程设计详细文档

1.什么是模块化?

模块化: 简单来说一个js文件可以引入另一个js文件中，遵守固定的规则，把一个大文件拆成独立并互相依赖的多个小模块

2 把代码进行模块化拆分的好处：

• 提高了代码的复用性
• 提高了代码的可维护性
• 可以实现按需加载

3 Node.js 中模块的分类**

Node.js 中根据模块来源的不同，将模块分为了 3 大类，分别是：

• 内置模块（内置模块是由 Node.js 官方提供的，例如 fs、path、http 等）
• 自定义模块（用户创建的每个 .js 文件，都是自定义模块）
• 第三方模块（由第三方开发出来的模块，并非官方提供的内置模块，也不是用户创建的自定义模块，使用前需要先下载）

4 文件目录

|--app                           服务端所有代码  
   |--controls                   接口处理函数
      |--index.js                入口文件,将所有的接口处理函数模块 导入到入口中
      |--module                  接口处理函数模块,处理各种业务
         |--*.js                 业务模块
   |--DB                         数据库连接目录
      |--index.js                数据库连接文件
   |--repositories               发送数据请求的目录
      |--index.js                入口文件
      |--module                  数据库模块
         |-- *.js                处理表明
   |--route                      路由目录
      |--index.js                路由入口文件
      |--config.js               路由配置文件
   |--verticafiction             接口中需要验证的参数目录
      |--method                  验证数据方法模块集合
         |-- *.js                验证数据方法模块
      |--*.js                    验证数据的配置文件
   |--middle                     自定义的中间件
      |-- *.js                   中间件模块
      
|--public                        部署前端代码,前端代码将来发布这个文件下
|--uploads                       管理上传的讲台资源
|--app.js                        程序的入口文件
|--package.json                  npm工程的配置文件
|--REAME.md                      项目的说明文件

respositories

有几个表就创建几个js文件

5 Node.js 中的模块作用域

• 什么是模块作用域

和函数作用域类似，在自定义模块中定义的变量、方法等成员，只能在当前模块内被访问，这种模块级别的访问限制，叫做模块作用域。

• 模块作用域的好处

防止了全局变量污染的问题(如果用script标签导入两个js文件且两个文件中都定义了同一个变量，则前一个会被后一个覆盖)

6 向外共享模块作用域中的成员

6.1.module 对象

在每个 .js 自定义模块中都有一个 module 对象，它里面存储了和当前模块有关的信息，

6.2.module.exports 对象

在自定义模块中，可以使用 module.exports 对象，将模块内的成员共享出去，供外界使用。

外界用 require() 方法导入自定义模块时，得到的就是 module.exports 所指向的对象。

6.3、共享成员时的注意点

使用 require() 方法导入模块时，导入的结果，永远以 module.exports 指向的对象为准。

6.4. exports 对象

由于 module.exports 单词写起来比较复杂，为了简化向外共享成员的代码，Node 提供了 exports 对象。默认情况下，exports 和 module.exports 指向同一个对象。最终共享的结果，还是以 module.exports 指向的对象为准。

6.5.exports 和 module.exports 的使用误区

时刻谨记，require() 模块时，得到的永远是 module.exports 指向的对象

• 总结

  exports 和 module.exports本来指向同一个对象。仅仅通过挂载数据指向的还是同一个对象，通过exports挂载的数据也可以被require模块得到。如果一方赋值(指向另一个对象，那么他们就不指向同一对象了，而require模块得到的是module.exports 指向的对象，所以一旦一方改变指向，require模块就不会得到exports的值。)

  注意： 为了防止混乱，建议大家不要在同一个模块中同时使用 exports 和 module.exports

6.6 Node.js 中的模块化规范

Node.js 遵循了 CommonJS 模块化规范，CommonJS 规定了模块的特性和各模块之间如何相互依赖。

补充：什么是CommonJS

我们知道Node.js的实现让js也可以成为后端开发语言，
但在早先Node.js开发过程中，它的作者发现在js中并没有像其他后端语言一样有包引入和模块系统的机制。
这就意味着js的所有变量，函数都在全局中定义。这样不但会污染全局变量，更会导致暴露函数内部细节等问题。

CommonJS组织也意识到了同样的问题，于是 CommonJS组织创造了一套js模块系统的规范。我们现在所说的CommonJS指的就是这个规范。

CommonJS 规定：

（1）每个模块内部，module 变量代表当前模块。

（2）module 变量是一个对象，它的 exports 属性（即 module.exports）是对外的接口。

（3）加载某个模块，其实是加载该模块的 module.exports 属性。require() 方法用于加载模块。