feat(logger}: 支持更好的日志输出, 完善了文档

Author: MoeFurina

CHANGELOG.MD

@@ -1,4 +1,7 @@
 # 更新日志
+
+## 二开作者注: 这些`commit`记录为原版网易云音乐API的记录, 本项目不会对其进行添加以及修改
+
 ### 4.25.0 | 2024.11.16
 - feat: 增加副歌时间、相关歌单推荐接口，原有相关歌单接口已废弃；fix: 将部分易盾白名单接口替换为eapi [#30](https://gitlab.com/Binaryify/neteasecloudmusicapi/-/merge_requests/30)
 - fix: 播客上传接口 [#32](https://gitlab.com/Binaryify/neteasecloudmusicapi/-/merge_requests/32)

README.MD

@@ -1,4 +1,4 @@
-# 网易云音乐 API Enhanced(Reborn)
+# 网易云音乐 API Enhanced
 
 ---
 
@@ -34,16 +34,18 @@ set PORT=4000 && node app.js  # Windows
 
 ### 重要提示
 
-- 调用前请务必阅读文档的“调用前须知”部分。
+- 调用前请务必阅读文档的 [调用前须知](https://music-api.focalors.ltd/#/?id=%e8%b0%83%e7%94%a8%e5%89%8d%e9%a1%bb%e7%9f%a5) 部分。
 - 推荐将敏感信息（如 cookie）通过部署平台的环境变量进行配置。
 
 ## 在线体验与文档
 
-- [在线文档](https://music-api.focalors.ltd/docs/#)
+- [在线文档](https://music-api.focalors.ltd/)
 - [NPM 包地址](https://www.npmjs.com/package/@neteaseapireborn/api)
 
 ## 常见部署方式
 
+- 推荐参考[在线文档](https://music-api.focalors.ltd/)
+
 ### Vercel 一键部署
 
 1. fork 本项目
@@ -114,4 +116,3 @@ pnpm test
 ## License
 
 [MIT License](https://github.com/IamFurina/NeteaseCloudMusicApiReborn/blob/main/LICENSE)
-console.log(error)

examples/get_static_moddef.js

@@ -1,6 +1,7 @@
 const fsPromises = require('fs/promises')
 const path = require('path')
 const server = require('../server')
+const logger = require('../util/logger.js')
 
 const exportFile = path.join(__dirname, 'moddef.json')
 
@@ -16,7 +17,7 @@ async function main() {
   )
 
   fsPromises.writeFile(exportFile, JSON.stringify(def, null, 4))
-  console.log(`👍 Get your own definition at: ${exportFile}`)
+  logger.info(`👍 Get your own definition at: ${exportFile}`)
 }
 
 main()

module/aidj_content_rcmd.js

@@ -4,6 +4,7 @@
 // 可按需修改此 API 的代码
 /* {"extInfo":"{\"lastRequestTimestamp\":1692358373509,\"lbsInfoList\":[{\"lat\":40.23076381,\"lon\":129.07545186,\"time\":1692358543},{\"lat\":40.23076381,\"lon\":129.07545186,\"time\":1692055283}],\"listenedTs\":false,\"noAidjToAidj\":true}","header":"{}"} */
 
+const logger = require('../util/logger.js')
 const createOption = require('../util/option.js')
 module.exports = (query, request) => {
   var extInfo = {}
@@ -22,6 +23,6 @@ module.exports = (query, request) => {
   const data = {
     extInfo: JSON.stringify(extInfo),
   }
-  // console.log(data)
+  // logger.info(data)
   return request(`/api/aidj/content/rcmd/info`, data, createOption(query))
 }

module/cloud.js

@@ -2,6 +2,7 @@ const mm = require('music-metadata')
 const uploadPlugin = require('../plugins/songUpload')
 const md5 = require('md5')
 const createOption = require('../util/option.js')
+const logger = require('../util/logger.js')
 module.exports = async (query, request) => {
   let ext = 'mp3'
   // if (query.songFile.name.indexOf('flac') > -1) {
@@ -65,7 +66,7 @@ module.exports = async (query, request) => {
     }
     // if (metadata.native.ID3v1) {
     //   metadata.native.ID3v1.forEach((item) => {
-    //     // console.log(item.id, item.value)
+    //     // logger.info(item.id, item.value)
     //     if (item.id === 'title') {
     //       songName = item.value
     //     }
@@ -76,19 +77,19 @@ module.exports = async (query, request) => {
     //       album = item.value
     //     }
     //   })
-    //   // console.log({
+    //   // logger.info({
     //   //   songName,
     //   //   album,
     //   //   songName,
     //   // })
     // }
-    // console.log({
+    // logger.info({
     //   songName,
     //   album,
     //   songName,
     // })
   } catch (error) {
-    console.log(error)
+    logger.info(error)
   }
   const tokenRes = await request(
     `/api/nos/token/alloc`,
@@ -106,9 +107,9 @@ module.exports = async (query, request) => {
 
   if (res.body.needUpload) {
     const uploadInfo = await uploadPlugin(query, request)
-    // console.log('uploadInfo', uploadInfo.body.result.resourceId)
+    // logger.info('uploadInfo', uploadInfo.body.result.resourceId)
   }
-  // console.log(tokenRes.body.result)
+  // logger.info(tokenRes.body.result)
   const res2 = await request(
     `/api/upload/cloud/info/v2`,
     {
@@ -123,16 +124,16 @@ module.exports = async (query, request) => {
     },
     createOption(query),
   )
-  // console.log({ res2, privateCloud: res2.body.privateCloud })
-  // console.log(res.body.songId, 'songid')
+  // logger.info({ res2, privateCloud: res2.body.privateCloud })
+  // logger.info(res.body.songId, 'songid')
   const res3 = await request(
     `/api/cloud/pub/v2`,
     {
       songid: res2.body.songId,
     },
     createOption(query),
   )
-  // console.log({ res3 })
+  // logger.info({ res3 })
   return {
     status: 200,
     body: {

module/playlist_track_add.js

@@ -1,4 +1,5 @@
 const createOption = require('../util/option.js')
+const logger = require('../util/logger.js')
 module.exports = async (query, request) => {
   query.ids = query.ids || ''
   const data = {
@@ -9,7 +10,7 @@ module.exports = async (query, request) => {
       }),
     ),
   }
-  console.log(data)
+  logger.info(data)
 
   return request(`/api/playlist/track/add`, data, createOption(query, 'weapi'))
 }

module/song_url_match.js

@@ -2,7 +2,7 @@
 // 支持qq音乐、酷狗音乐、酷我音乐、咪咕音乐、第三方网易云API等等(来自GD音乐台)
 
 const createOption = require('../util/option.js')
-
+const logger = require('../util/logger.js')
 
 module.exports = async (query, request) => {
     try {
@@ -12,7 +12,7 @@ module.exports = async (query, request) => {
         const server = query.server ? query.server.split(',') : query.server
         const result = await match(query.id, !server? source : server)
         const proxy = process.env.PROXY_URL;
-        console.log("[OK] 开始解灰", query.id, result)
+        logger.info("开始解灰", query.id, result)
         const useProxy = process.env.ENABLE_PROXY || "false"
         if (result.url.includes('kuwo')) { result.proxyUrl = useProxy === 'true' ? proxy + result.url : result.url }
         return {

module/song_url_unblock.js

@@ -2,7 +2,7 @@
 // 支持qq音乐、酷狗音乐、酷我音乐、咪咕音乐、第三方网易云API等等(来自GD音乐台)
 
 const createOption = require('../util/option.js')
-
+const logger = require('../util/logger.js')
 
 module.exports = async (query, request) => {
     try {
@@ -12,7 +12,7 @@ module.exports = async (query, request) => {
         const server = query.server ? query.server.split(',') : query.server
         const result = await match(query.id, !server? source : server)
         const proxy = process.env.PROXY_URL;
-        console.log("[OK] 开始解灰", query.id, result)
+        logger.info("开始解灰", query.id, result)
         const useProxy = process.env.ENABLE_PROXY || "false"
         if (result.url.includes('kuwo') && useProxy === "true") { result.proxyUrl = proxy + result.url }
         return {

module/song_url_v1.js

@@ -3,6 +3,7 @@
 // 而是采用 standard, exhigh, lossless, hires, jyeffect(高清环绕声), sky(沉浸环绕声), jymaster(超清母带) 进行音质判断
 // 当unblock为true时, 会尝试使用unblockneteasemusic进行解锁, 同时音质设置不会生效, 但仍然为必须传入参数
 
+const logger = require('../util/logger.js')
 const createOption = require('../util/option.js')
 module.exports = async (query, request) => {
   const match = require('@unblockneteasemusic/server')
@@ -16,7 +17,7 @@ module.exports = async (query, request) => {
   if (query.unblock === 'true') {
     try {
       const result = await match(query.id, source)
-      console.log('[OK] 开始解灰', query.id, result)
+      logger.info('开始解灰', query.id, result)
       if (result.url.includes('kuwo')) {
         const useProxy = process.env.ENABLE_PROXY || 'false'
         var proxyUrl = useProxy === 'true' ? process.env.PROXY_URL + result.url : result.url

module_example/eapi_decrypt.js

@@ -1,4 +1,5 @@
 const { eapiResDecrypt, eapiReqDecrypt } = require('../util/crypto')
+const logger = require('../util/logger.js')
 
 let reqParamsHex =
   '6E0B1C712DCB3648589D7C950C296204072A88C3E080C4CFFD0A71A553EC2533BA88E11B1E1C6DF3BE8EFA26177FCB6FCA34EB3FAFAB4671B2BBAFA9781AFDA2BF53A3DC423722493837B9BC6E80CED5BBD2DDC2856920E4D4E3E7F3EB77ECF265217A66AE677BE36F2D6FB203F721CA250E1453EA61A34904E33D5FCB9D483601D744BE0AE979AC911A00F25828538844F4B1C24F6C34880A4AB257F530C7FB10A81FED32B18D09D70C0B1B9D34A2E58A3C3FAD382C6F958077059C4F801AD7B3B248FDB9D7A59B6A9EEFF8C781A84315B33A7AFD48BE9FCFCBE1902CCC27949ACF2BDE3FA34D116E230C3597E8320B8C42BBBF371A00C03EC428E0440EB94C1540F3FD4173D29E310AFE43AB0EF449852904103EF305FC435AD43B7D8673642F74C89CCB2F1A6A79B3BE14F1235D3843C3B241D12C05DBDDF37B68CA8B5D0230AF1FCF2A9705886F4D126B33FFF6948DE1E4046DB6423D687E96C5B65122464D2E71AEC7722935FF2C3796FAE253A16AA3B102FBE7296AB0DB9EA5C46AD12B'.replaceAll(
@@ -10,6 +11,6 @@ const resHex =
     ' ',
     '',
   )
-console.log(reqParamsHex)
-console.log(eapiReqDecrypt(reqParamsHex))
-console.log(eapiResDecrypt(resHex))
+logger.info(reqParamsHex)
+logger.info(eapiReqDecrypt(reqParamsHex))
+logger.info(eapiResDecrypt(resHex))