微信小程序 绝对路径 require

1. 什么是微信小程序？

微信小程序是在微信生态系统内的一种新型应用形式，小程序不需要下载安装即可使用，用户扫码或者搜索即可直接打开使用，它具有轻便、开发便捷、开放能力的特点。一个微信小程序类似一个手机 APP，它可以实现类似 APP 的功能，如商城、社交、视频等，同时还支持原生的小程序游戏。

2. 微信小程序的绝对路径 require

在开发微信小程序过程中，为了避免模块名称冲突，会经常使用绝对路径 require。绝对路径 require 是相对于当前小程序根目录的路径，通常可以通过以下方式获取小程序根目录：

let rootPath = wx.env.USER_DATA_PATH.split('/').slice(0, -1).join('/') + '/'

接下来的示例中将会用到这个 rootPath。

2.1 使用

绝对路径 require 的使用非常简单，直接在需要引入模块的地方使用相对于小程序根目录的路径就可以了，例如：

let moduleA = require('/path/to/moduleA')

let moduleB = require('/path/to/moduleB')

2.2 注意事项

在使用绝对路径 require 时，需要注意以下几点：

1. 文件路径之间需要用斜杠 / 分隔，而不是反斜杠 \ 。

因为在 JavaScript 中，反斜杠 \ 通常被用于表示转义字符，例如 \n 表示换行符，在路径中使用会导致错误。

2. 不支持使用相对路径

小程序不支持使用相对路径进行模块引入，因为小程序中的文件结构是不定的，相对路径的结果也是不定的。因此，我们需要使用绝对路径来标识需要引入的模块。

2.3 如何配置引入模块的文件路径

通常情况下，我们需要将要引入的模块放置在小程序根目录下的一个特定目录中，例如 /path/to/lib 目录。为了使得所有文件都能够正确地引入到库目录下的模块，我们需要在小程序的工程配置文件 project.config.json 中进行如下配置：

{

  "miniprogramRoot": "./",
  "appOutput": "./dev",
  "compileType": "miniprogram",
  "lib": {
    "name": "lib",
    "root": [
      "/path/to/lib"
    ]
  }
}

这里，我们在 lib.root 中指定了要引入模块的目录，当我们在绝对路径中使用 /lib/module.js 的时候，它会被解析成小程序根目录加上 lib 中与路径部分相对应的目录，例如 /path/to/lib/module.js。

3. 示例

接下来我们来看一个使用绝对路径 require 的示例，首先我们准备一个模块 lib/a.js：

module.exports = function () {

  console.log('I am a')
}

然后在小程序的根目录下新建一个 app.js 文件，使用相对路径将该模块引入到 app.js 中：

const a = require('./lib/a')

a()

最后，使用绝对路径 require 将该模块引入到 app.js 中：

const rootPath = wx.env.USER_DATA_PATH.split('/').slice(0, -1).join('/') + '/'

const a = require(rootPath + 'path/to/lib/a')
a()

从这个例子中我们可以看出，使用绝对路径 require 可以避免使用相对路径时可能出现的路径问题，并且还可以将库的路径配置在 project.config.json 中，提高代码的可维护性。

4. 总结

绝对路径 require 是小程序开发中常用的一种模块引入方式，它避免了相对路径可能出现的路径问题，同时也提高了代码的可维护性。在使用绝对路径 require 时需要注意路径之间使用的斜杠 /，以及相对路径的不支持等问题。