开源的网易云音乐API项目都是怎么实现的？

站长

2022年09月13日 17:48 · 阅读数 16

上一篇文章这个高颜值的开源第三方网易云音乐播放器你值得拥有介绍了一个开源的第三方网易云音乐播放器，这篇文章我们来详细了解一下其中使用到的网易云音乐api项目NeteaseCloudMusicApi的实现原理。

NeteaseCloudMusicApi使用Node.js开发，主要用到的框架和库有两个，一个Web应用开发框架Express，一个请求库Axios，这两个大家应该都很熟了就不过多介绍了。

创建express应用

项目的入口文件为/app.js：

async function start() {
  require('./server').serveNcmApi({
    checkVersion: true,
  })
}
start()

调用了/server.js文件的serveNcmApi方法，让我们转到这个文件，serveNcmApi方法简化后如下：

async function serveNcmApi(options) {
    const port = Number(options.port || process.env.PORT || '3000')
    const host = options.host || process.env.HOST || ''
    const app = await consturctServer(options.moduleDefs)
    const appExt = app
    appExt.server = app.listen(port, host, () => {
        console.log(`server running @ http://${host ? host : 'localhost'}:${port}`)
    })

    return appExt
}

主要是启动监听指定端口，所以创建应用的主要逻辑在consturctServer方法：

async function consturctServer(moduleDefs) {
    // 创建一个应用
    const app = express()

    // 设置为true，则客户端的IP地址被理解为X-Forwarded-*报头中最左边的条目
    app.set('trust proxy', true)

    /**
   * 配置CORS & 预检请求
   */
    app.use((req, res, next) => {
        if (req.path !== '/' && !req.path.includes('.')) {
            res.set({
                'Access-Control-Allow-Credentials': true, // 跨域情况下，允许客户端携带验证信息，比如cookie，同时，前端发送请求时也需要设置withCredentials: true
                'Access-Control-Allow-Origin': req.headers.origin || '*', // 允许跨域请求的域名，设置为*代表允许所有域名
                'Access-Control-Allow-Headers': 'X-Requested-With,Content-Type', // 用于给预检请求(options)列出服务端允许的自定义标头，如果前端发送的请求中包含自定义的请求标头，且该标头不包含在Access-Control-Allow-Headers中，那么该请求无法成功发起
                'Access-Control-Allow-Methods': 'PUT,POST,GET,DELETE,OPTIONS', // 设置跨域请求允许的请求方法理想
                'Content-Type': 'application/json; charset=utf-8', // 设置响应数据的类型及编码
            })
        }
        // OPTIONS为预检请求，复杂请求会在发送真正的请求前先发送一个预检请求，获取服务器支持的Access-Control-Allow-xxx相关信息，判断后续是否有必要再发送真正的请求，返回状态码204代表请求成功，但是没有内容
        req.method === 'OPTIONS' ? res.status(204).end() : next()
    })
    // ...
}

首先创建了一个Express应用，然后设置为信任代理，在Express里获取ip一般是通过req.ip和req.ips，trust proxy默认值为false，这种情况下req.ips值是空的，当设置为true时，req.ip的值会从请求头X-Forwarded-For上取最左侧的一个值，req.ips则会包含X-Forwarded-For头部的所有ip地址。

X-Forwarded-For头部的格式如下：

X-Forwarded-For: client1, proxy1, proxy2

值通过一个 逗号+空格 把多个ip地址区分开，最左边的client1是最原始客户端的ip地址，代理服务器每成功收到一个请求，就把请求来源ip地址添加到右边。

以上面为例，这个请求通过了两台代理服务器：proxy1和proxy2。请求由client1发出，此时XFF是空的，到了proxy1时，proxy1把client1添加到XFF中，之后请求发往proxy2，通过proxy2的时候，proxy1被添加到XFF中，之后请求发往最终服务器，到达后proxy2被添加到XFF中。

但是伪造这个字段非常容易，所以当代理不可信时，这个字段也不一定可靠，不过正常情况下XFF中最后一个ip地址肯定是最后一个代理服务器的ip地址，这个会比较可靠。

随后设置了跨域响应头，这里的设置就是允许不同域名的网站也能请求成功的关键所在。

继续：

async function consturctServer(moduleDefs) {
    // ...
    /**
   * 解析Cookie
   */
    app.use((req, _, next) => {
        req.cookies = {}
        //;(req.headers.cookie || '').split(/\s*;\s*/).forEach((pair) => { //  Polynomial regular expression //
        // 从请求头中读取cookie，cookie格式为：name=value;name2=value2...，所以先根据;切割为数组
        ;(req.headers.cookie || '').split(/;\s+|(?<!\s)\s+$/g).forEach((pair) => {
            let crack = pair.indexOf('=')
            // 没有值的直接跳过
            if (crack < 1 || crack == pair.length - 1) return
            // 将cookie保存到cookies对象上
            req.cookies[decode(pair.slice(0, crack)).trim()] = decode(
                pair.slice(crack + 1),
            ).trim()
        })
        next()
    })

    /**
   * 请求体解析和文件上传处理
   */
    app.use(express.json())
    app.use(express.urlencoded({ extended: false }))
    app.use(fileUpload())

    /**
   * 将public目录下的文件作为静态文件提供
   */
    app.use(express.static(path.join(__dirname, 'public')))

    /**
   * 缓存请求，两分钟内同样的请求会从缓存里读取数据，不会向网易云音乐服务器发送请求
   */
    app.use(cache('2 minutes', (_, res) => res.statusCode === 200))
    // ...
}