mm_https 1.6.3 → 1.6.4

package/index.js

@@ -1,5 +1,5 @@
 /**
- * @fileOverview http请求帮助类函数
+ * @fileOverview HTTP请求模块
  * @author <a href="http://qww.elins.cn">邱文武</a>
  * @version 1.2
  */
@@ -8,37 +8,38 @@ const https = require('https');
 const Url = require('url');
 const HttpProxyAgent = require('https-proxy-agent');
 const fs = require("fs");
-const Cookie = require('./cookie');
 const {
 	unzipSync
 } = require('zlib');
 const iconv = require('iconv-lite');
-const {
-	hostname
-} = require('os');
-const {
-	HttpsProxyAgent
-} = require('https-proxy-agent');
+require('mm_expand');
 
+/**
+ * HTTP客户端类
+ * @class
+ */
 class Http {
+	/**
+	 * 创建HTTP客户端实例
+	 * @param {Object} config - 配置选项
+	 */
 	constructor(config) {
-		this.config = Object.assign({
+		this._config = Object.assign({
 			headers: "",
 			rejectUnauthorized: false,
 			cookie: "",
 			proxy: null
-			// proxy: "http://127.0.0.1:10809"
 		}, config);
 
 		/**
-		 * cookies 缓存
+		 * cookies缓存
 		 */
-		this.cookies = {};
+		this._cookies = {};
 
 		/**
-		 * headers 协议头
+		 * headers协议头
 		 */
-		this.headers = {
+		this._headers = {
 			'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9',
 			'Accept-Encoding': 'gzip, deflate',
 			'Accept-Language': 'zh-CN,zh;q=0.9',
@@ -47,79 +48,102 @@ class Http {
 			'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36'
 		};
 
-		if (this.config.cookie) {
-			this.set_cookie(this.config.cookie);
+		if (this._config.cookie) {
+			this.setCookie(this._config.cookie);
 		}
 
-		if (this.config.headers) {
-			var headers = this.change_headers(config.headers);
-			Object.assign(this.headers, headers);
+		if (this._config.headers) {
+			var headers = this.changeHeaders(config.headers);
+			Object.assign(this._headers, headers);
 		}
 	}
 }
 
-Http.prototype.set_cookie = function(cookieStr) {
-	var arr = cookieStr.split('; ');
-	var name;
-	if (arr.length > 1) {
-		for (var i = 0; i < arr.length; i++) {
-			var kv = arr[i];
-			var arr_kv = kv.split("=");
-			name = arr_kv[0];
-			this.cookies[name] = encodeURIComponent(arr_kv[1]);
+/**
+ * 设置Cookie
+ * @param {Object|String} cookies - Cookie字符串
+ */
+Http.prototype.setCookie = function (cookies) {
+	if (typeof (cookies) == "string") {
+		var arr = cookies.split('; ');
+		var name;
+		if (arr.length > 0) {
+			for (var i = 0; i < arr.length; i++) {
+				var kv = arr[i];
+				var kvArr = kv.split("=");
+				name = kvArr[0];
+				this._cookies[name] = encodeURIComponent(kvArr[1]);
+			}
 		}
 	}
+	else if (typeof (cookies) == "object") {
+		Object.assign(this._cookies, cookies);
+	}
 }
 
-Http.prototype.get_cookie = function() {
-	var dist = this.cookies;
+/**
+ * 获取Cookie字符串
+ * @returns {string} Cookie字符串
+ */
+Http.prototype.getCookie = function () {
+	var cookies = this._cookies;
 	var str = "";
-	for (var k in dist) {
-		str += "; " + k + "=" + dist[k];
+	for (var key in cookies) {
+		str += "; " + key + "=" + cookies[key];
 	}
-	var cookie = str.replace("; ", "");
-	return cookie
+	var cookieStr = str.replace("; ", "");
+	return cookieStr;
 }
 
 /**
  * 转换协议头
- * @param {Object|String} headers 协议头
+ * @param {Object|string} headers - 协议头
+ * @returns {Object} 转换后的协议头对象
  */
-Http.prototype.change_headers = function(headers) {
+Http.prototype.changeHeaders = function (headers) {
 	if (headers) {
-		if (typeof(headers) == "string") {
+		if (typeof (headers) == "string") {
 			if (headers.indexOf("{") === 0) {
 				return headers.toJson();
 			} else {
-				var dict = {};
+				var headerDict = {};
 				var lines = headers.split('\n');
 				for (var i = 0; i < lines.length; i++) {
 					var line = lines[i].trim();
 					if (line) {
-						dict[line.left(":").trim()] = line.right(":").trim();
+						headerDict[line.left(":").trim()] = line.right(":").trim();
 					}
 				}
-				return dict;
+				return headerDict;
 			}
 		} else {
 			return headers;
 		}
 	}
-	return {}
+	return {};
 }
 
-Http.prototype.options = function(options) {
+/**
+ * 获取默认选项
+ * @returns {Object} 默认选项对象
+ */
+Http.prototype.options = function () {
 	return {
 		href: "",
 		method: "GET",
 		body: {},
 		proxy: "http://127.0.0.1:10809",
-		headers: Object.assign({}, this.headers)
+		headers: Object.assign({}, this._headers)
 	}
 }
 
-Http.prototype.http_options = function(options) {
-	var cg = this.config;
+/**
+ * 生成HTTP选项
+ * @param {Object} options - 选项参数
+ * @returns {Object} HTTP选项对象
+ */
+Http.prototype.httpOptions = function (options) {
+	var cfg = this._config;
 	var {
 		href,
 		body,
@@ -128,96 +152,104 @@ Http.prototype.http_options = function(options) {
 		cookie,
 		type
 	} = options;
-	var u = Url.parse(href, true);
+	var urlObj = Url.parse(href, true);
 	if (cookie) {
-		this.set_cookie(cookie);
+		this.setCookie(cookie);
 	}
-	var host_protocol = href.left(":/") || 'http';
+	var protocol = href.left(":/") || 'http';
 	return Object.assign({}, {
-		host_protocol,
+		hostProtocol: protocol,
 		body,
 		type,
 		method: method || "GET",
-		headers: headers ? Object.assign({}, this.headers, headers) : Object.assign({}, this.headers),
-		agent: cg.proxy ? new HttpProxyAgent(cg.proxy) : null,
-		cookie: this.get_cookie()
-	}, u);
+		headers: headers ? Object.assign({}, this._headers, headers) : Object.assign({}, this._headers),
+		agent: cfg.proxy ? new HttpProxyAgent(cfg.proxy) : null,
+		cookie: this.getCookie()
+	}, urlObj);
 }
 
-Http.prototype.post_option = function(op) {
+/**
+ * 处理POST选项
+ * @param {Object} op - 选项对象
+ */
+Http.prototype.postOption = function (op) {
 	var param = op.body;
-	var body = "";
-	var tp = typeof(param);
-	var type = op.type;
-	if (tp === "object") {
-		if (!type) {
-			type = 'application/json; charset=UTF-8';
-		} else if (type.indexOf('json') !== -1) {
-			type = "application/json; charset=UTF-8";
-		} else if (type.indexOf('html') !== -1) {
-			type = "text/html; charset=UTF-8";
-		} else if (type.indexOf('form') !== -1) {
-			type = "application/x-www-form-urlencoded";
+	var bodyStr = "";
+	var paramType = typeof (param);
+	var contentType = op.type;
+	if (paramType === "object") {
+		if (!contentType) {
+			contentType = 'application/json; charset=UTF-8';
+		} else if (contentType.indexOf('json') !== -1) {
+			contentType = "application/json; charset=UTF-8";
+		} else if (contentType.indexOf('html') !== -1) {
+			contentType = "text/html; charset=UTF-8";
+		} else if (contentType.indexOf('form') !== -1) {
+			contentType = "application/x-www-form-urlencoded";
 		} else {
-			type = "text/plain; charset=UTF-8";
+			contentType = "text/plain; charset=UTF-8";
 		}
-		if (type.indexOf('/json') !== -1) {
-			body = JSON.stringify(param);
-		} else if (type.indexOf('form') !== -1) {
-			body = $.toUrl(param);
+		if (contentType.indexOf('/json') !== -1) {
+			bodyStr = JSON.stringify(param);
+		} else if (contentType.indexOf('form') !== -1) {
+			bodyStr = $.toUrl(param);
 		} else {
-			body = $.toXml(param);
+			bodyStr = $.toXml(param);
 		}
 	} else {
-		body = param.trim();
-		if (!type) {
-			if (body.startWith('{') && body.endWith('}')) {
-				type = "application/json; charset=UTF-8";
-			} else if (body.startWith('[') && body.endWith(']')) {
-				type = "application/json; charset=UTF-8";
-			} else if (body.indexOf("<html>") !== -1) {
-				type = "text/html";
+		bodyStr = param.trim();
+		if (!contentType) {
+			if (bodyStr.startsWith('{') && bodyStr.endsWith('}')) {
+				contentType = "application/json; charset=UTF-8";
+			} else if (bodyStr.startsWith('[') && bodyStr.endsWith(']')) {
+				contentType = "application/json; charset=UTF-8";
+			} else if (bodyStr.indexOf("<html>") !== -1) {
+				contentType = "text/html";
 			} else {
-				type = "text/plain; charset=UTF-8";
+				contentType = "text/plain; charset=UTF-8";
 			}
 		}
 	}
-	op.body = body;
+	op.body = bodyStr;
 	if (!op.headers['Content-Type']) {
-		op.headers['Content-Type'] = type;
+		op.headers['Content-Type'] = contentType;
 	}
-	op.headers['Content-Length'] = Buffer.byteLength(body);
+	op.headers['Content-Length'] = Buffer.byteLength(bodyStr);
 }
 
 /**
- * http请求
- * @param {Object} options 配置
- * @return {Object} 返回执行结果
+ * HTTP请求
+ * @param {Object} options - 配置选项
+ * @returns {Promise<Object>} 执行结果
  */
-Http.prototype.req = async function(options) {
-	var op = this.http_options(options);
+Http.prototype.req = async function (options) {
+	var op = this.httpOptions(options);
 	if (op.method.toLocaleUpperCase() === "POST") {
-		this.post_option(op);
+		this.postOption(op);
 	}
 	var res = await this.request(op);
 	if (res.status.code == 302 || res.status.code == 307) {
-		var url = res.headers.location;
-		var lt = res.headers['set-cookie'];
-		if (lt) {
-			var len = lt.length;
+		var redirectUrl = res.headers.location;
+		var cookieList = res.headers['set-cookie'];
+		if (cookieList) {
+			var len = cookieList.length;
 			for (var i = 0; i < len; i++) {
-				this.set_cookie(lt[i]);
+				this.setCookie(cookieList[i]);
 			}
 		}
-		options.href = url;
-		op = this.http_options(options);
+		options.href = redirectUrl;
+		op = this.httpOptions(options);
 		op.referer = options.href;
 		res = await this.request(op);
 	}
 	return res;
 }
 
-Http.prototype.undata = function(encoding) {
+/**
+ * 解压数据
+ * @param {string} encoding - 编码方式
+ */
+Http.prototype.undata = function (encoding) {
 	var bufarr = [];
 	var errored = false;
 	var zpipe;
@@ -226,23 +258,23 @@ Http.prototype.undata = function(encoding) {
 	} else {
 		zpipe = zlib.createInflate();
 	}
-	zpipe.on('data', function(d) {
-			bufarr.push(d);
-		})
-		.on('end', function() {
+	zpipe.on('data', function (d) {
+		bufarr.push(d);
+	})
+		.on('end', function () {
 			if (errored) return;
 			errored = true;
 			cb(null, response, enc ? Buffer.concat(bufarr).toString(
 				enc) : Buffer.concat(bufarr));
 		})
-		.on('error', function(err) {
+		.on('error', function (err) {
 			if (errored) return;
 			errored = true;
 			cb(err, response, null);
 		});
 	response.pipe(zpipe);
 	response
-		.on('error', function(err) {
+		.on('error', function (err) {
 			if (errored) return;
 			errored = true;
 			cb(err, response, null);
@@ -250,15 +282,16 @@ Http.prototype.undata = function(encoding) {
 }
 
 /**
- * 请求
- * @param {Object} options 配置
+ * 发送请求
+ * @param {Object} options - 配置选项
+ * @returns {Promise<Object>} 请求结果
  */
-Http.prototype.request = function(options) {
-	var hp = options.host_protocol === "https" ? https : http;
-	var _this = this;
-	return new Promise(function(resolve, reject) {
+Http.prototype.request = function (options) {
+	var protocol = options.hostProtocol === "https" ? https : http;
+	var self = this;
+	return new Promise(function (resolve, reject) {
 		var body = '';
-		var req = hp.request(options, (res) => {
+		var req = protocol.request(options, (res) => {
 			var {
 				headers
 			} = res;
@@ -267,9 +300,9 @@ Http.prototype.request = function(options) {
 				var chunks = [];
 				var encoding = headers['content-encoding'];
 
-				res.on('data', function(d) {
-					chunks.push(d);
-				}).on('end', function(de) {
+				res.on('data', function (chunk) {
+					chunks.push(chunk);
+				}).on('end', function () {
 					var buffer = Buffer.concat(chunks);
 					switch (encoding) {
 						case 'br':
@@ -282,20 +315,20 @@ Http.prototype.request = function(options) {
 							body = buffer.toString();
 							break;
 					}
-					var mh = body.match(/charset=gb2312"/i);
-					if (mh) {
+					var charsetMatch = body.match(/charset=gb2312"/i);
+					if (charsetMatch) {
 						body = iconv.decode(buffer, 'gb2312');
 					} else {
-						mh = body.match(/charset=GBK"/i);
-						if (mh) {
+						charsetMatch = body.match(/charset=GBK"/i);
+						if (charsetMatch) {
 							body = iconv.decode(buffer, 'GBK');
 						}
 					}
-					var lt = headers['set-cookie'];
-					if (lt) {
-						var len = lt.length;
+					var cookieList = headers['set-cookie'];
+					if (cookieList) {
+						var len = cookieList.length;
 						for (var i = 0; i < len; i++) {
-							_this.set_cookie(lt[i]);
+							self.setCookie(cookieList[i]);
 						}
 					}
 					resolve({
@@ -317,8 +350,8 @@ Http.prototype.request = function(options) {
 			}
 		});
 
-		req.on("error", function(err) {
-			console.log("错误", err);
+		req.on("error", function (err) {
+			$.log.debug("错误", err);
 			resolve({
 				status: 0,
 				message: err.message
@@ -333,13 +366,13 @@ Http.prototype.request = function(options) {
 }
 
 /**
- * @description GET请求
- * @param {String} url 请求地址
- * @param {Object} headers 请求头
- * @param {String} cookie 服务缓存
- * @return {Object} 响应的结果
+ * GET请求
+ * @param {string} url - 请求地址
+ * @param {Object} headers - 请求头
+ * @param {string} cookie - Cookie字符串
+ * @returns {Promise<Object>} 响应结果
  */
-Http.prototype.get = async function(url, headers, cookie) {
+Http.prototype.get = async function (url, headers, cookie) {
 	return await this.req({
 		method: "GET",
 		href: url,
@@ -348,17 +381,16 @@ Http.prototype.get = async function(url, headers, cookie) {
 	});
 };
 
-
 /**
- * @description POST提交
- * @param {String} url 请求地址
- * @param {Object} body 提交参
- * @param {Object} headers 请求头
- * @param {String} type 传参方式 json, form, text
- * @param {String} cookie 服务缓存
- * @return {Object} 响应的结果
+ * POST请求
+ * @param {string} url - 请求地址
+ * @param {Object} body - 提交参数
+ * @param {Object} headers - 请求头
+ * @param {string} type - 传参方式 json, form, text
+ * @param {string} cookie - Cookie字符串
+ * @returns {Promise<Object>} 响应结果
  */
-Http.prototype.post = async function(url, body, headers, type, cookie) {
+Http.prototype.post = async function (url, body, headers, type, cookie) {
 	return await this.req({
 		method: "POST",
 		href: url,
@@ -370,53 +402,52 @@ Http.prototype.post = async function(url, body, headers, type, cookie) {
 };
 
 /**
- * @description 下载
- * @param {String} url 下载地址
- * @param {String} filename 下载地址
- * @param {String} auto 自动类型
- * @param {Object} headers 协议头
- * @param {String} cookie 服务缓存
- * @return {String} 成功返回保存路径，失败返回null
+ * 下载文件
+ * @param {string} url - 下载地址
+ * @param {string} filename - 文件名
+ * @param {string} auto - 自动类型
+ * @param {Object} headers - 协议头
+ * @param {string} cookie - Cookie字符串
+ * @returns {Promise<string>} 成功返回保存路径，失败返回null
  */
-Http.prototype.download = async function(url, filename, auto, headers, cookie) {
+Http.prototype.download = async function (url, filename, auto, headers, cookie) {
 	var res = await this.get(url, headers, cookie);
-	var file = null;
+	var filePath = null;
 	if (res.body) {
 		if (auto) {
-			var arr = url.split('/');
-			var fullname = arr[arr.length - 1];
-			if (fullname.indexOf('.') !== -1) {
-				var type = fullname.right('.');
-				if (type) {
-					file = filename + "." + type;
+			var parts = url.split('/');
+			var fullName = parts[parts.length - 1];
+			if (fullName.indexOf('.') !== -1) {
+				var ext = fullName.right('.');
+				if (ext) {
+					filePath = filename + "." + ext;
 				}
 			} else {
-				var content_type = res.headers["content-type"];
-				var type = content_type.replace("image/", "").replace("application/x-", "").replace("text/", "")
-					.replace("audio/",
-						"").replace("audio/", "").replace("jpeg", "jpg");
-				file = filename + "." + type;
+				var contentType = res.headers["content-type"];
+				var ext = contentType.replace("image/", "").replace("application/x-", "").replace("text/", "")
+					.replace("audio/", "").replace("jpeg", "jpg");
+				filePath = filename + "." + ext;
 			}
 		} else {
-			file = filename;
+			filePath = filename;
 		}
-		if (file) {
-			var length = await fs.writeFileSync(file, res.buffer, "binary");
-			if (length == 0) {
-				file = null;
+		if (filePath) {
+			var bytesWritten = await fs.writeFileSync(filePath, res.buffer, "binary");
+			if (bytesWritten == 0) {
+				filePath = null;
 			}
 		} else {
-			console.log('保存文件名(filename)不能为!');
+			$.log.debug('保存文件名(filename)不能为!');
 		}
 	}
-	return file;
+	return filePath;
 };
 
 /**
  * 清除缓存
  */
-Http.prototype.clear = function() {
-	this.cookies = {};
+Http.prototype.clear = function () {
+	this._cookies = {};
 };
 
 if (global.$) {
@@ -424,6 +455,6 @@ if (global.$) {
 }
 
 /**
- * @description 导入构造函数
+ * 导出构造函数
  */
 module.exports = Http;

package/npm-publish-checklist.md

@@ -0,0 +1,99 @@
+# mm_https模块 npm发布检查清单
+
+## ✅ 已完成的项目
+
+### 1. 代码重构和规范
+- [x] 类名和方法名使用小驼峰命名法
+- [x] 私有成员使用下划线前缀
+- [x] 变量名使用小写蛇形命名法
+- [x] 完整的JSDoc注释
+- [x] 符合ES6类和原型方法范式
+
+### 2. 测试文件优化
+- [x] 创建适合npm发布的测试文件
+- [x] 包含基础功能测试
+- [x] 包含高级功能测试
+- [x] 包含错误处理测试
+- [x] 所有测试通过
+
+### 3. 配置文件优化
+- [x] 更新package.json描述和关键词
+- [x] 添加Node.js版本要求
+- [x] 优化依赖管理
+
+### 4. 功能验证
+- [x] 语法检查通过
+- [x] 依赖关系正常
+- [x] 模块功能完整
+
+## 📋 npm发布前检查
+
+### 版本管理
+- [ ] 确认当前版本号：1.6.4
+- [ ] 是否需要更新版本号
+- [ ] 更新CHANGELOG.md（如有）
+
+### 文档检查
+- [ ] README.md内容完整且准确
+- [ ] 示例代码正确
+- [ ] 安装说明清晰
+
+### 发布准备
+- [ ] 登录npm账号：`npm login`
+- [ ] 检查包名可用性：`npm search mm_https`
+- [ ] 执行发布命令：`npm publish`
+
+## 🚀 发布命令
+
+```bash
+# 登录npm（如果未登录）
+npm login
+
+# 检查包名是否可用
+npm search mm_https
+
+# 发布到npm
+npm publish
+
+# 或者发布为公开包（如果需要）
+npm publish --access public
+```
+
+## 📦 安装使用
+
+发布后，用户可以通过以下方式安装：
+
+```bash
+npm install mm_https
+```
+
+使用示例：
+```javascript
+const { Http } = require('mm_https');
+
+async function example() {
+    const http = new Http();
+    const res = await http.get('https://httpbin.org/get');
+    console.log(res.body);
+}
+```
+
+## 🔧 开发命令
+
+```bash
+# 运行测试
+npm test
+
+# 开发模式
+npm run dev
+
+# 安装依赖
+npm install
+```
+
+## 📞 支持信息
+
+- 作者：邱文武
+- 许可证：ISC
+- 问题反馈：https://gitee.com/qiuwenwu91/mm_https/issues
+- 主页：https://gitee.com/qiuwenwu91/mm_https#readme