diff --git a/.gitignore b/.gitignore index 42e92c5..a1f5db0 100644 --- a/.gitignore +++ b/.gitignore @@ -46,4 +46,5 @@ src/test/resources/font src/main/resources/WEB-INF/vm/outFile target/ *.back +src/main/old_src/ diff --git a/javascript/xuanran.wang/bme/js/BuildContractApply.js b/javascript/xuanran.wang/bme/js/BuildContractApply.js index 723ec25..c8df318 100644 --- a/javascript/xuanran.wang/bme/js/BuildContractApply.js +++ b/javascript/xuanran.wang/bme/js/BuildContractApply.js @@ -47,6 +47,8 @@ jQuery().ready(function(){ } } + addRowBack(2, configObj); + changeDetailFieldReadOnly(detailTable, detail2ComPayDateId, detail2PaymentTypeId, computeDatePayType) // 主表字段发生变化 diff --git a/javascript/xuanran.wang/bme/js/Common.js b/javascript/xuanran.wang/bme/js/Common.js index 4aae9d3..5c432b3 100644 --- a/javascript/xuanran.wang/bme/js/Common.js +++ b/javascript/xuanran.wang/bme/js/Common.js @@ -42,6 +42,8 @@ function getDate(time) { return y + "-" + (m < 10 ? "0" + m : m) + "-" + (d < 10 ? "0" + d : d); } + + /** * 校验比例是否等于100 * @param detailTable 明细表 @@ -153,6 +155,18 @@ function changeDetailPayDate(obj){ } } +/** + * 字段联动后添加明细行后执行的逻辑 + * @param detail + * @param configObj + */ +function addRowBack(detail, configObj){ + WfForm.registerAction(WfForm.ACTION_ADDROW + detail, function(index){ + configObj.index = index; + changeDetailPayDate(configObj); + }); +} + /** * 改变明细表字段只读 * @param detailTable @@ -173,3 +187,5 @@ function changeDetailFieldReadOnly(detailTable, detailComDateField, detailPaymen } } } + + diff --git a/javascript/xuanran.wang/bme/js/InventFileFirst.js b/javascript/xuanran.wang/bme/js/InventFileFirst.js new file mode 100644 index 0000000..032724b --- /dev/null +++ b/javascript/xuanran.wang/bme/js/InventFileFirst.js @@ -0,0 +1,31 @@ + // 存货分类编码 + const chflbmId = WfForm.convertFieldNameToId("chflbm"); + // 流程类型 + const workflowType = WfForm.convertFieldNameToId("lcxz"); + // 唯一编码 + const unqieCode = WfForm.convertFieldNameToId("wybm"); + // 帐套查询 + const zt = WfForm.convertFieldNameToId("ztcx"); + // 存货编码 + const chbm = WfForm.convertFieldNameToId("chbm2"); + + changeVal(); + WfForm.bindFieldChangeEvent(chflbmId, function(obj,id,value){ + changeVal(); + }); + + function changeVal(){ + let value = WfForm.getFieldValue(chflbmId) + console.log('value: ', value); + if(!value){ + return; + } + let firstVal = value.charAt(0); + if(firstVal == 0){ + value = value.substring(1, value.length); + console.log('修改后的val ', value); + setTimeout(()=>{ + $(`#${chflbmId}span`)[0].innerHTML = value; + },5); + } + } \ No newline at end of file diff --git a/javascript/xuanran.wang/bme/js/PayApply.js b/javascript/xuanran.wang/bme/js/PayApply.js new file mode 100644 index 0000000..fbe6238 --- /dev/null +++ b/javascript/xuanran.wang/bme/js/PayApply.js @@ -0,0 +1,32 @@ +// 主表预计付款日期 +const yjfksj = WfForm.convertFieldNameToId('yjfksj'); +// 主表比例 +const bl = WfForm.convertFieldNameToId('bcfkbl'); +// 明细要求付款日期 +const detail3Yqfkrq = WfForm.convertFieldNameToId('yqfkrq',"detail_3"); +// 明细本次付款比例 +const detailBl = WfForm.convertFieldNameToId('bcfkbl',"detail_3"); + +WfForm.registerCheckEvent(WfForm.OPER_ADDROW + "3", function (callback) { + callback(); + initDeatail3Date(); +}); + +WfForm.bindFieldChangeEvent(`${yjfksj},${bl}`, function(obj,id,value){ + initDeatail3Date(); +}); + +function initDeatail3Date(){ + let dateVal = WfForm.getFieldValue(yjfksj); + let blVal = WfForm.getFieldValue(bl); + console.log('dateVal ', dateVal); + console.log('blVal ', blVal); + let detail3RowArr = WfForm.getDetailAllRowIndexStr('detail_3').split(","); + for (let i = 0; i < detail3RowArr.length; i++) { + let rowIndex = detail3RowArr[i]; + if (rowIndex !== "") { + WfForm.changeFieldValue(`${detail3Yqfkrq}_${rowIndex}`,{value: dateVal}); + WfForm.changeFieldValue(`${detailBl}_${rowIndex}`,{value: blVal}); + } + } +} \ No newline at end of file diff --git a/javascript/xuanran.wang/bme/js/ProDataConfirm.js b/javascript/xuanran.wang/bme/js/ProDataConfirm.js new file mode 100644 index 0000000..6994422 --- /dev/null +++ b/javascript/xuanran.wang/bme/js/ProDataConfirm.js @@ -0,0 +1,217 @@ +var m_xmmc = WfForm.convertFieldNameToId("xmmc");//项目名称 +var m_bmwyz = WfForm.convertFieldNameToId("glkcjlb");//关联勘察 +var m_bmwyz1 = WfForm.convertFieldNameToId("glxsxqd");//关联销售 +var m_bmwyz2 = WfForm.convertFieldNameToId("chdadx");//唯一值多选 +var dt2_tyrq = WfForm.convertFieldNameToId("tyrq", "detail_2");//明细2停用日期 +jQuery(document).ready(function () { + setTimeout("bindFieldChange()", "500"); +}); + +function bindFieldChange() { + WfForm.bindFieldChangeEvent(m_xmmc, function (obj, id, value) { + WfForm.changeFieldValue(m_bmwyz, {value: ''}); + WfForm.changeFieldValue(m_bmwyz1, {value: ''}); + WfForm.changeFieldValue(m_bmwyz2, {value: ''}); + }); + //提交检验 + WfForm.registerCheckEvent(WfForm.OPER_SUBMIT, function (callback) { + var flag = true; + var rowArr = WfForm.getDetailAllRowIndexStr("detail_2").split(","); + for (var i = 0; i < rowArr.length; i++) { + var rowid = rowArr[i]; + var dt2_tyrq_v = WfForm.getFieldValue(dt2_tyrq + "_" + rowid); + if (dt2_tyrq_v != "") { + WfForm.showMessage("明细2第" + (i + 1) + "行设备已在" + dt2_tyrq_v + "停用！", 2, 5); + flag = flase; + break; + } + } + if (flag) { + callback(); //继续提交需调用callback，不调用代表阻断 + } + }); +} + +var rowArr = WfForm.getDetailAllRowIndexStr("detail_3").split(","); +// WfForm.delDetailRow("detail_2", "all"); +for (var i = 0; i < rowArr.length; i++) { + var rowIndex = rowArr[i]; + if (rowIndex !== "") { + var fieldMark = "field12566" + rowIndex; + if (fieldMark === "0") { + var count = WfForm.getFieldValue("field12562" + rowIndex); + var field7108_ = WfForm.getFieldValue("field6117_" + rowIndex); + WfForm.addDetailRow("detail_2", {field8567: {value: count}, field7583: {value: field7108_},}); + } + } +} +/* +dev-1 王宣然 限制明细表选择的bom不能重复 +*/ +const detailBomField = WfForm.convertFieldNameToId('bombm', 'detail_1'); +/** + * 主表辅助字段 + */ +const mainAttrField = WfForm.convertFieldNameToId('ycbmpzx'); +/** + * 明细1数量 + */ +const detail1NumFieldId = WfForm.convertFieldNameToId('sl1', "detail_1"); +/** + * 明细3 明细2数量 + */ +const detail3NumFieldId = WfForm.convertFieldNameToId('mx2sl', "detail_3"); +/** + * 明细3数量 + */ +const detail3NumFieldId2 = WfForm.convertFieldNameToId('sl1', "detail_3"); +/** + * 明细3需求数量 + */ +const detail3NumFieldId3 = WfForm.convertFieldNameToId('sl', "detail_3"); +/** + * 明细3bom编码 + */ +const detail3BomFieldId = WfForm.convertFieldNameToId('bombm', "detail_3"); +/** + * 明细1bom编码 + */ +const detail1BomFieldId = WfForm.convertFieldNameToId('bombm', "detail_1"); +/* +*已经选择的bom +*/ +let choiceArr = new Set(); +let updateNum = {}; + +const yjdhrq = WfForm.convertFieldNameToId('yjdhrq'); +console.log('id ', yjdhrq) +// 明细到货日期 +const detail1yjdhsj = WfForm.convertFieldNameToId('yjdhsj', "detail_2"); + +WfForm.bindFieldChangeEvent(yjdhrq, function (obj, id, value) { + initDeatail2Date(value); +}); + +WfForm.registerCheckEvent(WfForm.OPER_ADDROW + "2", function (callback) { + callback(); + let value = WfForm.getFieldValue(yjdhrq); + initDeatail2Date(value); +}); + +WfForm.bindDetailFieldChangeEvent(detailBomField, function (id, rowIndex, value) { + if (!value) { + return; + } + if (choiceArr.has(value)) { + WfForm.showMessage('不能选择重复的bom，请重新选择!'); + setTimeout(() => { + WfForm.changeFieldValue(`${detailBomField}_${rowIndex}`, {value: '', specialobj: []}); + }, 5); + } + initChoiceArr(); + getBomArr(); +}); + + +// 数量变化自动计算 +WfForm.bindDetailFieldChangeEvent(`${detail1NumFieldId},${detailBomField}`, function (id, rowIndex, value) { + let detail1RowArr = WfForm.getDetailAllRowIndexStr('detail_1').split(","); + console.log(detail1RowArr); + for (let i = 0; i < detail1RowArr.length; i++) { + let rowIndex = detail1RowArr[i]; + if (rowIndex !== "") { + let num = WfForm.getFieldValue(`${detail1NumFieldId}_${rowIndex}`); + // bom编码 + let bom = WfForm.getFieldValue(`${detail1BomFieldId}_${rowIndex}`); + setTimeout(() => { + computeNum(bom, num); + }, 500); + } + } + +}); + +function initDeatail2Date(value) { + let detail2RowArr = WfForm.getDetailAllRowIndexStr('detail_2').split(","); + for (let i = 0; i < detail2RowArr.length; i++) { + let rowIndex = detail2RowArr[i]; + if (rowIndex !== "") { + WfForm.changeFieldValue(`${detail1yjdhsj}_${rowIndex}`, {value: value}); + } + } +} + +/** + * 计算明细3数量 + */ +function computeNum(detail1Bom, detail1Num) { + let detail3RowArr = WfForm.getDetailAllRowIndexStr('detail_3').split(","); + console.log(detail3RowArr); + for (let i = 0; i < detail3RowArr.length; i++) { + let rowIndex = detail3RowArr[i]; + if (rowIndex !== "") { + // bom编码 + let bom = WfForm.getFieldValue(`${detail3BomFieldId}_${rowIndex}`); + if (bom != detail1Bom) { + continue; + } + console.log('需要改变的index ', rowIndex) + WfForm.changeFieldValue(`${detail3NumFieldId}_${rowIndex}`, {value: detail1Num}); + } + } +} + +/** + * 初始化已经选择的数组 + */ +function initChoiceArr() { + choiceArr = new Set(); + let rowArr = WfForm.getDetailAllRowIndexStr('detail_1').split(","); + for (let i = 0; i < rowArr.length; i++) { + let rowIndex = rowArr[i]; + if (rowIndex !== "") { + let bom = WfForm.getFieldValue(`${detailBomField}_${rowIndex}`); + // console.log('bom ', bom); + if (!bom) { + continue; + } + choiceArr.add(bom); + } + } + console.log('choiceArr ', choiceArr) +} + +WfForm.registerCheckEvent(WfForm.OPER_DELROW + "1", function (callback) { + callback(); + getBomArr(); + initChoiceArr(); +}); + +function getBomArr() { + let arr = []; + let rowArr = WfForm.getDetailAllRowIndexStr('detail_1').split(","); + for (let i = 0; i < rowArr.length; i++) { + let rowIndex = rowArr[i]; + if (rowIndex !== "") { + arr.push(WfForm.getFieldValue(`${detailBomField}_${rowIndex}`)); + } + } + let bom = new Set(arr); + let arr2 = [...bom]; + let obj = {}; + obj.value = arr2.join(','); + let specialobjArr = []; + for (let i = 0; i < arr2.length; i++) { + let obj = {}; + obj.id = arr2[i]; + obj.name = arr2[i]; + specialobjArr.push(obj); + } + obj.specialobj = specialobjArr; + let val = WfForm.changeFieldValue(mainAttrField, obj); + if (!val) { + WfForm.delDetailRow("detail_3", "all"); + } + console.log('主表辅助字段值 : ', WfForm.getFieldValue(mainAttrField)); +} + diff --git a/javascript/xuanran.wang/bme/js/PurchaseContractApply.js b/javascript/xuanran.wang/bme/js/PurchaseContractApply.js index 4303665..705e114 100644 --- a/javascript/xuanran.wang/bme/js/PurchaseContractApply.js +++ b/javascript/xuanran.wang/bme/js/PurchaseContractApply.js @@ -51,6 +51,9 @@ function init(){ 'computeDatePayType': computeDatePayType, 'paymentTypeGetValue': paymentTypeGetValue } + + addRowBack(3, obj); + changeDetailFieldReadOnly(detailTable, detailComPayDateId, detailPaymentTypeId, computeDatePayType) // 主表字段发生变化 mainFieldChangeDetailCom(`${mainProjectId},${contractSignDateId}`, detailTable, obj); diff --git a/javascript/xuanran.wang/bme/js/SaleContractApply.js b/javascript/xuanran.wang/bme/js/SaleContractApply.js index 2836a58..eff8107 100644 --- a/javascript/xuanran.wang/bme/js/SaleContractApply.js +++ b/javascript/xuanran.wang/bme/js/SaleContractApply.js @@ -52,6 +52,7 @@ function init(){ 'computeDatePayType': computeDatePayType, 'paymentTypeGetValue': paymentTypeGetValue } + addRowBack(2, obj); changeDetailFieldReadOnly(detailTable, detail2ComPayDateId, detail2PaymentTypeId, computeDatePayType) // 主表字段发生变化 mainFieldChangeDetailCom(mainProjectId, detailTable, obj); diff --git a/javascript/youhong.ai/pcn/workflow_code_block.js b/javascript/youhong.ai/pcn/workflow_code_block.js index b0f8437..9212a06 100644 --- a/javascript/youhong.ai/pcn/workflow_code_block.js +++ b/javascript/youhong.ai/pcn/workflow_code_block.js @@ -535,7 +535,46 @@ $(() => { callback() }) }) - /* ******************* 流程明细字段包含某个字符串时给某个字段赋值为某个东西end ******************* */ + +/* ******************* 流程明细字段包含某个字符串时给某个字段赋值为某个东西end ******************* */ + + +/* ******************* 流程提交按钮触发流程抄送start ******************* */ + +$(() => { + let config = { + // 抄送人所在明细表编号，1-明细1 ； 2-明细2 + detailNo: '1', + // 抄送人所在字段字段名 + ccResourceField: '', + // 一级部门负责人字段名 + firstLevelDepResponsibleField: '' + } + WfForm.registerCheckEvent(WfForm.OPER_SUBMIT, function (callback) { + $.ajax("/api/aiyh/pcn/cc-workflow/trigger", { + type: "POST", + data: JSON.stringify({ + detailNo: config.detailNo, + requestId: WfForm.getBaseInfo().requestid, + ccResourceField: config.ccResourceField, + firstLevelDepResponsibleField: config.firstLevelDepResponsibleField + }), + headers: { + "Content-Type": "application/json" + }, + complete: (res) => { + res.then(r => { + if (r && r.code === 200) { + callback(); + } + }) + } + }) + }); +}) + + /* ******************* 流程提交按钮触发流程抄送end ******************* */ + /* ******************* 提交外出流程 ******************* */ (function start() { diff --git a/libLib/WEB-INF/lib/keys/rsa_2048_priv.key b/libLib/WEB-INF/lib/keys/rsa_2048_priv.key new file mode 100644 index 0000000..6ea2feb --- /dev/null +++ b/libLib/WEB-INF/lib/keys/rsa_2048_priv.key @@ -0,0 +1 @@ +MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCa8TBiSrOPSgJER3nd+gW2eCoSjXHRVxEX54AdxzmtDe4Rn6OlvMVG1GLWfTnjdwbLTVeZUqjTpgZkCdGIp9njgjs6v6oQ7f8+DhQvByp6BSNXBHM+XH+YnmIohcQpnH7qvDT8l41Io2IVZbeNBWMlAtnz7laXWisYkYEDUm8HXOadKLkX+aqWdEYJHGy8zYN9ktNWH7P8BXBUAUd1vtTZhhE6BMd/O0WSqWhgpABbFZ8VKVT/5u4dlXUykKNbCKrsfXoiLE/7plbfHji02sUdaA1LAOF4QOaTePaGZu/55TWCYZPjWKrW2c0Gr8mS/1MQrg1zsWV2c59GqLNMWICtAgMBAAECggEAOS4thvi+j3DmqUAfj3YHybFLBZHBoVoaatH6jALMHDt50nMxt6aUv3D+EN4iEPoKPdkLLQA+Ye1xilW9SEt5s+aJ6UJ2hszuV35moHxqhqGCy0hPJ4KHbFF3NDE5lYm1pPdULqvXbiktt2vUc2y7jBsjSEx7FFwob2azUACKDRL+PkNGGcMmdMeCIHBcQf+j0CTY/VvsPGHqf53I/Ffe2KAE3Y0SugoIB5dqUE9VN5KGC01+X6hufaNUpPLYLbBiaI1eHVtMCHbGNmNnHuFgsEWT4ya4fw1rm9DLS8zJwDHkHmegE5ieqM7EzM2UIvKCN3TQJcy+Ssk3FX+KBFQqmQKBgQDaiC8QFqA7z8DY0K6lwj8PMiuNeu9APJuHLAhGdbDXjAKfdU1cNU4SHfsjjCU4Wymgp8QNrMD8WhardKHV+zr6B0mRMnUYOI6aoAg1+UcGoHYM2PEonZS+OtBHI68wDIsiKQ2Mybsl6GlxoLfo3YdlcclPFHNzXoVc8QFboN0TdwKBgQC1gerb6Anwlj6rJB9RCnoR/Jq5Lyh5wa1eL1C+gZSSM8Mwwxu3VpPohUMca7t1F1vmEDaf/Z2nsQ8IULnYkS94iGYooIcV2ffY5bagi/DkuTYfbf2QBWSZNTI1yHTWoaIXElRG0+svxgL6w98D3Y5lzIt0skz+/ZSGIdiLg8mt+wKBgQCBJCNzxXsxfWeAeWoMKMttJn/YXwLOGkLq0ZmeUeSMrH/MTdzGlfWp/S+xZRuFv1HNT/crAaEWQALPleAhfRLwOKg/9up9wsZ7GAFiLArOHrtEgluZXe5NsKHuuGbJ5U+/gzUvsvM2xq6xaIHmSiu+Rkzpv7MuRXhYYVAlHt4mpwKBgALOOEgf5Q9v8xYIH+fLxqlCg027ed+v67MZ/iCDtj0wSaMWUPZbgzvD246z55jevI/ozj9Y1zgBV58kSEsdq2MskI+uM4hV7yvOGS2QHDAc4MZJl/LC8pQfq2ADcjLjGrNKmDzkB62cXO1tW6Qep5XRPJKYMvJ6DvKn0UYOym5DAoGBALsEOPep1R8CBWCnni8igvbMudBwpzg5e9V6bu7p3MdADhGA/FMkCQgI2VH6fTufQsOA6rYi7YcdMS80r+p1/HMuVskOlqQfPDJ3OG0g0W8nwxf3XbIoEJcaAzLmqDOQMHfhmnoQsPlnCd7YRybbEEkEbKeRjyrDqhMSTSWC8lw4 \ No newline at end of file diff --git a/libLib/WEB-INF/lib/keys/rsa_2048_pub.key b/libLib/WEB-INF/lib/keys/rsa_2048_pub.key new file mode 100644 index 0000000..9654f34 --- /dev/null +++ b/libLib/WEB-INF/lib/keys/rsa_2048_pub.key @@ -0,0 +1 @@ +MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmvEwYkqzj0oCREd53foFtngqEo1x0VcRF+eAHcc5rQ3uEZ+jpbzFRtRi1n0543cGy01XmVKo06YGZAnRiKfZ44I7Or+qEO3/Pg4ULwcqegUjVwRzPlx/mJ5iKIXEKZx+6rw0/JeNSKNiFWW3jQVjJQLZ8+5Wl1orGJGBA1JvB1zmnSi5F/mqlnRGCRxsvM2DfZLTVh+z/AVwVAFHdb7U2YYROgTHfztFkqloYKQAWxWfFSlU/+buHZV1MpCjWwiq7H16IixP+6ZW3x44tNrFHWgNSwDheEDmk3j2hmbv+eU1gmGT41iq1tnNBq/Jkv9TEK4Nc7FldnOfRqizTFiArQIDAQAB \ No newline at end of file diff --git a/pom.xml b/pom.xml index 365f87d..5b8411e 100644 --- a/pom.xml +++ b/pom.xml @@ -56,6 +56,12 @@ ${lombok.version} provided + + + com.drewnoakes + metadata-extractor + ${metadata-extractor.version} + diff --git a/src/main/java/aiyh/utils/Util.java b/src/main/java/aiyh/utils/Util.java index 8fae3ea..909368b 100644 --- a/src/main/java/aiyh/utils/Util.java +++ b/src/main/java/aiyh/utils/Util.java @@ -732,7 +732,7 @@ public class Util extends weaver.general.Util { StringBuilder buffer = new StringBuilder(); for (int i = 0, l = charArray.length; i < l; i++) { // 判断当前字符是否是"_",如果跳出本次循环 - if (charArray[i] == 95) { + if (charArray[i] == '_') { underlineBefore = true; } else if (underlineBefore) { // 如果为true，代表上次的字符是"_",当前字符需要转成大写 @@ -763,10 +763,10 @@ public class Util extends weaver.general.Util { for (int i = 0, l = charArray.length; i < l; i++) { if (charArray[i] >= 65 && charArray[i] <= 90) { if (i == 0) { - buffer.append(charArray[i] += 32); + buffer.append(Character.toLowerCase(charArray[i])); continue; } - buffer.append("_").append(charArray[i] += 32); + buffer.append("_").append(Character.toLowerCase(charArray[i])); } else { buffer.append(charArray[i]); } @@ -2100,7 +2100,12 @@ public class Util extends weaver.general.Util { String s; for (Iterator item = coll.iterator(); item.hasNext(); sb.append(s)) { - s = (String) item.next(); + T value = item.next(); + if (Objects.isNull(value)) { + s = ""; + } else { + s = String.valueOf(value); + } if (isFirst) { isFirst = false; } else { @@ -2111,6 +2116,38 @@ public class Util extends weaver.general.Util { } } + /** + * join方法 + * + * @param coll + * @param split + * @return + */ + public static String joinEach(T[] coll, String split) { + if (Objects.isNull(coll)) { + return ""; + } else { + StringBuilder sb = new StringBuilder(); + boolean isFirst = true; + String s; + for (Iterator item = Arrays.stream(coll).iterator(); item.hasNext(); sb.append(s)) { + T value = item.next(); + if (Objects.isNull(value)) { + s = ""; + } else { + s = String.valueOf(value); + } + if (isFirst) { + isFirst = false; + } else { + sb.append(split); + } + } + return sb.toString(); + } + } + + /** * 将数组使用指定的分隔符链接为字符串 * @@ -3736,7 +3773,35 @@ public class Util extends weaver.general.Util { return Util.getValueByKeyStr("main." + fieldInfo.getFieldName(), workflowData); } - public static Map createFunctionMap() { - return null; + public static String getIpAddress(HttpServletRequest request) throws IOException { + // 获取请求主机IP地址,如果通过代理进来，则透过防火墙获取真实IP地址 + String ip = request.getHeader("X-Forwarded-For"); + if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { + if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { + ip = request.getHeader("Proxy-Client-IP"); + } + if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { + ip = request.getHeader("WL-Proxy-Client-IP"); + } + if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { + ip = request.getHeader("HTTP_CLIENT_IP"); + } + if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { + ip = request.getHeader("HTTP_X_FORWARDED_FOR"); + } + if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { + ip = request.getRemoteAddr(); + } + } else if (ip.length() > 15) { + String[] ips = ip.split(","); + for (int index = 0; index < ips.length; index++) { + String strIp = ips[index]; + if (!("unknown".equalsIgnoreCase(strIp))) { + ip = strIp; + break; + } + } + } + return ip; } } diff --git a/src/main/java/aiyh/utils/annotation/recordset/Association.java b/src/main/java/aiyh/utils/annotation/recordset/Association.java index cbe017b..9626623 100644 --- a/src/main/java/aiyh/utils/annotation/recordset/Association.java +++ b/src/main/java/aiyh/utils/annotation/recordset/Association.java @@ -18,7 +18,8 @@ public @interface Association { String column(); - String select(); + + String select() default ""; Id id(); diff --git a/src/main/java/aiyh/utils/annotation/recordset/BatchDeleteOracle.java b/src/main/java/aiyh/utils/annotation/recordset/BatchDeleteOracle.java new file mode 100644 index 0000000..7b11f27 --- /dev/null +++ b/src/main/java/aiyh/utils/annotation/recordset/BatchDeleteOracle.java @@ -0,0 +1,20 @@ +package aiyh.utils.annotation.recordset; + +import java.lang.annotation.*; + +/** + *

批量插入

+ * + *

create: 2022-08-09 17:40

+ * + * @author aiyh EBU7-dev-1 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +@Documented +public @interface BatchDeleteOracle { + String value() default ""; + + // sql是否是在参数中 + boolean custom() default false; +} diff --git a/src/main/java/aiyh/utils/annotation/recordset/BatchInsertOracle.java b/src/main/java/aiyh/utils/annotation/recordset/BatchInsertOracle.java new file mode 100644 index 0000000..a833ba4 --- /dev/null +++ b/src/main/java/aiyh/utils/annotation/recordset/BatchInsertOracle.java @@ -0,0 +1,20 @@ +package aiyh.utils.annotation.recordset; + +import java.lang.annotation.*; + +/** + *

批量插入

+ * + *

create: 2022-08-09 17:40

+ * + * @author aiyh EBU7-dev-1 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +@Documented +public @interface BatchInsertOracle { + String value() default ""; + + // sql是否是在参数中 + boolean custom() default false; +} diff --git a/src/main/java/aiyh/utils/annotation/recordset/BatchUpdateOracle.java b/src/main/java/aiyh/utils/annotation/recordset/BatchUpdateOracle.java new file mode 100644 index 0000000..27a13f2 --- /dev/null +++ b/src/main/java/aiyh/utils/annotation/recordset/BatchUpdateOracle.java @@ -0,0 +1,20 @@ +package aiyh.utils.annotation.recordset; + +import java.lang.annotation.*; + +/** + *

批量插入

+ * + *

create: 2022-08-09 17:40

+ * + * @author aiyh EBU7-dev-1 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +@Documented +public @interface BatchUpdateOracle { + String value() default ""; + + // sql是否是在参数中 + boolean custom() default false; +} diff --git a/src/main/java/aiyh/utils/annotation/recordset/CanBeNull.java b/src/main/java/aiyh/utils/annotation/recordset/CanBeNull.java new file mode 100644 index 0000000..b8113d4 --- /dev/null +++ b/src/main/java/aiyh/utils/annotation/recordset/CanBeNull.java @@ -0,0 +1,16 @@ +package aiyh.utils.annotation.recordset; + +import java.lang.annotation.*; + +/** + *

可以为null

+ * + *

create: 2023/3/8 21:41

+ * + * @author youHong.ai + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +@Documented +public @interface CanBeNull { +} diff --git a/src/main/java/aiyh/utils/annotation/recordset/CollectionMapping.java b/src/main/java/aiyh/utils/annotation/recordset/CollectionMapping.java index f3ba58a..6e15a77 100644 --- a/src/main/java/aiyh/utils/annotation/recordset/CollectionMapping.java +++ b/src/main/java/aiyh/utils/annotation/recordset/CollectionMapping.java @@ -17,7 +17,7 @@ public @interface CollectionMapping { String property(); /** 数据库字段名 */ - String column(); + String column() default ""; /** 查询方法全限定类名 */ String select() default ""; diff --git a/src/main/java/aiyh/utils/annotation/recordset/Column.java b/src/main/java/aiyh/utils/annotation/recordset/Column.java new file mode 100644 index 0000000..d90aa96 --- /dev/null +++ b/src/main/java/aiyh/utils/annotation/recordset/Column.java @@ -0,0 +1,20 @@ +package aiyh.utils.annotation.recordset; + +import java.lang.annotation.*; + +/** + *

列名

+ * + *

create: 2023/3/10 10:18

+ * + * @author youHong.ai + */ + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.ANNOTATION_TYPE) +@Documented +public @interface Column { + String value(); + + String oracle() default ""; +} diff --git a/src/main/java/aiyh/utils/annotation/recordset/DeleteOracle.java b/src/main/java/aiyh/utils/annotation/recordset/DeleteOracle.java new file mode 100644 index 0000000..54013e6 --- /dev/null +++ b/src/main/java/aiyh/utils/annotation/recordset/DeleteOracle.java @@ -0,0 +1,18 @@ +package aiyh.utils.annotation.recordset; + +import java.lang.annotation.*; + +/** + * @author @author EBU7-dev1-ay + * create 2021/12/19 0019 15:08 + */ + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +@Documented +public @interface DeleteOracle { + String value() default ""; + + // sql是否是在参数中 + boolean custom() default false; +} diff --git a/src/main/java/aiyh/utils/annotation/recordset/InsertOracle.java b/src/main/java/aiyh/utils/annotation/recordset/InsertOracle.java new file mode 100644 index 0000000..23f126a --- /dev/null +++ b/src/main/java/aiyh/utils/annotation/recordset/InsertOracle.java @@ -0,0 +1,18 @@ +package aiyh.utils.annotation.recordset; + +import java.lang.annotation.*; + +/** + * @author @author EBU7-dev1-ay + * create 2021/12/19 0019 15:08 + */ + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +@Documented +public @interface InsertOracle { + String value() default ""; + + // sql是否是在参数中 + boolean custom() default false; +} diff --git a/src/main/java/aiyh/utils/annotation/recordset/Select.java b/src/main/java/aiyh/utils/annotation/recordset/Select.java index 3786058..bfa0676 100644 --- a/src/main/java/aiyh/utils/annotation/recordset/Select.java +++ b/src/main/java/aiyh/utils/annotation/recordset/Select.java @@ -11,7 +11,8 @@ import java.lang.annotation.*; @Target(ElementType.METHOD) @Documented public @interface Select { - String value() default ""; - // sql是否是在参数中 - boolean custom() default false; + String value() default ""; + + // sql是否是在参数中 + boolean custom() default false; } diff --git a/src/main/java/aiyh/utils/annotation/recordset/SelectOracle.java b/src/main/java/aiyh/utils/annotation/recordset/SelectOracle.java new file mode 100644 index 0000000..377963f --- /dev/null +++ b/src/main/java/aiyh/utils/annotation/recordset/SelectOracle.java @@ -0,0 +1,17 @@ +package aiyh.utils.annotation.recordset; + +import java.lang.annotation.*; + +/** + * @author @author EBU7-dev1-ay + * create 2021/12/19 0019 15:08 + */ + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +@Documented +public @interface SelectOracle { + String value() default ""; + + boolean custom() default false; +} diff --git a/src/main/java/aiyh/utils/annotation/recordset/UpdateOracle.java b/src/main/java/aiyh/utils/annotation/recordset/UpdateOracle.java new file mode 100644 index 0000000..0310582 --- /dev/null +++ b/src/main/java/aiyh/utils/annotation/recordset/UpdateOracle.java @@ -0,0 +1,18 @@ +package aiyh.utils.annotation.recordset; + +import java.lang.annotation.*; + +/** + * @author @author EBU7-dev1-ay + * create 2021/12/19 0019 15:08 + */ + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +@Documented +public @interface UpdateOracle { + String value() default ""; + + // sql是否是在参数中 + boolean custom() default false; +} diff --git a/src/main/java/aiyh/utils/entity/DocImageInfo.java b/src/main/java/aiyh/utils/entity/DocImageInfo.java index 49753e0..f224ac6 100644 --- a/src/main/java/aiyh/utils/entity/DocImageInfo.java +++ b/src/main/java/aiyh/utils/entity/DocImageInfo.java @@ -1,5 +1,6 @@ package aiyh.utils.entity; +import aiyh.utils.annotation.recordset.SqlOracleDbFieldAnn; import lombok.Data; /** @@ -11,11 +12,33 @@ import lombok.Data; @Data public class DocImageInfo { + /** docId */ + @SqlOracleDbFieldAnn("DOC_ID") private Integer docId; + /** image id */ + @SqlOracleDbFieldAnn("IMAGE_FILE_ID") private Integer imageFileId; + /** 文件名称 */ + @SqlOracleDbFieldAnn("IMAGE_FILE_NAME") private String imageFileName; + + /** 创建时间 */ + @SqlOracleDbFieldAnn("DOC_CREATE_TIME") + private String docCreateTime; + + /** 创建日期 */ + @SqlOracleDbFieldAnn("DOC_CREATE_DATE") + private String docCreateDate; + /** 明细数据id */ + @SqlOracleDbFieldAnn("ID") private Integer id; + /** 其他id */ + @SqlOracleDbFieldAnn("DETAIL_ID") private Integer detailId; + /** 文件大小 */ + @SqlOracleDbFieldAnn("FILE_SIZE") private Integer fileSize; + /** 文件类型 */ + @SqlOracleDbFieldAnn("DOC_FILE_TYPE") private Integer docFileType; } diff --git a/src/main/java/aiyh/utils/entity/FieldViewInfo.java b/src/main/java/aiyh/utils/entity/FieldViewInfo.java index c76e2bb..0240c5f 100644 --- a/src/main/java/aiyh/utils/entity/FieldViewInfo.java +++ b/src/main/java/aiyh/utils/entity/FieldViewInfo.java @@ -6,7 +6,7 @@ import lombok.Setter; import lombok.ToString; /** - *

+ *

流程建模字段信息

* *

create: 2023/2/20 11:01

* diff --git a/src/main/java/aiyh/utils/entity/ModelTableInfo.java b/src/main/java/aiyh/utils/entity/ModelTableInfo.java new file mode 100644 index 0000000..e763cf7 --- /dev/null +++ b/src/main/java/aiyh/utils/entity/ModelTableInfo.java @@ -0,0 +1,28 @@ +package aiyh.utils.entity; + +import aiyh.utils.annotation.recordset.SqlOracleDbFieldAnn; +import lombok.Getter; +import lombok.Setter; +import lombok.ToString; + +/** + *

建模表信息

+ * + *

create: 2023/3/14 17:05

+ * + * @author youHong.ai + */ +@Getter +@Setter +@ToString +public class ModelTableInfo { + /** id */ + @SqlOracleDbFieldAnn("ID") + private String id; + + @SqlOracleDbFieldAnn("INDEX_DESC") + private String indexDesc; + /** 字段表名 */ + @SqlOracleDbFieldAnn("TABLE_NAME") + private String tableName; +} diff --git a/src/main/java/aiyh/utils/entity/SelectValueEntity.java b/src/main/java/aiyh/utils/entity/SelectValueEntity.java index 6411a50..28ba419 100644 --- a/src/main/java/aiyh/utils/entity/SelectValueEntity.java +++ b/src/main/java/aiyh/utils/entity/SelectValueEntity.java @@ -3,7 +3,7 @@ package aiyh.utils.entity; import lombok.Data; /** - *

+ *

下拉框字段信息

*

create 2022/6/10 21:21

* * @author ayh @@ -11,10 +11,10 @@ import lombok.Data; @Data public class SelectValueEntity { - private String id; - private String fieldname; - private String fieldlabel; - private String tablename; - private String selectname; - private Integer selectvalue; + private String id; + private String fieldname; + private String fieldlabel; + private String tablename; + private String selectname; + private Integer selectvalue; } diff --git a/src/main/java/aiyh/utils/fileUtil/WritWatermark.java b/src/main/java/aiyh/utils/fileUtil/WritWatermark.java index 1d73412..cd4267b 100644 --- a/src/main/java/aiyh/utils/fileUtil/WritWatermark.java +++ b/src/main/java/aiyh/utils/fileUtil/WritWatermark.java @@ -1,7 +1,6 @@ package aiyh.utils.fileUtil; import aiyh.utils.zwl.common.ToolUtil; -import sun.font.FontDesignMetrics; import weaver.conn.RecordSet; import weaver.file.FileUpload; import weaver.file.ImageFileManager; @@ -26,798 +25,799 @@ import java.util.UUID; public class WritWatermark { - - private static final ToolUtil toolUtil = new ToolUtil(); - - /** - * 根据系统中物理文件的id添加水印 - * - * @param imageId 物理文件id - * @param pressText 水印文字 - * @param color 水印文字颜色 - * @param fontName 水印文字字体 PLAIN（普通）　BOLD（粗体）　ITALIC（斜体） - * @param fontStyle 水印文字样式 - * @param fontSize 水印文字大小 - * @param watermarkPoint 水印位置对象 - * @param degree 旋转角度 - * @param alpha 透明度 0-1 - * @param lineSpacing 行间距（倍数） - * @return 带水印的物理图片的ID - * @throws IOException io异常 - */ - public static int addTextWatermarkById(int imageId, String pressText, Color color, String fontName, int fontStyle - , int fontSize, WatermarkPoint watermarkPoint, double degree, float alpha, double lineSpacing) throws IOException { - // 通过文件id获取输入流 - InputStream inputStreamById = ImageFileManager.getInputStreamById(imageId); - if (inputStreamById == null) { - throw new RuntimeException("Failed to obtain the image to which a watermark is to be added. " + - "Check whether the file exists in the system and ensure that the file is in the image format."); - } + + private static final ToolUtil toolUtil = new ToolUtil(); + + /** + * 根据系统中物理文件的id添加水印 + * + * @param imageId 物理文件id + * @param pressText 水印文字 + * @param color 水印文字颜色 + * @param fontName 水印文字字体 PLAIN（普通）　BOLD（粗体）　ITALIC（斜体） + * @param fontStyle 水印文字样式 + * @param fontSize 水印文字大小 + * @param watermarkPoint 水印位置对象 + * @param degree 旋转角度 + * @param alpha 透明度 0-1 + * @param lineSpacing 行间距（倍数） + * @return 带水印的物理图片的ID + * @throws IOException io异常 + */ + public static int addTextWatermarkById(int imageId, String pressText, Color color, String fontName, int fontStyle + , int fontSize, WatermarkPoint watermarkPoint, double degree, float alpha, double lineSpacing) throws IOException { + // 通过文件id获取输入流 + InputStream inputStreamById = ImageFileManager.getInputStreamById(imageId); + if (inputStreamById == null) { + throw new RuntimeException("Failed to obtain the image to which a watermark is to be added. " + + "Check whether the file exists in the system and ensure that the file is in the image format."); + } // 将输入流读取为图片 - Image image = ImageIO.read(inputStreamById); - int width = image.getWidth(null); - int height = image.getHeight(null); - // 创建bufferedImage - BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); - Graphics2D graphics = bufferedImage.createGraphics(); - // 设置对线段的锯齿状边缘处理 - graphics.setRenderingHint(RenderingHints.KEY_INTERPOLATION, - RenderingHints.VALUE_INTERPOLATION_BILINEAR); - graphics.drawImage(image, 0, 0, width, height, null); - String[] pressTexts = pressText.split("\n"); - String maxStr = ""; - int max = 0; + Image image = ImageIO.read(inputStreamById); + int width = image.getWidth(null); + int height = image.getHeight(null); + // 创建bufferedImage + BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); + Graphics2D graphics = bufferedImage.createGraphics(); + // 设置对线段的锯齿状边缘处理 + graphics.setRenderingHint(RenderingHints.KEY_INTERPOLATION, + RenderingHints.VALUE_INTERPOLATION_BILINEAR); + graphics.drawImage(image, 0, 0, width, height, null); + String[] pressTexts = pressText.split("\n"); + String maxStr = ""; + int max = 0; // 求出最大长度值 - for (String press : pressTexts) { - if (press.length() > max) { - max = press.length(); - maxStr = press; - } - } - String message = maxStr; - Font defaultFont = new Font(fontName, fontStyle, fontSize); - int wordWidth = getWordWidth(defaultFont, message); + for (String press : pressTexts) { + if (press.length() > max) { + max = press.length(); + maxStr = press; + } + } + String message = maxStr; + Font defaultFont = new Font(fontName, fontStyle, fontSize); + int wordWidth = getWordWidth(defaultFont, message, graphics); // 对字体进行限制 - if (wordWidth >= Math.min(width, height)) { - fontSize = Math.min(width, height) / (pressText.length() + 6); - } - toolUtil.writeDebuggerLog(String.format( - "图片宽度{%s}，图片高度{%s}，文字宽度{%s}，文字{%s}，字体大小{%s}，字体数量{%s}" - , width, height, wordWidth, message, fontSize, message.length())); - double lineHeight = fontSize * lineSpacing; - Font font = new Font(fontName, fontStyle, fontSize); - graphics.setColor(color); - graphics.setFont(font); + if (wordWidth >= Math.min(width, height)) { + fontSize = Math.min(width, height) / (pressText.length() + 6); + } + toolUtil.writeDebuggerLog(String.format( + "图片宽度{%s}，图片高度{%s}，文字宽度{%s}，文字{%s}，字体大小{%s}，字体数量{%s}" + , width, height, wordWidth, message, fontSize, message.length())); + double lineHeight = fontSize * lineSpacing; + Font font = new Font(fontName, fontStyle, fontSize); + graphics.setColor(color); + graphics.setFont(font); // 设置旋转角度 - graphics.rotate(Math.toRadians(degree), (double) width / 2, (double) height / 2); + graphics.rotate(Math.toRadians(degree), (double) width / 2, (double) height / 2); // 设置透明度 - graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); - - int X; - int Y; - int fontWidth = graphics.getFontMetrics(graphics.getFont()).charsWidth(maxStr.toCharArray(), 0, max); - int fontsHeight = (int) Math.round(lineHeight) * pressTexts.length; - if (watermarkPoint.getLocation() == null) { - X = watermarkPoint.getX(); - Y = watermarkPoint.getY(); - } else { - // 水印放在中间 - if (watermarkPoint.getLocation().equals(WatermarkPointEnum.CENTER)) { - X = (width / 2) - (fontWidth / 2); - Y = (height / 2) - (fontsHeight / 2); - } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.LEFT_TOP)) { - // 水印放在左上 - X = 10; - Y = 10; - } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.LEFT_BOTTOM)) { - // 水印放在左下 - X = 10; - Y = height - fontsHeight - 10; - } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.RIGHT_TOP)) { - // 水印放在右上 - X = width - fontWidth - 10; - Y = 10; - } else { - // 水印放在右下 - X = width - fontWidth - 10; - Y = height - fontsHeight - 10; - } - } - - for (int i = 0; i < pressTexts.length; i++) { + graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); + + int X; + int Y; + int fontWidth = graphics.getFontMetrics(graphics.getFont()).charsWidth(maxStr.toCharArray(), 0, max); + int fontsHeight = (int) Math.round(lineHeight) * pressTexts.length; + if (watermarkPoint.getLocation() == null) { + X = watermarkPoint.getX(); + Y = watermarkPoint.getY(); + } else { + // 水印放在中间 + if (watermarkPoint.getLocation().equals(WatermarkPointEnum.CENTER)) { + X = (width / 2) - (fontWidth / 2); + Y = (height / 2) - (fontsHeight / 2); + } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.LEFT_TOP)) { + // 水印放在左上 + X = 10; + Y = 10; + } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.LEFT_BOTTOM)) { + // 水印放在左下 + X = 10; + Y = height - fontsHeight - 10; + } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.RIGHT_TOP)) { + // 水印放在右上 + X = width - fontWidth - 10; + Y = 10; + } else { + // 水印放在右下 + X = width - fontWidth - 10; + Y = height - fontsHeight - 10; + } + } + + for (int i = 0; i < pressTexts.length; i++) { // 防止重叠，需要对Y进行特殊处理 - graphics.drawString(pressTexts[i], X, Y + ((int) Math.round(lineHeight) * (i + 1))); - } - graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); - graphics.dispose(); + graphics.drawString(pressTexts[i], X, Y + ((int) Math.round(lineHeight) * (i + 1))); + } + graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); + graphics.dispose(); // 获取图片后缀 - String query = "select imagefilename from imagefile where imagefileid = ?"; - RecordSet rs = new RecordSet(); - rs.executeQuery(query, imageId); - String suffix = "jpg"; - String imageFileName = ""; - if (rs.next()) { - imageFileName = Util.null2String(rs.getString(1)); - suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); - } - String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; + String query = "select imagefilename from imagefile where imagefileid = ?"; + RecordSet rs = new RecordSet(); + rs.executeQuery(query, imageId); + String suffix = "jpg"; + String imageFileName = ""; + if (rs.next()) { + imageFileName = Util.null2String(rs.getString(1)); + suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); + } + String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; // 防止高并发下文件名重复导致文件覆盖的问题 - String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + "." + suffix; - File file = new File(tempPath); - if (!file.getParentFile().exists()) { - file.getParentFile().mkdirs(); - } - if (!file.exists()) { - file.createNewFile(); - } + String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + "." + suffix; + File file = new File(tempPath); + if (!file.getParentFile().exists()) { + file.getParentFile().mkdirs(); + } + if (!file.exists()) { + file.createNewFile(); + } // 输出到临时目录 - FileOutputStream outputStreamTem = new FileOutputStream(URLDecoder.decode(tempPath, "utf-8")); - ImageIO.write(bufferedImage, suffix, outputStreamTem); - outputStreamTem.close(); + FileOutputStream outputStreamTem = new FileOutputStream(URLDecoder.decode(tempPath, "UTF-8")); + ImageIO.write(bufferedImage, suffix, outputStreamTem); + outputStreamTem.close(); // 保存生成的水印图片到压缩包 - int i = aiyh.utils.Util.createFileByInputSteam(new FileInputStream(tempPath), imageFileName); + int i = aiyh.utils.Util.createFileByInputSteam(new FileInputStream(tempPath), imageFileName); // 建议虚拟机进行一次垃圾回收，防止临时文件被其他文件流保存而无法删除临时文件 - System.gc(); + System.gc(); // 删除临时文件， 防止文件删除失败，设置一个自旋操作，加大文件删除的几率 - boolean deleteFlag = true; - int n = 0; - while (deleteFlag) { - try { - n++; - Files.delete(Paths.get(tempPath)); - deleteFlag = false; - } catch (Exception e) { + boolean deleteFlag = true; + int n = 0; + while (deleteFlag) { + try { + n++; + Files.delete(Paths.get(tempPath)); + deleteFlag = false; + } catch (Exception e) { // 设置线程沉睡500毫秒，等待jvm进行垃圾回收，将持有临时文件的流对象回收，确保临时文件能删除 - try { - Thread.sleep(500); - } catch (InterruptedException interruptedException) { - return i; - } - if (n > 5) { - deleteFlag = false; - } - } - } - return i; - } - - - /** - * 通过物理问文件id添加图片水印 - * - * @param imageId 物理文件id - * @param picId 水印图片物理文件id - * @param watermarkPoint 水印位置对象 - * @param degree 旋转角度 - * @param alpha 透明度 0-1 - * @return 带水印的物理图片的ID - * @throws IOException io异常 - */ - public static int addPicWatermarkById(int imageId, int picId - , WatermarkPoint watermarkPoint, double degree, float alpha) throws IOException { - ImageFileManager imageFileManager = new ImageFileManager(); - // 通过文件id获取输入流 - InputStream inputStreamById = ImageFileManager.getInputStreamById(imageId); - if (inputStreamById == null) { - throw new RuntimeException("Failed to obtain the image to which a watermark is to be added. " + - "Check whether the file exists in the system and ensure that the file is in the image format."); - } + try { + Thread.sleep(500); + } catch (InterruptedException interruptedException) { + return i; + } + if (n > 5) { + deleteFlag = false; + } + } + } + return i; + } + + + /** + * 通过物理问文件id添加图片水印 + * + * @param imageId 物理文件id + * @param picId 水印图片物理文件id + * @param watermarkPoint 水印位置对象 + * @param degree 旋转角度 + * @param alpha 透明度 0-1 + * @return 带水印的物理图片的ID + * @throws IOException io异常 + */ + public static int addPicWatermarkById(int imageId, int picId + , WatermarkPoint watermarkPoint, double degree, float alpha) throws IOException { + ImageFileManager imageFileManager = new ImageFileManager(); + // 通过文件id获取输入流 + InputStream inputStreamById = ImageFileManager.getInputStreamById(imageId); + if (inputStreamById == null) { + throw new RuntimeException("Failed to obtain the image to which a watermark is to be added. " + + "Check whether the file exists in the system and ensure that the file is in the image format."); + } // 将输入流读取为图片 - Image image = ImageIO.read(inputStreamById); - int width = image.getWidth(null); - int height = image.getHeight(null); - // 创建bufferedImage - BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); - Graphics2D graphics = bufferedImage.createGraphics(); - // 设置对线段的锯齿状边缘处理 - graphics.setRenderingHint(RenderingHints.KEY_INTERPOLATION, - RenderingHints.VALUE_INTERPOLATION_BILINEAR); - graphics.drawImage(image, 0, 0, width, height, null); + Image image = ImageIO.read(inputStreamById); + int width = image.getWidth(null); + int height = image.getHeight(null); + // 创建bufferedImage + BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); + Graphics2D graphics = bufferedImage.createGraphics(); + // 设置对线段的锯齿状边缘处理 + graphics.setRenderingHint(RenderingHints.KEY_INTERPOLATION, + RenderingHints.VALUE_INTERPOLATION_BILINEAR); + graphics.drawImage(image, 0, 0, width, height, null); // 设置旋转角度 - graphics.rotate(Math.toRadians(degree), (double) width / 2, (double) height / 2); + graphics.rotate(Math.toRadians(degree), (double) width / 2, (double) height / 2); // 设置透明度 - graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); + graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); // 获取水印图片 - InputStream inputStreamImgIcon = ImageFileManager.getInputStreamById(picId); - if (inputStreamImgIcon == null) { - throw new RuntimeException("The obtained watermark logo image is empty"); - } - Image logoImg = ImageIO.read(inputStreamImgIcon); - int logoWidth = logoImg.getWidth(null); - int logoHeight = logoImg.getHeight(null); - int X; - int Y; - if (watermarkPoint.getLocation() == null) { - X = watermarkPoint.getX(); - Y = watermarkPoint.getY(); - } else { - // 水印放在中间 - if (watermarkPoint.getLocation().equals(WatermarkPointEnum.CENTER)) { - X = (width / 2) - (logoWidth / 2); - Y = (height / 2) - (logoHeight / 2); - } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.LEFT_TOP)) { - // 水印放在左上 - X = 10; - Y = 10; - } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.LEFT_BOTTOM)) { - // 水印放在左下 - X = 10; - Y = height - logoHeight - 10; - } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.RIGHT_TOP)) { - // 水印放在右上 - X = width - logoWidth - 10; - Y = 10; - } else { - // 水印放在右下 - X = width - logoWidth - 10; - Y = height - logoHeight - 10; - } - } - graphics.drawImage(logoImg, X, Y, null); - graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); - graphics.dispose(); + InputStream inputStreamImgIcon = ImageFileManager.getInputStreamById(picId); + if (inputStreamImgIcon == null) { + throw new RuntimeException("The obtained watermark logo image is empty"); + } + Image logoImg = ImageIO.read(inputStreamImgIcon); + int logoWidth = logoImg.getWidth(null); + int logoHeight = logoImg.getHeight(null); + int X; + int Y; + if (watermarkPoint.getLocation() == null) { + X = watermarkPoint.getX(); + Y = watermarkPoint.getY(); + } else { + // 水印放在中间 + if (watermarkPoint.getLocation().equals(WatermarkPointEnum.CENTER)) { + X = (width / 2) - (logoWidth / 2); + Y = (height / 2) - (logoHeight / 2); + } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.LEFT_TOP)) { + // 水印放在左上 + X = 10; + Y = 10; + } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.LEFT_BOTTOM)) { + // 水印放在左下 + X = 10; + Y = height - logoHeight - 10; + } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.RIGHT_TOP)) { + // 水印放在右上 + X = width - logoWidth - 10; + Y = 10; + } else { + // 水印放在右下 + X = width - logoWidth - 10; + Y = height - logoHeight - 10; + } + } + graphics.drawImage(logoImg, X, Y, null); + graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); + graphics.dispose(); // 获取图片后缀 - String query = "select imagefilename from imagefile where imagefileid = ?"; - RecordSet rs = new RecordSet(); - rs.executeQuery(query, imageId); - String suffix = "jpg"; - String imageFileName = ""; - if (rs.next()) { - imageFileName = Util.null2String(rs.getString(1)); - suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); - } - String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; + String query = "select imagefilename from imagefile where imagefileid = ?"; + RecordSet rs = new RecordSet(); + rs.executeQuery(query, imageId); + String suffix = "jpg"; + String imageFileName = ""; + if (rs.next()) { + imageFileName = Util.null2String(rs.getString(1)); + suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); + } + String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; // 防止高并发下文件名重复导致文件覆盖的问题 - String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + "." + suffix; - File file = new File(tempPath); - if (!file.getParentFile().exists()) { - file.getParentFile().mkdirs(); - } - if (!file.exists()) { - file.createNewFile(); - } + String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + "." + suffix; + File file = new File(tempPath); + if (!file.getParentFile().exists()) { + file.getParentFile().mkdirs(); + } + if (!file.exists()) { + file.createNewFile(); + } // 输出到临时目录 - FileOutputStream outputStreamTem = new FileOutputStream(URLDecoder.decode(tempPath, "utf-8")); - ImageIO.write(bufferedImage, suffix, outputStreamTem); - outputStreamTem.close(); + FileOutputStream outputStreamTem = new FileOutputStream(URLDecoder.decode(tempPath, "UTF-8")); + ImageIO.write(bufferedImage, suffix, outputStreamTem); + outputStreamTem.close(); // 保存生成的水印图片到压缩包 - int i = aiyh.utils.Util.createFileByInputSteam(new FileInputStream(tempPath), imageFileName); + int i = aiyh.utils.Util.createFileByInputSteam(new FileInputStream(tempPath), imageFileName); // 建议虚拟机进行一次垃圾回收，防止临时文件被其他文件流保存而无法删除临时文件 - System.gc(); + System.gc(); // 删除临时文件， 防止文件删除失败，设置一个自旋操作，加大文件删除的几率 - boolean deleteFlag = true; - int n = 0; - while (deleteFlag) { - try { - n++; - Files.delete(Paths.get(tempPath)); - deleteFlag = false; - } catch (Exception e) { + boolean deleteFlag = true; + int n = 0; + while (deleteFlag) { + try { + n++; + Files.delete(Paths.get(tempPath)); + deleteFlag = false; + } catch (Exception e) { // 设置线程沉睡500毫秒，等待jvm进行垃圾回收，将持有临时文件的流对象回收，确保临时文件能删除 - try { - Thread.sleep(500); - } catch (InterruptedException interruptedException) { - return i; - } - if (n > 5) { - deleteFlag = false; - } - } - } - return i; - } - - - /** - * 通过物理问文件id添加图片水印 - * - * @param imageId 水印图片物理文件id - * @param logoInput 水印图片的输入流 - * @param watermarkPoint 水印位置对象 - * @param degree 旋转角度 - * @param alpha 透明度 0-1 - * @return 带水印的物理图片的ID - * @throws IOException io异常 - */ - public static int addPicWatermarkById(int imageId, InputStream logoInput - , WatermarkPoint watermarkPoint, double degree, float alpha) throws IOException { - ImageFileManager imageFileManager = new ImageFileManager(); - // 通过文件id获取输入流 - InputStream inputStreamById = ImageFileManager.getInputStreamById(imageId); - if (inputStreamById == null) { - throw new RuntimeException("Failed to obtain the image to which a watermark is to be added. " + - "Check whether the file exists in the system and ensure that the file is in the image format."); - } + try { + Thread.sleep(500); + } catch (InterruptedException interruptedException) { + return i; + } + if (n > 5) { + deleteFlag = false; + } + } + } + return i; + } + + + /** + * 通过物理问文件id添加图片水印 + * + * @param imageId 水印图片物理文件id + * @param logoInput 水印图片的输入流 + * @param watermarkPoint 水印位置对象 + * @param degree 旋转角度 + * @param alpha 透明度 0-1 + * @return 带水印的物理图片的ID + * @throws IOException io异常 + */ + public static int addPicWatermarkById(int imageId, InputStream logoInput + , WatermarkPoint watermarkPoint, double degree, float alpha) throws IOException { + ImageFileManager imageFileManager = new ImageFileManager(); + // 通过文件id获取输入流 + InputStream inputStreamById = ImageFileManager.getInputStreamById(imageId); + if (inputStreamById == null) { + throw new RuntimeException("Failed to obtain the image to which a watermark is to be added. " + + "Check whether the file exists in the system and ensure that the file is in the image format."); + } // 将输入流读取为图片 - Image image = ImageIO.read(inputStreamById); - int width = image.getWidth(null); - int height = image.getHeight(null); - // 创建bufferedImage - BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); - Graphics2D graphics = bufferedImage.createGraphics(); - // 设置对线段的锯齿状边缘处理 - graphics.setRenderingHint(RenderingHints.KEY_INTERPOLATION, - RenderingHints.VALUE_INTERPOLATION_BILINEAR); - graphics.drawImage(image, 0, 0, width, height, null); + Image image = ImageIO.read(inputStreamById); + int width = image.getWidth(null); + int height = image.getHeight(null); + // 创建bufferedImage + BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); + Graphics2D graphics = bufferedImage.createGraphics(); + // 设置对线段的锯齿状边缘处理 + graphics.setRenderingHint(RenderingHints.KEY_INTERPOLATION, + RenderingHints.VALUE_INTERPOLATION_BILINEAR); + graphics.drawImage(image, 0, 0, width, height, null); // 设置旋转角度 - graphics.rotate(Math.toRadians(degree), (double) width / 2, (double) height / 2); + graphics.rotate(Math.toRadians(degree), (double) width / 2, (double) height / 2); // 设置透明度 - graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); - if (logoInput == null) { - throw new RuntimeException("The obtained watermark logo image is empty"); - } + graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); + if (logoInput == null) { + throw new RuntimeException("The obtained watermark logo image is empty"); + } // 获取水印图片 - ImageIcon logoImgIcon = new ImageIcon(ImageIO.read(logoInput)); - Image logoImg = logoImgIcon.getImage(); - int logoWidth = logoImg.getWidth(null); - int logoHeight = logoImg.getHeight(null); - int X; - int Y; - if (watermarkPoint.getLocation() == null) { - X = watermarkPoint.getX(); - Y = watermarkPoint.getY(); - } else { - // 水印放在中间 - if (watermarkPoint.getLocation().equals(WatermarkPointEnum.CENTER)) { - X = (width / 2) - (logoWidth / 2); - Y = (height / 2) - (logoHeight / 2); - } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.LEFT_TOP)) { - // 水印放在左上 - X = 10; - Y = 10; - } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.LEFT_BOTTOM)) { - // 水印放在左下 - X = 10; - Y = height - logoHeight - 10; - } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.RIGHT_TOP)) { - // 水印放在右上 - X = width - logoWidth - 10; - Y = 10; - } else { - // 水印放在右下 - X = width - logoWidth - 10; - Y = height - logoHeight - 10; - } - } - graphics.drawImage(logoImg, X, Y, null); - graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); - graphics.dispose(); + ImageIcon logoImgIcon = new ImageIcon(ImageIO.read(logoInput)); + Image logoImg = logoImgIcon.getImage(); + int logoWidth = logoImg.getWidth(null); + int logoHeight = logoImg.getHeight(null); + int X; + int Y; + if (watermarkPoint.getLocation() == null) { + X = watermarkPoint.getX(); + Y = watermarkPoint.getY(); + } else { + // 水印放在中间 + if (watermarkPoint.getLocation().equals(WatermarkPointEnum.CENTER)) { + X = (width / 2) - (logoWidth / 2); + Y = (height / 2) - (logoHeight / 2); + } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.LEFT_TOP)) { + // 水印放在左上 + X = 10; + Y = 10; + } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.LEFT_BOTTOM)) { + // 水印放在左下 + X = 10; + Y = height - logoHeight - 10; + } else if (watermarkPoint.getLocation().equals(WatermarkPointEnum.RIGHT_TOP)) { + // 水印放在右上 + X = width - logoWidth - 10; + Y = 10; + } else { + // 水印放在右下 + X = width - logoWidth - 10; + Y = height - logoHeight - 10; + } + } + graphics.drawImage(logoImg, X, Y, null); + graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); + graphics.dispose(); // 获取图片后缀 - String query = "select imagefilename from imagefile where imagefileid = ?"; - RecordSet rs = new RecordSet(); - rs.executeQuery(query, imageId); - String suffix = "jpg"; - String imageFileName = ""; - if (rs.next()) { - imageFileName = Util.null2String(rs.getString(1)); - suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); - } - String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; + String query = "select imagefilename from imagefile where imagefileid = ?"; + RecordSet rs = new RecordSet(); + rs.executeQuery(query, imageId); + String suffix = "jpg"; + String imageFileName = ""; + if (rs.next()) { + imageFileName = Util.null2String(rs.getString(1)); + suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); + } + String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; // 防止高并发下文件名重复导致文件覆盖的问题 - String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + "." + suffix; - File file = new File(tempPath); - if (!file.getParentFile().exists()) { - file.getParentFile().mkdirs(); - } - if (!file.exists()) { - file.createNewFile(); - } + String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + "." + suffix; + File file = new File(tempPath); + if (!file.getParentFile().exists()) { + file.getParentFile().mkdirs(); + } + if (!file.exists()) { + file.createNewFile(); + } // 输出到临时目录 - FileOutputStream outputStreamTem = new FileOutputStream(URLDecoder.decode(tempPath, "utf-8")); - ImageIO.write(bufferedImage, suffix, outputStreamTem); - outputStreamTem.close(); + FileOutputStream outputStreamTem = new FileOutputStream(URLDecoder.decode(tempPath, "UTF-8")); + ImageIO.write(bufferedImage, suffix, outputStreamTem); + outputStreamTem.close(); // 保存生成的水印图片到压缩包 - int i = aiyh.utils.Util.createFileByInputSteam(new FileInputStream(tempPath), imageFileName); + int i = aiyh.utils.Util.createFileByInputSteam(new FileInputStream(tempPath), imageFileName); // 建议虚拟机进行一次垃圾回收，防止临时文件被其他文件流保存而无法删除临时文件 - System.gc(); + System.gc(); // 删除临时文件， 防止文件删除失败，设置一个自旋操作，加大文件删除的几率 - boolean deleteFlag = true; - int n = 0; - while (deleteFlag) { - try { - n++; - Files.delete(Paths.get(tempPath)); - deleteFlag = false; - } catch (Exception e) { + boolean deleteFlag = true; + int n = 0; + while (deleteFlag) { + try { + n++; + Files.delete(Paths.get(tempPath)); + deleteFlag = false; + } catch (Exception e) { // 设置线程沉睡500毫秒，等待jvm进行垃圾回收，将持有临时文件的流对象回收，确保临时文件能删除 - try { - Thread.sleep(500); - } catch (InterruptedException interruptedException) { - return i; - } - if (n > 5) { - deleteFlag = false; - } - } - } - return i; - } - - /** - * @param imageId 物理图片id - * @param pressText 水印文字 - * @param color 水印文字颜色 - * @param fontName 水印字体名字 - * @param fontStyle 水印字体样式 - * @param fontSize 水印字体大小 - * @param degree 水印旋转角度 - * @param alpha 水印透明度 - * @param lineSpacing 水印文字行间距（倍数） - * @param moveX 水印X轴偏移量 - * @param moveY 水印Y轴偏移量 - * @param randomX 水印X轴随机偏移量 - * @return 带水印的物理图片id - * @throws IOException io异常 - */ - public static int addTextTileWatermarkById(int imageId, String pressText, Color color, String fontName, int fontStyle - , int fontSize, double degree, float alpha, double lineSpacing, int moveX, int moveY, int randomX) throws IOException { - ImageFileManager imageFileManager = new ImageFileManager(); - // 通过文件id获取输入流 - InputStream inputStreamById = ImageFileManager.getInputStreamById(imageId); - if (inputStreamById == null) { - throw new RuntimeException("Failed to obtain the image to which a watermark is to be added. " + - "Check whether the file exists in the system and ensure that the file is in the image format."); - } + try { + Thread.sleep(500); + } catch (InterruptedException interruptedException) { + return i; + } + if (n > 5) { + deleteFlag = false; + } + } + } + return i; + } + + /** + * @param imageId 物理图片id + * @param pressText 水印文字 + * @param color 水印文字颜色 + * @param fontName 水印字体名字 + * @param fontStyle 水印字体样式 + * @param fontSize 水印字体大小 + * @param degree 水印旋转角度 + * @param alpha 水印透明度 + * @param lineSpacing 水印文字行间距（倍数） + * @param moveX 水印X轴偏移量 + * @param moveY 水印Y轴偏移量 + * @param randomX 水印X轴随机偏移量 + * @return 带水印的物理图片id + * @throws IOException io异常 + */ + public static int addTextTileWatermarkById(int imageId, String pressText, Color color, String fontName, int fontStyle + , int fontSize, double degree, float alpha, double lineSpacing, int moveX, int moveY, int randomX) throws IOException { + ImageFileManager imageFileManager = new ImageFileManager(); + // 通过文件id获取输入流 + InputStream inputStreamById = ImageFileManager.getInputStreamById(imageId); + if (inputStreamById == null) { + throw new RuntimeException("Failed to obtain the image to which a watermark is to be added. " + + "Check whether the file exists in the system and ensure that the file is in the image format."); + } // 将输入流读取为图片 - Image image = ImageIO.read(inputStreamById); - int width = image.getWidth(null); - int height = image.getHeight(null); - double lineHeight = fontSize * lineSpacing; - // 创建bufferedImage - BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); - Graphics2D graphics = bufferedImage.createGraphics(); - // 设置对线段的锯齿状边缘处理 - graphics.setRenderingHint(RenderingHints.KEY_INTERPOLATION, - RenderingHints.VALUE_INTERPOLATION_BILINEAR); - graphics.drawImage(image, 0, 0, width, height, null); - Font font = new Font(fontName, fontStyle, fontSize); - graphics.setColor(color); - graphics.setFont(font); + Image image = ImageIO.read(inputStreamById); + int width = image.getWidth(null); + int height = image.getHeight(null); + double lineHeight = fontSize * lineSpacing; + // 创建bufferedImage + BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); + Graphics2D graphics = bufferedImage.createGraphics(); + // 设置对线段的锯齿状边缘处理 + graphics.setRenderingHint(RenderingHints.KEY_INTERPOLATION, + RenderingHints.VALUE_INTERPOLATION_BILINEAR); + graphics.drawImage(image, 0, 0, width, height, null); + Font font = new Font(fontName, fontStyle, fontSize); + graphics.setColor(color); + graphics.setFont(font); // 设置旋转角度 - graphics.rotate(Math.toRadians(degree), (double) width / 2, (double) height / 2); + graphics.rotate(Math.toRadians(degree), (double) width / 2, (double) height / 2); // 设置透明度 - graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); - String[] pressTexts = pressText.split("\n"); - String maxStr = ""; - int max = 0; + graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); + String[] pressTexts = pressText.split("\n"); + String maxStr = ""; + int max = 0; // 求出最大长度值 - for (String press : pressTexts) { - if (press.length() > max) { - max = press.length(); - maxStr = press; - } - } - int X; - int Y; - int fontWidth = graphics.getFontMetrics(graphics.getFont()).charsWidth(maxStr.toCharArray(), 0, max); - int fontsHeight = (int) Math.round(lineHeight) * pressTexts.length; - int mustX = fontWidth; - int mustY = fontsHeight; - int start = -(width + height); - int end = width + height; - X = start; - Y = start; - int random = 0; - - // 循环Y，每次偏移防止重叠的最小偏移量加上自定义的偏移量 - for (; Y <= end; Y = Y + moveY + mustY) { - // 循环X,每次偏移防止重叠的最小偏移量加上自定义偏移量 - for (; X <= end; X = X + moveX + mustX) { - for (int i = 0; i < pressTexts.length; i++) { - // 防止重叠对Y做文字偏移 - graphics.drawString(pressTexts[i], X + random, Y + (int) Math.ceil(lineHeight) * (i + 1)); - } - - } - X = start; - if (random == 0) { - random = -randomX; - } else { - random = 0; - } - } - - graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); - graphics.dispose(); + for (String press : pressTexts) { + if (press.length() > max) { + max = press.length(); + maxStr = press; + } + } + int X; + int Y; + int fontWidth = graphics.getFontMetrics(graphics.getFont()).charsWidth(maxStr.toCharArray(), 0, max); + int fontsHeight = (int) Math.round(lineHeight) * pressTexts.length; + int mustX = fontWidth; + int mustY = fontsHeight; + int start = -(width + height); + int end = width + height; + X = start; + Y = start; + int random = 0; + + // 循环Y，每次偏移防止重叠的最小偏移量加上自定义的偏移量 + for (; Y <= end; Y = Y + moveY + mustY) { + // 循环X,每次偏移防止重叠的最小偏移量加上自定义偏移量 + for (; X <= end; X = X + moveX + mustX) { + for (int i = 0; i < pressTexts.length; i++) { + // 防止重叠对Y做文字偏移 + graphics.drawString(pressTexts[i], X + random, Y + (int) Math.ceil(lineHeight) * (i + 1)); + } + + } + X = start; + if (random == 0) { + random = -randomX; + } else { + random = 0; + } + } + + graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); + graphics.dispose(); // 获取图片后缀 - String query = "select imagefilename from imagefile where imagefileid = ?"; - RecordSet rs = new RecordSet(); - rs.executeQuery(query, imageId); - String suffix = "jpg"; - String imageFileName = ""; - if (rs.next()) { - imageFileName = Util.null2String(rs.getString(1)); - suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); - } - String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; + String query = "select imagefilename from imagefile where imagefileid = ?"; + RecordSet rs = new RecordSet(); + rs.executeQuery(query, imageId); + String suffix = "jpg"; + String imageFileName = ""; + if (rs.next()) { + imageFileName = Util.null2String(rs.getString(1)); + suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); + } + String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; // 防止高并发下文件名重复导致文件覆盖的问题 - String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + "." + suffix; - File file = new File(tempPath); - if (!file.getParentFile().exists()) { - file.getParentFile().mkdirs(); - } - if (!file.exists()) { - file.createNewFile(); - } + String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + "." + suffix; + File file = new File(tempPath); + if (!file.getParentFile().exists()) { + file.getParentFile().mkdirs(); + } + if (!file.exists()) { + file.createNewFile(); + } // 输出到临时目录 - FileOutputStream outputStreamTem = new FileOutputStream(URLDecoder.decode(tempPath, "utf-8")); - ImageIO.write(bufferedImage, suffix, outputStreamTem); - outputStreamTem.close(); + FileOutputStream outputStreamTem = new FileOutputStream(URLDecoder.decode(tempPath, "UTF-8")); + ImageIO.write(bufferedImage, suffix, outputStreamTem); + outputStreamTem.close(); // 保存生成的水印图片到压缩包 - int i = aiyh.utils.Util.createFileByInputSteam(new FileInputStream(tempPath), imageFileName); + int i = aiyh.utils.Util.createFileByInputSteam(new FileInputStream(tempPath), imageFileName); // 建议虚拟机进行一次垃圾回收，防止临时文件被其他文件流保存而无法删除临时文件 - System.gc(); + System.gc(); // 删除临时文件， 防止文件删除失败，设置一个自旋操作，加大文件删除的几率 - boolean deleteFlag = true; - int n = 0; - while (deleteFlag) { - try { - n++; - Files.delete(Paths.get(tempPath)); - deleteFlag = false; - } catch (Exception e) { + boolean deleteFlag = true; + int n = 0; + while (deleteFlag) { + try { + n++; + Files.delete(Paths.get(tempPath)); + deleteFlag = false; + } catch (Exception e) { // 设置线程沉睡500毫秒，等待jvm进行垃圾回收，将持有临时文件的流对象回收，确保临时文件能删除 - try { - Thread.sleep(500); - } catch (InterruptedException interruptedException) { - return i; - } - if (n > 5) { - deleteFlag = false; - } - } - } - return i; - } - - /** - * @param imageId 物理图片id - * @param picId 水印物理文件id - * @param degree 水印旋转角度 - * @param alpha 水印透明度 - * @param moveX 水印X轴偏移量 - * @param moveY 水印Y轴偏移量 - * @param randomX 水印X轴随机偏移量 - * @return 带水印的物理图片id - * @throws IOException io异常 - */ - public static int addPicTileWatermarkById(int imageId, int picId - , double degree, float alpha, int moveX, int moveY, int randomX) throws IOException { - ImageFileManager imageFileManager = new ImageFileManager(); - // 通过文件id获取输入流 - InputStream inputStreamById = ImageFileManager.getInputStreamById(imageId); - if (inputStreamById == null) { - throw new RuntimeException("Failed to obtain the image to which a watermark is to be added. " + - "Check whether the file exists in the system and ensure that the file is in the image format."); - } + try { + Thread.sleep(500); + } catch (InterruptedException interruptedException) { + return i; + } + if (n > 5) { + deleteFlag = false; + } + } + } + return i; + } + + /** + * @param imageId 物理图片id + * @param picId 水印物理文件id + * @param degree 水印旋转角度 + * @param alpha 水印透明度 + * @param moveX 水印X轴偏移量 + * @param moveY 水印Y轴偏移量 + * @param randomX 水印X轴随机偏移量 + * @return 带水印的物理图片id + * @throws IOException io异常 + */ + public static int addPicTileWatermarkById(int imageId, int picId + , double degree, float alpha, int moveX, int moveY, int randomX) throws IOException { + ImageFileManager imageFileManager = new ImageFileManager(); + // 通过文件id获取输入流 + InputStream inputStreamById = ImageFileManager.getInputStreamById(imageId); + if (inputStreamById == null) { + throw new RuntimeException("Failed to obtain the image to which a watermark is to be added. " + + "Check whether the file exists in the system and ensure that the file is in the image format."); + } // 将输入流读取为图片 - Image image = ImageIO.read(inputStreamById); - int width = image.getWidth(null); - int height = image.getHeight(null); - // 创建bufferedImage - BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); - Graphics2D graphics = bufferedImage.createGraphics(); - // 设置对线段的锯齿状边缘处理 - graphics.setRenderingHint(RenderingHints.KEY_INTERPOLATION, - RenderingHints.VALUE_INTERPOLATION_BILINEAR); - graphics.drawImage(image, 0, 0, width, height, null); + Image image = ImageIO.read(inputStreamById); + int width = image.getWidth(null); + int height = image.getHeight(null); + // 创建bufferedImage + BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); + Graphics2D graphics = bufferedImage.createGraphics(); + // 设置对线段的锯齿状边缘处理 + graphics.setRenderingHint(RenderingHints.KEY_INTERPOLATION, + RenderingHints.VALUE_INTERPOLATION_BILINEAR); + graphics.drawImage(image, 0, 0, width, height, null); // 设置旋转角度 - graphics.rotate(Math.toRadians(degree), (double) width / 2, (double) height / 2); + graphics.rotate(Math.toRadians(degree), (double) width / 2, (double) height / 2); // 设置透明度 - graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); + graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); // 获取水印图片 - InputStream inputStreamImgIcon = ImageFileManager.getInputStreamById(picId); - if (inputStreamImgIcon == null) { - throw new RuntimeException("The obtained watermark logo image is empty"); - } - ImageIcon logoImgIcon = new ImageIcon(ImageIO.read(inputStreamImgIcon)); - Image logoImg = logoImgIcon.getImage(); - int logoWidth = logoImg.getWidth(null); - int logoHeight = logoImg.getHeight(null); - int X; - int Y; - int mustX = logoWidth; - int mustY = logoHeight; - int start = -(width + height); - int end = width + height; - X = start; - Y = start; - int random = 0; - - // 循环Y，每次偏移防止重叠的最小偏移量加上自定义的偏移量 - for (; Y <= end; Y = Y + moveY + mustY) { - // 循环X,每次偏移防止重叠的最小偏移量加上自定义偏移量 - for (; X <= end; X = X + moveX + mustX) { - graphics.drawImage(logoImg, X + random, Y, null); - } - X = start; - if (random == 0) { - random = -randomX; - } else { - random = 0; - } - } - graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); - graphics.dispose(); + InputStream inputStreamImgIcon = ImageFileManager.getInputStreamById(picId); + if (inputStreamImgIcon == null) { + throw new RuntimeException("The obtained watermark logo image is empty"); + } + ImageIcon logoImgIcon = new ImageIcon(ImageIO.read(inputStreamImgIcon)); + Image logoImg = logoImgIcon.getImage(); + int logoWidth = logoImg.getWidth(null); + int logoHeight = logoImg.getHeight(null); + int X; + int Y; + int mustX = logoWidth; + int mustY = logoHeight; + int start = -(width + height); + int end = width + height; + X = start; + Y = start; + int random = 0; + + // 循环Y，每次偏移防止重叠的最小偏移量加上自定义的偏移量 + for (; Y <= end; Y = Y + moveY + mustY) { + // 循环X,每次偏移防止重叠的最小偏移量加上自定义偏移量 + for (; X <= end; X = X + moveX + mustX) { + graphics.drawImage(logoImg, X + random, Y, null); + } + X = start; + if (random == 0) { + random = -randomX; + } else { + random = 0; + } + } + graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); + graphics.dispose(); // 获取图片后缀 - String query = "select imagefilename from imagefile where imagefileid = ?"; - RecordSet rs = new RecordSet(); - rs.executeQuery(query, imageId); - String suffix = "jpg"; - String imageFileName = ""; - if (rs.next()) { - imageFileName = Util.null2String(rs.getString(1)); - suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); - } - String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; + String query = "select imagefilename from imagefile where imagefileid = ?"; + RecordSet rs = new RecordSet(); + rs.executeQuery(query, imageId); + String suffix = "jpg"; + String imageFileName = ""; + if (rs.next()) { + imageFileName = Util.null2String(rs.getString(1)); + suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); + } + String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; // 防止高并发下文件名重复导致文件覆盖的问题 - String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + "." + suffix; - File file = new File(tempPath); - if (!file.getParentFile().exists()) { - file.getParentFile().mkdirs(); - } - if (!file.exists()) { - file.createNewFile(); - } + String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + "." + suffix; + File file = new File(tempPath); + if (!file.getParentFile().exists()) { + file.getParentFile().mkdirs(); + } + if (!file.exists()) { + file.createNewFile(); + } // 输出到临时目录 - FileOutputStream outputStreamTem = new FileOutputStream(URLDecoder.decode(tempPath, "utf-8")); - ImageIO.write(bufferedImage, suffix, outputStreamTem); - outputStreamTem.close(); + FileOutputStream outputStreamTem = new FileOutputStream(URLDecoder.decode(tempPath, "UTF-8")); + ImageIO.write(bufferedImage, suffix, outputStreamTem); + outputStreamTem.close(); // 保存生成的水印图片到压缩包 - int i = aiyh.utils.Util.createFileByInputSteam(new FileInputStream(tempPath), imageFileName); + int i = aiyh.utils.Util.createFileByInputSteam(new FileInputStream(tempPath), imageFileName); // 建议虚拟机进行一次垃圾回收，防止临时文件被其他文件流保存而无法删除临时文件 - System.gc(); + System.gc(); // 删除临时文件， 防止文件删除失败，设置一个自旋操作，加大文件删除的几率 - boolean deleteFlag = true; - int n = 0; - while (deleteFlag) { - try { - n++; - Files.delete(Paths.get(tempPath)); - deleteFlag = false; - } catch (Exception e) { + boolean deleteFlag = true; + int n = 0; + while (deleteFlag) { + try { + n++; + Files.delete(Paths.get(tempPath)); + deleteFlag = false; + } catch (Exception e) { // 设置线程沉睡500毫秒，等待jvm进行垃圾回收，将持有临时文件的流对象回收，确保临时文件能删除 - try { - Thread.sleep(500); - } catch (InterruptedException interruptedException) { - return i; - } - if (n > 5) { - deleteFlag = false; - } - } - } - return i; - } - - - /** - * @param imageId 物理图片id - * @param logoInput 水印图片输入流 - * @param degree 水印旋转角度 - * @param alpha 水印透明度 - * @param moveX 水印X轴偏移位置 - * @param moveY 水印Y轴偏移位置 - * @param randomX 水印X轴随机偏移量 - * @return 带水印的物理图片id - * @throws IOException io异常 - */ - public static int addPicTileWatermarkById(int imageId, InputStream logoInput - , double degree, float alpha, int moveX, int moveY, int randomX) throws IOException { - ImageFileManager imageFileManager = new ImageFileManager(); - // 通过文件id获取输入流 - InputStream inputStreamById = ImageFileManager.getInputStreamById(imageId); - if (inputStreamById == null) { - throw new RuntimeException("Failed to obtain the image to which a watermark is to be added. " + - "Check whether the file exists in the system and ensure that the file is in the image format."); - } + try { + Thread.sleep(500); + } catch (InterruptedException interruptedException) { + return i; + } + if (n > 5) { + deleteFlag = false; + } + } + } + return i; + } + + + /** + * @param imageId 物理图片id + * @param logoInput 水印图片输入流 + * @param degree 水印旋转角度 + * @param alpha 水印透明度 + * @param moveX 水印X轴偏移位置 + * @param moveY 水印Y轴偏移位置 + * @param randomX 水印X轴随机偏移量 + * @return 带水印的物理图片id + * @throws IOException io异常 + */ + public static int addPicTileWatermarkById(int imageId, InputStream logoInput + , double degree, float alpha, int moveX, int moveY, int randomX) throws IOException { + ImageFileManager imageFileManager = new ImageFileManager(); + // 通过文件id获取输入流 + InputStream inputStreamById = ImageFileManager.getInputStreamById(imageId); + if (inputStreamById == null) { + throw new RuntimeException("Failed to obtain the image to which a watermark is to be added. " + + "Check whether the file exists in the system and ensure that the file is in the image format."); + } // 将输入流读取为图片 - Image image = ImageIO.read(inputStreamById); - int width = image.getWidth(null); - int height = image.getHeight(null); - // 创建bufferedImage - BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); - Graphics2D graphics = bufferedImage.createGraphics(); - // 设置对线段的锯齿状边缘处理 - graphics.setRenderingHint(RenderingHints.KEY_INTERPOLATION, - RenderingHints.VALUE_INTERPOLATION_BILINEAR); - graphics.drawImage(image, 0, 0, width, height, null); + Image image = ImageIO.read(inputStreamById); + int width = image.getWidth(null); + int height = image.getHeight(null); + // 创建bufferedImage + BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); + Graphics2D graphics = bufferedImage.createGraphics(); + // 设置对线段的锯齿状边缘处理 + graphics.setRenderingHint(RenderingHints.KEY_INTERPOLATION, + RenderingHints.VALUE_INTERPOLATION_BILINEAR); + graphics.drawImage(image, 0, 0, width, height, null); // 设置旋转角度 - graphics.rotate(Math.toRadians(degree), (double) width / 2, (double) height / 2); + graphics.rotate(Math.toRadians(degree), (double) width / 2, (double) height / 2); // 设置透明度 - graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); - if (logoInput == null) { - throw new RuntimeException("The obtained watermark logo image is empty"); - } + graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); + if (logoInput == null) { + throw new RuntimeException("The obtained watermark logo image is empty"); + } // 获取水印图片 - ImageIcon logoImgIcon = new ImageIcon(ImageIO.read(logoInput)); - Image logoImg = logoImgIcon.getImage(); - int logoWidth = logoImg.getWidth(null); - int logoHeight = logoImg.getHeight(null); - int X; - int Y; - int mustX = logoWidth; - int mustY = logoHeight; - int start = -(width + height); - int end = width + height; - X = start; - Y = start; - int random = 0; - - // 循环Y，每次偏移防止重叠的最小偏移量加上自定义的偏移量 - for (; Y <= end; Y = Y + moveY + mustY) { - // 循环X,每次偏移防止重叠的最小偏移量加上自定义偏移量 - for (; X <= end; X = X + moveX + mustX) { - graphics.drawImage(logoImg, X + random, Y, null); - } - X = start; - if (random == 0) { - random = -randomX; - } else { - random = 0; - } - } - graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); - graphics.dispose(); + ImageIcon logoImgIcon = new ImageIcon(ImageIO.read(logoInput)); + Image logoImg = logoImgIcon.getImage(); + int logoWidth = logoImg.getWidth(null); + int logoHeight = logoImg.getHeight(null); + int X; + int Y; + int mustX = logoWidth; + int mustY = logoHeight; + int start = -(width + height); + int end = width + height; + X = start; + Y = start; + int random = 0; + + // 循环Y，每次偏移防止重叠的最小偏移量加上自定义的偏移量 + for (; Y <= end; Y = Y + moveY + mustY) { + // 循环X,每次偏移防止重叠的最小偏移量加上自定义偏移量 + for (; X <= end; X = X + moveX + mustX) { + graphics.drawImage(logoImg, X + random, Y, null); + } + X = start; + if (random == 0) { + random = -randomX; + } else { + random = 0; + } + } + graphics.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER)); + graphics.dispose(); // 获取图片后缀 - String query = "select imagefilename from imagefile where imagefileid = ?"; - RecordSet rs = new RecordSet(); - rs.executeQuery(query, imageId); - String suffix = "jpg"; - String imageFileName = ""; - if (rs.next()) { - imageFileName = Util.null2String(rs.getString(1)); - suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); - } - String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; + String query = "select imagefilename from imagefile where imagefileid = ?"; + RecordSet rs = new RecordSet(); + rs.executeQuery(query, imageId); + String suffix = "jpg"; + String imageFileName = ""; + if (rs.next()) { + imageFileName = Util.null2String(rs.getString(1)); + suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); + } + String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; // 防止高并发下文件名重复导致文件覆盖的问题 - String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + "." + suffix; - File file = new File(tempPath); - if (!file.getParentFile().exists()) { - file.getParentFile().mkdirs(); - } - if (!file.exists()) { - file.createNewFile(); - } + String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + "." + suffix; + File file = new File(tempPath); + if (!file.getParentFile().exists()) { + file.getParentFile().mkdirs(); + } + if (!file.exists()) { + file.createNewFile(); + } // 输出到临时目录 - FileOutputStream outputStreamTem = new FileOutputStream(URLDecoder.decode(tempPath, "utf-8")); - ImageIO.write(bufferedImage, suffix, outputStreamTem); - outputStreamTem.close(); + FileOutputStream outputStreamTem = new FileOutputStream(URLDecoder.decode(tempPath, "UTF-8")); + ImageIO.write(bufferedImage, suffix, outputStreamTem); + outputStreamTem.close(); // 保存生成的水印图片到压缩包 - int i = aiyh.utils.Util.createFileByInputSteam(new FileInputStream(tempPath), imageFileName); + int i = aiyh.utils.Util.createFileByInputSteam(new FileInputStream(tempPath), imageFileName); // 建议虚拟机进行一次垃圾回收，防止临时文件被其他文件流保存而无法删除临时文件 - System.gc(); + System.gc(); // 删除临时文件， 防止文件删除失败，设置一个自旋操作，加大文件删除的几率 - boolean deleteFlag = true; - int n = 0; - while (deleteFlag) { - try { - n++; - Files.delete(Paths.get(tempPath)); - deleteFlag = false; - } catch (Exception e) { + boolean deleteFlag = true; + int n = 0; + while (deleteFlag) { + try { + n++; + Files.delete(Paths.get(tempPath)); + deleteFlag = false; + } catch (Exception e) { // 设置线程沉睡500毫秒，等待jvm进行垃圾回收，将持有临时文件的流对象回收，确保临时文件能删除 - try { - Thread.sleep(500); - } catch (InterruptedException interruptedException) { - return i; - } - if (n > 5) { - deleteFlag = false; - } - } - } - return i; - } - - public static int getWordWidth(Font font, String content) { - FontDesignMetrics metrics = FontDesignMetrics.getMetrics(font); - int width = 0; - for (int i = 0; i < content.length(); i++) { - width += metrics.charWidth(content.charAt(i)); - } - return width; - } - - + try { + Thread.sleep(500); + } catch (InterruptedException interruptedException) { + return i; + } + if (n > 5) { + deleteFlag = false; + } + } + } + return i; + } + + public static int getWordWidth(Font font, String content, Graphics2D graphics) { + // FontDesignMetrics metrics = FontDesignMetrics.getMetrics(font); + // int width = 0; + // for (int i = 0; i < content.length(); i++) { + // width += metrics.charWidth(content.charAt(i)); + // } + // return width; + return graphics.getFontMetrics(font).stringWidth(content); + } + + } diff --git a/src/main/java/aiyh/utils/fileUtil/pdf/PdfUtil.java b/src/main/java/aiyh/utils/fileUtil/pdf/PdfUtil.java index 90d8a1f..c0c3bab 100644 --- a/src/main/java/aiyh/utils/fileUtil/pdf/PdfUtil.java +++ b/src/main/java/aiyh/utils/fileUtil/pdf/PdfUtil.java @@ -15,7 +15,6 @@ import weaver.file.ImageFileManager; import weaver.system.SystemComInfo; import java.io.*; -import java.net.URLDecoder; import java.nio.file.Files; import java.nio.file.Paths; import java.util.List; @@ -29,217 +28,217 @@ import java.util.UUID; */ public class PdfUtil { - - private static final Logger log = Util.getLogger("util_water_log"); - - /** - * 获取关键字位置信息 - * - * @param inputStream pdf文件流 - * @param keyword 关键字 - * @return 关键字位置信息 - */ - public static List findKeywordPoints(InputStream inputStream, String keyword) { - PdfReader pdfReader = null; - try { - pdfReader = new PdfReader(inputStream); - } catch (IOException e) { - throw new CustomerException("读取pdf失败！", e); - } - return getKeywordPoints(pdfReader, keyword); - } - - - /** - * 获取关键字位置信息 - * - * @param pdfReader pdf读取器 - * @param keyword 关键字 - * @return 关键字位置信息 - */ - private static List getKeywordPoints(PdfReader pdfReader, String keyword) { - int totalPage = pdfReader.getNumberOfPages(); - PdfReaderContentParser pdfReaderContentParser = new PdfReaderContentParser(pdfReader); - CustomerPdfRenderListener customerPdfRenderListener = new CustomerPdfRenderListener(); - customerPdfRenderListener.setKeyWord(keyword); - customerPdfRenderListener.setTotalPage(totalPage); - for (int page = 1; page <= totalPage; page++) { - customerPdfRenderListener.setPage(page); - try { - pdfReaderContentParser.processContent(page, customerPdfRenderListener); - } catch (IOException e) { - throw new CustomerException("解析pdf失败！", e); - } - } - pdfReader.close(); - return customerPdfRenderListener.getPoints(); - } - - - /** - * 添加图片水印到关键字位置 - * - * @param pdfImageFileId 添加图片水印的pdfid - * @param pictureInputStream 图片流 - * @param keyword 关键字 - * @param allKeyword 是否全部关键字 - * @param opacity 透明度 - * @param imageFitWidth 图片宽度 - * @param imageFitHeight 图片高度 - * @param offsetX 图片水印x偏移量 - * @param offsetY 图片水印y偏移量 - * @return 添加水印后的pdf文件 - */ - public static int addPictureWater2pdfByKeyword(int pdfImageFileId, - InputStream pictureInputStream, - String keyword, - boolean allKeyword, - float opacity, - int imageFitWidth, - int imageFitHeight, - int offsetX, - int offsetY) { - ImageFileManager imageFileManager = new ImageFileManager(); - imageFileManager.getImageFileInfoById(pdfImageFileId); - String imageFileName = imageFileManager.getImageFileName(); - String suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); - if (!"pdf".equalsIgnoreCase(suffix)) { - throw new CustomerException("不支持的文件类型 ： " + suffix); - } - InputStream inputStream = ImageFileManager.getInputStreamById(pdfImageFileId); - List keywordPoints = findKeywordPoints(inputStream, keyword); - PdfReader pdfReader = null; - Image image = null; - try { - byte[] imgb = org.apache.commons.io.IOUtils.toByteArray(pictureInputStream); - image = Image.getInstance(imgb); - } catch (Exception e) { - throw new CustomerException("获取水印图片失败！", e); - } - PdfGState gs = new PdfGState(); - gs.setFillOpacity(opacity); - image.scaleToFit(imageFitWidth, imageFitHeight); - String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; + + private static final Logger log = Util.getLogger("util_water_log"); + + /** + * 获取关键字位置信息 + * + * @param inputStream pdf文件流 + * @param keyword 关键字 + * @return 关键字位置信息 + */ + public static List findKeywordPoints(InputStream inputStream, String keyword) { + PdfReader pdfReader = null; + try { + pdfReader = new PdfReader(inputStream); + } catch (IOException e) { + throw new CustomerException("读取pdf失败！", e); + } + return getKeywordPoints(pdfReader, keyword); + } + + + /** + * 获取关键字位置信息 + * + * @param pdfReader pdf读取器 + * @param keyword 关键字 + * @return 关键字位置信息 + */ + private static List getKeywordPoints(PdfReader pdfReader, String keyword) { + int totalPage = pdfReader.getNumberOfPages(); + PdfReaderContentParser pdfReaderContentParser = new PdfReaderContentParser(pdfReader); + CustomerPdfRenderListener customerPdfRenderListener = new CustomerPdfRenderListener(); + customerPdfRenderListener.setKeyWord(keyword); + customerPdfRenderListener.setTotalPage(totalPage); + for (int page = 1; page <= totalPage; page++) { + customerPdfRenderListener.setPage(page); + try { + pdfReaderContentParser.processContent(page, customerPdfRenderListener); + } catch (IOException e) { + throw new CustomerException("解析pdf失败！", e); + } + } + pdfReader.close(); + return customerPdfRenderListener.getPoints(); + } + + + /** + * 添加图片水印到关键字位置 + * + * @param pdfImageFileId 添加图片水印的pdfid + * @param pictureInputStream 图片流 + * @param keyword 关键字 + * @param allKeyword 是否全部关键字 + * @param opacity 透明度 + * @param imageFitWidth 图片宽度 + * @param imageFitHeight 图片高度 + * @param offsetX 图片水印x偏移量 + * @param offsetY 图片水印y偏移量 + * @return 添加水印后的pdf文件 + */ + public static int addPictureWater2pdfByKeyword(int pdfImageFileId, + InputStream pictureInputStream, + String keyword, + boolean allKeyword, + float opacity, + int imageFitWidth, + int imageFitHeight, + int offsetX, + int offsetY) { + ImageFileManager imageFileManager = new ImageFileManager(); + imageFileManager.getImageFileInfoById(pdfImageFileId); + String imageFileName = imageFileManager.getImageFileName(); + String suffix = imageFileName.substring(imageFileName.lastIndexOf(".") + 1); + if (!"pdf".equalsIgnoreCase(suffix)) { + throw new CustomerException("不支持的文件类型 ： " + suffix); + } + InputStream inputStream = ImageFileManager.getInputStreamById(pdfImageFileId); + List keywordPoints = findKeywordPoints(inputStream, keyword); + PdfReader pdfReader = null; + Image image = null; + try { + byte[] imgb = org.apache.commons.io.IOUtils.toByteArray(pictureInputStream); + image = Image.getInstance(imgb); + } catch (Exception e) { + throw new CustomerException("获取水印图片失败！", e); + } + PdfGState gs = new PdfGState(); + gs.setFillOpacity(opacity); + image.scaleToFit(imageFitWidth, imageFitHeight); + String createDir = FileUpload.getCreateDir(new SystemComInfo().getFilesystem()) + "tempfile" + File.separator; // 防止高并发下文件名重复导致文件覆盖的问题 - String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + ".pdf"; - File file = new File(tempPath); - if (!file.getParentFile().exists()) { - file.getParentFile().mkdirs(); - } - if (!file.exists()) { - try { - file.createNewFile(); - } catch (IOException e) { - throw new CustomerException("创建临时文件失败！", e); - } - } + String tempPath = createDir + imageFileName + System.currentTimeMillis() + UUID.randomUUID() + ".pdf"; + File file = new File(tempPath); + if (!file.getParentFile().exists()) { + file.getParentFile().mkdirs(); + } + if (!file.exists()) { + try { + file.createNewFile(); + } catch (IOException e) { + throw new CustomerException("创建临时文件失败！", e); + } + } // 输出到临时目录 - FileOutputStream outputStreamTem; - try { - outputStreamTem = new FileOutputStream(URLDecoder.decode(tempPath, "utf-8")); - } catch (FileNotFoundException | UnsupportedEncodingException e) { - throw new CustomerException("创建临时文件流和路径转换失败！", e); - } - PdfStamper pdfStamper = null; - try { - inputStream = ImageFileManager.getInputStreamById(pdfImageFileId); - pdfReader = new PdfReader(inputStream); - pdfStamper = new PdfStamper(pdfReader, outputStreamTem); - } catch (IOException | DocumentException e) { - throw new CustomerException("读取pdf失败！", e); - } - if (allKeyword) { - addPictureWater2pdfByKeywordAllKeyword(pdfStamper, keywordPoints, image, gs, offsetX, offsetY); - } else { - PdfPointItem keywordPoint = keywordPoints.get(0); - PdfContentByte overContent = pdfStamper.getOverContent(keywordPoint.getStartPage()); - overContent.setGState(gs); - float absoluteX = keywordPoint.getStartPointX() + offsetX; - float absoluteY = keywordPoint.getStartPointY() + offsetY; - image.setAbsolutePosition(absoluteX, absoluteY); - try { - overContent.addImage(image); - } catch (DocumentException e) { - throw new CustomerException("添加水印图片失败！", e); - } - } - try { - pdfStamper.close(); - outputStreamTem.close(); - } catch (IOException | DocumentException e) { - e.printStackTrace(); - log.error("关闭流失败！", e); - } - int imageFileId = -1; - InputStream waterPdf = null; - try { - waterPdf = new FileInputStream(tempPath); - } catch (FileNotFoundException e) { - throw new CustomerException("文件水印添加失败！", e); - } - imageFileId = Util.createFileByInputSteam(waterPdf, imageFileName); - try { - waterPdf.close(); - Files.deleteIfExists(Paths.get(tempPath)); - } catch (IOException e ){ - e.printStackTrace(); - } - return imageFileId; - } - - /** - * 添加图片水印到关键字位置 - * - * @param pdfImageFileId 添加图片水印的pdfid - * @param pictureImageFileId 图片id - * @param keyword 关键字 - * @param allKeyword 是否全部关键字 - * @param opacity 透明度 - * @param imageFitWidth 图片宽度 - * @param imageFitHeight 图片高度 - * @param offsetX x偏移 - * @param offsetY y偏移 - * @return 添加水印后的pdf文件 - */ - public static int addPictureWater2pdfByKeyword(int pdfImageFileId, - int pictureImageFileId, - String keyword, - boolean allKeyword, - float opacity, - int imageFitWidth, - int imageFitHeight, - int offsetX, - int offsetY) { - InputStream pictureInputStream = ImageFileManager.getInputStreamById(pictureImageFileId); - return addPictureWater2pdfByKeyword(pdfImageFileId, pictureInputStream, keyword, allKeyword, opacity, imageFitWidth, imageFitHeight, offsetX, offsetY); - } - - /** - * 添加图片水印全关键字的地方 - * - * @param pdfStamper pdfStamper - * @param keywordPoints 关键字位置 - * @param image 图片 - * @param gs 图片透明度 - * @param offsetX 图片偏移量X - * @param offsetY 图片偏移量Y - */ - private static void addPictureWater2pdfByKeywordAllKeyword(PdfStamper pdfStamper, - List keywordPoints, - Image image, PdfGState gs, - int offsetX, int offsetY) { - PdfContentByte overContent = null; - for (PdfPointItem keywordPoint : keywordPoints) { - overContent = pdfStamper.getOverContent(keywordPoint.getStartPage()); - overContent.setGState(gs); - float absoluteX = keywordPoint.getStartPointX() + offsetX; - float absoluteY = keywordPoint.getStartPointY() + offsetY; - image.setAbsolutePosition(absoluteX, absoluteY); - try { - overContent.addImage(image); - } catch (DocumentException e) { - throw new CustomerException("添加水印图片失败！", e); - } - } - } + FileOutputStream outputStreamTem; + try { + outputStreamTem = new FileOutputStream(tempPath); + } catch (FileNotFoundException e) { + throw new CustomerException("创建临时文件流和路径转换失败！", e); + } + PdfStamper pdfStamper = null; + try { + inputStream = ImageFileManager.getInputStreamById(pdfImageFileId); + pdfReader = new PdfReader(inputStream); + pdfStamper = new PdfStamper(pdfReader, outputStreamTem); + } catch (IOException | DocumentException e) { + throw new CustomerException("读取pdf失败！", e); + } + if (allKeyword) { + addPictureWater2pdfByKeywordAllKeyword(pdfStamper, keywordPoints, image, gs, offsetX, offsetY); + } else { + PdfPointItem keywordPoint = keywordPoints.get(0); + PdfContentByte overContent = pdfStamper.getOverContent(keywordPoint.getStartPage()); + overContent.setGState(gs); + float absoluteX = keywordPoint.getStartPointX() + offsetX; + float absoluteY = keywordPoint.getStartPointY() + offsetY; + image.setAbsolutePosition(absoluteX, absoluteY); + try { + overContent.addImage(image); + } catch (DocumentException e) { + throw new CustomerException("添加水印图片失败！", e); + } + } + try { + pdfStamper.close(); + outputStreamTem.close(); + } catch (IOException | DocumentException e) { + e.printStackTrace(); + log.error("关闭流失败！", e); + } + int imageFileId = -1; + InputStream waterPdf = null; + try { + waterPdf = new FileInputStream(tempPath); + } catch (FileNotFoundException e) { + throw new CustomerException("文件水印添加失败！", e); + } + imageFileId = Util.createFileByInputSteam(waterPdf, imageFileName); + try { + waterPdf.close(); + Files.deleteIfExists(Paths.get(tempPath)); + } catch (IOException e) { + e.printStackTrace(); + } + return imageFileId; + } + + /** + * 添加图片水印到关键字位置 + * + * @param pdfImageFileId 添加图片水印的pdfid + * @param pictureImageFileId 图片id + * @param keyword 关键字 + * @param allKeyword 是否全部关键字 + * @param opacity 透明度 + * @param imageFitWidth 图片宽度 + * @param imageFitHeight 图片高度 + * @param offsetX x偏移 + * @param offsetY y偏移 + * @return 添加水印后的pdf文件 + */ + public static int addPictureWater2pdfByKeyword(int pdfImageFileId, + int pictureImageFileId, + String keyword, + boolean allKeyword, + float opacity, + int imageFitWidth, + int imageFitHeight, + int offsetX, + int offsetY) { + InputStream pictureInputStream = ImageFileManager.getInputStreamById(pictureImageFileId); + return addPictureWater2pdfByKeyword(pdfImageFileId, pictureInputStream, keyword, allKeyword, opacity, imageFitWidth, imageFitHeight, offsetX, offsetY); + } + + /** + * 添加图片水印全关键字的地方 + * + * @param pdfStamper pdfStamper + * @param keywordPoints 关键字位置 + * @param image 图片 + * @param gs 图片透明度 + * @param offsetX 图片偏移量X + * @param offsetY 图片偏移量Y + */ + private static void addPictureWater2pdfByKeywordAllKeyword(PdfStamper pdfStamper, + List keywordPoints, + Image image, PdfGState gs, + int offsetX, int offsetY) { + PdfContentByte overContent = null; + for (PdfPointItem keywordPoint : keywordPoints) { + overContent = pdfStamper.getOverContent(keywordPoint.getStartPage()); + overContent.setGState(gs); + float absoluteX = keywordPoint.getStartPointX() + offsetX; + float absoluteY = keywordPoint.getStartPointY() + offsetY; + image.setAbsolutePosition(absoluteX, absoluteY); + try { + overContent.addImage(image); + } catch (DocumentException e) { + throw new CustomerException("添加水印图片失败！", e); + } + } + } } diff --git a/src/main/java/aiyh/utils/httpUtil/ResponeVo.java b/src/main/java/aiyh/utils/httpUtil/ResponeVo.java index 7605284..95188c5 100644 --- a/src/main/java/aiyh/utils/httpUtil/ResponeVo.java +++ b/src/main/java/aiyh/utils/httpUtil/ResponeVo.java @@ -4,7 +4,6 @@ package aiyh.utils.httpUtil; import aiyh.utils.Util; import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.JSONArray; -import com.alibaba.fastjson.JSONException; import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.core.type.TypeReference; import com.fasterxml.jackson.databind.ObjectMapper; @@ -136,11 +135,11 @@ public class ResponeVo implements HttpResponse { } catch (JsonProcessingException ignored) { try { this.resultList = (List) JSONArray.parseArray(this.getEntityString(), Map.class); - } catch (JSONException e) { - Util.getLogger().error("Unable to convert the response result to array！" + Util.getErrString(e)); + } catch (Exception e) { + Util.getLogger().error("Unable to convert the response result to array！"); } } catch (Exception e) { - Util.getLogger().error("Unable to convert the response result to map or array！" + Util.getErrString(e)); + Util.getLogger().error("Unable to convert the response result to map or array！"); } } diff --git a/src/main/java/aiyh/utils/httpUtil/util/HttpUtils.java b/src/main/java/aiyh/utils/httpUtil/util/HttpUtils.java index 05491b2..6aabc85 100644 --- a/src/main/java/aiyh/utils/httpUtil/util/HttpUtils.java +++ b/src/main/java/aiyh/utils/httpUtil/util/HttpUtils.java @@ -86,6 +86,10 @@ public class HttpUtils { } + public void setCredentialsProvider(CredentialsProvider credentialsProvider) { + this.credentialsProvider = credentialsProvider; + } + public HttpUtils(CredentialsProvider credentialsProvider) { this.credentialsProvider = credentialsProvider; } diff --git a/src/main/java/aiyh/utils/mapper/UtilMapper.java b/src/main/java/aiyh/utils/mapper/UtilMapper.java index 51648ff..7382768 100644 --- a/src/main/java/aiyh/utils/mapper/UtilMapper.java +++ b/src/main/java/aiyh/utils/mapper/UtilMapper.java @@ -1,10 +1,7 @@ package aiyh.utils.mapper; import aiyh.utils.annotation.recordset.*; -import aiyh.utils.entity.DocImageInfo; -import aiyh.utils.entity.FieldViewInfo; -import aiyh.utils.entity.SelectValueEntity; -import aiyh.utils.entity.WorkflowNodeConfig; +import aiyh.utils.entity.*; import java.util.List; import java.util.Map; @@ -58,17 +55,31 @@ public interface UtilMapper { String selectWorkfowMainTable(@ParamMapper("workflowId") String workflowId); - @Select("select id,docid doc_id,imagefileid image_file_id,imagefilename image_file_name from docimagefile where docid = #{docId}") + @Select("select di.id id,dc.id doc_id," + + "di.imagefileid image_file_id," + + "dc.DOCCREATEDATE doc_create_date,dc.DOCCREATETIME doc_create_time," + + "(case when imagefilename = '' or imagefilename is null then dc.DOCSUBJECT else imagefilename end) image_file_name " + + "from DocDetail dc " + + "left join docimagefile di on (dc.id = #{docId} and dc.id = di.docid) " + + "where dc.id = #{docId} ") DocImageInfo selectDocImageInfo(@ParamMapper("docId") String docId); - @Select("select id,docid doc_id," + - "imagefileid image_file_id, docfiletype doc_file_type," + - "imagefilename image_file_name from docimagefile where docid in ($t{docIds})") + @Select("select di.id id,dc.id doc_id," + + "di.imagefileid image_file_id, di.docfiletype doc_file_type," + + "dc.DOCCREATEDATE doc_create_date,dc.DOCCREATETIME doc_create_time," + + "(case when imagefilename = '' or imagefilename is null then dc.DOCSUBJECT else imagefilename end) image_file_name " + + "from DocDetail dc " + + "left join docimagefile di on (dc.id in ($t{docIds}) and dc.id = di.docid )" + + "where dc.id in ($t{docIds})") List selectDocImageInfos(@ParamMapper("docIds") String docIds); - @Select("select id,docid doc_id,imagefileid image_file_id," + - "docfiletype doc_file_type," + - "imagefilename image_file_name from docimagefile where docid in (${docIds})") + @Select("select di.id id,dc.id doc_id," + + "di.imagefileid image_file_id, di.docfiletype doc_file_type," + + "dc.DOCCREATEDATE doc_create_date,dc.DOCCREATETIME doc_create_time," + + "(case when imagefilename = '' or imagefilename is null then dc.DOCSUBJECT else imagefilename end) image_file_name " + + "from DocDetail dc " + + "left join docimagefile di on (dc.id in ($t{docIds}) and dc.id = di.docid )" + + "where dc.id in ($t{docIds})") List selectDocImageInfos(@ParamMapper("docIds") String[] docIds); @@ -176,4 +187,14 @@ public interface UtilMapper { " fieldhtmltype field_html_type\n" + "from workflow_field_table_view where id = #{id}") FieldViewInfo selectFieldInfo(Integer id); + + /** + *

查询建模表表信息

+ * + * @param id id + * @return 建模表信息 + */ + + @Select("select id, tablename table_name, indexdesc index_desc from mode_bill_info_view where id = #{id}") + ModelTableInfo selectModelTableInfo(Integer id); } diff --git a/src/main/java/aiyh/utils/recordset/DoubleTypeHandler.java b/src/main/java/aiyh/utils/recordset/DoubleTypeHandler.java index ecc9e36..d92ae9e 100644 --- a/src/main/java/aiyh/utils/recordset/DoubleTypeHandler.java +++ b/src/main/java/aiyh/utils/recordset/DoubleTypeHandler.java @@ -1,10 +1,12 @@ package aiyh.utils.recordset; import aiyh.utils.Util; +import aiyh.utils.annotation.recordset.CanBeNull; import weaver.conn.RecordSet; import weaver.conn.RecordSetTrans; import java.lang.reflect.Field; +import java.util.Objects; /** *

float处理

@@ -18,7 +20,12 @@ public class DoubleTypeHandler implements TypeHandler { public Object getValue(RecordSet rs, String fieldName, Field declaredField) { String string = Util.null2String(GetRsValueUtil.getRsValue(rs, fieldName, declaredField)); if ("".equals(string)) { - return null; + if (!Objects.isNull(declaredField)) { + if (declaredField.isAnnotationPresent(CanBeNull.class)) { + return null; + } + } + return 0.0D; } return Double.parseDouble(string); } @@ -27,7 +34,12 @@ public class DoubleTypeHandler implements TypeHandler { public Object getValue(RecordSet rs, int index, Field declaredField) { String string = Util.null2String(rs.getString(index)); if ("".equals(string)) { - return null; + if (!Objects.isNull(declaredField)) { + if (declaredField.isAnnotationPresent(CanBeNull.class)) { + return null; + } + } + return 0.0D; } return Double.parseDouble(string); } @@ -36,7 +48,12 @@ public class DoubleTypeHandler implements TypeHandler { public Object getValue(RecordSetTrans rs, String fieldName, Field declaredField) { String string = Util.null2String(GetRsValueUtil.getRsValue(rs, fieldName, declaredField)); if ("".equals(string)) { - return null; + if (!Objects.isNull(declaredField)) { + if (declaredField.isAnnotationPresent(CanBeNull.class)) { + return null; + } + } + return 0.0D; } return Double.parseDouble(string); } @@ -45,7 +62,12 @@ public class DoubleTypeHandler implements TypeHandler { public Object getValue(RecordSetTrans rs, int index, Field declaredField) { String string = Util.null2String(rs.getString(index)); if ("".equals(string)) { - return null; + if (!Objects.isNull(declaredField)) { + if (declaredField.isAnnotationPresent(CanBeNull.class)) { + return null; + } + } + return 0.0D; } return Double.parseDouble(string); } diff --git a/src/main/java/aiyh/utils/recordset/FloatTypeHandler.java b/src/main/java/aiyh/utils/recordset/FloatTypeHandler.java index 7f5bde0..46d0b99 100644 --- a/src/main/java/aiyh/utils/recordset/FloatTypeHandler.java +++ b/src/main/java/aiyh/utils/recordset/FloatTypeHandler.java @@ -1,10 +1,12 @@ package aiyh.utils.recordset; import aiyh.utils.Util; +import aiyh.utils.annotation.recordset.CanBeNull; import weaver.conn.RecordSet; import weaver.conn.RecordSetTrans; import java.lang.reflect.Field; +import java.util.Objects; /** *

float处理

@@ -18,7 +20,12 @@ public class FloatTypeHandler implements TypeHandler { public Object getValue(RecordSet rs, String fieldName, Field declaredField) { String string = Util.null2String(GetRsValueUtil.getRsValue(rs, fieldName, declaredField)); if ("".equals(string)) { - return null; + if (!Objects.isNull(declaredField)) { + if (declaredField.isAnnotationPresent(CanBeNull.class)) { + return null; + } + } + return 0.0F; } return Float.parseFloat(string); } @@ -27,7 +34,12 @@ public class FloatTypeHandler implements TypeHandler { public Object getValue(RecordSet rs, int index, Field declaredField) { String string = Util.null2String(rs.getString(index), "0.0"); if ("".equals(string)) { - return null; + if (!Objects.isNull(declaredField)) { + if (declaredField.isAnnotationPresent(CanBeNull.class)) { + return null; + } + } + return 0.0F; } return Float.parseFloat(string); } @@ -36,7 +48,12 @@ public class FloatTypeHandler implements TypeHandler { public Object getValue(RecordSetTrans rs, String fieldName, Field declaredField) { String string = Util.null2String(GetRsValueUtil.getRsValue(rs, fieldName, declaredField)); if ("".equals(string)) { - return null; + if (!Objects.isNull(declaredField)) { + if (declaredField.isAnnotationPresent(CanBeNull.class)) { + return null; + } + } + return 0.0F; } return Float.parseFloat(string); } @@ -45,7 +62,12 @@ public class FloatTypeHandler implements TypeHandler { public Object getValue(RecordSetTrans rs, int index, Field declaredField) { String string = Util.null2String(rs.getString(index)); if ("".equals(string)) { - return null; + if (!Objects.isNull(declaredField)) { + if (declaredField.isAnnotationPresent(CanBeNull.class)) { + return null; + } + } + return 0.0F; } return Float.parseFloat(string); } diff --git a/src/main/java/aiyh/utils/recordset/FormatSqlUtil.java b/src/main/java/aiyh/utils/recordset/FormatSqlUtil.java new file mode 100644 index 0000000..0a6303b --- /dev/null +++ b/src/main/java/aiyh/utils/recordset/FormatSqlUtil.java @@ -0,0 +1,38 @@ +package aiyh.utils.recordset; + +import com.alibaba.druid.sql.SQLUtils; +import com.alibaba.druid.sql.parser.ParserException; +import weaver.conn.RecordSet; + +import java.util.Objects; + +/** + *

格式化sql字符串

+ * + *

create: 2023/3/5 11:45

+ * + * @author youHong.ai + */ +public class FormatSqlUtil { + private static String dbType = null; + private static RecordSet recordSet = null; + + public static String formatSql(String sql) { + + if (Objects.isNull(FormatSqlUtil.dbType)) { + if (recordSet == null) { + recordSet = new RecordSet(); + } + FormatSqlUtil.dbType = recordSet.getDBType(); + } + try { + return SQLUtils.format(sql, dbType); + } catch (ParserException e) { + return toSqlString(sql); + } + } + + private static String toSqlString(String sql) { + return sql; + } +} diff --git a/src/main/java/aiyh/utils/recordset/IntegerTypeHandler.java b/src/main/java/aiyh/utils/recordset/IntegerTypeHandler.java index 8d4f65c..d7c44ca 100644 --- a/src/main/java/aiyh/utils/recordset/IntegerTypeHandler.java +++ b/src/main/java/aiyh/utils/recordset/IntegerTypeHandler.java @@ -1,10 +1,12 @@ package aiyh.utils.recordset; import aiyh.utils.Util; +import aiyh.utils.annotation.recordset.CanBeNull; import weaver.conn.RecordSet; import weaver.conn.RecordSetTrans; import java.lang.reflect.Field; +import java.util.Objects; /** * @author EBU7-dev1-ayh create 2021/12/21 0021 13:10 @@ -16,7 +18,10 @@ public class IntegerTypeHandler implements TypeHandler { public Object getValue(RecordSet rs, String fieldName, Field declaredField) { String string = Util.null2String(GetRsValueUtil.getRsValue(rs, fieldName, declaredField)); if ("".equals(string)) { - return null; + if (declaredField.isAnnotationPresent(CanBeNull.class)) { + return null; + } + return -1; } if (string.contains(".")) { string = string.substring(0, string.indexOf(".")); @@ -28,7 +33,12 @@ public class IntegerTypeHandler implements TypeHandler { public Object getValue(RecordSet rs, int index, Field declaredField) { String string = Util.null2String(rs.getString(index)); if ("".equals(string)) { - return null; + if (!Objects.isNull(declaredField)) { + if (declaredField.isAnnotationPresent(CanBeNull.class)) { + return null; + } + } + return -1; } if (string.contains(".")) { string = string.substring(0, string.indexOf(".")); @@ -40,7 +50,12 @@ public class IntegerTypeHandler implements TypeHandler { public Object getValue(RecordSetTrans rs, String fieldName, Field declaredField) { String string = Util.null2String(GetRsValueUtil.getRsValue(rs, fieldName, declaredField)); if ("".equals(string)) { - return null; + if (!Objects.isNull(declaredField)) { + if (declaredField.isAnnotationPresent(CanBeNull.class)) { + return null; + } + } + return -1; } if (string.contains(".")) { string = string.substring(0, string.indexOf(".")); @@ -52,7 +67,12 @@ public class IntegerTypeHandler implements TypeHandler { public Object getValue(RecordSetTrans rs, int index, Field declaredField) { String string = Util.null2String(rs.getString(index)); if ("".equals(string)) { - return null; + if (!Objects.isNull(declaredField)) { + if (declaredField.isAnnotationPresent(CanBeNull.class)) { + return null; + } + } + return -1; } if (string.contains(".")) { string = string.substring(0, string.indexOf(".")); diff --git a/src/main/java/aiyh/utils/recordset/RecordsetUtil.java b/src/main/java/aiyh/utils/recordset/RecordsetUtil.java index 55220f9..1b78fd5 100644 --- a/src/main/java/aiyh/utils/recordset/RecordsetUtil.java +++ b/src/main/java/aiyh/utils/recordset/RecordsetUtil.java @@ -8,6 +8,7 @@ import aiyh.utils.sqlUtil.sqlResult.impl.BatchSqlResultImpl; import aiyh.utils.sqlUtil.sqlResult.impl.PrepSqlResultImpl; import weaver.conn.RecordSet; import weaver.conn.RecordSetTrans; +import weaver.conn.constant.DBConstant; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Method; @@ -59,6 +60,146 @@ public class RecordsetUtil implements InvocationHandler { return invokeRsTrans(proxy, method, args, name); } + private Object invokeDefault(int type, String sql, boolean custom, RecordSet rs, Method method, Object[] args) { + SqlHandler sqlHandler = new SqlHandler(); + ResultMapper resultMapper = new ResultMapper(); + PrepSqlResultImpl handler = sqlHandler.handler(sql, custom, method, args); + String invokeMethod = method.getDeclaringClass().getName() + ":" + method.getName() + " : "; + switch (type) { + case 1: { + if (!handler.getSqlStr().trim().toLowerCase().startsWith("select ")) { + throw new CustomerException("The sql statement does not match, the @Select annotation can only execute the select statement, please check whether the sql statement matches!"); + } + Util.getLogger(SQL_LOG).info(invokeMethod + handler); + if (handler.getArgs().isEmpty()) { + rs.executeQuery(handler.getSqlStr()); + } else { + rs.executeQuery(handler.getSqlStr(), handler.getArgs()); + } + return resultMapper.mapperResult(rs, method, method.getReturnType(), this); + } + case 2: { + if (!handler.getSqlStr().trim().toLowerCase().startsWith("update ")) { + throw new CustomerException("The sql statement does not match, the @Update annotation can only execute the update statement, please check whether the sql statement matches!"); + } + Util.getLogger(SQL_LOG).info(invokeMethod + handler); + Class returnType = method.getReturnType(); + boolean b; + if (handler.getArgs().isEmpty()) { + b = rs.executeUpdate(handler.getSqlStr()); + } else { + b = rs.executeUpdate(handler.getSqlStr(), handler.getArgs()); + } + if (returnType.equals(void.class)) { + return null; + } + if (returnType.equals(int.class) || returnType.equals(Integer.class)) { + if (b) { + return 1; + } else { + return 0; + } + } + if (returnType.equals(boolean.class) || returnType.equals(Boolean.class)) { + return b; + } + } + case 3: { + if (!handler.getSqlStr().trim().toLowerCase().startsWith("insert ")) { + throw new CustomerException("The sql statement does not match, the @Insert annotation can only execute the insert statement, please check whether the sql statement matches!"); + } + Util.getLogger(SQL_LOG).info(invokeMethod + handler); + Class returnType = method.getReturnType(); + boolean b; + if (handler.getArgs().isEmpty()) { + b = rs.executeUpdate(handler.getSqlStr()); + } else { + b = rs.executeUpdate(handler.getSqlStr(), handler.getArgs()); + } + if (returnType.equals(void.class)) { + return null; + } + if (returnType.equals(boolean.class) || returnType.equals(Boolean.class)) { + return b; + } + } + case 4: { + if (!handler.getSqlStr().trim().toLowerCase().startsWith("delete ")) { + throw new CustomerException("The sql statement does not match, the @Delete annotation can only execute the delete statement, please check whether the sql statement matches!"); + } + Util.getLogger(SQL_LOG).info(invokeMethod + handler); + Class returnType = method.getReturnType(); + boolean b; + if (handler.getArgs().isEmpty()) { + b = rs.executeUpdate(handler.getSqlStr()); + } else { + b = rs.executeUpdate(handler.getSqlStr(), handler.getArgs()); + } + if (returnType.equals(void.class)) { + return null; + } + if (returnType.equals(boolean.class) || returnType.equals(Boolean.class)) { + return b; + } + } + case 5: { + Class returnType = method.getReturnType(); + BatchSqlResultImpl batchSqlResult = sqlHandler.handlerBatch(sql, custom, method, args); + Util.getLogger(SQL_LOG).info(invokeMethod + batchSqlResult.toString()); + if (batchSqlResult.getBatchList().isEmpty()) { + throw new CustomerException("execute batch sql error , batch sql args is empty!"); + } + if (!batchSqlResult.getSqlStr().trim().toLowerCase().startsWith("insert ")) { + throw new CustomerException("The sql statement does not match, the @Insert annotation can only execute the insert statement, please check whether the sql statement matches!"); + } + boolean b = rs.executeBatchSql(batchSqlResult.getSqlStr(), batchSqlResult.getBatchList()); + if (returnType.equals(void.class)) { + return null; + } + if (returnType.equals(boolean.class) || returnType.equals(Boolean.class)) { + return b; + } + } + case 6: { + Class returnType = method.getReturnType(); + BatchSqlResultImpl batchSqlResult = sqlHandler.handlerBatch(sql, custom, method, args); + Util.getLogger(SQL_LOG).info(invokeMethod + batchSqlResult.toString()); + if (batchSqlResult.getBatchList().isEmpty()) { + throw new CustomerException("execute batch sql error , batch sql args is empty!"); + } + if (!batchSqlResult.getSqlStr().trim().toLowerCase().startsWith("update ")) { + throw new CustomerException("The sql statement does not match, the @Update annotation can only execute the update statement, please check whether the sql statement matches!"); + } + boolean b = rs.executeBatchSql(batchSqlResult.getSqlStr(), batchSqlResult.getBatchList()); + if (returnType.equals(void.class)) { + return null; + } + if (returnType.equals(boolean.class) || returnType.equals(Boolean.class)) { + return b; + } + } + case 7: { + Class returnType = method.getReturnType(); + BatchSqlResultImpl batchSqlResult = sqlHandler.handlerBatch(sql, custom, method, args); + Util.getLogger(SQL_LOG).info(invokeMethod + batchSqlResult.toString()); + if (batchSqlResult.getBatchList().isEmpty()) { + throw new CustomerException("execute batch sql error , batch sql args is empty!"); + } + if (!batchSqlResult.getSqlStr().trim().toLowerCase().startsWith("delete ")) { + throw new CustomerException("The sql statement does not match, the @Delete annotation can only execute the delete statement, please check whether the sql statement matches!"); + } + boolean b = rs.executeBatchSql(batchSqlResult.getSqlStr(), batchSqlResult.getBatchList()); + if (returnType.equals(void.class)) { + return null; + } + if (returnType.equals(boolean.class) || returnType.equals(Boolean.class)) { + return b; + } + } + default: + throw new CustomerException("不支持的sql注解类型： " + type); + } + } private Object invokeRs(Object proxy, Method method, Object[] args, String name) { String mapperKey = method.getDeclaringClass().getName(); @@ -71,177 +212,100 @@ public class RecordsetUtil implements InvocationHandler { rs = rsManager.getRs(mapperKey); } SqlHandler sqlHandler = new SqlHandler(); - ResultMapper resultMapper = new ResultMapper(); + if (DBConstant.DB_TYPE_ORACLE.equals(rs.getDBType())) { + SelectOracle selectOracle = method.getAnnotation(SelectOracle.class); + if (selectOracle != null) { + String sql = selectOracle.value(); + boolean custom = selectOracle.custom(); + return invokeDefault(1, sql, custom, rs, method, args); + } + + UpdateOracle updateOracle = method.getAnnotation(UpdateOracle.class); + if (updateOracle != null) { + String sql = updateOracle.value(); + boolean custom = updateOracle.custom(); + return invokeDefault(2, sql, custom, rs, method, args); + } + InsertOracle insertOracle = method.getAnnotation(InsertOracle.class); + if (insertOracle != null) { + String sql = insertOracle.value(); + boolean custom = insertOracle.custom(); + return invokeDefault(3, sql, custom, rs, method, args); + } + DeleteOracle deleteOracle = method.getAnnotation(DeleteOracle.class); + if (deleteOracle != null) { + String sql = deleteOracle.value(); + boolean custom = deleteOracle.custom(); + return invokeDefault(4, sql, custom, rs, method, args); + } + BatchInsertOracle batchInsertOracle = method.getAnnotation(BatchInsertOracle.class); + if (batchInsertOracle != null) { + String sql = batchInsertOracle.value(); + boolean custom = batchInsertOracle.custom(); + return invokeDefault(5, sql, custom, rs, method, args); + } + BatchUpdateOracle batchUpdateOracle = method.getAnnotation(BatchUpdateOracle.class); + if (batchUpdateOracle != null) { + String sql = batchUpdateOracle.value(); + boolean custom = batchUpdateOracle.custom(); + return invokeDefault(6, sql, custom, rs, method, args); + } + BatchDeleteOracle batchDeleteOracle = method.getAnnotation(BatchDeleteOracle.class); + if (batchDeleteOracle != null) { + String sql = batchDeleteOracle.value(); + boolean custom = batchDeleteOracle.custom(); + return invokeDefault(7, sql, custom, rs, method, args); + } + } Select select = method.getAnnotation(Select.class); if (select != null) { - // 查询 String sql = select.value(); boolean custom = select.custom(); - PrepSqlResultImpl handler = sqlHandler.handler(sql, custom, method, args); - if (!handler.getSqlStr().trim().toLowerCase().startsWith("select ")) { - throw new CustomerException("The sql statement does not match, the @Select annotation can only execute the select statement, please check whether the sql statement matches!"); - } - Util.getLogger(SQL_LOG).info("解析sql===>" + handler); - if (handler.getArgs().isEmpty()) { - rs.executeQuery(handler.getSqlStr()); - } else { - rs.executeQuery(handler.getSqlStr(), handler.getArgs()); - } - return resultMapper.mapperResult(rs, method, method.getReturnType(), this); + return invokeDefault(1, sql, custom, rs, method, args); } Update update = method.getAnnotation(Update.class); if (update != null) { - // 查询 String sql = update.value(); boolean custom = update.custom(); - PrepSqlResultImpl handler = sqlHandler.handler(sql, custom, method, args); - if (!handler.getSqlStr().trim().toLowerCase().startsWith("update ")) { - throw new CustomerException("The sql statement does not match, the @Update annotation can only execute the update statement, please check whether the sql statement matches!"); - } - Util.getLogger(SQL_LOG).info(handler.toString()); - Class returnType = method.getReturnType(); - boolean b; - if (handler.getArgs().isEmpty()) { - b = rs.executeUpdate(handler.getSqlStr()); - } else { - b = rs.executeUpdate(handler.getSqlStr(), handler.getArgs()); - } - if (returnType.equals(void.class)) { - return null; - } - if (returnType.equals(int.class) || returnType.equals(Integer.class)) { - if (b) { - return 1; - } else { - return 0; - } - } - if (returnType.equals(boolean.class) || returnType.equals(Boolean.class)) { - return b; - } + return invokeDefault(2, sql, custom, rs, method, args); } Insert insert = method.getAnnotation(Insert.class); if (insert != null) { - // 查询 String sql = insert.value(); boolean custom = insert.custom(); - PrepSqlResultImpl handler = sqlHandler.handler(sql, custom, method, args); - if (!handler.getSqlStr().trim().toLowerCase().startsWith("insert ")) { - throw new CustomerException("The sql statement does not match, the @Insert annotation can only execute the insert statement, please check whether the sql statement matches!"); - } - Util.getLogger(SQL_LOG).info(handler.toString()); - Class returnType = method.getReturnType(); - boolean b; - if (handler.getArgs().isEmpty()) { - b = rs.executeUpdate(handler.getSqlStr()); - } else { - b = rs.executeUpdate(handler.getSqlStr(), handler.getArgs()); - } - if (returnType.equals(void.class)) { - return null; - } - if (returnType.equals(boolean.class) || returnType.equals(Boolean.class)) { - return b; - } + return invokeDefault(3, sql, custom, rs, method, args); } Delete delete = method.getAnnotation(Delete.class); if (delete != null) { - // 查询 String sql = delete.value(); boolean custom = delete.custom(); - PrepSqlResultImpl handler = sqlHandler.handler(sql, custom, method, args); - if (!handler.getSqlStr().trim().toLowerCase().startsWith("delete ")) { - throw new CustomerException("The sql statement does not match, the @Delete annotation can only execute the delete statement, please check whether the sql statement matches!"); - } - Util.getLogger(SQL_LOG).info(handler.toString()); - Class returnType = method.getReturnType(); - boolean b; - if (handler.getArgs().isEmpty()) { - b = rs.executeUpdate(handler.getSqlStr()); - } else { - b = rs.executeUpdate(handler.getSqlStr(), handler.getArgs()); - } - if (returnType.equals(void.class)) { - return null; - } - if (returnType.equals(boolean.class) || returnType.equals(Boolean.class)) { - return b; - } + return invokeDefault(4, sql, custom, rs, method, args); } - boolean hasBatchInsert = method.isAnnotationPresent(BatchInsert.class); - if (hasBatchInsert) { - BatchInsert batchInsert = method.getAnnotation(BatchInsert.class); + BatchInsert batchInsert = method.getAnnotation(BatchInsert.class); + if (batchInsert != null) { String sql = batchInsert.value(); - Class returnType = method.getReturnType(); boolean custom = batchInsert.custom(); - BatchSqlResultImpl batchSqlResult = sqlHandler.handlerBatch(sql, custom, method, args); - Util.getLogger(SQL_LOG).info(batchSqlResult.toString()); - if (batchSqlResult.getBatchList().isEmpty()) { - throw new CustomerException("execute batch sql error , batch sql args is empty!"); - } - if (!batchSqlResult.getSqlStr().trim().toLowerCase().startsWith("insert ")) { - throw new CustomerException("The sql statement does not match, the @Insert annotation can only execute the insert statement, please check whether the sql statement matches!"); - } - boolean b = rs.executeBatchSql(batchSqlResult.getSqlStr(), batchSqlResult.getBatchList()); - if (returnType.equals(void.class)) { - return null; - } - if (returnType.equals(boolean.class) || returnType.equals(Boolean.class)) { - return b; - } - + return invokeDefault(5, sql, custom, rs, method, args); } - boolean hasBatchUpdate = method.isAnnotationPresent(BatchUpdate.class); - if (hasBatchUpdate) { - BatchUpdate batchUpdate = method.getAnnotation(BatchUpdate.class); + BatchUpdate batchUpdate = method.getAnnotation(BatchUpdate.class); + if (batchUpdate != null) { String sql = batchUpdate.value(); - Class returnType = method.getReturnType(); boolean custom = batchUpdate.custom(); - BatchSqlResultImpl batchSqlResult = sqlHandler.handlerBatch(sql, custom, method, args); - Util.getLogger(SQL_LOG).info(batchSqlResult.toString()); - if (batchSqlResult.getBatchList().isEmpty()) { - throw new CustomerException("execute batch sql error , batch sql args is empty!"); - } - if (!batchSqlResult.getSqlStr().trim().toLowerCase().startsWith("update ")) { - throw new CustomerException("The sql statement does not match, the @Update annotation can only execute the update statement, please check whether the sql statement matches!"); - } - boolean b = rs.executeBatchSql(batchSqlResult.getSqlStr(), batchSqlResult.getBatchList()); - if (returnType.equals(void.class)) { - return null; - } - if (returnType.equals(boolean.class) || returnType.equals(Boolean.class)) { - return b; - } - + return invokeDefault(6, sql, custom, rs, method, args); } - boolean hasBatchDelete = method.isAnnotationPresent(BatchDelete.class); - if (hasBatchDelete) { - BatchDelete batchDelete = method.getAnnotation(BatchDelete.class); + BatchDelete batchDelete = method.getAnnotation(BatchDelete.class); + if (batchDelete != null) { String sql = batchDelete.value(); - Class returnType = method.getReturnType(); boolean custom = batchDelete.custom(); - BatchSqlResultImpl batchSqlResult = sqlHandler.handlerBatch(sql, custom, method, args); - Util.getLogger(SQL_LOG).info(batchSqlResult.toString()); - if (batchSqlResult.getBatchList().isEmpty()) { - throw new CustomerException("execute batch sql error , batch sql args is empty!"); - } - if (!batchSqlResult.getSqlStr().trim().toLowerCase().startsWith("delete ")) { - throw new CustomerException("The sql statement does not match, the @Delete annotation can only execute the delete statement, please check whether the sql statement matches!"); - } - boolean b = rs.executeBatchSql(batchSqlResult.getSqlStr(), batchSqlResult.getBatchList()); - if (returnType.equals(void.class)) { - return null; - } - if (returnType.equals(boolean.class) || returnType.equals(Boolean.class)) { - return b; - } - + return invokeDefault(7, sql, custom, rs, method, args); } throw new CustomerException("该方法没有添加注解！请检查是否正确添加注解！@Select、@Update、@Insert、@Delete、@BatchUpdate、@BatchInsert、@BatchDelete"); } + private Object invokeRsTrans(Object proxy, Method method, Object[] args, String name) { String mapperKey = method.getDeclaringClass().getName(); + String invokeMethod = method.getDeclaringClass().getName() + ":" + method.getName() + " : "; if (!"".equals(name) && null != name) { mapperKey += "." + name; } @@ -261,7 +325,7 @@ public class RecordsetUtil implements InvocationHandler { if (!handler.getSqlStr().trim().toLowerCase().startsWith("select ")) { throw new CustomerException("The sql statement does not match, the @Select annotation can only execute the select statement, please check whether the sql statement matches!"); } - Util.getLogger(SQL_LOG).info("解析sql===>" + handler); + Util.getLogger(SQL_LOG).info(invokeMethod + handler); try { if (handler.getArgs().isEmpty()) { rs.executeQuery(handler.getSqlStr()); @@ -284,7 +348,7 @@ public class RecordsetUtil implements InvocationHandler { if (!handler.getSqlStr().trim().toLowerCase().startsWith("update ")) { throw new CustomerException("The sql statement does not match, the @Update annotation can only execute the update statement, please check whether the sql statement matches!"); } - Util.getLogger(SQL_LOG).info(handler.toString()); + Util.getLogger(SQL_LOG).info(invokeMethod + handler); Class returnType = method.getReturnType(); boolean b; try { @@ -320,7 +384,7 @@ public class RecordsetUtil implements InvocationHandler { if (!handler.getSqlStr().trim().toLowerCase().startsWith("insert ")) { throw new CustomerException("The sql statement does not match, the @Insert annotation can only execute the insert statement, please check whether the sql statement matches!"); } - Util.getLogger(SQL_LOG).info(handler.toString()); + Util.getLogger(SQL_LOG).info(invokeMethod + handler); Class returnType = method.getReturnType(); boolean b; try { @@ -349,7 +413,7 @@ public class RecordsetUtil implements InvocationHandler { if (!handler.getSqlStr().trim().toLowerCase().startsWith("delete ")) { throw new CustomerException("The sql statement does not match, the @Delete annotation can only execute the delete statement, please check whether the sql statement matches!"); } - Util.getLogger(SQL_LOG).info(handler.toString()); + Util.getLogger(SQL_LOG).info(invokeMethod + handler); Class returnType = method.getReturnType(); boolean b; try { @@ -376,7 +440,7 @@ public class RecordsetUtil implements InvocationHandler { Class returnType = method.getReturnType(); boolean custom = batchInsert.custom(); BatchSqlResultImpl batchSqlResult = sqlHandler.handlerBatch(sql, custom, method, args); - Util.getLogger(SQL_LOG).info(batchSqlResult.toString()); + Util.getLogger(SQL_LOG).info(invokeMethod + batchSqlResult.toString()); List batchList = batchSqlResult.getBatchList(); if (batchList.isEmpty()) { throw new CustomerException("execute batch sql error , batch sql args is empty!"); @@ -415,7 +479,7 @@ public class RecordsetUtil implements InvocationHandler { Class returnType = method.getReturnType(); boolean custom = batchUpdate.custom(); BatchSqlResultImpl batchSqlResult = sqlHandler.handlerBatch(sql, custom, method, args); - Util.getLogger(SQL_LOG).info(batchSqlResult.toString()); + Util.getLogger(SQL_LOG).info(invokeMethod + batchSqlResult.toString()); if (batchSqlResult.getBatchList().isEmpty()) { throw new CustomerException("execute batch sql error , batch sql args is empty!"); } @@ -456,7 +520,7 @@ public class RecordsetUtil implements InvocationHandler { Class returnType = method.getReturnType(); boolean custom = batchDelete.custom(); BatchSqlResultImpl batchSqlResult = sqlHandler.handlerBatch(sql, custom, method, args); - Util.getLogger(SQL_LOG).info(batchSqlResult.toString()); + Util.getLogger(SQL_LOG).info(invokeMethod + batchSqlResult.toString()); if (batchSqlResult.getBatchList().isEmpty()) { throw new CustomerException("execute batch sql error , batch sql args is empty!"); } diff --git a/src/main/java/aiyh/utils/recordset/ResultMapper.java b/src/main/java/aiyh/utils/recordset/ResultMapper.java index 401e816..856db07 100644 --- a/src/main/java/aiyh/utils/recordset/ResultMapper.java +++ b/src/main/java/aiyh/utils/recordset/ResultMapper.java @@ -41,7 +41,7 @@ public class ResultMapper { typeHandler.put(Boolean.class, new BooleanTypeHandler()); typeHandler.put(boolean.class, new BooleanTypeHandler()); typeHandler.put(Date.class, new DataTypeHandler()); - typeHandler.put(Float.class, new FloatTypeHandler()); + typeHandler.put(float.class, new FloatTypeHandler()); typeHandler.put(Float.class, new FloatTypeHandler()); typeHandler.put(double.class, new DoubleTypeHandler()); typeHandler.put(Double.class, new DoubleTypeHandler()); @@ -319,8 +319,12 @@ public class ResultMapper { ((Map) o).put(Util.toCamelCase(columnName[i]), rs.getInt(i + 1)); continue; } + if (DBConstant.DB_TYPE_ORACLE.equals(rs.getDBType())) { + ((Map) o).put(Util.toCamelCase(columnName[i]), rs.getInt(i + 1)); + } ((Map) o).put(columnName[i].toLowerCase(), rs.getInt(i + 1)); ((Map) o).put(columnName[i].toUpperCase(), rs.getInt(i + 1)); + ((Map) o).put(columnName[i], rs.getInt(i + 1)); continue; } if ("FLOAT".equalsIgnoreCase(columnType) || "DOUBLE".equalsIgnoreCase(columnType) || "DECIMAL".equalsIgnoreCase(columnType)) { @@ -328,16 +332,24 @@ public class ResultMapper { ((Map) o).put(Util.toCamelCase(columnName[i]), rs.getFloat(i + 1)); continue; } + if (DBConstant.DB_TYPE_ORACLE.equals(rs.getDBType())) { + ((Map) o).put(Util.toCamelCase(columnName[i]), rs.getFloat(i + 1)); + } ((Map) o).put(columnName[i].toLowerCase(), rs.getFloat(i + 1)); ((Map) o).put(columnName[i].toUpperCase(), rs.getFloat(i + 1)); + ((Map) o).put(columnName[i], rs.getFloat(i + 1)); continue; } if (enable) { ((Map) o).put(Util.toCamelCase(columnName[i]), rs.getString(i + 1)); continue; } + if (DBConstant.DB_TYPE_ORACLE.equals(rs.getDBType())) { + ((Map) o).put(Util.toCamelCase(columnName[i]), rs.getString(i + 1)); + } ((Map) o).put(columnName[i].toLowerCase(), rs.getString(i + 1)); ((Map) o).put(columnName[i].toUpperCase(), rs.getString(i + 1)); + ((Map) o).put(columnName[i], rs.getString(i + 1)); continue; } return o; @@ -386,7 +398,9 @@ public class ResultMapper { } else { value = ResultMapper.typeHandler.get(propertyType) == null ? null : ResultMapper.typeHandler.get(propertyType).getValue(rs, fieldName, declaredField); } - propertyDescriptor.getWriteMethod().invoke(o, value); + if (!Objects.isNull(value)) { + propertyDescriptor.getWriteMethod().invoke(o, value); + } } } catch (Exception e) { @@ -449,8 +463,12 @@ public class ResultMapper { ((Map) o).put(Util.toCamelCase(columnName[i]), rs.getInt(i + 1)); continue; } + if (DBConstant.DB_TYPE_ORACLE.equals(rs.getDBType())) { + ((Map) o).put(Util.toCamelCase(columnName[i]), rs.getInt(i + 1)); + } ((Map) o).put(columnName[i].toLowerCase(), rs.getInt(i + 1)); ((Map) o).put(columnName[i].toUpperCase(), rs.getInt(i + 1)); + ((Map) o).put(columnName[i], rs.getInt(i + 1)); continue; } if ("FLOAT".equalsIgnoreCase(columnType) || "DOUBLE".equalsIgnoreCase(columnType) || "DECIMAL".equalsIgnoreCase(columnType)) { @@ -458,8 +476,12 @@ public class ResultMapper { ((Map) o).put(Util.toCamelCase(columnName[i]), rs.getFloat(i + 1)); continue; } + if (DBConstant.DB_TYPE_ORACLE.equals(rs.getDBType())) { + ((Map) o).put(Util.toCamelCase(columnName[i]), rs.getFloat(i + 1)); + } ((Map) o).put(columnName[i].toLowerCase(), rs.getFloat(i + 1)); ((Map) o).put(columnName[i].toUpperCase(), rs.getFloat(i + 1)); + ((Map) o).put(columnName[i], rs.getFloat(i + 1)); continue; } if (method.isAnnotationPresent(Associations.class)) { @@ -488,8 +510,12 @@ public class ResultMapper { ((Map) o).put(Util.toCamelCase(columnName[i]), rs.getString(i + 1)); continue; } + if (DBConstant.DB_TYPE_ORACLE.equals(rs.getDBType())) { + ((Map) o).put(Util.toCamelCase(columnName[i]), rs.getString(i + 1)); + } ((Map) o).put(columnName[i].toLowerCase(), rs.getString(i + 1)); ((Map) o).put(columnName[i].toUpperCase(), rs.getString(i + 1)); + ((Map) o).put(columnName[i], rs.getString(i + 1)); } return o; } @@ -528,6 +554,7 @@ public class ResultMapper { Object value = null; String fieldName = propertyDescriptor.getName(); + Field declaredField = o.getClass().getDeclaredField(fieldName); if (Strings.isNullOrEmpty(fieldName)) { fieldName = propertyDescriptor.getDisplayName(); } @@ -536,7 +563,20 @@ public class ResultMapper { if (association != null) { if (association.property().equals(fieldName)) { Object cassociationValue = association(rs, association, method); - propertyDescriptor.getWriteMethod().invoke(o, cassociationValue); + if (cassociationValue == null) { + continue; + } + if (paramType.containsKey(declaredField.getType())) { + cassociationValue = paramType.get(declaredField.getType()).apply(String.valueOf(cassociationValue)); + } + try { + propertyDescriptor.getWriteMethod().invoke(o, cassociationValue); + } catch (Exception e) { + Util.getLogger().error("实体数据写入报错：" + fieldName + " => " + value); + if (value != null) { + Util.getLogger().error("查询数据类型： " + value.getClass()); + } + } continue; } } @@ -546,21 +586,37 @@ public class ResultMapper { if (collectionMapping != null) { if (fieldName.equals(collectionMapping.property()) && !"".equals(collectionMapping.property())) { Object collection = collection(rs, collectionMapping, method); - propertyDescriptor.getWriteMethod().invoke(o, collection); + try { + propertyDescriptor.getWriteMethod().invoke(o, collection); + } catch (Exception e) { + Util.getLogger().error("实体数据写入报错：" + fieldName + " => " + value); + if (value != null) { + Util.getLogger().error("查询数据类型： " + value.getClass()); + } + } continue; } } } - Field declaredField = o.getClass().getDeclaredField(fieldName); + TypeHandler typeHandler = ResultMapper.typeHandler.get(propertyType); if (enable) { - value = ResultMapper.typeHandler.get(propertyType) == null ? null : ResultMapper.typeHandler.get(propertyType).getValue(rs, Util.toUnderlineCase(fieldName), declaredField); + value = typeHandler == null ? null : typeHandler.getValue(rs, Util.toUnderlineCase(fieldName), declaredField); } else { - value = ResultMapper.typeHandler.get(propertyType) == null ? null : ResultMapper.typeHandler.get(propertyType).getValue(rs, fieldName, declaredField); + value = typeHandler == null ? null : typeHandler.getValue(rs, fieldName, declaredField); } - propertyDescriptor.getWriteMethod().invoke(o, value); + try { + if (!Objects.isNull(value)) { + propertyDescriptor.getWriteMethod().invoke(o, value); + } + } catch (Exception e) { + Util.getLogger().error("实体数据写入报错：" + fieldName + " => " + value); + if (value != null) { + Util.getLogger().error("查询数据类型： " + value.getClass()); + } + throw e; + } + } - - } catch (Exception e) { Util.getLogger().error("报错了，写入数据到实体类报错！\n" + Util.getErrString(e)); throw new CustomerException(e.getMessage(), e); @@ -607,6 +663,9 @@ public class ResultMapper { Id id = annotation.id(); String column = annotation.column(); String columnValue = rs.getString(column); + if (Objects.isNull(columnValue) || "".equals(columnValue)) { + columnValue = rs.getString(column.toUpperCase()); + } if (Objects.isNull(columnValue) || "".equals(columnValue)) { return null; } @@ -665,6 +724,9 @@ public class ResultMapper { Id id = annotation.id(); String column = annotation.column(); String columnValue = rs.getString(column); + if (Objects.isNull(columnValue) || "".equals(columnValue)) { + columnValue = rs.getString(column.toUpperCase()); + } if (Objects.isNull(columnValue) || "".equals(columnValue)) { return null; } diff --git a/src/main/java/aiyh/utils/sqlUtil/sqlResult/impl/BatchSqlResultImpl.java b/src/main/java/aiyh/utils/sqlUtil/sqlResult/impl/BatchSqlResultImpl.java index c6c5cc9..cc4e2c1 100644 --- a/src/main/java/aiyh/utils/sqlUtil/sqlResult/impl/BatchSqlResultImpl.java +++ b/src/main/java/aiyh/utils/sqlUtil/sqlResult/impl/BatchSqlResultImpl.java @@ -1,5 +1,7 @@ package aiyh.utils.sqlUtil.sqlResult.impl; +import aiyh.utils.recordset.FormatSqlUtil; + import java.util.List; /** @@ -10,27 +12,27 @@ import java.util.List; public class BatchSqlResultImpl implements aiyh.utils.sqlUtil.sqlResult.SqlResult { - private final String sqlStr; - private final List batchList; - - public BatchSqlResultImpl(String sqlStr, List batchList) { - this.sqlStr = sqlStr; - this.batchList = batchList; - } - - public String getSqlStr() { - return sqlStr; - } - - public List getBatchList() { - return batchList; - } - - @Override - public String toString() { - return "BatchSqlResultImpl{" + - "sqlStr='" + sqlStr + '\'' + - ", batchList=" + batchList + - '}'; - } + private final String sqlStr; + private final List batchList; + + public BatchSqlResultImpl(String sqlStr, List batchList) { + this.sqlStr = sqlStr; + this.batchList = batchList; + } + + public String getSqlStr() { + return sqlStr; + } + + public List getBatchList() { + return batchList; + } + + @Override + public String toString() { + return "BatchSqlResultImpl{" + + "sqlStr='\n" + FormatSqlUtil.formatSql(sqlStr) + "\n'" + + ", batchList=" + batchList + + '}'; + } } diff --git a/src/main/java/aiyh/utils/sqlUtil/sqlResult/impl/PrepSqlResultImpl.java b/src/main/java/aiyh/utils/sqlUtil/sqlResult/impl/PrepSqlResultImpl.java index 4c6e478..5acf3ee 100644 --- a/src/main/java/aiyh/utils/sqlUtil/sqlResult/impl/PrepSqlResultImpl.java +++ b/src/main/java/aiyh/utils/sqlUtil/sqlResult/impl/PrepSqlResultImpl.java @@ -1,5 +1,6 @@ package aiyh.utils.sqlUtil.sqlResult.impl; +import aiyh.utils.recordset.FormatSqlUtil; import aiyh.utils.sqlUtil.sqlResult.SqlResult; import java.util.List; @@ -14,25 +15,25 @@ import java.util.List; public class PrepSqlResultImpl implements SqlResult { private final String sqlStr; private final List args; - + public PrepSqlResultImpl(String sqlStr, List args) { this.sqlStr = sqlStr; this.args = args; } - + public String getSqlStr() { return sqlStr; } - + public List getArgs() { return args; } - - @Override - public String toString() { - return "PrepSqlResultImpl{" + - "sqlStr='" + sqlStr + '\'' + - ", args=" + args + - '}'; - } + + @Override + public String toString() { + return "PrepSqlResultImpl{" + + "sqlStr='\n" + FormatSqlUtil.formatSql(sqlStr) + "\n'" + + ", args=" + args + + '}'; + } } diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AbstractAnnotationSynthesizer.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AbstractAnnotationSynthesizer.java new file mode 100644 index 0000000..216e9d2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AbstractAnnotationSynthesizer.java @@ -0,0 +1,168 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.annotation.scanner.AnnotationScanner; +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.lang.annotation.Annotation; +import java.util.Collection; +import java.util.Comparator; +import java.util.LinkedHashMap; +import java.util.Map; + +/** + * {@link AnnotationSynthesizer}的基本实现 + * + * @author huangchengxing + */ +public abstract class AbstractAnnotationSynthesizer implements AnnotationSynthesizer { + + /** + * 合成注解来源最初来源 + */ + protected final T source; + + /** + * 包含根注解以及其元注解在内的全部注解实例 + */ + protected final Map, SynthesizedAnnotation> synthesizedAnnotationMap; + + /** + * 已经合成过的注解对象 + */ + private final Map, Annotation> synthesizedProxyAnnotations; + + /** + * 合成注解选择器 + */ + protected final SynthesizedAnnotationSelector annotationSelector; + + /** + * 合成注解属性处理器 + */ + protected final Collection postProcessors; + + /** + * 注解扫描器 + */ + protected final AnnotationScanner annotationScanner; + + /** + * 构造一个注解合成器 + * + * @param source 当前查找的注解对象 + * @param annotationSelector 合成注解选择器 + * @param annotationPostProcessors 注解后置处理器 + * @param annotationScanner 注解扫描器，该扫描器需要支持扫描注解类 + */ + protected AbstractAnnotationSynthesizer( + T source, + SynthesizedAnnotationSelector annotationSelector, + Collection annotationPostProcessors, + AnnotationScanner annotationScanner) { + Assert.notNull(source, "source must not null"); + Assert.notNull(annotationSelector, "annotationSelector must not null"); + Assert.notNull(annotationPostProcessors, "annotationPostProcessors must not null"); + Assert.notNull(annotationPostProcessors, "annotationScanner must not null"); + + this.source = source; + this.annotationSelector = annotationSelector; + this.annotationScanner = annotationScanner; + this.postProcessors = CollUtil.unmodifiable( + CollUtil.sort(annotationPostProcessors, Comparator.comparing(SynthesizedAnnotationPostProcessor::order)) + ); + this.synthesizedProxyAnnotations = new LinkedHashMap<>(); + this.synthesizedAnnotationMap = MapUtil.unmodifiable(loadAnnotations()); + annotationPostProcessors.forEach(processor -> + synthesizedAnnotationMap.values().forEach(synthesized -> processor.process(synthesized, this)) + ); + } + + /** + * 加载合成注解的必要属性 + * + * @return 合成注解 + */ + protected abstract Map, SynthesizedAnnotation> loadAnnotations(); + + /** + * 根据指定的注解类型和对应注解对象，合成最终所需的合成注解 + * + * @param annotationType 注解类型 + * @param annotation 合成注解对象 + * @param 注解类型 + * @return 最终所需的合成注解 + */ + protected abstract A synthesize(Class annotationType, SynthesizedAnnotation annotation); + + /** + * 获取合成注解来源最初来源 + * + * @return 合成注解来源最初来源 + */ + @Override + public T getSource() { + return source; + } + + /** + * 合成注解选择器 + * + * @return 注解选择器 + */ + @Override + public SynthesizedAnnotationSelector getAnnotationSelector() { + return annotationSelector; + } + + /** + * 获取合成注解后置处理器 + * + * @return 合成注解后置处理器 + */ + @Override + public Collection getAnnotationPostProcessors() { + return postProcessors; + } + + /** + * 获取已合成的注解 + * + * @param annotationType 注解类型 + * @return 已合成的注解 + */ + @Override + public SynthesizedAnnotation getSynthesizedAnnotation(Class annotationType) { + return synthesizedAnnotationMap.get(annotationType); + } + + /** + * 获取全部的合成注解 + * + * @return 合成注解 + */ + @Override + public Map, SynthesizedAnnotation> getAllSynthesizedAnnotation() { + return synthesizedAnnotationMap; + } + + /** + * 获取合成注解 + * + * @param annotationType 注解类型 + * @param 注解类型 + * @return 类型 + */ + @SuppressWarnings("unchecked") + @Override + public A synthesize(Class annotationType) { + return (A)synthesizedProxyAnnotations.computeIfAbsent(annotationType, type -> { + final SynthesizedAnnotation synthesizedAnnotation = synthesizedAnnotationMap.get(annotationType); + return ObjectUtil.isNull(synthesizedAnnotation) ? + null : synthesize(annotationType, synthesizedAnnotation); + }); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AbstractLinkAnnotationPostProcessor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AbstractLinkAnnotationPostProcessor.java new file mode 100644 index 0000000..7e0c226 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AbstractLinkAnnotationPostProcessor.java @@ -0,0 +1,163 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Opt; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.lang.annotation.Annotation; +import java.util.HashMap; +import java.util.Map; + +/** + * {@link SynthesizedAnnotationPostProcessor}的基本实现， + * 用于处理注解中带有{@link Link}注解的属性。 + * + * @author huangchengxing + * @see MirrorLinkAnnotationPostProcessor + * @see AliasLinkAnnotationPostProcessor + */ +public abstract class AbstractLinkAnnotationPostProcessor implements SynthesizedAnnotationPostProcessor { + + /** + * 若一个注解属性上存在{@link Link}注解，注解的{@link Link#type()}返回值在{@link #processTypes()}中存在， + * 且此{@link Link}指定的注解对象在当前的{@link SynthesizedAggregateAnnotation}中存在， + * 则从聚合器中获取类型对应的合成注解对象，与该对象中的指定属性，然后将全部关联数据交给 + * {@link #processLinkedAttribute}处理。 + * + * @param synthesizedAnnotation 合成的注解 + * @param synthesizer 合成注解聚合器 + */ + @Override + public void process(SynthesizedAnnotation synthesizedAnnotation, AnnotationSynthesizer synthesizer) { + final Map attributeMap = new HashMap<>(synthesizedAnnotation.getAttributes()); + attributeMap.forEach((originalAttributeName, originalAttribute) -> { + // 获取注解 + final Link link = getLinkAnnotation(originalAttribute, processTypes()); + if (ObjectUtil.isNull(link)) { + return; + } + // 获取注解属性 + final SynthesizedAnnotation linkedAnnotation = getLinkedAnnotation(link, synthesizer, synthesizedAnnotation.annotationType()); + if (ObjectUtil.isNull(linkedAnnotation)) { + return; + } + final AnnotationAttribute linkedAttribute = linkedAnnotation.getAttributes().get(link.attribute()); + // 处理 + processLinkedAttribute( + synthesizer, link, + synthesizedAnnotation, synthesizedAnnotation.getAttributes().get(originalAttributeName), + linkedAnnotation, linkedAttribute + ); + }); + } + + // =========================== 抽象方法 =========================== + + /** + * 当属性上存在{@link Link}注解时，仅当{@link Link#type()}在本方法返回值内存在时才进行处理 + * + * @return 支持处理的{@link RelationType}类型 + */ + protected abstract RelationType[] processTypes(); + + /** + * 对关联的合成注解对象及其关联属性的处理 + * + * @param synthesizer 注解合成器 + * @param annotation {@code originalAttribute}上的{@link Link}注解对象 + * @param originalAnnotation 当前正在处理的{@link SynthesizedAnnotation}对象 + * @param originalAttribute {@code originalAnnotation}上的待处理的属性 + * @param linkedAnnotation {@link Link}指向的关联注解对象 + * @param linkedAttribute {@link Link}指向的{@code originalAnnotation}中的关联属性，该参数可能为空 + */ + protected abstract void processLinkedAttribute( + AnnotationSynthesizer synthesizer, Link annotation, + SynthesizedAnnotation originalAnnotation, AnnotationAttribute originalAttribute, + SynthesizedAnnotation linkedAnnotation, AnnotationAttribute linkedAttribute + ); + + // =========================== @Link注解的处理 =========================== + + /** + * 从注解属性上获取指定类型的{@link Link}注解 + * + * @param attribute 注解属性 + * @param relationTypes 类型 + * @return 注解 + */ + protected Link getLinkAnnotation(AnnotationAttribute attribute, RelationType... relationTypes) { + return Opt.ofNullable(attribute) + .map(t -> AnnotationUtil.getSynthesizedAnnotation(attribute.getAttribute(), Link.class)) + .filter(a -> ArrayUtil.contains(relationTypes, a.type())) + .get(); + } + + /** + * 从合成注解中获取{@link Link#type()}指定的注解对象 + * + * @param annotation {@link Link}注解 + * @param synthesizer 注解合成器 + * @param defaultType 默认类型 + * @return {@link SynthesizedAnnotation} + */ + protected SynthesizedAnnotation getLinkedAnnotation(Link annotation, AnnotationSynthesizer synthesizer, Class defaultType) { + final Class targetAnnotationType = getLinkedAnnotationType(annotation, defaultType); + return synthesizer.getSynthesizedAnnotation(targetAnnotationType); + } + + /** + * 若{@link Link#annotation()}获取的类型{@code Annotation#getClass()}，则返回{@code defaultType}， + * 否则返回{@link Link#annotation()}指定的类型 + * + * @param annotation {@link Link}注解 + * @param defaultType 默认注解类型 + * @return 注解类型 + */ + protected Class getLinkedAnnotationType(Link annotation, Class defaultType) { + return ObjectUtil.equals(annotation.annotation(), Annotation.class) ? + defaultType : annotation.annotation(); + } + + // =========================== 注解属性的校验 =========================== + + /** + * 校验两个注解属性的返回值类型是否一致 + * + * @param original 原属性 + * @param alias 别名属性 + */ + protected void checkAttributeType(AnnotationAttribute original, AnnotationAttribute alias) { + Assert.equals( + original.getAttributeType(), alias.getAttributeType(), + "return type of the linked attribute [{}] is inconsistent with the original [{}]", + original.getAttribute(), alias.getAttribute() + ); + } + + /** + * 检查{@link Link}指向的注解属性是否就是本身 + * + * @param original {@link Link}注解的属性 + * @param linked {@link Link}指向的注解属性 + */ + protected void checkLinkedSelf(AnnotationAttribute original, AnnotationAttribute linked) { + boolean linkSelf = (original == linked) || ObjectUtil.equals(original.getAttribute(), linked.getAttribute()); + Assert.isFalse(linkSelf, "cannot link self [{}]", original.getAttribute()); + } + + /** + * 检查{@link Link}指向的注解属性是否存在 + * + * @param original {@link Link}注解的属性 + * @param linkedAttribute {@link Link}指向的注解属性 + * @param annotation {@link Link}注解 + */ + protected void checkLinkedAttributeNotNull(AnnotationAttribute original, AnnotationAttribute linkedAttribute, Link annotation) { + Assert.notNull(linkedAttribute, "cannot find linked attribute [{}] of original [{}] in [{}]", + original.getAttribute(), annotation.attribute(), + getLinkedAnnotationType(annotation, original.getAnnotationType()) + ); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AbstractWrappedAnnotationAttribute.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AbstractWrappedAnnotationAttribute.java new file mode 100644 index 0000000..f86e8e6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AbstractWrappedAnnotationAttribute.java @@ -0,0 +1,71 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; + +/** + * {@link WrappedAnnotationAttribute}的基本实现 + * + * @author huangchengxing + * @see ForceAliasedAnnotationAttribute + * @see AliasedAnnotationAttribute + * @see MirroredAnnotationAttribute + */ +public abstract class AbstractWrappedAnnotationAttribute implements WrappedAnnotationAttribute { + + protected final AnnotationAttribute original; + protected final AnnotationAttribute linked; + + protected AbstractWrappedAnnotationAttribute(AnnotationAttribute original, AnnotationAttribute linked) { + Assert.notNull(original, "target must not null"); + Assert.notNull(linked, "linked must not null"); + this.original = original; + this.linked = linked; + } + + @Override + public AnnotationAttribute getOriginal() { + return original; + } + + @Override + public AnnotationAttribute getLinked() { + return linked; + } + + @Override + public AnnotationAttribute getNonWrappedOriginal() { + AnnotationAttribute curr = null; + AnnotationAttribute next = original; + while (next != null) { + curr = next; + next = next.isWrapped() ? ((WrappedAnnotationAttribute)curr).getOriginal() : null; + } + return curr; + } + + @Override + public Collection getAllLinkedNonWrappedAttributes() { + List leafAttributes = new ArrayList<>(); + collectLeafAttribute(this, leafAttributes); + return leafAttributes; + } + + private void collectLeafAttribute(AnnotationAttribute curr, List leafAttributes) { + if (ObjectUtil.isNull(curr)) { + return; + } + if (!curr.isWrapped()) { + leafAttributes.add(curr); + return; + } + WrappedAnnotationAttribute wrappedAttribute = (WrappedAnnotationAttribute)curr; + collectLeafAttribute(wrappedAttribute.getOriginal(), leafAttributes); + collectLeafAttribute(wrappedAttribute.getLinked(), leafAttributes); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AggregateAnnotation.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AggregateAnnotation.java new file mode 100644 index 0000000..caa5adc --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AggregateAnnotation.java @@ -0,0 +1,27 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import java.lang.annotation.Annotation; + +/** + * 表示一组被聚合在一起的注解对象 + * + * @author huangchengxing + */ +public interface AggregateAnnotation extends Annotation { + + /** + * 在聚合中是否存在的指定类型注解对象 + * + * @param annotationType 注解类型 + * @return 是否 + */ + boolean isAnnotationPresent(Class annotationType); + + /** + * 获取聚合中的全部注解对象 + * + * @return 注解对象 + */ + Annotation[] getAnnotations(); + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/Alias.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/Alias.java new file mode 100644 index 0000000..4e61c73 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/Alias.java @@ -0,0 +1,26 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * 别名注解，使用此注解的字段、方法、参数等会有一个别名，用于Bean拷贝、Bean转Map等 + * + * @author Looly + * @since 5.1.1 + */ +@Documented +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER}) +public @interface Alias { + + /** + * 别名值，即使用此注解要替换成的别名名称 + * + * @return 别名值 + */ + String value(); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AliasAnnotationPostProcessor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AliasAnnotationPostProcessor.java new file mode 100644 index 0000000..97d305c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AliasAnnotationPostProcessor.java @@ -0,0 +1,66 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Opt; +import aiyh.utils.tool.cn.hutool.core.map.ForestMap; +import aiyh.utils.tool.cn.hutool.core.map.LinkedForestMap; +import aiyh.utils.tool.cn.hutool.core.map.TreeEntry; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.util.Map; + +/** + *

用于处理注解对象中带有{@link Alias}注解的属性。
+ * 当该处理器执行完毕后，{@link Alias}注解指向的目标注解的属性将会被包装并替换为 + * {@link ForceAliasedAnnotationAttribute}。 + * + * @author huangchengxing + * @see Alias + * @see ForceAliasedAnnotationAttribute + */ +public class AliasAnnotationPostProcessor implements SynthesizedAnnotationPostProcessor { + + @Override + public int order() { + return Integer.MIN_VALUE; + } + + @Override + public void process(SynthesizedAnnotation synthesizedAnnotation, AnnotationSynthesizer synthesizer) { + final Map attributeMap = synthesizedAnnotation.getAttributes(); + + // 记录别名与属性的关系 + final ForestMap attributeAliasMappings = new LinkedForestMap<>(false); + attributeMap.forEach((attributeName, attribute) -> { + final String alias = Opt.ofNullable(attribute.getAnnotation(Alias.class)) + .map(Alias::value) + .orElse(null); + if (ObjectUtil.isNull(alias)) { + return; + } + final AnnotationAttribute aliasAttribute = attributeMap.get(alias); + Assert.notNull(aliasAttribute, "no method for alias: [{}]", alias); + attributeAliasMappings.putLinkedNodes(alias, aliasAttribute, attributeName, attribute); + }); + + // 处理别名 + attributeMap.forEach((attributeName, attribute) -> { + final AnnotationAttribute resolvedAttribute = Opt.ofNullable(attributeName) + .map(attributeAliasMappings::getRootNode) + .map(TreeEntry::getValue) + .orElse(attribute); + Assert.isTrue( + ObjectUtil.isNull(resolvedAttribute) + || ClassUtil.isAssignable(attribute.getAttributeType(), resolvedAttribute.getAttributeType()), + "return type of the root alias method [{}] is inconsistent with the original [{}]", + resolvedAttribute.getClass(), attribute.getAttributeType() + ); + if (attribute != resolvedAttribute) { + attributeMap.put(attributeName, new ForceAliasedAnnotationAttribute(attribute, resolvedAttribute)); + } + }); + synthesizedAnnotation.setAttributes(attributeMap); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AliasFor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AliasFor.java new file mode 100644 index 0000000..bf78532 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AliasFor.java @@ -0,0 +1,39 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import java.lang.annotation.*; + +/** + *

{@link Link}的子注解。表示“原始属性”将作为“关联属性”的别名。 + *

    + *
  • 当“原始属性”为默认值时，获取“关联属性”将返回“关联属性”本身的值；
    • + *
  • 当“原始属性”不为默认值时，获取“关联属性”将返回“原始属性”的值；
    • + *
+ * 注意，该注解与{@link Link}、{@link ForceAliasFor}或{@link MirrorFor}一起使用时，将只有被声明在最上面的注解会生效 + * + * @author huangchengxing + * @see Link + * @see RelationType#ALIAS_FOR + */ +@Link(type = RelationType.ALIAS_FOR) +@Documented +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE}) +public @interface AliasFor { + + /** + * 产生关联的注解类型，当不指定时，默认指注释的属性所在的类 + * + * @return 注解类型 + */ + @Link(annotation = Link.class, attribute = "annotation", type = RelationType.FORCE_ALIAS_FOR) + Class annotation() default Annotation.class; + + /** + * {@link #annotation()}指定注解中关联的属性 + * + * @return 关联属性 + */ + @Link(annotation = Link.class, attribute = "attribute", type = RelationType.FORCE_ALIAS_FOR) + String attribute() default ""; + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AliasLinkAnnotationPostProcessor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AliasLinkAnnotationPostProcessor.java new file mode 100644 index 0000000..53e21e7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AliasLinkAnnotationPostProcessor.java @@ -0,0 +1,126 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Opt; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.util.function.BinaryOperator; + +/** + *

用于处理注解对象中带有{@link Link}注解，且{@link Link#type()}为 + * {@link RelationType#ALIAS_FOR}或{@link RelationType#FORCE_ALIAS_FOR}的属性。
+ * 当该处理器执行完毕后，{@link Link}注解指向的目标注解的属性将会被包装并替换为 + * {@link AliasedAnnotationAttribute}或{@link ForceAliasedAnnotationAttribute}。 + * + * @author huangchengxing + * @see RelationType#ALIAS_FOR + * @see AliasedAnnotationAttribute + * @see RelationType#FORCE_ALIAS_FOR + * @see ForceAliasedAnnotationAttribute + */ +public class AliasLinkAnnotationPostProcessor extends AbstractLinkAnnotationPostProcessor { + + private static final RelationType[] PROCESSED_RELATION_TYPES = new RelationType[]{ RelationType.ALIAS_FOR, RelationType.FORCE_ALIAS_FOR }; + + @Override + public int order() { + return Integer.MIN_VALUE + 2; + } + + /** + * 该处理器只处理{@link Link#type()}类型为{@link RelationType#ALIAS_FOR}和{@link RelationType#FORCE_ALIAS_FOR}的注解属性 + * + * @return 含有{@link RelationType#ALIAS_FOR}和{@link RelationType#FORCE_ALIAS_FOR}的数组 + */ + @Override + protected RelationType[] processTypes() { + return PROCESSED_RELATION_TYPES; + } + + /** + * 获取{@link Link}指向的目标注解属性，并根据{@link Link#type()}的类型是 + * {@link RelationType#ALIAS_FOR}或{@link RelationType#FORCE_ALIAS_FOR} + * 将目标注解属性包装为{@link AliasedAnnotationAttribute}或{@link ForceAliasedAnnotationAttribute}， + * 然后用包装后注解属性在对应的合成注解中替换原始的目标注解属性 + * + * @param synthesizer 注解合成器 + * @param annotation {@code originalAttribute}上的{@link Link}注解对象 + * @param originalAnnotation 当前正在处理的{@link SynthesizedAnnotation}对象 + * @param originalAttribute {@code originalAnnotation}上的待处理的属性 + * @param linkedAnnotation {@link Link}指向的关联注解对象 + * @param linkedAttribute {@link Link}指向的{@code originalAnnotation}中的关联属性，该参数可能为空 + */ + @Override + protected void processLinkedAttribute( + AnnotationSynthesizer synthesizer, Link annotation, + SynthesizedAnnotation originalAnnotation, AnnotationAttribute originalAttribute, + SynthesizedAnnotation linkedAnnotation, AnnotationAttribute linkedAttribute) { + // 校验别名关系 + checkAliasRelation(annotation, originalAttribute, linkedAttribute); + // 处理aliasFor类型的关系 + if (RelationType.ALIAS_FOR.equals(annotation.type())) { + wrappingLinkedAttribute(synthesizer, originalAttribute, linkedAttribute, AliasedAnnotationAttribute::new); + return; + } + // 处理forceAliasFor类型的关系 + wrappingLinkedAttribute(synthesizer, originalAttribute, linkedAttribute, ForceAliasedAnnotationAttribute::new); + } + + /** + * 对指定注解属性进行包装，若该属性已被包装过，则递归以其为根节点的树结构，对树上全部的叶子节点进行包装 + */ + private void wrappingLinkedAttribute( + AnnotationSynthesizer synthesizer, AnnotationAttribute originalAttribute, AnnotationAttribute aliasAttribute, BinaryOperator wrapping) { + // 不是包装属性 + if (!aliasAttribute.isWrapped()) { + processAttribute(synthesizer, originalAttribute, aliasAttribute, wrapping); + return; + } + // 是包装属性 + final AbstractWrappedAnnotationAttribute wrapper = (AbstractWrappedAnnotationAttribute)aliasAttribute; + wrapper.getAllLinkedNonWrappedAttributes().forEach( + t -> processAttribute(synthesizer, originalAttribute, t, wrapping) + ); + } + + /** + * 获取指定注解属性，然后将其再进行一层包装 + */ + private void processAttribute( + AnnotationSynthesizer synthesizer, AnnotationAttribute originalAttribute, + AnnotationAttribute target, BinaryOperator wrapping) { + Opt.ofNullable(target.getAnnotationType()) + .map(synthesizer::getSynthesizedAnnotation) + .ifPresent(t -> t.replaceAttribute(target.getAttributeName(), old -> wrapping.apply(old, originalAttribute))); + } + + /** + * 基本校验 + */ + private void checkAliasRelation(Link annotation, AnnotationAttribute originalAttribute, AnnotationAttribute linkedAttribute) { + checkLinkedAttributeNotNull(originalAttribute, linkedAttribute, annotation); + checkAttributeType(originalAttribute, linkedAttribute); + checkCircularDependency(originalAttribute, linkedAttribute); + } + + /** + * 检查两个属性是否互为别名 + */ + private void checkCircularDependency(AnnotationAttribute original, AnnotationAttribute alias) { + checkLinkedSelf(original, alias); + Link annotation = getLinkAnnotation(alias, RelationType.ALIAS_FOR, RelationType.FORCE_ALIAS_FOR); + if (ObjectUtil.isNull(annotation)) { + return; + } + final Class aliasAnnotationType = getLinkedAnnotationType(annotation, alias.getAnnotationType()); + if (ObjectUtil.notEqual(aliasAnnotationType, original.getAnnotationType())) { + return; + } + Assert.notEquals( + annotation.attribute(), original.getAttributeName(), + "circular reference between the alias attribute [{}] and the original attribute [{}]", + alias.getAttribute(), original.getAttribute() + ); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AliasedAnnotationAttribute.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AliasedAnnotationAttribute.java new file mode 100644 index 0000000..ada1292 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AliasedAnnotationAttribute.java @@ -0,0 +1,36 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +/** + *

表示一个具有别名的属性。 + * 当别名属性值为默认值时，优先返回原属性的值，当别名属性不为默认值时，优先返回别名属性的值 + * + * @author huangchengxing + * @see AliasLinkAnnotationPostProcessor + * @see RelationType#ALIAS_FOR + */ +public class AliasedAnnotationAttribute extends AbstractWrappedAnnotationAttribute { + + protected AliasedAnnotationAttribute(AnnotationAttribute origin, AnnotationAttribute linked) { + super(origin, linked); + } + + /** + * 若{@link #linked}为默认值，则返回{@link #original}的值，否则返回{@link #linked}的值 + * + * @return 属性值 + */ + @Override + public Object getValue() { + return linked.isValueEquivalentToDefaultValue() ? super.getValue() : linked.getValue(); + } + + /** + * 当{@link #original}与{@link #linked}都为默认值时返回{@code true} + * + * @return 是否 + */ + @Override + public boolean isValueEquivalentToDefaultValue() { + return linked.isValueEquivalentToDefaultValue() && original.isValueEquivalentToDefaultValue(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationAttribute.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationAttribute.java new file mode 100644 index 0000000..0981131 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationAttribute.java @@ -0,0 +1,104 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; + +import java.lang.annotation.Annotation; +import java.lang.reflect.Method; + +/** + *

表示注解的某个属性，等同于绑定的调用对象的{@link Method}方法。
+ * 在{@link SynthesizedAggregateAnnotation}的解析以及取值过程中， + * 可以通过设置{@link SynthesizedAnnotation}的注解属性， + * 从而使得可以从一个注解对象中属性获取另一个注解对象的属性值 + * + *

一般情况下，注解属性的处理会发生在{@link SynthesizedAnnotationPostProcessor}调用时 + * + * @author huangchengxing + * @see SynthesizedAnnotationPostProcessor + * @see WrappedAnnotationAttribute + * @see CacheableAnnotationAttribute + * @see AbstractWrappedAnnotationAttribute + * @see ForceAliasedAnnotationAttribute + * @see AliasedAnnotationAttribute + * @see MirroredAnnotationAttribute + */ +public interface AnnotationAttribute { + + /** + * 获取注解对象 + * + * @return 注解对象 + */ + Annotation getAnnotation(); + + /** + * 获取注解属性对应的方法 + * + * @return 注解属性对应的方法 + */ + Method getAttribute(); + + /** + * 获取声明属性的注解类 + * + * @return 声明注解的注解类 + */ + default Class getAnnotationType() { + return getAttribute().getDeclaringClass(); + } + + /** + * 获取属性名称 + * + * @return 属性名称 + */ + default String getAttributeName() { + return getAttribute().getName(); + } + + /** + * 获取注解属性 + * + * @return 注解属性 + */ + default Object getValue() { + return ReflectUtil.invoke(getAnnotation(), getAttribute()); + } + + /** + * 该注解属性的值是否等于默认值 + * + * @return 该注解属性的值是否等于默认值 + */ + boolean isValueEquivalentToDefaultValue(); + + /** + * 获取属性类型 + * + * @return 属性类型 + */ + default Class getAttributeType() { + return getAttribute().getReturnType(); + } + + /** + * 获取属性上的注解 + * + * @param 注解类型 + * @param annotationType 注解类型 + * @return 注解对象 + */ + default T getAnnotation(Class annotationType) { + return getAttribute().getAnnotation(annotationType); + } + + /** + * 当前注解属性是否已经被{@link WrappedAnnotationAttribute}包装 + * + * @return boolean + */ + default boolean isWrapped() { + return false; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationAttributeValueProvider.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationAttributeValueProvider.java new file mode 100644 index 0000000..2838efa --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationAttributeValueProvider.java @@ -0,0 +1,18 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +/** + * 表示一个可以从当前接口的实现类中，获得特定的属性值 + */ +@FunctionalInterface +public interface AnnotationAttributeValueProvider { + + /** + * 获取注解属性值 + * + * @param attributeName 属性名称 + * @param attributeType 属性类型 + * @return 注解属性值 + */ + Object getAttributeValue(String attributeName, Class attributeType); + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationProxy.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationProxy.java new file mode 100644 index 0000000..1b10b73 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationProxy.java @@ -0,0 +1,88 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.lang.annotation.Annotation; +import java.lang.reflect.InvocationHandler; +import java.lang.reflect.Method; +import java.util.HashMap; +import java.util.Map; + +/** + * 注解代理
+ * 通过代理指定注解，可以自定义调用注解的方法逻辑，如支持{@link Alias} 注解 + * + * @param 注解类型 + * @since 5.7.23 + */ +public class AnnotationProxy implements Annotation, InvocationHandler, Serializable { + private static final long serialVersionUID = 1L; + + private final T annotation; + private final Class type; + private final Map attributes; + + /** + * 构造 + * + * @param annotation 注解 + */ + public AnnotationProxy(T annotation) { + this.annotation = annotation; + //noinspection unchecked + this.type = (Class) annotation.annotationType(); + this.attributes = initAttributes(); + } + + + @Override + public Class annotationType() { + return type; + } + + @Override + public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { + + // 注解别名 + Alias alias = method.getAnnotation(Alias.class); + if(null != alias){ + final String name = alias.value(); + if(StrUtil.isNotBlank(name)){ + if(false == attributes.containsKey(name)){ + throw new IllegalArgumentException(StrUtil.format("No method for alias: [{}]", name)); + } + return attributes.get(name); + } + } + + final Object value = attributes.get(method.getName()); + if (value != null) { + return value; + } + return method.invoke(this, args); + } + + /** + * 初始化注解的属性
+ * 此方法预先调用所有注解的方法，将注解方法值缓存于attributes中 + * + * @return 属性（方法结果）映射 + */ + private Map initAttributes() { + final Method[] methods = ReflectUtil.getMethods(this.type); + final Map attributes = new HashMap<>(methods.length, 1); + + for (Method method : methods) { + // 跳过匿名内部类自动生成的方法 + if (method.isSynthetic()) { + continue; + } + + attributes.put(method.getName(), ReflectUtil.invoke(this.annotation, method)); + } + + return attributes; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationSynthesizer.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationSynthesizer.java new file mode 100644 index 0000000..b5454b0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationSynthesizer.java @@ -0,0 +1,77 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import java.lang.annotation.Annotation; +import java.util.Collection; +import java.util.Map; + +/** + *

注解合成器，用于处理一组给定的与{@link #getSource()}具有直接或间接联系的注解对象， + * 并返回与原始注解对象具有不同属性的“合成”注解。 + * + *

合成注解一般被用于处理类层级结果中具有直接或间接关联的注解对象， + * 当实例被创建时，会获取到这些注解对象，并使用{@link SynthesizedAnnotationSelector}对类型相同的注解进行过滤， + * 并最终得到类型不重复的有效注解对象。这些有效注解将被包装为{@link SynthesizedAnnotation}， + * 然后最终用于“合成”一个{@link SynthesizedAggregateAnnotation}。
+ * {@link SynthesizedAnnotationSelector}是合成注解生命周期中的第一个钩子， + * 自定义选择器以拦截原始注解被扫描的过程。 + * + *

当合成注解完成对待合成注解的扫描，并完成了必要属性的加载后， + * 将会按顺序依次调用{@link SynthesizedAnnotationPostProcessor}， + * 注解后置处理器允许用于对完成注解的待合成注解进行二次调整， + * 该钩子一般用于根据{@link Link}注解对属性进行调整。
+ * {@link SynthesizedAnnotationPostProcessor}是合成注解生命周期中的第二个钩子， + * 自定义后置处理器以拦截原始在转为待合成注解后的初始化过程。 + * + *

使用{@link #synthesize(Class)}用于获取“合成”后的注解， + * 该注解对象的属性可能会与原始的对象属性不同。 + * + * @author huangchengxing + */ +public interface AnnotationSynthesizer { + + /** + * 获取合成注解来源最初来源 + * + * @return 合成注解来源最初来源 + */ + Object getSource(); + + /** + * 合成注解选择器 + * + * @return 注解选择器 + */ + SynthesizedAnnotationSelector getAnnotationSelector(); + + /** + * 获取合成注解后置处理器 + * + * @return 合成注解后置处理器 + */ + Collection getAnnotationPostProcessors(); + + /** + * 获取已合成的注解 + * + * @param annotationType 注解类型 + * @return 已合成的注解 + */ + SynthesizedAnnotation getSynthesizedAnnotation(Class annotationType); + + /** + * 获取全部的合成注解 + * + * @return 合成注解 + */ + Map, SynthesizedAnnotation> getAllSynthesizedAnnotation(); + + /** + * 获取合成注解 + * + * @param annotationType 注解类型 + * @param 注解类型 + * @return 类型 + */ + T synthesize(Class annotationType); + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationUtil.java new file mode 100755 index 0000000..e57e56f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/AnnotationUtil.java @@ -0,0 +1,576 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.annotation.scanner.AnnotationScanner; +import aiyh.utils.tool.cn.hutool.core.annotation.scanner.MetaAnnotationScanner; +import aiyh.utils.tool.cn.hutool.core.annotation.scanner.MethodAnnotationScanner; +import aiyh.utils.tool.cn.hutool.core.annotation.scanner.TypeAnnotationScanner; +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.lang.Opt; +import aiyh.utils.tool.cn.hutool.core.lang.func.Func1; +import aiyh.utils.tool.cn.hutool.core.lang.func.LambdaUtil; +import aiyh.utils.tool.cn.hutool.core.util.*; + +import java.lang.annotation.*; +import java.lang.invoke.SerializedLambda; +import java.lang.reflect.AnnotatedElement; +import java.lang.reflect.Method; +import java.lang.reflect.Proxy; +import java.util.*; +import java.util.function.Predicate; +import java.util.stream.Collectors; + +/** + * 注解工具类
+ * 快速获取注解对象、注解值等工具封装 + * + * @author looly + * @since 4.0.9 + */ +public class AnnotationUtil { + + /** + * 元注解 + */ + static final Set> META_ANNOTATIONS = CollUtil.newHashSet(Target.class, // + Retention.class, // + Inherited.class, // + Documented.class, // + SuppressWarnings.class, // + Override.class, // + Deprecated.class// + ); + + /** + * 是否为Jdk自带的元注解。
+ * 包括： + *

    + *
  • {@link Target}
    • + *
  • {@link Retention}
    • + *
  • {@link Inherited}
    • + *
  • {@link Documented}
    • + *
  • {@link SuppressWarnings}
    • + *
  • {@link Override}
    • + *
  • {@link Deprecated}
    • + *
+ * + * @param annotationType 注解类型 + * @return 是否为Jdk自带的元注解 + */ + public static boolean isJdkMetaAnnotation(Class annotationType) { + return META_ANNOTATIONS.contains(annotationType); + } + + /** + * 是否不为Jdk自带的元注解。
+ * 包括： + *
    + *
  • {@link Target}
    • + *
  • {@link Retention}
    • + *
  • {@link Inherited}
    • + *
  • {@link Documented}
    • + *
  • {@link SuppressWarnings}
    • + *
  • {@link Override}
    • + *
  • {@link Deprecated}
    • + *
+ * + * @param annotationType 注解类型 + * @return 是否为Jdk自带的元注解 + */ + public static boolean isNotJdkMateAnnotation(Class annotationType) { + return false == isJdkMetaAnnotation(annotationType); + } + + /** + * 将指定的被注解的元素转换为组合注解元素 + * + * @param annotationEle 注解元素 + * @return 组合注解元素 + */ + public static CombinationAnnotationElement toCombination(AnnotatedElement annotationEle) { + if (annotationEle instanceof CombinationAnnotationElement) { + return (CombinationAnnotationElement) annotationEle; + } + return new CombinationAnnotationElement(annotationEle); + } + + /** + * 获取指定注解 + * + * @param annotationEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param isToCombination 是否为转换为组合注解，组合注解可以递归获取注解的注解 + * @return 注解对象 + */ + public static Annotation[] getAnnotations(AnnotatedElement annotationEle, boolean isToCombination) { + return getAnnotations(annotationEle, isToCombination, (Predicate) null); + } + + /** + * 获取组合注解 + * + * @param 注解类型 + * @param annotationEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param annotationType 限定的 + * @return 注解对象数组 + * @since 5.8.0 + */ + public static T[] getCombinationAnnotations(AnnotatedElement annotationEle, Class annotationType) { + return getAnnotations(annotationEle, true, annotationType); + } + + /** + * 获取指定注解 + * + * @param 注解类型 + * @param annotationEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param isToCombination 是否为转换为组合注解，组合注解可以递归获取注解的注解 + * @param annotationType 限定的 + * @return 注解对象数组 + * @since 5.8.0 + */ + public static T[] getAnnotations(AnnotatedElement annotationEle, boolean isToCombination, Class annotationType) { + final Annotation[] annotations = getAnnotations(annotationEle, isToCombination, + (annotation -> null == annotationType || annotationType.isAssignableFrom(annotation.getClass()))); + + final T[] result = ArrayUtil.newArray(annotationType, annotations.length); + for (int i = 0; i < annotations.length; i++) { + //noinspection unchecked + result[i] = (T) annotations[i]; + } + return result; + } + + /** + * 获取指定注解 + * + * @param annotationEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param isToCombination 是否为转换为组合注解，组合注解可以递归获取注解的注解 + * @param predicate 过滤器，{@link Predicate#test(Object)}返回{@code true}保留，否则不保留 + * @return 注解对象，如果提供的{@link AnnotatedElement}为{@code null}，返回{@code null} + * @since 5.8.0 + */ + public static Annotation[] getAnnotations(AnnotatedElement annotationEle, boolean isToCombination, Predicate predicate) { + if (null == annotationEle) { + return null; + } + + if (isToCombination) { + if (null == predicate) { + return toCombination(annotationEle).getAnnotations(); + } + return CombinationAnnotationElement.of(annotationEle, predicate).getAnnotations(); + } + + final Annotation[] result = annotationEle.getAnnotations(); + if (null == predicate) { + return result; + } + return ArrayUtil.filter(result, predicate::test); + } + + /** + * 获取指定注解 + * + * @param 注解类型 + * @param annotationEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param annotationType 注解类型 + * @return 注解对象 + */ + public static A getAnnotation(AnnotatedElement annotationEle, Class annotationType) { + return (null == annotationEle) ? null : toCombination(annotationEle).getAnnotation(annotationType); + } + + /** + * 检查是否包含指定注解指定注解 + * + * @param annotationEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param annotationType 注解类型 + * @return 是否包含指定注解 + * @since 5.4.2 + */ + public static boolean hasAnnotation(AnnotatedElement annotationEle, Class annotationType) { + return null != getAnnotation(annotationEle, annotationType); + } + + /** + * 获取指定注解默认值
+ * 如果无指定的属性方法返回null + * + * @param 注解值类型 + * @param annotationEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param annotationType 注解类型 + * @return 注解对象 + * @throws UtilException 调用注解中的方法时执行异常 + */ + public static T getAnnotationValue(AnnotatedElement annotationEle, Class annotationType) throws UtilException { + return getAnnotationValue(annotationEle, annotationType, "value"); + } + + /** + * 获取指定注解属性的值
+ * 如果无指定的属性方法返回null + * + * @param 注解值类型 + * @param annotationEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param annotationType 注解类型 + * @param propertyName 属性名，例如注解中定义了name()方法，则 此处传入name + * @return 注解对象 + * @throws UtilException 调用注解中的方法时执行异常 + */ + public static T getAnnotationValue(AnnotatedElement annotationEle, Class annotationType, String propertyName) throws UtilException { + final Annotation annotation = getAnnotation(annotationEle, annotationType); + if (null == annotation) { + return null; + } + + final Method method = ReflectUtil.getMethodOfObj(annotation, propertyName); + if (null == method) { + return null; + } + return ReflectUtil.invoke(annotation, method); + } + + /** + * 获取指定注解属性的值
+ * 如果无指定的属性方法返回null + * + * @param 注解类型 + * @param 注解类型值 + * @param annotationEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param propertyName 属性名，例如注解中定义了name()方法，则 此处传入name + * @return 注解对象 + * @throws UtilException 调用注解中的方法时执行异常 + * @since 5.8.9 + */ + public static R getAnnotationValue(AnnotatedElement annotationEle, Func1 propertyName) { + if (propertyName == null) { + return null; + } else { + final SerializedLambda lambda = LambdaUtil.resolve(propertyName); + final String instantiatedMethodType = lambda.getInstantiatedMethodType(); + final Class annotationClass = ClassUtil.loadClass(StrUtil.sub(instantiatedMethodType, 2, StrUtil.indexOf(instantiatedMethodType, ';'))); + return getAnnotationValue(annotationEle, annotationClass, lambda.getImplMethodName()); + } + } + + /** + * 获取指定注解中所有属性值
+ * 如果无指定的属性方法返回null + * + * @param annotationEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param annotationType 注解类型 + * @return 注解对象 + * @throws UtilException 调用注解中的方法时执行异常 + */ + public static Map getAnnotationValueMap(AnnotatedElement annotationEle, Class annotationType) throws UtilException { + final Annotation annotation = getAnnotation(annotationEle, annotationType); + if (null == annotation) { + return null; + } + + final Method[] methods = ReflectUtil.getMethods(annotationType, t -> { + if (ArrayUtil.isEmpty(t.getParameterTypes())) { + // 只读取无参方法 + final String name = t.getName(); + // 跳过自有的几个方法 + return (false == "hashCode".equals(name)) // + && (false == "toString".equals(name)) // + && (false == "annotationType".equals(name)); + } + return false; + }); + + final HashMap result = new HashMap<>(methods.length, 1); + for (Method method : methods) { + result.put(method.getName(), ReflectUtil.invoke(annotation, method)); + } + return result; + } + + /** + * 获取注解类的保留时间，可选值 SOURCE（源码时），CLASS（编译时），RUNTIME（运行时），默认为 CLASS + * + * @param annotationType 注解类 + * @return 保留时间枚举 + */ + public static RetentionPolicy getRetentionPolicy(Class annotationType) { + final Retention retention = annotationType.getAnnotation(Retention.class); + if (null == retention) { + return RetentionPolicy.CLASS; + } + return retention.value(); + } + + /** + * 获取注解类可以用来修饰哪些程序元素，如 TYPE, METHOD, CONSTRUCTOR, FIELD, PARAMETER 等 + * + * @param annotationType 注解类 + * @return 注解修饰的程序元素数组 + */ + public static ElementType[] getTargetType(Class annotationType) { + final Target target = annotationType.getAnnotation(Target.class); + if (null == target) { + return new ElementType[]{ElementType.TYPE, // + ElementType.FIELD, // + ElementType.METHOD, // + ElementType.PARAMETER, // + ElementType.CONSTRUCTOR, // + ElementType.LOCAL_VARIABLE, // + ElementType.ANNOTATION_TYPE, // + ElementType.PACKAGE// + }; + } + return target.value(); + } + + /** + * 是否会保存到 Javadoc 文档中 + * + * @param annotationType 注解类 + * @return 是否会保存到 Javadoc 文档中 + */ + public static boolean isDocumented(Class annotationType) { + return annotationType.isAnnotationPresent(Documented.class); + } + + /** + * 是否可以被继承，默认为 false + * + * @param annotationType 注解类 + * @return 是否会保存到 Javadoc 文档中 + */ + public static boolean isInherited(Class annotationType) { + return annotationType.isAnnotationPresent(Inherited.class); + } + + /** + * 扫描注解类，以及注解类的{@link Class}层级结构中的注解，将返回除了{@link #META_ANNOTATIONS}中指定的JDK默认注解外， + * 按元注解对象与{@code annotationType}的距离和{@link Class#getAnnotations()}顺序排序的注解对象集合 + * + *

比如：
+ * 若{@code annotationType}为 A，且A存在元注解B，B又存在元注解C和D，则有： + * 

+	 *                              |-> C.class [@a, @b]
+	 *     A.class -> B.class [@a] -|
+	 *                              |-> D.class [@a, @c]
+	 *
+ * 扫描A，则该方法最终将返回 {@code [@a, @a, @b, @a, @c]} + * + * @param annotationType 注解类 + * @return 注解对象集合 + * @see MetaAnnotationScanner + */ + public static List scanMetaAnnotation(Class annotationType) { + return AnnotationScanner.DIRECTLY_AND_META_ANNOTATION.getAnnotationsIfSupport(annotationType); + } + + /** + *

扫描类以及类的{@link Class}层级结构中的注解，将返回除了{@link #META_ANNOTATIONS}中指定的JDK默认元注解外, + * 全部类/接口的{@link Class#getAnnotations()}方法返回的注解对象。
+ * 层级结构将按广度优先递归，遵循规则如下： + *

    + *
  • 同一层级中，优先处理父类，然后再处理父接口；
    • + *
  • 同一个接口在不同层级出现，优先选择层级距离{@code targetClass}更近的接口；
    • + *
  • 同一个接口在相同层级出现，优先选择其子类/子接口被先解析的那个；
    • + *
+ * 注解根据其声明类/接口被扫描的顺序排序，若注解都在同一个{@link Class}中被声明，则还会遵循{@link Class#getAnnotations()}的顺序。 + * + *

比如：
+ * 若{@code targetClass}为{@code A.class}，且{@code A.class}存在父类{@code B.class}、父接口{@code C.class}， + * 三个类的注解声明情况如下： + * 

+	 *                   |-> B.class [@a, @b]
+	 *     A.class [@a] -|
+	 *                   |-> C.class [@a, @c]
+	 *
+ * 则该方法最终将返回 {@code [@a, @a, @b, @a, @c]} + * + * @param targetClass 类 + * @return 注解对象集合 + * @see TypeAnnotationScanner + */ + public static List scanClass(Class targetClass) { + return AnnotationScanner.TYPE_HIERARCHY.getAnnotationsIfSupport(targetClass); + } + + /** + *

扫描方法，以及该方法所在类的{@link Class}层级结构中的具有相同方法签名的方法， + * 将返回除了{@link #META_ANNOTATIONS}中指定的JDK默认元注解外, + * 全部匹配方法上{@link Method#getAnnotations()}方法返回的注解对象。
+ * 方法所在类的层级结构将按广度优先递归，遵循规则如下： + *

    + *
  • 同一层级中，优先处理父类，然后再处理父接口；
    • + *
  • 同一个接口在不同层级出现，优先选择层级距离{@code targetClass}更近的接口；
    • + *
  • 同一个接口在相同层级出现，优先选择其子类/子接口被先解析的那个；
    • + *
+ * 方法上的注解根据方法的声明类/接口被扫描的顺序排序，若注解都在同一个类的同一个方法中被声明，则还会遵循{@link Method#getAnnotations()}的顺序。 + * + *

比如：
+ * 若方法X声明于{@code A.class}，且重载/重写自父类{@code B.class}，并且父类中的方法X由重写至其实现的接口{@code C.class}， + * 三个类的注解声明情况如下： + * 

+	 *     A#X()[@a] -> B#X()[@b] -> C#X()[@c]
+	 *
+ * 则该方法最终将返回 {@code [@a, @b, @c]} + * + * @param method 方法 + * @return 注解对象集合 + * @see MethodAnnotationScanner + */ + public static List scanMethod(Method method) { + return AnnotationScanner.TYPE_HIERARCHY.getAnnotationsIfSupport(method); + } + + /** + * 设置新的注解的属性（字段）值 + * + * @param annotation 注解对象 + * @param annotationField 注解属性（字段）名称 + * @param value 要更新的属性值 + * @since 5.5.2 + */ + @SuppressWarnings({"rawtypes", "unchecked"}) + public static void setValue(Annotation annotation, String annotationField, Object value) { + final Map memberValues = (Map) ReflectUtil.getFieldValue(Proxy.getInvocationHandler(annotation), "memberValues"); + memberValues.put(annotationField, value); + } + + /** + * 该注解对象是否为通过代理类生成的合成注解 + * + * @param annotation 注解对象 + * @return 是否 + * @see SynthesizedAnnotationProxy#isProxyAnnotation(Class) + */ + public static boolean isSynthesizedAnnotation(Annotation annotation) { + return SynthesizedAnnotationProxy.isProxyAnnotation(annotation.getClass()); + } + + /** + * 获取别名支持后的注解 + * + * @param annotationEle 被注解的类 + * @param annotationType 注解类型Class + * @param 注解类型 + * @return 别名支持后的注解 + * @since 5.7.23 + */ + public static T getAnnotationAlias(AnnotatedElement annotationEle, Class annotationType) { + final T annotation = getAnnotation(annotationEle, annotationType); + return aggregatingFromAnnotation(annotation).synthesize(annotationType); + } + + /** + * 将指定注解实例与其元注解转为合成注解 + * + * @param annotationType 注解类 + * @param annotations 注解对象 + * @param 注解类型 + * @return 合成注解 + * @see SynthesizedAggregateAnnotation + */ + public static T getSynthesizedAnnotation(Class annotationType, Annotation... annotations) { + // TODO 缓存合成注解信息，避免重复解析 + return Opt.ofNullable(annotations) + .filter(ArrayUtil::isNotEmpty) + .map(AnnotationUtil::aggregatingFromAnnotationWithMeta) + .map(a -> a.synthesize(annotationType)) + .get(); + } + + /** + *

获取元素上距离指定元素最接近的合成注解 + *

    + *
  • 若元素是类，则递归解析全部父类和全部父接口上的注解;
    • + *
  • 若元素是方法、属性或注解，则只解析其直接声明的注解;
    • + *
+ * + *

注解合成规则如下： + * 若{@code AnnotatedEle}按顺序从上到下声明了A，B，C三个注解，且三注解存在元注解如下： + * 

+	 *    A -> M3
+	 *    B -> M1 -> M2 -> M3
+	 *    C -> M2 -> M3
+	 *
+ * 此时入参{@code annotationType}类型为{@code M2}，则最终将优先返回基于根注解B合成的合成注解 + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param annotationType 注解类 + * @param 注解类型 + * @return 合成注解 + * @see SynthesizedAggregateAnnotation + */ + public static T getSynthesizedAnnotation(AnnotatedElement annotatedEle, Class annotationType) { + T target = annotatedEle.getAnnotation(annotationType); + if (ObjectUtil.isNotNull(target)) { + return target; + } + return AnnotationScanner.DIRECTLY + .getAnnotationsIfSupport(annotatedEle).stream() + .map(annotation -> getSynthesizedAnnotation(annotationType, annotation)) + .filter(Objects::nonNull) + .findFirst() + .orElse(null); + } + + /** + * 获取元素上所有指定注解 + *
    + *
  • 若元素是类，则递归解析全部父类和全部父接口上的注解;
    • + *
  • 若元素是方法、属性或注解，则只解析其直接声明的注解;
    • + *
+ * + *

注解合成规则如下： + * 若{@code AnnotatedEle}按顺序从上到下声明了A，B，C三个注解，且三注解存在元注解如下： + * 

+	 *    A -> M1 -> M2
+	 *    B -> M3 -> M1 -> M2
+	 *    C -> M2
+	 *
+ * 此时入参{@code annotationType}类型为{@code M1}，则最终将返回基于根注解A与根注解B合成的合成注解。 + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param annotationType 注解类 + * @param 注解类型 + * @return 合成注解 + * @see SynthesizedAggregateAnnotation + */ + public static List getAllSynthesizedAnnotations(AnnotatedElement annotatedEle, Class annotationType) { + return AnnotationScanner.DIRECTLY + .getAnnotationsIfSupport(annotatedEle).stream() + .map(annotation -> getSynthesizedAnnotation(annotationType, annotation)) + .filter(Objects::nonNull) + .collect(Collectors.toList()); + } + + /** + * 对指定注解对象进行聚合 + * + * @param annotations 注解对象 + * @return 聚合注解 + */ + public static SynthesizedAggregateAnnotation aggregatingFromAnnotation(Annotation... annotations) { + return new GenericSynthesizedAggregateAnnotation(Arrays.asList(annotations), AnnotationScanner.NOTHING); + } + + /** + * 对指定注解对象及其元注解进行聚合 + * + * @param annotations 注解对象 + * @return 聚合注解 + */ + public static SynthesizedAggregateAnnotation aggregatingFromAnnotationWithMeta(Annotation... annotations) { + return new GenericSynthesizedAggregateAnnotation(Arrays.asList(annotations), AnnotationScanner.DIRECTLY_AND_META_ANNOTATION); + } + + /** + * 方法是否为注解属性方法。
+ * 方法无参数，且有返回值的方法认为是注解属性的方法。 + * + * @param method 方法 + */ + static boolean isAttributeMethod(Method method) { + return method.getParameterCount() == 0 && method.getReturnType() != void.class; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/CacheableAnnotationAttribute.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/CacheableAnnotationAttribute.java new file mode 100644 index 0000000..0bd0560 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/CacheableAnnotationAttribute.java @@ -0,0 +1,63 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; + +import java.lang.annotation.Annotation; +import java.lang.reflect.Method; + +/** + * {@link AnnotationAttribute}的基本实现 + * + * @author huangchengxing + */ +public class CacheableAnnotationAttribute implements AnnotationAttribute { + + private boolean valueInvoked; + private Object value; + + private boolean defaultValueInvoked; + private Object defaultValue; + + private final Annotation annotation; + private final Method attribute; + + public CacheableAnnotationAttribute(Annotation annotation, Method attribute) { + Assert.notNull(annotation, "annotation must not null"); + Assert.notNull(attribute, "attribute must not null"); + this.annotation = annotation; + this.attribute = attribute; + this.valueInvoked = false; + this.defaultValueInvoked = false; + } + + @Override + public Annotation getAnnotation() { + return this.annotation; + } + + @Override + public Method getAttribute() { + return this.attribute; + } + + @Override + public Object getValue() { + if (!valueInvoked) { + valueInvoked = true; + value = ReflectUtil.invoke(annotation, attribute); + } + return value; + } + + @Override + public boolean isValueEquivalentToDefaultValue() { + if (!defaultValueInvoked) { + defaultValue = attribute.getDefaultValue(); + defaultValueInvoked = true; + } + return ObjectUtil.equals(getValue(), defaultValue); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/CacheableSynthesizedAnnotationAttributeProcessor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/CacheableSynthesizedAnnotationAttributeProcessor.java new file mode 100644 index 0000000..6d91a84 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/CacheableSynthesizedAnnotationAttributeProcessor.java @@ -0,0 +1,62 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.map.multi.RowKeyTable; +import aiyh.utils.tool.cn.hutool.core.map.multi.Table; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.util.Collection; +import java.util.Comparator; + +/** + *

带缓存功能的{@link SynthesizedAnnotationAttributeProcessor}实现， + * 构建时需要传入比较器，获取属性值时将根据比较器对合成注解进行排序， + * 然后选择具有所需属性的，排序最靠前的注解用于获取属性值 + * + *

通过该处理器获取合成注解属性值时会出现隐式别名， + * 即子注解和元注解中同时存在类型和名称皆相同的属性时，元注解中属性总是会被该属性覆盖， + * 并且该覆盖关系并不会通过{@link Alias}或{@link Link}被传递到关联的属性中。 + * + * @author huangchengxing + */ +public class CacheableSynthesizedAnnotationAttributeProcessor implements SynthesizedAnnotationAttributeProcessor { + + private final Table, Object> valueCaches = new RowKeyTable<>(); + private final Comparator annotationComparator; + + /** + * 创建一个带缓存的注解值选择器 + * + * @param annotationComparator 注解比较器，排序更靠前的注解将被优先用于获取值 + */ + public CacheableSynthesizedAnnotationAttributeProcessor(Comparator annotationComparator) { + Assert.notNull(annotationComparator, "annotationComparator must not null"); + this.annotationComparator = annotationComparator; + } + + /** + * 创建一个带缓存的注解值选择器， + * 默认按{@link SynthesizedAnnotation#getVerticalDistance()}和{@link SynthesizedAnnotation#getHorizontalDistance()}排序， + * 越靠前的越优先被取值。 + */ + public CacheableSynthesizedAnnotationAttributeProcessor() { + this(Hierarchical.DEFAULT_HIERARCHICAL_COMPARATOR); + } + + @SuppressWarnings("unchecked") + @Override + public T getAttributeValue(String attributeName, Class attributeType, Collection synthesizedAnnotations) { + Object value = valueCaches.get(attributeName, attributeType); + // 此处理论上不可能出现缓存值为nul的情况 + if (ObjectUtil.isNotNull(value)) { + return (T)value; + } + value = synthesizedAnnotations.stream() + .filter(ma -> ma.hasAttribute(attributeName, attributeType)) + .min(annotationComparator) + .map(ma -> ma.getAttributeValue(attributeName)) + .orElse(null); + valueCaches.put(attributeName, attributeType, value); + return (T)value; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/CombinationAnnotationElement.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/CombinationAnnotationElement.java new file mode 100755 index 0000000..61129a3 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/CombinationAnnotationElement.java @@ -0,0 +1,165 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.map.TableMap; + +import java.io.Serializable; +import java.lang.annotation.Annotation; +import java.lang.reflect.AnnotatedElement; +import java.util.Arrays; +import java.util.Collection; +import java.util.Map; +import java.util.function.Predicate; + +/** + * 组合注解 对JDK的原生注解机制做一个增强，支持类似Spring的组合注解。
+ * 核心实现使用了递归获取指定元素上的注解以及注解的注解，以实现复合注解的获取。 + * + * @author Succy, Looly + * @since 4.0.9 + **/ + +public class CombinationAnnotationElement implements AnnotatedElement, Serializable { + private static final long serialVersionUID = 1L; + + /** + * 创建CombinationAnnotationElement + * + * @param element 需要解析注解的元素：可以是Class、Method、Field、Constructor、ReflectPermission + * @param predicate 过滤器，{@link Predicate#test(Object)}返回{@code true}保留，否则不保留 + * @return CombinationAnnotationElement + * @since 5.8.0 + */ + public static CombinationAnnotationElement of(AnnotatedElement element, Predicate predicate) { + return new CombinationAnnotationElement(element, predicate); + } + + /** + * 注解类型与注解对象对应表 + */ + private Map, Annotation> annotationMap; + /** + * 直接注解类型与注解对象对应表 + */ + private Map, Annotation> declaredAnnotationMap; + /** + * 过滤器 + */ + private final Predicate predicate; + + /** + * 构造 + * + * @param element 需要解析注解的元素：可以是Class、Method、Field、Constructor、ReflectPermission + */ + public CombinationAnnotationElement(AnnotatedElement element) { + this(element, null); + } + + /** + * 构造 + * + * @param element 需要解析注解的元素：可以是Class、Method、Field、Constructor、ReflectPermission + * @param predicate 过滤器，{@link Predicate#test(Object)}返回{@code true}保留，否则不保留 + * @since 5.8.0 + */ + public CombinationAnnotationElement(AnnotatedElement element, Predicate predicate) { + this.predicate = predicate; + init(element); + } + + @Override + public boolean isAnnotationPresent(Class annotationClass) { + return annotationMap.containsKey(annotationClass); + } + + @Override + @SuppressWarnings("unchecked") + public T getAnnotation(Class annotationClass) { + Annotation annotation = annotationMap.get(annotationClass); + return (annotation == null) ? null : (T) annotation; + } + + @Override + public Annotation[] getAnnotations() { + final Collection annotations = this.annotationMap.values(); + return annotations.toArray(new Annotation[0]); + } + + @Override + public Annotation[] getDeclaredAnnotations() { + final Collection annotations = this.declaredAnnotationMap.values(); + return annotations.toArray(new Annotation[0]); + } + + /** + * 初始化 + * + * @param element 元素 + */ + private void init(AnnotatedElement element) { + final Annotation[] declaredAnnotations = element.getDeclaredAnnotations(); + this.declaredAnnotationMap = new TableMap<>(); + parseDeclared(declaredAnnotations); + + final Annotation[] annotations = element.getAnnotations(); + if (Arrays.equals(declaredAnnotations, annotations)) { + this.annotationMap = this.declaredAnnotationMap; + } else { + this.annotationMap = new TableMap<>(); + parse(annotations); + } + } + + /** + * 进行递归解析注解，直到全部都是元注解为止 + * + * @param annotations Class, Method, Field等 + */ + private void parseDeclared(Annotation[] annotations) { + Class annotationType; + // 直接注解 + for (Annotation annotation : annotations) { + annotationType = annotation.annotationType(); + // issue#I5FQGW@Gitee：跳过元注解和已经处理过的注解，防止递归调用 + if (AnnotationUtil.isNotJdkMateAnnotation(annotationType) + && false == declaredAnnotationMap.containsKey(annotationType)) { + if(test(annotation)){ + declaredAnnotationMap.put(annotationType, annotation); + } + // 测试不通过的注解，不影响继续递归 + parseDeclared(annotationType.getDeclaredAnnotations()); + } + } + } + + /** + * 进行递归解析注解，直到全部都是元注解为止 + * + * @param annotations Class, Method, Field等 + */ + private void parse(Annotation[] annotations) { + Class annotationType; + for (Annotation annotation : annotations) { + annotationType = annotation.annotationType(); + // issue#I5FQGW@Gitee：跳过元注解和已经处理过的注解，防止递归调用 + if (AnnotationUtil.isNotJdkMateAnnotation(annotationType) + && false == declaredAnnotationMap.containsKey(annotationType)) { + if(test(annotation)){ + annotationMap.put(annotationType, annotation); + } + // 测试不通过的注解，不影响继续递归 + parse(annotationType.getAnnotations()); + } + } + } + + /** + * 检查给定的注解是否符合过滤条件 + * + * @param annotation 注解对象 + * @return 是否符合条件 + */ + private boolean test(Annotation annotation) { + return null == this.predicate || this.predicate.test(annotation); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/ForceAliasFor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/ForceAliasFor.java new file mode 100644 index 0000000..83c28f5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/ForceAliasFor.java @@ -0,0 +1,35 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import java.lang.annotation.*; + +/** + *

{@link Link}的子注解。表示“原始属性”将强制作为“关联属性”的别名。效果等同于在“原始属性”上添加{@link Alias}注解， + * 任何情况下，获取“关联属性”的值都将直接返回“原始属性”的值 + * 注意，该注解与{@link Link}、{@link AliasFor}或{@link MirrorFor}一起使用时，将只有被声明在最上面的注解会生效 + * + * @author huangchengxing + * @see Link + * @see RelationType#FORCE_ALIAS_FOR + */ +@Link(type = RelationType.FORCE_ALIAS_FOR) +@Documented +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE}) +public @interface ForceAliasFor { + + /** + * 产生关联的注解类型，当不指定时，默认指注释的属性所在的类 + * + * @return 关联注解类型 + */ + @Link(annotation = Link.class, attribute = "annotation", type = RelationType.FORCE_ALIAS_FOR) + Class annotation() default Annotation.class; + + /** + * {@link #annotation()}指定注解中关联的属性 + * + * @return 关联的属性 + */ + @Link(annotation = Link.class, attribute = "attribute", type = RelationType.FORCE_ALIAS_FOR) + String attribute() default ""; +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/ForceAliasedAnnotationAttribute.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/ForceAliasedAnnotationAttribute.java new file mode 100644 index 0000000..a6406c8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/ForceAliasedAnnotationAttribute.java @@ -0,0 +1,49 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +/** + * 表示一个被指定了强制别名的注解属性。 + * 当调用{@link #getValue()}时，总是返回{@link #linked}的值 + * + * @author huangchengxing + * @see AliasAnnotationPostProcessor + * @see AliasLinkAnnotationPostProcessor + * @see RelationType#ALIAS_FOR + * @see RelationType#FORCE_ALIAS_FOR + */ +public class ForceAliasedAnnotationAttribute extends AbstractWrappedAnnotationAttribute { + + protected ForceAliasedAnnotationAttribute(AnnotationAttribute origin, AnnotationAttribute linked) { + super(origin, linked); + } + + /** + * 总是返回{@link #linked}的{@link AnnotationAttribute#getValue()}的返回值 + * + * @return {@link #linked}的{@link AnnotationAttribute#getValue()}的返回值 + */ + @Override + public Object getValue() { + return linked.getValue(); + } + + /** + * 总是返回{@link #linked}的{@link AnnotationAttribute#isValueEquivalentToDefaultValue()}的返回值 + * + * @return {@link #linked}的{@link AnnotationAttribute#isValueEquivalentToDefaultValue()}的返回值 + */ + @Override + public boolean isValueEquivalentToDefaultValue() { + return linked.isValueEquivalentToDefaultValue(); + } + + /** + * 总是返回{@link #linked}的{@link AnnotationAttribute#getAttributeType()}的返回值 + * + * @return {@link #linked}的{@link AnnotationAttribute#getAttributeType()}的返回值 + */ + @Override + public Class getAttributeType() { + return linked.getAttributeType(); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/GenericSynthesizedAggregateAnnotation.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/GenericSynthesizedAggregateAnnotation.java new file mode 100644 index 0000000..33fa0ff --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/GenericSynthesizedAggregateAnnotation.java @@ -0,0 +1,318 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.annotation.scanner.AnnotationScanner; +import aiyh.utils.tool.cn.hutool.core.annotation.scanner.MetaAnnotationScanner; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Opt; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.lang.annotation.Annotation; +import java.lang.reflect.AnnotatedElement; +import java.util.*; + +/** + * {@link SynthesizedAggregateAnnotation}的基本实现，表示基于多个注解对象， + * 或多个根注解对象与他们的多层元注解对象的聚合得到的注解。 + * + *

假设现有注解A，若指定的{@link #annotationScanner}支持扫描注解A的元注解， + * 且A上存在元注解B，B上存在元注解C，则对注解A进行解析，将得到包含根注解A，以及其元注解B、C在内的合成元注解聚合{@link GenericSynthesizedAggregateAnnotation}。 + * 从{@link AnnotatedElement}的角度来说，得到的合成注解是一个同时承载有ABC三个注解对象的被注解元素， + * 因此通过调用{@link AnnotatedElement}的相关方法将返回对应符合语义的注解对象。 + * + *

在扫描指定根注解及其元注解时，若在不同的层级出现了类型相同的注解实例， + * 将会根据实例化时指定的{@link SynthesizedAnnotationSelector}选择最优的注解， + * 完成对根注解及其元注解的扫描后，合成注解中每种类型的注解对象都将有且仅有一个。
+ * 默认情况下，将使用{@link SynthesizedAnnotationSelector#NEAREST_AND_OLDEST_PRIORITY}作为选择器， + * 此时若出现扫描时得到了多个同类型的注解对象，有且仅有最接近根注解的注解对象会被作为有效注解。 + * + *

当扫描的注解对象经过{@link SynthesizedAnnotationSelector}处理后， + * 将会被转为{@link MetaAnnotation}，并使用在实例化时指定的{@link AliasAnnotationPostProcessor} + * 进行后置处理。
+ * 默认情况下，将注册以下后置处理器以对{@link Alias}与{@link Link}和其扩展注解提供支持： + *

    + *
  • {@link AliasAnnotationPostProcessor}；
    • + *
  • {@link MirrorLinkAnnotationPostProcessor}；
    • + *
  • {@link AliasLinkAnnotationPostProcessor}；
    • + *
+ * 若用户需要自行扩展，则需要保证上述三个处理器被正确注入当前实例。 + * + *

{@link GenericSynthesizedAggregateAnnotation}支持通过{@link #getAttributeValue(String, Class)}， + * 或通过{@link #synthesize(Class)}获得注解代理对象后获取指定类型的注解属性值， + * 返回的属性值将根据合成注解中对应原始注解属性上的{@link Alias}与{@link Link}注解而有所变化。 + * 通过当前实例获取属性值时，将经过{@link SynthesizedAnnotationAttributeProcessor}的处理。
+ * 默认情况下，实例将会注册{@link CacheableSynthesizedAnnotationAttributeProcessor}， + * 该处理器将令元注解中与子注解类型与名称皆一致的属性被子注解的属性覆盖，并且缓存最终获取到的属性值。 + * + * @author huangchengxing + * @see AnnotationUtil + * @see SynthesizedAnnotationProxy + * @see SynthesizedAnnotationSelector + * @see SynthesizedAnnotationAttributeProcessor + * @see SynthesizedAnnotationPostProcessor + * @see AnnotationSynthesizer + * @see AnnotationScanner + */ +public class GenericSynthesizedAggregateAnnotation + extends AbstractAnnotationSynthesizer> + implements SynthesizedAggregateAnnotation { + + /** + * 根对象 + */ + private final Object root; + + /** + * 距离根对象的垂直距离 + */ + private final int verticalDistance; + + /** + * 距离根对象的水平距离 + */ + private final int horizontalDistance; + + /** + * 合成注解属性处理器 + */ + private final SynthesizedAnnotationAttributeProcessor attributeProcessor; + + /** + * 基于指定根注解，为其与其元注解的层级结构中的全部注解构造一个合成注解。 + * 当层级结构中出现了相同的注解对象时，将优先选择以距离根注解最近，且优先被扫描的注解对象, + * 当获取值时，同样遵循该规则。 + * + * @param source 源注解 + */ + public GenericSynthesizedAggregateAnnotation(Annotation... source) { + this(Arrays.asList(source), new MetaAnnotationScanner()); + } + + /** + * 基于指定根注解，为其层级结构中的全部注解构造一个合成注解。 + * 若扫描器支持对注解的层级结构进行扫描，则若层级结构中出现了相同的注解对象时， + * 将优先选择以距离根注解最近，且优先被扫描的注解对象，并且当获取注解属性值时同样遵循该规则。 + * + * @param source 源注解 + * @param annotationScanner 注解扫描器，该扫描器必须支持扫描注解类 + */ + public GenericSynthesizedAggregateAnnotation(List source, AnnotationScanner annotationScanner) { + this( + source, SynthesizedAnnotationSelector.NEAREST_AND_OLDEST_PRIORITY, + new CacheableSynthesizedAnnotationAttributeProcessor(), + Arrays.asList( + SynthesizedAnnotationPostProcessor.ALIAS_ANNOTATION_POST_PROCESSOR, + SynthesizedAnnotationPostProcessor.MIRROR_LINK_ANNOTATION_POST_PROCESSOR, + SynthesizedAnnotationPostProcessor.ALIAS_LINK_ANNOTATION_POST_PROCESSOR + ), + annotationScanner + ); + } + + /** + * 基于指定根注解，为其层级结构中的全部注解构造一个合成注解 + * + * @param source 当前查找的注解对象 + * @param annotationSelector 合成注解选择器 + * @param attributeProcessor 注解属性处理器 + * @param annotationPostProcessors 注解后置处理器 + * @param annotationScanner 注解扫描器，该扫描器必须支持扫描注解类 + */ + public GenericSynthesizedAggregateAnnotation( + List source, + SynthesizedAnnotationSelector annotationSelector, + SynthesizedAnnotationAttributeProcessor attributeProcessor, + Collection annotationPostProcessors, + AnnotationScanner annotationScanner) { + this( + null, 0, 0, + source, annotationSelector, attributeProcessor, annotationPostProcessors, annotationScanner + ); + } + + /** + * 基于指定根注解，为其层级结构中的全部注解构造一个合成注解 + * + * @param root 根对象 + * @param verticalDistance 距离根对象的水平距离 + * @param horizontalDistance 距离根对象的垂直距离 + * @param source 当前查找的注解对象 + * @param annotationSelector 合成注解选择器 + * @param attributeProcessor 注解属性处理器 + * @param annotationPostProcessors 注解后置处理器 + * @param annotationScanner 注解扫描器，该扫描器必须支持扫描注解类 + */ + GenericSynthesizedAggregateAnnotation( + Object root, int verticalDistance, int horizontalDistance, + List source, + SynthesizedAnnotationSelector annotationSelector, + SynthesizedAnnotationAttributeProcessor attributeProcessor, + Collection annotationPostProcessors, + AnnotationScanner annotationScanner) { + super(source, annotationSelector, annotationPostProcessors, annotationScanner); + Assert.notNull(attributeProcessor, "attributeProcessor must not null"); + + this.root = ObjectUtil.defaultIfNull(root, this); + this.verticalDistance = verticalDistance; + this.horizontalDistance = horizontalDistance; + this.attributeProcessor = attributeProcessor; + } + + /** + * 获取根对象 + * + * @return 根对象 + */ + @Override + public Object getRoot() { + return root; + } + + /** + * 获取与根对象的垂直距离 + * + * @return 与根对象的垂直距离 + */ + @Override + public int getVerticalDistance() { + return verticalDistance; + } + + /** + * 获取与根对象的水平距离 + * + * @return 获取与根对象的水平距离 + */ + @Override + public int getHorizontalDistance() { + return horizontalDistance; + } + + /** + * 按广度优先扫描{@link #source}上的元注解 + */ + @Override + protected Map, SynthesizedAnnotation> loadAnnotations() { + Map, SynthesizedAnnotation> annotationMap = new LinkedHashMap<>(); + + // 根注解默认水平坐标为0，根注解的元注解坐标从1开始 + for (int i = 0; i < source.size(); i++) { + final Annotation sourceAnnotation = source.get(i); + Assert.isFalse(AnnotationUtil.isSynthesizedAnnotation(sourceAnnotation), "source [{}] has been synthesized"); + annotationMap.put(sourceAnnotation.annotationType(), new MetaAnnotation(sourceAnnotation, sourceAnnotation, 0, i)); + Assert.isTrue( + annotationScanner.support(sourceAnnotation.annotationType()), + "annotation scanner [{}] cannot support scan [{}]", + annotationScanner, sourceAnnotation.annotationType() + ); + annotationScanner.scan( + (index, annotation) -> { + SynthesizedAnnotation oldAnnotation = annotationMap.get(annotation.annotationType()); + SynthesizedAnnotation newAnnotation = new MetaAnnotation(sourceAnnotation, annotation, index + 1, annotationMap.size()); + if (ObjectUtil.isNull(oldAnnotation)) { + annotationMap.put(annotation.annotationType(), newAnnotation); + } else { + annotationMap.put(annotation.annotationType(), annotationSelector.choose(oldAnnotation, newAnnotation)); + } + }, + sourceAnnotation.annotationType(), null + ); + } + return annotationMap; + } + + /** + * 获取合成注解属性处理器 + * + * @return 合成注解属性处理器 + */ + @Override + public SynthesizedAnnotationAttributeProcessor getAnnotationAttributeProcessor() { + return this.attributeProcessor; + } + + /** + * 根据指定的属性名与属性类型获取对应的属性值，若存在{@link Alias}则获取{@link Alias#value()}指定的别名属性的值 + *

当不同层级的注解之间存在同名同类型属性时，将优先获取更接近根注解的属性 + * + * @param attributeName 属性名 + * @param attributeType 属性类型 + * @return 属性 + */ + @Override + public Object getAttributeValue(String attributeName, Class attributeType) { + return attributeProcessor.getAttributeValue(attributeName, attributeType, synthesizedAnnotationMap.values()); + } + + /** + * 获取合成注解中包含的指定注解 + * + * @param annotationType 注解类型 + * @param 注解类型 + * @return 注解对象 + */ + @Override + public T getAnnotation(Class annotationType) { + return Opt.ofNullable(annotationType) + .map(synthesizedAnnotationMap::get) + .map(SynthesizedAnnotation::getAnnotation) + .map(annotationType::cast) + .orElse(null); + } + + /** + * 当前合成注解中是否存在指定元注解 + * + * @param annotationType 注解类型 + * @return 是否 + */ + @Override + public boolean isAnnotationPresent(Class annotationType) { + return synthesizedAnnotationMap.containsKey(annotationType); + } + + /** + * 获取合成注解中包含的全部注解 + * + * @return 注解对象 + */ + @Override + public Annotation[] getAnnotations() { + return synthesizedAnnotationMap.values().stream() + .map(SynthesizedAnnotation::getAnnotation) + .toArray(Annotation[]::new); + } + + /** + * 若合成注解在存在指定元注解，则使用动态代理生成一个对应的注解实例 + * + * @param annotationType 注解类型 + * @return 合成注解对象 + * @see SynthesizedAnnotationProxy#create(Class, AnnotationAttributeValueProvider, SynthesizedAnnotation) + */ + @Override + public T synthesize(Class annotationType, SynthesizedAnnotation annotation) { + return SynthesizedAnnotationProxy.create(annotationType, this, annotation); + } + + /** + * 注解包装类，表示{@link #source}以及{@link #source}所属层级结构中的全部关联注解对象 + * + * @author huangchengxing + */ + public static class MetaAnnotation extends GenericSynthesizedAnnotation { + + /** + * 创建一个合成注解 + * + * @param root 根对象 + * @param annotation 被合成的注解对象 + * @param verticalDistance 距离根对象的水平距离 + * @param horizontalDistance 距离根对象的垂直距离 + */ + protected MetaAnnotation(Annotation root, Annotation annotation, int verticalDistance, int horizontalDistance) { + super(root, annotation, verticalDistance, horizontalDistance); + } + + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/GenericSynthesizedAnnotation.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/GenericSynthesizedAnnotation.java new file mode 100644 index 0000000..99fad59 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/GenericSynthesizedAnnotation.java @@ -0,0 +1,197 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.lang.Opt; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.lang.annotation.Annotation; +import java.lang.reflect.Method; +import java.util.HashMap; +import java.util.Map; +import java.util.function.UnaryOperator; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +/** + * {@link SynthesizedAnnotation}的基本实现 + * + * @param 根对象类型 + * @param 注解类型 + * @author huangchengxing + */ +public class GenericSynthesizedAnnotation implements SynthesizedAnnotation { + + private final R root; + private final T annotation; + private final Map attributeMethodCaches; + private final int verticalDistance; + private final int horizontalDistance; + + /** + * 创建一个合成注解 + * + * @param root 根对象 + * @param annotation 被合成的注解对象 + * @param verticalDistance 距离根对象的水平距离 + * @param horizontalDistance 距离根对象的垂直距离 + */ + protected GenericSynthesizedAnnotation( + R root, T annotation, int verticalDistance, int horizontalDistance) { + this.root = root; + this.annotation = annotation; + this.verticalDistance = verticalDistance; + this.horizontalDistance = horizontalDistance; + this.attributeMethodCaches = new HashMap<>(); + this.attributeMethodCaches.putAll(loadAttributeMethods()); + } + + /** + * 加载注解属性 + * + * @return 注解属性 + */ + protected Map loadAttributeMethods() { + return Stream.of(ClassUtil.getDeclaredMethods(annotation.annotationType())) + .filter(AnnotationUtil::isAttributeMethod) + .collect(Collectors.toMap(Method::getName, method -> new CacheableAnnotationAttribute(annotation, method))); + } + + /** + * 元注解是否存在该属性 + * + * @param attributeName 属性名 + * @return 是否存在该属性 + */ + public boolean hasAttribute(String attributeName) { + return attributeMethodCaches.containsKey(attributeName); + } + + /** + * 元注解是否存在该属性，且该属性的值类型是指定类型或其子类 + * + * @param attributeName 属性名 + * @param returnType 返回值类型 + * @return 是否存在该属性 + */ + @Override + public boolean hasAttribute(String attributeName, Class returnType) { + return Opt.ofNullable(attributeMethodCaches.get(attributeName)) + .filter(method -> ClassUtil.isAssignable(returnType, method.getAttributeType())) + .isPresent(); + } + + /** + * 获取该注解的全部属性 + * + * @return 注解属性 + */ + @Override + public Map getAttributes() { + return this.attributeMethodCaches; + } + + /** + * 设置属性值 + * + * @param attributeName 属性名称 + * @param attribute 注解属性 + */ + @Override + public void setAttribute(String attributeName, AnnotationAttribute attribute) { + attributeMethodCaches.put(attributeName, attribute); + } + + /** + * 替换属性值 + * + * @param attributeName 属性名 + * @param operator 替换操作 + */ + @Override + public void replaceAttribute(String attributeName, UnaryOperator operator) { + AnnotationAttribute old = attributeMethodCaches.get(attributeName); + if (ObjectUtil.isNotNull(old)) { + attributeMethodCaches.put(attributeName, operator.apply(old)); + } + } + + /** + * 获取属性值 + * + * @param attributeName 属性名 + * @return 属性值 + */ + @Override + public Object getAttributeValue(String attributeName) { + return Opt.ofNullable(attributeMethodCaches.get(attributeName)) + .map(AnnotationAttribute::getValue) + .get(); + } + + /** + * 获取该合成注解对应的根节点 + * + * @return 合成注解对应的根节点 + */ + @Override + public R getRoot() { + return root; + } + + /** + * 获取被合成的注解对象 + * + * @return 注解对象 + */ + @Override + public T getAnnotation() { + return annotation; + } + + /** + * 获取该合成注解与根对象的垂直距离。 + * 默认情况下，该距离即为当前注解与根对象之间相隔的层级数。 + * + * @return 合成注解与根对象的垂直距离 + */ + @Override + public int getVerticalDistance() { + return verticalDistance; + } + + /** + * 获取该合成注解与根对象的水平距离。 + * 默认情况下，该距离即为当前注解与根对象之间相隔的已经被扫描到的注解数。 + * + * @return 合成注解与根对象的水平距离 + */ + @Override + public int getHorizontalDistance() { + return horizontalDistance; + } + + /** + * 获取被合成的注解类型 + * + * @return 被合成的注解类型 + */ + @Override + public Class annotationType() { + return annotation.annotationType(); + } + + /** + * 获取注解属性值 + * + * @param attributeName 属性名称 + * @param attributeType 属性类型 + * @return 注解属性值 + */ + @Override + public Object getAttributeValue(String attributeName, Class attributeType) { + return Opt.ofNullable(attributeMethodCaches.get(attributeName)) + .filter(method -> ClassUtil.isAssignable(attributeType, method.getAttributeType())) + .map(AnnotationAttribute::getValue) + .get(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/Hierarchical.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/Hierarchical.java new file mode 100644 index 0000000..729017a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/Hierarchical.java @@ -0,0 +1,155 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + + +import java.util.Comparator; + +/** + *

描述以一个参照物为对象，存在于该参照物的层级结构中的对象。 + * + *

该对象可通过{@link #getVerticalDistance()}与{@link #getHorizontalDistance()} + * 描述其在以参照物为基点的坐标坐标系中的位置。
+ * 在需要对该接口的实现类进行按优先级排序时，距离{@link #getRoot()}对象越近，则该实现类的优先级越高。 + * 默认提供了{@link #DEFAULT_HIERARCHICAL_COMPARATOR}用于实现该比较规则。
+ * 一般情况下，{@link #getRoot()}返回值相同的对象之间的比较才有意义。 + * + *

此外，还提供了{@link Selector}接口用于根据一定的规则从两个{@link Hierarchical}实现类中选择并返回一个最合适的对象， + * 默认提供了四个实现类： + *

    + *
  • {@link Selector#NEAREST_AND_OLDEST_PRIORITY}: 返回距离根对象更近的对象，当距离一样时优先返回旧对象；
    • + *
  • {@link Selector#NEAREST_AND_NEWEST_PRIORITY}: 返回距离根对象更近的对象，当距离一样时优先返回新对象；
    • + *
  • {@link Selector#FARTHEST_AND_OLDEST_PRIORITY}: 返回距离根对象更远的对象，当距离一样时优先返回旧对象；
    • + *
  • {@link Selector#FARTHEST_AND_NEWEST_PRIORITY}: 返回距离根对象更远的对象，当距离一样时优先返回新对象；
    • + *
+ * + * @author huangchengxing + */ +public interface Hierarchical extends Comparable { + + // ====================== compare ====================== + + /** + * 默认{@link #getHorizontalDistance()}与{@link #getVerticalDistance()}排序的比较器 + */ + Comparator DEFAULT_HIERARCHICAL_COMPARATOR = Comparator + .comparing(Hierarchical::getVerticalDistance) + .thenComparing(Hierarchical::getHorizontalDistance); + + /** + * 按{@link #getVerticalDistance()}和{@link #getHorizontalDistance()}排序 + * + * @param o {@link SynthesizedAnnotation}对象 + * @return 比较值 + */ + @Override + default int compareTo(Hierarchical o) { + return DEFAULT_HIERARCHICAL_COMPARATOR.compare(this, o); + } + + // ====================== hierarchical ====================== + + /** + * 参照物，即坐标为{@code (0, 0)}的对象。 + * 当对象本身即为参照物时，该方法应当返回其本身 + * + * @return 参照物 + */ + Object getRoot(); + + /** + * 获取该对象与参照物的垂直距离。 + * 默认情况下，该距离即为当前对象与参照物之间相隔的层级数。 + * + * @return 合成注解与根对象的垂直距离 + */ + int getVerticalDistance(); + + /** + * 获取该对象与参照物的水平距离。 + * 默认情况下，该距离即为当前对象在与参照物{@link #getVerticalDistance()}相同的情况下条， + * 该对象被扫描到的顺序。 + * + * @return 合成注解与根对象的水平距离 + */ + int getHorizontalDistance(); + + // ====================== selector ====================== + + /** + * {@link Hierarchical}选择器，用于根据一定的规则从两个{@link Hierarchical}实现类中选择并返回一个最合适的对象 + */ + @FunctionalInterface + interface Selector { + + /** + * 返回距离根对象更近的对象，当距离一样时优先返回旧对象 + */ + Selector NEAREST_AND_OLDEST_PRIORITY = new NearestAndOldestPrioritySelector(); + + /** + * 返回距离根对象更近的对象，当距离一样时优先返回新对象 + */ + Selector NEAREST_AND_NEWEST_PRIORITY = new NearestAndNewestPrioritySelector(); + + /** + * 返回距离根对象更远的对象，当距离一样时优先返回旧对象 + */ + Selector FARTHEST_AND_OLDEST_PRIORITY = new FarthestAndOldestPrioritySelector(); + + /** + * 返回距离根对象更远的对象，当距离一样时优先返回新对象 + */ + Selector FARTHEST_AND_NEWEST_PRIORITY = new FarthestAndNewestPrioritySelector(); + + /** + * 比较两个被合成的对象，选择其中的一个并返回 + * + * @param 复合注解类型 + * @param prev 上一对象，该参数不允许为空 + * @param next 下一对象，该参数不允许为空 + * @return 对象 + */ + T choose(T prev, T next); + + /** + * 返回距离根对象更近的注解，当距离一样时优先返回旧注解 + */ + class NearestAndOldestPrioritySelector implements Selector { + @Override + public T choose(T oldAnnotation, T newAnnotation) { + return newAnnotation.getVerticalDistance() < oldAnnotation.getVerticalDistance() ? newAnnotation : oldAnnotation; + } + } + + /** + * 返回距离根对象更近的注解，当距离一样时优先返回新注解 + */ + class NearestAndNewestPrioritySelector implements Selector { + @Override + public T choose(T oldAnnotation, T newAnnotation) { + return newAnnotation.getVerticalDistance() <= oldAnnotation.getVerticalDistance() ? newAnnotation : oldAnnotation; + } + } + + /** + * 返回距离根对象更远的注解，当距离一样时优先返回旧注解 + */ + class FarthestAndOldestPrioritySelector implements Selector { + @Override + public T choose(T oldAnnotation, T newAnnotation) { + return newAnnotation.getVerticalDistance() > oldAnnotation.getVerticalDistance() ? newAnnotation : oldAnnotation; + } + } + + /** + * 返回距离根对象更远的注解，当距离一样时优先返回新注解 + */ + class FarthestAndNewestPrioritySelector implements Selector { + @Override + public T choose(T oldAnnotation, T newAnnotation) { + return newAnnotation.getVerticalDistance() >= oldAnnotation.getVerticalDistance() ? newAnnotation : oldAnnotation; + } + } + + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/Link.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/Link.java new file mode 100644 index 0000000..abacadf --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/Link.java @@ -0,0 +1,49 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import java.lang.annotation.*; + +/** + *

用于在同一注解中，或具有一定关联的不同注解的属性中，表明这些属性之间具有特定的关联关系。 + * 在通过{@link SynthesizedAggregateAnnotation}获取合成注解后，合成注解获取属性值时会根据该注解进行调整。
+ * + *

该注解存在三个字注解：{@link MirrorFor}、{@link ForceAliasFor}或{@link AliasFor}， + * 使用三个子注解等同于{@link Link}。但是需要注意的是， + * 当注解中的属性同时存在多个{@link Link}或基于{@link Link}的子注解时， + * 仅有声明在被注解的属性最上方的注解会生效，其余注解都将被忽略。 + * + * 注意：该注解的优先级低于{@link Alias} + * + * @author huangchengxing + * @see SynthesizedAggregateAnnotation + * @see RelationType + * @see AliasFor + * @see MirrorFor + * @see ForceAliasFor + */ +@Documented +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE}) +public @interface Link { + + /** + * 产生关联的注解类型，当不指定时，默认指注释的属性所在的类 + * + * @return 关联的注解类型 + */ + Class annotation() default Annotation.class; + + /** + * {@link #annotation()}指定注解中关联的属性 + * + * @return 属性名 + */ + String attribute() default ""; + + /** + * {@link #attribute()}指定属性与当前注解的属性建的关联关系类型 + * + * @return 关系类型 + */ + RelationType type() default RelationType.MIRROR_FOR; + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/MirrorFor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/MirrorFor.java new file mode 100644 index 0000000..b21a9e9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/MirrorFor.java @@ -0,0 +1,42 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import java.lang.annotation.*; + +/** + *

{@link Link}的子注解。表示注解的属性与指定的属性互为镜像，通过一个属性将能够获得对方的值。
+ * 它们遵循下述规则： + *

    + *
  • 互为镜像的两个属性，必须同时通过指定模式为{@code MIRROR_FOR}的{@link Link}注解指定对方；
    • + *
  • 互为镜像的两个属性，类型必须一致；
    • + *
  • 互为镜像的两个属性在获取值，且两者的值皆不同时，必须且仅允许有一个非默认值，该值被优先返回；
    • + *
  • 互为镜像的两个属性，在值都为默认值或都不为默认值时，两者的值必须相等；
    • + *
+ * 注意，该注解与{@link Link}、{@link ForceAliasFor}或{@link AliasFor}一起使用时，将只有被声明在最上面的注解会生效 + * + * @author huangchengxing + * @see Link + * @see RelationType#MIRROR_FOR + */ +@Link(type = RelationType.MIRROR_FOR) +@Documented +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE}) +public @interface MirrorFor { + + /** + * 产生关联的注解类型，当不指定时，默认指注释的属性所在的类 + * + * @return 关联的注解类型 + */ + @Link(annotation = Link.class, attribute = "annotation", type = RelationType.FORCE_ALIAS_FOR) + Class annotation() default Annotation.class; + + /** + * {@link #annotation()}指定注解中关联的属性 + * + * @return 属性名 + */ + @Link(annotation = Link.class, attribute = "attribute", type = RelationType.FORCE_ALIAS_FOR) + String attribute() default ""; + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/MirrorLinkAnnotationPostProcessor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/MirrorLinkAnnotationPostProcessor.java new file mode 100644 index 0000000..4eb18bf --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/MirrorLinkAnnotationPostProcessor.java @@ -0,0 +1,132 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.text.CharSequenceUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +/** + *

用于处理注解对象中带有{@link Link}注解，且{@link Link#type()}为{@link RelationType#MIRROR_FOR}的属性。
+ * 当该处理器执行完毕后，原始合成注解中被{@link Link}注解的属性与{@link Link}注解指向的目标注解的属性， + * 都将会被被包装并替换为{@link MirroredAnnotationAttribute}。 + * + * @author huangchengxing + * @see RelationType#MIRROR_FOR + * @see MirroredAnnotationAttribute + */ +public class MirrorLinkAnnotationPostProcessor extends AbstractLinkAnnotationPostProcessor { + + private static final RelationType[] PROCESSED_RELATION_TYPES = new RelationType[]{ RelationType.MIRROR_FOR }; + + @Override + public int order() { + return Integer.MIN_VALUE + 1; + } + + /** + * 该处理器只处理{@link Link#type()}类型为{@link RelationType#MIRROR_FOR}的注解属性 + * + * @return 仅有{@link RelationType#MIRROR_FOR}数组 + */ + @Override + protected RelationType[] processTypes() { + return PROCESSED_RELATION_TYPES; + } + + /** + * 将存在镜像关系的合成注解属性分别包装为{@link MirroredAnnotationAttribute}对象， + * 并使用包装后{@link MirroredAnnotationAttribute}替换在它们对应合成注解实例中的{@link AnnotationAttribute} + * + * @param synthesizer 注解合成器 + * @param annotation {@code originalAttribute}上的{@link Link}注解对象 + * @param originalAnnotation 当前正在处理的{@link SynthesizedAnnotation}对象 + * @param originalAttribute {@code originalAnnotation}上的待处理的属性 + * @param linkedAnnotation {@link Link}指向的关联注解对象 + * @param linkedAttribute {@link Link}指向的{@code originalAnnotation}中的关联属性，该参数可能为空 + */ + @Override + protected void processLinkedAttribute( + AnnotationSynthesizer synthesizer, Link annotation, + SynthesizedAnnotation originalAnnotation, AnnotationAttribute originalAttribute, + SynthesizedAnnotation linkedAnnotation, AnnotationAttribute linkedAttribute) { + + // 镜像属性必然成对出现，因此此处必定存在三种情况： + // 1.两属性都不为镜像属性，此时继续进行后续处理； + // 2.两属性都为镜像属性，并且指向对方，此时无需后续处理； + // 3.两属性仅有任意一属性为镜像属性，此时镜像属性必然未指向当前原始属性，此时应该抛出异常； + if (originalAttribute instanceof MirroredAnnotationAttribute + || linkedAttribute instanceof MirroredAnnotationAttribute) { + checkMirrored(originalAttribute, linkedAttribute); + return; + } + + // 校验镜像关系 + checkMirrorRelation(annotation, originalAttribute, linkedAttribute); + // 包装这一对镜像属性，并替换原注解中的对应属性 + final AnnotationAttribute mirroredOriginalAttribute = new MirroredAnnotationAttribute(originalAttribute, linkedAttribute); + originalAnnotation.setAttribute(originalAttribute.getAttributeName(), mirroredOriginalAttribute); + final AnnotationAttribute mirroredTargetAttribute = new MirroredAnnotationAttribute(linkedAttribute, originalAttribute); + linkedAnnotation.setAttribute(annotation.attribute(), mirroredTargetAttribute); + } + + /** + * 检查映射关系是否正确 + */ + private void checkMirrored(AnnotationAttribute original, AnnotationAttribute mirror) { + final boolean originalAttributeMirrored = original instanceof MirroredAnnotationAttribute; + final boolean mirrorAttributeMirrored = mirror instanceof MirroredAnnotationAttribute; + + // 校验通过 + final boolean passed = originalAttributeMirrored && mirrorAttributeMirrored + && ObjectUtil.equals(((MirroredAnnotationAttribute)original).getLinked(), ((MirroredAnnotationAttribute)mirror).getOriginal()); + if (passed) { + return; + } + + // 校验失败，拼装异常信息用于抛出异常 + String errorMsg; + // 原始字段已经跟其他字段形成镜像 + if (originalAttributeMirrored && !mirrorAttributeMirrored) { + errorMsg = CharSequenceUtil.format( + "attribute [{}] cannot mirror for [{}], because it's already mirrored for [{}]", + original.getAttribute(), mirror.getAttribute(), ((MirroredAnnotationAttribute)original).getLinked() + ); + } + // 镜像字段已经跟其他字段形成镜像 + else if (!originalAttributeMirrored && mirrorAttributeMirrored) { + errorMsg = CharSequenceUtil.format( + "attribute [{}] cannot mirror for [{}], because it's already mirrored for [{}]", + mirror.getAttribute(), original.getAttribute(), ((MirroredAnnotationAttribute)mirror).getLinked() + ); + } + // 两者都形成了镜像，但是都未指向对方，理论上不会存在该情况 + else { + errorMsg = CharSequenceUtil.format( + "attribute [{}] cannot mirror for [{}], because [{}] already mirrored for [{}] and [{}] already mirrored for [{}]", + mirror.getAttribute(), original.getAttribute(), + mirror.getAttribute(), ((MirroredAnnotationAttribute)mirror).getLinked(), + original.getAttribute(), ((MirroredAnnotationAttribute)original).getLinked() + ); + } + + throw new IllegalArgumentException(errorMsg); + } + + /** + * 基本校验 + */ + private void checkMirrorRelation(Link annotation, AnnotationAttribute original, AnnotationAttribute mirror) { + // 镜像属性必须存在 + checkLinkedAttributeNotNull(original, mirror, annotation); + // 镜像属性返回值必须一致 + checkAttributeType(original, mirror); + // 镜像属性上必须存在对应的注解 + final Link mirrorAttributeAnnotation = getLinkAnnotation(mirror, RelationType.MIRROR_FOR); + Assert.isTrue( + ObjectUtil.isNotNull(mirrorAttributeAnnotation) && RelationType.MIRROR_FOR.equals(mirrorAttributeAnnotation.type()), + "mirror attribute [{}] of original attribute [{}] must marked by @Link, and also @LinkType.type() must is [{}]", + mirror.getAttribute(), original.getAttribute(), RelationType.MIRROR_FOR + ); + checkLinkedSelf(original, mirror); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/MirroredAnnotationAttribute.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/MirroredAnnotationAttribute.java new file mode 100644 index 0000000..70202c4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/MirroredAnnotationAttribute.java @@ -0,0 +1,48 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +/** + * 表示存在对应镜像属性的注解属性，当获取值时将根据{@link RelationType#MIRROR_FOR}的规则进行处理 + * + * @author huangchengxing + * @see MirrorLinkAnnotationPostProcessor + * @see RelationType#MIRROR_FOR + */ +public class MirroredAnnotationAttribute extends AbstractWrappedAnnotationAttribute { + + public MirroredAnnotationAttribute(AnnotationAttribute origin, AnnotationAttribute linked) { + super(origin, linked); + } + + @Override + public Object getValue() { + final boolean originIsDefault = original.isValueEquivalentToDefaultValue(); + final boolean targetIsDefault = linked.isValueEquivalentToDefaultValue(); + final Object originValue = original.getValue(); + final Object targetValue = linked.getValue(); + + // 都为默认值，或都为非默认值时，两方法的返回值必须相等 + if (originIsDefault == targetIsDefault) { + Assert.equals( + originValue, targetValue, + "the values of attributes [{}] and [{}] that mirror each other are different: [{}] <==> [{}]", + original.getAttribute(), linked.getAttribute(), originValue, targetValue + ); + return originValue; + } + + // 两者有一者不为默认值时，优先返回非默认值 + return originIsDefault ? targetValue : originValue; + } + + /** + * 当{@link #original}与{@link #linked}都为默认值时返回{@code true} + * + * @return 是否 + */ + @Override + public boolean isValueEquivalentToDefaultValue() { + return original.isValueEquivalentToDefaultValue() && linked.isValueEquivalentToDefaultValue(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/PropIgnore.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/PropIgnore.java new file mode 100644 index 0000000..f833b0e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/PropIgnore.java @@ -0,0 +1,21 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * 属性忽略注解，使用此注解的字段等会被忽略，主要用于Bean拷贝、Bean转Map等
+ * 此注解应用于字段时，忽略读取和设置属性值，应用于setXXX方法忽略设置值，应用于getXXX忽略读取值 + * + * @author Looly + * @since 5.4.2 + */ +@Documented +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER}) +public @interface PropIgnore { + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/RelationType.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/RelationType.java new file mode 100644 index 0000000..f892a19 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/RelationType.java @@ -0,0 +1,50 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +/** + *

注解属性的关系类型
+ * 若将被{@link Link}注解的属性称为“原始属性”，而在{@link Link}注解中指向的注解属性称为“关联属性”， + * 则该枚举用于描述“原始属性”与“关联属性”在{@link SynthesizedAggregateAnnotation}处理过程中的作用关系。
+ * 根据在{@link Link#type()}中指定的关系类型的不同，通过{@link SynthesizedAggregateAnnotation}合成的注解的属性值也将有所变化。 + * + *

当一个注解中的所有属性同时具备多种关系时，将依次按下述顺序处理： + *

    + *
  1. 属性上的{@link Alias}注解；
    2. + *
  2. 属性上的{@link Link}注解，且{@link Link#type()}为{@link #MIRROR_FOR}；
    3. + *
  3. 属性上的{@link Link}注解，且{@link Link#type()}为{@link #FORCE_ALIAS_FOR}；
    4. + *
  4. 属性上的{@link Link}注解，且{@link Link#type()}为{@link #ALIAS_FOR}；
    5. + *
+ * + * @author huangchengxing + * @see SynthesizedAggregateAnnotation + * @see Link + */ +public enum RelationType { + + /** + *

表示注解的属性与指定的属性互为镜像，通过一个属性将能够获得对方的值。
+ * 它们遵循下述规则： + *

    + *
  • 互为镜像的两个属性，必须同时通过指定模式为{@code MIRROR_FOR}的{@link Link}注解指定对方；
    • + *
  • 互为镜像的两个属性，类型必须一致；
    • + *
  • 互为镜像的两个属性在获取值，且两者的值皆不同时，必须且仅允许有一个非默认值，该值被优先返回；
    • + *
  • 互为镜像的两个属性，在值都为默认值或都不为默认值时，两者的值必须相等；
    • + *
+ */ + MIRROR_FOR, + + /** + *

表示“原始属性”将作为“关联属性”的别名。 + *

    + *
  • 当“原始属性”为默认值时，获取“关联属性”将返回“关联属性”本身的值；
    • + *
  • 当“原始属性”不为默认值时，获取“关联属性”将返回“原始属性”的值；
    • + *
+ */ + ALIAS_FOR, + + /** + *

表示“原始属性”将强制作为“关联属性”的别名。效果等同于在“原始属性”上添加{@link Alias}注解， + * 任何情况下，获取“关联属性”的值都将直接返回“原始属性”的值 + */ + FORCE_ALIAS_FOR; + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAggregateAnnotation.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAggregateAnnotation.java new file mode 100644 index 0000000..2dbc798 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAggregateAnnotation.java @@ -0,0 +1,102 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import java.lang.annotation.Annotation; + +/** + *

表示基于特定规则聚合，将一组注解聚合而来的注解对象， + * 该注解对象允许根据一定规则“合成”一些跟原始注解属性不一样合成注解。 + * + *

合成注解一般被用于处理类层级结果中具有直接或间接关联的注解对象， + * 当实例被创建时，会获取到这些注解对象，并使用{@link SynthesizedAnnotationSelector}对类型相同的注解进行过滤， + * 并最终得到类型不重复的有效注解对象。这些有效注解将被包装为{@link SynthesizedAnnotation}， + * 然后最终用于“合成”一个{@link SynthesizedAggregateAnnotation}。
+ * {@link SynthesizedAnnotationSelector}是合成注解生命周期中的第一个钩子， + * 自定义选择器以拦截原始注解被扫描的过程。 + * + *

当合成注解完成对待合成注解的扫描，并完成了必要属性的加载后， + * 将会按顺序依次调用{@link SynthesizedAnnotationPostProcessor}， + * 注解后置处理器允许用于对完成注解的待合成注解进行二次调整， + * 该钩子一般用于根据{@link Link}注解对属性进行调整。
+ * {@link SynthesizedAnnotationPostProcessor}是合成注解生命周期中的第二个钩子， + * 自定义后置处理器以拦截原始在转为待合成注解后的初始化过程。 + * + *

合成注解允许通过{@link #synthesize(Class)}合成一个指定的注解对象， + * 该方法返回的注解对象可能是原始的注解对象，也有可能通过动态代理的方式生成， + * 该对象实例的属性不一定来自对象本身，而是来自于经过{@link SynthesizedAnnotationAttributeProcessor} + * 处理后的、用于合成当前实例的全部关联注解的相关属性。
+ * {@link SynthesizedAnnotationAttributeProcessor}是合成注解生命周期中的第三个钩子， + * 自定义属性处理器以拦截合成注解的取值过程。 + * + * @author huangchengxing + * @see AnnotationSynthesizer + * @see SynthesizedAnnotation + * @see SynthesizedAnnotationSelector + * @see SynthesizedAnnotationAttributeProcessor + * @see SynthesizedAnnotationPostProcessor + * @see GenericSynthesizedAggregateAnnotation + */ +public interface SynthesizedAggregateAnnotation extends AggregateAnnotation, Hierarchical, AnnotationSynthesizer, AnnotationAttributeValueProvider { + + // ================== hierarchical ================== + + /** + * 距离{@link #getRoot()}返回值的垂直距离， + * 默认聚合注解即为根对象，因此返回0 + * + * @return 距离{@link #getRoot()}返回值的水平距离， + */ + @Override + default int getVerticalDistance() { + return 0; + } + + /** + * 距离{@link #getRoot()}返回值的水平距离， + * 默认聚合注解即为根对象，因此返回0 + * + * @return 距离{@link #getRoot()}返回值的水平距离， + */ + @Override + default int getHorizontalDistance() { + return 0; + } + + // ================== synthesize ================== + + /** + * 获取在聚合中存在的指定注解对象 + * + * @param annotationType 注解类型 + * @param 注解类型 + * @return 注解对象 + */ + T getAnnotation(Class annotationType); + + /** + * 获取合成注解属性处理器 + * + * @return 合成注解属性处理器 + */ + SynthesizedAnnotationAttributeProcessor getAnnotationAttributeProcessor(); + + /** + * 获取当前的注解类型 + * + * @return 注解类型 + */ + @Override + default Class annotationType() { + return this.getClass(); + } + + /** + * 从聚合中获取指定类型的属性值 + * + * @param attributeName 属性名称 + * @param attributeType 属性类型 + * @return 属性值 + */ + @Override + Object getAttributeValue(String attributeName, Class attributeType); + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotation.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotation.java new file mode 100644 index 0000000..966c2d3 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotation.java @@ -0,0 +1,96 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; + +import java.lang.annotation.Annotation; +import java.util.Map; +import java.util.function.UnaryOperator; + +/** + *

用于在{@link SynthesizedAggregateAnnotation}中表示一个处于合成状态的注解对象。
+ * 当对多个合成注解排序时，默认使用{@link #DEFAULT_HIERARCHICAL_COMPARATOR}进行排序， + * 从保证合成注解按{@link #getVerticalDistance()}与{@link #getHorizontalDistance()}的返回值保持有序， + * 从而使得距离根元素更接近的注解对象在被处理是具有更高的优先级。 + * + * @author huangchengxing + * @see SynthesizedAggregateAnnotation + */ +public interface SynthesizedAnnotation extends Annotation, Hierarchical, AnnotationAttributeValueProvider { + + /** + * 获取被合成的注解对象 + * + * @return 注解对象 + */ + Annotation getAnnotation(); + + /** + * 获取该合成注解与根对象的垂直距离。 + * 默认情况下，该距离即为当前注解与根对象之间相隔的层级数。 + * + * @return 合成注解与根对象的垂直距离 + */ + @Override + int getVerticalDistance(); + + /** + * 获取该合成注解与根对象的水平距离。 + * 默认情况下，该距离即为当前注解与根对象之间相隔的已经被扫描到的注解数。 + * + * @return 合成注解与根对象的水平距离 + */ + @Override + int getHorizontalDistance(); + + /** + * 注解是否存在该名称相同，且类型一致的属性 + * + * @param attributeName 属性名 + * @param returnType 返回值类型 + * @return 是否存在该属性 + */ + boolean hasAttribute(String attributeName, Class returnType); + + /** + * 获取该注解的全部属性 + * + * @return 注解属性 + */ + Map getAttributes(); + + /** + * 设置该注解的全部属性 + * + * @param attributes 注解属性 + */ + default void setAttributes(Map attributes) { + if (CollUtil.isNotEmpty(attributes)) { + attributes.forEach(this::setAttribute); + } + } + + /** + * 设置属性值 + * + * @param attributeName 属性名称 + * @param attribute 注解属性 + */ + void setAttribute(String attributeName, AnnotationAttribute attribute); + + /** + * 替换属性值 + * + * @param attributeName 属性名 + * @param operator 替换操作 + */ + void replaceAttribute(String attributeName, UnaryOperator operator); + + /** + * 获取属性值 + * + * @param attributeName 属性名 + * @return 属性值 + */ + Object getAttributeValue(String attributeName); + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotationAttributeProcessor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotationAttributeProcessor.java new file mode 100644 index 0000000..20159c8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotationAttributeProcessor.java @@ -0,0 +1,24 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import java.util.Collection; + +/** + * 合成注解属性选择器。用于在{@link SynthesizedAggregateAnnotation}中从指定类型的合成注解里获取到对应的属性值 + * + * @author huangchengxing + */ +@FunctionalInterface +public interface SynthesizedAnnotationAttributeProcessor { + + /** + * 从一批被合成注解中，获取指定名称与类型的属性值 + * + * @param attributeName 属性名称 + * @param attributeType 属性类型 + * @param synthesizedAnnotations 被合成的注解 + * @param 属性类型 + * @return 属性值 + */ + R getAttributeValue(String attributeName, Class attributeType, Collection synthesizedAnnotations); + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotationPostProcessor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotationPostProcessor.java new file mode 100644 index 0000000..8c23600 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotationPostProcessor.java @@ -0,0 +1,71 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.comparator.CompareUtil; + +import java.util.Comparator; + +/** + *

被合成注解后置处理器，用于在{@link SynthesizedAggregateAnnotation}加载完所有待合成注解后， + * 再对加载好的{@link SynthesizedAnnotation}进行后置处理。
+ * 当多个{@link SynthesizedAnnotationPostProcessor}需要一起执行时，将按照{@link #order()}的返回值进行排序， + * 该值更小的处理器将被优先执行。 + * + *

该接口存在多个实现类，调用者应当保证在任何时候，对一批后置处理器的调用顺序都符合： + *

    + *
  • {@link AliasAnnotationPostProcessor}；
    • + *
  • {@link MirrorLinkAnnotationPostProcessor}；
    • + *
  • {@link AliasLinkAnnotationPostProcessor}；
    • + *
  • 其他后置处理器；
    • + *
+ * + * @author huangchengxing + * @see AliasAnnotationPostProcessor + * @see MirrorLinkAnnotationPostProcessor + * @see AliasLinkAnnotationPostProcessor + */ +public interface SynthesizedAnnotationPostProcessor extends Comparable { + + /** + * 属性上带有{@link Alias}的注解对象的后置处理器 + */ + AliasAnnotationPostProcessor ALIAS_ANNOTATION_POST_PROCESSOR = new AliasAnnotationPostProcessor(); + + /** + * 属性上带有{@link Link}，且与其他注解的属性存在镜像关系的注解对象的后置处理器 + */ + MirrorLinkAnnotationPostProcessor MIRROR_LINK_ANNOTATION_POST_PROCESSOR = new MirrorLinkAnnotationPostProcessor(); + + /** + * 属性上带有{@link Link}，且与其他注解的属性存在别名关系的注解对象的后置处理器 + */ + AliasLinkAnnotationPostProcessor ALIAS_LINK_ANNOTATION_POST_PROCESSOR = new AliasLinkAnnotationPostProcessor(); + + /** + * 在一组后置处理器中被调用的顺序，越小越靠前 + * + * @return 排序值 + */ + default int order() { + return Integer.MAX_VALUE; + } + + /** + * 比较两个后置处理器的{@link #order()}返回值 + * + * @param o 比较对象 + * @return 大小 + */ + @Override + default int compareTo(SynthesizedAnnotationPostProcessor o) { + return CompareUtil.compare(this, o, Comparator.comparing(SynthesizedAnnotationPostProcessor::order)); + } + + /** + * 给定指定被合成注解与其所属的合成注解聚合器实例，经过处理后返回最终 + * + * @param synthesizedAnnotation 合成的注解 + * @param synthesizer 注解合成器 + */ + void process(SynthesizedAnnotation synthesizedAnnotation, AnnotationSynthesizer synthesizer); + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotationProxy.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotationProxy.java new file mode 100644 index 0000000..ffd01c2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotationProxy.java @@ -0,0 +1,160 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Opt; +import aiyh.utils.tool.cn.hutool.core.text.CharSequenceUtil; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; + +import java.lang.annotation.Annotation; +import java.lang.reflect.InvocationHandler; +import java.lang.reflect.Method; +import java.lang.reflect.Proxy; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.function.BiFunction; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +/** + * 合成注解代理类，用于为{@link SynthesizedAnnotation}生成对应的合成注解代理对象 + * + * @author huangchengxing + * @see SynthesizedAnnotation + * @see AnnotationAttributeValueProvider + */ +public class SynthesizedAnnotationProxy implements InvocationHandler { + + private final AnnotationAttributeValueProvider annotationAttributeValueProvider; + private final SynthesizedAnnotation annotation; + private final Map> methods; + + /** + * 创建一个代理注解，生成的代理对象将是{@link SyntheticProxyAnnotation}与指定的注解类的子类。 + * + * @param 注解类型 + * @param annotationType 注解类型 + * @param annotationAttributeValueProvider 注解属性值获取器 + * @param annotation 合成注解 + * @return 代理注解 + */ + @SuppressWarnings("unchecked") + public static T create( + Class annotationType, + AnnotationAttributeValueProvider annotationAttributeValueProvider, + SynthesizedAnnotation annotation) { + if (ObjectUtil.isNull(annotation)) { + return null; + } + final SynthesizedAnnotationProxy proxyHandler = new SynthesizedAnnotationProxy(annotationAttributeValueProvider, annotation); + if (ObjectUtil.isNull(annotation)) { + return null; + } + return (T) Proxy.newProxyInstance( + annotationType.getClassLoader(), + new Class[]{annotationType, SyntheticProxyAnnotation.class}, + proxyHandler + ); + } + + /** + * 创建一个代理注解，生成的代理对象将是{@link SyntheticProxyAnnotation}与指定的注解类的子类。 + * + * @param 注解类型 + * @param annotationType 注解类型 + * @param annotation 合成注解 + * @return 代理注解 + */ + public static T create( + Class annotationType, SynthesizedAnnotation annotation) { + return create(annotationType, annotation, annotation); + } + + /** + * 该类是否为通过{@code SynthesizedAnnotationProxy}生成的代理类 + * + * @param annotationType 注解类型 + * @return 是否 + */ + public static boolean isProxyAnnotation(Class annotationType) { + return ClassUtil.isAssignable(SyntheticProxyAnnotation.class, annotationType); + } + + SynthesizedAnnotationProxy(AnnotationAttributeValueProvider annotationAttributeValueProvider, SynthesizedAnnotation annotation) { + Assert.notNull(annotationAttributeValueProvider, "annotationAttributeValueProvider must not null"); + Assert.notNull(annotation, "annotation must not null"); + this.annotationAttributeValueProvider = annotationAttributeValueProvider; + this.annotation = annotation; + this.methods = new HashMap<>(9); + loadMethods(); + } + + @Override + public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { + return Opt.ofNullable(methods.get(method.getName())) + .map(m -> m.apply(method, args)) + .orElseGet(() -> ReflectUtil.invoke(this, method, args)); + } + + // ========================= 代理方法 ========================= + + void loadMethods() { + methods.put("toString", (method, args) -> proxyToString()); + methods.put("hashCode", (method, args) -> proxyHashCode()); + methods.put("getSynthesizedAnnotation", (method, args) -> proxyGetSynthesizedAnnotation()); + methods.put("getRoot", (method, args) -> annotation.getRoot()); + methods.put("getVerticalDistance", (method, args) -> annotation.getVerticalDistance()); + methods.put("getHorizontalDistance", (method, args) -> annotation.getHorizontalDistance()); + methods.put("hasAttribute", (method, args) -> annotation.hasAttribute((String) args[0], (Class) args[1])); + methods.put("getAttributes", (method, args) -> annotation.getAttributes()); + methods.put("setAttribute", (method, args) -> { + throw new UnsupportedOperationException("proxied annotation can not reset attributes"); + }); + methods.put("getAttributeValue", (method, args) -> annotation.getAttributeValue((String) args[0])); + methods.put("annotationType", (method, args) -> annotation.annotationType()); + for (final Method declaredMethod : ClassUtil.getDeclaredMethods(annotation.getAnnotation().annotationType())) { + methods.put(declaredMethod.getName(), (method, args) -> proxyAttributeValue(method)); + } + } + + private String proxyToString() { + final String attributes = Stream.of(ClassUtil.getDeclaredMethods(annotation.getAnnotation().annotationType())) + .filter(AnnotationUtil::isAttributeMethod) + .map(method -> CharSequenceUtil.format( + "{}={}", method.getName(), proxyAttributeValue(method)) + ) + .collect(Collectors.joining(", ")); + return CharSequenceUtil.format("@{}({})", annotation.annotationType().getName(), attributes); + } + + private int proxyHashCode() { + return Objects.hash(annotationAttributeValueProvider, annotation); + } + + private Object proxyGetSynthesizedAnnotation() { + return annotation; + } + + private Object proxyAttributeValue(Method attributeMethod) { + return annotationAttributeValueProvider.getAttributeValue(attributeMethod.getName(), attributeMethod.getReturnType()); + } + + /** + * 通过代理类生成的合成注解 + * + * @author huangchengxing + */ + interface SyntheticProxyAnnotation extends SynthesizedAnnotation { + + /** + * 获取该代理注解对应的已合成注解 + * + * @return 理注解对应的已合成注解 + */ + SynthesizedAnnotation getSynthesizedAnnotation(); + + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotationSelector.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotationSelector.java new file mode 100644 index 0000000..e6f385c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/SynthesizedAnnotationSelector.java @@ -0,0 +1,82 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +/** + * 注解选择器，指定两个注解，选择其中一个返回。
+ * 该接口用于在{@link SynthesizedAggregateAnnotation}中用于从一批相同的注解对象中筛选最终用于合成注解对象。 + * + * @author huangchengxing + */ +@FunctionalInterface +public interface SynthesizedAnnotationSelector { + + /** + * 返回距离根对象更近的注解，当距离一样时优先返回旧注解 + */ + SynthesizedAnnotationSelector NEAREST_AND_OLDEST_PRIORITY = new NearestAndOldestPrioritySelector(); + + /** + * 返回距离根对象更近的注解，当距离一样时优先返回新注解 + */ + SynthesizedAnnotationSelector NEAREST_AND_NEWEST_PRIORITY = new NearestAndNewestPrioritySelector(); + + /** + * 返回距离根对象更远的注解，当距离一样时优先返回旧注解 + */ + SynthesizedAnnotationSelector FARTHEST_AND_OLDEST_PRIORITY = new FarthestAndOldestPrioritySelector(); + + /** + * 返回距离根对象更远的注解，当距离一样时优先返回新注解 + */ + SynthesizedAnnotationSelector FARTHEST_AND_NEWEST_PRIORITY = new FarthestAndNewestPrioritySelector(); + + /** + * 比较两个被合成的注解，选择其中的一个并返回 + * + * @param 复合注解类型 + * @param oldAnnotation 已存在的注解，该参数不允许为空 + * @param newAnnotation 新获取的注解，该参数不允许为空 + * @return 被合成的注解 + */ + T choose(T oldAnnotation, T newAnnotation); + + /** + * 返回距离根对象更近的注解，当距离一样时优先返回旧注解 + */ + class NearestAndOldestPrioritySelector implements SynthesizedAnnotationSelector { + @Override + public T choose(T oldAnnotation, T newAnnotation) { + return Hierarchical.Selector.NEAREST_AND_OLDEST_PRIORITY.choose(oldAnnotation, newAnnotation); + } + } + + /** + * 返回距离根对象更近的注解，当距离一样时优先返回新注解 + */ + class NearestAndNewestPrioritySelector implements SynthesizedAnnotationSelector { + @Override + public T choose(T oldAnnotation, T newAnnotation) { + return Hierarchical.Selector.NEAREST_AND_NEWEST_PRIORITY.choose(oldAnnotation, newAnnotation); + } + } + + /** + * 返回距离根对象更远的注解，当距离一样时优先返回旧注解 + */ + class FarthestAndOldestPrioritySelector implements SynthesizedAnnotationSelector { + @Override + public T choose(T oldAnnotation, T newAnnotation) { + return Hierarchical.Selector.FARTHEST_AND_OLDEST_PRIORITY.choose(oldAnnotation, newAnnotation); + } + } + + /** + * 返回距离根对象更远的注解，当距离一样时优先返回新注解 + */ + class FarthestAndNewestPrioritySelector implements SynthesizedAnnotationSelector { + @Override + public T choose(T oldAnnotation, T newAnnotation) { + return Hierarchical.Selector.FARTHEST_AND_NEWEST_PRIORITY.choose(oldAnnotation, newAnnotation); + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/WrappedAnnotationAttribute.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/WrappedAnnotationAttribute.java new file mode 100644 index 0000000..eb86d8e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/WrappedAnnotationAttribute.java @@ -0,0 +1,125 @@ +package aiyh.utils.tool.cn.hutool.core.annotation; + +import java.lang.annotation.Annotation; +import java.lang.reflect.Method; +import java.util.Collection; + +/** + *

表示一个被包装过的{@link AnnotationAttribute}， + * 该实例中的一些方法可能会被代理到另一个注解属性对象中， + * 从而使得通过原始的注解属性的方法获取到另一注解属性的值。
+ * 除了{@link #getValue()}以外，其他方法的返回值应当尽可能与{@link #getOriginal()} + * 返回的{@link AnnotationAttribute}对象的方法返回值一致。 + * + *

当包装类被包装了多层后，则规则生效优先级按包装的先后顺序倒序排序， + * 比如a、b互为镜像，此时a、b两属性应当都被{@link MirroredAnnotationAttribute}包装， + * 若再指定c为a的别名字段，则c、a、b都要在原基础上再次包装一层{@link AliasedAnnotationAttribute}。
+ * 此时a、b同时被包装了两层，则执行时，优先执行{@link AliasedAnnotationAttribute}的逻辑， + * 当该规则不生效时，比如c只有默认值，此时上一次的{@link MirroredAnnotationAttribute}的逻辑才会生效。 + * + *

被包装的{@link AnnotationAttribute}实际结构为一颗二叉树， + * 当包装类再次被包装时，实际上等于又添加了一个新的根节点， + * 此时需要同时更新树的全部关联叶子节点。 + * + * @author huangchengxing + * @see AnnotationAttribute + * @see ForceAliasedAnnotationAttribute + * @see AliasedAnnotationAttribute + * @see MirroredAnnotationAttribute + */ +public interface WrappedAnnotationAttribute extends AnnotationAttribute { + + // =========================== 新增方法 =========================== + + /** + * 获取被包装的{@link AnnotationAttribute}对象，该对象也可能是{@link AnnotationAttribute} + * + * @return 被包装的{@link AnnotationAttribute}对象 + */ + AnnotationAttribute getOriginal(); + + /** + * 获取最初的被包装的{@link AnnotationAttribute} + * + * @return 最初的被包装的{@link AnnotationAttribute} + */ + AnnotationAttribute getNonWrappedOriginal(); + + /** + * 获取包装{@link #getOriginal()}的{@link AnnotationAttribute}对象，该对象也可能是{@link AnnotationAttribute} + * + * @return 包装对象 + */ + AnnotationAttribute getLinked(); + + /** + * 遍历以当前实例为根节点的树结构，获取所有未被包装的属性 + * + * @return 叶子节点 + */ + Collection getAllLinkedNonWrappedAttributes(); + + // =========================== 代理实现 =========================== + + /** + * 获取注解对象 + * + * @return 注解对象 + */ + @Override + default Annotation getAnnotation() { + return getOriginal().getAnnotation(); + } + + /** + * 获取注解属性对应的方法 + * + * @return 注解属性对应的方法 + */ + @Override + default Method getAttribute() { + return getOriginal().getAttribute(); + } + + /** + * 该注解属性的值是否等于默认值
+ * 默认仅当{@link #getOriginal()}与{@link #getLinked()}返回的注解属性 + * 都为默认值时，才返回{@code true} + * + * @return 该注解属性的值是否等于默认值 + */ + @Override + boolean isValueEquivalentToDefaultValue(); + + /** + * 获取属性类型 + * + * @return 属性类型 + */ + @Override + default Class getAttributeType() { + return getOriginal().getAttributeType(); + } + + /** + * 获取属性上的注解 + * + * @param annotationType 注解类型 + * @return 注解对象 + */ + @Override + default T getAnnotation(Class annotationType) { + return getOriginal().getAnnotation(annotationType); + } + + /** + * 当前注解属性是否已经被{@link WrappedAnnotationAttribute}包装 + * + * @return boolean + */ + @Override + default boolean isWrapped() { + return true; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/package-info.java new file mode 100644 index 0000000..9c674f4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/package-info.java @@ -0,0 +1,7 @@ +/** + * 注解包，提供增强型注解和注解工具类 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.annotation; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/AbstractTypeAnnotationScanner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/AbstractTypeAnnotationScanner.java new file mode 100644 index 0000000..f98b669 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/AbstractTypeAnnotationScanner.java @@ -0,0 +1,288 @@ +package aiyh.utils.tool.cn.hutool.core.annotation.scanner; + +import aiyh.utils.tool.cn.hutool.core.annotation.AnnotationUtil; +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.lang.annotation.Annotation; +import java.lang.reflect.AnnotatedElement; +import java.lang.reflect.Proxy; +import java.util.*; +import java.util.function.BiConsumer; +import java.util.function.Predicate; +import java.util.function.UnaryOperator; + +/** + * 为需要从类的层级结构中获取注解的{@link AnnotationScanner}提供基本实现 + * + * @author huangchengxing + */ +public abstract class AbstractTypeAnnotationScanner> implements AnnotationScanner { + + /** + * 是否允许扫描父类 + */ + private boolean includeSuperClass; + + /** + * 是否允许扫描父接口 + */ + private boolean includeInterfaces; + + /** + * 过滤器，若类型无法通过该过滤器，则该类型及其树结构将直接不被查找 + */ + private Predicate> filter; + + /** + * 排除的类型，以上类型及其树结构将直接不被查找 + */ + private final Set> excludeTypes; + + /** + * 转换器 + */ + private final List>> converters; + + /** + * 是否有转换器 + */ + private boolean hasConverters; + + /** + * 当前实例 + */ + private final T typedThis; + + /** + * 构造一个类注解扫描器 + * + * @param includeSuperClass 是否允许扫描父类 + * @param includeInterfaces 是否允许扫描父接口 + * @param filter 过滤器 + * @param excludeTypes 不包含的类型 + */ + @SuppressWarnings("unchecked") + protected AbstractTypeAnnotationScanner(boolean includeSuperClass, boolean includeInterfaces, Predicate> filter, Set> excludeTypes) { + Assert.notNull(filter, "filter must not null"); + Assert.notNull(excludeTypes, "excludeTypes must not null"); + this.includeSuperClass = includeSuperClass; + this.includeInterfaces = includeInterfaces; + this.filter = filter; + this.excludeTypes = excludeTypes; + this.converters = new ArrayList<>(); + this.typedThis = (T) this; + } + + /** + * 是否允许扫描父类 + * + * @return 是否允许扫描父类 + */ + public boolean isIncludeSuperClass() { + return includeSuperClass; + } + + /** + * 是否允许扫描父接口 + * + * @return 是否允许扫描父接口 + */ + public boolean isIncludeInterfaces() { + return includeInterfaces; + } + + /** + * 设置过滤器，若类型无法通过该过滤器，则该类型及其树结构将直接不被查找 + * + * @param filter 过滤器 + * @return 当前实例 + */ + public T setFilter(Predicate> filter) { + Assert.notNull(filter, "filter must not null"); + this.filter = filter; + return typedThis; + } + + /** + * 添加不扫描的类型，该类型及其树结构将直接不被查找 + * + * @param excludeTypes 不扫描的类型 + * @return 当前实例 + */ + public T addExcludeTypes(Class... excludeTypes) { + CollUtil.addAll(this.excludeTypes, excludeTypes); + return typedThis; + } + + /** + * 添加转换器 + * + * @param converter 转换器 + * @return 当前实例 + * @see JdkProxyClassConverter + */ + public T addConverters(UnaryOperator> converter) { + Assert.notNull(converter, "converter must not null"); + this.converters.add(converter); + if (!this.hasConverters) { + this.hasConverters = CollUtil.isNotEmpty(this.converters); + } + return typedThis; + } + + /** + * 是否允许扫描父类 + * + * @param includeSuperClass 是否 + * @return 当前实例 + */ + protected T setIncludeSuperClass(boolean includeSuperClass) { + this.includeSuperClass = includeSuperClass; + return typedThis; + } + + /** + * 是否允许扫描父接口 + * + * @param includeInterfaces 是否 + * @return 当前实例 + */ + protected T setIncludeInterfaces(boolean includeInterfaces) { + this.includeInterfaces = includeInterfaces; + return typedThis; + } + + /** + * 则根据广度优先递归扫描类的层级结构，并对层级结构中类/接口声明的层级索引和它们声明的注解对象进行处理 + * + * @param consumer 对获取到的注解和注解对应的层级索引的处理 + * @param annotatedEle 注解元素 + * @param filter 注解过滤器，无法通过过滤器的注解不会被处理。该参数允许为空。 + */ + @Override + public void scan(BiConsumer consumer, AnnotatedElement annotatedEle, Predicate filter) { + filter = ObjectUtil.defaultIfNull(filter, a -> annotation -> true); + final Class sourceClass = getClassFormAnnotatedElement(annotatedEle); + final Deque>> classDeque = CollUtil.newLinkedList(CollUtil.newArrayList(sourceClass)); + final Set> accessedTypes = new LinkedHashSet<>(); + int index = 0; + while (!classDeque.isEmpty()) { + final List> currClassQueue = classDeque.removeFirst(); + final List> nextClassQueue = new ArrayList<>(); + for (Class targetClass : currClassQueue) { + targetClass = convert(targetClass); + // 过滤不需要处理的类 + if (isNotNeedProcess(accessedTypes, targetClass)) { + continue; + } + accessedTypes.add(targetClass); + // 扫描父类 + scanSuperClassIfNecessary(nextClassQueue, targetClass); + // 扫描接口 + scanInterfaceIfNecessary(nextClassQueue, targetClass); + // 处理层级索引和注解 + final Annotation[] targetAnnotations = getAnnotationsFromTargetClass(annotatedEle, index, targetClass); + for (final Annotation annotation : targetAnnotations) { + if (AnnotationUtil.isNotJdkMateAnnotation(annotation.annotationType()) && filter.test(annotation)) { + consumer.accept(index, annotation); + } + } + index++; + } + if (CollUtil.isNotEmpty(nextClassQueue)) { + classDeque.addLast(nextClassQueue); + } + } + } + + /** + * 从要搜索的注解元素上获得要递归的类型 + * + * @param annotatedElement 注解元素 + * @return 要递归的类型 + */ + protected abstract Class getClassFormAnnotatedElement(AnnotatedElement annotatedElement); + + /** + * 从类上获取最终所需的目标注解 + * + * @param source 最初的注解元素 + * @param index 类的层级索引 + * @param targetClass 类 + * @return 最终所需的目标注解 + */ + protected abstract Annotation[] getAnnotationsFromTargetClass(AnnotatedElement source, int index, Class targetClass); + + /** + * 当前类是否不需要处理 + * + * @param accessedTypes 访问类型 + * @param targetClass 目标类型 + * @return 是否不需要处理 + */ + protected boolean isNotNeedProcess(Set> accessedTypes, Class targetClass) { + return ObjectUtil.isNull(targetClass) + || accessedTypes.contains(targetClass) + || excludeTypes.contains(targetClass) + || filter.negate().test(targetClass); + } + + /** + * 若{@link #includeInterfaces}为{@code true}，则将目标类的父接口也添加到nextClasses + * + * @param nextClasses 下一个类集合 + * @param targetClass 目标类型 + */ + protected void scanInterfaceIfNecessary(List> nextClasses, Class targetClass) { + if (includeInterfaces) { + final Class[] interfaces = targetClass.getInterfaces(); + if (ArrayUtil.isNotEmpty(interfaces)) { + CollUtil.addAll(nextClasses, interfaces); + } + } + } + + /** + * 若{@link #includeSuperClass}为{@code true}，则将目标类的父类也添加到nextClasses + * + * @param nextClassQueue 下一个类队列 + * @param targetClass 目标类型 + */ + protected void scanSuperClassIfNecessary(List> nextClassQueue, Class targetClass) { + if (includeSuperClass) { + final Class superClass = targetClass.getSuperclass(); + if (!ObjectUtil.equals(superClass, Object.class) && ObjectUtil.isNotNull(superClass)) { + nextClassQueue.add(superClass); + } + } + } + + /** + * 若存在转换器，则使用转换器对目标类进行转换 + * + * @param target 目标类 + * @return 转换后的类 + */ + protected Class convert(Class target) { + if (hasConverters) { + for (final UnaryOperator> converter : converters) { + target = converter.apply(target); + } + } + return target; + } + + /** + * 若类型为jdk代理类，则尝试转换为原始被代理类 + */ + public static class JdkProxyClassConverter implements UnaryOperator> { + @Override + public Class apply(Class sourceClass) { + return Proxy.isProxyClass(sourceClass) ? apply(sourceClass.getSuperclass()) : sourceClass; + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/AnnotationScanner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/AnnotationScanner.java new file mode 100644 index 0000000..d12d731 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/AnnotationScanner.java @@ -0,0 +1,198 @@ +package aiyh.utils.tool.cn.hutool.core.annotation.scanner; + +import aiyh.utils.tool.cn.hutool.core.annotation.AnnotationUtil; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.lang.annotation.Annotation; +import java.lang.annotation.Inherited; +import java.lang.reflect.AnnotatedElement; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.function.BiConsumer; +import java.util.function.Predicate; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +/** + *

注解扫描器，用于从支持的可注解元素上获取所需注解 + * + *

默认提供了以下扫描方式： + *

    + *
  • {@link #NOTHING}：什么都不做，什么注解都不扫描；
    • + *
  • {@link #DIRECTLY}：扫描元素本身直接声明的注解，包括父类带有{@link Inherited}、被传递到元素上的注解；
    • + *
  • + * {@link #DIRECTLY_AND_META_ANNOTATION}：扫描元素本身直接声明的注解，包括父类带有{@link Inherited}、被传递到元素上的注解， + * 以及这些注解的元注解； + *
    • + *
  • {@link #SUPERCLASS}：扫描元素本身以及父类的层级结构中声明的注解；
    • + *
  • {@link #SUPERCLASS_AND_META_ANNOTATION}：扫描元素本身以及父类的层级结构中声明的注解，以及这些注解的元注解；
    • + *
  • {@link #INTERFACE}：扫描元素本身以及父接口的层级结构中声明的注解；
    • + *
  • {@link #INTERFACE_AND_META_ANNOTATION}：扫描元素本身以及父接口的层级结构中声明的注解，以及这些注解的元注解；
    • + *
  • {@link #TYPE_HIERARCHY}：扫描元素本身以及父类、父接口的层级结构中声明的注解；
    • + *
  • {@link #TYPE_HIERARCHY_AND_META_ANNOTATION}：扫描元素本身以及父接口、父接口的层级结构中声明的注解，以及这些注解的元注解；
    • + *
+ * + * @author huangchengxing + * @see TypeAnnotationScanner + * @see MethodAnnotationScanner + * @see FieldAnnotationScanner + * @see MetaAnnotationScanner + * @see ElementAnnotationScanner + * @see GenericAnnotationScanner + */ +public interface AnnotationScanner { + + // ============================ 预置的扫描器实例 ============================ + + /** + * 不扫描任何注解 + */ + AnnotationScanner NOTHING = new EmptyAnnotationScanner(); + + /** + * 扫描元素本身直接声明的注解，包括父类带有{@link Inherited}、被传递到元素上的注解的扫描器 + */ + AnnotationScanner DIRECTLY = new GenericAnnotationScanner(false, false, false); + + /** + * 扫描元素本身直接声明的注解，包括父类带有{@link Inherited}、被传递到元素上的注解，以及这些注解的元注解的扫描器 + */ + AnnotationScanner DIRECTLY_AND_META_ANNOTATION = new GenericAnnotationScanner(true, false, false); + + /** + * 扫描元素本身以及父类的层级结构中声明的注解的扫描器 + */ + AnnotationScanner SUPERCLASS = new GenericAnnotationScanner(false, true, false); + + /** + * 扫描元素本身以及父类的层级结构中声明的注解，以及这些注解的元注解的扫描器 + */ + AnnotationScanner SUPERCLASS_AND_META_ANNOTATION = new GenericAnnotationScanner(true, true, false); + + /** + * 扫描元素本身以及父接口的层级结构中声明的注解的扫描器 + */ + AnnotationScanner INTERFACE = new GenericAnnotationScanner(false, false, true); + + /** + * 扫描元素本身以及父接口的层级结构中声明的注解，以及这些注解的元注解的扫描器 + */ + AnnotationScanner INTERFACE_AND_META_ANNOTATION = new GenericAnnotationScanner(true, false, true); + + /** + * 扫描元素本身以及父类、父接口的层级结构中声明的注解的扫描器 + */ + AnnotationScanner TYPE_HIERARCHY = new GenericAnnotationScanner(false, true, true); + + /** + * 扫描元素本身以及父接口、父接口的层级结构中声明的注解，以及这些注解的元注解的扫描器 + */ + AnnotationScanner TYPE_HIERARCHY_AND_META_ANNOTATION = new GenericAnnotationScanner(true, true, true); + + // ============================ 静态方法 ============================ + + /** + * 给定一组扫描器，使用第一个支持处理该类型元素的扫描器获取元素上可能存在的注解 + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param scanners 注解扫描器 + * @return 注解 + */ + static List scanByAnySupported(AnnotatedElement annotatedEle, AnnotationScanner... scanners) { + if (ObjectUtil.isNull(annotatedEle) && ArrayUtil.isNotEmpty(scanners)) { + return Collections.emptyList(); + } + return Stream.of(scanners) + .filter(scanner -> scanner.support(annotatedEle)) + .findFirst() + .map(scanner -> scanner.getAnnotations(annotatedEle)) + .orElseGet(Collections::emptyList); + } + + /** + * 根据指定的扫描器，扫描元素上可能存在的注解 + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param scanners 注解扫描器 + * @return 注解 + */ + static List scanByAllSupported(AnnotatedElement annotatedEle, AnnotationScanner... scanners) { + if (ObjectUtil.isNull(annotatedEle) && ArrayUtil.isNotEmpty(scanners)) { + return Collections.emptyList(); + } + return Stream.of(scanners) + .map(scanner -> scanner.getAnnotationsIfSupport(annotatedEle)) + .flatMap(Collection::stream) + .collect(Collectors.toList()); + } + + // ============================ 抽象方法 ============================ + + /** + * 判断是否支持扫描该注解元素 + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @return 是否支持扫描该注解元素 + */ + default boolean support(AnnotatedElement annotatedEle) { + return false; + } + + /** + * 获取注解元素上的全部注解。调用该方法前，需要确保调用{@link #support(AnnotatedElement)}返回为true + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @return 注解 + */ + default List getAnnotations(AnnotatedElement annotatedEle) { + final List annotations = new ArrayList<>(); + scan((index, annotation) -> annotations.add(annotation), annotatedEle, null); + return annotations; + } + + /** + * 若{@link #support(AnnotatedElement)}返回{@code true}， + * 则调用并返回{@link #getAnnotations(AnnotatedElement)}结果， + * 否则返回{@link Collections#emptyList()} + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @return 注解 + */ + default List getAnnotationsIfSupport(AnnotatedElement annotatedEle) { + return support(annotatedEle) ? getAnnotations(annotatedEle) : Collections.emptyList(); + } + + /** + * 扫描注解元素的层级结构（若存在），然后对获取到的注解和注解对应的层级索引进行处理。 + * 调用该方法前，需要确保调用{@link #support(AnnotatedElement)}返回为true + * + * @param consumer 对获取到的注解和注解对应的层级索引的处理 + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param filter 注解过滤器，无法通过过滤器的注解不会被处理。该参数允许为空。 + */ + default void scan(BiConsumer consumer, AnnotatedElement annotatedEle, Predicate filter) { + filter = ObjectUtil.defaultIfNull(filter, (a)->annotation -> true); + for (final Annotation annotation : annotatedEle.getAnnotations()) { + if (AnnotationUtil.isNotJdkMateAnnotation(annotation.annotationType()) && filter.test(annotation)) { + consumer.accept(0, annotation); + } + } + } + + /** + * 若{@link #support(AnnotatedElement)}返回{@code true}，则调用{@link #scan(BiConsumer, AnnotatedElement, Predicate)} + * + * @param consumer 对获取到的注解和注解对应的层级索引的处理 + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param filter 注解过滤器，无法通过过滤器的注解不会被处理。该参数允许为空。 + */ + default void scanIfSupport(BiConsumer consumer, AnnotatedElement annotatedEle, Predicate filter) { + if (support(annotatedEle)) { + scan(consumer, annotatedEle, filter); + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/ElementAnnotationScanner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/ElementAnnotationScanner.java new file mode 100644 index 0000000..0ecc7a6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/ElementAnnotationScanner.java @@ -0,0 +1,44 @@ +package aiyh.utils.tool.cn.hutool.core.annotation.scanner; + +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.lang.annotation.Annotation; +import java.lang.reflect.AnnotatedElement; +import java.util.function.BiConsumer; +import java.util.function.Predicate; +import java.util.stream.Stream; + +/** + * 扫描{@link AnnotatedElement}上的注解，不支持处理层级对象 + * + * @author huangchengxing + */ +public class ElementAnnotationScanner implements AnnotationScanner { + + /** + * 判断是否支持扫描该注解元素，仅当注解元素不为空时返回{@code true} + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @return 是否支持扫描该注解元素 + */ + @Override + public boolean support(AnnotatedElement annotatedEle) { + return ObjectUtil.isNotNull(annotatedEle); + } + + /** + * 扫描{@link AnnotatedElement}上直接声明的注解，调用前需要确保调用{@link #support(AnnotatedElement)}返回为true + * + * @param consumer 对获取到的注解和注解对应的层级索引的处理 + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param filter 注解过滤器，无法通过过滤器的注解不会被处理。该参数允许为空。 + */ + @Override + public void scan(BiConsumer consumer, AnnotatedElement annotatedEle, Predicate filter) { + filter = ObjectUtil.defaultIfNull(filter,a-> t -> true); + Stream.of(annotatedEle.getAnnotations()) + .filter(filter) + .forEach(annotation -> consumer.accept(0, annotation)); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/EmptyAnnotationScanner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/EmptyAnnotationScanner.java new file mode 100644 index 0000000..bd44590 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/EmptyAnnotationScanner.java @@ -0,0 +1,31 @@ +package aiyh.utils.tool.cn.hutool.core.annotation.scanner; + +import java.lang.annotation.Annotation; +import java.lang.reflect.AnnotatedElement; +import java.util.Collections; +import java.util.List; +import java.util.function.BiConsumer; +import java.util.function.Predicate; + +/** + * 默认不扫描任何元素的扫描器 + * + * @author huangchengxing + */ +public class EmptyAnnotationScanner implements AnnotationScanner { + + @Override + public boolean support(AnnotatedElement annotatedEle) { + return true; + } + + @Override + public List getAnnotations(AnnotatedElement annotatedEle) { + return Collections.emptyList(); + } + + @Override + public void scan(BiConsumer consumer, AnnotatedElement annotatedEle, Predicate filter) { + // do nothing + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/FieldAnnotationScanner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/FieldAnnotationScanner.java new file mode 100644 index 0000000..ef96a86 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/FieldAnnotationScanner.java @@ -0,0 +1,47 @@ +package aiyh.utils.tool.cn.hutool.core.annotation.scanner; + +import aiyh.utils.tool.cn.hutool.core.annotation.AnnotationUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.lang.annotation.Annotation; +import java.lang.reflect.AnnotatedElement; +import java.lang.reflect.Field; +import java.util.function.BiConsumer; +import java.util.function.Predicate; + +/** + * 扫描{@link Field}上的注解 + * + * @author huangchengxing + */ +public class FieldAnnotationScanner implements AnnotationScanner { + + /** + * 判断是否支持扫描该注解元素，仅当注解元素是{@link Field}时返回{@code true} + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @return 是否支持扫描该注解元素 + */ + @Override + public boolean support(AnnotatedElement annotatedEle) { + return annotatedEle instanceof Field; + } + + /** + * 扫描{@link Field}上直接声明的注解，调用前需要确保调用{@link #support(AnnotatedElement)}返回为true + * + * @param consumer 对获取到的注解和注解对应的层级索引的处理 + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param filter 注解过滤器，无法通过过滤器的注解不会被处理。该参数允许为空。 + */ + @Override + public void scan(BiConsumer consumer, AnnotatedElement annotatedEle, Predicate filter) { + filter = ObjectUtil.defaultIfNull(filter, a -> annotation -> true); + for (final Annotation annotation : annotatedEle.getAnnotations()) { + if (AnnotationUtil.isNotJdkMateAnnotation(annotation.annotationType()) && filter.test(annotation)) { + consumer.accept(0, annotation); + } + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/GenericAnnotationScanner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/GenericAnnotationScanner.java new file mode 100644 index 0000000..dd3ecd4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/GenericAnnotationScanner.java @@ -0,0 +1,149 @@ +package aiyh.utils.tool.cn.hutool.core.annotation.scanner; + +import aiyh.utils.tool.cn.hutool.core.map.multi.ListValueMap; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.lang.annotation.Annotation; +import java.lang.reflect.AnnotatedElement; +import java.lang.reflect.Method; +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.function.BiConsumer; +import java.util.function.Predicate; + +/** + *

通用注解扫描器，支持按不同的层级结构扫描{@link AnnotatedElement}上的注解。 + * + *

当{@link AnnotatedElement}类型不同时，“层级结构”指向的对象将有所区别： + *

    + *
  • + * 当元素为{@link Method}时，此处层级结构指声明方法的类的层级结构， + * 扫描器将从层级结构中寻找与该方法签名相同的方法，并对其进行扫描； + *
    • + *
  • + * 当元素为{@link Class}时，此处层级结构即指类本身与其父类、父接口共同构成的层级结构， + * 扫描器将扫描层级结构中类、接口声明的注解； + *
    • + *
  • 当元素不为{@link Method}或{@link Class}时，则其层级结构仅有其本身一层；
    • + *
+ * 此外，扫描器支持在获取到层级结构中的注解对象后，再对注解对象的元注解进行扫描。 + * + * @author huangchengxing + * @see TypeAnnotationScanner + * @see MethodAnnotationScanner + * @see MetaAnnotationScanner + * @see ElementAnnotationScanner + */ +public class GenericAnnotationScanner implements AnnotationScanner { + + /** + * 类型扫描器 + */ + private final AnnotationScanner typeScanner; + + /** + * 方法扫描器 + */ + private final AnnotationScanner methodScanner; + + /** + * 元注解扫描器 + */ + private final AnnotationScanner metaScanner; + + /** + * 普通元素扫描器 + */ + private final AnnotationScanner elementScanner; + + /** + * 通用注解扫描器支持扫描所有类型的{@link AnnotatedElement} + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @return 是否支持扫描该注解元素 + */ + @Override + public boolean support(AnnotatedElement annotatedEle) { + return true; + } + + /** + * 构造一个通用注解扫描器 + * + * @param enableScanMetaAnnotation 是否扫描注解上的元注解 + * @param enableScanSupperClass 是否扫描父类 + * @param enableScanSupperInterface 是否扫描父接口 + */ + public GenericAnnotationScanner( + boolean enableScanMetaAnnotation, + boolean enableScanSupperClass, + boolean enableScanSupperInterface) { + + this.metaScanner = enableScanMetaAnnotation ? new MetaAnnotationScanner() : new EmptyAnnotationScanner(); + this.typeScanner = new TypeAnnotationScanner( + enableScanSupperClass, enableScanSupperInterface, a -> true, Collections.emptySet() + ); + this.methodScanner = new MethodAnnotationScanner( + enableScanSupperClass, enableScanSupperInterface, a -> true, Collections.emptySet() + ); + this.elementScanner = new ElementAnnotationScanner(); + } + + /** + * 扫描注解元素的层级结构（若存在），然后对获取到的注解和注解对应的层级索引进行处理 + * + * @param consumer 对获取到的注解和注解对应的层级索引的处理 + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param filter 注解过滤器，无法通过过滤器的注解不会被处理。该参数允许为空。 + */ + @Override + public void scan(BiConsumer consumer, AnnotatedElement annotatedEle, Predicate filter) { + filter = ObjectUtil.defaultIfNull(filter, a -> t -> true); + if (ObjectUtil.isNull(annotatedEle)) { + return; + } + // 注解元素是类 + if (annotatedEle instanceof Class) { + scanElements(typeScanner, consumer, annotatedEle, filter); + } + // 注解元素是方法 + else if (annotatedEle instanceof Method) { + scanElements(methodScanner, consumer, annotatedEle, filter); + } + // 注解元素是其他类型 + else { + scanElements(elementScanner, consumer, annotatedEle, filter); + } + } + + /** + * 扫描注解类的层级结构（若存在），然后对获取到的注解和注解对应的层级索引进行处理 + * + * @param scanner 使用的扫描器 + * @param consumer 对获取到的注解和注解对应的层级索引的处理 + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param filter 注解过滤器，无法通过过滤器的注解不会被处理。该参数允许为空。 + */ + private void scanElements( + AnnotationScanner scanner, + BiConsumer consumer, + AnnotatedElement annotatedEle, + Predicate filter) { + // 扫描类上注解 + final ListValueMap classAnnotations = new ListValueMap<>(new LinkedHashMap<>()); + scanner.scan((index, annotation) -> { + if (filter.test(annotation)) { + classAnnotations.putValue(index, annotation); + } + }, annotatedEle, filter); + + // 扫描元注解 + classAnnotations.forEach((index, annotations) -> + annotations.forEach(annotation -> { + consumer.accept(index, annotation); + metaScanner.scan(consumer, annotation.annotationType(), filter); + }) + ); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/MetaAnnotationScanner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/MetaAnnotationScanner.java new file mode 100644 index 0000000..29271ba --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/MetaAnnotationScanner.java @@ -0,0 +1,110 @@ +package aiyh.utils.tool.cn.hutool.core.annotation.scanner; + +import aiyh.utils.tool.cn.hutool.core.annotation.AnnotationUtil; +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.lang.annotation.Annotation; +import java.lang.reflect.AnnotatedElement; +import java.util.*; +import java.util.function.BiConsumer; +import java.util.function.Predicate; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +/** + * 扫描注解类上存在的注解，支持处理枚举实例或枚举类型 + * 需要注意，当待解析是枚举类时，有可能与{@link TypeAnnotationScanner}冲突 + * + * @author huangchengxing + * @see TypeAnnotationScanner + */ +public class MetaAnnotationScanner implements AnnotationScanner { + + /** + * 获取当前注解的元注解后，是否继续递归扫描的元注解的元注解 + */ + private final boolean includeSupperMetaAnnotation; + + /** + * 构造一个元注解扫描器 + * + * @param includeSupperMetaAnnotation 获取当前注解的元注解后，是否继续递归扫描的元注解的元注解 + */ + public MetaAnnotationScanner(boolean includeSupperMetaAnnotation) { + this.includeSupperMetaAnnotation = includeSupperMetaAnnotation; + } + + /** + * 构造一个元注解扫描器，默认在扫描当前注解上的元注解后，并继续递归扫描元注解 + */ + public MetaAnnotationScanner() { + this(true); + } + + /** + * 判断是否支持扫描该注解元素，仅当注解元素是{@link Annotation}接口的子类{@link Class}时返回{@code true} + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @return 是否支持扫描该注解元素 + */ + @Override + public boolean support(AnnotatedElement annotatedEle) { + return (annotatedEle instanceof Class && ClassUtil.isAssignable(Annotation.class, (Class) annotatedEle)); + } + + /** + * 获取注解元素上的全部注解。调用该方法前，需要确保调用{@link #support(AnnotatedElement)}返回为true + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @return 注解 + */ + @Override + public List getAnnotations(AnnotatedElement annotatedEle) { + final List annotations = new ArrayList<>(); + scan( + (index, annotation) -> annotations.add(annotation), annotatedEle, + annotation -> ObjectUtil.notEqual(annotation, annotatedEle) + ); + return annotations; + } + + /** + * 按广度优先扫描指定注解上的元注解，对扫描到的注解与层级索引进行操作 + * + * @param consumer 当前层级索引与操作 + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @param filter 过滤器 + */ + @SuppressWarnings("unchecked") + @Override + public void scan(BiConsumer consumer, AnnotatedElement annotatedEle, Predicate filter) { + filter = ObjectUtil.defaultIfNull(filter, a -> t -> true); + Set> accessed = new HashSet<>(); + final Deque>> deque = CollUtil.newLinkedList(CollUtil.newArrayList((Class) annotatedEle)); + int distance = 0; + do { + final List> annotationTypes = deque.removeFirst(); + for (final Class type : annotationTypes) { + final List metaAnnotations = Stream.of(type.getAnnotations()) + .filter(a -> !AnnotationUtil.isJdkMetaAnnotation(a.annotationType())) + .filter(filter) + .collect(Collectors.toList()); + for (final Annotation metaAnnotation : metaAnnotations) { + consumer.accept(distance, metaAnnotation); + } + accessed.add(type); + List> next = metaAnnotations.stream() + .map(Annotation::annotationType) + .filter(t -> !accessed.contains(t)) + .collect(Collectors.toList()); + if (CollUtil.isNotEmpty(next)) { + deque.addLast(next); + } + } + distance++; + } while (includeSupperMetaAnnotation && !deque.isEmpty()); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/MethodAnnotationScanner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/MethodAnnotationScanner.java new file mode 100644 index 0000000..d248f4d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/MethodAnnotationScanner.java @@ -0,0 +1,133 @@ +package aiyh.utils.tool.cn.hutool.core.annotation.scanner; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.lang.annotation.Annotation; +import java.lang.reflect.AnnotatedElement; +import java.lang.reflect.Method; +import java.util.Set; +import java.util.function.Predicate; +import java.util.stream.Stream; + +/** + * 扫描{@link Method}上的注解 + * + * @author huangchengxing + */ +public class MethodAnnotationScanner extends AbstractTypeAnnotationScanner implements AnnotationScanner { + + /** + * 构造一个类注解扫描器，仅扫描该方法上直接声明的注解 + */ + public MethodAnnotationScanner() { + this(false); + } + + /** + * 构造一个类注解扫描器 + * + * @param scanSameSignatureMethod 是否扫描类层级结构中具有相同方法签名的方法 + */ + public MethodAnnotationScanner(boolean scanSameSignatureMethod) { + this(scanSameSignatureMethod, targetClass -> true, CollUtil.newLinkedHashSet()); + } + + /** + * 构造一个方法注解扫描器 + * + * @param scanSameSignatureMethod 是否扫描类层级结构中具有相同方法签名的方法 + * @param filter 过滤器 + * @param excludeTypes 不包含的类型 + */ + public MethodAnnotationScanner(boolean scanSameSignatureMethod, Predicate> filter, Set> excludeTypes) { + super(scanSameSignatureMethod, scanSameSignatureMethod, filter, excludeTypes); + } + + /** + * 构造一个方法注解扫描器 + * + * @param includeSuperClass 是否允许扫描父类中具有相同方法签名的方法 + * @param includeInterfaces 是否允许扫描父接口中具有相同方法签名的方法 + * @param filter 过滤器 + * @param excludeTypes 不包含的类型 + */ + public MethodAnnotationScanner(boolean includeSuperClass, boolean includeInterfaces, Predicate> filter, Set> excludeTypes) { + super(includeSuperClass, includeInterfaces, filter, excludeTypes); + } + + /** + * 判断是否支持扫描该注解元素，仅当注解元素是{@link Method}时返回{@code true} + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @return boolean 是否支持扫描该注解元素 + */ + @Override + public boolean support(AnnotatedElement annotatedEle) { + return annotatedEle instanceof Method; + } + + /** + * 获取声明该方法的类 + * + * @param annotatedElement 注解元素 + * @return 要递归的类型 + * @see Method#getDeclaringClass() + */ + @Override + protected Class getClassFormAnnotatedElement(AnnotatedElement annotatedElement) { + return ((Method)annotatedElement).getDeclaringClass(); + } + + /** + * 若父类/父接口中方法具有相同的方法签名，则返回该方法上的注解 + * + * @param source 原始方法 + * @param index 类的层级索引 + * @param targetClass 类 + * @return 最终所需的目标注解 + */ + @Override + protected Annotation[] getAnnotationsFromTargetClass(AnnotatedElement source, int index, Class targetClass) { + final Method sourceMethod = (Method) source; + return Stream.of(ClassUtil.getDeclaredMethods(targetClass)) + .filter(superMethod -> !superMethod.isBridge()) + .filter(superMethod -> hasSameSignature(sourceMethod, superMethod)) + .map(AnnotatedElement::getAnnotations) + .flatMap(Stream::of) + .toArray(Annotation[]::new); + } + + /** + * 设置是否扫描类层级结构中具有相同方法签名的方法 + * + * @param scanSuperMethodIfOverride 是否扫描类层级结构中具有相同方法签名的方法 + * @return 当前实例 + */ + public MethodAnnotationScanner setScanSameSignatureMethod(boolean scanSuperMethodIfOverride) { + setIncludeInterfaces(scanSuperMethodIfOverride); + setIncludeSuperClass(scanSuperMethodIfOverride); + return this; + } + + /** + * 该方法是否具备与扫描的方法相同的方法签名 + */ + private boolean hasSameSignature(Method sourceMethod, Method superMethod) { + if (false == StrUtil.equals(sourceMethod.getName(), superMethod.getName())) { + return false; + } + final Class[] sourceParameterTypes = sourceMethod.getParameterTypes(); + final Class[] targetParameterTypes = superMethod.getParameterTypes(); + if (sourceParameterTypes.length != targetParameterTypes.length) { + return false; + } + if (!ArrayUtil.containsAll(sourceParameterTypes, targetParameterTypes)) { + return false; + } + return ClassUtil.isAssignable(superMethod.getReturnType(), sourceMethod.getReturnType()); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/TypeAnnotationScanner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/TypeAnnotationScanner.java new file mode 100644 index 0000000..4f637ed --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/TypeAnnotationScanner.java @@ -0,0 +1,105 @@ +package aiyh.utils.tool.cn.hutool.core.annotation.scanner; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; + +import java.lang.annotation.Annotation; +import java.lang.reflect.AnnotatedElement; +import java.lang.reflect.Proxy; +import java.util.Set; +import java.util.function.Predicate; +import java.util.function.UnaryOperator; + +/** + * 扫描{@link Class}上的注解 + * + * @author huangchengxing + */ +public class TypeAnnotationScanner extends AbstractTypeAnnotationScanner implements AnnotationScanner { + + /** + * 构造一个类注解扫描器 + * + * @param includeSupperClass 是否允许扫描父类 + * @param includeInterfaces 是否允许扫描父接口 + * @param filter 过滤器 + * @param excludeTypes 不包含的类型 + */ + public TypeAnnotationScanner(boolean includeSupperClass, boolean includeInterfaces, Predicate> filter, Set> excludeTypes) { + super(includeSupperClass, includeInterfaces, filter, excludeTypes); + } + + /** + * 构建一个类注解扫描器，默认允许扫描指定元素的父类以及父接口 + */ + public TypeAnnotationScanner() { + this(true, true, t -> true, CollUtil.newLinkedHashSet()); + } + + /** + * 判断是否支持扫描该注解元素，仅当注解元素是{@link Class}接时返回{@code true} + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @return 是否支持扫描该注解元素 + */ + @Override + public boolean support(AnnotatedElement annotatedEle) { + return annotatedEle instanceof Class; + } + + /** + * 将注解元素转为{@link Class} + * + * @param annotatedEle {@link AnnotatedElement}，可以是Class、Method、Field、Constructor、ReflectPermission + * @return 要递归的类型 + */ + @Override + protected Class getClassFormAnnotatedElement(AnnotatedElement annotatedEle) { + return (Class)annotatedEle; + } + + /** + * 获取{@link Class#getAnnotations()} + * + * @param source 最初的注解元素 + * @param index 类的层级索引 + * @param targetClass 类 + * @return 类上直接声明的注解 + */ + @Override + protected Annotation[] getAnnotationsFromTargetClass(AnnotatedElement source, int index, Class targetClass) { + return targetClass.getAnnotations(); + } + + /** + * 是否允许扫描父类 + * + * @param includeSuperClass 是否允许扫描父类 + * @return 当前实例 + */ + @Override + public TypeAnnotationScanner setIncludeSuperClass(boolean includeSuperClass) { + return super.setIncludeSuperClass(includeSuperClass); + } + + /** + * 是否允许扫描父接口 + * + * @param includeInterfaces 是否允许扫描父类 + * @return 当前实例 + */ + @Override + public TypeAnnotationScanner setIncludeInterfaces(boolean includeInterfaces) { + return super.setIncludeInterfaces(includeInterfaces); + } + + /** + * 若类型为jdk代理类，则尝试转换为原始被代理类 + */ + public static class JdkProxyClassConverter implements UnaryOperator> { + @Override + public Class apply(Class sourceClass) { + return Proxy.isProxyClass(sourceClass) ? apply(sourceClass.getSuperclass()) : sourceClass; + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/package-info.java new file mode 100644 index 0000000..d1a3798 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/annotation/scanner/package-info.java @@ -0,0 +1,7 @@ +/** + * 注解包扫描封装 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.annotation.scanner; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanDesc.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanDesc.java new file mode 100644 index 0000000..47be18a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanDesc.java @@ -0,0 +1,324 @@ +package aiyh.utils.tool.cn.hutool.core.bean; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.map.CaseInsensitiveMap; +import aiyh.utils.tool.cn.hutool.core.util.BooleanUtil; +import aiyh.utils.tool.cn.hutool.core.util.ModifierUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.lang.reflect.Field; +import java.lang.reflect.Method; +import java.util.Collection; +import java.util.LinkedHashMap; +import java.util.Map; + +/** + * Bean信息描述做为BeanInfo替代方案，此对象持有JavaBean中的setters和getters等相关信息描述
+ * 查找Getter和Setter方法时会： + * + * 
+ * 1. 忽略字段和方法名的大小写
+ * 2. Getter查找getXXX、isXXX、getIsXXX
+ * 3. Setter查找setXXX、setIsXXX
+ * 4. Setter忽略参数值与字段值不匹配的情况，因此有多个参数类型的重载时，会调用首次匹配的
+ *
+ * + * @author looly + * @since 3.1.2 + */ +public class BeanDesc implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * Bean类 + */ + private final Class beanClass; + /** + * 属性Map + */ + private final Map propMap = new LinkedHashMap<>(); + + /** + * 构造 + * + * @param beanClass Bean类 + */ + public BeanDesc(Class beanClass) { + Assert.notNull(beanClass); + this.beanClass = beanClass; + init(); + } + + /** + * 获取Bean的全类名 + * + * @return Bean的类名 + */ + public String getName() { + return this.beanClass.getName(); + } + + /** + * 获取Bean的简单类名 + * + * @return Bean的类名 + */ + public String getSimpleName() { + return this.beanClass.getSimpleName(); + } + + /** + * 获取字段名-字段属性Map + * + * @param ignoreCase 是否忽略大小写，true为忽略，false不忽略 + * @return 字段名-字段属性Map + */ + public Map getPropMap(boolean ignoreCase) { + return ignoreCase ? new CaseInsensitiveMap<>(1, this.propMap) : this.propMap; + } + + /** + * 获取字段属性列表 + * + * @return {@link PropDesc} 列表 + */ + public Collection getProps() { + return this.propMap.values(); + } + + /** + * 获取属性，如果不存在返回null + * + * @param fieldName 字段名 + * @return {@link PropDesc} + */ + public PropDesc getProp(String fieldName) { + return this.propMap.get(fieldName); + } + + /** + * 获得字段名对应的字段对象，如果不存在返回null + * + * @param fieldName 字段名 + * @return 字段值 + */ + public Field getField(String fieldName) { + final PropDesc desc = this.propMap.get(fieldName); + return null == desc ? null : desc.getField(); + } + + /** + * 获取Getter方法，如果不存在返回null + * + * @param fieldName 字段名 + * @return Getter方法 + */ + public Method getGetter(String fieldName) { + final PropDesc desc = this.propMap.get(fieldName); + return null == desc ? null : desc.getGetter(); + } + + /** + * 获取Setter方法，如果不存在返回null + * + * @param fieldName 字段名 + * @return Setter方法 + */ + public Method getSetter(String fieldName) { + final PropDesc desc = this.propMap.get(fieldName); + return null == desc ? null : desc.getSetter(); + } + + // ------------------------------------------------------------------------------------------------------ Private method start + + /** + * 初始化
+ * 只有与属性关联的相关Getter和Setter方法才会被读取，无关的getXXX和setXXX都被忽略 + * + * @return this + */ + private BeanDesc init() { + final Method[] gettersAndSetters = ReflectUtil.getMethods(this.beanClass, ReflectUtil::isGetterOrSetterIgnoreCase); + PropDesc prop; + for (Field field : ReflectUtil.getFields(this.beanClass)) { + // 排除静态属性和对象子类 + if (false == ModifierUtil.isStatic(field) && false == ReflectUtil.isOuterClassField(field)) { + prop = createProp(field, gettersAndSetters); + // 只有不存在时才放入，防止父类属性覆盖子类属性 + this.propMap.putIfAbsent(prop.getFieldName(), prop); + } + } + return this; + } + + /** + * 根据字段创建属性描述
+ * 查找Getter和Setter方法时会： + * + * 
+	 * 1. 忽略字段和方法名的大小写
+	 * 2. Getter查找getXXX、isXXX、getIsXXX
+	 * 3. Setter查找setXXX、setIsXXX
+	 * 4. Setter忽略参数值与字段值不匹配的情况，因此有多个参数类型的重载时，会调用首次匹配的
+	 *
+ * + * @param field 字段 + * @param methods 类中所有的方法 + * @return {@link PropDesc} + * @since 4.0.2 + */ + private PropDesc createProp(Field field, Method[] methods) { + final PropDesc prop = findProp(field, methods, false); + // 忽略大小写重新匹配一次 + if (null == prop.getter || null == prop.setter) { + final PropDesc propIgnoreCase = findProp(field, methods, true); + if (null == prop.getter) { + prop.getter = propIgnoreCase.getter; + } + if (null == prop.setter) { + prop.setter = propIgnoreCase.setter; + } + } + + return prop; + } + + /** + * 查找字段对应的Getter和Setter方法 + * + * @param field 字段 + * @param gettersOrSetters 类中所有的Getter或Setter方法 + * @param ignoreCase 是否忽略大小写匹配 + * @return PropDesc + */ + private PropDesc findProp(Field field, Method[] gettersOrSetters, boolean ignoreCase) { + final String fieldName = field.getName(); + final Class fieldType = field.getType(); + final boolean isBooleanField = BooleanUtil.isBoolean(fieldType); + + Method getter = null; + Method setter = null; + String methodName; + for (Method method : gettersOrSetters) { + methodName = method.getName(); + if (method.getParameterCount() == 0) { + // 无参数，可能为Getter方法 + if (isMatchGetter(methodName, fieldName, isBooleanField, ignoreCase)) { + // 方法名与字段名匹配，则为Getter方法 + getter = method; + } + } else if (isMatchSetter(methodName, fieldName, isBooleanField, ignoreCase)) { + // setter方法的参数类型和字段类型必须一致，或参数类型是字段类型的子类 + if(fieldType.isAssignableFrom(method.getParameterTypes()[0])){ + setter = method; + } + } + if (null != getter && null != setter) { + // 如果Getter和Setter方法都找到了，不再继续寻找 + break; + } + } + + return new PropDesc(field, getter, setter); + } + + /** + * 方法是否为Getter方法
+ * 匹配规则如下（忽略大小写）： + * + * 
+	 * 字段名    -》 方法名
+	 * isName  -》 isName
+	 * isName  -》 isIsName
+	 * isName  -》 getIsName
+	 * name     -》 isName
+	 * name     -》 getName
+	 *
+ * + * @param methodName 方法名 + * @param fieldName 字段名 + * @param isBooleanField 是否为Boolean类型字段 + * @param ignoreCase 匹配是否忽略大小写 + * @return 是否匹配 + */ + private boolean isMatchGetter(String methodName, String fieldName, boolean isBooleanField, boolean ignoreCase) { + final String handledFieldName; + if (ignoreCase) { + // 全部转为小写，忽略大小写比较 + methodName = methodName.toLowerCase(); + handledFieldName = fieldName.toLowerCase(); + fieldName = handledFieldName; + } else { + handledFieldName = StrUtil.upperFirst(fieldName); + } + + // 针对Boolean类型特殊检查 + if (isBooleanField) { + if (fieldName.startsWith("is")) { + // 字段已经是is开头 + if (methodName.equals(fieldName) // isName -》 isName + || ("get" + handledFieldName).equals(methodName)// isName -》 getIsName + || ("is" + handledFieldName).equals(methodName)// isName -》 isIsName + ) { + return true; + } + } else if (("is" + handledFieldName).equals(methodName)) { + // 字段非is开头， name -》 isName + return true; + } + } + + // 包括boolean的任何类型只有一种匹配情况：name -》 getName + return ("get" + handledFieldName).equals(methodName); + } + + /** + * 方法是否为Setter方法
+ * 匹配规则如下（忽略大小写）： + * + * 
+	 * 字段名    -》 方法名
+	 * isName  -》 setName
+	 * isName  -》 setIsName
+	 * name     -》 setName
+	 *
+ * + * @param methodName 方法名 + * @param fieldName 字段名 + * @param isBooleanField 是否为Boolean类型字段 + * @param ignoreCase 匹配是否忽略大小写 + * @return 是否匹配 + */ + private boolean isMatchSetter(String methodName, String fieldName, boolean isBooleanField, boolean ignoreCase) { + final String handledFieldName; + if (ignoreCase) { + // 全部转为小写，忽略大小写比较 + methodName = methodName.toLowerCase(); + handledFieldName = fieldName.toLowerCase(); + fieldName = handledFieldName; + } else { + handledFieldName = StrUtil.upperFirst(fieldName); + } + + // 非标准Setter方法跳过 + if (false == methodName.startsWith("set")) { + return false; + } + + // 针对Boolean类型特殊检查 + if (isBooleanField && fieldName.startsWith("is")) { + // 字段是is开头 + if (("set" + StrUtil.removePrefix(fieldName, "is")).equals(methodName)// isName -》 setName + || ("set" + handledFieldName).equals(methodName)// isName -》 setIsName + ) { + return true; + } + } + + // 包括boolean的任何类型只有一种匹配情况：name -》 setName + return ("set" + handledFieldName).equals(methodName); + } + // ------------------------------------------------------------------------------------------------------ Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanDescCache.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanDescCache.java new file mode 100755 index 0000000..72870a5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanDescCache.java @@ -0,0 +1,37 @@ +package aiyh.utils.tool.cn.hutool.core.bean; + +import aiyh.utils.tool.cn.hutool.core.lang.func.Func0; +import aiyh.utils.tool.cn.hutool.core.map.WeakConcurrentMap; + +/** + * Bean属性缓存
+ * 缓存用于防止多次反射造成的性能问题 + * + * @author Looly + */ +public enum BeanDescCache { + INSTANCE; + + private final WeakConcurrentMap, BeanDesc> bdCache = new WeakConcurrentMap<>(); + + /** + * 获得属性名和{@link BeanDesc}Map映射 + * + * @param beanClass Bean的类 + * @param supplier 对象不存在时创建对象的函数 + * @return 属性名和{@link BeanDesc}映射 + * @since 5.4.2 + */ + public BeanDesc getBeanDesc(Class beanClass, Func0 supplier) { + return bdCache.computeIfAbsent(beanClass, (key)->supplier.callWithRuntimeException()); + } + + /** + * 清空全局的Bean属性缓存 + * + * @since 5.7.21 + */ + public void clear() { + this.bdCache.clear(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanException.java new file mode 100644 index 0000000..871d68d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanException.java @@ -0,0 +1,32 @@ +package aiyh.utils.tool.cn.hutool.core.bean; + +import aiyh.utils.tool.cn.hutool.core.exceptions.ExceptionUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * Bean异常 + * @author xiaoleilu + */ +public class BeanException extends RuntimeException{ + private static final long serialVersionUID = -8096998667745023423L; + + public BeanException(Throwable e) { + super(ExceptionUtil.getMessage(e), e); + } + + public BeanException(String message) { + super(message); + } + + public BeanException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public BeanException(String message, Throwable throwable) { + super(message, throwable); + } + + public BeanException(Throwable throwable, String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params), throwable); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanInfoCache.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanInfoCache.java new file mode 100755 index 0000000..79f0cd7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanInfoCache.java @@ -0,0 +1,80 @@ +package aiyh.utils.tool.cn.hutool.core.bean; + +import aiyh.utils.tool.cn.hutool.core.lang.func.Func0; +import aiyh.utils.tool.cn.hutool.core.map.ReferenceConcurrentMap; +import aiyh.utils.tool.cn.hutool.core.map.WeakConcurrentMap; + +import java.beans.PropertyDescriptor; +import java.util.Map; + +/** + * Bean属性缓存
+ * 缓存用于防止多次反射造成的性能问题 + * + * @author Looly + */ +public enum BeanInfoCache { + INSTANCE; + + private final WeakConcurrentMap, Map> pdCache = new WeakConcurrentMap<>(); + private final WeakConcurrentMap, Map> ignoreCasePdCache = new WeakConcurrentMap<>(); + + /** + * 获得属性名和{@link PropertyDescriptor}Map映射 + * + * @param beanClass Bean的类 + * @param ignoreCase 是否忽略大小写 + * @return 属性名和{@link PropertyDescriptor}Map映射 + */ + public Map getPropertyDescriptorMap(Class beanClass, boolean ignoreCase) { + return getCache(ignoreCase).get(beanClass); + } + + /** + * 获得属性名和{@link PropertyDescriptor}Map映射 + * + * @param beanClass Bean的类 + * @param ignoreCase 是否忽略大小写 + * @param supplier 缓存对象产生函数 + * @return 属性名和{@link PropertyDescriptor}Map映射 + * @since 5.4.1 + */ + public Map getPropertyDescriptorMap( + Class beanClass, + boolean ignoreCase, + Func0> supplier) { + return getCache(ignoreCase).computeIfAbsent(beanClass, (key)->supplier.callWithRuntimeException()); + } + + /** + * 加入缓存 + * + * @param beanClass Bean的类 + * @param fieldNamePropertyDescriptorMap 属性名和{@link PropertyDescriptor}Map映射 + * @param ignoreCase 是否忽略大小写 + */ + public void putPropertyDescriptorMap(Class beanClass, Map fieldNamePropertyDescriptorMap, boolean ignoreCase) { + getCache(ignoreCase).put(beanClass, fieldNamePropertyDescriptorMap); + } + + /** + * 清空缓存 + * + * @since 5.7.21 + */ + public void clear() { + this.pdCache.clear(); + this.ignoreCasePdCache.clear(); + } + + /** + * 根据是否忽略字段名的大小写，返回不用Cache对象 + * + * @param ignoreCase 是否忽略大小写 + * @return {@link ReferenceConcurrentMap} + * @since 5.4.1 + */ + private ReferenceConcurrentMap, Map> getCache(boolean ignoreCase) { + return ignoreCase ? ignoreCasePdCache : pdCache; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanPath.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanPath.java new file mode 100644 index 0000000..8a3cb64 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanPath.java @@ -0,0 +1,324 @@ +package aiyh.utils.tool.cn.hutool.core.bean; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.collection.ListUtil; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * Bean路径表达式，用于获取多层嵌套Bean中的字段值或Bean对象
+ * 根据给定的表达式，查找Bean中对应的属性值对象。 表达式分为两种： + *
    + *
  1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. + *
  2. []表达式，可以获取集合等对象中对应index的值
    3. + *
+ *

+ * 表达式栗子： + * + * 

+ * persion
+ * persion.name
+ * persons[3]
+ * person.friends[5].name
+ * ['person']['friends'][5]['name']
+ *
+ * + * @author Looly + * @since 4.0.6 + */ +public class BeanPath implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * 表达式边界符号数组 + */ + private static final char[] EXP_CHARS = {CharUtil.DOT, CharUtil.BRACKET_START, CharUtil.BRACKET_END}; + + private boolean isStartWith = false; + protected List patternParts; + + /** + * 解析Bean路径表达式为Bean模式
+ * Bean表达式，用于获取多层嵌套Bean中的字段值或Bean对象
+ * 根据给定的表达式，查找Bean中对应的属性值对象。 表达式分为两种： + *
    + *
  1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. + *
  2. []表达式，可以获取集合等对象中对应index的值
    3. + *
+ *

+ * 表达式栗子： + * + * 

+	 * persion
+	 * persion.name
+	 * persons[3]
+	 * person.friends[5].name
+	 * ['person']['friends'][5]['name']
+	 *
+ * + * @param expression 表达式 + * @return BeanPath + */ + public static BeanPath create(final String expression) { + return new BeanPath(expression); + } + + /** + * 构造 + * + * @param expression 表达式 + */ + public BeanPath(final String expression) { + init(expression); + } + + /** + * 获取表达式解析后的分段列表 + * + * @return 表达式分段列表 + */ + public List getPatternParts() { + return this.patternParts; + } + + /** + * 获取Bean中对应表达式的值 + * + * @param bean Bean对象或Map或List等 + * @return 值，如果对应值不存在，则返回null + */ + public Object get(final Object bean) { + return get(this.patternParts, bean, false); + } + + /** + * 设置表达式指定位置（或filed对应）的值
+ * 若表达式指向一个List则设置其坐标对应位置的值，若指向Map则put对应key的值，Bean则设置字段的值
+ * 注意： + * + * 
+	 * 1. 如果为List，如果下标不大于List长度，则替换原有值，否则追加值
+	 * 2. 如果为数组，如果下标不大于数组长度，则替换原有值，否则追加值
+	 *
+ * + * @param bean Bean、Map或List + * @param value 值 + */ + public void set(final Object bean, final Object value) { + set(bean, this.patternParts, lastIsNumber(this.patternParts), value); + } + + @Override + public String toString() { + return this.patternParts.toString(); + } + + //region Private Methods + + /** + * 设置表达式指定位置（或filed对应）的值
+ * 若表达式指向一个List则设置其坐标对应位置的值，若指向Map则put对应key的值，Bean则设置字段的值
+ * 注意： + * + * 
+	 * 1. 如果为List，如果下标不大于List长度，则替换原有值，否则追加值
+	 * 2. 如果为数组，如果下标不大于数组长度，则替换原有值，否则追加值
+	 *
+ * + * @param bean Bean、Map或List + * @param patternParts 表达式块列表 + * @param value 值 + * @return 值 + */ + private void set(Object bean, List patternParts, boolean nextNumberPart, Object value) { + Object subBean = this.get(patternParts, bean, true); + if (null == subBean) { + final List parentParts = getParentParts(patternParts); + this.set(bean, parentParts, lastIsNumber(parentParts), nextNumberPart ? new ArrayList<>() : new HashMap<>()); + //set中有可能做过转换，因此此处重新获取bean + subBean = this.get(patternParts, bean, true); + } + BeanUtil.setFieldValue(subBean, patternParts.get(patternParts.size() - 1), value); + } + + /** + * 判断path列表中末尾的标记是否为数字 + * + * @param patternParts path列表 + * @return 是否为数字 + */ + private static boolean lastIsNumber(List patternParts) { + return NumberUtil.isInteger(patternParts.get(patternParts.size() - 1)); + } + + /** + * 获取父级路径列表 + * + * @param patternParts 路径列表 + * @return 父级路径列表 + */ + private static List getParentParts(List patternParts) { + return patternParts.subList(0, patternParts.size() - 1); + } + + /** + * 获取Bean中对应表达式的值 + * + * @param patternParts 表达式分段列表 + * @param bean Bean对象或Map或List等 + * @param ignoreLast 是否忽略最后一个值，忽略最后一个值则用于set，否则用于read + * @return 值，如果对应值不存在，则返回null + */ + private Object get(final List patternParts, final Object bean, final boolean ignoreLast) { + int length = patternParts.size(); + if (ignoreLast) { + length--; + } + Object subBean = bean; + boolean isFirst = true; + String patternPart; + for (int i = 0; i < length; i++) { + patternPart = patternParts.get(i); + subBean = getFieldValue(subBean, patternPart); + if (null == subBean) { + // 支持表达式的第一个对象为Bean本身（若用户定义表达式$开头，则不做此操作） + if (isFirst && false == this.isStartWith && BeanUtil.isMatchName(bean, patternPart, true)) { + subBean = bean; + isFirst = false; + } else { + return null; + } + } + } + return subBean; + } + + @SuppressWarnings("unchecked") + private static Object getFieldValue(final Object bean, final String expression) { + if (StrUtil.isBlank(expression)) { + return null; + } + + if (StrUtil.contains(expression, ':')) { + // [start:end:step] 模式 + final List parts = StrUtil.splitTrim(expression, ':'); + final int start = Integer.parseInt(parts.get(0)); + final int end = Integer.parseInt(parts.get(1)); + int step = 1; + if (3 == parts.size()) { + step = Integer.parseInt(parts.get(2)); + } + if (bean instanceof Collection) { + return CollUtil.sub((Collection) bean, start, end, step); + } else if (ArrayUtil.isArray(bean)) { + return ArrayUtil.sub(bean, start, end, step); + } + } else if (StrUtil.contains(expression, ',')) { + // [num0,num1,num2...]模式或者['key0','key1']模式 + final List keys = StrUtil.splitTrim(expression, ','); + if (bean instanceof Collection) { + return CollUtil.getAny((Collection) bean, Convert.convert(int[].class, keys)); + } else if (ArrayUtil.isArray(bean)) { + return ArrayUtil.getAny(bean, Convert.convert(int[].class, keys)); + } else { + final String[] unWrappedKeys = new String[keys.size()]; + for (int i = 0; i < unWrappedKeys.length; i++) { + unWrappedKeys[i] = StrUtil.unWrap(keys.get(i), '\''); + } + if (bean instanceof Map) { + // 只支持String为key的Map + return MapUtil.getAny((Map) bean, unWrappedKeys); + } else { + final Map map = BeanUtil.beanToMap(bean); + return MapUtil.getAny(map, unWrappedKeys); + } + } + } else { + // 数字或普通字符串 + return BeanUtil.getFieldValue(bean, expression); + } + + return null; + } + + /** + * 初始化 + * + * @param expression 表达式 + */ + private void init(final String expression) { + final List localPatternParts = new ArrayList<>(); + final int length = expression.length(); + + final StringBuilder builder = new StringBuilder(); + char c; + boolean isNumStart = false;// 下标标识符开始 + boolean isInWrap = false; //标识是否在引号内 + for (int i = 0; i < length; i++) { + c = expression.charAt(i); + if (0 == i && '$' == c) { + // 忽略开头的$符，表示当前对象 + isStartWith = true; + continue; + } + + if ('\'' == c) { + // 结束 + isInWrap = (false == isInWrap); + continue; + } + + if (false == isInWrap && ArrayUtil.contains(EXP_CHARS, c)) { + // 处理边界符号 + if (CharUtil.BRACKET_END == c) { + // 中括号（数字下标）结束 + if (false == isNumStart) { + throw new IllegalArgumentException(StrUtil.format("Bad expression '{}':{}, we find ']' but no '[' !", expression, i)); + } + isNumStart = false; + // 中括号结束加入下标 + } else { + if (isNumStart) { + // 非结束中括号情况下发现起始中括号报错（中括号未关闭） + throw new IllegalArgumentException(StrUtil.format("Bad expression '{}':{}, we find '[' but no ']' !", expression, i)); + } else if (CharUtil.BRACKET_START == c) { + // 数字下标开始 + isNumStart = true; + } + // 每一个边界符之前的表达式是一个完整的KEY，开始处理KEY + } + if (builder.length() > 0) { + localPatternParts.add(builder.toString()); + } + builder.setLength(0); + } else { + // 非边界符号，追加字符 + builder.append(c); + } + } + + // 末尾边界符检查 + if (isNumStart) { + throw new IllegalArgumentException(StrUtil.format("Bad expression '{}':{}, we find '[' but no ']' !", expression, length - 1)); + } else { + if (builder.length() > 0) { + localPatternParts.add(builder.toString()); + } + } + + // 不可变List + this.patternParts = ListUtil.unmodifiable(localPatternParts); + } + //endregion +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanUtil.java new file mode 100755 index 0000000..7faffc5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/BeanUtil.java @@ -0,0 +1,1010 @@ +package aiyh.utils.tool.cn.hutool.core.bean; + +import aiyh.utils.tool.cn.hutool.core.bean.copier.BeanCopier; +import aiyh.utils.tool.cn.hutool.core.bean.copier.CopyOptions; +import aiyh.utils.tool.cn.hutool.core.bean.copier.ValueProvider; +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.collection.ListUtil; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.lang.Editor; +import aiyh.utils.tool.cn.hutool.core.map.CaseInsensitiveMap; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ModifierUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.beans.BeanInfo; +import java.beans.IntrospectionException; +import java.beans.Introspector; +import java.beans.PropertyDescriptor; +import java.beans.PropertyEditor; +import java.beans.PropertyEditorManager; +import java.lang.reflect.Field; +import java.lang.reflect.Method; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.function.Consumer; +import java.util.function.Supplier; +import java.util.stream.Collectors; + +/** + * Bean工具类 + * + *

+ * 把一个拥有对属性进行set和get方法的类，我们就可以称之为JavaBean。 + *

+ * + * @author Looly + * @since 3.1.2 + */ +public class BeanUtil { + + /** + * 判断是否为可读的Bean对象，判定方法是： + * + * 
+	 *     1、是否存在只有无参数的getXXX方法或者isXXX方法
+	 *     2、是否存在public类型的字段
+	 *
+ * + * @param clazz 待测试类 + * @return 是否为可读的Bean对象 + * @see #hasGetter(Class) + * @see #hasPublicField(Class) + */ + public static boolean isReadableBean(Class clazz) { + return hasGetter(clazz) || hasPublicField(clazz); + } + + /** + * 判断是否为Bean对象，判定方法是： + * + * 
+	 *     1、是否存在只有一个参数的setXXX方法
+	 *     2、是否存在public类型的字段
+	 *
+ * + * @param clazz 待测试类 + * @return 是否为Bean对象 + * @see #hasSetter(Class) + * @see #hasPublicField(Class) + */ + public static boolean isBean(Class clazz) { + return hasSetter(clazz) || hasPublicField(clazz); + } + + /** + * 判断是否有Setter方法
+ * 判定方法是否存在只有一个参数的setXXX方法 + * + * @param clazz 待测试类 + * @return 是否为Bean对象 + * @since 4.2.2 + */ + public static boolean hasSetter(Class clazz) { + if (ClassUtil.isNormalClass(clazz)) { + for (Method method : clazz.getMethods()) { + if (method.getParameterCount() == 1 && method.getName().startsWith("set")) { + // 检测包含标准的setXXX方法即视为标准的JavaBean + return true; + } + } + } + return false; + } + + /** + * 判断是否为Bean对象
+ * 判定方法是否存在只有无参数的getXXX方法或者isXXX方法 + * + * @param clazz 待测试类 + * @return 是否为Bean对象 + * @since 4.2.2 + */ + public static boolean hasGetter(Class clazz) { + if (ClassUtil.isNormalClass(clazz)) { + for (Method method : clazz.getMethods()) { + if (method.getParameterCount() == 0) { + if (method.getName().startsWith("get") || method.getName().startsWith("is")) { + return true; + } + } + } + } + return false; + } + + /** + * 指定类中是否有public类型字段(static字段除外) + * + * @param clazz 待测试类 + * @return 是否有public类型字段 + * @since 5.1.0 + */ + public static boolean hasPublicField(Class clazz) { + if (ClassUtil.isNormalClass(clazz)) { + for (Field field : clazz.getFields()) { + if (ModifierUtil.isPublic(field) && false == ModifierUtil.isStatic(field)) { + //非static的public字段 + return true; + } + } + } + return false; + } + + /** + * 创建动态Bean + * + * @param bean 普通Bean或Map + * @return {@link DynaBean} + * @since 3.0.7 + */ + public static DynaBean createDynaBean(Object bean) { + return new DynaBean(bean); + } + + /** + * 查找类型转换器 {@link PropertyEditor} + * + * @param type 需要转换的目标类型 + * @return {@link PropertyEditor} + */ + public static PropertyEditor findEditor(Class type) { + return PropertyEditorManager.findEditor(type); + } + + /** + * 获取{@link BeanDesc} Bean描述信息 + * + * @param clazz Bean类 + * @return {@link BeanDesc} + * @since 3.1.2 + */ + public static BeanDesc getBeanDesc(Class clazz) { + return BeanDescCache.INSTANCE.getBeanDesc(clazz, () -> new BeanDesc(clazz)); + } + + /** + * 遍历Bean的属性 + * + * @param clazz Bean类 + * @param action 每个元素的处理类 + * @since 5.4.2 + */ + public static void descForEach(Class clazz, Consumer action) { + getBeanDesc(clazz).getProps().forEach(action); + } + + // --------------------------------------------------------------------------------------------------------- PropertyDescriptor + + /** + * 获得Bean字段描述数组 + * + * @param clazz Bean类 + * @return 字段描述数组 + * @throws BeanException 获取属性异常 + */ + public static PropertyDescriptor[] getPropertyDescriptors(Class clazz) throws BeanException { + BeanInfo beanInfo; + try { + beanInfo = Introspector.getBeanInfo(clazz); + } catch (IntrospectionException e) { + throw new BeanException(e); + } + return ArrayUtil.filter(beanInfo.getPropertyDescriptors(), t -> { + // 过滤掉getClass方法 + return false == "class".equals(t.getName()); + }); + } + + /** + * 获得字段名和字段描述Map，获得的结果会缓存在 {@link BeanInfoCache}中 + * + * @param clazz Bean类 + * @param ignoreCase 是否忽略大小写 + * @return 字段名和字段描述Map + * @throws BeanException 获取属性异常 + */ + public static Map getPropertyDescriptorMap(Class clazz, boolean ignoreCase) throws BeanException { + return BeanInfoCache.INSTANCE.getPropertyDescriptorMap(clazz, ignoreCase, () -> internalGetPropertyDescriptorMap(clazz, ignoreCase)); + } + + /** + * 获得字段名和字段描述Map。内部使用，直接获取Bean类的PropertyDescriptor + * + * @param clazz Bean类 + * @param ignoreCase 是否忽略大小写 + * @return 字段名和字段描述Map + * @throws BeanException 获取属性异常 + */ + private static Map internalGetPropertyDescriptorMap(Class clazz, boolean ignoreCase) throws BeanException { + final PropertyDescriptor[] propertyDescriptors = getPropertyDescriptors(clazz); + final Map map = ignoreCase ? new CaseInsensitiveMap<>(propertyDescriptors.length, 1f) + : new HashMap<>(propertyDescriptors.length, 1); + + for (PropertyDescriptor propertyDescriptor : propertyDescriptors) { + map.put(propertyDescriptor.getName(), propertyDescriptor); + } + return map; + } + + /** + * 获得Bean类属性描述，大小写敏感 + * + * @param clazz Bean类 + * @param fieldName 字段名 + * @return PropertyDescriptor + * @throws BeanException 获取属性异常 + */ + public static PropertyDescriptor getPropertyDescriptor(Class clazz, final String fieldName) throws BeanException { + return getPropertyDescriptor(clazz, fieldName, false); + } + + /** + * 获得Bean类属性描述 + * + * @param clazz Bean类 + * @param fieldName 字段名 + * @param ignoreCase 是否忽略大小写 + * @return PropertyDescriptor + * @throws BeanException 获取属性异常 + */ + public static PropertyDescriptor getPropertyDescriptor(Class clazz, final String fieldName, boolean ignoreCase) throws BeanException { + final Map map = getPropertyDescriptorMap(clazz, ignoreCase); + return (null == map) ? null : map.get(fieldName); + } + + /** + * 获得字段值，通过反射直接获得字段值，并不调用getXXX方法
+ * 对象同样支持Map类型，fieldNameOrIndex即为key + * + *
    + *
  • Map: fieldNameOrIndex需为key，获取对应value
    • + *
  • Collection: fieldNameOrIndex当为数字，返回index对应值，非数字遍历集合返回子bean对应name值
    • + *
  • Array: fieldNameOrIndex当为数字，返回index对应值，非数字遍历数组返回子bean对应name值
    • + *
+ * + * @param bean Bean对象 + * @param fieldNameOrIndex 字段名或序号，序号支持负数 + * @return 字段值 + */ + public static Object getFieldValue(Object bean, String fieldNameOrIndex) { + if (null == bean || null == fieldNameOrIndex) { + return null; + } + + if (bean instanceof Map) { + return ((Map) bean).get(fieldNameOrIndex); + } else if (bean instanceof Collection) { + try { + return CollUtil.get((Collection) bean, Integer.parseInt(fieldNameOrIndex)); + } catch (NumberFormatException e) { + // 非数字，see pr#254@Gitee + return CollUtil.map((Collection) bean, (beanEle) -> getFieldValue(beanEle, fieldNameOrIndex), false); + } + } else if (ArrayUtil.isArray(bean)) { + try { + return ArrayUtil.get(bean, Integer.parseInt(fieldNameOrIndex)); + } catch (NumberFormatException e) { + // 非数字，see pr#254@Gitee + return ArrayUtil.map(bean, Object.class, (beanEle) -> getFieldValue(beanEle, fieldNameOrIndex)); + } + } else {// 普通Bean对象 + return ReflectUtil.getFieldValue(bean, fieldNameOrIndex); + } + } + + /** + * 设置字段值，通过反射设置字段值，并不调用setXXX方法
+ * 对象同样支持Map类型，fieldNameOrIndex即为key + * + * @param bean Bean + * @param fieldNameOrIndex 字段名或序号，序号支持负数 + * @param value 值 + */ + @SuppressWarnings({"unchecked", "rawtypes"}) + public static void setFieldValue(Object bean, String fieldNameOrIndex, Object value) { + if (bean instanceof Map) { + ((Map) bean).put(fieldNameOrIndex, value); + } else if (bean instanceof List) { + ListUtil.setOrPadding((List) bean, Convert.toInt(fieldNameOrIndex), value); + } else if (ArrayUtil.isArray(bean)) { + ArrayUtil.setOrAppend(bean, Convert.toInt(fieldNameOrIndex), value); + } else { + // 普通Bean对象 + ReflectUtil.setFieldValue(bean, fieldNameOrIndex, value); + } + } + + /** + * 解析Bean中的属性值 + * + * @param 属性值类型 + * @param bean Bean对象，支持Map、List、Collection、Array + * @param expression 表达式，例如：person.friend[5].name + * @return Bean属性值，bean为{@code null}或者express为空，返回{@code null} + * @see BeanPath#get(Object) + * @since 3.0.7 + */ + @SuppressWarnings("unchecked") + public static T getProperty(Object bean, String expression) { + if (null == bean || StrUtil.isBlank(expression)) { + return null; + } + return (T) BeanPath.create(expression).get(bean); + } + + /** + * 解析Bean中的属性值 + * + * @param bean Bean对象，支持Map、List、Collection、Array + * @param expression 表达式，例如：person.friend[5].name + * @param value 属性值 + * @see BeanPath#get(Object) + * @since 4.0.6 + */ + public static void setProperty(Object bean, String expression, Object value) { + BeanPath.create(expression).set(bean, value); + } + + // --------------------------------------------------------------------------------------------- mapToBean + + /** + * Map转换为Bean对象 + * + * @param Bean类型 + * @param map {@link Map} + * @param beanClass Bean Class + * @param isIgnoreError 是否忽略注入错误 + * @return Bean + * @deprecated 请使用 {@link #toBean(Object, Class)} 或 {@link #toBeanIgnoreError(Object, Class)} + */ + @Deprecated + public static T mapToBean(Map map, Class beanClass, boolean isIgnoreError) { + return fillBeanWithMap(map, ReflectUtil.newInstanceIfPossible(beanClass), isIgnoreError); + } + + /** + * Map转换为Bean对象
+ * 忽略大小写 + * + * @param Bean类型 + * @param map Map + * @param beanClass Bean Class + * @param isIgnoreError 是否忽略注入错误 + * @return Bean + * @deprecated 请使用 {@link #toBeanIgnoreCase(Object, Class, boolean)} + */ + @Deprecated + public static T mapToBeanIgnoreCase(Map map, Class beanClass, boolean isIgnoreError) { + return fillBeanWithMapIgnoreCase(map, ReflectUtil.newInstanceIfPossible(beanClass), isIgnoreError); + } + + /** + * Map转换为Bean对象 + * + * @param Bean类型 + * @param map {@link Map} + * @param beanClass Bean Class + * @param copyOptions 转Bean选项 + * @return Bean + * @deprecated 请使用 {@link #toBean(Object, Class, CopyOptions)} + */ + @Deprecated + public static T mapToBean(Map map, Class beanClass, CopyOptions copyOptions) { + return fillBeanWithMap(map, ReflectUtil.newInstanceIfPossible(beanClass), copyOptions); + } + + /** + * Map转换为Bean对象 + * + * @param Bean类型 + * @param map {@link Map} + * @param beanClass Bean Class + * @param isToCamelCase 是否将Map中的下划线风格key转换为驼峰风格 + * @param copyOptions 转Bean选项 + * @return Bean + */ + public static T mapToBean(Map map, Class beanClass, boolean isToCamelCase, CopyOptions copyOptions) { + return fillBeanWithMap(map, ReflectUtil.newInstanceIfPossible(beanClass), isToCamelCase, copyOptions); + } + + // --------------------------------------------------------------------------------------------- fillBeanWithMap + + /** + * 使用Map填充Bean对象 + * + * @param Bean类型 + * @param map Map + * @param bean Bean + * @param isIgnoreError 是否忽略注入错误 + * @return Bean + */ + public static T fillBeanWithMap(Map map, T bean, boolean isIgnoreError) { + return fillBeanWithMap(map, bean, false, isIgnoreError); + } + + /** + * 使用Map填充Bean对象，可配置将下划线转换为驼峰 + * + * @param Bean类型 + * @param map Map + * @param bean Bean + * @param isToCamelCase 是否将下划线模式转换为驼峰模式 + * @param isIgnoreError 是否忽略注入错误 + * @return Bean + */ + public static T fillBeanWithMap(Map map, T bean, boolean isToCamelCase, boolean isIgnoreError) { + return fillBeanWithMap(map, bean, isToCamelCase, CopyOptions.create().setIgnoreError(isIgnoreError)); + } + + /** + * 使用Map填充Bean对象，忽略大小写 + * + * @param Bean类型 + * @param map Map + * @param bean Bean + * @param isIgnoreError 是否忽略注入错误 + * @return Bean + */ + public static T fillBeanWithMapIgnoreCase(Map map, T bean, boolean isIgnoreError) { + return fillBeanWithMap(map, bean, CopyOptions.create().setIgnoreCase(true).setIgnoreError(isIgnoreError)); + } + + /** + * 使用Map填充Bean对象 + * + * @param Bean类型 + * @param map Map + * @param bean Bean + * @param copyOptions 属性复制选项 {@link CopyOptions} + * @return Bean + */ + public static T fillBeanWithMap(Map map, T bean, CopyOptions copyOptions) { + return fillBeanWithMap(map, bean, false, copyOptions); + } + + /** + * 使用Map填充Bean对象 + * + * @param Bean类型 + * @param map Map + * @param bean Bean + * @param isToCamelCase 是否将Map中的下划线风格key转换为驼峰风格 + * @param copyOptions 属性复制选项 {@link CopyOptions} + * @return Bean + * @since 3.3.1 + */ + public static T fillBeanWithMap(Map map, T bean, boolean isToCamelCase, CopyOptions copyOptions) { + if (MapUtil.isEmpty(map)) { + return bean; + } + if (isToCamelCase) { + map = MapUtil.toCamelCaseMap(map); + } + copyProperties(map, bean, copyOptions); + return bean; + } + + // --------------------------------------------------------------------------------------------- fillBean + + /** + * 对象或Map转Bean + * + * @param 转换的Bean类型 + * @param source Bean对象或Map + * @param clazz 目标的Bean类型 + * @return Bean对象 + * @since 4.1.20 + */ + public static T toBean(Object source, Class clazz) { + return toBean(source, clazz, null); + } + + /** + * 对象或Map转Bean，忽略字段转换时发生的异常 + * + * @param 转换的Bean类型 + * @param source Bean对象或Map + * @param clazz 目标的Bean类型 + * @return Bean对象 + * @since 5.4.0 + */ + public static T toBeanIgnoreError(Object source, Class clazz) { + return toBean(source, clazz, CopyOptions.create().setIgnoreError(true)); + } + + /** + * 对象或Map转Bean，忽略字段转换时发生的异常 + * + * @param 转换的Bean类型 + * @param source Bean对象或Map + * @param clazz 目标的Bean类型 + * @param ignoreError 是否忽略注入错误 + * @return Bean对象 + * @since 5.4.0 + */ + public static T toBeanIgnoreCase(Object source, Class clazz, boolean ignoreError) { + return toBean(source, clazz, + CopyOptions.create() + .setIgnoreCase(true) + .setIgnoreError(ignoreError)); + } + + /** + * 对象或Map转Bean + * + * @param 转换的Bean类型 + * @param source Bean对象或Map + * @param clazz 目标的Bean类型 + * @param options 属性拷贝选项 + * @return Bean对象 + * @since 5.2.4 + */ + public static T toBean(Object source, Class clazz, CopyOptions options) { + return toBean(source, () -> ReflectUtil.newInstanceIfPossible(clazz), options); + } + + /** + * 对象或Map转Bean + * + * @param 转换的Bean类型 + * @param source Bean对象或Map + * @param targetSupplier 目标的Bean创建器 + * @param options 属性拷贝选项 + * @return Bean对象 + * @since 5.8.0 + */ + public static T toBean(Object source, Supplier targetSupplier, CopyOptions options) { + if (null == source || null == targetSupplier) { + return null; + } + final T target = targetSupplier.get(); + copyProperties(source, target, options); + return target; + } + + /** + * ServletRequest 参数转Bean + * + * @param Bean类型 + * @param beanClass Bean Class + * @param valueProvider 值提供者 + * @param copyOptions 拷贝选项，见 {@link CopyOptions} + * @return Bean + */ + public static T toBean(Class beanClass, ValueProvider valueProvider, CopyOptions copyOptions) { + if (null == beanClass || null == valueProvider) { + return null; + } + return fillBean(ReflectUtil.newInstanceIfPossible(beanClass), valueProvider, copyOptions); + } + + /** + * 填充Bean的核心方法 + * + * @param Bean类型 + * @param bean Bean + * @param valueProvider 值提供者 + * @param copyOptions 拷贝选项，见 {@link CopyOptions} + * @return Bean + */ + public static T fillBean(T bean, ValueProvider valueProvider, CopyOptions copyOptions) { + if (null == valueProvider) { + return bean; + } + + return BeanCopier.create(valueProvider, bean, copyOptions).copy(); + } + + // --------------------------------------------------------------------------------------------- beanToMap + /** + * 将bean的部分属性转换成map
+ * 可选拷贝哪些属性值，默认是不忽略值为{@code null}的值的。 + * + * @param bean bean + * @param properties 需要拷贝的属性值，{@code null}或空表示拷贝所有值 + * @return Map + * @since 5.8.0 + */ + public static Map beanToMap(Object bean, String... properties) { + int mapSize = 16; + Editor keyEditor = null; + if(ArrayUtil.isNotEmpty(properties)){ + mapSize = properties.length; + final Set propertiesSet = CollUtil.set(false, properties); + keyEditor = property -> propertiesSet.contains(property) ? property : null; + } + + // 指明了要复制的属性 所以不忽略null值 + return beanToMap(bean, new LinkedHashMap<>(mapSize, 1), false, keyEditor); + } + + /** + * 对象转Map + * + * @param bean bean对象 + * @param isToUnderlineCase 是否转换为下划线模式 + * @param ignoreNullValue 是否忽略值为空的字段 + * @return Map + */ + public static Map beanToMap(Object bean, boolean isToUnderlineCase, boolean ignoreNullValue) { + if (null == bean) { + return null; + } + return beanToMap(bean, new LinkedHashMap<>(), isToUnderlineCase, ignoreNullValue); + } + + /** + * 对象转Map + * + * @param bean bean对象 + * @param targetMap 目标的Map + * @param isToUnderlineCase 是否转换为下划线模式 + * @param ignoreNullValue 是否忽略值为空的字段 + * @return Map + * @since 3.2.3 + */ + public static Map beanToMap(Object bean, Map targetMap, final boolean isToUnderlineCase, boolean ignoreNullValue) { + if (null == bean) { + return null; + } + + return beanToMap(bean, targetMap, ignoreNullValue, key -> isToUnderlineCase ? StrUtil.toUnderlineCase(key) : key); + } + + /** + * 对象转Map
+ * 通过实现{@link Editor} 可以自定义字段值，如果这个Editor返回null则忽略这个字段，以便实现： + * + * 
+	 * 1. 字段筛选，可以去除不需要的字段
+	 * 2. 字段变换，例如实现驼峰转下划线
+	 * 3. 自定义字段前缀或后缀等等
+	 *
+ * + * @param bean bean对象 + * @param targetMap 目标的Map + * @param ignoreNullValue 是否忽略值为空的字段 + * @param keyEditor 属性字段（Map的key）编辑器，用于筛选、编辑key，如果这个Editor返回null则忽略这个字段 + * @return Map + * @since 4.0.5 + */ + public static Map beanToMap(Object bean, Map targetMap, boolean ignoreNullValue, Editor keyEditor) { + if (null == bean) { + return null; + } + + return BeanCopier.create(bean, targetMap, + CopyOptions.create() + .setIgnoreNullValue(ignoreNullValue) + .setFieldNameEditor(keyEditor) + ).copy(); + } + + /** + * 对象转Map
+ * 通过自定义{@link CopyOptions} 完成抓换选项，以便实现： + * + * 
+	 * 1. 字段筛选，可以去除不需要的字段
+	 * 2. 字段变换，例如实现驼峰转下划线
+	 * 3. 自定义字段前缀或后缀等等
+	 * 4. 字段值处理
+	 * ...
+	 *
+ * + * @param bean bean对象 + * @param targetMap 目标的Map + * @param copyOptions 拷贝选项 + * @return Map + * @since 5.7.15 + */ + public static Map beanToMap(Object bean, Map targetMap, CopyOptions copyOptions) { + if (null == bean) { + return null; + } + + return BeanCopier.create(bean, targetMap, copyOptions).copy(); + } + + // --------------------------------------------------------------------------------------------- copyProperties + + /** + * 按照Bean对象属性创建对应的Class对象，并忽略某些属性 + * + * @param 对象类型 + * @param source 源Bean对象 + * @param tClass 目标Class + * @param ignoreProperties 不拷贝的的属性列表 + * @return 目标对象 + */ + public static T copyProperties(Object source, Class tClass, String... ignoreProperties) { + if(null == source){ + return null; + } + T target = ReflectUtil.newInstanceIfPossible(tClass); + copyProperties(source, target, CopyOptions.create().setIgnoreProperties(ignoreProperties)); + return target; + } + + /** + * 复制Bean对象属性
+ * 限制类用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类 + * + * @param source 源Bean对象 + * @param target 目标Bean对象 + * @param ignoreProperties 不拷贝的的属性列表 + */ + public static void copyProperties(Object source, Object target, String... ignoreProperties) { + copyProperties(source, target, CopyOptions.create().setIgnoreProperties(ignoreProperties)); + } + + /** + * 复制Bean对象属性
+ * + * @param source 源Bean对象 + * @param target 目标Bean对象 + * @param ignoreCase 是否忽略大小写 + */ + public static void copyProperties(Object source, Object target, boolean ignoreCase) { + BeanCopier.create(source, target, CopyOptions.create().setIgnoreCase(ignoreCase)).copy(); + } + + /** + * 复制Bean对象属性
+ * 限制类用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类 + * + * @param source 源Bean对象 + * @param target 目标Bean对象 + * @param copyOptions 拷贝选项，见 {@link CopyOptions} + */ + public static void copyProperties(Object source, Object target, CopyOptions copyOptions) { + if(null == source){ + return; + } + BeanCopier.create(source, target, ObjectUtil.defaultIfNull(copyOptions, CopyOptions::create)).copy(); + } + + /** + * 复制集合中的Bean属性
+ * 此方法遍历集合中每个Bean，复制其属性后加入一个新的{@link List}中。 + * + * @param collection 原Bean集合 + * @param targetType 目标Bean类型 + * @param copyOptions 拷贝选项 + * @param Bean类型 + * @return 复制后的List + * @since 5.6.4 + */ + public static List copyToList(Collection collection, Class targetType, CopyOptions copyOptions) { + if (null == collection) { + return null; + } + if (collection.isEmpty()) { + return new ArrayList<>(0); + } + return collection.stream().map((source) -> { + final T target = ReflectUtil.newInstanceIfPossible(targetType); + copyProperties(source, target, copyOptions); + return target; + }).collect(Collectors.toList()); + } + + /** + * 复制集合中的Bean属性
+ * 此方法遍历集合中每个Bean，复制其属性后加入一个新的{@link List}中。 + * + * @param collection 原Bean集合 + * @param targetType 目标Bean类型 + * @param Bean类型 + * @return 复制后的List + * @since 5.6.6 + */ + public static List copyToList(Collection collection, Class targetType) { + return copyToList(collection, targetType, CopyOptions.create()); + } + + /** + * 给定的Bean的类名是否匹配指定类名字符串
+ * 如果isSimple为{@code true}，则只匹配类名而忽略包名，例如：cn.hutool.TestEntity只匹配TestEntity
+ * 如果isSimple为{@code false}，则匹配包括包名的全类名，例如：cn.hutool.TestEntity匹配cn.hutool.TestEntity + * + * @param bean Bean + * @param beanClassName Bean的类名 + * @param isSimple 是否只匹配类名而忽略包名，true表示忽略包名 + * @return 是否匹配 + * @since 4.0.6 + */ + public static boolean isMatchName(Object bean, String beanClassName, boolean isSimple) { + if (null == bean || StrUtil.isBlank(beanClassName)) { + return false; + } + return ClassUtil.getClassName(bean, isSimple).equals(isSimple ? StrUtil.upperFirst(beanClassName) : beanClassName); + } + + /** + * 编辑Bean的字段，static字段不会处理
+ * 例如需要对指定的字段做判空操作、null转""操作等等。 + * + * @param bean bean + * @param editor 编辑器函数 + * @param 被编辑的Bean类型 + * @return bean + * @since 5.6.4 + */ + public static T edit(T bean, Editor editor) { + if (bean == null) { + return null; + } + + final Field[] fields = ReflectUtil.getFields(bean.getClass()); + for (Field field : fields) { + if (ModifierUtil.isStatic(field)) { + continue; + } + editor.edit(field); + } + return bean; + } + + /** + * 把Bean里面的String属性做trim操作。此方法直接对传入的Bean做修改。 + *

+ * 通常bean直接用来绑定页面的input，用户的输入可能首尾存在空格，通常保存数据库前需要把首尾空格去掉 + * + * @param Bean类型 + * @param bean Bean对象 + * @param ignoreFields 不需要trim的Field名称列表（不区分大小写） + * @return 处理后的Bean对象 + */ + public static T trimStrFields(T bean, String... ignoreFields) { + return edit(bean, (field) -> { + if (ignoreFields != null && ArrayUtil.containsIgnoreCase(ignoreFields, field.getName())) { + // 不处理忽略的Fields + return field; + } + if (String.class.equals(field.getType())) { + // 只有String的Field才处理 + final String val = (String) ReflectUtil.getFieldValue(bean, field); + if (null != val) { + final String trimVal = StrUtil.trim(val); + if (false == val.equals(trimVal)) { + // Field Value不为null，且首尾有空格才处理 + ReflectUtil.setFieldValue(bean, field, trimVal); + } + } + } + return field; + }); + } + + /** + * 判断Bean是否为非空对象，非空对象表示本身不为{@code null}或者含有非{@code null}属性的对象 + * + * @param bean Bean对象 + * @param ignoreFieldNames 忽略检查的字段名 + * @return 是否为非空，{@code true} - 非空 / {@code false} - 空 + * @since 5.0.7 + */ + public static boolean isNotEmpty(Object bean, String... ignoreFieldNames) { + return false == isEmpty(bean, ignoreFieldNames); + } + + /** + * 判断Bean是否为空对象，空对象表示本身为{@code null}或者所有属性都为{@code null}
+ * 此方法不判断static属性 + * + * @param bean Bean对象 + * @param ignoreFieldNames 忽略检查的字段名 + * @return 是否为空，{@code true} - 空 / {@code false} - 非空 + * @since 4.1.10 + */ + public static boolean isEmpty(Object bean, String... ignoreFieldNames) { + if (null != bean) { + for (Field field : ReflectUtil.getFields(bean.getClass())) { + if (ModifierUtil.isStatic(field)) { + continue; + } + if ((false == ArrayUtil.contains(ignoreFieldNames, field.getName())) + && null != ReflectUtil.getFieldValue(bean, field)) { + return false; + } + } + } + return true; + } + + /** + * 判断Bean是否包含值为{@code null}的属性
+ * 对象本身为{@code null}也返回true + * + * @param bean Bean对象 + * @param ignoreFieldNames 忽略检查的字段名 + * @return 是否包含值为null的属性，{@code true} - 包含 / {@code false} - 不包含 + * @since 4.1.10 + */ + public static boolean hasNullField(Object bean, String... ignoreFieldNames) { + if (null == bean) { + return true; + } + for (Field field : ReflectUtil.getFields(bean.getClass())) { + if (ModifierUtil.isStatic(field)) { + continue; + } + if ((false == ArrayUtil.contains(ignoreFieldNames, field.getName())) + && null == ReflectUtil.getFieldValue(bean, field)) { + return true; + } + } + return false; + } + + /** + * 获取Getter或Setter方法名对应的字段名称，规则如下： + *

    + *
  • getXxxx获取为xxxx，如getName得到name。
    • + *
  • setXxxx获取为xxxx，如setName得到name。
    • + *
  • isXxxx获取为xxxx，如isName得到name。
    • + *
  • 其它不满足规则的方法名抛出{@link IllegalArgumentException}
    • + *
+ * + * @param getterOrSetterName Getter或Setter方法名 + * @return 字段名称 + * @throws IllegalArgumentException 非Getter或Setter方法 + * @since 5.7.23 + */ + public static String getFieldName(String getterOrSetterName) { + if (getterOrSetterName.startsWith("get") || getterOrSetterName.startsWith("set")) { + return StrUtil.removePreAndLowerFirst(getterOrSetterName, 3); + } else if (getterOrSetterName.startsWith("is")) { + return StrUtil.removePreAndLowerFirst(getterOrSetterName, 2); + } else { + throw new IllegalArgumentException("Invalid Getter or Setter name: " + getterOrSetterName); + } + } + + /** + * 判断source与target的所有公共字段的值是否相同 + * + * @param source 待检测对象1 + * @param target 待检测对象2 + * @param ignoreProperties 不需要检测的字段 + * @return 判断结果，如果为true则证明所有字段的值都相同 + * @since 5.8.4 + * @author Takak11 + */ + public static boolean isCommonFieldsEqual(Object source, Object target, String...ignoreProperties) { + + if (null == source && null == target) { + return true; + } + if (null == source || null == target) { + return false; + } + + Map sourceFieldsMap = BeanUtil.beanToMap(source); + Map targetFieldsMap = BeanUtil.beanToMap(target); + + Set sourceFields = sourceFieldsMap.keySet(); + sourceFields.removeAll(Arrays.asList(ignoreProperties)); + + for (String field : sourceFields) { + if(ObjectUtil.notEqual(sourceFieldsMap.get(field), targetFieldsMap.get(field))){ + return false; + } + } + + return true; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/DynaBean.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/DynaBean.java new file mode 100644 index 0000000..5a2ef7c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/DynaBean.java @@ -0,0 +1,226 @@ +package aiyh.utils.tool.cn.hutool.core.bean; + +import aiyh.utils.tool.cn.hutool.core.clone.CloneSupport; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; + +import java.io.Serializable; +import java.util.Map; + +/** + * 动态Bean，通过反射对Bean的相关方法做操作
+ * 支持Map和普通Bean + * + * @author Looly + * @since 3.0.7 + */ +public class DynaBean extends CloneSupport implements Serializable { + private static final long serialVersionUID = 1L; + + private final Class beanClass; + private final Object bean; + + /** + * 创建一个DynaBean + * + * @param bean 普通Bean + * @return DynaBean + */ + public static DynaBean create(Object bean) { + return new DynaBean(bean); + } + + /** + * 创建一个DynaBean + * + * @param beanClass Bean类 + * @return DynaBean + */ + public static DynaBean create(Class beanClass) { + return new DynaBean(beanClass); + } + + + /** + * 创建一个DynaBean + * + * @param beanClass Bean类 + * @param params 构造Bean所需要的参数 + * @return DynaBean + */ + public static DynaBean create(Class beanClass, Object... params) { + return new DynaBean(beanClass, params); + } + + //------------------------------------------------------------------------ Constructor start + + /** + * 构造 + * + * @param beanClass Bean类 + * @param params 构造Bean所需要的参数 + */ + public DynaBean(Class beanClass, Object... params) { + this(ReflectUtil.newInstance(beanClass, params)); + } + + /** + * 构造 + * + * @param beanClass Bean类 + */ + public DynaBean(Class beanClass) { + this(ReflectUtil.newInstance(beanClass)); + } + + /** + * 构造 + * + * @param bean 原始Bean + */ + public DynaBean(Object bean) { + Assert.notNull(bean); + if (bean instanceof DynaBean) { + bean = ((DynaBean) bean).getBean(); + } + this.bean = bean; + this.beanClass = ClassUtil.getClass(bean); + } + //------------------------------------------------------------------------ Constructor end + + /** + * 获得字段对应值 + * + * @param 属性值类型 + * @param fieldName 字段名 + * @return 字段值 + * @throws BeanException 反射获取属性值或字段值导致的异常 + */ + @SuppressWarnings("unchecked") + public T get(String fieldName) throws BeanException { + if (Map.class.isAssignableFrom(beanClass)) { + return (T) ((Map) bean).get(fieldName); + } else { + final PropDesc prop = BeanUtil.getBeanDesc(beanClass).getProp(fieldName); + if (null == prop) { + throw new BeanException("No public field or get method for {}", fieldName); + } + return (T) prop.getValue(bean); + } + } + + /** + * 检查是否有指定名称的bean属性 + * + * @param fieldName 字段名 + * @return 是否有bean属性 + * @since 5.4.2 + */ + public boolean containsProp(String fieldName) { + if (Map.class.isAssignableFrom(beanClass)) { + return ((Map) bean).containsKey(fieldName); + } else{ + return null != BeanUtil.getBeanDesc(beanClass).getProp(fieldName); + } + } + + /** + * 获得字段对应值，获取异常返回{@code null} + * + * @param 属性值类型 + * @param fieldName 字段名 + * @return 字段值 + * @since 3.1.1 + */ + public T safeGet(String fieldName) { + try { + return get(fieldName); + } catch (Exception e) { + return null; + } + } + + /** + * 设置字段值 + * + * @param fieldName 字段名 + * @param value 字段值 + * @throws BeanException 反射获取属性值或字段值导致的异常 + */ + @SuppressWarnings({"unchecked", "rawtypes"}) + public void set(String fieldName, Object value) throws BeanException { + if (Map.class.isAssignableFrom(beanClass)) { + ((Map) bean).put(fieldName, value); + } else { + final PropDesc prop = BeanUtil.getBeanDesc(beanClass).getProp(fieldName); + if (null == prop) { + throw new BeanException("No public field or set method for {}", fieldName); + } + prop.setValue(bean, value); + } + } + + /** + * 执行原始Bean中的方法 + * + * @param methodName 方法名 + * @param params 参数 + * @return 执行结果，可能为null + */ + public Object invoke(String methodName, Object... params) { + return ReflectUtil.invoke(this.bean, methodName, params); + } + + /** + * 获得原始Bean + * + * @param Bean类型 + * @return bean + */ + @SuppressWarnings("unchecked") + public T getBean() { + return (T) this.bean; + } + + /** + * 获得Bean的类型 + * + * @param Bean类型 + * @return Bean类型 + */ + @SuppressWarnings("unchecked") + public Class getBeanClass() { + return (Class) this.beanClass; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((bean == null) ? 0 : bean.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + final DynaBean other = (DynaBean) obj; + if (bean == null) { + return other.bean == null; + } else return bean.equals(other.bean); + } + + @Override + public String toString() { + return this.bean.toString(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/NullWrapperBean.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/NullWrapperBean.java new file mode 100644 index 0000000..85d40f5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/NullWrapperBean.java @@ -0,0 +1,29 @@ +package aiyh.utils.tool.cn.hutool.core.bean; + +/** + * 为了解决反射过程中,需要传递null参数,但是会丢失参数类型而设立的包装类 + * + * @param Null值对应的类型 + * @author Lillls + * @since 5.5.0 + */ +public class NullWrapperBean { + + private final Class clazz; + + /** + * @param clazz null的类型 + */ + public NullWrapperBean(Class clazz) { + this.clazz = clazz; + } + + /** + * 获取null值对应的类型 + * + * @return 类型 + */ + public Class getWrappedClass() { + return clazz; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/PropDesc.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/PropDesc.java new file mode 100644 index 0000000..84a9cc2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/PropDesc.java @@ -0,0 +1,404 @@ +package aiyh.utils.tool.cn.hutool.core.bean; + +import aiyh.utils.tool.cn.hutool.core.annotation.AnnotationUtil; +import aiyh.utils.tool.cn.hutool.core.annotation.PropIgnore; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ModifierUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +import java.beans.Transient; +import java.lang.reflect.Field; +import java.lang.reflect.Method; +import java.lang.reflect.Type; + +/** + * 属性描述，包括了字段、getter、setter和相应的方法执行 + * + * @author looly + */ +public class PropDesc { + + /** + * 字段 + */ + final Field field; + /** + * Getter方法 + */ + protected Method getter; + /** + * Setter方法 + */ + protected Method setter; + + /** + * 构造
+ * Getter和Setter方法设置为默认可访问 + * + * @param field 字段 + * @param getter get方法 + * @param setter set方法 + */ + public PropDesc(Field field, Method getter, Method setter) { + this.field = field; + this.getter = ClassUtil.setAccessible(getter); + this.setter = ClassUtil.setAccessible(setter); + } + + /** + * 获取字段名，如果存在Alias注解，读取注解的值作为名称 + * + * @return 字段名 + */ + public String getFieldName() { + return ReflectUtil.getFieldName(this.field); + } + + /** + * 获取字段名称 + * + * @return 字段名 + * @since 5.1.6 + */ + public String getRawFieldName() { + return null == this.field ? null : this.field.getName(); + } + + /** + * 获取字段 + * + * @return 字段 + */ + public Field getField() { + return this.field; + } + + /** + * 获得字段类型
+ * 先获取字段的类型，如果字段不存在，则获取Getter方法的返回类型，否则获取Setter的第一个参数类型 + * + * @return 字段类型 + */ + public Type getFieldType() { + if (null != this.field) { + return TypeUtil.getType(this.field); + } + return findPropType(getter, setter); + } + + /** + * 获得字段类型
+ * 先获取字段的类型，如果字段不存在，则获取Getter方法的返回类型，否则获取Setter的第一个参数类型 + * + * @return 字段类型 + */ + public Class getFieldClass() { + if (null != this.field) { + return TypeUtil.getClass(this.field); + } + return findPropClass(getter, setter); + } + + /** + * 获取Getter方法，可能为{@code null} + * + * @return Getter方法 + */ + public Method getGetter() { + return this.getter; + } + + /** + * 获取Setter方法，可能为{@code null} + * + * @return {@link Method}Setter 方法对象 + */ + public Method getSetter() { + return this.setter; + } + + /** + * 检查属性是否可读（即是否可以通过{@link #getValue(Object)}获取到值） + * + * @param checkTransient 是否检查Transient关键字或注解 + * @return 是否可读 + * @since 5.4.2 + */ + public boolean isReadable(boolean checkTransient) { + // 检查是否有getter方法或是否为public修饰 + if (null == this.getter && false == ModifierUtil.isPublic(this.field)) { + return false; + } + + // 检查transient关键字和@Transient注解 + if (checkTransient && isTransientForGet()) { + return false; + } + + // 检查@PropIgnore注解 + return false == isIgnoreGet(); + } + + /** + * 获取属性值
+ * 首先调用字段对应的Getter方法获取值，如果Getter方法不存在，则判断字段如果为public，则直接获取字段值
+ * 此方法不检查任何注解，使用前需调用 {@link #isReadable(boolean)} 检查是否可读 + * + * @param bean Bean对象 + * @return 字段值 + * @since 4.0.5 + */ + public Object getValue(Object bean) { + if (null != this.getter) { + return ReflectUtil.invoke(bean, this.getter); + } else if (ModifierUtil.isPublic(this.field)) { + return ReflectUtil.getFieldValue(bean, this.field); + } + + return null; + } + + /** + * 获取属性值，自动转换属性值类型
+ * 首先调用字段对应的Getter方法获取值，如果Getter方法不存在，则判断字段如果为public，则直接获取字段值 + * + * @param bean Bean对象 + * @param targetType 返回属性值需要转换的类型，null表示不转换 + * @param ignoreError 是否忽略错误，包括转换错误和注入错误 + * @return this + * @since 5.4.2 + */ + public Object getValue(Object bean, Type targetType, boolean ignoreError) { + Object result = null; + try { + result = getValue(bean); + } catch (Exception e) { + if (false == ignoreError) { + throw new BeanException(e, "Get value of [{}] error!", getFieldName()); + } + } + + if (null != result && null != targetType) { + // 尝试将结果转换为目标类型，如果转换失败，返回null，即跳过此属性值。 + // 来自：issues#I41WKP@Gitee，当忽略错误情况下，目标类型转换失败应返回null + // 如果返回原值，在集合注入时会成功，但是集合取值时会报类型转换错误 + return Convert.convertWithCheck(targetType, result, null, ignoreError); + } + return result; + } + + /** + * 检查属性是否可读（即是否可以通过{@link #getValue(Object)}获取到值） + * + * @param checkTransient 是否检查Transient关键字或注解 + * @return 是否可读 + * @since 5.4.2 + */ + public boolean isWritable(boolean checkTransient) { + // 检查是否有getter方法或是否为public修饰 + if (null == this.setter && false == ModifierUtil.isPublic(this.field)) { + return false; + } + + // 检查transient关键字和@Transient注解 + if (checkTransient && isTransientForSet()) { + return false; + } + + // 检查@PropIgnore注解 + return false == isIgnoreSet(); + } + + /** + * 设置Bean的字段值
+ * 首先调用字段对应的Setter方法，如果Setter方法不存在，则判断字段如果为public，则直接赋值字段值
+ * 此方法不检查任何注解，使用前需调用 {@link #isWritable(boolean)} 检查是否可写 + * + * @param bean Bean对象 + * @param value 值，必须与字段值类型匹配 + * @return this + * @since 4.0.5 + */ + public PropDesc setValue(Object bean, Object value) { + if (null != this.setter) { + ReflectUtil.invoke(bean, this.setter, value); + } else if (ModifierUtil.isPublic(this.field)) { + ReflectUtil.setFieldValue(bean, this.field, value); + } + return this; + } + + /** + * 设置属性值，可以自动转换字段类型为目标类型 + * + * @param bean Bean对象 + * @param value 属性值，可以为任意类型 + * @param ignoreNull 是否忽略{@code null}值，true表示忽略 + * @param ignoreError 是否忽略错误，包括转换错误和注入错误 + * @return this + * @since 5.4.2 + */ + public PropDesc setValue(Object bean, Object value, boolean ignoreNull, boolean ignoreError) { + return setValue(bean, value, ignoreNull, ignoreError, true); + } + + /** + * 设置属性值，可以自动转换字段类型为目标类型 + * + * @param bean Bean对象 + * @param value 属性值，可以为任意类型 + * @param ignoreNull 是否忽略{@code null}值，true表示忽略 + * @param ignoreError 是否忽略错误，包括转换错误和注入错误 + * @param override 是否覆盖目标值，如果不覆盖，会先读取bean的值，{@code null}则写，否则忽略。如果覆盖，则不判断直接写 + * @return this + * @since 5.7.17 + */ + public PropDesc setValue(Object bean, Object value, boolean ignoreNull, boolean ignoreError, boolean override) { + if (null == value && ignoreNull) { + return this; + } + + // issue#I4JQ1N@Gitee + // 非覆盖模式下，如果目标值存在，则跳过 + if (false == override && null != getValue(bean)) { + return this; + } + + // 当类型不匹配的时候，执行默认转换 + if (null != value) { + final Class propClass = getFieldClass(); + if (false == propClass.isInstance(value)) { + value = Convert.convertWithCheck(propClass, value, null, ignoreError); + } + } + + // 属性赋值 + if (null != value || false == ignoreNull) { + try { + this.setValue(bean, value); + } catch (Exception e) { + if (false == ignoreError) { + throw new BeanException(e, "Set value of [{}] error!", getFieldName()); + } + // 忽略注入失败 + } + } + + return this; + } + + //------------------------------------------------------------------------------------ Private method start + + /** + * 通过Getter和Setter方法中找到属性类型 + * + * @param getter Getter方法 + * @param setter Setter方法 + * @return {@link Type} + */ + private Type findPropType(Method getter, Method setter) { + Type type = null; + if (null != getter) { + type = TypeUtil.getReturnType(getter); + } + if (null == type && null != setter) { + type = TypeUtil.getParamType(setter, 0); + } + return type; + } + + /** + * 通过Getter和Setter方法中找到属性类型 + * + * @param getter Getter方法 + * @param setter Setter方法 + * @return {@link Type} + */ + private Class findPropClass(Method getter, Method setter) { + Class type = null; + if (null != getter) { + type = TypeUtil.getReturnClass(getter); + } + if (null == type && null != setter) { + type = TypeUtil.getFirstParamClass(setter); + } + return type; + } + + /** + * 检查字段是否被忽略写，通过{@link PropIgnore} 注解完成，规则为： + * 
+	 *     1. 在字段上有{@link PropIgnore} 注解
+	 *     2. 在setXXX方法上有{@link PropIgnore} 注解
+	 *
+ * + * @return 是否忽略写 + * @since 5.4.2 + */ + private boolean isIgnoreSet() { + return AnnotationUtil.hasAnnotation(this.field, PropIgnore.class) + || AnnotationUtil.hasAnnotation(this.setter, PropIgnore.class); + } + + /** + * 检查字段是否被忽略读，通过{@link PropIgnore} 注解完成，规则为： + * 
+	 *     1. 在字段上有{@link PropIgnore} 注解
+	 *     2. 在getXXX方法上有{@link PropIgnore} 注解
+	 *
+ * + * @return 是否忽略读 + * @since 5.4.2 + */ + private boolean isIgnoreGet() { + return AnnotationUtil.hasAnnotation(this.field, PropIgnore.class) + || AnnotationUtil.hasAnnotation(this.getter, PropIgnore.class); + } + + /** + * 字段和Getter方法是否为Transient关键字修饰的 + * + * @return 是否为Transient关键字修饰的 + * @since 5.3.11 + */ + private boolean isTransientForGet() { + boolean isTransient = ModifierUtil.hasModifier(this.field, ModifierUtil.ModifierType.TRANSIENT); + + // 检查Getter方法 + if (false == isTransient && null != this.getter) { + isTransient = ModifierUtil.hasModifier(this.getter, ModifierUtil.ModifierType.TRANSIENT); + + // 检查注解 + if (false == isTransient) { + isTransient = AnnotationUtil.hasAnnotation(this.getter, Transient.class); + } + } + + return isTransient; + } + + /** + * 字段和Getter方法是否为Transient关键字修饰的 + * + * @return 是否为Transient关键字修饰的 + * @since 5.3.11 + */ + private boolean isTransientForSet() { + boolean isTransient = ModifierUtil.hasModifier(this.field, ModifierUtil.ModifierType.TRANSIENT); + + // 检查Getter方法 + if (false == isTransient && null != this.setter) { + isTransient = ModifierUtil.hasModifier(this.setter, ModifierUtil.ModifierType.TRANSIENT); + + // 检查注解 + if (false == isTransient) { + isTransient = AnnotationUtil.hasAnnotation(this.setter, Transient.class); + } + } + + return isTransient; + } + //------------------------------------------------------------------------------------ Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/AbsCopier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/AbsCopier.java new file mode 100755 index 0000000..fb0619f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/AbsCopier.java @@ -0,0 +1,28 @@ +package aiyh.utils.tool.cn.hutool.core.bean.copier; + +import aiyh.utils.tool.cn.hutool.core.lang.copier.Copier; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +/** + * 抽象的对象拷贝封装，提供来源对象、目标对象持有 + * + * @param 来源对象类型 + * @param 目标对象类型 + * @author looly + * @since 5.8.0 + */ +public abstract class AbsCopier implements Copier { + + protected final S source; + protected final T target; + /** + * 拷贝选项 + */ + protected final CopyOptions copyOptions; + + public AbsCopier(S source, T target, CopyOptions copyOptions) { + this.source = source; + this.target = target; + this.copyOptions = ObjectUtil.defaultIfNull(copyOptions, CopyOptions::create); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/BeanCopier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/BeanCopier.java new file mode 100755 index 0000000..032d6f8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/BeanCopier.java @@ -0,0 +1,94 @@ +package aiyh.utils.tool.cn.hutool.core.bean.copier; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.copier.Copier; + +import java.io.Serializable; +import java.lang.reflect.Type; +import java.util.Map; + +/** + * Bean拷贝，提供： + * + * 
+ *     1. Bean 转 Bean
+ *     2. Bean 转 Map
+ *     3. Map  转 Bean
+ *     4. Map  转 Map
+ *
+ * + * @author looly + * + * @param 目标对象类型 + * @since 3.2.3 + */ +public class BeanCopier implements Copier, Serializable { + private static final long serialVersionUID = 1L; + + private final Copier copier; + + /** + * 创建BeanCopier + * + * @param 目标Bean类型 + * @param source 来源对象，可以是Bean或者Map + * @param target 目标Bean对象 + * @param copyOptions 拷贝属性选项 + * @return BeanCopier + */ + public static BeanCopier create(Object source, T target, CopyOptions copyOptions) { + return create(source, target, target.getClass(), copyOptions); + } + + /** + * 创建BeanCopier + * + * @param 目标Bean类型 + * @param source 来源对象，可以是Bean或者Map + * @param target 目标Bean对象 + * @param destType 目标的泛型类型，用于标注有泛型参数的Bean对象 + * @param copyOptions 拷贝属性选项 + * @return BeanCopier + */ + public static BeanCopier create(Object source, T target, Type destType, CopyOptions copyOptions) { + return new BeanCopier<>(source, target, destType, copyOptions); + } + + /** + * 构造 + * + * @param source 来源对象，可以是Bean或者Map + * @param target 目标Bean对象 + * @param targetType 目标的泛型类型，用于标注有泛型参数的Bean对象 + * @param copyOptions 拷贝属性选项 + */ + public BeanCopier(Object source, T target, Type targetType, CopyOptions copyOptions) { + Assert.notNull(source, "Source bean must be not null!"); + Assert.notNull(target, "Target bean must be not null!"); + Copier copier; + if (source instanceof Map) { + if (target instanceof Map) { + //noinspection unchecked + copier = (Copier) new MapToMapCopier((Map) source, (Map) target, targetType, copyOptions); + } else { + copier = new MapToBeanCopier<>((Map) source, target, targetType, copyOptions); + } + }else if(source instanceof ValueProvider){ + //noinspection unchecked + copier = new ValueProviderToBeanCopier<>((ValueProvider) source, target, targetType, copyOptions); + } else { + if (target instanceof Map) { + //noinspection unchecked + copier = (Copier) new BeanToMapCopier(source, (Map) target, targetType, copyOptions); + } else { + copier = new BeanToBeanCopier<>(source, target, targetType, copyOptions); + } + } + this.copier = copier; + } + + @Override + public T copy() { + return copier.copy(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/BeanToBeanCopier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/BeanToBeanCopier.java new file mode 100755 index 0000000..4309ece --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/BeanToBeanCopier.java @@ -0,0 +1,91 @@ +package aiyh.utils.tool.cn.hutool.core.bean.copier; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.bean.PropDesc; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +import java.lang.reflect.Type; +import java.util.Map; + +/** + * Bean属性拷贝到Bean中的拷贝器 + * + * @param 源Bean类型 + * @param 目标Bean类型 + * @since 5.8.0 + */ +public class BeanToBeanCopier extends AbsCopier { + + /** + * 目标的类型（用于泛型类注入） + */ + private final Type targetType; + + /** + * 构造 + * + * @param source 来源Map + * @param target 目标Bean对象 + * @param targetType 目标泛型类型 + * @param copyOptions 拷贝选项 + */ + public BeanToBeanCopier(S source, T target, Type targetType, CopyOptions copyOptions) { + super(source, target, copyOptions); + this.targetType = targetType; + } + + @Override + public T copy() { + Class actualEditable = target.getClass(); + if (null != copyOptions.editable) { + // 检查限制类是否为target的父类或接口 + Assert.isTrue(copyOptions.editable.isInstance(target), + "Target class [{}] not assignable to Editable class [{}]", actualEditable.getName(), copyOptions.editable.getName()); + actualEditable = copyOptions.editable; + } + final Map targetPropDescMap = BeanUtil.getBeanDesc(actualEditable).getPropMap(copyOptions.ignoreCase); + + final Map sourcePropDescMap = BeanUtil.getBeanDesc(source.getClass()).getPropMap(copyOptions.ignoreCase); + sourcePropDescMap.forEach((sFieldName, sDesc) -> { + if (null == sFieldName || false == sDesc.isReadable(copyOptions.transientSupport)) { + // 字段空或不可读，跳过 + return; + } + + sFieldName = copyOptions.editFieldName(sFieldName); + // 对key做转换，转换后为null的跳过 + if (null == sFieldName) { + return; + } + + // 忽略不需要拷贝的 key, + if (false == copyOptions.testKeyFilter(sFieldName)) { + return; + } + + // 检查目标字段可写性 + final PropDesc tDesc = targetPropDescMap.get(sFieldName); + if (null == tDesc || false == tDesc.isWritable(this.copyOptions.transientSupport)) { + // 字段不可写，跳过之 + return; + } + + // 检查源对象属性是否过滤属性 + Object sValue = sDesc.getValue(this.source); + if (false == copyOptions.testPropertyFilter(sDesc.getField(), sValue)) { + return; + } + + // 获取目标字段真实类型并转换源值 + final Type fieldType = TypeUtil.getActualType(this.targetType, tDesc.getFieldType()); + //sValue = Convert.convertWithCheck(fieldType, sValue, null, this.copyOptions.ignoreError); + sValue = this.copyOptions.convertField(fieldType, sValue); + sValue = copyOptions.editFieldValue(sFieldName, sValue); + + // 目标赋值 + tDesc.setValue(this.target, sValue, copyOptions.ignoreNullValue, copyOptions.ignoreError, copyOptions.override); + }); + return this.target; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/BeanToMapCopier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/BeanToMapCopier.java new file mode 100755 index 0000000..e7a74cf --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/BeanToMapCopier.java @@ -0,0 +1,87 @@ +package aiyh.utils.tool.cn.hutool.core.bean.copier; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.bean.PropDesc; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +import java.lang.reflect.Type; +import java.util.Map; + +/** + * Bean属性拷贝到Map中的拷贝器 + * + * @since 5.8.0 + */ +@SuppressWarnings("rawtypes") +public class BeanToMapCopier extends AbsCopier { + + /** + * 目标的Map类型（用于泛型类注入） + */ + private final Type targetType; + + /** + * 构造 + * + * @param source 来源Map + * @param target 目标Map对象 + * @param targetType 目标泛型类型 + * @param copyOptions 拷贝选项 + */ + public BeanToMapCopier(Object source, Map target, Type targetType, CopyOptions copyOptions) { + super(source, target, copyOptions); + this.targetType = targetType; + } + + @Override + public Map copy() { + Class actualEditable = source.getClass(); + if (null != copyOptions.editable) { + // 检查限制类是否为target的父类或接口 + Assert.isTrue(copyOptions.editable.isInstance(source), + "Source class [{}] not assignable to Editable class [{}]", actualEditable.getName(), copyOptions.editable.getName()); + actualEditable = copyOptions.editable; + } + + final Map sourcePropDescMap = BeanUtil.getBeanDesc(actualEditable).getPropMap(copyOptions.ignoreCase); + sourcePropDescMap.forEach((sFieldName, sDesc) -> { + if (null == sFieldName || false == sDesc.isReadable(copyOptions.transientSupport)) { + // 字段空或不可读，跳过 + return; + } + + sFieldName = copyOptions.editFieldName(sFieldName); + // 对key做转换，转换后为null的跳过 + if (null == sFieldName) { + return; + } + + // 忽略不需要拷贝的 key, + if (false == copyOptions.testKeyFilter(sFieldName)) { + return; + } + + // 检查源对象属性是否过滤属性 + Object sValue = sDesc.getValue(this.source); + if (false == copyOptions.testPropertyFilter(sDesc.getField(), sValue)) { + return; + } + + // 获取目标值真实类型并转换源值 + final Type[] typeArguments = TypeUtil.getTypeArguments(this.targetType); + if(null != typeArguments){ + //sValue = Convert.convertWithCheck(typeArguments[1], sValue, null, this.copyOptions.ignoreError); + sValue = this.copyOptions.convertField(typeArguments[1], sValue); + sValue = copyOptions.editFieldValue(sFieldName, sValue); + } + + // 目标赋值 + if(null != sValue || false == copyOptions.ignoreNullValue){ + //noinspection unchecked + target.put(sFieldName, sValue); + } + }); + return this.target; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/CopyOptions.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/CopyOptions.java new file mode 100755 index 0000000..c7dea16 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/CopyOptions.java @@ -0,0 +1,383 @@ +package aiyh.utils.tool.cn.hutool.core.bean.copier; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.convert.TypeConverter; +import aiyh.utils.tool.cn.hutool.core.lang.Editor; +import aiyh.utils.tool.cn.hutool.core.lang.func.Func1; +import aiyh.utils.tool.cn.hutool.core.lang.func.LambdaUtil; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; + +import java.io.Serializable; +import java.lang.reflect.Field; +import java.lang.reflect.Type; +import java.util.Map; +import java.util.Set; +import java.util.function.BiFunction; +import java.util.function.BiPredicate; + +/** + * 属性拷贝选项
+ * 包括：
+ * 1、限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
+ * 2、是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
+ * 3、忽略的属性列表，设置一个属性列表，不拷贝这些属性值
+ * + * @author Looly + */ +public class CopyOptions implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
+ * 如果目标对象是Map，源对象是Bean，则作用于源对象上 + */ + protected Class editable; + /** + * 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null + */ + protected boolean ignoreNullValue; + /** + * 属性过滤器，断言通过的属性才会被复制
+ * 断言参数中Field为源对象的字段对象,如果源对象为Map，使用目标对象，Object为源对象的对应值 + */ + private BiPredicate propertiesFilter; + /** + * 是否忽略字段注入错误 + */ + protected boolean ignoreError; + /** + * 是否忽略字段大小写 + */ + protected boolean ignoreCase; + /** + * 字段属性编辑器，用于自定义属性转换规则，例如驼峰转下划线等
+ * 规则为，{@link Editor#edit(Object)}属性为源对象的字段名称或key，返回值为目标对象的字段名称或key + */ + private Editor fieldNameEditor; + /** + * 字段属性值编辑器，用于自定义属性值转换规则，例如null转""等 + */ + protected BiFunction fieldValueEditor; + /** + * 是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。 + */ + protected boolean transientSupport = true; + /** + * 是否覆盖目标值，如果不覆盖，会先读取目标对象的值，非{@code null}则写，否则忽略。如果覆盖，则不判断直接写 + */ + protected boolean override = true; + + /** + * 源对象和目标对象都是 {@code Map} 时, 需要忽略的源对象 {@code Map} key + */ + private Set ignoreKeySet; + + /** + * 自定义类型转换器，默认使用全局万能转换器转换 + */ + protected TypeConverter converter = (type, value) -> { + if(null == value){ + return null; + } + + final String name = value.getClass().getName(); + if(ArrayUtil.contains(new String[]{"cn.hutool.json.JSONObject", "cn.hutool.json.JSONArray"}, name)){ + // 由于设计缺陷导致JSON转Bean时无法使用自定义的反序列化器，此处采用反射方式修复bug，此类问题会在6.x解决 + return ReflectUtil.invoke(value, "toBean", ObjectUtil.defaultIfNull(type, Object.class)); + } + + return Convert.convertWithCheck(type, value, null, ignoreError); + }; + + //region create + + /** + * 创建拷贝选项 + * + * @return 拷贝选项 + */ + public static CopyOptions create() { + return new CopyOptions(); + } + + /** + * 创建拷贝选项 + * + * @param editable 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性 + * @param ignoreNullValue 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null + * @param ignoreProperties 忽略的属性列表，设置一个属性列表，不拷贝这些属性值 + * @return 拷贝选项 + */ + public static CopyOptions create(Class editable, boolean ignoreNullValue, String... ignoreProperties) { + return new CopyOptions(editable, ignoreNullValue, ignoreProperties); + } + //endregion + + /** + * 构造拷贝选项 + */ + public CopyOptions() { + } + + /** + * 构造拷贝选项 + * + * @param editable 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性 + * @param ignoreNullValue 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null + * @param ignoreProperties 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值 + */ + public CopyOptions(Class editable, boolean ignoreNullValue, String... ignoreProperties) { + this.propertiesFilter = (f, v) -> true; + this.editable = editable; + this.ignoreNullValue = ignoreNullValue; + this.setIgnoreProperties(ignoreProperties); + } + + /** + * 设置限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性 + * + * @param editable 限制的类或接口 + * @return CopyOptions + */ + public CopyOptions setEditable(Class editable) { + this.editable = editable; + return this; + } + + /** + * 设置是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null + * + * @param ignoreNullVall 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null + * @return CopyOptions + */ + public CopyOptions setIgnoreNullValue(boolean ignoreNullVall) { + this.ignoreNullValue = ignoreNullVall; + return this; + } + + /** + * 设置忽略空值，当源对象的值为null时，忽略而不注入此值 + * + * @return CopyOptions + * @since 4.5.7 + */ + public CopyOptions ignoreNullValue() { + return setIgnoreNullValue(true); + } + + /** + * 属性过滤器，断言通过的属性才会被复制
+ * {@link BiPredicate#test(Object, Object)}返回{@code true}则属性通过，{@code false}不通过，抛弃之 + * + * @param propertiesFilter 属性过滤器 + * @return CopyOptions + */ + public CopyOptions setPropertiesFilter(BiPredicate propertiesFilter) { + this.propertiesFilter = propertiesFilter; + return this; + } + + /** + * 设置忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值 + * + * @param ignoreProperties 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值 + * @return CopyOptions + */ + public CopyOptions setIgnoreProperties(String... ignoreProperties) { + this.ignoreKeySet = CollUtil.newHashSet(ignoreProperties); + return this; + } + + /** + * 设置忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值，Lambda方式 + * + * @param

参数类型 + * @param 返回值类型 + * @param funcs 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值 + * @return CopyOptions + * @since 5.8.0 + */ + @SuppressWarnings("unchecked") + public CopyOptions setIgnoreProperties(Func1... funcs) { + this.ignoreKeySet = ArrayUtil.mapToSet(funcs, LambdaUtil::getFieldName); + return this; + } + + /** + * 设置是否忽略字段的注入错误 + * + * @param ignoreError 是否忽略注入错误 + * @return CopyOptions + */ + public CopyOptions setIgnoreError(boolean ignoreError) { + this.ignoreError = ignoreError; + return this; + } + + /** + * 设置忽略字段的注入错误 + * + * @return CopyOptions + * @since 4.5.7 + */ + public CopyOptions ignoreError() { + return setIgnoreError(true); + } + + /** + * 设置是否忽略字段的大小写 + * + * @param ignoreCase 是否忽略大小写 + * @return CopyOptions + */ + public CopyOptions setIgnoreCase(boolean ignoreCase) { + this.ignoreCase = ignoreCase; + return this; + } + + /** + * 设置忽略字段的大小写 + * + * @return CopyOptions + * @since 4.5.7 + */ + public CopyOptions ignoreCase() { + return setIgnoreCase(true); + } + + /** + * 设置拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用
+ * 需要注意的是，当使用ValueProvider作为数据提供者时，这个映射是相反的，即fieldMapping中key为目标Bean的名称，而value是提供者中的key + * + * @param fieldMapping 拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用 + * @return CopyOptions + */ + public CopyOptions setFieldMapping(Map fieldMapping) { + return setFieldNameEditor((key -> fieldMapping.getOrDefault(key, key))); + } + + /** + * 设置字段属性编辑器，用于自定义属性转换规则，例如驼峰转下划线等
+ * 此转换器只针对源端的字段做转换，请确认转换后与目标端字段一致
+ * 当转换后的字段名为null时忽略这个字段
+ * 需要注意的是，当使用ValueProvider作为数据提供者时，这个映射是相反的，即fieldMapping中key为目标Bean的名称，而value是提供者中的key + * + * @param fieldNameEditor 字段属性编辑器，用于自定义属性转换规则，例如驼峰转下划线等 + * @return CopyOptions + * @since 5.4.2 + */ + public CopyOptions setFieldNameEditor(Editor fieldNameEditor) { + this.fieldNameEditor = fieldNameEditor; + return this; + } + + /** + * 设置字段属性值编辑器，用于自定义属性值转换规则，例如null转""等
+ * + * @param fieldValueEditor 字段属性值编辑器，用于自定义属性值转换规则，例如null转""等 + * @return CopyOptions + * @since 5.7.15 + */ + public CopyOptions setFieldValueEditor(BiFunction fieldValueEditor) { + this.fieldValueEditor = fieldValueEditor; + return this; + } + + /** + * 编辑字段值 + * + * @param fieldName 字段名 + * @param fieldValue 字段值 + * @return 编辑后的字段值 + * @since 5.7.15 + */ + protected Object editFieldValue(String fieldName, Object fieldValue) { + return (null != this.fieldValueEditor) ? + this.fieldValueEditor.apply(fieldName, fieldValue) : fieldValue; + } + + /** + * 设置是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。 + * + * @param transientSupport 是否支持 + * @return this + * @since 5.4.2 + */ + public CopyOptions setTransientSupport(boolean transientSupport) { + this.transientSupport = transientSupport; + return this; + } + + /** + * 设置是否覆盖目标值，如果不覆盖，会先读取目标对象的值，为{@code null}则写，否则忽略。如果覆盖，则不判断直接写 + * + * @param override 是否覆盖目标值 + * @return this + * @since 5.7.17 + */ + public CopyOptions setOverride(boolean override) { + this.override = override; + return this; + } + + /** + * 设置自定义类型转换器，默认使用全局万能转换器转换。 + * + * @param converter 转换器 + * @return this + * @since 5.8.0 + */ + public CopyOptions setConverter(TypeConverter converter) { + this.converter = converter; + return this; + } + + /** + * 使用自定义转换器转换字段值
+ * 如果自定义转换器为{@code null}，则返回原值。 + * + * @param targetType 目标类型 + * @param fieldValue 字段值 + * @return 编辑后的字段值 + * @since 5.8.0 + */ + protected Object convertField(Type targetType, Object fieldValue) { + return (null != this.converter) ? + this.converter.convert(targetType, fieldValue) : fieldValue; + } + + /** + * 转换字段名为编辑后的字段名 + * + * @param fieldName 字段名 + * @return 编辑后的字段名 + * @since 5.4.2 + */ + protected String editFieldName(String fieldName) { + return (null != this.fieldNameEditor) ? this.fieldNameEditor.edit(fieldName) : fieldName; + } + + /** + * 测试是否保留字段，{@code true}保留，{@code false}不保留 + * + * @param field 字段 + * @param value 值 + * @return 是否保留 + */ + protected boolean testPropertyFilter(Field field, Object value) { + return null == this.propertiesFilter || this.propertiesFilter.test(field, value); + } + + /** + * 测试是否保留key, {@code true} 不保留， {@code false} 保留 + * + * @param key {@link Map} key + * @return 是否保留 + */ + protected boolean testKeyFilter(Object key) { + return CollUtil.isEmpty(this.ignoreKeySet) || false == this.ignoreKeySet.contains(key); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/MapToBeanCopier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/MapToBeanCopier.java new file mode 100755 index 0000000..3cd64e2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/MapToBeanCopier.java @@ -0,0 +1,130 @@ +package aiyh.utils.tool.cn.hutool.core.bean.copier; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.bean.PropDesc; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.map.CaseInsensitiveMap; +import aiyh.utils.tool.cn.hutool.core.map.MapWrapper; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +import java.lang.reflect.Type; +import java.util.Map; + +/** + * Map属性拷贝到Bean中的拷贝器 + * + * @param 目标Bean类型 + * @since 5.8.0 + */ +public class MapToBeanCopier extends AbsCopier, T> { + + /** + * 目标的类型（用于泛型类注入） + */ + private final Type targetType; + + /** + * 构造 + * + * @param source 来源Map + * @param target 目标Bean对象 + * @param targetType 目标泛型类型 + * @param copyOptions 拷贝选项 + */ + public MapToBeanCopier(Map source, T target, Type targetType, CopyOptions copyOptions) { + super(source, target, copyOptions); + + // 针对MapWrapper特殊处理，提供的Map包装了忽略大小写的Map，则默认转Bean的时候也忽略大小写，如JSONObject + if(source instanceof MapWrapper){ + final Map raw = ((MapWrapper) source).getRaw(); + if(raw instanceof CaseInsensitiveMap){ + copyOptions.setIgnoreCase(true); + } + } + + this.targetType = targetType; + } + + @Override + public T copy() { + Class actualEditable = target.getClass(); + if (null != copyOptions.editable) { + // 检查限制类是否为target的父类或接口 + Assert.isTrue(copyOptions.editable.isInstance(target), + "Target class [{}] not assignable to Editable class [{}]", actualEditable.getName(), copyOptions.editable.getName()); + actualEditable = copyOptions.editable; + } + final Map targetPropDescMap = BeanUtil.getBeanDesc(actualEditable).getPropMap(copyOptions.ignoreCase); + + this.source.forEach((sKey, sValue) -> { + if (null == sKey) { + return; + } + String sKeyStr = copyOptions.editFieldName(sKey.toString()); + // 对key做转换，转换后为null的跳过 + if (null == sKeyStr) { + return; + } + + // 忽略不需要拷贝的 key, + if (false == copyOptions.testKeyFilter(sKeyStr)) { + return; + } + + // 检查目标字段可写性 + final PropDesc tDesc = findPropDesc(targetPropDescMap, sKeyStr); + if (null == tDesc || false == tDesc.isWritable(this.copyOptions.transientSupport)) { + // 字段不可写，跳过之 + return; + } + sKeyStr = tDesc.getFieldName(); + + // 检查目标是否过滤属性 + if (false == copyOptions.testPropertyFilter(tDesc.getField(), sValue)) { + return; + } + + // 获取目标字段真实类型并转换源值 + final Type fieldType = TypeUtil.getActualType(this.targetType, tDesc.getFieldType()); + //Object newValue = Convert.convertWithCheck(fieldType, sValue, null, this.copyOptions.ignoreError); + Object newValue = this.copyOptions.convertField(fieldType, sValue); + newValue = copyOptions.editFieldValue(sKeyStr, newValue); + + // 目标赋值 + tDesc.setValue(this.target, newValue, copyOptions.ignoreNullValue, copyOptions.ignoreError, copyOptions.override); + }); + return this.target; + } + + /** + * 查找Map对应Bean的名称
+ * 尝试原名称、转驼峰名称、isXxx去掉is的名称 + * + * @param targetPropDescMap 目标bean的属性描述Map + * @param sKeyStr 键或字段名 + * @return {@link PropDesc} + */ + private PropDesc findPropDesc(Map targetPropDescMap, String sKeyStr){ + PropDesc propDesc = targetPropDescMap.get(sKeyStr); + if(null != propDesc){ + return propDesc; + } + + // 转驼峰尝试查找 + sKeyStr = StrUtil.toCamelCase(sKeyStr); + propDesc = targetPropDescMap.get(sKeyStr); + if(null != propDesc){ + return propDesc; + } + + // boolean类型参数名转换尝试查找 + if(sKeyStr.startsWith("is")){ + sKeyStr = StrUtil.removePreAndLowerFirst(sKeyStr, 2); + propDesc = targetPropDescMap.get(sKeyStr); + return propDesc; + } + + return null; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/MapToMapCopier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/MapToMapCopier.java new file mode 100755 index 0000000..31047d8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/MapToMapCopier.java @@ -0,0 +1,75 @@ +package aiyh.utils.tool.cn.hutool.core.bean.copier; + +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +import java.lang.reflect.Type; +import java.util.Map; + +/** + * Map属性拷贝到Map中的拷贝器 + * + * @since 5.8.0 + */ +@SuppressWarnings({"rawtypes", "unchecked"}) +public class MapToMapCopier extends AbsCopier { + + /** + * 目标的类型（用于泛型类注入） + */ + private final Type targetType; + + /** + * 构造 + * + * @param source 来源Map + * @param target 目标Bean对象 + * @param targetType 目标泛型类型 + * @param copyOptions 拷贝选项 + */ + public MapToMapCopier(Map source, Map target, Type targetType, CopyOptions copyOptions) { + super(source, target, copyOptions); + this.targetType = targetType; + } + + @Override + public Map copy() { + this.source.forEach((sKey, sValue) -> { + if (null == sKey) { + return; + } + // 忽略空值 + if (true == copyOptions.ignoreNullValue && sValue == null) { + return; + } + + final String sKeyStr = copyOptions.editFieldName(sKey.toString()); + // 对key做转换，转换后为null的跳过 + if (null == sKeyStr) { + return; + } + + // 忽略不需要拷贝的 key, + if (false == copyOptions.testKeyFilter(sKeyStr)) { + return; + } + + final Object targetValue = target.get(sKeyStr); + // 非覆盖模式下，如果目标值存在，则跳过 + if (false == copyOptions.override && null != targetValue) { + return; + } + + // 获取目标值真实类型并转换源值 + final Type[] typeArguments = TypeUtil.getTypeArguments(this.targetType); + if (null != typeArguments) { + //sValue = Convert.convertWithCheck(typeArguments[1], sValue, null, this.copyOptions.ignoreError); + sValue = this.copyOptions.convertField(typeArguments[1], sValue); + sValue = copyOptions.editFieldValue(sKeyStr, sValue); + } + + // 目标赋值 + target.put(sKeyStr, sValue); + }); + return this.target; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/ValueProvider.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/ValueProvider.java new file mode 100644 index 0000000..3f22b73 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/ValueProvider.java @@ -0,0 +1,34 @@ +package aiyh.utils.tool.cn.hutool.core.bean.copier; + +import java.lang.reflect.Type; + +/** + * 值提供者，用于提供Bean注入时参数对应值得抽象接口
+ * 继承或匿名实例化此接口
+ * 在Bean注入过程中，Bean获得字段名，通过外部方式根据这个字段名查找相应的字段值，然后注入Bean
+ * + * @author Looly + * @param KEY类型，一般情况下为 {@link String} + * + */ +public interface ValueProvider{ + + /** + * 获取值
+ * 返回值一般需要匹配被注入类型，如果不匹配会调用默认转换 Convert#convert(Type, Object)实现转换 + * + * @param key Bean对象中参数名 + * @param valueType 被注入的值的类型 + * @return 对应参数名的值 + */ + Object value(T key, Type valueType); + + /** + * 是否包含指定KEY，如果不包含则忽略注入
+ * 此接口方法单独需要实现的意义在于：有些值提供者（比如Map）key是存在的，但是value为null，此时如果需要注入这个null，需要根据此方法判断 + * + * @param key Bean对象中参数名 + * @return 是否包含指定KEY + */ + boolean containsKey(T key); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/ValueProviderToBeanCopier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/ValueProviderToBeanCopier.java new file mode 100755 index 0000000..63a96c8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/ValueProviderToBeanCopier.java @@ -0,0 +1,89 @@ +package aiyh.utils.tool.cn.hutool.core.bean.copier; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.bean.PropDesc; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +import java.lang.reflect.Type; +import java.util.Map; + +/** + * {@link ValueProvider}属性拷贝到Bean中的拷贝器 + * + * @param 目标Bean类型 + * @since 5.8.0 + */ +public class ValueProviderToBeanCopier extends AbsCopier, T> { + + /** + * 目标的类型（用于泛型类注入） + */ + private final Type targetType; + + /** + * 构造 + * + * @param source 来源Map + * @param target 目标Bean对象 + * @param targetType 目标泛型类型 + * @param copyOptions 拷贝选项 + */ + public ValueProviderToBeanCopier(ValueProvider source, T target, Type targetType, CopyOptions copyOptions) { + super(source, target, copyOptions); + this.targetType = targetType; + } + + @Override + public T copy() { + Class actualEditable = target.getClass(); + if (null != copyOptions.editable) { + // 检查限制类是否为target的父类或接口 + Assert.isTrue(copyOptions.editable.isInstance(target), + "Target class [{}] not assignable to Editable class [{}]", actualEditable.getName(), copyOptions.editable.getName()); + actualEditable = copyOptions.editable; + } + final Map targetPropDescMap = BeanUtil.getBeanDesc(actualEditable).getPropMap(copyOptions.ignoreCase); + + targetPropDescMap.forEach((tFieldName, tDesc) -> { + if (null == tFieldName) { + return; + } + tFieldName = copyOptions.editFieldName(tFieldName); + // 对key做转换，转换后为null的跳过 + if (null == tFieldName) { + return; + } + + // 无字段内容跳过 + if(false == source.containsKey(tFieldName)){ + return; + } + + // 忽略不需要拷贝的 key, + if (false == copyOptions.testKeyFilter(tFieldName)) { + return; + } + + // 检查目标字段可写性 + if (null == tDesc || false == tDesc.isWritable(this.copyOptions.transientSupport)) { + // 字段不可写，跳过之 + return; + } + + // 获取目标字段真实类型 + final Type fieldType = TypeUtil.getActualType(this.targetType ,tDesc.getFieldType()); + + // 检查目标对象属性是否过滤属性 + Object sValue = source.value(tFieldName, fieldType); + if (false == copyOptions.testPropertyFilter(tDesc.getField(), sValue)) { + return; + } + sValue = copyOptions.editFieldValue(tFieldName, sValue); + + // 目标赋值 + tDesc.setValue(this.target, sValue, copyOptions.ignoreNullValue, copyOptions.ignoreError, copyOptions.override); + }); + return this.target; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/package-info.java new file mode 100644 index 0000000..ee34087 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/package-info.java @@ -0,0 +1,7 @@ +/** + * Bean拷贝实现，包括拷贝选项等 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.bean.copier; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/provider/BeanValueProvider.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/provider/BeanValueProvider.java new file mode 100644 index 0000000..2ae55b7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/provider/BeanValueProvider.java @@ -0,0 +1,100 @@ +package aiyh.utils.tool.cn.hutool.core.bean.copier.provider; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.bean.PropDesc; +import aiyh.utils.tool.cn.hutool.core.bean.copier.ValueProvider; +import aiyh.utils.tool.cn.hutool.core.lang.Editor; +import aiyh.utils.tool.cn.hutool.core.map.FuncKeyMap; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.lang.reflect.Type; +import java.util.HashMap; +import java.util.Map; +import java.util.function.Function; + +/** + * Bean的值提供者 + * + * @author looly + */ +public class BeanValueProvider implements ValueProvider { + + private final Object source; + private final boolean ignoreError; + final Map sourcePdMap; + + /** + * 构造 + * + * @param bean Bean + * @param ignoreCase 是否忽略字段大小写 + * @param ignoreError 是否忽略字段值读取错误 + */ + public BeanValueProvider(Object bean, boolean ignoreCase, boolean ignoreError) { + this(bean, ignoreCase, ignoreError, null); + } + + /** + * 构造 + * + * @param bean Bean + * @param ignoreCase 是否忽略字段大小写 + * @param ignoreError 是否忽略字段值读取错误 + * @param keyEditor 键编辑器 + */ + public BeanValueProvider(Object bean, boolean ignoreCase, boolean ignoreError, Editor keyEditor) { + this.source = bean; + this.ignoreError = ignoreError; + final Map sourcePdMap = BeanUtil.getBeanDesc(source.getClass()).getPropMap(ignoreCase); + // issue#2202@Github + // 如果用户定义了键编辑器，则提供的map中的数据必须全部转换key + // issue#I5VRHW@Gitee 使Function可以被序列化 + this.sourcePdMap = new FuncKeyMap<>(new HashMap<>(sourcePdMap.size(), 1), (Function & Serializable)(key) -> { + if (ignoreCase && key instanceof CharSequence) { + key = key.toString().toLowerCase(); + } + if (null != keyEditor) { + key = keyEditor.edit(key.toString()); + } + return key.toString(); + }); + this.sourcePdMap.putAll(sourcePdMap); + } + + @Override + public Object value(String key, Type valueType) { + final PropDesc sourcePd = getPropDesc(key, valueType); + + Object result = null; + if (null != sourcePd) { + result = sourcePd.getValue(this.source, valueType, this.ignoreError); + } + return result; + } + + @Override + public boolean containsKey(String key) { + final PropDesc sourcePd = getPropDesc(key, null); + + // 字段描述不存在或忽略读的情况下，表示不存在 + return null != sourcePd && sourcePd.isReadable(false); + } + + /** + * 获得属性描述 + * + * @param key 字段名 + * @param valueType 值类型，用于判断是否为Boolean，可以为null + * @return 属性描述 + */ + private PropDesc getPropDesc(String key, Type valueType) { + PropDesc sourcePd = sourcePdMap.get(key); + if (null == sourcePd && (null == valueType || Boolean.class == valueType || boolean.class == valueType)) { + //boolean类型字段字段名支持两种方式 + sourcePd = sourcePdMap.get(StrUtil.upperFirstAndAddPre(key, "is")); + } + + return sourcePd; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/provider/DynaBeanValueProvider.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/provider/DynaBeanValueProvider.java new file mode 100644 index 0000000..506dc17 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/provider/DynaBeanValueProvider.java @@ -0,0 +1,42 @@ +package aiyh.utils.tool.cn.hutool.core.bean.copier.provider; + +import aiyh.utils.tool.cn.hutool.core.bean.DynaBean; +import aiyh.utils.tool.cn.hutool.core.bean.copier.ValueProvider; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; + +import java.lang.reflect.Type; + +/** + * DynaBean值提供者 + * + * @author looly + * @since 5.4.2 + */ +public class DynaBeanValueProvider implements ValueProvider { + + private final DynaBean dynaBean; + private final boolean ignoreError; + + /** + * 构造 + * + * @param dynaBean DynaBean + * @param ignoreError 是否忽略错误 + */ + public DynaBeanValueProvider(DynaBean dynaBean, boolean ignoreError) { + this.dynaBean = dynaBean; + this.ignoreError = ignoreError; + } + + @Override + public Object value(String key, Type valueType) { + final Object value = dynaBean.get(key); + return Convert.convertWithCheck(valueType, value, null, this.ignoreError); + } + + @Override + public boolean containsKey(String key) { + return dynaBean.containsProp(key); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/provider/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/provider/package-info.java new file mode 100644 index 0000000..097e12a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/copier/provider/package-info.java @@ -0,0 +1,7 @@ +/** + * Bean值提供者方式封装 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.bean.copier.provider; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/package-info.java new file mode 100644 index 0000000..5558619 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/bean/package-info.java @@ -0,0 +1,7 @@ +/** + * Bean相关操作，包括Bean信息描述，Bean路径表达式、动态Bean、Bean工具等 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.bean; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/Builder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/Builder.java new file mode 100644 index 0000000..4f3e641 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/Builder.java @@ -0,0 +1,19 @@ +package aiyh.utils.tool.cn.hutool.core.builder; + +import java.io.Serializable; + +/** + * 建造者模式接口定义 + * + * @param 建造对象类型 + * @author Looly + * @since 4.2.2 + */ +public interface Builder extends Serializable{ + /** + * 构建 + * + * @return 被构建的对象 + */ + T build(); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/CompareToBuilder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/CompareToBuilder.java new file mode 100644 index 0000000..975c977 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/CompareToBuilder.java @@ -0,0 +1,975 @@ +package aiyh.utils.tool.cn.hutool.core.builder; + +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; + +import java.lang.reflect.AccessibleObject; +import java.lang.reflect.Field; +import java.lang.reflect.Modifier; +import java.util.Collection; +import java.util.Comparator; + +/** + * 用于构建 {@link java.lang.Comparable#compareTo(Object)} 方法的辅助工具 + * + *

+ * 在Bean对象中，所有相关字段都参与比对，继承的字段不参与。使用方法如下： + * + * 

+ * public class MyClass {
+ *   String field1;
+ *   int field2;
+ *   boolean field3;
+ *
+ *   ...
+ *
+ *   public int compareTo(Object o) {
+ *     MyClass myClass = (MyClass) o;
+ *     return new CompareToBuilder()
+ *       .appendSuper(super.compareTo(o)
+ *       .append(this.field1, myClass.field1)
+ *       .append(this.field2, myClass.field2)
+ *       .append(this.field3, myClass.field3)
+ *       .toComparison();
+ *   }
+ * }
+ *
+ * + * 字段值按照顺序比较，如果某个字段返回非0结果，比较终止，使用{@code toComparison()}返回结果，后续比较忽略。 + * + *

+ * 也可以使用{@link #reflectionCompare(Object, Object) reflectionCompare} 方法通过反射比较字段，使用方法如下： + * + * 

+ * public int compareTo(Object o) {
+ *   return CompareToBuilder.reflectionCompare(this, o);
+ * }
+ *
+ * + *TODO 待整理 + * 来自于Apache-Commons-Lang3 + * @author looly，Apache-Commons + * @since 4.2.2 + */ +public class CompareToBuilder implements Builder { + private static final long serialVersionUID = 1L; + + /** 当前比较状态 */ + private int comparison; + + /** + * 构造，构造后调用append方法增加比较项，然后调用{@link #toComparison()}获取结果 + */ + public CompareToBuilder() { + comparison = 0; + } + + //----------------------------------------------------------------------- + /** + * 通过反射比较两个Bean对象，对象字段可以为private。比较规则如下： + * + *
    + *
  • static字段不比较
    • + *
  • Transient字段不参与比较
    • + *
  • 父类字段参与比较
    • + *
+ * + *

+ *如果被比较的两个对象都为null，被认为相同。 + * + * @param lhs 第一个对象 + * @param rhs 第二个对象 + * @return a negative integer, zero, or a positive integer as lhs + * is less than, equal to, or greater than rhs + * @throws NullPointerException if either (but not both) parameters are + * null + * @throws ClassCastException if rhs is not assignment-compatible + * with lhs + */ + public static int reflectionCompare(final Object lhs, final Object rhs) { + return reflectionCompare(lhs, rhs, false, null); + } + + /** + *

Compares two Objects via reflection.

+ * + *

Fields can be private, thus AccessibleObject.setAccessible + * is used to bypass normal access control checks. This will fail under a + * security manager unless the appropriate permissions are set.

+ * + *
    + *
  • Static fields will not be compared
    • + *
  • If compareTransients is true, + * compares transient members. Otherwise ignores them, as they + * are likely derived fields.
    • + *
  • Superclass fields will be compared
    • + *
+ * + *

If both lhs and rhs are null, + * they are considered equal.

+ * + * @param lhs left-hand object + * @param rhs right-hand object + * @param compareTransients whether to compare transient fields + * @return a negative integer, zero, or a positive integer as lhs + * is less than, equal to, or greater than rhs + * @throws NullPointerException if either lhs or rhs + * (but not both) is null + * @throws ClassCastException if rhs is not assignment-compatible + * with lhs + */ + public static int reflectionCompare(final Object lhs, final Object rhs, final boolean compareTransients) { + return reflectionCompare(lhs, rhs, compareTransients, null); + } + + /** + *

Compares two Objects via reflection.

+ * + *

Fields can be private, thus AccessibleObject.setAccessible + * is used to bypass normal access control checks. This will fail under a + * security manager unless the appropriate permissions are set.

+ * + *
    + *
  • Static fields will not be compared
    • + *
  • If compareTransients is true, + * compares transient members. Otherwise ignores them, as they + * are likely derived fields.
    • + *
  • Superclass fields will be compared
    • + *
+ * + *

If both lhs and rhs are null, + * they are considered equal.

+ * + * @param lhs left-hand object + * @param rhs right-hand object + * @param excludeFields Collection of String fields to exclude + * @return a negative integer, zero, or a positive integer as lhs + * is less than, equal to, or greater than rhs + * @throws NullPointerException if either lhs or rhs + * (but not both) is null + * @throws ClassCastException if rhs is not assignment-compatible + * with lhs + * @since 2.2 + */ + public static int reflectionCompare(final Object lhs, final Object rhs, final Collection excludeFields) { + return reflectionCompare(lhs, rhs, ArrayUtil.toArray(excludeFields, String.class)); + } + + /** + *

Compares two Objects via reflection.

+ * + *

Fields can be private, thus AccessibleObject.setAccessible + * is used to bypass normal access control checks. This will fail under a + * security manager unless the appropriate permissions are set.

+ * + *
    + *
  • Static fields will not be compared
    • + *
  • If compareTransients is true, + * compares transient members. Otherwise ignores them, as they + * are likely derived fields.
    • + *
  • Superclass fields will be compared
    • + *
+ * + *

If both lhs and rhs are null, + * they are considered equal.

+ * + * @param lhs left-hand object + * @param rhs right-hand object + * @param excludeFields array of fields to exclude + * @return a negative integer, zero, or a positive integer as lhs + * is less than, equal to, or greater than rhs + * @throws NullPointerException if either lhs or rhs + * (but not both) is null + * @throws ClassCastException if rhs is not assignment-compatible + * with lhs + * @since 2.2 + */ + public static int reflectionCompare(final Object lhs, final Object rhs, final String... excludeFields) { + return reflectionCompare(lhs, rhs, false, null, excludeFields); + } + + /** + *

Compares two Objects via reflection.

+ * + *

Fields can be private, thus AccessibleObject.setAccessible + * is used to bypass normal access control checks. This will fail under a + * security manager unless the appropriate permissions are set.

+ * + *
    + *
  • Static fields will not be compared
    • + *
  • If the compareTransients is true, + * compares transient members. Otherwise ignores them, as they + * are likely derived fields.
    • + *
  • Compares superclass fields up to and including reflectUpToClass. + * If reflectUpToClass is null, compares all superclass fields.
    • + *
+ * + *

If both lhs and rhs are null, + * they are considered equal.

+ * + * @param lhs left-hand object + * @param rhs right-hand object + * @param compareTransients whether to compare transient fields + * @param reflectUpToClass last superclass for which fields are compared + * @param excludeFields fields to exclude + * @return a negative integer, zero, or a positive integer as lhs + * is less than, equal to, or greater than rhs + * @throws NullPointerException if either lhs or rhs + * (but not both) is null + * @throws ClassCastException if rhs is not assignment-compatible + * with lhs + * @since 2.2 (2.0 as reflectionCompare(Object, Object, boolean, Class)) + */ + public static int reflectionCompare( + final Object lhs, + final Object rhs, + final boolean compareTransients, + final Class reflectUpToClass, + final String... excludeFields) { + + if (lhs == rhs) { + return 0; + } + if (lhs == null || rhs == null) { + throw new NullPointerException(); + } + Class lhsClazz = lhs.getClass(); + if (!lhsClazz.isInstance(rhs)) { + throw new ClassCastException(); + } + final CompareToBuilder compareToBuilder = new CompareToBuilder(); + reflectionAppend(lhs, rhs, lhsClazz, compareToBuilder, compareTransients, excludeFields); + while (lhsClazz.getSuperclass() != null && lhsClazz != reflectUpToClass) { + lhsClazz = lhsClazz.getSuperclass(); + reflectionAppend(lhs, rhs, lhsClazz, compareToBuilder, compareTransients, excludeFields); + } + return compareToBuilder.toComparison(); + } + + /** + *

Appends to builder the comparison of lhs + * to rhs using the fields defined in clazz.

+ * + * @param lhs left-hand object + * @param rhs right-hand object + * @param clazz Class that defines fields to be compared + * @param builder CompareToBuilder to append to + * @param useTransients whether to compare transient fields + * @param excludeFields fields to exclude + */ + private static void reflectionAppend( + final Object lhs, + final Object rhs, + final Class clazz, + final CompareToBuilder builder, + final boolean useTransients, + final String[] excludeFields) { + + final Field[] fields = clazz.getDeclaredFields(); + AccessibleObject.setAccessible(fields, true); + for (int i = 0; i < fields.length && builder.comparison == 0; i++) { + final Field f = fields[i]; + if (false == ArrayUtil.contains(excludeFields, f.getName()) + && (f.getName().indexOf('$') == -1) + && (useTransients || !Modifier.isTransient(f.getModifiers())) + && (!Modifier.isStatic(f.getModifiers()))) { + try { + builder.append(f.get(lhs), f.get(rhs)); + } catch (final IllegalAccessException e) { + // This can't happen. Would get a Security exception instead. + // Throw a runtime exception in case the impossible happens. + throw new InternalError("Unexpected IllegalAccessException"); + } + } + } + } + + //----------------------------------------------------------------------- + /** + *

Appends to the builder the compareTo(Object) + * result of the superclass.

+ * + * @param superCompareTo result of calling super.compareTo(Object) + * @return this - used to chain append calls + * @since 2.0 + */ + public CompareToBuilder appendSuper(final int superCompareTo) { + if (comparison != 0) { + return this; + } + comparison = superCompareTo; + return this; + } + + //----------------------------------------------------------------------- + /** + *

Appends to the builder the comparison of + * two Objects.

+ * + *
    + *
  1. Check if lhs == rhs
    2. + *
  2. Check if either lhs or rhs is null, + * a null object is less than a non-null object
    3. + *
  3. Check the object contents
    4. + *
+ * + *

lhs must either be an array or implement {@link Comparable}.

+ * + * @param lhs left-hand object + * @param rhs right-hand object + * @return this - used to chain append calls + * @throws ClassCastException if rhs is not assignment-compatible + * with lhs + */ + public CompareToBuilder append(final Object lhs, final Object rhs) { + return append(lhs, rhs, null); + } + + /** + *

Appends to the builder the comparison of + * two Objects.

+ * + *
    + *
  1. Check if lhs == rhs
    2. + *
  2. Check if either lhs or rhs is null, + * a null object is less than a non-null object
    3. + *
  3. Check the object contents
    4. + *
+ * + *

If lhs is an array, array comparison methods will be used. + * Otherwise comparator will be used to compare the objects. + * If comparator is null, lhs must + * implement {@link Comparable} instead.

+ * + * @param lhs left-hand object + * @param rhs right-hand object + * @param comparator Comparator used to compare the objects, + * null means treat lhs as Comparable + * @return this - used to chain append calls + * @throws ClassCastException if rhs is not assignment-compatible + * with lhs + * @since 2.0 + */ + public CompareToBuilder append(final Object lhs, final Object rhs, final Comparator comparator) { + if (comparison != 0) { + return this; + } + if (lhs == rhs) { + return this; + } + if (lhs == null) { + comparison = -1; + return this; + } + if (rhs == null) { + comparison = +1; + return this; + } + if (lhs.getClass().isArray()) { + // switch on type of array, to dispatch to the correct handler + // handles multi dimensional arrays + // throws a ClassCastException if rhs is not the correct array type + if (lhs instanceof long[]) { + append((long[]) lhs, (long[]) rhs); + } else if (lhs instanceof int[]) { + append((int[]) lhs, (int[]) rhs); + } else if (lhs instanceof short[]) { + append((short[]) lhs, (short[]) rhs); + } else if (lhs instanceof char[]) { + append((char[]) lhs, (char[]) rhs); + } else if (lhs instanceof byte[]) { + append((byte[]) lhs, (byte[]) rhs); + } else if (lhs instanceof double[]) { + append((double[]) lhs, (double[]) rhs); + } else if (lhs instanceof float[]) { + append((float[]) lhs, (float[]) rhs); + } else if (lhs instanceof boolean[]) { + append((boolean[]) lhs, (boolean[]) rhs); + } else { + // not an array of primitives + // throws a ClassCastException if rhs is not an array + append((Object[]) lhs, (Object[]) rhs, comparator); + } + } else { + // the simple case, not an array, just test the element + if (comparator == null) { + @SuppressWarnings("unchecked") // assume this can be done; if not throw CCE as per Javadoc + final Comparable comparable = (Comparable) lhs; + comparison = comparable.compareTo(rhs); + } else { + @SuppressWarnings("unchecked") // assume this can be done; if not throw CCE as per Javadoc + final Comparator comparator2 = (Comparator) comparator; + comparison = comparator2.compare(lhs, rhs); + } + } + return this; + } + + //------------------------------------------------------------------------- + /** + * Appends to the builder the comparison of + * two longs. + * + * @param lhs left-hand value + * @param rhs right-hand value + * @return this - used to chain append calls + */ + public CompareToBuilder append(final long lhs, final long rhs) { + if (comparison != 0) { + return this; + } + comparison = (Long.compare(lhs, rhs)); + return this; + } + + /** + * Appends to the builder the comparison of + * two ints. + * + * @param lhs left-hand value + * @param rhs right-hand value + * @return this - used to chain append calls + */ + public CompareToBuilder append(final int lhs, final int rhs) { + if (comparison != 0) { + return this; + } + comparison = (Integer.compare(lhs, rhs)); + return this; + } + + /** + * Appends to the builder the comparison of + * two shorts. + * + * @param lhs left-hand value + * @param rhs right-hand value + * @return this - used to chain append calls + */ + public CompareToBuilder append(final short lhs, final short rhs) { + if (comparison != 0) { + return this; + } + comparison = (Short.compare(lhs, rhs)); + return this; + } + + /** + * Appends to the builder the comparison of + * two chars. + * + * @param lhs left-hand value + * @param rhs right-hand value + * @return this - used to chain append calls + */ + public CompareToBuilder append(final char lhs, final char rhs) { + if (comparison != 0) { + return this; + } + comparison = (Character.compare(lhs, rhs)); + return this; + } + + /** + * Appends to the builder the comparison of + * two bytes. + * + * @param lhs left-hand value + * @param rhs right-hand value + * @return this - used to chain append calls + */ + public CompareToBuilder append(final byte lhs, final byte rhs) { + if (comparison != 0) { + return this; + } + comparison = (Byte.compare(lhs, rhs)); + return this; + } + + /** + *

Appends to the builder the comparison of + * two doubles.

+ * + *

This handles NaNs, Infinities, and -0.0.

+ * + *

It is compatible with the hash code generated by + * HashCodeBuilder.

+ * + * @param lhs left-hand value + * @param rhs right-hand value + * @return this - used to chain append calls + */ + public CompareToBuilder append(final double lhs, final double rhs) { + if (comparison != 0) { + return this; + } + comparison = Double.compare(lhs, rhs); + return this; + } + + /** + *

Appends to the builder the comparison of + * two floats.

+ * + *

This handles NaNs, Infinities, and -0.0.

+ * + *

It is compatible with the hash code generated by + * HashCodeBuilder.

+ * + * @param lhs left-hand value + * @param rhs right-hand value + * @return this - used to chain append calls + */ + public CompareToBuilder append(final float lhs, final float rhs) { + if (comparison != 0) { + return this; + } + comparison = Float.compare(lhs, rhs); + return this; + } + + /** + * Appends to the builder the comparison of + * two booleanss. + * + * @param lhs left-hand value + * @param rhs right-hand value + * @return this - used to chain append calls + */ + public CompareToBuilder append(final boolean lhs, final boolean rhs) { + if (comparison != 0) { + return this; + } + if (lhs == rhs) { + return this; + } + if (lhs == false) { + comparison = -1; + } else { + comparison = +1; + } + return this; + } + + //----------------------------------------------------------------------- + /** + *

Appends to the builder the deep comparison of + * two Object arrays.

+ * + *
    + *
  1. Check if arrays are the same using ==
    2. + *
  2. Check if for null, null is less than non-null
    3. + *
  3. Check array length, a short length array is less than a long length array
    4. + *
  4. Check array contents element by element using {@link #append(Object, Object, Comparator)}
    5. + *
+ * + *

This method will also will be called for the top level of multi-dimensional, + * ragged, and multi-typed arrays.

+ * + * @param lhs left-hand array + * @param rhs right-hand array + * @return this - used to chain append calls + * @throws ClassCastException if rhs is not assignment-compatible + * with lhs + */ + public CompareToBuilder append(final Object[] lhs, final Object[] rhs) { + return append(lhs, rhs, null); + } + + /** + *

Appends to the builder the deep comparison of + * two Object arrays.

+ * + *
    + *
  1. Check if arrays are the same using ==
    2. + *
  2. Check if for null, null is less than non-null
    3. + *
  3. Check array length, a short length array is less than a long length array
    4. + *
  4. Check array contents element by element using {@link #append(Object, Object, Comparator)}
    5. + *
+ * + *

This method will also will be called for the top level of multi-dimensional, + * ragged, and multi-typed arrays.

+ * + * @param lhs left-hand array + * @param rhs right-hand array + * @param comparator Comparator to use to compare the array elements, + * null means to treat lhs elements as Comparable. + * @return this - used to chain append calls + * @throws ClassCastException if rhs is not assignment-compatible + * with lhs + * @since 2.0 + */ + public CompareToBuilder append(final Object[] lhs, final Object[] rhs, final Comparator comparator) { + if (comparison != 0) { + return this; + } + if (lhs == rhs) { + return this; + } + if (lhs == null) { + comparison = -1; + return this; + } + if (rhs == null) { + comparison = +1; + return this; + } + if (lhs.length != rhs.length) { + comparison = (lhs.length < rhs.length) ? -1 : +1; + return this; + } + for (int i = 0; i < lhs.length && comparison == 0; i++) { + append(lhs[i], rhs[i], comparator); + } + return this; + } + + /** + *

Appends to the builder the deep comparison of + * two long arrays.

+ * + *
    + *
  1. Check if arrays are the same using ==
    2. + *
  2. Check if for null, null is less than non-null
    3. + *
  3. Check array length, a shorter length array is less than a longer length array
    4. + *
  4. Check array contents element by element using {@link #append(long, long)}
    5. + *
+ * + * @param lhs left-hand array + * @param rhs right-hand array + * @return this - used to chain append calls + */ + public CompareToBuilder append(final long[] lhs, final long[] rhs) { + if (comparison != 0) { + return this; + } + if (lhs == rhs) { + return this; + } + if (lhs == null) { + comparison = -1; + return this; + } + if (rhs == null) { + comparison = +1; + return this; + } + if (lhs.length != rhs.length) { + comparison = (lhs.length < rhs.length) ? -1 : +1; + return this; + } + for (int i = 0; i < lhs.length && comparison == 0; i++) { + append(lhs[i], rhs[i]); + } + return this; + } + + /** + *

Appends to the builder the deep comparison of + * two int arrays.

+ * + *
    + *
  1. Check if arrays are the same using ==
    2. + *
  2. Check if for null, null is less than non-null
    3. + *
  3. Check array length, a shorter length array is less than a longer length array
    4. + *
  4. Check array contents element by element using {@link #append(int, int)}
    5. + *
+ * + * @param lhs left-hand array + * @param rhs right-hand array + * @return this - used to chain append calls + */ + public CompareToBuilder append(final int[] lhs, final int[] rhs) { + if (comparison != 0) { + return this; + } + if (lhs == rhs) { + return this; + } + if (lhs == null) { + comparison = -1; + return this; + } + if (rhs == null) { + comparison = +1; + return this; + } + if (lhs.length != rhs.length) { + comparison = (lhs.length < rhs.length) ? -1 : +1; + return this; + } + for (int i = 0; i < lhs.length && comparison == 0; i++) { + append(lhs[i], rhs[i]); + } + return this; + } + + /** + *

Appends to the builder the deep comparison of + * two short arrays.

+ * + *
    + *
  1. Check if arrays are the same using ==
    2. + *
  2. Check if for null, null is less than non-null
    3. + *
  3. Check array length, a shorter length array is less than a longer length array
    4. + *
  4. Check array contents element by element using {@link #append(short, short)}
    5. + *
+ * + * @param lhs left-hand array + * @param rhs right-hand array + * @return this - used to chain append calls + */ + public CompareToBuilder append(final short[] lhs, final short[] rhs) { + if (comparison != 0) { + return this; + } + if (lhs == rhs) { + return this; + } + if (lhs == null) { + comparison = -1; + return this; + } + if (rhs == null) { + comparison = +1; + return this; + } + if (lhs.length != rhs.length) { + comparison = (lhs.length < rhs.length) ? -1 : +1; + return this; + } + for (int i = 0; i < lhs.length && comparison == 0; i++) { + append(lhs[i], rhs[i]); + } + return this; + } + + /** + *

Appends to the builder the deep comparison of + * two char arrays.

+ * + *
    + *
  1. Check if arrays are the same using ==
    2. + *
  2. Check if for null, null is less than non-null
    3. + *
  3. Check array length, a shorter length array is less than a longer length array
    4. + *
  4. Check array contents element by element using {@link #append(char, char)}
    5. + *
+ * + * @param lhs left-hand array + * @param rhs right-hand array + * @return this - used to chain append calls + */ + public CompareToBuilder append(final char[] lhs, final char[] rhs) { + if (comparison != 0) { + return this; + } + if (lhs == rhs) { + return this; + } + if (lhs == null) { + comparison = -1; + return this; + } + if (rhs == null) { + comparison = +1; + return this; + } + if (lhs.length != rhs.length) { + comparison = (lhs.length < rhs.length) ? -1 : +1; + return this; + } + for (int i = 0; i < lhs.length && comparison == 0; i++) { + append(lhs[i], rhs[i]); + } + return this; + } + + /** + *

Appends to the builder the deep comparison of + * two byte arrays.

+ * + *
    + *
  1. Check if arrays are the same using ==
    2. + *
  2. Check if for null, null is less than non-null
    3. + *
  3. Check array length, a shorter length array is less than a longer length array
    4. + *
  4. Check array contents element by element using {@link #append(byte, byte)}
    5. + *
+ * + * @param lhs left-hand array + * @param rhs right-hand array + * @return this - used to chain append calls + */ + public CompareToBuilder append(final byte[] lhs, final byte[] rhs) { + if (comparison != 0) { + return this; + } + if (lhs == rhs) { + return this; + } + if (lhs == null) { + comparison = -1; + return this; + } + if (rhs == null) { + comparison = +1; + return this; + } + if (lhs.length != rhs.length) { + comparison = (lhs.length < rhs.length) ? -1 : +1; + return this; + } + for (int i = 0; i < lhs.length && comparison == 0; i++) { + append(lhs[i], rhs[i]); + } + return this; + } + + /** + *

Appends to the builder the deep comparison of + * two double arrays.

+ * + *
    + *
  1. Check if arrays are the same using ==
    2. + *
  2. Check if for null, null is less than non-null
    3. + *
  3. Check array length, a shorter length array is less than a longer length array
    4. + *
  4. Check array contents element by element using {@link #append(double, double)}
    5. + *
+ * + * @param lhs left-hand array + * @param rhs right-hand array + * @return this - used to chain append calls + */ + public CompareToBuilder append(final double[] lhs, final double[] rhs) { + if (comparison != 0) { + return this; + } + if (lhs == rhs) { + return this; + } + if (lhs == null) { + comparison = -1; + return this; + } + if (rhs == null) { + comparison = +1; + return this; + } + if (lhs.length != rhs.length) { + comparison = (lhs.length < rhs.length) ? -1 : +1; + return this; + } + for (int i = 0; i < lhs.length && comparison == 0; i++) { + append(lhs[i], rhs[i]); + } + return this; + } + + /** + *

Appends to the builder the deep comparison of + * two float arrays.

+ * + *
    + *
  1. Check if arrays are the same using ==
    2. + *
  2. Check if for null, null is less than non-null
    3. + *
  3. Check array length, a shorter length array is less than a longer length array
    4. + *
  4. Check array contents element by element using {@link #append(float, float)}
    5. + *
+ * + * @param lhs left-hand array + * @param rhs right-hand array + * @return this - used to chain append calls + */ + public CompareToBuilder append(final float[] lhs, final float[] rhs) { + if (comparison != 0) { + return this; + } + if (lhs == rhs) { + return this; + } + if (lhs == null) { + comparison = -1; + return this; + } + if (rhs == null) { + comparison = +1; + return this; + } + if (lhs.length != rhs.length) { + comparison = (lhs.length < rhs.length) ? -1 : +1; + return this; + } + for (int i = 0; i < lhs.length && comparison == 0; i++) { + append(lhs[i], rhs[i]); + } + return this; + } + + /** + *

Appends to the builder the deep comparison of + * two boolean arrays.

+ * + *
    + *
  1. Check if arrays are the same using ==
    2. + *
  2. Check if for null, null is less than non-null
    3. + *
  3. Check array length, a shorter length array is less than a longer length array
    4. + *
  4. Check array contents element by element using {@link #append(boolean, boolean)}
    5. + *
+ * + * @param lhs left-hand array + * @param rhs right-hand array + * @return this - used to chain append calls + */ + public CompareToBuilder append(final boolean[] lhs, final boolean[] rhs) { + if (comparison != 0) { + return this; + } + if (lhs == rhs) { + return this; + } + if (lhs == null) { + comparison = -1; + return this; + } + if (rhs == null) { + comparison = +1; + return this; + } + if (lhs.length != rhs.length) { + comparison = (lhs.length < rhs.length) ? -1 : +1; + return this; + } + for (int i = 0; i < lhs.length && comparison == 0; i++) { + append(lhs[i], rhs[i]); + } + return this; + } + + //----------------------------------------------------------------------- + /** + * Returns a negative integer, a positive integer, or zero as + * the builder has judged the "left-hand" side + * as less than, greater than, or equal to the "right-hand" + * side. + * + * @return final comparison result + * @see #build() + */ + public int toComparison() { + return comparison; + } + + /** + * Returns a negative Integer, a positive Integer, or zero as + * the builder has judged the "left-hand" side + * as less than, greater than, or equal to the "right-hand" + * side. + * + * @return final comparison result as an Integer + * @see #toComparison() + * @since 3.0 + */ + @Override + public Integer build() { + return toComparison(); + } +} + diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/EqualsBuilder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/EqualsBuilder.java new file mode 100644 index 0000000..47e024b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/EqualsBuilder.java @@ -0,0 +1,563 @@ +package aiyh.utils.tool.cn.hutool.core.builder; + +import aiyh.utils.tool.cn.hutool.core.lang.Pair; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; + +import java.lang.reflect.AccessibleObject; +import java.lang.reflect.Field; +import java.lang.reflect.Modifier; +import java.util.Collection; +import java.util.HashSet; +import java.util.Set; + +/** + *

{@link Object#equals(Object)} 方法的构建器

+ * + *

两个对象equals必须保证hashCode值相等，hashCode值相等不能保证一定equals

+ * + *

使用方法如下：

+ * 
+ * public boolean equals(Object obj) {
+ *   if (obj == null) { return false; }
+ *   if (obj == this) { return true; }
+ *   if (obj.getClass() != getClass()) {
+ *     return false;
+ *   }
+ *   MyClass rhs = (MyClass) obj;
+ *   return new EqualsBuilder()
+ *                 .appendSuper(super.equals(obj))
+ *                 .append(field1, rhs.field1)
+ *                 .append(field2, rhs.field2)
+ *                 .append(field3, rhs.field3)
+ *                 .isEquals();
+ *  }
+ *
+ * + *

我们也可以通过反射判断所有字段是否equals：

+ * 
+ * public boolean equals(Object obj) {
+ *   return EqualsBuilder.reflectionEquals(this, obj);
+ * }
+ *
+ *

+ * 来自Apache Commons Lang改造 + */ +public class EqualsBuilder implements Builder { + private static final long serialVersionUID = 1L; + + /** + *

+ * A registry of objects used by reflection methods to detect cyclical object references and avoid infinite loops. + *

+ */ + private static final ThreadLocal>> REGISTRY = new ThreadLocal<>(); + + /** + *

+ * Returns the registry of object pairs being traversed by the reflection + * methods in the current thread. + *

+ * + * @return Set the registry of objects being traversed + * @since 3.0 + */ + static Set> getRegistry() { + return REGISTRY.get(); + } + + /** + *

+ * Converters value pair into a register pair. + *

+ * + * @param lhs {@code this} object + * @param rhs the other object + * @return the pair + */ + static Pair getRegisterPair(final Object lhs, final Object rhs) { + final IDKey left = new IDKey(lhs); + final IDKey right = new IDKey(rhs); + return new Pair<>(left, right); + } + + /** + *

+ * Returns {@code true} if the registry contains the given object pair. + * Used by the reflection methods to avoid infinite loops. + * Objects might be swapped therefore a check is needed if the object pair + * is registered in given or swapped order. + *

+ * + * @param lhs {@code this} object to lookup in registry + * @param rhs the other object to lookup on registry + * @return boolean {@code true} if the registry contains the given object. + * @since 3.0 + */ + static boolean isRegistered(final Object lhs, final Object rhs) { + final Set> registry = getRegistry(); + final Pair pair = getRegisterPair(lhs, rhs); + final Pair swappedPair = new Pair<>(pair.getKey(), pair.getValue()); + + return registry != null + && (registry.contains(pair) || registry.contains(swappedPair)); + } + + /** + *

+ * Registers the given object pair. + * Used by the reflection methods to avoid infinite loops. + *

+ * + * @param lhs {@code this} object to register + * @param rhs the other object to register + */ + static void register(final Object lhs, final Object rhs) { + synchronized (EqualsBuilder.class) { + if (getRegistry() == null) { + REGISTRY.set(new HashSet<>()); + } + } + + final Set> registry = getRegistry(); + final Pair pair = getRegisterPair(lhs, rhs); + registry.add(pair); + } + + /** + *

+ * Unregisters the given object pair. + *

+ * + *

+ * Used by the reflection methods to avoid infinite loops. + * + * @param lhs {@code this} object to unregister + * @param rhs the other object to unregister + * @since 3.0 + */ + static void unregister(final Object lhs, final Object rhs) { + Set> registry = getRegistry(); + if (registry != null) { + final Pair pair = getRegisterPair(lhs, rhs); + registry.remove(pair); + synchronized (EqualsBuilder.class) { + //read again + registry = getRegistry(); + if (registry != null && registry.isEmpty()) { + REGISTRY.remove(); + } + } + } + } + + /** + * 是否equals，此值随着构建会变更，默认true + */ + private boolean isEquals = true; + + /** + * 构造，初始状态值为true + */ + public EqualsBuilder() { + // do nothing for now. + } + + //------------------------------------------------------------------------- + + /** + *

反射检查两个对象是否equals，此方法检查对象及其父对象的属性（包括私有属性）是否equals

+ * + * @param lhs 此对象 + * @param rhs 另一个对象 + * @param excludeFields 排除的字段集合，如果有不参与计算equals的字段加入此集合即可 + * @return 两个对象是否equals，是返回{@code true} + */ + public static boolean reflectionEquals(final Object lhs, final Object rhs, final Collection excludeFields) { + return reflectionEquals(lhs, rhs, ArrayUtil.toArray(excludeFields, String.class)); + } + + /** + *

反射检查两个对象是否equals，此方法检查对象及其父对象的属性（包括私有属性）是否equals

+ * + * @param lhs 此对象 + * @param rhs 另一个对象 + * @param excludeFields 排除的字段集合，如果有不参与计算equals的字段加入此集合即可 + * @return 两个对象是否equals，是返回{@code true} + */ + public static boolean reflectionEquals(final Object lhs, final Object rhs, final String... excludeFields) { + return reflectionEquals(lhs, rhs, false, null, excludeFields); + } + + /** + *

This method uses reflection to determine if the two {@code Object}s + * are equal.

+ * + *

It uses {@code AccessibleObject.setAccessible} to gain access to private + * fields. This means that it will throw a security exception if run under + * a security manager, if the permissions are not set up correctly. It is also + * not as efficient as testing explicitly. Non-primitive fields are compared using + * {@code equals()}.

+ * + *

If the TestTransients parameter is set to {@code true}, transient + * members will be tested, otherwise they are ignored, as they are likely + * derived fields, and not part of the value of the {@code Object}.

+ * + *

Static fields will not be tested. Superclass fields will be included.

+ * + * @param lhs {@code this} object + * @param rhs the other object + * @param testTransients whether to include transient fields + * @return {@code true} if the two Objects have tested equals. + */ + public static boolean reflectionEquals(final Object lhs, final Object rhs, final boolean testTransients) { + return reflectionEquals(lhs, rhs, testTransients, null); + } + + /** + *

This method uses reflection to determine if the two {@code Object}s + * are equal.

+ * + *

It uses {@code AccessibleObject.setAccessible} to gain access to private + * fields. This means that it will throw a security exception if run under + * a security manager, if the permissions are not set up correctly. It is also + * not as efficient as testing explicitly. Non-primitive fields are compared using + * {@code equals()}.

+ * + *

If the testTransients parameter is set to {@code true}, transient + * members will be tested, otherwise they are ignored, as they are likely + * derived fields, and not part of the value of the {@code Object}.

+ * + *

Static fields will not be included. Superclass fields will be appended + * up to and including the specified superclass. A null superclass is treated + * as java.lang.Object.

+ * + * @param lhs {@code this} object + * @param rhs the other object + * @param testTransients whether to include transient fields + * @param reflectUpToClass the superclass to reflect up to (inclusive), + * may be {@code null} + * @param excludeFields array of field names to exclude from testing + * @return {@code true} if the two Objects have tested equals. + * @since 2.0 + */ + public static boolean reflectionEquals(final Object lhs, final Object rhs, final boolean testTransients, final Class reflectUpToClass, + final String... excludeFields) { + if (lhs == rhs) { + return true; + } + if (lhs == null || rhs == null) { + return false; + } + // Find the leaf class since there may be transients in the leaf + // class or in classes between the leaf and root. + // If we are not testing transients or a subclass has no ivars, + // then a subclass can test equals to a superclass. + final Class lhsClass = lhs.getClass(); + final Class rhsClass = rhs.getClass(); + Class testClass; + if (lhsClass.isInstance(rhs)) { + testClass = lhsClass; + if (!rhsClass.isInstance(lhs)) { + // rhsClass is a subclass of lhsClass + testClass = rhsClass; + } + } else if (rhsClass.isInstance(lhs)) { + testClass = rhsClass; + if (!lhsClass.isInstance(rhs)) { + // lhsClass is a subclass of rhsClass + testClass = lhsClass; + } + } else { + // The two classes are not related. + return false; + } + final EqualsBuilder equalsBuilder = new EqualsBuilder(); + try { + if (testClass.isArray()) { + equalsBuilder.append(lhs, rhs); + } else { + reflectionAppend(lhs, rhs, testClass, equalsBuilder, testTransients, excludeFields); + while (testClass.getSuperclass() != null && testClass != reflectUpToClass) { + testClass = testClass.getSuperclass(); + reflectionAppend(lhs, rhs, testClass, equalsBuilder, testTransients, excludeFields); + } + } + } catch (final IllegalArgumentException e) { + // In this case, we tried to test a subclass vs. a superclass and + // the subclass has ivars or the ivars are transient and + // we are testing transients. + // If a subclass has ivars that we are trying to test them, we get an + // exception and we know that the objects are not equal. + return false; + } + return equalsBuilder.isEquals(); + } + + /** + *

Appends the fields and values defined by the given object of the + * given Class.

+ * + * @param lhs the left hand object + * @param rhs the right hand object + * @param clazz the class to append details of + * @param builder the builder to append to + * @param useTransients whether to test transient fields + * @param excludeFields array of field names to exclude from testing + */ + private static void reflectionAppend( + final Object lhs, + final Object rhs, + final Class clazz, + final EqualsBuilder builder, + final boolean useTransients, + final String[] excludeFields) { + + if (isRegistered(lhs, rhs)) { + return; + } + + try { + register(lhs, rhs); + final Field[] fields = clazz.getDeclaredFields(); + AccessibleObject.setAccessible(fields, true); + for (int i = 0; i < fields.length && builder.isEquals; i++) { + final Field f = fields[i]; + if (false == ArrayUtil.contains(excludeFields, f.getName()) + && (f.getName().indexOf('$') == -1) + && (useTransients || !Modifier.isTransient(f.getModifiers())) + && (!Modifier.isStatic(f.getModifiers()))) { + try { + builder.append(f.get(lhs), f.get(rhs)); + } catch (final IllegalAccessException e) { + //this can't happen. Would get a Security exception instead + //throw a runtime exception in case the impossible happens. + throw new InternalError("Unexpected IllegalAccessException"); + } + } + } + } finally { + unregister(lhs, rhs); + } + } + + //------------------------------------------------------------------------- + + /** + *

Adds the result of {@code super.equals()} to this builder.

+ * + * @param superEquals the result of calling {@code super.equals()} + * @return EqualsBuilder - used to chain calls. + * @since 2.0 + */ + public EqualsBuilder appendSuper(final boolean superEquals) { + if (isEquals == false) { + return this; + } + isEquals = superEquals; + return this; + } + + //------------------------------------------------------------------------- + + /** + *

Test if two {@code Object}s are equal using their + * {@code equals} method.

+ * + * @param lhs the left hand object + * @param rhs the right hand object + * @return EqualsBuilder - used to chain calls. + */ + public EqualsBuilder append(final Object lhs, final Object rhs) { + if (isEquals == false) { + return this; + } + if (lhs == rhs) { + return this; + } + if (lhs == null || rhs == null) { + return setEquals(false); + } + if (ArrayUtil.isArray(lhs)) { + // 判断数组的equals + return setEquals(ArrayUtil.equals(lhs, rhs)); + } + + // The simple case, not an array, just test the element + return setEquals(lhs.equals(rhs)); + } + + /** + *

+ * Test if two {@code long} s are equal. + *

+ * + * @param lhs the left hand {@code long} + * @param rhs the right hand {@code long} + * @return EqualsBuilder - used to chain calls. + */ + public EqualsBuilder append(final long lhs, final long rhs) { + if (isEquals == false) { + return this; + } + isEquals = (lhs == rhs); + return this; + } + + /** + *

Test if two {@code int}s are equal.

+ * + * @param lhs the left hand {@code int} + * @param rhs the right hand {@code int} + * @return EqualsBuilder - used to chain calls. + */ + public EqualsBuilder append(final int lhs, final int rhs) { + if (isEquals == false) { + return this; + } + isEquals = (lhs == rhs); + return this; + } + + /** + *

Test if two {@code short}s are equal.

+ * + * @param lhs the left hand {@code short} + * @param rhs the right hand {@code short} + * @return EqualsBuilder - used to chain calls. + */ + public EqualsBuilder append(final short lhs, final short rhs) { + if (isEquals == false) { + return this; + } + isEquals = (lhs == rhs); + return this; + } + + /** + *

Test if two {@code char}s are equal.

+ * + * @param lhs the left hand {@code char} + * @param rhs the right hand {@code char} + * @return EqualsBuilder - used to chain calls. + */ + public EqualsBuilder append(final char lhs, final char rhs) { + if (isEquals == false) { + return this; + } + isEquals = (lhs == rhs); + return this; + } + + /** + *

Test if two {@code byte}s are equal.

+ * + * @param lhs the left hand {@code byte} + * @param rhs the right hand {@code byte} + * @return EqualsBuilder - used to chain calls. + */ + public EqualsBuilder append(final byte lhs, final byte rhs) { + if (isEquals == false) { + return this; + } + isEquals = (lhs == rhs); + return this; + } + + /** + *

Test if two {@code double}s are equal by testing that the + * pattern of bits returned by {@code doubleToLong} are equal.

+ * + *

This handles NaNs, Infinities, and {@code -0.0}.

+ * + *

It is compatible with the hash code generated by + * {@code HashCodeBuilder}.

+ * + * @param lhs the left hand {@code double} + * @param rhs the right hand {@code double} + * @return EqualsBuilder - used to chain calls. + */ + public EqualsBuilder append(final double lhs, final double rhs) { + if (isEquals == false) { + return this; + } + return append(Double.doubleToLongBits(lhs), Double.doubleToLongBits(rhs)); + } + + /** + *

Test if two {@code float}s are equal byt testing that the + * pattern of bits returned by doubleToLong are equal.

+ * + *

This handles NaNs, Infinities, and {@code -0.0}.

+ * + *

It is compatible with the hash code generated by + * {@code HashCodeBuilder}.

+ * + * @param lhs the left hand {@code float} + * @param rhs the right hand {@code float} + * @return EqualsBuilder - used to chain calls. + */ + public EqualsBuilder append(final float lhs, final float rhs) { + if (isEquals == false) { + return this; + } + return append(Float.floatToIntBits(lhs), Float.floatToIntBits(rhs)); + } + + /** + *

Test if two {@code booleans}s are equal.

+ * + * @param lhs the left hand {@code boolean} + * @param rhs the right hand {@code boolean} + * @return EqualsBuilder - used to chain calls. + */ + public EqualsBuilder append(final boolean lhs, final boolean rhs) { + if (isEquals == false) { + return this; + } + isEquals = (lhs == rhs); + return this; + } + + /** + *

Returns {@code true} if the fields that have been checked + * are all equal.

+ * + * @return boolean + */ + public boolean isEquals() { + return this.isEquals; + } + + /** + *

Returns {@code true} if the fields that have been checked + * are all equal.

+ * + * @return {@code true} if all of the fields that have been checked + * are equal, {@code false} otherwise. + * @since 3.0 + */ + @Override + public Boolean build() { + return isEquals(); + } + + /** + * Sets the {@code isEquals} value. + * + * @param isEquals The value to set. + * @return this + */ + protected EqualsBuilder setEquals(boolean isEquals) { + this.isEquals = isEquals; + return this; + } + + /** + * Reset the EqualsBuilder so you can use the same object again + * + * @since 2.5 + */ + public void reset() { + this.isEquals = true; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/GenericBuilder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/GenericBuilder.java new file mode 100644 index 0000000..8503a46 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/GenericBuilder.java @@ -0,0 +1,235 @@ +package aiyh.utils.tool.cn.hutool.core.builder; + +import aiyh.utils.tool.cn.hutool.core.lang.func.Consumer3; +import aiyh.utils.tool.cn.hutool.core.lang.func.Supplier1; +import aiyh.utils.tool.cn.hutool.core.lang.func.Supplier2; +import aiyh.utils.tool.cn.hutool.core.lang.func.Supplier3; +import aiyh.utils.tool.cn.hutool.core.lang.func.Supplier4; +import aiyh.utils.tool.cn.hutool.core.lang.func.Supplier5; + +import java.util.ArrayList; +import java.util.List; +import java.util.function.BiConsumer; +import java.util.function.Consumer; +import java.util.function.Supplier; + +/** + *

通用Builder

+ * 参考: 一看就会的java8通用Builder + *

使用方法如下：

+ * 
+ * Box box = GenericBuilder
+ * 		.of(Box::new)
+ * 		.with(Box::setId, 1024L)
+ * 		.with(Box::setTitle, "Hello World!")
+ * 		.with(Box::setLength, 9)
+ * 		.with(Box::setWidth, 8)
+ * 		.with(Box::setHeight, 7)
+ * 		.build();
+ *
+ *
+ * + *

我们也可以对已创建的对象进行修改：

+ * 
+ * Box boxModified = GenericBuilder
+ * 		.of(() -> box)
+ * 		.with(Box::setTitle, "Hello Friend!")
+ * 		.with(Box::setLength, 3)
+ * 		.with(Box::setWidth, 4)
+ * 		.with(Box::setHeight, 5)
+ * 		.build();
+ *
+ *

我们还可以对这样调用有参构造，这对于创建一些在有参构造中包含初始化函数的对象是有意义的：

+ * 
+ * Box box1 = GenericBuilder
+ * 		.of(Box::new, 2048L, "Hello Partner!", 222, 333, 444)
+ * 		.with(Box::alis)
+ * 		.build();
+ *
+ *

还可能这样构建Map对象：

+ * {@code + * HashMap colorMap = GenericBuilder + * .of(HashMap::new) + * .with(Map::put, "red", "#FF0000") + * .with(Map::put, "yellow", "#FFFF00") + * .with(Map::put, "blue", "#0000FF") + * .build(); + * } + * + *

注意：本工具类支持调用的构造方法的参数数量不超过5个，一般方法的参数数量不超过2个，更多的参数不利于阅读和维护。

+ * + * @author TomXin + * @since 5.7.21 + */ +public class GenericBuilder implements Builder { + private static final long serialVersionUID = 1L; + + /** + * 实例化器 + */ + private final Supplier instant; + + /** + * 修改器列表 + */ + private final List> modifiers = new ArrayList<>(); + + /** + * 构造 + * + * @param instant 实例化器 + */ + public GenericBuilder(Supplier instant) { + this.instant = instant; + } + + /** + * 通过无参数实例化器创建GenericBuilder + * + * @param instant 实例化器 + * @param 目标类型 + * @return GenericBuilder对象 + */ + public static GenericBuilder of(Supplier instant) { + return new GenericBuilder<>(instant); + } + + /** + * 通过1参数实例化器创建GenericBuilder + * + * @param instant 实例化器 + * @param p1 参数一 + * @param 目标类型 + * @param 参数一类型 + * @return GenericBuilder对象 + */ + public static GenericBuilder of(Supplier1 instant, P1 p1) { + return of(instant.toSupplier(p1)); + } + + /** + * 通过2参数实例化器创建GenericBuilder + * + * @param instant 实例化器 + * @param p1 参数一 + * @param p2 参数二 + * @param 目标类型 + * @param 参数一类型 + * @param 参数二类型 + * @return GenericBuilder对象 + */ + public static GenericBuilder of(Supplier2 instant, P1 p1, P2 p2) { + return of(instant.toSupplier(p1, p2)); + } + + /** + * 通过3参数实例化器创建GenericBuilder + * + * @param instant 实例化器 + * @param p1 参数一 + * @param p2 参数二 + * @param p3 参数三 + * @param 目标类型 + * @param 参数一类型 + * @param 参数二类型 + * @param 参数三类型 + * @return GenericBuilder对象 + */ + public static GenericBuilder of(Supplier3 instant, P1 p1, P2 p2, P3 p3) { + return of(instant.toSupplier(p1, p2, p3)); + } + + /** + * 通过4参数实例化器创建GenericBuilder + * + * @param instant 实例化器 + * @param p1 参数一 + * @param p2 参数二 + * @param p3 参数三 + * @param p4 参数四 + * @param 目标类型 + * @param 参数一类型 + * @param 参数二类型 + * @param 参数三类型 + * @param 参数四类型 + * @return GenericBuilder对象 + */ + public static GenericBuilder of(Supplier4 instant, P1 p1, P2 p2, P3 p3, P4 p4) { + return of(instant.toSupplier(p1, p2, p3, p4)); + } + + /** + * 通过5参数实例化器创建GenericBuilder + * + * @param instant 实例化器 + * @param p1 参数一 + * @param p2 参数二 + * @param p3 参数三 + * @param p4 参数四 + * @param p5 参数五 + * @param 目标类型 + * @param 参数一类型 + * @param 参数二类型 + * @param 参数三类型 + * @param 参数四类型 + * @param 参数五类型 + * @return GenericBuilder对象 + */ + public static GenericBuilder of(Supplier5 instant, P1 p1, P2 p2, P3 p3, P4 p4, P5 p5) { + return of(instant.toSupplier(p1, p2, p3, p4, p5)); + } + + + /** + * 调用无参数方法 + * + * @param consumer 无参数Consumer + * @return GenericBuilder对象 + */ + public GenericBuilder with(Consumer consumer) { + modifiers.add(consumer); + return this; + } + + + /** + * 调用1参数方法 + * + * @param consumer 1参数Consumer + * @param p1 参数一 + * @param 参数一类型 + * @return GenericBuilder对象 + */ + public GenericBuilder with(BiConsumer consumer, P1 p1) { + modifiers.add(instant -> consumer.accept(instant, p1)); + return this; + } + + /** + * 调用2参数方法 + * + * @param consumer 2参数Consumer + * @param p1 参数一 + * @param p2 参数二 + * @param 参数一类型 + * @param 参数二类型 + * @return GenericBuilder对象 + */ + public GenericBuilder with(Consumer3 consumer, P1 p1, P2 p2) { + modifiers.add(instant -> consumer.accept(instant, p1, p2)); + return this; + } + + /** + * 构建 + * + * @return 目标对象 + */ + @Override + public T build() { + T value = instant.get(); + modifiers.forEach(modifier -> modifier.accept(value)); + modifiers.clear(); + return value; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/HashCodeBuilder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/HashCodeBuilder.java new file mode 100644 index 0000000..cf4916a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/HashCodeBuilder.java @@ -0,0 +1,958 @@ +package aiyh.utils.tool.cn.hutool.core.builder; + +import java.lang.reflect.AccessibleObject; +import java.lang.reflect.Field; +import java.lang.reflect.Modifier; +import java.util.Collection; +import java.util.HashSet; +import java.util.Set; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; + +/** + *

+ * Assists in implementing {@link Object#hashCode()} methods. + *

+ * + *

+ * This class enables a good hashCode method to be built for any class. It follows the rules laid out in + * the book Effective Java by Joshua Bloch. Writing a + * good hashCode method is actually quite difficult. This class aims to simplify the process. + *

+ * + *

+ * The following is the approach taken. When appending a data field, the current total is multiplied by the + * multiplier then a relevant value + * for that data type is added. For example, if the current hashCode is 17, and the multiplier is 37, then + * appending the integer 45 will create a hashcode of 674, namely 17 * 37 + 45. + *

+ * + *

+ * All relevant fields from the object should be included in the hashCode method. Derived fields may be + * excluded. In general, any field used in the equals method must be used in the hashCode + * method. + *

+ * + *

+ * To use this class write code as follows: + *

+ * + * 
+ * public class Person {
+ *   String name;
+ *   int age;
+ *   boolean smoker;
+ *   ...
+ *
+ *   public int hashCode() {
+ *     // you pick a hard-coded, randomly chosen, non-zero, odd number
+ *     // ideally different for each class
+ *     return new HashCodeBuilder(17, 37).
+ *       append(name).
+ *       append(age).
+ *       append(smoker).
+ *       toHashCode();
+ *   }
+ * }
+ *
+ * + *

+ * If required, the superclass hashCode() can be added using {@link #appendSuper}. + *

+ * + *

+ * Alternatively, there is a method that uses reflection to determine the fields to test. Because these fields are + * usually private, the method, reflectionHashCode, uses AccessibleObject.setAccessible + * to change the visibility of the fields. This will fail under a security manager, unless the appropriate permissions + * are set up correctly. It is also slower than testing explicitly. + *

+ * + *

+ * A typical invocation for this method would look like: + *

+ * + * 
+ * public int hashCode() {
+ *   return HashCodeBuilder.reflectionHashCode(this);
+ * }
+ *
+ * + * TODO 待整理 + * 来自于Apache-Commons-Lang3 + * @author looly，Apache-Commons + * @since 4.2.2 + */ +public class HashCodeBuilder implements Builder { + private static final long serialVersionUID = 1L; + + /** + * The default initial value to use in reflection hash code building. + */ + private static final int DEFAULT_INITIAL_VALUE = 17; + + /** + * The default multipler value to use in reflection hash code building. + */ + private static final int DEFAULT_MULTIPLIER_VALUE = 37; + + /** + *

+ * A registry of objects used by reflection methods to detect cyclical object references and avoid infinite loops. + *

+ * + * @since 2.3 + */ + private static final ThreadLocal> REGISTRY = new ThreadLocal<>(); + + /* + * NOTE: we cannot store the actual objects in a HashSet, as that would use the very hashCode() + * we are in the process of calculating. + * + * So we generate a one-to-one mapping from the original object to a new object. + * + * Now HashSet uses equals() to determine if two elements with the same hashcode really + * are equal, so we also need to ensure that the replacement objects are only equal + * if the original objects are identical. + * + * The original implementation (2.4 and before) used the System.indentityHashCode() + * method - however this is not guaranteed to generate unique ids (e.g. LANG-459) + * + * We now use the IDKey helper class (adapted from org.apache.axis.utils.IDKey) + * to disambiguate the duplicate ids. + */ + + /** + *

+ * Returns the registry of objects being traversed by the reflection methods in the current thread. + *

+ * + * @return Set the registry of objects being traversed + * @since 2.3 + */ + private static Set getRegistry() { + return REGISTRY.get(); + } + + /** + *

+ * Returns true if the registry contains the given object. Used by the reflection methods to avoid + * infinite loops. + *

+ * + * @param value + * The object to lookup in the registry. + * @return boolean true if the registry contains the given object. + * @since 2.3 + */ + private static boolean isRegistered(final Object value) { + final Set registry = getRegistry(); + return registry != null && registry.contains(new IDKey(value)); + } + + /** + *

+ * Appends the fields and values defined by the given object of the given Class. + *

+ * + * @param object + * the object to append details of + * @param clazz + * the class to append details of + * @param builder + * the builder to append to + * @param useTransients + * whether to use transient fields + * @param excludeFields + * Collection of String field names to exclude from use in calculation of hash code + */ + private static void reflectionAppend(final Object object, final Class clazz, final HashCodeBuilder builder, final boolean useTransients, + final String[] excludeFields) { + if (isRegistered(object)) { + return; + } + try { + register(object); + final Field[] fields = clazz.getDeclaredFields(); + AccessibleObject.setAccessible(fields, true); + for (final Field field : fields) { + if (false == ArrayUtil.contains(excludeFields, field.getName()) + && (field.getName().indexOf('$') == -1) + && (useTransients || !Modifier.isTransient(field.getModifiers())) + && (!Modifier.isStatic(field.getModifiers()))) { + try { + final Object fieldValue = field.get(object); + builder.append(fieldValue); + } catch (final IllegalAccessException e) { + // this can't happen. Would get a Security exception instead + // throw a runtime exception in case the impossible happens. + throw new InternalError("Unexpected IllegalAccessException"); + } + } + } + } finally { + unregister(object); + } + } + + /** + *

+ * Uses reflection to build a valid hash code from the fields of {@code object}. + *

+ * + *

+ * It uses AccessibleObject.setAccessible to gain access to private fields. This means that it will + * throw a security exception if run under a security manager, if the permissions are not set up correctly. It is + * also not as efficient as testing explicitly. + *

+ * + *

+ * Transient members will be not be used, as they are likely derived fields, and not part of the value of the + * Object. + *

+ * + *

+ * Static fields will not be tested. Superclass fields will be included. + *

+ * + *

+ * Two randomly chosen, non-zero, odd numbers must be passed in. Ideally these should be different for each class, + * however this is not vital. Prime numbers are preferred, especially for the multiplier. + *

+ * + * @param initialNonZeroOddNumber + * a non-zero, odd number used as the initial value. This will be the returned + * value if no fields are found to include in the hash code + * @param multiplierNonZeroOddNumber + * a non-zero, odd number used as the multiplier + * @param object + * the Object to create a hashCode for + * @return int hash code + * @throws IllegalArgumentException + * if the Object is null + * @throws IllegalArgumentException + * if the number is zero or even + */ + public static int reflectionHashCode(final int initialNonZeroOddNumber, final int multiplierNonZeroOddNumber, final Object object) { + return reflectionHashCode(initialNonZeroOddNumber, multiplierNonZeroOddNumber, object, false, null); + } + + /** + *

+ * Uses reflection to build a valid hash code from the fields of {@code object}. + *

+ * + *

+ * It uses AccessibleObject.setAccessible to gain access to private fields. This means that it will + * throw a security exception if run under a security manager, if the permissions are not set up correctly. It is + * also not as efficient as testing explicitly. + *

+ * + *

+ * If the TestTransients parameter is set to true, transient members will be tested, otherwise they + * are ignored, as they are likely derived fields, and not part of the value of the Object. + *

+ * + *

+ * Static fields will not be tested. Superclass fields will be included. + *

+ * + *

+ * Two randomly chosen, non-zero, odd numbers must be passed in. Ideally these should be different for each class, + * however this is not vital. Prime numbers are preferred, especially for the multiplier. + *

+ * + * @param initialNonZeroOddNumber + * a non-zero, odd number used as the initial value. This will be the returned + * value if no fields are found to include in the hash code + * @param multiplierNonZeroOddNumber + * a non-zero, odd number used as the multiplier + * @param object + * the Object to create a hashCode for + * @param testTransients + * whether to include transient fields + * @return int hash code + * @throws IllegalArgumentException + * if the Object is null + * @throws IllegalArgumentException + * if the number is zero or even + */ + public static int reflectionHashCode(final int initialNonZeroOddNumber, final int multiplierNonZeroOddNumber, final Object object, + final boolean testTransients) { + return reflectionHashCode(initialNonZeroOddNumber, multiplierNonZeroOddNumber, object, testTransients, null); + } + + /** + *

+ * Uses reflection to build a valid hash code from the fields of {@code object}. + *

+ * + *

+ * It uses AccessibleObject.setAccessible to gain access to private fields. This means that it will + * throw a security exception if run under a security manager, if the permissions are not set up correctly. It is + * also not as efficient as testing explicitly. + *

+ * + *

+ * If the TestTransients parameter is set to true, transient members will be tested, otherwise they + * are ignored, as they are likely derived fields, and not part of the value of the Object. + *

+ * + *

+ * Static fields will not be included. Superclass fields will be included up to and including the specified + * superclass. A null superclass is treated as java.lang.Object. + *

+ * + *

+ * Two randomly chosen, non-zero, odd numbers must be passed in. Ideally these should be different for each class, + * however this is not vital. Prime numbers are preferred, especially for the multiplier. + *

+ * + * @param + * the type of the object involved + * @param initialNonZeroOddNumber + * a non-zero, odd number used as the initial value. This will be the returned + * value if no fields are found to include in the hash code + * @param multiplierNonZeroOddNumber + * a non-zero, odd number used as the multiplier + * @param object + * the Object to create a hashCode for + * @param testTransients + * whether to include transient fields + * @param reflectUpToClass + * the superclass to reflect up to (inclusive), may be null + * @param excludeFields + * array of field names to exclude from use in calculation of hash code + * @return int hash code + * @throws IllegalArgumentException + * if the Object is null + * @throws IllegalArgumentException + * if the number is zero or even + * @since 2.0 + */ + public static int reflectionHashCode(final int initialNonZeroOddNumber, final int multiplierNonZeroOddNumber, final T object, + final boolean testTransients, final Class reflectUpToClass, final String... excludeFields) { + + if (object == null) { + throw new IllegalArgumentException("The object to build a hash code for must not be null"); + } + final HashCodeBuilder builder = new HashCodeBuilder(initialNonZeroOddNumber, multiplierNonZeroOddNumber); + Class clazz = object.getClass(); + reflectionAppend(object, clazz, builder, testTransients, excludeFields); + while (clazz.getSuperclass() != null && clazz != reflectUpToClass) { + clazz = clazz.getSuperclass(); + reflectionAppend(object, clazz, builder, testTransients, excludeFields); + } + return builder.toHashCode(); + } + + /** + *

+ * Uses reflection to build a valid hash code from the fields of {@code object}. + *

+ * + *

+ * This constructor uses two hard coded choices for the constants needed to build a hash code. + *

+ * + *

+ * It uses AccessibleObject.setAccessible to gain access to private fields. This means that it will + * throw a security exception if run under a security manager, if the permissions are not set up correctly. It is + * also not as efficient as testing explicitly. + *

+ * + *

+ * If the TestTransients parameter is set to true, transient members will be tested, otherwise they + * are ignored, as they are likely derived fields, and not part of the value of the Object. + *

+ * + *

+ * Static fields will not be tested. Superclass fields will be included. If no fields are found to include + * in the hash code, the result of this method will be constant. + *

+ * + * @param object + * the Object to create a hashCode for + * @param testTransients + * whether to include transient fields + * @return int hash code + * @throws IllegalArgumentException + * if the object is null + */ + public static int reflectionHashCode(final Object object, final boolean testTransients) { + return reflectionHashCode(DEFAULT_INITIAL_VALUE, DEFAULT_MULTIPLIER_VALUE, object, + testTransients, null); + } + + /** + *

+ * Uses reflection to build a valid hash code from the fields of {@code object}. + *

+ * + *

+ * This constructor uses two hard coded choices for the constants needed to build a hash code. + *

+ * + *

+ * It uses AccessibleObject.setAccessible to gain access to private fields. This means that it will + * throw a security exception if run under a security manager, if the permissions are not set up correctly. It is + * also not as efficient as testing explicitly. + *

+ * + *

+ * Transient members will be not be used, as they are likely derived fields, and not part of the value of the + * Object. + *

+ * + *

+ * Static fields will not be tested. Superclass fields will be included. If no fields are found to include + * in the hash code, the result of this method will be constant. + *

+ * + * @param object + * the Object to create a hashCode for + * @param excludeFields + * Collection of String field names to exclude from use in calculation of hash code + * @return int hash code + * @throws IllegalArgumentException + * if the object is null + */ + public static int reflectionHashCode(final Object object, final Collection excludeFields) { + return reflectionHashCode(object, ArrayUtil.toArray(excludeFields, String.class)); + } + + // ------------------------------------------------------------------------- + + /** + *

+ * Uses reflection to build a valid hash code from the fields of {@code object}. + *

+ * + *

+ * This constructor uses two hard coded choices for the constants needed to build a hash code. + *

+ * + *

+ * It uses AccessibleObject.setAccessible to gain access to private fields. This means that it will + * throw a security exception if run under a security manager, if the permissions are not set up correctly. It is + * also not as efficient as testing explicitly. + *

+ * + *

+ * Transient members will be not be used, as they are likely derived fields, and not part of the value of the + * Object. + *

+ * + *

+ * Static fields will not be tested. Superclass fields will be included. If no fields are found to include + * in the hash code, the result of this method will be constant. + *

+ * + * @param object + * the Object to create a hashCode for + * @param excludeFields + * array of field names to exclude from use in calculation of hash code + * @return int hash code + * @throws IllegalArgumentException + * if the object is null + */ + public static int reflectionHashCode(final Object object, final String... excludeFields) { + return reflectionHashCode(DEFAULT_INITIAL_VALUE, DEFAULT_MULTIPLIER_VALUE, object, false, + null, excludeFields); + } + + /** + *

+ * Registers the given object. Used by the reflection methods to avoid infinite loops. + *

+ * + * @param value + * The object to register. + */ + static void register(final Object value) { + synchronized (HashCodeBuilder.class) { + if (getRegistry() == null) { + REGISTRY.set(new HashSet()); + } + } + getRegistry().add(new IDKey(value)); + } + + /** + *

+ * Unregisters the given object. + *

+ * + *

+ * Used by the reflection methods to avoid infinite loops. + * + * @param value + * The object to unregister. + * @since 2.3 + */ + static void unregister(final Object value) { + Set registry = getRegistry(); + if (registry != null) { + registry.remove(new IDKey(value)); + synchronized (HashCodeBuilder.class) { + //read again + registry = getRegistry(); + if (registry != null && registry.isEmpty()) { + REGISTRY.remove(); + } + } + } + } + + /** + * Constant to use in building the hashCode. + */ + private final int iConstant; + + /** + * Running total of the hashCode. + */ + private int iTotal; + + /** + *

+ * Uses two hard coded choices for the constants needed to build a hashCode. + *

+ */ + public HashCodeBuilder() { + iConstant = 37; + iTotal = 17; + } + + /** + *

+ * Two randomly chosen, odd numbers must be passed in. Ideally these should be different for each class, + * however this is not vital. + *

+ * + *

+ * Prime numbers are preferred, especially for the multiplier. + *

+ * + * @param initialOddNumber + * an odd number used as the initial value + * @param multiplierOddNumber + * an odd number used as the multiplier + * @throws IllegalArgumentException + * if the number is even + */ + public HashCodeBuilder(final int initialOddNumber, final int multiplierOddNumber) { + Assert.isTrue(initialOddNumber % 2 != 0, "HashCodeBuilder requires an odd initial value"); + Assert.isTrue(multiplierOddNumber % 2 != 0, "HashCodeBuilder requires an odd multiplier"); + iConstant = multiplierOddNumber; + iTotal = initialOddNumber; + } + + /** + *

+ * Append a hashCode for a boolean. + *

+ *

+ * This adds 1 when true, and 0 when false to the hashCode. + *

+ *

+ * This is in contrast to the standard java.lang.Boolean.hashCode handling, which computes + * a hashCode value of 1231 for java.lang.Boolean instances + * that represent true or 1237 for java.lang.Boolean instances + * that represent false. + *

+ *

+ * This is in accordance with the Effective Java design. + *

+ * + * @param value + * the boolean to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final boolean value) { + iTotal = iTotal * iConstant + (value ? 0 : 1); + return this; + } + + /** + *

+ * Append a hashCode for a boolean array. + *

+ * + * @param array + * the array to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final boolean[] array) { + if (array == null) { + iTotal = iTotal * iConstant; + } else { + for (final boolean element : array) { + append(element); + } + } + return this; + } + + // ------------------------------------------------------------------------- + + /** + *

+ * Append a hashCode for a byte. + *

+ * + * @param value + * the byte to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final byte value) { + iTotal = iTotal * iConstant + value; + return this; + } + + // ------------------------------------------------------------------------- + + /** + *

+ * Append a hashCode for a byte array. + *

+ * + * @param array + * the array to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final byte[] array) { + if (array == null) { + iTotal = iTotal * iConstant; + } else { + for (final byte element : array) { + append(element); + } + } + return this; + } + + /** + *

+ * Append a hashCode for a char. + *

+ * + * @param value + * the char to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final char value) { + iTotal = iTotal * iConstant + value; + return this; + } + + /** + *

+ * Append a hashCode for a char array. + *

+ * + * @param array + * the array to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final char[] array) { + if (array == null) { + iTotal = iTotal * iConstant; + } else { + for (final char element : array) { + append(element); + } + } + return this; + } + + /** + *

+ * Append a hashCode for a double. + *

+ * + * @param value + * the double to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final double value) { + return append(Double.doubleToLongBits(value)); + } + + /** + *

+ * Append a hashCode for a double array. + *

+ * + * @param array + * the array to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final double[] array) { + if (array == null) { + iTotal = iTotal * iConstant; + } else { + for (final double element : array) { + append(element); + } + } + return this; + } + + /** + *

+ * Append a hashCode for a float. + *

+ * + * @param value + * the float to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final float value) { + iTotal = iTotal * iConstant + Float.floatToIntBits(value); + return this; + } + + /** + *

+ * Append a hashCode for a float array. + *

+ * + * @param array + * the array to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final float[] array) { + if (array == null) { + iTotal = iTotal * iConstant; + } else { + for (final float element : array) { + append(element); + } + } + return this; + } + + /** + *

+ * Append a hashCode for an int. + *

+ * + * @param value + * the int to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final int value) { + iTotal = iTotal * iConstant + value; + return this; + } + + /** + *

+ * Append a hashCode for an int array. + *

+ * + * @param array + * the array to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final int[] array) { + if (array == null) { + iTotal = iTotal * iConstant; + } else { + for (final int element : array) { + append(element); + } + } + return this; + } + + /** + *

+ * Append a hashCode for a long. + *

+ * + * @param value + * the long to add to the hashCode + * @return this + */ + // NOTE: This method uses >> and not >>> as Effective Java and + // Long.hashCode do. Ideally we should switch to >>> at + // some stage. There are backwards compat issues, so + // that will have to wait for the time being. cf LANG-342. + public HashCodeBuilder append(final long value) { + iTotal = iTotal * iConstant + ((int) (value ^ (value >> 32))); + return this; + } + + /** + *

+ * Append a hashCode for a long array. + *

+ * + * @param array + * the array to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final long[] array) { + if (array == null) { + iTotal = iTotal * iConstant; + } else { + for (final long element : array) { + append(element); + } + } + return this; + } + + /** + *

+ * Append a hashCode for an Object. + *

+ * + * @param object + * the Object to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final Object object) { + if (object == null) { + iTotal = iTotal * iConstant; + + } else { + if(object.getClass().isArray()) { + // 'Switch' on type of array, to dispatch to the correct handler + // This handles multi dimensional arrays + if (object instanceof long[]) { + append((long[]) object); + } else if (object instanceof int[]) { + append((int[]) object); + } else if (object instanceof short[]) { + append((short[]) object); + } else if (object instanceof char[]) { + append((char[]) object); + } else if (object instanceof byte[]) { + append((byte[]) object); + } else if (object instanceof double[]) { + append((double[]) object); + } else if (object instanceof float[]) { + append((float[]) object); + } else if (object instanceof boolean[]) { + append((boolean[]) object); + } else { + // Not an array of primitives + append((Object[]) object); + } + } else { + iTotal = iTotal * iConstant + object.hashCode(); + } + } + return this; + } + + /** + *

+ * Append a hashCode for an Object array. + *

+ * + * @param array + * the array to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final Object[] array) { + if (array == null) { + iTotal = iTotal * iConstant; + } else { + for (final Object element : array) { + append(element); + } + } + return this; + } + + /** + *

+ * Append a hashCode for a short. + *

+ * + * @param value + * the short to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final short value) { + iTotal = iTotal * iConstant + value; + return this; + } + + /** + *

+ * Append a hashCode for a short array. + *

+ * + * @param array + * the array to add to the hashCode + * @return this + */ + public HashCodeBuilder append(final short[] array) { + if (array == null) { + iTotal = iTotal * iConstant; + } else { + for (final short element : array) { + append(element); + } + } + return this; + } + + /** + *

+ * Adds the result of super.hashCode() to this builder. + *

+ * + * @param superHashCode + * the result of calling super.hashCode() + * @return this HashCodeBuilder, used to chain calls. + * @since 2.0 + */ + public HashCodeBuilder appendSuper(final int superHashCode) { + iTotal = iTotal * iConstant + superHashCode; + return this; + } + + /** + *

+ * Return the computed hashCode. + *

+ * + * @return hashCode based on the fields appended + */ + public int toHashCode() { + return iTotal; + } + + /** + * Returns the computed hashCode. + * + * @return hashCode based on the fields appended + * + * @since 3.0 + */ + @Override + public Integer build() { + return toHashCode(); + } + + /** + *

+ * The computed hashCode from toHashCode() is returned due to the likelihood + * of bugs in mis-calling toHashCode() and the unlikeliness of it mattering what the hashCode for + * HashCodeBuilder itself is.

+ * + * @return hashCode based on the fields appended + * @since 2.5 + */ + @Override + public int hashCode() { + return toHashCode(); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/IDKey.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/IDKey.java new file mode 100644 index 0000000..c119d20 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/IDKey.java @@ -0,0 +1,61 @@ +package aiyh.utils.tool.cn.hutool.core.builder; + +import java.io.Serializable; + +/** + * 包装唯一键（System.identityHashCode()）使对象只有和自己 equals + * + * 此对象用于消除小概率下System.identityHashCode()产生的ID重复问题。 + * + * 来自于Apache-Commons-Lang3 + * @author looly，Apache-Commons + * @since 4.2.2 + */ +final class IDKey implements Serializable{ + private static final long serialVersionUID = 1L; + + private final Object value; + private final int id; + + /** + * 构造 + * + * @param obj 计算唯一ID的对象 + */ + public IDKey(final Object obj) { + id = System.identityHashCode(obj); + // There have been some cases (LANG-459) that return the + // same identity hash code for different objects. So + // the value is also added to disambiguate these cases. + value = obj; + } + + /** + * returns hashcode - i.e. the system identity hashcode. + * + * @return the hashcode + */ + @Override + public int hashCode() { + return id; + } + + /** + * checks if instances are equal + * + * @param other The other object to compare to + * @return if the instances are for the same object + */ + @Override + public boolean equals(final Object other) { + if (!(other instanceof IDKey)) { + return false; + } + final IDKey idKey = (IDKey) other; + if (id != idKey.id) { + return false; + } + // Note that identity equals is used. + return value == idKey.value; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/package-info.java new file mode 100644 index 0000000..f3c9e62 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/builder/package-info.java @@ -0,0 +1,8 @@ +/** + * 建造者工具
+ * 用于建造特定对象或结果 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.builder; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/CloneRuntimeException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/CloneRuntimeException.java new file mode 100644 index 0000000..8117d4b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/CloneRuntimeException.java @@ -0,0 +1,32 @@ +package aiyh.utils.tool.cn.hutool.core.clone; + +import aiyh.utils.tool.cn.hutool.core.exceptions.ExceptionUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 克隆异常 + * @author xiaoleilu + */ +public class CloneRuntimeException extends RuntimeException{ + private static final long serialVersionUID = 6774837422188798989L; + + public CloneRuntimeException(Throwable e) { + super(ExceptionUtil.getMessage(e), e); + } + + public CloneRuntimeException(String message) { + super(message); + } + + public CloneRuntimeException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public CloneRuntimeException(String message, Throwable throwable) { + super(message, throwable); + } + + public CloneRuntimeException(Throwable throwable, String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params), throwable); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/CloneSupport.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/CloneSupport.java new file mode 100644 index 0000000..ed11164 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/CloneSupport.java @@ -0,0 +1,21 @@ +package aiyh.utils.tool.cn.hutool.core.clone; + +/** + * 克隆支持类，提供默认的克隆方法 + * @author Looly + * + * @param 继承类的类型 + */ +public class CloneSupport implements Cloneable{ + + @SuppressWarnings("unchecked") + @Override + public T clone() { + try { + return (T) super.clone(); + } catch (CloneNotSupportedException e) { + throw new CloneRuntimeException(e); + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/Cloneable.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/Cloneable.java new file mode 100644 index 0000000..82e08a9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/Cloneable.java @@ -0,0 +1,16 @@ +package aiyh.utils.tool.cn.hutool.core.clone; + +/** + * 克隆支持接口 + * @author Looly + * + * @param 实现克隆接口的类型 + */ +public interface Cloneable extends java.lang.Cloneable{ + + /** + * 克隆当前对象，浅复制 + * @return 克隆后的对象 + */ + T clone(); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/DefaultCloneable.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/DefaultCloneable.java new file mode 100644 index 0000000..bde09a7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/DefaultCloneable.java @@ -0,0 +1,28 @@ +package aiyh.utils.tool.cn.hutool.core.clone; + + +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; + +/** + * 克隆默认实现接口，用于实现返回指定泛型类型的克隆方法 + * + * @param 泛型类型 + * @since 5.7.17 + */ +public interface DefaultCloneable extends java.lang.Cloneable { + + /** + * 浅拷贝，提供默认的泛型返回值的clone方法。 + * + * @return obj + */ + default T clone0() { + try { + return ReflectUtil.invoke(this, "clone"); + } catch (Exception e) { + throw new CloneRuntimeException(e); + } + } +} + + diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/package-info.java new file mode 100644 index 0000000..b910d98 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/clone/package-info.java @@ -0,0 +1,7 @@ +/** + * 克隆封装 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.clone; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/BCD.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/BCD.java new file mode 100644 index 0000000..6c71df8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/BCD.java @@ -0,0 +1,129 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +/** + * BCD码（Binary-Coded Decimal）亦称二进码十进数或二-十进制代码
+ * BCD码这种编码形式利用了四个位元来储存一个十进制的数码，使二进制和十进制之间的转换得以快捷的进行
+ * see http://cuisuqiang.iteye.com/blog/1429956 + * @author Looly + * + * @deprecated 由于对于ASCII的编码解码有缺陷，且这种BCD实现并不规范，因此会在6.0.0中移除 + */ +@Deprecated +public class BCD { + + /** + * 字符串转BCD码 + * @param asc ASCII字符串 + * @return BCD + */ + public static byte[] strToBcd(String asc) { + Assert.notNull(asc, "ASCII must not be null!"); + int len = asc.length(); + int mod = len % 2; + if (mod != 0) { + asc = "0" + asc; + len = asc.length(); + } + byte[] abt; + if (len >= 2) { + len >>= 1; + } + byte[] bbt; + bbt = new byte[len]; + abt = asc.getBytes(); + int j; + int k; + for (int p = 0; p < asc.length() / 2; p++) { + if ((abt[2 * p] >= '0') && (abt[2 * p] <= '9')) { + j = abt[2 * p] - '0'; + } else if ((abt[2 * p] >= 'a') && (abt[2 * p] <= 'z')) { + j = abt[2 * p] - 'a' + 0x0a; + } else { + j = abt[2 * p] - 'A' + 0x0a; + } + if ((abt[2 * p + 1] >= '0') && (abt[2 * p + 1] <= '9')) { + k = abt[2 * p + 1] - '0'; + } else if ((abt[2 * p + 1] >= 'a') && (abt[2 * p + 1] <= 'z')) { + k = abt[2 * p + 1] - 'a' + 0x0a; + } else { + k = abt[2 * p + 1] - 'A' + 0x0a; + } + int a = (j << 4) + k; + byte b = (byte) a; + bbt[p] = b; + } + return bbt; + } + + /** + * ASCII转BCD + * @param ascii ASCII byte数组 + * @return BCD + */ + public static byte[] ascToBcd(byte[] ascii) { + Assert.notNull(ascii, "Ascii must be not null!"); + return ascToBcd(ascii, ascii.length); + } + + /** + * ASCII转BCD + * @param ascii ASCII byte数组 + * @param ascLength 长度 + * @return BCD + */ + public static byte[] ascToBcd(byte[] ascii, int ascLength) { + Assert.notNull(ascii, "Ascii must be not null!"); + byte[] bcd = new byte[ascLength / 2]; + int j = 0; + for (int i = 0; i < (ascLength + 1) / 2; i++) { + bcd[i] = ascToBcd(ascii[j++]); + bcd[i] = (byte) (((j >= ascLength) ? 0x00 : ascToBcd(ascii[j++])) + (bcd[i] << 4)); + } + return bcd; + } + + /** + * BCD转ASCII字符串 + * @param bytes BCD byte数组 + * @return ASCII字符串 + */ + public static String bcdToStr(byte[] bytes) { + Assert.notNull(bytes, "Bcd bytes must be not null!"); + char[] temp = new char[bytes.length * 2]; + char val; + + for (int i = 0; i < bytes.length; i++) { + val = (char) (((bytes[i] & 0xf0) >> 4) & 0x0f); + temp[i * 2] = (char) (val > 9 ? val + 'A' - 10 : val + '0'); + + val = (char) (bytes[i] & 0x0f); + temp[i * 2 + 1] = (char) (val > 9 ? val + 'A' - 10 : val + '0'); + } + return new String(temp); + } + + + //----------------------------------------------------------------- Private method start + /** + * 转换单个byte为BCD + * @param asc ACSII + * @return BCD + */ + private static byte ascToBcd(byte asc) { + byte bcd; + + if ((asc >= '0') && (asc <= '9')) { + bcd = (byte) (asc - '0'); + }else if ((asc >= 'A') && (asc <= 'F')) { + bcd = (byte) (asc - 'A' + 10); + }else if ((asc >= 'a') && (asc <= 'f')) { + bcd = (byte) (asc - 'a' + 10); + }else { + bcd = (byte) (asc - 48); + } + return bcd; + } + //----------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base16Codec.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base16Codec.java new file mode 100644 index 0000000..cd50c9e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base16Codec.java @@ -0,0 +1,118 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * Base16（Hex）编码解码器
+ * 十六进制（简写为hex或下标16）在数学中是一种逢16进1的进位制，一般用数字0到9和字母A到F表示（其中:A~F即10~15）。
+ * 例如十进制数57，在二进制写作111001，在16进制写作39。 + * + * @author looly + * @since 5.7.23 + */ +public class Base16Codec implements Encoder, Decoder { + + public static final Base16Codec CODEC_LOWER = new Base16Codec(true); + public static final Base16Codec CODEC_UPPER = new Base16Codec(false); + + private final char[] alphabets; + + /** + * 构造 + * + * @param lowerCase 是否小写 + */ + public Base16Codec(boolean lowerCase) { + this.alphabets = (lowerCase ? "0123456789abcdef" : "0123456789ABCDEF").toCharArray(); + } + + @Override + public char[] encode(byte[] data) { + final int len = data.length; + final char[] out = new char[len << 1];//len*2 + // two characters from the hex value. + for (int i = 0, j = 0; i < len; i++) { + out[j++] = alphabets[(0xF0 & data[i]) >>> 4];// 高位 + out[j++] = alphabets[0x0F & data[i]];// 低位 + } + return out; + } + + @Override + public byte[] decode(CharSequence encoded) { + if (StrUtil.isEmpty(encoded)) { + return null; + } + + encoded = StrUtil.cleanBlank(encoded); + int len = encoded.length(); + + if ((len & 0x01) != 0) { + // 如果提供的数据是奇数长度，则前面补0凑偶数 + encoded = "0" + encoded; + len = encoded.length(); + } + + final byte[] out = new byte[len >> 1]; + + // two characters form the hex value. + for (int i = 0, j = 0; j < len; i++) { + int f = toDigit(encoded.charAt(j), j) << 4; + j++; + f = f | toDigit(encoded.charAt(j), j); + j++; + out[i] = (byte) (f & 0xFF); + } + + return out; + } + + /** + * 将指定char值转换为Unicode字符串形式，常用于特殊字符（例如汉字）转Unicode形式
+ * 转换的字符串如果u后不足4位，则前面用0填充，例如： + * + * 
+	 * '你' =》'\u4f60'
+	 *
+ * + * @param ch char值 + * @return Unicode表现形式 + */ + public String toUnicodeHex(char ch) { + return "\\u" +// + alphabets[(ch >> 12) & 15] +// + alphabets[(ch >> 8) & 15] +// + alphabets[(ch >> 4) & 15] +// + alphabets[(ch) & 15]; + } + + /** + * 将byte值转为16进制并添加到{@link StringBuilder}中 + * + * @param builder {@link StringBuilder} + * @param b byte + */ + public void appendHex(StringBuilder builder, byte b) { + int high = (b & 0xf0) >>> 4;//高位 + int low = b & 0x0f;//低位 + builder.append(alphabets[high]); + builder.append(alphabets[low]); + } + + /** + * 将十六进制字符转换成一个整数 + * + * @param ch 十六进制char + * @param index 十六进制字符在字符数组中的位置 + * @return 一个整数 + * @throws UtilException 当ch不是一个合法的十六进制字符时，抛出运行时异常 + */ + private static int toDigit(char ch, int index) { + int digit = Character.digit(ch, 16); + if (digit < 0) { + throw new UtilException("Illegal hexadecimal character {} at index {}", ch, index); + } + return digit; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base32.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base32.java new file mode 100644 index 0000000..43147f7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base32.java @@ -0,0 +1,148 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.nio.charset.Charset; + +/** + * Base32 - encodes and decodes RFC4648 Base32 (see https://datatracker.ietf.org/doc/html/rfc4648#section-6 )
+ * base32就是用32（2的5次方）个特定ASCII码来表示256个ASCII码。
+ * 所以，5个ASCII字符经过base32编码后会变为8个字符（公约数为40），长度增加3/5.不足8n用“=”补足。
+ * 根据RFC4648 Base32规范，支持两种模式： + *
    + *
  • Base 32 Alphabet (ABCDEFGHIJKLMNOPQRSTUVWXYZ234567)
    • + *
  • "Extended Hex" Base 32 Alphabet (0123456789ABCDEFGHIJKLMNOPQRSTUV)
    • + *
+ * + * @author Looly + */ +public class Base32 { + //----------------------------------------------------------------------------------------- encode + + /** + * 编码 + * + * @param bytes 数据 + * @return base32 + */ + public static String encode(final byte[] bytes) { + return Base32Codec.INSTANCE.encode(bytes); + } + + /** + * base32编码 + * + * @param source 被编码的base32字符串 + * @return 被加密后的字符串 + */ + public static String encode(String source) { + return encode(source, CharsetUtil.CHARSET_UTF_8); + } + + /** + * base32编码 + * + * @param source 被编码的base32字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + */ + public static String encode(String source, Charset charset) { + return encode(StrUtil.bytes(source, charset)); + } + + /** + * 编码 + * + * @param bytes 数据（Hex模式） + * @return base32 + */ + public static String encodeHex(final byte[] bytes) { + return Base32Codec.INSTANCE.encode(bytes, true); + } + + /** + * base32编码（Hex模式） + * + * @param source 被编码的base32字符串 + * @return 被加密后的字符串 + */ + public static String encodeHex(String source) { + return encodeHex(source, CharsetUtil.CHARSET_UTF_8); + } + + /** + * base32编码（Hex模式） + * + * @param source 被编码的base32字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + */ + public static String encodeHex(String source, Charset charset) { + return encodeHex(StrUtil.bytes(source, charset)); + } + + //----------------------------------------------------------------------------------------- decode + + /** + * 解码 + * + * @param base32 base32编码 + * @return 数据 + */ + public static byte[] decode(String base32) { + return Base32Codec.INSTANCE.decode(base32); + } + + /** + * base32解码 + * + * @param source 被解码的base32字符串 + * @return 被加密后的字符串 + */ + public static String decodeStr(String source) { + return decodeStr(source, CharsetUtil.CHARSET_UTF_8); + } + + /** + * base32解码 + * + * @param source 被解码的base32字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + */ + public static String decodeStr(String source, Charset charset) { + return StrUtil.str(decode(source), charset); + } + + /** + * 解码 + * + * @param base32 base32编码 + * @return 数据 + */ + public static byte[] decodeHex(String base32) { + return Base32Codec.INSTANCE.decode(base32, true); + } + + /** + * base32解码 + * + * @param source 被解码的base32字符串 + * @return 被加密后的字符串 + */ + public static String decodeStrHex(String source) { + return decodeStrHex(source, CharsetUtil.CHARSET_UTF_8); + } + + /** + * base32解码 + * + * @param source 被解码的base32字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + */ + public static String decodeStrHex(String source, Charset charset) { + return StrUtil.str(decodeHex(source), charset); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base32Codec.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base32Codec.java new file mode 100755 index 0000000..954507c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base32Codec.java @@ -0,0 +1,215 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import java.util.Arrays; + +/** + * Base32 - encodes and decodes RFC4648 Base32 (see https://datatracker.ietf.org/doc/html/rfc4648#section-6 )
+ * base32就是用32（2的5次方）个特定ASCII码来表示256个ASCII码。
+ * 所以，5个ASCII字符经过base32编码后会变为8个字符（公约数为40），长度增加3/5.不足8n用“=”补足。
+ * 根据RFC4648 Base32规范，支持两种模式： + *
    + *
  • Base 32 Alphabet (ABCDEFGHIJKLMNOPQRSTUVWXYZ234567)
    • + *
  • "Extended Hex" Base 32 Alphabet (0123456789ABCDEFGHIJKLMNOPQRSTUV)
    • + *
+ * + * @author Looly + * @since 5.8.0 + */ +public class Base32Codec implements Encoder, Decoder { + + public static Base32Codec INSTANCE = new Base32Codec(); + + @Override + public String encode(byte[] data) { + return encode(data, false); + } + + /** + * 编码数据 + * + * @param data 数据 + * @param useHex 是否使用Hex Alphabet + * @return 编码后的Base32字符串 + */ + public String encode(byte[] data, boolean useHex) { + final Base32Encoder encoder = useHex ? Base32Encoder.HEX_ENCODER : Base32Encoder.ENCODER; + return encoder.encode(data); + } + + @Override + public byte[] decode(CharSequence encoded) { + return decode(encoded, false); + } + + /** + * 解码数据 + * + * @param encoded base32字符串 + * @param useHex 是否使用Hex Alphabet + * @return 解码后的内容 + */ + public byte[] decode(CharSequence encoded, boolean useHex) { + final Base32Decoder decoder = useHex ? Base32Decoder.HEX_DECODER : Base32Decoder.DECODER; + return decoder.decode(encoded); + } + + /** + * Bas32编码器 + */ + public static class Base32Encoder implements Encoder { + private static final String DEFAULT_ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567"; + private static final String HEX_ALPHABET = "0123456789ABCDEFGHIJKLMNOPQRSTUV"; + private static final Character DEFAULT_PAD = '='; + private static final int[] BASE32_FILL = {-1, 4, 1, 6, 3}; + + public static final Base32Encoder ENCODER = new Base32Encoder(DEFAULT_ALPHABET, DEFAULT_PAD); + public static final Base32Encoder HEX_ENCODER = new Base32Encoder(HEX_ALPHABET, DEFAULT_PAD); + + private final char[] alphabet; + private final Character pad; + + /** + * 构造 + * + * @param alphabet 自定义编码字母表，见 {@link #DEFAULT_ALPHABET}和 {@link #HEX_ALPHABET} + * @param pad 补位字符 + */ + public Base32Encoder(String alphabet, Character pad) { + this.alphabet = alphabet.toCharArray(); + this.pad = pad; + } + + @Override + public String encode(byte[] data) { + int i = 0; + int index = 0; + int digit; + int currByte; + int nextByte; + + int encodeLen = data.length * 8 / 5; + if (encodeLen != 0) { + encodeLen = encodeLen + 1 + BASE32_FILL[(data.length * 8) % 5]; + } + + StringBuilder base32 = new StringBuilder(encodeLen); + + while (i < data.length) { + // unsign + currByte = (data[i] >= 0) ? data[i] : (data[i] + 256); + + /* Is the current digit going to span a byte boundary? */ + if (index > 3) { + if ((i + 1) < data.length) { + nextByte = (data[i + 1] >= 0) ? data[i + 1] : (data[i + 1] + 256); + } else { + nextByte = 0; + } + + digit = currByte & (0xFF >> index); + index = (index + 5) % 8; + digit <<= index; + digit |= nextByte >> (8 - index); + i++; + } else { + digit = (currByte >> (8 - (index + 5))) & 0x1F; + index = (index + 5) % 8; + if (index == 0) { + i++; + } + } + base32.append(alphabet[digit]); + } + + if (null != pad) { + // 末尾补充不足长度的 + while (base32.length() < encodeLen) { + base32.append(pad.charValue()); + } + } + + return base32.toString(); + } + } + + /** + * Base32解码器 + */ + public static class Base32Decoder implements Decoder { + private static final char BASE_CHAR = '0'; + + public static final Base32Decoder DECODER = new Base32Decoder(Base32Encoder.DEFAULT_ALPHABET); + public static final Base32Decoder HEX_DECODER = new Base32Decoder(Base32Encoder.HEX_ALPHABET); + + private final byte[] lookupTable; + + /** + * 构造 + * + * @param alphabet 编码字母表 + */ + public Base32Decoder(String alphabet) { + lookupTable = new byte[128]; + Arrays.fill(lookupTable, (byte) -1); + + final int length = alphabet.length(); + + char c; + for (int i = 0; i < length; i++) { + c = alphabet.charAt(i); + lookupTable[c - BASE_CHAR] = (byte) i; + // 支持小写字母解码 + if(c >= 'A' && c <= 'Z'){ + lookupTable[Character.toLowerCase(c) - BASE_CHAR] = (byte) i; + } + } + } + + @Override + public byte[] decode(CharSequence encoded) { + int i, index, lookup, offset, digit; + final String base32 = encoded.toString(); + int len = base32.endsWith("=") ? base32.indexOf("=") * 5 / 8 : base32.length() * 5 / 8; + byte[] bytes = new byte[len]; + + for (i = 0, index = 0, offset = 0; i < base32.length(); i++) { + lookup = base32.charAt(i) - BASE_CHAR; + + /* Skip chars outside the lookup table */ + if (lookup < 0 || lookup >= lookupTable.length) { + continue; + } + + digit = lookupTable[lookup]; + + /* If this digit is not in the table, ignore it */ + if (digit < 0) { + continue; + } + + if (index <= 3) { + index = (index + 5) % 8; + if (index == 0) { + bytes[offset] |= digit; + offset++; + if (offset >= bytes.length) { + break; + } + } else { + bytes[offset] |= digit << (8 - index); + } + } else { + index = (index + 5) % 8; + bytes[offset] |= (digit >>> index); + offset++; + + if (offset >= bytes.length) { + break; + } + bytes[offset] |= digit << (8 - index); + } + } + return bytes; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base58.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base58.java new file mode 100644 index 0000000..b2135ec --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base58.java @@ -0,0 +1,152 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.exceptions.ValidateException; + +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.Arrays; + + +/** + * Base58工具类，提供Base58的编码和解码方案
+ * 参考： https://github.com/Anujraval24/Base58Encoding
+ * 规范见：https://en.bitcoin.it/wiki/Base58Check_encoding + * + * @author lin， looly + * @since 5.7.22 + */ +public class Base58 { + + private static final int CHECKSUM_SIZE = 4; + + // -------------------------------------------------------------------- encode + + /** + * Base58编码
+ * 包含版本位和校验位 + * + * @param version 编码版本，{@code null}表示不包含版本位 + * @param data 被编码的数组，添加校验和。 + * @return 编码后的字符串 + */ + public static String encodeChecked(Integer version, byte[] data) { + return encode(addChecksum(version, data)); + } + + /** + * Base58编码 + * + * @param data 被编码的数据，不带校验和。 + * @return 编码后的字符串 + */ + public static String encode(byte[] data) { + return Base58Codec.INSTANCE.encode(data); + } + // -------------------------------------------------------------------- decode + + /** + * Base58解码
+ * 解码包含标志位验证和版本呢位去除 + * + * @param encoded 被解码的base58字符串 + * @return 解码后的bytes + * @throws ValidateException 标志位验证错误抛出此异常 + */ + public static byte[] decodeChecked(CharSequence encoded) throws ValidateException { + try { + return decodeChecked(encoded, true); + } catch (ValidateException ignore) { + return decodeChecked(encoded, false); + } + } + + /** + * Base58解码
+ * 解码包含标志位验证和版本呢位去除 + * + * @param encoded 被解码的base58字符串 + * @param withVersion 是否包含版本位 + * @return 解码后的bytes + * @throws ValidateException 标志位验证错误抛出此异常 + */ + public static byte[] decodeChecked(CharSequence encoded, boolean withVersion) throws ValidateException { + byte[] valueWithChecksum = decode(encoded); + return verifyAndRemoveChecksum(valueWithChecksum, withVersion); + } + + /** + * Base58解码 + * + * @param encoded 被编码的base58字符串 + * @return 解码后的bytes + */ + public static byte[] decode(CharSequence encoded) { + return Base58Codec.INSTANCE.decode(encoded); + } + + /** + * 验证并去除验证位和版本位 + * + * @param data 编码的数据 + * @param withVersion 是否包含版本位 + * @return 载荷数据 + */ + private static byte[] verifyAndRemoveChecksum(byte[] data, boolean withVersion) { + final byte[] payload = Arrays.copyOfRange(data, withVersion ? 1 : 0, data.length - CHECKSUM_SIZE); + final byte[] checksum = Arrays.copyOfRange(data, data.length - CHECKSUM_SIZE, data.length); + final byte[] expectedChecksum = checksum(payload); + if (false == Arrays.equals(checksum, expectedChecksum)) { + throw new ValidateException("Base58 checksum is invalid"); + } + return payload; + } + + /** + * 数据 + 校验码 + * + * @param version 版本，{@code null}表示不添加版本位 + * @param payload Base58数据（不含校验码） + * @return Base58数据 + */ + private static byte[] addChecksum(Integer version, byte[] payload) { + final byte[] addressBytes; + if (null != version) { + addressBytes = new byte[1 + payload.length + CHECKSUM_SIZE]; + addressBytes[0] = (byte) version.intValue(); + System.arraycopy(payload, 0, addressBytes, 1, payload.length); + } else { + addressBytes = new byte[payload.length + CHECKSUM_SIZE]; + System.arraycopy(payload, 0, addressBytes, 0, payload.length); + } + final byte[] checksum = checksum(payload); + System.arraycopy(checksum, 0, addressBytes, addressBytes.length - CHECKSUM_SIZE, CHECKSUM_SIZE); + return addressBytes; + } + + /** + * 获取校验码
+ * 计算规则为对数据进行两次sha256计算，然后取{@link #CHECKSUM_SIZE}长度 + * + * @param data 数据 + * @return 校验码 + */ + private static byte[] checksum(byte[] data) { + byte[] hash = hash256(hash256(data)); + return Arrays.copyOfRange(hash, 0, CHECKSUM_SIZE); + } + + /** + * 计算数据的SHA-256值 + * + * @param data 数据 + * @return sha-256值 + */ + private static byte[] hash256(byte[] data) { + try { + return MessageDigest.getInstance("SHA-256").digest(data); + } catch (NoSuchAlgorithmException e) { + throw new UtilException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base58Codec.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base58Codec.java new file mode 100644 index 0000000..040496d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base58Codec.java @@ -0,0 +1,187 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.Arrays; + +/** + * Base58编码器
+ * 此编码器不包括校验码、版本等信息 + * + * @author lin， looly + * @since 5.7.22 + */ +public class Base58Codec implements Encoder, Decoder { + + public static Base58Codec INSTANCE = new Base58Codec(); + + /** + * Base58编码 + * + * @param data 被编码的数据，不带校验和。 + * @return 编码后的字符串 + */ + @Override + public String encode(byte[] data) { + return Base58Encoder.ENCODER.encode(data); + } + + /** + * 解码给定的Base58字符串 + * + * @param encoded Base58编码字符串 + * @return 解码后的bytes + * @throws IllegalArgumentException 非标准Base58字符串 + */ + @Override + public byte[] decode(CharSequence encoded) throws IllegalArgumentException { + return Base58Decoder.DECODER.decode(encoded); + } + + /** + * Base58编码器 + * + * @since 5.8.0 + */ + public static class Base58Encoder implements Encoder { + private static final String DEFAULT_ALPHABET = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"; + + public static final Base58Encoder ENCODER = new Base58Encoder(DEFAULT_ALPHABET.toCharArray()); + + private final char[] alphabet; + private final char alphabetZero; + + /** + * 构造 + * + * @param alphabet 编码字母表 + */ + public Base58Encoder(char[] alphabet) { + this.alphabet = alphabet; + alphabetZero = alphabet[0]; + } + + @Override + public String encode(byte[] data) { + if (null == data) { + return null; + } + if (data.length == 0) { + return StrUtil.EMPTY; + } + // 计算开头0的个数 + int zeroCount = 0; + while (zeroCount < data.length && data[zeroCount] == 0) { + ++zeroCount; + } + // 将256位编码转换为58位编码 + data = Arrays.copyOf(data, data.length); // since we modify it in-place + final char[] encoded = new char[data.length * 2]; // upper bound + int outputStart = encoded.length; + for (int inputStart = zeroCount; inputStart < data.length; ) { + encoded[--outputStart] = alphabet[divmod(data, inputStart, 256, 58)]; + if (data[inputStart] == 0) { + ++inputStart; // optimization - skip leading zeros + } + } + // Preserve exactly as many leading encoded zeros in output as there were leading zeros in input. + while (outputStart < encoded.length && encoded[outputStart] == alphabetZero) { + ++outputStart; + } + while (--zeroCount >= 0) { + encoded[--outputStart] = alphabetZero; + } + // Return encoded string (including encoded leading zeros). + return new String(encoded, outputStart, encoded.length - outputStart); + } + } + + /** + * Base58解码器 + * + * @since 5.8.0 + */ + public static class Base58Decoder implements Decoder { + + public static Base58Decoder DECODER = new Base58Decoder(Base58Encoder.DEFAULT_ALPHABET); + + private final byte[] lookupTable; + + /** + * 构造 + * + * @param alphabet 编码字符表 + */ + public Base58Decoder(String alphabet) { + final byte[] lookupTable = new byte['z' + 1]; + Arrays.fill(lookupTable, (byte) -1); + + final int length = alphabet.length(); + for (int i = 0; i < length; i++) { + lookupTable[alphabet.charAt(i)] = (byte) i; + } + this.lookupTable = lookupTable; + } + + @Override + public byte[] decode(CharSequence encoded) { + if (encoded.length() == 0) { + return new byte[0]; + } + // Convert the base58-encoded ASCII chars to a base58 byte sequence (base58 digits). + final byte[] input58 = new byte[encoded.length()]; + for (int i = 0; i < encoded.length(); ++i) { + char c = encoded.charAt(i); + int digit = c < 128 ? lookupTable[c] : -1; + if (digit < 0) { + throw new IllegalArgumentException(StrUtil.format("Invalid char '{}' at [{}]", c, i)); + } + input58[i] = (byte) digit; + } + // Count leading zeros. + int zeros = 0; + while (zeros < input58.length && input58[zeros] == 0) { + ++zeros; + } + // Convert base-58 digits to base-256 digits. + byte[] decoded = new byte[encoded.length()]; + int outputStart = decoded.length; + for (int inputStart = zeros; inputStart < input58.length; ) { + decoded[--outputStart] = divmod(input58, inputStart, 58, 256); + if (input58[inputStart] == 0) { + ++inputStart; // optimization - skip leading zeros + } + } + // Ignore extra leading zeroes that were added during the calculation. + while (outputStart < decoded.length && decoded[outputStart] == 0) { + ++outputStart; + } + // Return decoded data (including original number of leading zeros). + return Arrays.copyOfRange(decoded, outputStart - zeros, decoded.length); + } + } + + /** + * Divides a number, represented as an array of bytes each containing a single digit + * in the specified base, by the given divisor. The given number is modified in-place + * to contain the quotient, and the return value is the remainder. + * + * @param number the number to divide + * @param firstDigit the index within the array of the first non-zero digit + * (this is used for optimization by skipping the leading zeros) + * @param base the base in which the number's digits are represented (up to 256) + * @param divisor the number to divide by (up to 256) + * @return the remainder of the division operation + */ + private static byte divmod(byte[] number, int firstDigit, int base, int divisor) { + // this is just long division which accounts for the base of the input digits + int remainder = 0; + for (int i = firstDigit; i < number.length; i++) { + int digit = (int) number[i] & 0xFF; + int temp = remainder * base + digit; + number[i] = (byte) (temp / divisor); + remainder = temp % divisor; + } + return (byte) remainder; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base62.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base62.java new file mode 100644 index 0000000..f69a41d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base62.java @@ -0,0 +1,262 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.File; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.charset.Charset; + +/** + * Base62工具类，提供Base62的编码和解码方案
+ * + * @author Looly + * @since 4.5.9 + */ +public class Base62 { + + private static final Charset DEFAULT_CHARSET = CharsetUtil.CHARSET_UTF_8; + + // -------------------------------------------------------------------- encode + /** + * Base62编码 + * + * @param source 被编码的Base62字符串 + * @return 被加密后的字符串 + */ + public static String encode(CharSequence source) { + return encode(source, DEFAULT_CHARSET); + } + + /** + * Base62编码 + * + * @param source 被编码的Base62字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + */ + public static String encode(CharSequence source, Charset charset) { + return encode(StrUtil.bytes(source, charset)); + } + + /** + * Base62编码 + * + * @param source 被编码的Base62字符串 + * @return 被加密后的字符串 + */ + public static String encode(byte[] source) { + return new String(Base62Codec.INSTANCE.encode(source)); + } + + /** + * Base62编码 + * + * @param in 被编码Base62的流（一般为图片流或者文件流） + * @return 被加密后的字符串 + */ + public static String encode(InputStream in) { + return encode(IoUtil.readBytes(in)); + } + + /** + * Base62编码 + * + * @param file 被编码Base62的文件 + * @return 被加密后的字符串 + */ + public static String encode(File file) { + return encode(FileUtil.readBytes(file)); + } + + /** + * Base62编码（反转字母表模式） + * + * @param source 被编码的Base62字符串 + * @return 被加密后的字符串 + */ + public static String encodeInverted(CharSequence source) { + return encodeInverted(source, DEFAULT_CHARSET); + } + + /** + * Base62编码（反转字母表模式） + * + * @param source 被编码的Base62字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + */ + public static String encodeInverted(CharSequence source, Charset charset) { + return encodeInverted(StrUtil.bytes(source, charset)); + } + + /** + * Base62编码（反转字母表模式） + * + * @param source 被编码的Base62字符串 + * @return 被加密后的字符串 + */ + public static String encodeInverted(byte[] source) { + return new String(Base62Codec.INSTANCE.encode(source, true)); + } + + /** + * Base62编码 + * + * @param in 被编码Base62的流（一般为图片流或者文件流） + * @return 被加密后的字符串 + */ + public static String encodeInverted(InputStream in) { + return encodeInverted(IoUtil.readBytes(in)); + } + + /** + * Base62编码（反转字母表模式） + * + * @param file 被编码Base62的文件 + * @return 被加密后的字符串 + */ + public static String encodeInverted(File file) { + return encodeInverted(FileUtil.readBytes(file)); + } + + // -------------------------------------------------------------------- decode + /** + * Base62解码 + * + * @param source 被解码的Base62字符串 + * @return 被加密后的字符串 + */ + public static String decodeStrGbk(CharSequence source) { + return decodeStr(source, CharsetUtil.CHARSET_GBK); + } + + /** + * Base62解码 + * + * @param source 被解码的Base62字符串 + * @return 被加密后的字符串 + */ + public static String decodeStr(CharSequence source) { + return decodeStr(source, DEFAULT_CHARSET); + } + + /** + * Base62解码 + * + * @param source 被解码的Base62字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + */ + public static String decodeStr(CharSequence source, Charset charset) { + return StrUtil.str(decode(source), charset); + } + + /** + * Base62解码 + * + * @param Base62 被解码的Base62字符串 + * @param destFile 目标文件 + * @return 目标文件 + */ + public static File decodeToFile(CharSequence Base62, File destFile) { + return FileUtil.writeBytes(decode(Base62), destFile); + } + + /** + * Base62解码 + * + * @param base62Str 被解码的Base62字符串 + * @param out 写出到的流 + * @param isCloseOut 是否关闭输出流 + */ + public static void decodeToStream(CharSequence base62Str, OutputStream out, boolean isCloseOut) { + IoUtil.write(out, isCloseOut, decode(base62Str)); + } + + /** + * Base62解码 + * + * @param base62Str 被解码的Base62字符串 + * @return 被加密后的字符串 + */ + public static byte[] decode(CharSequence base62Str) { + return decode(StrUtil.bytes(base62Str, DEFAULT_CHARSET)); + } + + /** + * 解码Base62 + * + * @param base62bytes Base62输入 + * @return 解码后的bytes + */ + public static byte[] decode(byte[] base62bytes) { + return Base62Codec.INSTANCE.decode(base62bytes); + } + + /** + * Base62解码（反转字母表模式） + * + * @param source 被解码的Base62字符串 + * @return 被加密后的字符串 + */ + public static String decodeStrInverted(CharSequence source) { + return decodeStrInverted(source, DEFAULT_CHARSET); + } + + /** + * Base62解码（反转字母表模式） + * + * @param source 被解码的Base62字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + */ + public static String decodeStrInverted(CharSequence source, Charset charset) { + return StrUtil.str(decodeInverted(source), charset); + } + + /** + * Base62解码（反转字母表模式） + * + * @param Base62 被解码的Base62字符串 + * @param destFile 目标文件 + * @return 目标文件 + */ + public static File decodeToFileInverted(CharSequence Base62, File destFile) { + return FileUtil.writeBytes(decodeInverted(Base62), destFile); + } + + /** + * Base62解码（反转字母表模式） + * + * @param base62Str 被解码的Base62字符串 + * @param out 写出到的流 + * @param isCloseOut 是否关闭输出流 + */ + public static void decodeToStreamInverted(CharSequence base62Str, OutputStream out, boolean isCloseOut) { + IoUtil.write(out, isCloseOut, decodeInverted(base62Str)); + } + + /** + * Base62解码（反转字母表模式） + * + * @param base62Str 被解码的Base62字符串 + * @return 被加密后的字符串 + */ + public static byte[] decodeInverted(CharSequence base62Str) { + return decodeInverted(StrUtil.bytes(base62Str, DEFAULT_CHARSET)); + } + + /** + * 解码Base62（反转字母表模式） + * + * @param base62bytes Base62输入 + * @return 解码后的bytes + */ + public static byte[] decodeInverted(byte[] base62bytes) { + return Base62Codec.INSTANCE.decode(base62bytes, true); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base62Codec.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base62Codec.java new file mode 100644 index 0000000..16161fa --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base62Codec.java @@ -0,0 +1,232 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; + +import java.io.ByteArrayOutputStream; +import java.io.Serializable; + +/** + * Base62编码解码实现，常用于短URL
+ * From https://github.com/seruco/base62 + * + * @author Looly, Sebastian Ruhleder, sebastian@seruco.io + * @since 4.5.9 + */ +public class Base62Codec implements Encoder, Decoder, Serializable { + private static final long serialVersionUID = 1L; + + private static final int STANDARD_BASE = 256; + private static final int TARGET_BASE = 62; + + public static Base62Codec INSTANCE = new Base62Codec(); + + /** + * 编码指定消息bytes为Base62格式的bytes + * + * @param data 被编码的消息 + * @return Base62内容 + */ + @Override + public byte[] encode(byte[] data) { + return encode(data, false); + } + + /** + * 编码指定消息bytes为Base62格式的bytes + * + * @param data 被编码的消息 + * @param useInverted 是否使用反转风格，即将GMP风格中的大小写做转换 + * @return Base62内容 + */ + public byte[] encode(byte[] data, boolean useInverted) { + final Base62Encoder encoder = useInverted ? Base62Encoder.INVERTED_ENCODER : Base62Encoder.GMP_ENCODER; + return encoder.encode(data); + } + + /** + * 解码Base62消息 + * + * @param encoded Base62内容 + * @return 消息 + */ + @Override + public byte[] decode(byte[] encoded) { + return decode(encoded, false); + } + + /** + * 解码Base62消息 + * + * @param encoded Base62内容 + * @param useInverted 是否使用反转风格，即将GMP风格中的大小写做转换 + * @return 消息 + */ + public byte[] decode(byte[] encoded, boolean useInverted) { + final Base62Decoder decoder = useInverted ? Base62Decoder.INVERTED_DECODER : Base62Decoder.GMP_DECODER; + return decoder.decode(encoded); + } + + /** + * Base62编码器 + * + * @since 5.8.0 + */ + public static class Base62Encoder implements Encoder { + /** + * GMP风格 + */ + private static final byte[] GMP = { // + '0', '1', '2', '3', '4', '5', '6', '7', // + '8', '9', 'A', 'B', 'C', 'D', 'E', 'F', // + 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', // + 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', // + 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', // + 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', // + 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', // + 'u', 'v', 'w', 'x', 'y', 'z' // + }; + + /** + * 反转风格，即将GMP风格中的大小写做转换 + */ + private static final byte[] INVERTED = { // + '0', '1', '2', '3', '4', '5', '6', '7', // + '8', '9', 'a', 'b', 'c', 'd', 'e', 'f', // + 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', // + 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', // + 'w', 'x', 'y', 'z', 'A', 'B', 'C', 'D', // + 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', // + 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', // + 'U', 'V', 'W', 'X', 'Y', 'Z' // + }; + + public static Base62Encoder GMP_ENCODER = new Base62Encoder(GMP); + public static Base62Encoder INVERTED_ENCODER = new Base62Encoder(INVERTED); + + private final byte[] alphabet; + + /** + * 构造 + * + * @param alphabet 字符表 + */ + public Base62Encoder(byte[] alphabet) { + this.alphabet = alphabet; + } + + @Override + public byte[] encode(byte[] data) { + final byte[] indices = convert(data, STANDARD_BASE, TARGET_BASE); + return translate(indices, alphabet); + } + } + + /** + * Base62解码器 + * + * @since 5.8.0 + */ + public static class Base62Decoder implements Decoder { + + public static Base62Decoder GMP_DECODER = new Base62Decoder(Base62Encoder.GMP); + public static Base62Decoder INVERTED_DECODER = new Base62Decoder(Base62Encoder.INVERTED); + + private final byte[] lookupTable; + + /** + * 构造 + * + * @param alphabet 字母表 + */ + public Base62Decoder(byte[] alphabet) { + lookupTable = new byte['z' + 1]; + for (int i = 0; i < alphabet.length; i++) { + lookupTable[alphabet[i]] = (byte) i; + } + } + + + @Override + public byte[] decode(byte[] encoded) { + final byte[] prepared = translate(encoded, lookupTable); + return convert(prepared, TARGET_BASE, STANDARD_BASE); + } + } + + // region Private Methods + + /** + * 按照字典转换bytes + * + * @param indices 内容 + * @param dictionary 字典 + * @return 转换值 + */ + private static byte[] translate(byte[] indices, byte[] dictionary) { + final byte[] translation = new byte[indices.length]; + + for (int i = 0; i < indices.length; i++) { + translation[i] = dictionary[indices[i]]; + } + + return translation; + } + + /** + * 使用定义的字母表从源基准到目标基准 + * + * @param message 消息bytes + * @param sourceBase 源基准长度 + * @param targetBase 目标基准长度 + * @return 计算结果 + */ + private static byte[] convert(byte[] message, int sourceBase, int targetBase) { + // 计算结果长度，算法来自：http://codegolf.stackexchange.com/a/21672 + final int estimatedLength = estimateOutputLength(message.length, sourceBase, targetBase); + + final ByteArrayOutputStream out = new ByteArrayOutputStream(estimatedLength); + + byte[] source = message; + + while (source.length > 0) { + final ByteArrayOutputStream quotient = new ByteArrayOutputStream(source.length); + + int remainder = 0; + + for (byte b : source) { + final int accumulator = (b & 0xFF) + remainder * sourceBase; + final int digit = (accumulator - (accumulator % targetBase)) / targetBase; + + remainder = accumulator % targetBase; + + if (quotient.size() > 0 || digit > 0) { + quotient.write(digit); + } + } + + out.write(remainder); + + source = quotient.toByteArray(); + } + + // pad output with zeroes corresponding to the number of leading zeroes in the message + for (int i = 0; i < message.length - 1 && message[i] == 0; i++) { + out.write(0); + } + + return ArrayUtil.reverse(out.toByteArray()); + } + + /** + * 估算结果长度 + * + * @param inputLength 输入长度 + * @param sourceBase 源基准长度 + * @param targetBase 目标基准长度 + * @return 估算长度 + */ + private static int estimateOutputLength(int inputLength, int sourceBase, int targetBase) { + return (int) Math.ceil((Math.log(sourceBase) / Math.log(targetBase)) * inputLength); + } + // endregion +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base64.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base64.java new file mode 100755 index 0000000..f0eeb0d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base64.java @@ -0,0 +1,386 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.File; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.charset.Charset; + +/** + * Base64工具类，提供Base64的编码和解码方案
+ * base64编码是用64（2的6次方）个ASCII字符来表示256（2的8次方）个ASCII字符，
+ * 也就是三位二进制数组经过编码后变为四位的ASCII字符显示，长度比原来增加1/3。 + * + * @author Looly + */ +public class Base64 { + + private static final Charset DEFAULT_CHARSET = CharsetUtil.CHARSET_UTF_8; + // -------------------------------------------------------------------- encode + + /** + * 编码为Base64，非URL安全的 + * + * @param arr 被编码的数组 + * @param lineSep 在76个char之后是CRLF还是EOF + * @return 编码后的bytes + */ + public static byte[] encode(byte[] arr, boolean lineSep) { + return lineSep ? + java.util.Base64.getMimeEncoder().encode(arr) : + java.util.Base64.getEncoder().encode(arr); + } + + /** + * 编码为Base64，URL安全的 + * + * @param arr 被编码的数组 + * @param lineSep 在76个char之后是CRLF还是EOF + * @return 编码后的bytes + * @since 3.0.6 + * @deprecated 按照RFC2045规范，URL安全的Base64无需换行 + */ + @Deprecated + public static byte[] encodeUrlSafe(byte[] arr, boolean lineSep) { + return Base64Encoder.encodeUrlSafe(arr, lineSep); + } + + /** + * base64编码 + * + * @param source 被编码的base64字符串 + * @return 被加密后的字符串 + */ + public static String encode(CharSequence source) { + return encode(source, DEFAULT_CHARSET); + } + + /** + * base64编码，URL安全 + * + * @param source 被编码的base64字符串 + * @return 被加密后的字符串 + * @since 3.0.6 + */ + public static String encodeUrlSafe(CharSequence source) { + return encodeUrlSafe(source, DEFAULT_CHARSET); + } + + /** + * base64编码 + * + * @param source 被编码的base64字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + */ + public static String encode(CharSequence source, String charset) { + return encode(source, CharsetUtil.charset(charset)); + } + + /** + * base64编码，不进行padding(末尾不会填充'=') + * + * @param source 被编码的base64字符串 + * @param charset 编码 + * @return 被加密后的字符串 + * @since 5.5.2 + */ + public static String encodeWithoutPadding(CharSequence source, String charset) { + return encodeWithoutPadding(StrUtil.bytes(source, charset)); + } + + /** + * base64编码,URL安全 + * + * @param source 被编码的base64字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + * @since 3.0.6 + * @deprecated 请使用 {@link #encodeUrlSafe(CharSequence, Charset)} + */ + @Deprecated + public static String encodeUrlSafe(CharSequence source, String charset) { + return encodeUrlSafe(source, CharsetUtil.charset(charset)); + } + + /** + * base64编码 + * + * @param source 被编码的base64字符串 + * @param charset 字符集 + * @return 被编码后的字符串 + */ + public static String encode(CharSequence source, Charset charset) { + return encode(StrUtil.bytes(source, charset)); + } + + /** + * base64编码，URL安全的 + * + * @param source 被编码的base64字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + * @since 3.0.6 + */ + public static String encodeUrlSafe(CharSequence source, Charset charset) { + return encodeUrlSafe(StrUtil.bytes(source, charset)); + } + + /** + * base64编码 + * + * @param source 被编码的base64字符串 + * @return 被加密后的字符串 + */ + public static String encode(byte[] source) { + return java.util.Base64.getEncoder().encodeToString(source); + } + + /** + * base64编码，不进行padding(末尾不会填充'=') + * + * @param source 被编码的base64字符串 + * @return 被加密后的字符串 + * @since 5.5.2 + */ + public static String encodeWithoutPadding(byte[] source) { + return java.util.Base64.getEncoder().withoutPadding().encodeToString(source); + } + + /** + * base64编码,URL安全的 + * + * @param source 被编码的base64字符串 + * @return 被加密后的字符串 + * @since 3.0.6 + */ + public static String encodeUrlSafe(byte[] source) { + return java.util.Base64.getUrlEncoder().withoutPadding().encodeToString(source); + } + + /** + * base64编码 + * + * @param in 被编码base64的流（一般为图片流或者文件流） + * @return 被加密后的字符串 + * @since 4.0.9 + */ + public static String encode(InputStream in) { + return encode(IoUtil.readBytes(in)); + } + + /** + * base64编码,URL安全的 + * + * @param in 被编码base64的流（一般为图片流或者文件流） + * @return 被加密后的字符串 + * @since 4.0.9 + */ + public static String encodeUrlSafe(InputStream in) { + return encodeUrlSafe(IoUtil.readBytes(in)); + } + + /** + * base64编码 + * + * @param file 被编码base64的文件 + * @return 被加密后的字符串 + * @since 4.0.9 + */ + public static String encode(File file) { + return encode(FileUtil.readBytes(file)); + } + + /** + * base64编码,URL安全的 + * + * @param file 被编码base64的文件 + * @return 被加密后的字符串 + * @since 4.0.9 + */ + public static String encodeUrlSafe(File file) { + return encodeUrlSafe(FileUtil.readBytes(file)); + } + + /** + * 编码为Base64字符串
+ * 如果isMultiLine为{@code true}，则每76个字符一个换行符，否则在一行显示 + * + * @param arr 被编码的数组 + * @param isMultiLine 在76个char之后是CRLF还是EOF + * @param isUrlSafe 是否使用URL安全字符，一般为{@code false} + * @return 编码后的bytes + * @since 5.7.2 + */ + public static String encodeStr(byte[] arr, boolean isMultiLine, boolean isUrlSafe) { + return StrUtil.str(encode(arr, isMultiLine, isUrlSafe), DEFAULT_CHARSET); + } + + /** + * 编码为Base64
+ * 如果isMultiLine为{@code true}，则每76个字符一个换行符，否则在一行显示 + * + * @param arr 被编码的数组 + * @param isMultiLine 在76个char之后是CRLF还是EOF + * @param isUrlSafe 是否使用URL安全字符，一般为{@code false} + * @return 编码后的bytes + */ + public static byte[] encode(byte[] arr, boolean isMultiLine, boolean isUrlSafe) { + return Base64Encoder.encode(arr, isMultiLine, isUrlSafe); + } + + // -------------------------------------------------------------------- decode + + /** + * base64解码 + * + * @param source 被解码的base64字符串 + * @return 被加密后的字符串 + * @since 4.3.2 + */ + public static String decodeStrGbk(CharSequence source) { + return Base64Decoder.decodeStr(source, CharsetUtil.CHARSET_GBK); + } + + /** + * base64解码 + * + * @param source 被解码的base64字符串 + * @return 被加密后的字符串 + */ + public static String decodeStr(CharSequence source) { + return Base64Decoder.decodeStr(source); + } + + /** + * base64解码 + * + * @param source 被解码的base64字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + */ + public static String decodeStr(CharSequence source, String charset) { + return decodeStr(source, CharsetUtil.charset(charset)); + } + + /** + * base64解码 + * + * @param source 被解码的base64字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + */ + public static String decodeStr(CharSequence source, Charset charset) { + return Base64Decoder.decodeStr(source, charset); + } + + /** + * base64解码 + * + * @param base64 被解码的base64字符串 + * @param destFile 目标文件 + * @return 目标文件 + * @since 4.0.9 + */ + public static File decodeToFile(CharSequence base64, File destFile) { + return FileUtil.writeBytes(Base64Decoder.decode(base64), destFile); + } + + /** + * base64解码 + * + * @param base64 被解码的base64字符串 + * @param out 写出到的流 + * @param isCloseOut 是否关闭输出流 + * @since 4.0.9 + */ + public static void decodeToStream(CharSequence base64, OutputStream out, boolean isCloseOut) { + IoUtil.write(out, isCloseOut, Base64Decoder.decode(base64)); + } + + /** + * base64解码 + * + * @param base64 被解码的base64字符串 + * @return 解码后的bytes + */ + public static byte[] decode(CharSequence base64) { + return Base64Decoder.decode(base64); + } + + /** + * 解码Base64 + * + * @param in 输入 + * @return 解码后的bytes + */ + public static byte[] decode(byte[] in) { + return Base64Decoder.decode(in); + } + + /** + * 检查是否为Base64 + * + * @param base64 Base64的bytes + * @return 是否为Base64 + * @since 5.7.5 + */ + public static boolean isBase64(CharSequence base64) { + if (base64 == null || base64.length() < 2) { + return false; + } + + final byte[] bytes = StrUtil.utf8Bytes(base64); + + if (bytes.length != base64.length()) { + // 如果长度不相等，说明存在双字节字符，肯定不是Base64，直接返回false + return false; + } + + return isBase64(bytes); + } + + /** + * 检查是否为Base64 + * + * @param base64Bytes Base64的bytes + * @return 是否为Base64 + * @since 5.7.5 + */ + public static boolean isBase64(byte[] base64Bytes) { + if (base64Bytes == null || base64Bytes.length < 3) { + return false; + } + boolean hasPadding = false; + for (byte base64Byte : base64Bytes) { + if (hasPadding) { + if ('=' != base64Byte) { + // 前一个字符是'='，则后边的字符都必须是'='，即'='只能都位于结尾 + return false; + } + } else if ('=' == base64Byte) { + // 发现'=' 标记之 + hasPadding = true; + } else if (false == (Base64Decoder.isBase64Code(base64Byte) || isWhiteSpace(base64Byte))) { + return false; + } + } + return true; + } + + private static boolean isWhiteSpace(byte byteToCheck) { + switch (byteToCheck) { + case ' ': + case '\n': + case '\r': + case '\t': + return true; + default: + return false; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base64Decoder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base64Decoder.java new file mode 100644 index 0000000..c35ca20 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base64Decoder.java @@ -0,0 +1,162 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.lang.mutable.MutableInt; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.nio.charset.Charset; + +/** + * Base64解码实现 + * + * @author looly + * + */ +public class Base64Decoder { + + private static final Charset DEFAULT_CHARSET = CharsetUtil.CHARSET_UTF_8; + private static final byte PADDING = -2; + + /** Base64解码表，共128位，-1表示非base64字符，-2表示padding */ + private static final byte[] DECODE_TABLE = { + // 0 1 2 3 4 5 6 7 8 9 A B C D E F + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // 00-0f + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // 10-1f + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, 62, -1, 63, // 20-2f + - / + 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, -1, -1, -1, -2, -1, -1, // 30-3f 0-9，-2的位置是'=' + -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, // 40-4f A-O + 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, -1, -1, -1, -1, 63, // 50-5f P-Z _ + -1, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, // 60-6f a-o + 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51 // 70-7a p-z + }; + + /** + * base64解码 + * + * @param source 被解码的base64字符串 + * @return 被加密后的字符串 + */ + public static String decodeStr(CharSequence source) { + return decodeStr(source, DEFAULT_CHARSET); + } + + /** + * base64解码 + * + * @param source 被解码的base64字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + */ + public static String decodeStr(CharSequence source, Charset charset) { + return StrUtil.str(decode(source), charset); + } + + /** + * base64解码 + * + * @param source 被解码的base64字符串 + * @return 被加密后的字符串 + */ + public static byte[] decode(CharSequence source) { + return decode(StrUtil.bytes(source, DEFAULT_CHARSET)); + } + + /** + * 解码Base64 + * + * @param in 输入 + * @return 解码后的bytes + */ + public static byte[] decode(byte[] in) { + if (ArrayUtil.isEmpty(in)) { + return in; + } + return decode(in, 0, in.length); + } + + /** + * 解码Base64 + * + * @param in 输入 + * @param pos 开始位置 + * @param length 长度 + * @return 解码后的bytes + */ + public static byte[] decode(byte[] in, int pos, int length) { + if (ArrayUtil.isEmpty(in)) { + return in; + } + + final MutableInt offset = new MutableInt(pos); + + byte sestet0; + byte sestet1; + byte sestet2; + byte sestet3; + int maxPos = pos + length - 1; + int octetId = 0; + byte[] octet = new byte[length * 3 / 4];// over-estimated if non-base64 characters present + while (offset.intValue() <= maxPos) { + sestet0 = getNextValidDecodeByte(in, offset, maxPos); + sestet1 = getNextValidDecodeByte(in, offset, maxPos); + sestet2 = getNextValidDecodeByte(in, offset, maxPos); + sestet3 = getNextValidDecodeByte(in, offset, maxPos); + + if (PADDING != sestet1) { + octet[octetId++] = (byte) ((sestet0 << 2) | (sestet1 >>> 4)); + } + if (PADDING != sestet2) { + octet[octetId++] = (byte) (((sestet1 & 0xf) << 4) | (sestet2 >>> 2)); + } + if (PADDING != sestet3) { + octet[octetId++] = (byte) (((sestet2 & 3) << 6) | sestet3); + } + } + + if (octetId == octet.length) { + return octet; + } else { + // 如果有非Base64字符混入，则实际结果比解析的要短，截取之 + return (byte[]) ArrayUtil.copy(octet, new byte[octetId], octetId); + } + } + + /** + * 给定的字符是否为Base64字符 + * + * @param octet 被检查的字符 + * @return 是否为Base64字符 + * @since 5.7.5 + */ + public static boolean isBase64Code(byte octet) { + return octet == '=' || (octet >= 0 && octet < DECODE_TABLE.length && DECODE_TABLE[octet] != -1); + } + + // ----------------------------------------------------------------------------------------------- Private start + /** + * 获取下一个有效的byte字符 + * + * @param in 输入 + * @param pos 当前位置，调用此方法后此位置保持在有效字符的下一个位置 + * @param maxPos 最大位置 + * @return 有效字符，如果达到末尾返回 + */ + private static byte getNextValidDecodeByte(byte[] in, MutableInt pos, int maxPos) { + byte base64Byte; + byte decodeByte; + while (pos.intValue() <= maxPos) { + base64Byte = in[pos.intValue()]; + pos.increment(); + if (base64Byte > -1) { + decodeByte = DECODE_TABLE[base64Byte]; + if (decodeByte > -1) { + return decodeByte; + } + } + } + // padding if reached max position + return PADDING; + } + // ----------------------------------------------------------------------------------------------- Private end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base64Encoder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base64Encoder.java new file mode 100644 index 0000000..ca7f716 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Base64Encoder.java @@ -0,0 +1,214 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.nio.charset.Charset; + +/** + * Base64编码
+ * TODO 6.x移除此类，使用JDK自身 + * + * @author looly + * @since 3.2.0 + */ +public class Base64Encoder { + + private static final Charset DEFAULT_CHARSET = CharsetUtil.CHARSET_UTF_8; + /** + * 标准编码表 + */ + private static final byte[] STANDARD_ENCODE_TABLE = { // + 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', // + 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', // + 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', // + 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f', // + 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', // + 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', // + 'w', 'x', 'y', 'z', '0', '1', '2', '3', // + '4', '5', '6', '7', '8', '9', '+', '/' // + }; + /** + * URL安全的编码表，将 + 和 / 替换为 - 和 _ + */ + private static final byte[] URL_SAFE_ENCODE_TABLE = { // + 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', // + 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', // + 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', // + 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f', // + 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', // + 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', // + 'w', 'x', 'y', 'z', '0', '1', '2', '3', // + '4', '5', '6', '7', '8', '9', '-', '_' // + }; + + // -------------------------------------------------------------------- encode + + /** + * 编码为Base64，非URL安全的 + * + * @param arr 被编码的数组 + * @param lineSep 在76个char之后是CRLF还是EOF + * @return 编码后的bytes + */ + public static byte[] encode(byte[] arr, boolean lineSep) { + return encode(arr, lineSep, false); + } + + /** + * 编码为Base64，URL安全的 + * + * @param arr 被编码的数组 + * @param lineSep 在76个char之后是CRLF还是EOF + * @return 编码后的bytes + * @since 3.0.6 + */ + public static byte[] encodeUrlSafe(byte[] arr, boolean lineSep) { + return encode(arr, lineSep, true); + } + + /** + * base64编码 + * + * @param source 被编码的base64字符串 + * @return 被加密后的字符串 + */ + public static String encode(CharSequence source) { + return encode(source, DEFAULT_CHARSET); + } + + /** + * base64编码，URL安全 + * + * @param source 被编码的base64字符串 + * @return 被加密后的字符串 + * @since 3.0.6 + */ + public static String encodeUrlSafe(CharSequence source) { + return encodeUrlSafe(source, DEFAULT_CHARSET); + } + + /** + * base64编码 + * + * @param source 被编码的base64字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + */ + public static String encode(CharSequence source, Charset charset) { + return encode(StrUtil.bytes(source, charset)); + } + + /** + * base64编码，URL安全的 + * + * @param source 被编码的base64字符串 + * @param charset 字符集 + * @return 被加密后的字符串 + * @since 3.0.6 + */ + public static String encodeUrlSafe(CharSequence source, Charset charset) { + return encodeUrlSafe(StrUtil.bytes(source, charset)); + } + + /** + * base64编码 + * + * @param source 被编码的base64字符串 + * @return 被加密后的字符串 + */ + public static String encode(byte[] source) { + return StrUtil.str(encode(source, false), DEFAULT_CHARSET); + } + + /** + * base64编码,URL安全的 + * + * @param source 被编码的base64字符串 + * @return 被加密后的字符串 + * @since 3.0.6 + */ + public static String encodeUrlSafe(byte[] source) { + return StrUtil.str(encodeUrlSafe(source, false), DEFAULT_CHARSET); + } + + /** + * 编码为Base64字符串
+ * 如果isMultiLine为{@code true}，则每76个字符一个换行符，否则在一行显示 + * + * @param arr 被编码的数组 + * @param isMultiLine 在76个char之后是CRLF还是EOF + * @param isUrlSafe 是否使用URL安全字符，在URL Safe模式下，=为URL中的关键字符，不需要补充。空余的byte位要去掉，一般为{@code false} + * @return 编码后的bytes + * @since 5.7.2 + */ + public static String encodeStr(byte[] arr, boolean isMultiLine, boolean isUrlSafe) { + return StrUtil.str(encode(arr, isMultiLine, isUrlSafe), DEFAULT_CHARSET); + } + + /** + * 编码为Base64
+ * 如果isMultiLine为{@code true}，则每76个字符一个换行符，否则在一行显示 + * + * @param arr 被编码的数组 + * @param isMultiLine 在76个char之后是CRLF还是EOF + * @param isUrlSafe 是否使用URL安全字符，在URL Safe模式下，=为URL中的关键字符，不需要补充。空余的byte位要去掉，一般为{@code false} + * @return 编码后的bytes + */ + public static byte[] encode(byte[] arr, boolean isMultiLine, boolean isUrlSafe) { + if (null == arr) { + return null; + } + + int len = arr.length; + if (len == 0) { + return new byte[0]; + } + + int evenlen = (len / 3) * 3; + int cnt = ((len - 1) / 3 + 1) << 2; + int destlen = cnt + (isMultiLine ? (cnt - 1) / 76 << 1 : 0); + byte[] dest = new byte[destlen]; + + byte[] encodeTable = isUrlSafe ? URL_SAFE_ENCODE_TABLE : STANDARD_ENCODE_TABLE; + + for (int s = 0, d = 0, cc = 0; s < evenlen; ) { + int i = (arr[s++] & 0xff) << 16 | (arr[s++] & 0xff) << 8 | (arr[s++] & 0xff); + + dest[d++] = encodeTable[(i >>> 18) & 0x3f]; + dest[d++] = encodeTable[(i >>> 12) & 0x3f]; + dest[d++] = encodeTable[(i >>> 6) & 0x3f]; + dest[d++] = encodeTable[i & 0x3f]; + + if (isMultiLine && ++cc == 19 && d < destlen - 2) { + dest[d++] = '\r'; + dest[d++] = '\n'; + cc = 0; + } + } + + int left = len - evenlen;// 剩余位数 + if (left > 0) { + int i = ((arr[evenlen] & 0xff) << 10) | (left == 2 ? ((arr[len - 1] & 0xff) << 2) : 0); + + dest[destlen - 4] = encodeTable[i >> 12]; + dest[destlen - 3] = encodeTable[(i >>> 6) & 0x3f]; + + if (isUrlSafe) { + // 在URL Safe模式下，=为URL中的关键字符，不需要补充。空余的byte位要去掉。 + int urlSafeLen = destlen - 2; + if (2 == left) { + dest[destlen - 2] = encodeTable[i & 0x3f]; + urlSafeLen += 1; + } + byte[] urlSafeDest = new byte[urlSafeLen]; + System.arraycopy(dest, 0, urlSafeDest, 0, urlSafeLen); + return urlSafeDest; + } else { + dest[destlen - 2] = (left == 2) ? encodeTable[i & 0x3f] : (byte) '='; + dest[destlen - 1] = '='; + } + } + return dest; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Caesar.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Caesar.java new file mode 100644 index 0000000..bb46a7a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Caesar.java @@ -0,0 +1,89 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +/** + * 凯撒密码实现
+ * 算法来自：https://github.com/zhaorenjie110/SymmetricEncryptionAndDecryption + * + * @author looly + */ +public class Caesar { + + // 26个字母表 + public static final String TABLE = "AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz"; + + /** + * 传入明文，加密得到密文 + * + * @param message 加密的消息 + * @param offset 偏移量 + * @return 加密后的内容 + */ + public static String encode(String message, int offset) { + Assert.notNull(message, "message must be not null!"); + final int len = message.length(); + final char[] plain = message.toCharArray(); + char c; + for (int i = 0; i < len; i++) { + c = message.charAt(i); + if (false == Character.isLetter(c)) { + continue; + } + plain[i] = encodeChar(c, offset); + } + return new String(plain); + } + + /** + * 传入明文解密到密文 + * + * @param cipherText 密文 + * @param offset 偏移量 + * @return 解密后的内容 + */ + public static String decode(String cipherText, int offset) { + Assert.notNull(cipherText, "cipherText must be not null!"); + final int len = cipherText.length(); + final char[] plain = cipherText.toCharArray(); + char c; + for (int i = 0; i < len; i++) { + c = cipherText.charAt(i); + if (false == Character.isLetter(c)) { + continue; + } + plain[i] = decodeChar(c, offset); + } + return new String(plain); + } + + // ----------------------------------------------------------------------------------------- Private method start + + /** + * 加密轮盘 + * + * @param c 被加密字符 + * @param offset 偏移量 + * @return 加密后的字符 + */ + private static char encodeChar(char c, int offset) { + int position = (TABLE.indexOf(c) + offset) % 52; + return TABLE.charAt(position); + + } + + /** + * 解密轮盘 + * + * @param c 字符 + * @return 解密后的字符 + */ + private static char decodeChar(char c, int offset) { + int position = (TABLE.indexOf(c) - offset) % 52; + if (position < 0) { + position += 52; + } + return TABLE.charAt(position); + } + // ----------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Decoder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Decoder.java new file mode 100644 index 0000000..2035510 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Decoder.java @@ -0,0 +1,20 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +/** + * 解码接口 + * + * @param 被解码的数据类型 + * @param 解码后的数据类型 + * @author looly + * @since 5.7.22 + */ +public interface Decoder { + + /** + * 执行解码 + * + * @param encoded 被解码的数据 + * @return 解码后的数据 + */ + R decode(T encoded); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Encoder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Encoder.java new file mode 100644 index 0000000..b6917db --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Encoder.java @@ -0,0 +1,20 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +/** + * 编码接口 + * + * @param 被编码的数据类型 + * @param 编码后的数据类型 + * @author looly + * @since 5.7.22 + */ +public interface Encoder { + + /** + * 执行编码 + * + * @param data 被编码的数据 + * @return 编码后的数据 + */ + R encode(T data); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Hashids.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Hashids.java new file mode 100755 index 0000000..f3d2df2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Hashids.java @@ -0,0 +1,506 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import java.math.BigInteger; +import java.util.Arrays; +import java.util.LinkedHashSet; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import java.util.stream.LongStream; + +/** + * Hashids 协议实现，以实现： + *
    + *
  • 生成简短、唯一、大小写敏感并无序的hash值
    • + *
  • 自然数字的Hash值
    • + *
  • 可以设置不同的盐，具有保密性
    • + *
  • 可配置的hash长度
    • + *
  • 递增的输入产生的输出无法预测
    • + *
+ * + *

+ * 来自：https://github.com/davidafsilva/java-hashids + *

+ * + *

+ * {@code Hashids}可以将数字或者16进制字符串转为短且唯一不连续的字符串，采用双向编码实现，比如，它可以将347之类的数字转换为yr8之类的字符串，也可以将yr8之类的字符串重新解码为347之类的数字。
+ * 此编码算法主要是解决爬虫类应用对连续ID爬取问题，将有序的ID转换为无序的Hashids，而且一一对应。 + *

+ * + * @author david + */ +public class Hashids implements Encoder, Decoder { + + private static final int LOTTERY_MOD = 100; + private static final double GUARD_THRESHOLD = 12; + private static final double SEPARATOR_THRESHOLD = 3.5; + // 最小编解码字符串 + private static final int MIN_ALPHABET_LENGTH = 16; + private static final Pattern HEX_VALUES_PATTERN = Pattern.compile("[\\w\\W]{1,12}"); + + // 默认编解码字符串 + public static final char[] DEFAULT_ALPHABET = { + 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', + 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', + 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', + 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', + '1', '2', '3', '4', '5', '6', '7', '8', '9', '0' + }; + // 默认分隔符 + private static final char[] DEFAULT_SEPARATORS = { + 'c', 'f', 'h', 'i', 's', 't', 'u', 'C', 'F', 'H', 'I', 'S', 'T', 'U' + }; + + // algorithm properties + private final char[] alphabet; + // 多个数字编解码的分界符 + private final char[] separators; + private final Set separatorsSet; + private final char[] salt; + // 补齐至 minLength 长度添加的字符列表 + private final char[] guards; + // 编码后最小的字符长度 + private final int minLength; + + // region create + + /** + * 根据参数值，创建{@code Hashids}，使用默认{@link #DEFAULT_ALPHABET}作为字母表，不限制最小长度 + * + * @param salt 加盐值 + * @return {@code Hashids} + */ + public static Hashids create(final char[] salt) { + return create(salt, DEFAULT_ALPHABET, -1); + } + + /** + * 根据参数值，创建{@code Hashids}，使用默认{@link #DEFAULT_ALPHABET}作为字母表 + * + * @param salt 加盐值 + * @param minLength 限制最小长度，-1表示不限制 + * @return {@code Hashids} + */ + public static Hashids create(final char[] salt, final int minLength) { + return create(salt, DEFAULT_ALPHABET, minLength); + } + + /** + * 根据参数值，创建{@code Hashids} + * + * @param salt 加盐值 + * @param alphabet hash字母表 + * @param minLength 限制最小长度，-1表示不限制 + * @return {@code Hashids} + */ + public static Hashids create(final char[] salt, final char[] alphabet, final int minLength) { + return new Hashids(salt, alphabet, minLength); + } + // endregion + + /** + * 构造 + * + * @param salt 加盐值 + * @param alphabet hash字母表 + * @param minLength 限制最小长度，-1表示不限制 + */ + public Hashids(final char[] salt, final char[] alphabet, final int minLength) { + this.minLength = minLength; + this.salt = Arrays.copyOf(salt, salt.length); + + // filter and shuffle separators + char[] tmpSeparators = shuffle(filterSeparators(DEFAULT_SEPARATORS, alphabet), this.salt); + + // validate and filter the alphabet + char[] tmpAlphabet = validateAndFilterAlphabet(alphabet, tmpSeparators); + + // check separator threshold + if (tmpSeparators.length == 0 || + ((double) (tmpAlphabet.length / tmpSeparators.length)) > SEPARATOR_THRESHOLD) { + final int minSeparatorsSize = (int) Math.ceil(tmpAlphabet.length / SEPARATOR_THRESHOLD); + // check minimum size of separators + if (minSeparatorsSize > tmpSeparators.length) { + // fill separators from alphabet + final int missingSeparators = minSeparatorsSize - tmpSeparators.length; + tmpSeparators = Arrays.copyOf(tmpSeparators, tmpSeparators.length + missingSeparators); + System.arraycopy(tmpAlphabet, 0, tmpSeparators, + tmpSeparators.length - missingSeparators, missingSeparators); + System.arraycopy(tmpAlphabet, 0, tmpSeparators, + tmpSeparators.length - missingSeparators, missingSeparators); + tmpAlphabet = Arrays.copyOfRange(tmpAlphabet, missingSeparators, tmpAlphabet.length); + } + } + + // shuffle the current alphabet + shuffle(tmpAlphabet, this.salt); + + // check guards + this.guards = new char[(int) Math.ceil(tmpAlphabet.length / GUARD_THRESHOLD)]; + if (alphabet.length < 3) { + System.arraycopy(tmpSeparators, 0, guards, 0, guards.length); + this.separators = Arrays.copyOfRange(tmpSeparators, guards.length, tmpSeparators.length); + this.alphabet = tmpAlphabet; + } else { + System.arraycopy(tmpAlphabet, 0, guards, 0, guards.length); + this.separators = tmpSeparators; + this.alphabet = Arrays.copyOfRange(tmpAlphabet, guards.length, tmpAlphabet.length); + } + + // create the separators set + separatorsSet = IntStream.range(0, separators.length) + .mapToObj(idx -> separators[idx]) + .collect(Collectors.toSet()); + } + + /** + * 编码给定的16进制数字 + * + * @param hexNumbers 16进制数字 + * @return 编码后的值, {@code null} if {@code numbers} 是 {@code null}. + * @throws IllegalArgumentException 数字不支持抛出此异常 + */ + public String encodeFromHex(final String hexNumbers) { + if (hexNumbers == null) { + return null; + } + + // remove the prefix, if present + final String hex = hexNumbers.startsWith("0x") || hexNumbers.startsWith("0X") ? + hexNumbers.substring(2) : hexNumbers; + + // get the associated long value and encode it + LongStream values = LongStream.empty(); + final Matcher matcher = HEX_VALUES_PATTERN.matcher(hex); + while (matcher.find()) { + final long value = new BigInteger("1" + matcher.group(), 16).longValue(); + values = LongStream.concat(values, LongStream.of(value)); + } + + return encode(values.toArray()); + } + + /** + * 编码给定的数字数组 + * + * @param numbers 数字数组 + * @return 编码后的值, {@code null} if {@code numbers} 是 {@code null}. + * @throws IllegalArgumentException 数字不支持抛出此异常 + */ + @Override + public String encode(final long... numbers) { + if (numbers == null) { + return null; + } + + // copy alphabet + final char[] currentAlphabet = Arrays.copyOf(alphabet, alphabet.length); + + // determine the lottery number + final long lotteryId = LongStream.range(0, numbers.length) + .reduce(0, (state, i) -> { + final long number = numbers[(int) i]; + if (number < 0) { + throw new IllegalArgumentException("invalid number: " + number); + } + return state + number % (i + LOTTERY_MOD); + }); + final char lottery = currentAlphabet[(int) (lotteryId % currentAlphabet.length)]; + + // encode each number + final StringBuilder global = new StringBuilder(); + IntStream.range(0, numbers.length) + .forEach(idx -> { + // derive alphabet + deriveNewAlphabet(currentAlphabet, salt, lottery); + + // encode + final int initialLength = global.length(); + translate(numbers[idx], currentAlphabet, global, initialLength); + + // prepend the lottery + if (idx == 0) { + global.insert(0, lottery); + } + + // append the separator, if more numbers are pending encoding + if (idx + 1 < numbers.length) { + long n = numbers[idx] % (global.charAt(initialLength) + 1); + global.append(separators[(int) (n % separators.length)]); + } + }); + + // add the guards, if there's any space left + if (minLength > global.length()) { + int guardIdx = (int) ((lotteryId + lottery) % guards.length); + global.insert(0, guards[guardIdx]); + if (minLength > global.length()) { + guardIdx = (int) ((lotteryId + global.charAt(2)) % guards.length); + global.append(guards[guardIdx]); + } + } + + // add the necessary padding + int paddingLeft = minLength - global.length(); + while (paddingLeft > 0) { + shuffle(currentAlphabet, Arrays.copyOf(currentAlphabet, currentAlphabet.length)); + + final int alphabetHalfSize = currentAlphabet.length / 2; + final int initialSize = global.length(); + if (paddingLeft > currentAlphabet.length) { + // entire alphabet with the current encoding in the middle of it + int offset = alphabetHalfSize + (currentAlphabet.length % 2 == 0 ? 0 : 1); + + global.insert(0, currentAlphabet, alphabetHalfSize, offset); + global.insert(offset + initialSize, currentAlphabet, 0, alphabetHalfSize); + // decrease the padding left + paddingLeft -= currentAlphabet.length; + } else { + // calculate the excess + final int excess = currentAlphabet.length + global.length() - minLength; + final int secondHalfStartOffset = alphabetHalfSize + Math.floorDiv(excess, 2); + final int secondHalfLength = currentAlphabet.length - secondHalfStartOffset; + final int firstHalfLength = paddingLeft - secondHalfLength; + + global.insert(0, currentAlphabet, secondHalfStartOffset, secondHalfLength); + global.insert(secondHalfLength + initialSize, currentAlphabet, 0, firstHalfLength); + + paddingLeft = 0; + } + } + + return global.toString(); + } + + //------------------------- + // Decode + //------------------------- + + /** + * 解码Hash值为16进制数字 + * + * @param hash hash值 + * @return 解码后的16进制值, {@code null} if {@code numbers} 是 {@code null}. + * @throws IllegalArgumentException if the hash is invalid. + */ + public String decodeToHex(final String hash) { + if (hash == null) { + return null; + } + + final StringBuilder sb = new StringBuilder(); + Arrays.stream(decode(hash)) + .mapToObj(Long::toHexString) + .forEach(hex -> sb.append(hex, 1, hex.length())); + return sb.toString(); + } + + /** + * 解码Hash值为数字数组 + * + * @param hash hash值 + * @return 解码后的16进制值, {@code null} if {@code numbers} 是 {@code null}. + * @throws IllegalArgumentException if the hash is invalid. + */ + @Override + public long[] decode(final String hash) { + if (hash == null) { + return null; + } + + // create a set of the guards + final Set guardsSet = IntStream.range(0, guards.length) + .mapToObj(idx -> guards[idx]) + .collect(Collectors.toSet()); + // count the total guards used + final int[] guardsIdx = IntStream.range(0, hash.length()) + .filter(idx -> guardsSet.contains(hash.charAt(idx))) + .toArray(); + // get the start/end index base on the guards count + final int startIdx, endIdx; + if (guardsIdx.length > 0) { + startIdx = guardsIdx[0] + 1; + endIdx = guardsIdx.length > 1 ? guardsIdx[1] : hash.length(); + } else { + startIdx = 0; + endIdx = hash.length(); + } + + LongStream decoded = LongStream.empty(); + // parse the hash + if (hash.length() > 0) { + final char lottery = hash.charAt(startIdx); + + // create the initial accumulation string + final int length = hash.length() - guardsIdx.length - 1; + StringBuilder block = new StringBuilder(length); + + // create the base salt + final char[] decodeSalt = new char[alphabet.length]; + decodeSalt[0] = lottery; + final int saltLength = salt.length >= alphabet.length ? alphabet.length - 1 : salt.length; + System.arraycopy(salt, 0, decodeSalt, 1, saltLength); + final int saltLeft = alphabet.length - saltLength - 1; + + // copy alphabet + final char[] currentAlphabet = Arrays.copyOf(alphabet, alphabet.length); + + for (int i = startIdx + 1; i < endIdx; i++) { + if (false == separatorsSet.contains(hash.charAt(i))) { + block.append(hash.charAt(i)); + // continue if we have not reached the end, yet + if (i < endIdx - 1) { + continue; + } + } + + if (block.length() > 0) { + // create the salt + if (saltLeft > 0) { + System.arraycopy(currentAlphabet, 0, decodeSalt, + alphabet.length - saltLeft, saltLeft); + } + + // shuffle the alphabet + shuffle(currentAlphabet, decodeSalt); + + // prepend the decoded value + final long n = translate(block.toString().toCharArray(), currentAlphabet); + decoded = LongStream.concat(decoded, LongStream.of(n)); + + // create a new block + block = new StringBuilder(length); + } + } + } + + // validate the hash + final long[] decodedValue = decoded.toArray(); + if (!Objects.equals(hash, encode(decodedValue))) { + throw new IllegalArgumentException("invalid hash: " + hash); + } + + return decodedValue; + } + + private StringBuilder translate(final long n, final char[] alphabet, + final StringBuilder sb, final int start) { + long input = n; + do { + // prepend the chosen char + sb.insert(start, alphabet[(int) (input % alphabet.length)]); + + // trim the input + input = input / alphabet.length; + } while (input > 0); + + return sb; + } + + private long translate(final char[] hash, final char[] alphabet) { + long number = 0; + + final Map alphabetMapping = IntStream.range(0, alphabet.length) + .mapToObj(idx -> new Object[]{alphabet[idx], idx}) + .collect(Collectors.groupingBy(arr -> (Character) arr[0], + Collectors.mapping(arr -> (Integer) arr[1], + Collectors.reducing(null, (a, b) -> a == null ? b : a)))); + + for (int i = 0; i < hash.length; ++i) { + number += alphabetMapping.computeIfAbsent(hash[i], k -> { + throw new IllegalArgumentException("Invalid alphabet for hash"); + }) * (long) Math.pow(alphabet.length, hash.length - i - 1); + } + + return number; + } + + private char[] deriveNewAlphabet(final char[] alphabet, final char[] salt, final char lottery) { + // create the new salt + final char[] newSalt = new char[alphabet.length]; + + // 1. lottery + newSalt[0] = lottery; + int spaceLeft = newSalt.length - 1; + int offset = 1; + // 2. salt + if (salt.length > 0 && spaceLeft > 0) { + int length = Math.min(salt.length, spaceLeft); + System.arraycopy(salt, 0, newSalt, offset, length); + spaceLeft -= length; + offset += length; + } + // 3. alphabet + if (spaceLeft > 0) { + System.arraycopy(alphabet, 0, newSalt, offset, spaceLeft); + } + + // shuffle + return shuffle(alphabet, newSalt); + } + + private char[] validateAndFilterAlphabet(final char[] alphabet, final char[] separators) { + // validate size + if (alphabet.length < MIN_ALPHABET_LENGTH) { + throw new IllegalArgumentException(String.format("alphabet must contain at least %d unique " + + "characters: %d", MIN_ALPHABET_LENGTH, alphabet.length)); + } + + final Set seen = new LinkedHashSet<>(alphabet.length); + final Set invalid = IntStream.range(0, separators.length) + .mapToObj(idx -> separators[idx]) + .collect(Collectors.toSet()); + + // add to seen set (without duplicates) + IntStream.range(0, alphabet.length) + .forEach(i -> { + if (alphabet[i] == ' ') { + throw new IllegalArgumentException(String.format("alphabet must not contain spaces: " + + "index %d", i)); + } + final Character c = alphabet[i]; + if (!invalid.contains(c)) { + seen.add(c); + } + }); + + // create a new alphabet without the duplicates + final char[] uniqueAlphabet = new char[seen.size()]; + int idx = 0; + for (char c : seen) { + uniqueAlphabet[idx++] = c; + } + return uniqueAlphabet; + } + + @SuppressWarnings("SameParameterValue") + private char[] filterSeparators(final char[] separators, final char[] alphabet) { + final Set valid = IntStream.range(0, alphabet.length) + .mapToObj(idx -> alphabet[idx]) + .collect(Collectors.toSet()); + + return IntStream.range(0, separators.length) + .mapToObj(idx -> (separators[idx])) + .filter(valid::contains) + // ugly way to convert back to char[] + .map(c -> Character.toString(c)) + .collect(Collectors.joining()) + .toCharArray(); + } + + private char[] shuffle(final char[] alphabet, final char[] salt) { + for (int i = alphabet.length - 1, v = 0, p = 0, j, z; salt.length > 0 && i > 0; i--, v++) { + v %= salt.length; + p += z = salt[v]; + j = (z + v + p) % i; + final char tmp = alphabet[j]; + alphabet[j] = alphabet[i]; + alphabet[i] = tmp; + } + return alphabet; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Morse.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Morse.java new file mode 100644 index 0000000..0ba7c2e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Morse.java @@ -0,0 +1,172 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 莫尔斯电码的编码和解码实现
+ * 参考：https://github.com/TakWolf/Java-MorseCoder + * + * @author looly, TakWolf + * @since 4.4.1 + */ +public class Morse { + + private static final Map ALPHABETS = new HashMap<>(); // code point -> morse + private static final Map DICTIONARIES = new HashMap<>(); // morse -> code point + + /** + * 注册莫尔斯电码表 + * + * @param abc 字母和字符 + * @param dict 二进制 + */ + private static void registerMorse(Character abc, String dict) { + ALPHABETS.put((int) abc, dict); + DICTIONARIES.put(dict, (int) abc); + } + + static { + // Letters + registerMorse('A', "01"); + registerMorse('B', "1000"); + registerMorse('C', "1010"); + registerMorse('D', "100"); + registerMorse('E', "0"); + registerMorse('F', "0010"); + registerMorse('G', "110"); + registerMorse('H', "0000"); + registerMorse('I', "00"); + registerMorse('J', "0111"); + registerMorse('K', "101"); + registerMorse('L', "0100"); + registerMorse('M', "11"); + registerMorse('N', "10"); + registerMorse('O', "111"); + registerMorse('P', "0110"); + registerMorse('Q', "1101"); + registerMorse('R', "010"); + registerMorse('S', "000"); + registerMorse('T', "1"); + registerMorse('U', "001"); + registerMorse('V', "0001"); + registerMorse('W', "011"); + registerMorse('X', "1001"); + registerMorse('Y', "1011"); + registerMorse('Z', "1100"); + // Numbers + registerMorse('0', "11111"); + registerMorse('1', "01111"); + registerMorse('2', "00111"); + registerMorse('3', "00011"); + registerMorse('4', "00001"); + registerMorse('5', "00000"); + registerMorse('6', "10000"); + registerMorse('7', "11000"); + registerMorse('8', "11100"); + registerMorse('9', "11110"); + // Punctuation + registerMorse('.', "010101"); + registerMorse(',', "110011"); + registerMorse('?', "001100"); + registerMorse('\'', "011110"); + registerMorse('!', "101011"); + registerMorse('/', "10010"); + registerMorse('(', "10110"); + registerMorse(')', "101101"); + registerMorse('&', "01000"); + registerMorse(':', "111000"); + registerMorse(';', "101010"); + registerMorse('=', "10001"); + registerMorse('+', "01010"); + registerMorse('-', "100001"); + registerMorse('_', "001101"); + registerMorse('"', "010010"); + registerMorse('$', "0001001"); + registerMorse('@', "011010"); + } + + private final char dit; // short mark or dot + private final char dah; // longer mark or dash + private final char split; + + /** + * 构造 + */ + public Morse() { + this(CharUtil.DOT, CharUtil.DASHED, CharUtil.SLASH); + } + + /** + * 构造 + * + * @param dit 点表示的字符 + * @param dah 横线表示的字符 + * @param split 分隔符 + */ + public Morse(char dit, char dah, char split) { + this.dit = dit; + this.dah = dah; + this.split = split; + } + + /** + * 编码 + * + * @param text 文本 + * @return 密文 + */ + public String encode(String text) { + Assert.notNull(text, "Text should not be null."); + + text = text.toUpperCase(); + final StringBuilder morseBuilder = new StringBuilder(); + final int len = text.codePointCount(0, text.length()); + for (int i = 0; i < len; i++) { + int codePoint = text.codePointAt(i); + String word = ALPHABETS.get(codePoint); + if (word == null) { + word = Integer.toBinaryString(codePoint); + } + morseBuilder.append(word.replace('0', dit).replace('1', dah)).append(split); + } + return morseBuilder.toString(); + } + + /** + * 解码 + * + * @param morse 莫尔斯电码 + * @return 明文 + */ + public String decode(String morse) { + Assert.notNull(morse, "Morse should not be null."); + + final char dit = this.dit; + final char dah = this.dah; + final char split = this.split; + if (false == StrUtil.containsOnly(morse, dit, dah, split)) { + throw new IllegalArgumentException("Incorrect morse."); + } + final List words = StrUtil.split(morse, split); + final StringBuilder textBuilder = new StringBuilder(); + Integer codePoint; + for (String word : words) { + if(StrUtil.isEmpty(word)){ + continue; + } + word = word.replace(dit, '0').replace(dah, '1'); + codePoint = DICTIONARIES.get(word); + if (codePoint == null) { + codePoint = Integer.valueOf(word, 2); + } + textBuilder.appendCodePoint(codePoint); + } + return textBuilder.toString(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/PercentCodec.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/PercentCodec.java new file mode 100755 index 0000000..d6d0778 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/PercentCodec.java @@ -0,0 +1,198 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.HexUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.OutputStreamWriter; +import java.io.Serializable; +import java.nio.charset.Charset; +import java.util.BitSet; + +/** + * 百分号编码(Percent-encoding), 也称作URL编码(URL encoding)。
+ * 百分号编码可用于URI的编码，也可以用于"application/x-www-form-urlencoded"的MIME准备数据。 + * + *

+ * 百分号编码会对 URI 中不允许出现的字符或者其他特殊情况的允许的字符进行编码，对于被编码的字符，最终会转为以百分号"%“开头，后面跟着两位16进制数值的形式。 + * 举个例子，空格符（SP）是不允许的字符，在 ASCII 码对应的二进制值是"00100000”，最终转为"%20"。 + *

+ *

+ * 对于不同场景应遵循不同规范： + * + *

    + *
  • URI：遵循RFC 3986保留字规范
    • + *
  • application/x-www-form-urlencoded，遵循W3C HTML Form content types规范，如空格须转+
    • + *
+ * + * @author looly + * @since 5.7.16 + */ +public class PercentCodec implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * 从已知PercentCodec创建PercentCodec，会复制给定PercentCodec的安全字符 + * + * @param codec PercentCodec + * @return PercentCodec + */ + public static PercentCodec of(PercentCodec codec) { + return new PercentCodec((BitSet) codec.safeCharacters.clone()); + } + + /** + * 创建PercentCodec，使用指定字符串中的字符作为安全字符 + * + * @param chars 安全字符合集 + * @return PercentCodec + */ + public static PercentCodec of(CharSequence chars) { + Assert.notNull(chars, "chars must not be null"); + final PercentCodec codec = new PercentCodec(); + final int length = chars.length(); + for (int i = 0; i < length; i++) { + codec.addSafe(chars.charAt(i)); + } + return codec; + } + + /** + * 存放安全编码 + */ + private final BitSet safeCharacters; + + /** + * 是否编码空格为+
+ * 如果为{@code true}，则将空格编码为"+"，此项只在"application/x-www-form-urlencoded"中使用
+ * 如果为{@code false}，则空格编码为"%20",此项一般用于URL的Query部分（RFC3986规范） + */ + private boolean encodeSpaceAsPlus = false; + + /** + * 构造
+ * [a-zA-Z0-9]默认不被编码 + */ + public PercentCodec() { + this(new BitSet(256)); + } + + /** + * 构造 + * + * @param safeCharacters 安全字符，安全字符不被编码 + */ + public PercentCodec(BitSet safeCharacters) { + this.safeCharacters = safeCharacters; + } + + /** + * 增加安全字符
+ * 安全字符不被编码 + * + * @param c 字符 + * @return this + */ + public PercentCodec addSafe(char c) { + safeCharacters.set(c); + return this; + } + + /** + * 移除安全字符
+ * 安全字符不被编码 + * + * @param c 字符 + * @return this + */ + public PercentCodec removeSafe(char c) { + safeCharacters.clear(c); + return this; + } + + /** + * 增加安全字符到挡墙的PercentCodec + * + * @param codec PercentCodec + * @return this + */ + public PercentCodec or(PercentCodec codec) { + this.safeCharacters.or(codec.safeCharacters); + return this; + } + + /** + * 组合当前PercentCodec和指定PercentCodec为一个新的PercentCodec，安全字符为并集 + * + * @param codec PercentCodec + * @return 新的PercentCodec + */ + public PercentCodec orNew(PercentCodec codec) { + return of(this).or(codec); + } + + /** + * 是否将空格编码为+
+ * 如果为{@code true}，则将空格编码为"+"，此项只在"application/x-www-form-urlencoded"中使用
+ * 如果为{@code false}，则空格编码为"%20",此项一般用于URL的Query部分（RFC3986规范） + * + * @param encodeSpaceAsPlus 是否将空格编码为+ + * @return this + */ + public PercentCodec setEncodeSpaceAsPlus(boolean encodeSpaceAsPlus) { + this.encodeSpaceAsPlus = encodeSpaceAsPlus; + return this; + } + + /** + * 将URL中的字符串编码为%形式 + * + * @param path 需要编码的字符串 + * @param charset 编码, {@code null}返回原字符串，表示不编码 + * @param customSafeChar 自定义安全字符 + * @return 编码后的字符串 + */ + public String encode(CharSequence path, Charset charset, char... customSafeChar) { + if (null == charset || StrUtil.isEmpty(path)) { + return StrUtil.str(path); + } + + final StringBuilder rewrittenPath = new StringBuilder(path.length()); + final ByteArrayOutputStream buf = new ByteArrayOutputStream(); + final OutputStreamWriter writer = new OutputStreamWriter(buf, charset); + + char c; + for (int i = 0; i < path.length(); i++) { + c = path.charAt(i); + if (safeCharacters.get(c) || ArrayUtil.contains(customSafeChar, c)) { + rewrittenPath.append(c); + } else if (encodeSpaceAsPlus && c == CharUtil.SPACE) { + // 对于空格单独处理 + rewrittenPath.append('+'); + } else { + // convert to external encoding before hex conversion + try { + writer.write(c); + writer.flush(); + } catch (IOException e) { + buf.reset(); + continue; + } + + // 兼容双字节的Unicode符处理（如部分emoji） + byte[] ba = buf.toByteArray(); + for (byte toEncode : ba) { + // Converting each byte in the buffer + rewrittenPath.append('%'); + HexUtil.appendHex(rewrittenPath, toEncode, false); + } + buf.reset(); + } + } + return rewrittenPath.toString(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/PunyCode.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/PunyCode.java new file mode 100644 index 0000000..77c4147 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/PunyCode.java @@ -0,0 +1,313 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.List; + +/** + * Punycode是一个根据RFC 3492标准而制定的编码系统，主要用于把域名从地方语言所采用的Unicode编码转换成为可用于DNS系统的编码 + *

+ * 参考：https://blog.csdn.net/a19881029/article/details/18262671 + * + * @author looly + * @since 5.5.2 + */ +public class PunyCode { + private static final int TMIN = 1; + private static final int TMAX = 26; + private static final int BASE = 36; + private static final int INITIAL_N = 128; + private static final int INITIAL_BIAS = 72; + private static final int DAMP = 700; + private static final int SKEW = 38; + private static final char DELIMITER = '-'; + + public static final String PUNY_CODE_PREFIX = "xn--"; + + /** + * punycode转码域名 + * + * @param domain 域名 + * @return 编码后的域名 + * @throws UtilException 计算异常 + */ + public static String encodeDomain(String domain) throws UtilException { + Assert.notNull(domain, "domain must not be null!"); + final List split = StrUtil.split(domain, CharUtil.DOT); + final StringBuilder result = new StringBuilder(domain.length() * 4); + for (final String str : split) { + if (result.length() != 0) { + result.append(CharUtil.DOT); + } + result.append(encode(str, true)); + } + + return result.toString(); + } + + /** + * 将内容编码为PunyCode + * + * @param input 字符串 + * @return PunyCode字符串 + * @throws UtilException 计算异常 + */ + public static String encode(CharSequence input) throws UtilException { + return encode(input, false); + } + + /** + * 将内容编码为PunyCode + * + * @param input 字符串 + * @param withPrefix 是否包含 "xn--"前缀 + * @return PunyCode字符串 + * @throws UtilException 计算异常 + */ + public static String encode(CharSequence input, boolean withPrefix) throws UtilException { + Assert.notNull(input, "input must not be null!"); + int n = INITIAL_N; + int delta = 0; + int bias = INITIAL_BIAS; + StringBuilder output = new StringBuilder(); + // Copy all basic code points to the output + final int length = input.length(); + int b = 0; + for (int i = 0; i < length; i++) { + char c = input.charAt(i); + if (isBasic(c)) { + output.append(c); + b++; + } + } + // Append delimiter + if (b > 0) { + if(b == length){ + // 无需要编码的字符 + return output.toString(); + } + output.append(DELIMITER); + } + int h = b; + while (h < length) { + int m = Integer.MAX_VALUE; + // Find the minimum code point >= n + for (int i = 0; i < length; i++) { + final char c = input.charAt(i); + if (c >= n && c < m) { + m = c; + } + } + if (m - n > (Integer.MAX_VALUE - delta) / (h + 1)) { + throw new UtilException("OVERFLOW"); + } + delta = delta + (m - n) * (h + 1); + n = m; + for (int j = 0; j < length; j++) { + int c = input.charAt(j); + if (c < n) { + delta++; + if (0 == delta) { + throw new UtilException("OVERFLOW"); + } + } + if (c == n) { + int q = delta; + for (int k = BASE; ; k += BASE) { + int t; + if (k <= bias) { + t = TMIN; + } else if (k >= bias + TMAX) { + t = TMAX; + } else { + t = k - bias; + } + if (q < t) { + break; + } + output.append((char) digit2codepoint(t + (q - t) % (BASE - t))); + q = (q - t) / (BASE - t); + } + output.append((char) digit2codepoint(q)); + bias = adapt(delta, h + 1, h == b); + delta = 0; + h++; + } + } + delta++; + n++; + } + + if (withPrefix) { + output.insert(0, PUNY_CODE_PREFIX); + } + return output.toString(); + } + + /** + * 解码punycode域名 + * + * @param domain PunyCode域名 + * @return 解码后的域名 + * @throws UtilException 计算异常 + */ + public static String decodeDomain(String domain) throws UtilException { + Assert.notNull(domain, "domain must not be null!"); + final List split = StrUtil.split(domain, CharUtil.DOT); + final StringBuilder result = new StringBuilder(domain.length() / 4 + 1); + for (final String str : split) { + if (result.length() != 0) { + result.append(CharUtil.DOT); + } + result.append(StrUtil.startWithIgnoreEquals(str, PUNY_CODE_PREFIX) ? decode(str) : str); + } + + return result.toString(); + } + + /** + * 解码 PunyCode为字符串 + * + * @param input PunyCode + * @return 字符串 + * @throws UtilException 计算异常 + */ + public static String decode(String input) throws UtilException { + Assert.notNull(input, "input must not be null!"); + input = StrUtil.removePrefixIgnoreCase(input, PUNY_CODE_PREFIX); + + int n = INITIAL_N; + int i = 0; + int bias = INITIAL_BIAS; + StringBuilder output = new StringBuilder(); + int d = input.lastIndexOf(DELIMITER); + if (d > 0) { + for (int j = 0; j < d; j++) { + final char c = input.charAt(j); + if (isBasic(c)) { + output.append(c); + } + } + d++; + } else { + d = 0; + } + final int length = input.length(); + while (d < length) { + int oldi = i; + int w = 1; + for (int k = BASE; ; k += BASE) { + if (d == length) { + throw new UtilException("BAD_INPUT"); + } + int c = input.charAt(d++); + int digit = codepoint2digit(c); + if (digit > (Integer.MAX_VALUE - i) / w) { + throw new UtilException("OVERFLOW"); + } + i = i + digit * w; + int t; + if (k <= bias) { + t = TMIN; + } else if (k >= bias + TMAX) { + t = TMAX; + } else { + t = k - bias; + } + if (digit < t) { + break; + } + w = w * (BASE - t); + } + bias = adapt(i - oldi, output.length() + 1, oldi == 0); + if (i / (output.length() + 1) > Integer.MAX_VALUE - n) { + throw new UtilException("OVERFLOW"); + } + n = n + i / (output.length() + 1); + i = i % (output.length() + 1); + output.insert(i, (char) n); + i++; + } + + return output.toString(); + } + + private static int adapt(int delta, int numpoints, boolean first) { + if (first) { + delta = delta / DAMP; + } else { + delta = delta / 2; + } + delta = delta + (delta / numpoints); + int k = 0; + while (delta > ((BASE - TMIN) * TMAX) / 2) { + delta = delta / (BASE - TMIN); + k = k + BASE; + } + return k + ((BASE - TMIN + 1) * delta) / (delta + SKEW); + } + + private static boolean isBasic(char c) { + return c < 0x80; + } + + /** + * 将数字转为字符，对应关系为： + * 

+	 *     0 -> a
+	 *     1 -> b
+	 *     ...
+	 *     25 -> z
+	 *     26 -> '0'
+	 *     ...
+	 *     35 -> '9'
+	 *
+ * + * @param d 输入字符 + * @return 转换后的字符 + * @throws UtilException 无效字符 + */ + private static int digit2codepoint(int d) throws UtilException { + Assert.checkBetween(d, 0, 35); + if (d < 26) { + // 0..25 : 'a'..'z' + return d + 'a'; + } else if (d < 36) { + // 26..35 : '0'..'9'; + return d - 26 + '0'; + } else { + throw new UtilException("BAD_INPUT"); + } + } + + /** + * 将字符转为数字，对应关系为： + * 
+	 *     a -> 0
+	 *     b -> 1
+	 *     ...
+	 *     z -> 25
+	 *     '0' -> 26
+	 *     ...
+	 *     '9' -> 35
+	 *
+ * + * @param c 输入字符 + * @return 转换后的字符 + * @throws UtilException 无效字符 + */ + private static int codepoint2digit(int c) throws UtilException { + if (c - '0' < 10) { + // '0'..'9' : 26..35 + return c - '0' + 26; + } else if (c - 'a' < 26) { + // 'a'..'z' : 0..25 + return c - 'a'; + } else { + throw new UtilException("BAD_INPUT"); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Rot.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Rot.java new file mode 100644 index 0000000..edba829 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/Rot.java @@ -0,0 +1,177 @@ +package aiyh.utils.tool.cn.hutool.core.codec; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +/** + * RotN（rotate by N places），回转N位密码，是一种简易的替换式密码，也是过去在古罗马开发的凯撒加密的一种变体。
+ * 代码来自：https://github.com/orclight/jencrypt + * + * @author looly,shuzhilong + * @since 4.4.1 + */ +public class Rot { + + private static final char aCHAR = 'a'; + private static final char zCHAR = 'z'; + private static final char ACHAR = 'A'; + private static final char ZCHAR = 'Z'; + private static final char CHAR0 = '0'; + private static final char CHAR9 = '9'; + + /** + * Rot-13编码，同时编码数字 + * + * @param message 被编码的消息 + * @return 编码后的字符串 + */ + public static String encode13(String message) { + return encode13(message, true); + } + + /** + * Rot-13编码 + * + * @param message 被编码的消息 + * @param isEncodeNumber 是否编码数字 + * @return 编码后的字符串 + */ + public static String encode13(String message, boolean isEncodeNumber) { + return encode(message, 13, isEncodeNumber); + } + + /** + * RotN编码 + * + * @param message 被编码的消息 + * @param offset 位移，常用位移13 + * @param isEncodeNumber 是否编码数字 + * @return 编码后的字符串 + */ + public static String encode(String message, int offset, boolean isEncodeNumber) { + Assert.notNull(message, "message must not be null"); + final int len = message.length(); + final char[] chars = new char[len]; + + for (int i = 0; i < len; i++) { + chars[i] = encodeChar(message.charAt(i), offset, isEncodeNumber); + } + return new String(chars); + } + + /** + * Rot-13解码，同时解码数字 + * + * @param rot 被解码的消息密文 + * @return 解码后的字符串 + */ + public static String decode13(String rot) { + return decode13(rot, true); + } + + /** + * Rot-13解码 + * + * @param rot 被解码的消息密文 + * @param isDecodeNumber 是否解码数字 + * @return 解码后的字符串 + */ + public static String decode13(String rot, boolean isDecodeNumber) { + return decode(rot, 13, isDecodeNumber); + } + + /** + * RotN解码 + * + * @param rot 被解码的消息密文 + * @param offset 位移，常用位移13 + * @param isDecodeNumber 是否解码数字 + * @return 解码后的字符串 + */ + public static String decode(String rot, int offset, boolean isDecodeNumber) { + Assert.notNull(rot, "rot must not be null"); + final int len = rot.length(); + final char[] chars = new char[len]; + + for (int i = 0; i < len; i++) { + chars[i] = decodeChar(rot.charAt(i), offset, isDecodeNumber); + } + return new String(chars); + } + + // ------------------------------------------------------------------------------------------ Private method start + /** + * 解码字符 + * + * @param c 字符 + * @param offset 位移 + * @param isDecodeNumber 是否解码数字 + * @return 解码后的字符串 + */ + private static char encodeChar(char c, int offset, boolean isDecodeNumber) { + if (isDecodeNumber) { + if (c >= CHAR0 && c <= CHAR9) { + c -= CHAR0; + c = (char) ((c + offset) % 10); + c += CHAR0; + } + } + + // A == 65, Z == 90 + if (c >= ACHAR && c <= ZCHAR) { + c -= ACHAR; + c = (char) ((c + offset) % 26); + c += ACHAR; + } + // a == 97, z == 122. + else if (c >= aCHAR && c <= zCHAR) { + c -= aCHAR; + c = (char) ((c + offset) % 26); + c += aCHAR; + } + return c; + } + + /** + * 编码字符 + * + * @param c 字符 + * @param offset 位移 + * @param isDecodeNumber 是否编码数字 + * @return 编码后的字符串 + */ + private static char decodeChar(char c, int offset, boolean isDecodeNumber) { + int temp = c; + // if converting numbers is enabled + if (isDecodeNumber) { + if (temp >= CHAR0 && temp <= CHAR9) { + temp -= CHAR0; + temp = temp - offset; + while (temp < 0) { + temp += 10; + } + temp += CHAR0; + } + } + + // A == 65, Z == 90 + if (temp >= ACHAR && temp <= ZCHAR) { + temp -= ACHAR; + + temp = temp - offset; + while (temp < 0) { + temp = 26 + temp; + } + temp += ACHAR; + } else if (temp >= aCHAR && temp <= zCHAR) { + temp -= aCHAR; + + temp = temp - offset; + if (temp < 0) + temp = 26 + temp; + + temp += aCHAR; + } + return (char) temp; + } + // ------------------------------------------------------------------------------------------ Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/package-info.java new file mode 100644 index 0000000..8e11d72 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/codec/package-info.java @@ -0,0 +1,7 @@ +/** + * BaseN以及BCD编码封装 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.codec; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ArrayIter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ArrayIter.java new file mode 100644 index 0000000..360d606 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ArrayIter.java @@ -0,0 +1,133 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import java.io.Serializable; +import java.lang.reflect.Array; +import java.util.NoSuchElementException; + +/** + * 数组Iterator对象 + * + * @param 元素类型 + * @author Looly + * @since 4.1.1 + */ +public class ArrayIter implements IterableIter, ResettableIter, Serializable { + private static final long serialVersionUID = 1L; + + /** + * 数组 + */ + private final Object array; + /** + * 起始位置 + */ + private int startIndex; + /** + * 结束位置 + */ + private int endIndex; + /** + * 当前位置 + */ + private int index; + + /** + * 构造 + * + * @param array 数组 + * @throws IllegalArgumentException array对象不为数组抛出此异常 + * @throws NullPointerException array对象为null + */ + public ArrayIter(E[] array) { + this((Object) array); + } + + /** + * 构造 + * + * @param array 数组 + * @throws IllegalArgumentException array对象不为数组抛出此异常 + * @throws NullPointerException array对象为null + */ + public ArrayIter(Object array) { + this(array, 0); + } + + /** + * 构造 + * + * @param array 数组 + * @param startIndex 起始位置，当起始位置小于0或者大于结束位置，置为0。 + * @throws IllegalArgumentException array对象不为数组抛出此异常 + * @throws NullPointerException array对象为null + */ + public ArrayIter(Object array, int startIndex) { + this(array, startIndex, -1); + } + + /** + * 构造 + * + * @param array 数组 + * @param startIndex 起始位置，当起始位置小于0或者大于结束位置，置为0。 + * @param endIndex 结束位置，当结束位置小于0或者大于数组长度，置为数组长度。 + * @throws IllegalArgumentException array对象不为数组抛出此异常 + * @throws NullPointerException array对象为null + */ + public ArrayIter(final Object array, final int startIndex, final int endIndex) { + this.endIndex = Array.getLength(array); + if (endIndex > 0 && endIndex < this.endIndex) { + this.endIndex = endIndex; + } + + if (startIndex >= 0 && startIndex < this.endIndex) { + this.startIndex = startIndex; + } + this.array = array; + this.index = this.startIndex; + } + + @Override + public boolean hasNext() { + return (index < endIndex); + } + + @Override + @SuppressWarnings("unchecked") + public E next() { + if (hasNext() == false) { + throw new NoSuchElementException(); + } + return (E) Array.get(array, index++); + } + + /** + * 不允许操作数组元素 + * + * @throws UnsupportedOperationException always + */ + @Override + public void remove() { + throw new UnsupportedOperationException("remove() method is not supported"); + } + + // Properties + // ----------------------------------------------------------------------- + + /** + * 获得原始数组对象 + * + * @return 原始数组对象 + */ + public Object getArray() { + return array; + } + + /** + * 重置数组位置 + */ + @Override + public void reset() { + this.index = this.startIndex; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/AvgPartition.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/AvgPartition.java new file mode 100644 index 0000000..024ee5c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/AvgPartition.java @@ -0,0 +1,59 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.util.List; + +/** + * 列表分区或分段
+ * 通过传入分区个数，将指定列表分区为不同的块，每块区域的长度均匀分布（个数差不超过1）
+ * 
+ *     [1,2,3,4] -》 [1,2], [3, 4]
+ *     [1,2,3,4] -》 [1,2], [3], [4]
+ *     [1,2,3,4] -》 [1], [2], [3], [4]
+ *     [1,2,3,4] -》 [1], [2], [3], [4], []
+ *
+ * 分区是在原List的基础上进行的，返回的分区是不可变的抽象列表，原列表元素变更，分区中元素也会变更。 + * + * @param 元素类型 + * @author looly + * @since 5.7.10 + */ +public class AvgPartition extends Partition { + + final int limit; + // 平均分完后剩余的个数，平均放在前remainder个分区中 + final int remainder; + + /** + * 列表分区 + * + * @param list 被分区的列表 + * @param limit 分区个数 + */ + public AvgPartition(List list, int limit) { + super(list, list.size() / (limit <= 0 ? 1 : limit)); + Assert.isTrue(limit > 0, "Partition limit must be > 0"); + this.limit = limit; + this.remainder = list.size() % limit; + } + + @Override + public List get(int index) { + final int size = this.size; + final int remainder = this.remainder; + // 当limit个数超过list的size时，size为0，此时每个分区分1个元素，直到remainder个分配完，剩余分区为[] + int start = index * size + Math.min(index, remainder); + int end = start + size; + if (index + 1 <= remainder) { + // 将remainder个元素平均分布在前面，每个分区分1个 + end += 1; + } + return list.subList(start, end); + } + + @Override + public int size() { + return limit; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/BoundedPriorityQueue.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/BoundedPriorityQueue.java new file mode 100644 index 0000000..5e69072 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/BoundedPriorityQueue.java @@ -0,0 +1,90 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Comparator; +import java.util.Iterator; +import java.util.PriorityQueue; + +/** + * 有界优先队列
+ * 按照给定的排序规则，排序元素，当队列满时，按照给定的排序规则淘汰末尾元素（去除末尾元素） + * @author xiaoleilu + * + * @param 成员类型 + */ +public class BoundedPriorityQueue extends PriorityQueue{ + private static final long serialVersionUID = 3794348988671694820L; + + //容量 + private final int capacity; + private final Comparator comparator; + + public BoundedPriorityQueue(int capacity) { + this(capacity, null); + } + + /** + * 构造 + * @param capacity 容量 + * @param comparator 比较器 + */ + public BoundedPriorityQueue(int capacity, final Comparator comparator) { + super(capacity, (o1, o2) -> { + int cResult; + if(comparator != null) { + cResult = comparator.compare(o1, o2); + }else { + @SuppressWarnings("unchecked") + Comparable o1c = (Comparable)o1; + cResult = o1c.compareTo(o2); + } + + return - cResult; + }); + this.capacity = capacity; + this.comparator = comparator; + } + + /** + * 加入元素，当队列满时，淘汰末尾元素 + * @param e 元素 + * @return 加入成功与否 + */ + @Override + public boolean offer(E e) { + if(size() >= capacity) { + E head = peek(); + if (this.comparator().compare(e, head) <= 0){ + return true; + } + //当队列满时，就要淘汰顶端队列 + poll(); + } + return super.offer(e); + } + + /** + * 添加多个元素
+ * 参数为集合的情况请使用{@link PriorityQueue#addAll} + * @param c 元素数组 + * @return 是否发生改变 + */ + public boolean addAll(E[] c) { + return this.addAll(Arrays.asList(c)); + } + + /** + * @return 返回排序后的列表 + */ + public ArrayList toList() { + final ArrayList list = new ArrayList<>(this); + list.sort(comparator); + return list; + } + + @Override + public Iterator iterator() { + return toList().iterator(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/CollStreamUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/CollStreamUtil.java new file mode 100644 index 0000000..e9a1e41 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/CollStreamUtil.java @@ -0,0 +1,388 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + + +import aiyh.utils.tool.cn.hutool.core.lang.Opt; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.stream.CollectorUtil; +import aiyh.utils.tool.cn.hutool.core.stream.StreamUtil; + +import java.util.Collection; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.function.BiFunction; +import java.util.function.Function; +import java.util.stream.Collector; +import java.util.stream.Collectors; + +/** + * 集合的stream操作封装 + * + * @author 528910437@QQ.COM, VampireAchao<achao1441470436@gmail.com>Lion Li> + * @since 5.5.2 + */ +public class CollStreamUtil { + + /** + * 将collection转化为类型不变的map
+ * {@code Collection ----> Map} + * + * @param collection 需要转化的集合 + * @param key V类型转化为K类型的lambda方法 + * @param collection中的泛型 + * @param map中的key类型 + * @return 转化后的map + */ + public static Map toIdentityMap(Collection collection, Function key) { + return toIdentityMap(collection, key, false); + } + + + /** + * 将collection转化为类型不变的map
+ * {@code Collection ----> Map} + * + * @param collection 需要转化的集合 + * @param key V类型转化为K类型的lambda方法 + * @param isParallel 是否并行流 + * @param collection中的泛型 + * @param map中的key类型 + * @return 转化后的map + */ + public static Map toIdentityMap(Collection collection, Function key, boolean isParallel) { + if (CollUtil.isEmpty(collection)) { + return MapUtil.newHashMap(0); + } + return toMap(collection, (v) -> Opt.ofNullable(v).map(key).get(), Function.identity(), isParallel); + } + + /** + * 将Collection转化为map(value类型与collection的泛型不同)
+ * {@code Collection -----> Map } + * + * @param collection 需要转化的集合 + * @param key E类型转化为K类型的lambda方法 + * @param value E类型转化为V类型的lambda方法 + * @param collection中的泛型 + * @param map中的key类型 + * @param map中的value类型 + * @return 转化后的map + */ + public static Map toMap(Collection collection, Function key, Function value) { + return toMap(collection, key, value, false); + } + + /** + * @param collection 需要转化的集合 + * @param key E类型转化为K类型的lambda方法 + * @param value E类型转化为V类型的lambda方法 + * @param isParallel 是否并行流 + * @param collection中的泛型 + * @param map中的key类型 + * @param map中的value类型 + * @return 转化后的map + */ + public static Map toMap(Collection collection, Function key, Function value, boolean isParallel) { + if (CollUtil.isEmpty(collection)) { + return MapUtil.newHashMap(0); + } + return StreamUtil.of(collection, isParallel) + .collect(HashMap::new, (m, v) -> m.put(key.apply(v), value.apply(v)), HashMap::putAll); + } + + + /** + * 将collection按照规则(比如有相同的班级id)分组成map
+ * {@code Collection -------> Map> } + * + * @param collection 需要分组的集合 + * @param key 分组的规则 + * @param collection中的泛型 + * @param map中的key类型 + * @return 分组后的map + */ + public static Map> groupByKey(Collection collection, Function key) { + return groupByKey(collection, key, false); + } + + /** + * 将collection按照规则(比如有相同的班级id)分组成map
+ * {@code Collection -------> Map> } + * + * @param collection 需要分组的集合 + * @param key 键分组的规则 + * @param isParallel 是否并行流 + * @param collection中的泛型 + * @param map中的key类型 + * @return 分组后的map + */ + public static Map> groupByKey(Collection collection, Function key, boolean isParallel) { + if (CollUtil.isEmpty(collection)) { + return MapUtil.newHashMap(0); + } + return groupBy(collection, key, Collectors.toList(), isParallel); + } + + /** + * 将collection按照两个规则(比如有相同的年级id,班级id)分组成双层map
+ * {@code Collection ---> Map>> } + * + * @param collection 需要分组的集合 + * @param key1 第一个分组的规则 + * @param key2 第二个分组的规则 + * @param 集合元素类型 + * @param 第一个map中的key类型 + * @param 第二个map中的key类型 + * @return 分组后的map + */ + public static Map>> groupBy2Key(Collection collection, Function key1, Function key2) { + return groupBy2Key(collection, key1, key2, false); + } + + + /** + * 将collection按照两个规则(比如有相同的年级id,班级id)分组成双层map
+ * {@code Collection ---> Map>> } + * + * @param collection 需要分组的集合 + * @param key1 第一个分组的规则 + * @param key2 第二个分组的规则 + * @param isParallel 是否并行流 + * @param 集合元素类型 + * @param 第一个map中的key类型 + * @param 第二个map中的key类型 + * @return 分组后的map + */ + public static Map>> groupBy2Key(Collection collection, Function key1, + Function key2, boolean isParallel) { + if (CollUtil.isEmpty(collection)) { + return MapUtil.newHashMap(0); + } + return groupBy(collection, key1, CollectorUtil.groupingBy(key2, Collectors.toList()), isParallel); + } + + /** + * 将collection按照两个规则(比如有相同的年级id,班级id)分组成双层map
+ * {@code Collection ---> Map> } + * + * @param collection 需要分组的集合 + * @param key1 第一个分组的规则 + * @param key2 第二个分组的规则 + * @param 第一个map中的key类型 + * @param 第二个map中的key类型 + * @param collection中的泛型 + * @return 分组后的map + */ + public static Map> group2Map(Collection collection, Function key1, Function key2) { + return group2Map(collection, key1, key2, false); + } + + /** + * 将collection按照两个规则(比如有相同的年级id,班级id)分组成双层map
+ * {@code Collection ---> Map> } + * + * @param collection 需要分组的集合 + * @param key1 第一个分组的规则 + * @param key2 第二个分组的规则 + * @param isParallel 是否并行流 + * @param 第一个map中的key类型 + * @param 第二个map中的key类型 + * @param collection中的泛型 + * @return 分组后的map + */ + public static Map> group2Map(Collection collection, + Function key1, Function key2, boolean isParallel) { + if (CollUtil.isEmpty(collection) || key1 == null || key2 == null) { + return MapUtil.newHashMap(0); + } + return groupBy(collection, key1, CollectorUtil.toMap(key2, Function.identity(), (l, r) -> l), isParallel); + } + + /** + * 将collection按照规则(比如有相同的班级id)分组成map，map中的key为班级id，value为班级名
+ * {@code Collection -------> Map> } + * + * @param collection 需要分组的集合 + * @param key 键分组的规则 + * @param value 值分组的规则 + * @param collection中的泛型 + * @param map中的key类型 + * @param List中的value类型 + * @return 分组后的map + */ + public static Map> groupKeyValue(Collection collection, Function key, + Function value) { + return groupKeyValue(collection, key, value, false); + } + + /** + * 将collection按照规则(比如有相同的班级id)分组成map，map中的key为班级id，value为班级名
+ * {@code Collection -------> Map> } + * + * @param collection 需要分组的集合 + * @param key 键分组的规则 + * @param value 值分组的规则 + * @param isParallel 是否并行流 + * @param collection中的泛型 + * @param map中的key类型 + * @param List中的value类型 + * @return 分组后的map + */ + public static Map> groupKeyValue(Collection collection, Function key, + Function value, boolean isParallel) { + if (CollUtil.isEmpty(collection)) { + return MapUtil.newHashMap(0); + } + return groupBy(collection, key, Collectors.mapping(v -> Opt.ofNullable(v).map(value).orElse(null), Collectors.toList()), isParallel); + } + + /** + * 作为所有groupingBy的公共方法，更接近于原生，灵活性更强 + * + * @param collection 需要分组的集合 + * @param key 第一次分组时需要的key + * @param downstream 分组后需要进行的操作 + * @param collection中的泛型 + * @param map中的key类型 + * @param 后续操作的返回值 + * @return 分组后的map + * @since 5.7.18 + */ + public static Map groupBy(Collection collection, Function key, Collector downstream) { + if (CollUtil.isEmpty(collection)) { + return MapUtil.newHashMap(0); + } + return groupBy(collection, key, downstream, false); + } + + /** + * 作为所有groupingBy的公共方法，更接近于原生，灵活性更强 + * + * @param collection 需要分组的集合 + * @param key 第一次分组时需要的key + * @param downstream 分组后需要进行的操作 + * @param isParallel 是否并行流 + * @param collection中的泛型 + * @param map中的key类型 + * @param 后续操作的返回值 + * @return 分组后的map + * @see Collectors#groupingBy(Function, Collector) + * @since 5.7.18 + */ + public static Map groupBy(Collection collection, Function key, Collector downstream, boolean isParallel) { + if (CollUtil.isEmpty(collection)) { + return MapUtil.newHashMap(0); + } + return StreamUtil.of(collection, isParallel).collect(CollectorUtil.groupingBy(key, downstream)); + } + + /** + * 将collection转化为List集合，但是两者的泛型不同
+ * {@code Collection ------> List } + * + * @param collection 需要转化的集合 + * @param function collection中的泛型转化为list泛型的lambda表达式 + * @param collection中的泛型 + * @param List中的泛型 + * @return 转化后的list + */ + public static List toList(Collection collection, Function function) { + return toList(collection, function, false); + } + + /** + * 将collection转化为List集合，但是两者的泛型不同
+ * {@code Collection ------> List } + * + * @param collection 需要转化的集合 + * @param function collection中的泛型转化为list泛型的lambda表达式 + * @param isParallel 是否并行流 + * @param collection中的泛型 + * @param List中的泛型 + * @return 转化后的list + */ + public static List toList(Collection collection, Function function, boolean isParallel) { + if (CollUtil.isEmpty(collection)) { + return CollUtil.newArrayList(); + } + return StreamUtil.of(collection, isParallel) + .map(function) + .filter(Objects::nonNull) + .collect(Collectors.toList()); + } + + /** + * 将collection转化为Set集合，但是两者的泛型不同
+ * {@code Collection ------> Set } + * + * @param collection 需要转化的集合 + * @param function collection中的泛型转化为set泛型的lambda表达式 + * @param collection中的泛型 + * @param Set中的泛型 + * @return 转化后的Set + */ + public static Set toSet(Collection collection, Function function) { + return toSet(collection, function, false); + } + + /** + * 将collection转化为Set集合，但是两者的泛型不同
+ * {@code Collection ------> Set } + * + * @param collection 需要转化的集合 + * @param function collection中的泛型转化为set泛型的lambda表达式 + * @param isParallel 是否并行流 + * @param collection中的泛型 + * @param Set中的泛型 + * @return 转化后的Set + */ + public static Set toSet(Collection collection, Function function, boolean isParallel) { + if (CollUtil.isEmpty(collection)) { + return CollUtil.newHashSet(); + } + return StreamUtil.of(collection, isParallel) + .map(function) + .filter(Objects::nonNull) + .collect(Collectors.toSet()); + } + + + /** + * 合并两个相同key类型的map + * + * @param map1 第一个需要合并的 map + * @param map2 第二个需要合并的 map + * @param merge 合并的lambda，将key value1 value2合并成最终的类型,注意value可能为空的情况 + * @param map中的key类型 + * @param 第一个 map的value类型 + * @param 第二个 map的value类型 + * @param 最终map的value类型 + * @return 合并后的map + */ + public static Map merge(Map map1, Map map2, BiFunction merge) { + if (MapUtil.isEmpty(map1) && MapUtil.isEmpty(map2)) { + return MapUtil.newHashMap(0); + } else if (MapUtil.isEmpty(map1)) { + map1 = MapUtil.newHashMap(0); + } else if (MapUtil.isEmpty(map2)) { + map2 = MapUtil.newHashMap(0); + } + Set key = new HashSet<>(); + key.addAll(map1.keySet()); + key.addAll(map2.keySet()); + Map map = MapUtil.newHashMap(key.size()); + for (K t : key) { + X x = map1.get(t); + Y y = map2.get(t); + V z = merge.apply(x, y); + if (z != null) { + map.put(t, z); + } + } + return map; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/CollUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/CollUtil.java new file mode 100755 index 0000000..e820f3c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/CollUtil.java @@ -0,0 +1,3103 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.comparator.CompareUtil; +import aiyh.utils.tool.cn.hutool.core.comparator.PinyinComparator; +import aiyh.utils.tool.cn.hutool.core.comparator.PropertyComparator; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.convert.ConverterRegistry; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Editor; +import aiyh.utils.tool.cn.hutool.core.lang.Filter; +import aiyh.utils.tool.cn.hutool.core.lang.Matcher; +import aiyh.utils.tool.cn.hutool.core.lang.func.Func1; +import aiyh.utils.tool.cn.hutool.core.lang.hash.Hash32; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.*; + +import java.io.Serializable; +import java.lang.reflect.Type; +import java.util.*; +import java.util.Map.Entry; +import java.util.concurrent.ArrayBlockingQueue; +import java.util.concurrent.BlockingQueue; +import java.util.concurrent.CopyOnWriteArrayList; +import java.util.concurrent.LinkedBlockingDeque; +import java.util.function.BiConsumer; +import java.util.function.Function; +import java.util.function.Predicate; +import java.util.function.Supplier; + +/** + * 集合相关工具类 + *

+ * 此工具方法针对{@link Collection}及其实现类封装的工具。 + *

+ * 由于{@link Collection} 实现了{@link Iterable}接口，因此部分工具此类不提供，而是在{@link IterUtil} 中提供 + * + * @author xiaoleilu + * @see IterUtil + * @since 3.1.1 + */ +public class CollUtil { + + /** + * 如果提供的集合为{@code null}，返回一个不可变的默认空集合，否则返回原集合
+ * 空集合使用{@link Collections#emptySet()} + * + * @param 集合元素类型 + * @param set 提供的集合，可能为null + * @return 原集合，若为null返回空集合 + * @since 4.6.3 + */ + public static Set emptyIfNull(Set set) { + return (null == set) ? Collections.emptySet() : set; + } + + /** + * 如果提供的集合为{@code null}，返回一个不可变的默认空集合，否则返回原集合
+ * 空集合使用{@link Collections#emptyList()} + * + * @param 集合元素类型 + * @param list 提供的集合，可能为null + * @return 原集合，若为null返回空集合 + * @since 4.6.3 + */ + public static List emptyIfNull(List list) { + return (null == list) ? Collections.emptyList() : list; + } + + /** + * 两个集合的并集
+ * 针对一个集合中存在多个相同元素的情况，计算两个集合中此元素的个数，保留最多的个数
+ * 例如：集合1：[a, b, c, c, c]，集合2：[a, b, c, c]
+ * 结果：[a, b, c, c, c]，此结果中只保留了三个c + * + * @param 集合元素类型 + * @param coll1 集合1 + * @param coll2 集合2 + * @return 并集的集合，返回 {@link ArrayList} + */ + public static Collection union(Collection coll1, Collection coll2) { + if (isEmpty(coll1) && isEmpty(coll2)) { + return new ArrayList<>(); + } + if (isEmpty(coll1)) { + return new ArrayList<>(coll2); + } else if (isEmpty(coll2)) { + return new ArrayList<>(coll1); + } + + final ArrayList list = new ArrayList<>(Math.max(coll1.size(), coll2.size())); + final Map map1 = countMap(coll1); + final Map map2 = countMap(coll2); + final Set elts = newHashSet(coll2); + elts.addAll(coll1); + int m; + for (T t : elts) { + m = Math.max(Convert.toInt(map1.get(t), 0), Convert.toInt(map2.get(t), 0)); + for (int i = 0; i < m; i++) { + list.add(t); + } + } + return list; + } + + /** + * 多个集合的并集
+ * 针对一个集合中存在多个相同元素的情况，计算两个集合中此元素的个数，保留最多的个数
+ * 例如：集合1：[a, b, c, c, c]，集合2：[a, b, c, c]
+ * 结果：[a, b, c, c, c]，此结果中只保留了三个c + * + * @param 集合元素类型 + * @param coll1 集合1 + * @param coll2 集合2 + * @param otherColls 其它集合 + * @return 并集的集合，返回 {@link ArrayList} + */ + @SafeVarargs + public static Collection union(Collection coll1, Collection coll2, Collection... otherColls) { + Collection union = union(coll1, coll2); + for (Collection coll : otherColls) { + if (isEmpty(coll)) { + continue; + } + union = union(union, coll); + } + return union; + } + + /** + * 多个集合的非重复并集，类似于SQL中的“UNION DISTINCT”
+ * 针对一个集合中存在多个相同元素的情况，只保留一个
+ * 例如：集合1：[a, b, c, c, c]，集合2：[a, b, c, c]
+ * 结果：[a, b, c]，此结果中只保留了一个c + * + * @param 集合元素类型 + * @param coll1 集合1 + * @param coll2 集合2 + * @param otherColls 其它集合 + * @return 并集的集合，返回 {@link LinkedHashSet} + */ + @SafeVarargs + public static Set unionDistinct(Collection coll1, Collection coll2, Collection... otherColls) { + final Set result; + if (isEmpty(coll1)) { + result = new LinkedHashSet<>(); + } else { + result = new LinkedHashSet<>(coll1); + } + + if (isNotEmpty(coll2)) { + result.addAll(coll2); + } + + if (ArrayUtil.isNotEmpty(otherColls)) { + for (Collection otherColl : otherColls) { + if (isEmpty(otherColl)) { + continue; + } + result.addAll(otherColl); + } + } + + return result; + } + + /** + * 多个集合的完全并集，类似于SQL中的“UNION ALL”
+ * 针对一个集合中存在多个相同元素的情况，保留全部元素
+ * 例如：集合1：[a, b, c, c, c]，集合2：[a, b, c, c]
+ * 结果：[a, b, c, c, c, a, b, c, c] + * + * @param 集合元素类型 + * @param coll1 集合1 + * @param coll2 集合2 + * @param otherColls 其它集合 + * @return 并集的集合，返回 {@link ArrayList} + */ + @SafeVarargs + public static List unionAll(Collection coll1, Collection coll2, Collection... otherColls) { + if (CollUtil.isEmpty(coll1) && CollUtil.isEmpty(coll2) && ArrayUtil.isEmpty(otherColls)) { + return new ArrayList<>(0); + } + + // 计算元素总数 + int totalSize = 0; + totalSize += size(coll1); + totalSize += size(coll2); + if (otherColls != null) { + for (final Collection otherColl : otherColls) { + totalSize += size(otherColl); + } + } + + // 根据size创建，防止多次扩容 + final List res = new ArrayList<>(totalSize); + if (coll1 != null) { + res.addAll(coll1); + } + if (coll2 != null) { + res.addAll(coll2); + } + if (otherColls == null) { + return res; + } + + for (final Collection otherColl : otherColls) { + if (otherColl != null) { + res.addAll(otherColl); + } + } + + return res; + } + + /** + * 两个集合的交集
+ * 针对一个集合中存在多个相同元素的情况，计算两个集合中此元素的个数，保留最少的个数
+ * 例如：集合1：[a, b, c, c, c]，集合2：[a, b, c, c]
+ * 结果：[a, b, c, c]，此结果中只保留了两个c + * + * @param 集合元素类型 + * @param coll1 集合1 + * @param coll2 集合2 + * @return 交集的集合，返回 {@link ArrayList} + */ + public static Collection intersection(Collection coll1, Collection coll2) { + if (isNotEmpty(coll1) && isNotEmpty(coll2)) { + final ArrayList list = new ArrayList<>(Math.min(coll1.size(), coll2.size())); + final Map map1 = countMap(coll1); + final Map map2 = countMap(coll2); + final Set elts = newHashSet(coll2); + int m; + for (T t : elts) { + m = Math.min(Convert.toInt(map1.get(t), 0), Convert.toInt(map2.get(t), 0)); + for (int i = 0; i < m; i++) { + list.add(t); + } + } + return list; + } + + return new ArrayList<>(); + } + + /** + * 多个集合的交集
+ * 针对一个集合中存在多个相同元素的情况，计算两个集合中此元素的个数，保留最少的个数
+ * 例如：集合1：[a, b, c, c, c]，集合2：[a, b, c, c]
+ * 结果：[a, b, c, c]，此结果中只保留了两个c + * + * @param 集合元素类型 + * @param coll1 集合1 + * @param coll2 集合2 + * @param otherColls 其它集合 + * @return 交集的集合，返回 {@link ArrayList} + */ + @SafeVarargs + public static Collection intersection(Collection coll1, Collection coll2, Collection... otherColls) { + Collection intersection = intersection(coll1, coll2); + if (isEmpty(intersection)) { + return intersection; + } + for (Collection coll : otherColls) { + intersection = intersection(intersection, coll); + if (isEmpty(intersection)) { + return intersection; + } + } + return intersection; + } + + /** + * 多个集合的交集
+ * 针对一个集合中存在多个相同元素的情况，只保留一个
+ * 例如：集合1：[a, b, c, c, c]，集合2：[a, b, c, c]
+ * 结果：[a, b, c]，此结果中只保留了一个c + * + * @param 集合元素类型 + * @param coll1 集合1 + * @param coll2 集合2 + * @param otherColls 其它集合 + * @return 交集的集合，返回 {@link LinkedHashSet} + * @since 5.3.9 + */ + @SafeVarargs + public static Set intersectionDistinct(Collection coll1, Collection coll2, Collection... otherColls) { + final Set result; + if (isEmpty(coll1) || isEmpty(coll2)) { + // 有一个空集合就直接返回空 + return new LinkedHashSet<>(); + } else { + result = new LinkedHashSet<>(coll1); + } + + if (ArrayUtil.isNotEmpty(otherColls)) { + for (Collection otherColl : otherColls) { + if (isNotEmpty(otherColl)) { + result.retainAll(otherColl); + } else { + // 有一个空集合就直接返回空 + return new LinkedHashSet<>(); + } + } + } + + result.retainAll(coll2); + + return result; + } + + /** + * 两个集合的差集
+ * 针对一个集合中存在多个相同元素的情况，计算两个集合中此元素的个数，保留两个集合中此元素个数差的个数
+ * 例如： + * + * 

+	 *     disjunction([a, b, c, c, c], [a, b, c, c]) -》 [c]
+	 *     disjunction([a, b], [])                    -》 [a, b]
+	 *     disjunction([a, b, c], [b, c, d])          -》 [a, d]
+	 *
+ * 任意一个集合为空，返回另一个集合
+ * 两个集合无差集则返回空集合 + * + * @param 集合元素类型 + * @param coll1 集合1 + * @param coll2 集合2 + * @return 差集的集合，返回 {@link ArrayList} + */ + public static Collection disjunction(Collection coll1, Collection coll2) { + if (isEmpty(coll1)) { + return coll2; + } + if (isEmpty(coll2)) { + return coll1; + } + + final List result = new ArrayList<>(); + final Map map1 = countMap(coll1); + final Map map2 = countMap(coll2); + final Set elts = newHashSet(coll2); + elts.addAll(coll1); + int m; + for (T t : elts) { + m = Math.abs(Convert.toInt(map1.get(t), 0) - Convert.toInt(map2.get(t), 0)); + for (int i = 0; i < m; i++) { + result.add(t); + } + } + return result; + } + + /** + * 计算集合的单差集，即只返回【集合1】中有，但是【集合2】中没有的元素，例如： + * + * 
+	 *     subtract([1,2,3,4],[2,3,4,5]) -》 [1]
+	 *
+ * + * @param coll1 集合1 + * @param coll2 集合2 + * @param 元素类型 + * @return 单差集 + */ + public static Collection subtract(Collection coll1, Collection coll2) { + Collection result = ObjectUtil.clone(coll1); + try { + if (null == result) { + result = CollUtil.create(coll1.getClass()); + result.addAll(coll1); + } + result.removeAll(coll2); + } catch (UnsupportedOperationException e){ + // 针对 coll1 为只读集合的补偿 + result = CollUtil.create(AbstractCollection.class); + result.addAll(coll1); + result.removeAll(coll2); + } + return result; + } + + /** + * 计算集合的单差集，即只返回【集合1】中有，但是【集合2】中没有的元素，例如： + * + * 
+	 *     subtractToList([1,2,3,4],[2,3,4,5]) -》 [1]
+	 *
+ * + * @param coll1 集合1 + * @param coll2 集合2 + * @param 元素类型 + * @return 单差集 + * @since 5.3.5 + */ + public static List subtractToList(Collection coll1, Collection coll2) { + + if (isEmpty(coll1)) { + return ListUtil.empty(); + } + if (isEmpty(coll2)) { + return ListUtil.list(true, coll1); + } + + //将被交数用链表储存，防止因为频繁扩容影响性能 + final List result = new LinkedList<>(); + Set set = new HashSet<>(coll2); + for (T t : coll1) { + if (false == set.contains(t)) { + result.add(t); + } + } + return result; + } + + /** + * 判断指定集合是否包含指定值，如果集合为空（null或者空），返回{@code false}，否则找到元素返回{@code true} + * + * @param collection 集合 + * @param value 需要查找的值 + * @return 如果集合为空（null或者空），返回{@code false}，否则找到元素返回{@code true} + * @throws ClassCastException 如果类型不一致会抛出转换异常 + * @throws NullPointerException 当指定的元素 值为 null ,或集合类不支持null 时抛出该异常 + * @see Collection#contains(Object) + * @since 4.1.10 + */ + public static boolean contains(Collection collection, Object value) { + return isNotEmpty(collection) && collection.contains(value); + } + + /** + * 判断指定集合是否包含指定值，如果集合为空（null或者空），返回{@code false}，否则找到元素返回{@code true} + * + * @param collection 集合 + * @param value 需要查找的值 + * @return 果集合为空（null或者空），返回{@code false}，否则找到元素返回{@code true} + * @since 5.7.16 + */ + public static boolean safeContains(Collection collection, Object value) { + + try { + return contains(collection, value); + } catch (ClassCastException | NullPointerException e) { + return false; + } + } + + + /** + * 自定义函数判断集合是否包含某类值 + * + * @param collection 集合 + * @param containFunc 自定义判断函数 + * @param 值类型 + * @return 是否包含自定义规则的值 + */ + public static boolean contains(Collection collection, Predicate containFunc) { + if (isEmpty(collection)) { + return false; + } + for (T t : collection) { + if (containFunc.test(t)) { + return true; + } + } + return false; + } + + /** + * 其中一个集合在另一个集合中是否至少包含一个元素，即是两个集合是否至少有一个共同的元素 + * + * @param coll1 集合1 + * @param coll2 集合2 + * @return 其中一个集合在另一个集合中是否至少包含一个元素 + * @see #intersection + * @since 2.1 + */ + public static boolean containsAny(Collection coll1, Collection coll2) { + if (isEmpty(coll1) || isEmpty(coll2)) { + return false; + } + if (coll1.size() < coll2.size()) { + for (Object object : coll1) { + if (coll2.contains(object)) { + return true; + } + } + } else { + for (Object object : coll2) { + if (coll1.contains(object)) { + return true; + } + } + } + return false; + } + + /** + * 集合1中是否包含集合2中所有的元素，即集合2是否为集合1的子集 + * + * @param coll1 集合1 + * @param coll2 集合2 + * @return 集合1中是否包含集合2中所有的元素 + * @since 4.5.12 + */ + public static boolean containsAll(Collection coll1, Collection coll2) { + if (isEmpty(coll1)) { + return isEmpty(coll2); + } + + if (isEmpty(coll2)) { + return true; + } + + if (coll1.size() < coll2.size()) { + return false; + } + + for (Object object : coll2) { + if (false == coll1.contains(object)) { + return false; + } + } + return true; + } + + /** + * 根据集合返回一个元素计数的 {@link Map}
+ * 所谓元素计数就是假如这个集合中某个元素出现了n次，那将这个元素做为key，n做为value
+ * 例如：[a,b,c,c,c] 得到：
+ * a: 1
+ * b: 1
+ * c: 3
+ * + * @param 集合元素类型 + * @param collection 集合 + * @return {@link Map} + * @see IterUtil#countMap(Iterator) + */ + public static Map countMap(Iterable collection) { + return IterUtil.countMap(null == collection ? null : collection.iterator()); + } + + /** + * 以 conjunction 为分隔符将集合转换为字符串 + * + * @param 集合元素类型 + * @param iterable {@link Iterable} + * @param conjunction 分隔符 + * @param func 集合元素转换器，将元素转换为字符串 + * @return 连接后的字符串 + * @see IterUtil#join(Iterator, CharSequence, Function) + * @since 5.6.7 + */ + public static String join(Iterable iterable, CharSequence conjunction, Function func) { + if (null == iterable) { + return null; + } + return IterUtil.join(iterable.iterator(), conjunction, func); + } + + /** + * 以 conjunction 为分隔符将集合转换为字符串
+ * 如果集合元素为数组、{@link Iterable}或{@link Iterator}，则递归组合其为字符串 + * + * @param 集合元素类型 + * @param iterable {@link Iterable} + * @param conjunction 分隔符 + * @return 连接后的字符串 + * @see IterUtil#join(Iterator, CharSequence) + */ + public static String join(Iterable iterable, CharSequence conjunction) { + if (null == iterable) { + return null; + } + return IterUtil.join(iterable.iterator(), conjunction); + } + + /** + * 以 conjunction 为分隔符将集合转换为字符串 + * + * @param 集合元素类型 + * @param iterable {@link Iterable} + * @param conjunction 分隔符 + * @param prefix 每个元素添加的前缀，null表示不添加 + * @param suffix 每个元素添加的后缀，null表示不添加 + * @return 连接后的字符串 + * @since 5.3.0 + */ + public static String join(Iterable iterable, CharSequence conjunction, String prefix, String suffix) { + if (null == iterable) { + return null; + } + return IterUtil.join(iterable.iterator(), conjunction, prefix, suffix); + } + + /** + * 以 conjunction 为分隔符将集合转换为字符串
+ * 如果集合元素为数组、{@link Iterable}或{@link Iterator}，则递归组合其为字符串 + * + * @param 集合元素类型 + * @param iterator 集合 + * @param conjunction 分隔符 + * @return 连接后的字符串 + * @deprecated 请使用IterUtil#join(Iterator, CharSequence) + */ + @Deprecated + public static String join(Iterator iterator, CharSequence conjunction) { + return IterUtil.join(iterator, conjunction); + } + + /** + * 切取部分数据
+ * 切取后的栈将减少这些元素 + * + * @param 集合元素类型 + * @param surplusAlaDatas 原数据 + * @param partSize 每部分数据的长度 + * @return 切取出的数据或null + */ + public static List popPart(Stack surplusAlaDatas, int partSize) { + if (isEmpty(surplusAlaDatas)) { + return ListUtil.empty(); + } + + final List currentAlaDatas = new ArrayList<>(); + int size = surplusAlaDatas.size(); + // 切割 + if (size > partSize) { + for (int i = 0; i < partSize; i++) { + currentAlaDatas.add(surplusAlaDatas.pop()); + } + } else { + for (int i = 0; i < size; i++) { + currentAlaDatas.add(surplusAlaDatas.pop()); + } + } + return currentAlaDatas; + } + + /** + * 切取部分数据
+ * 切取后的栈将减少这些元素 + * + * @param 集合元素类型 + * @param surplusAlaDatas 原数据 + * @param partSize 每部分数据的长度 + * @return 切取出的数据或null + */ + public static List popPart(Deque surplusAlaDatas, int partSize) { + if (isEmpty(surplusAlaDatas)) { + return ListUtil.empty(); + } + + final List currentAlaDatas = new ArrayList<>(); + int size = surplusAlaDatas.size(); + // 切割 + if (size > partSize) { + for (int i = 0; i < partSize; i++) { + currentAlaDatas.add(surplusAlaDatas.pop()); + } + } else { + for (int i = 0; i < size; i++) { + currentAlaDatas.add(surplusAlaDatas.pop()); + } + } + return currentAlaDatas; + } + + // ----------------------------------------------------------------------------------------------- new HashSet + + /** + * 新建一个HashSet + * + * @param 集合元素类型 + * @param ts 元素数组 + * @return HashSet对象 + */ + @SafeVarargs + public static HashSet newHashSet(T... ts) { + return set(false, ts); + } + + /** + * 新建一个LinkedHashSet + * + * @param 集合元素类型 + * @param ts 元素数组 + * @return HashSet对象 + * @since 4.1.10 + */ + @SafeVarargs + public static LinkedHashSet newLinkedHashSet(T... ts) { + return (LinkedHashSet) set(true, ts); + } + + /** + * 新建一个HashSet + * + * @param 集合元素类型 + * @param isSorted 是否有序，有序返回 {@link LinkedHashSet}，否则返回 {@link HashSet} + * @param ts 元素数组 + * @return HashSet对象 + */ + @SafeVarargs + public static HashSet set(boolean isSorted, T... ts) { + if (null == ts) { + return isSorted ? new LinkedHashSet<>() : new HashSet<>(); + } + int initialCapacity = Math.max((int) (ts.length / .75f) + 1, 16); + final HashSet set = isSorted ? new LinkedHashSet<>(initialCapacity) : new HashSet<>(initialCapacity); + Collections.addAll(set, ts); + return set; + } + + /** + * 新建一个HashSet + * + * @param 集合元素类型 + * @param collection 集合 + * @return HashSet对象 + */ + public static HashSet newHashSet(Collection collection) { + return newHashSet(false, collection); + } + + /** + * 新建一个HashSet + * + * @param 集合元素类型 + * @param isSorted 是否有序，有序返回 {@link LinkedHashSet}，否则返回{@link HashSet} + * @param collection 集合，用于初始化Set + * @return HashSet对象 + */ + public static HashSet newHashSet(boolean isSorted, Collection collection) { + return isSorted ? new LinkedHashSet<>(collection) : new HashSet<>(collection); + } + + /** + * 新建一个HashSet + * + * @param 集合元素类型 + * @param isSorted 是否有序，有序返回 {@link LinkedHashSet}，否则返回{@link HashSet} + * @param iter {@link Iterator} + * @return HashSet对象 + * @since 3.0.8 + */ + public static HashSet newHashSet(boolean isSorted, Iterator iter) { + if (null == iter) { + return set(isSorted, (T[]) null); + } + final HashSet set = isSorted ? new LinkedHashSet<>() : new HashSet<>(); + while (iter.hasNext()) { + set.add(iter.next()); + } + return set; + } + + /** + * 新建一个HashSet + * + * @param 集合元素类型 + * @param isSorted 是否有序，有序返回 {@link LinkedHashSet}，否则返回{@link HashSet} + * @param enumeration {@link Enumeration} + * @return HashSet对象 + * @since 3.0.8 + */ + public static HashSet newHashSet(boolean isSorted, Enumeration enumeration) { + if (null == enumeration) { + return set(isSorted, (T[]) null); + } + final HashSet set = isSorted ? new LinkedHashSet<>() : new HashSet<>(); + while (enumeration.hasMoreElements()) { + set.add(enumeration.nextElement()); + } + return set; + } + + // ----------------------------------------------------------------------------------------------- List + + /** + * 新建一个空List + * + * @param 集合元素类型 + * @param isLinked 是否新建LinkedList + * @return List对象 + * @since 4.1.2 + */ + public static List list(boolean isLinked) { + return ListUtil.list(isLinked); + } + + /** + * 新建一个List + * + * @param 集合元素类型 + * @param isLinked 是否新建LinkedList + * @param values 数组 + * @return List对象 + * @since 4.1.2 + */ + @SafeVarargs + public static List list(boolean isLinked, T... values) { + return ListUtil.list(isLinked, values); + } + + /** + * 新建一个List + * + * @param 集合元素类型 + * @param isLinked 是否新建LinkedList + * @param collection 集合 + * @return List对象 + * @since 4.1.2 + */ + public static List list(boolean isLinked, Collection collection) { + return ListUtil.list(isLinked, collection); + } + + /** + * 新建一个List
+ * 提供的参数为null时返回空{@link ArrayList} + * + * @param 集合元素类型 + * @param isLinked 是否新建LinkedList + * @param iterable {@link Iterable} + * @return List对象 + * @since 4.1.2 + */ + public static List list(boolean isLinked, Iterable iterable) { + return ListUtil.list(isLinked, iterable); + } + + /** + * 新建一个ArrayList
+ * 提供的参数为null时返回空{@link ArrayList} + * + * @param 集合元素类型 + * @param isLinked 是否新建LinkedList + * @param iter {@link Iterator} + * @return ArrayList对象 + * @since 4.1.2 + */ + public static List list(boolean isLinked, Iterator iter) { + return ListUtil.list(isLinked, iter); + } + + /** + * 新建一个List
+ * 提供的参数为null时返回空{@link ArrayList} + * + * @param 集合元素类型 + * @param isLinked 是否新建LinkedList + * @param enumeration {@link Enumeration} + * @return ArrayList对象 + * @since 3.0.8 + */ + public static List list(boolean isLinked, Enumeration enumeration) { + return ListUtil.list(isLinked, enumeration); + } + + /** + * 新建一个ArrayList + * + * @param 集合元素类型 + * @param values 数组 + * @return ArrayList对象 + * @see #toList(Object[]) + */ + @SafeVarargs + public static ArrayList newArrayList(T... values) { + return ListUtil.toList(values); + } + + /** + * 数组转为ArrayList + * + * @param 集合元素类型 + * @param values 数组 + * @return ArrayList对象 + * @since 4.0.11 + */ + @SafeVarargs + public static ArrayList toList(T... values) { + return ListUtil.toList(values); + } + + /** + * 新建一个ArrayList + * + * @param 集合元素类型 + * @param collection 集合 + * @return ArrayList对象 + */ + public static ArrayList newArrayList(Collection collection) { + return ListUtil.toList(collection); + } + + /** + * 新建一个ArrayList
+ * 提供的参数为null时返回空{@link ArrayList} + * + * @param 集合元素类型 + * @param iterable {@link Iterable} + * @return ArrayList对象 + * @since 3.1.0 + */ + public static ArrayList newArrayList(Iterable iterable) { + return ListUtil.toList(iterable); + } + + /** + * 新建一个ArrayList
+ * 提供的参数为null时返回空{@link ArrayList} + * + * @param 集合元素类型 + * @param iterator {@link Iterator} + * @return ArrayList对象 + * @since 3.0.8 + */ + public static ArrayList newArrayList(Iterator iterator) { + return ListUtil.toList(iterator); + } + + /** + * 新建一个ArrayList
+ * 提供的参数为null时返回空{@link ArrayList} + * + * @param 集合元素类型 + * @param enumeration {@link Enumeration} + * @return ArrayList对象 + * @since 3.0.8 + */ + public static ArrayList newArrayList(Enumeration enumeration) { + return ListUtil.toList(enumeration); + } + + // ----------------------------------------------------------------------new LinkedList + + /** + * 新建LinkedList + * + * @param values 数组 + * @param 类型 + * @return LinkedList + * @since 4.1.2 + */ + @SafeVarargs + public static LinkedList newLinkedList(T... values) { + return ListUtil.toLinkedList(values); + } + + /** + * 新建一个CopyOnWriteArrayList + * + * @param 集合元素类型 + * @param collection 集合 + * @return {@link CopyOnWriteArrayList} + */ + public static CopyOnWriteArrayList newCopyOnWriteArrayList(Collection collection) { + return ListUtil.toCopyOnWriteArrayList(collection); + } + + /** + * 新建{@link BlockingQueue}
+ * 在队列为空时，获取元素的线程会等待队列变为非空。当队列满时，存储元素的线程会等待队列可用。 + * + * @param 集合类型 + * @param capacity 容量 + * @param isLinked 是否为链表形式 + * @return {@link BlockingQueue} + * @since 3.3.0 + */ + public static BlockingQueue newBlockingQueue(int capacity, boolean isLinked) { + final BlockingQueue queue; + if (isLinked) { + queue = new LinkedBlockingDeque<>(capacity); + } else { + queue = new ArrayBlockingQueue<>(capacity); + } + return queue; + } + + /** + * 创建新的集合对象 + * + * @param 集合类型 + * @param collectionType 集合类型 + * @return 集合类型对应的实例 + * @since 3.0.8 + */ + public static Collection create(Class collectionType) { + return create(collectionType, null); + } + + /** + * 创建新的集合对象，返回具体的泛型集合 + * + * @param 集合元素类型 + * @param collectionType 集合类型，rawtype 如 ArrayList.class, EnumSet.class ... + * @param elementType 集合元素类型 + * @return 集合类型对应的实例 + * @since v5 + */ + @SuppressWarnings({"unchecked", "rawtypes"}) + public static Collection create(Class collectionType, Class elementType) { + final Collection list; + if (collectionType.isAssignableFrom(AbstractCollection.class)) { + // 抽象集合默认使用ArrayList + list = new ArrayList<>(); + } + + // Set + else if (collectionType.isAssignableFrom(HashSet.class)) { + list = new HashSet<>(); + } else if (collectionType.isAssignableFrom(LinkedHashSet.class)) { + list = new LinkedHashSet<>(); + } else if (collectionType.isAssignableFrom(TreeSet.class)) { + list = new TreeSet<>((o1, o2) -> { + // 优先按照对象本身比较，如果没有实现比较接口，默认按照toString内容比较 + if (o1 instanceof Comparable) { + return ((Comparable) o1).compareTo(o2); + } + return CompareUtil.compare(o1.toString(), o2.toString()); + }); + } else if (collectionType.isAssignableFrom(EnumSet.class)) { + list = (Collection) EnumSet.noneOf(Assert.notNull((Class) elementType)); + } + + // List + else if (collectionType.isAssignableFrom(ArrayList.class)) { + list = new ArrayList<>(); + } else if (collectionType.isAssignableFrom(LinkedList.class)) { + list = new LinkedList<>(); + } + + // Others，直接实例化 + else { + try { + list = (Collection) ReflectUtil.newInstance(collectionType); + } catch (final Exception e) { + // 无法创建当前类型的对象，尝试创建父类型对象 + final Class superclass = collectionType.getSuperclass(); + if (null != superclass && collectionType != superclass) { + return create(superclass); + } + throw new UtilException(e); + } + } + return list; + } + + /** + * 去重集合 + * + * @param 集合元素类型 + * @param collection 集合 + * @return {@link ArrayList} + */ + public static ArrayList distinct(Collection collection) { + if (isEmpty(collection)) { + return new ArrayList<>(); + } else if (collection instanceof Set) { + return new ArrayList<>(collection); + } else { + return new ArrayList<>(new LinkedHashSet<>(collection)); + } + } + + /** + * 根据函数生成的KEY去重集合，如根据Bean的某个或者某些字段完成去重。
+ * 去重可选是保留最先加入的值还是后加入的值 + * + * @param 集合元素类型 + * @param 唯一键类型 + * @param collection 集合 + * @param uniqueGenerator 唯一键生成器 + * @param override 是否覆盖模式，如果为{@code true}，加入的新值会覆盖相同key的旧值，否则会忽略新加值 + * @return {@link ArrayList} + * @since 5.8.0 + */ + public static List distinct(Collection collection, Function uniqueGenerator, boolean override) { + if (isEmpty(collection)) { + return new ArrayList<>(); + } + + final UniqueKeySet set = new UniqueKeySet<>(true, uniqueGenerator); + if (override) { + set.addAll(collection); + } else { + set.addAllIfAbsent(collection); + } + return new ArrayList<>(set); + } + + /** + * 截取列表的部分 + * + * @param 集合元素类型 + * @param list 被截取的数组 + * @param start 开始位置（包含） + * @param end 结束位置（不包含） + * @return 截取后的数组，当开始位置超过最大时，返回空的List + * @see ListUtil#sub(List, int, int) + */ + public static List sub(List list, int start, int end) { + return ListUtil.sub(list, start, end); + } + + /** + * 截取列表的部分 + * + * @param 集合元素类型 + * @param list 被截取的数组 + * @param start 开始位置（包含） + * @param end 结束位置（不包含） + * @param step 步进 + * @return 截取后的数组，当开始位置超过最大时，返回空的List + * @see ListUtil#sub(List, int, int, int) + * @since 4.0.6 + */ + public static List sub(List list, int start, int end, int step) { + return ListUtil.sub(list, start, end, step); + } + + /** + * 截取集合的部分 + * + * @param 集合元素类型 + * @param collection 被截取的数组 + * @param start 开始位置（包含） + * @param end 结束位置（不包含） + * @return 截取后的数组，当开始位置超过最大时，返回null + */ + public static List sub(Collection collection, int start, int end) { + return sub(collection, start, end, 1); + } + + /** + * 截取集合的部分 + * + * @param 集合元素类型 + * @param collection 被截取的数组 + * @param start 开始位置（包含） + * @param end 结束位置（不包含） + * @param step 步进 + * @return 截取后的数组，当开始位置超过最大时，返回空集合 + * @since 4.0.6 + */ + public static List sub(Collection collection, int start, int end, int step) { + if (isEmpty(collection)) { + return ListUtil.empty(); + } + + final List list = collection instanceof List ? (List) collection : ListUtil.toList(collection); + return sub(list, start, end, step); + } + + /** + * 对集合按照指定长度分段，每一个段为单独的集合，返回这个集合的列表 + *

+ * 需要特别注意的是，此方法调用{@link List#subList(int, int)}切分List， + * 此方法返回的是原List的视图，也就是说原List有变更，切分后的结果也会变更。 + *

+ * + * @param 集合元素类型 + * @param list 列表 + * @param size 每个段的长度 + * @return 分段列表 + * @since 5.4.5 + * @deprecated 请使用 {@link ListUtil#partition(List, int)} + */ + @Deprecated + public static List> splitList(List list, int size) { + return ListUtil.partition(list, size); + } + + /** + * 对集合按照指定长度分段，每一个段为单独的集合，返回这个集合的列表 + * + * @param 集合元素类型 + * @param collection 集合 + * @param size 每个段的长度 + * @return 分段列表 + */ + public static List> split(Collection collection, int size) { + final List> result = new ArrayList<>(); + if (CollUtil.isEmpty(collection)) { + return result; + } + + ArrayList subList = new ArrayList<>(size); + for (T t : collection) { + if (subList.size() >= size) { + result.add(subList); + subList = new ArrayList<>(size); + } + subList.add(t); + } + result.add(subList); + return result; + } + + /** + * 编辑，此方法产生一个新集合
+ * 编辑过程通过传入的Editor实现来返回需要的元素内容，这个Editor实现可以实现以下功能： + * + * 
+	 * 1、过滤出需要的对象，如果返回null表示这个元素对象抛弃
+	 * 2、修改元素对象，返回集合中为修改后的对象
+	 *
+ * + * @param 集合元素类型 + * @param collection 集合 + * @param editor 编辑器接口，{@code null}返回原集合 + * @return 过滤后的集合 + */ + public static Collection edit(Collection collection, Editor editor) { + if (null == collection || null == editor) { + return collection; + } + + final Collection collection2 = create(collection.getClass()); + if (isEmpty(collection)) { + return collection2; + } + + T modified; + for (T t : collection) { + modified = editor.edit(t); + if (null != modified) { + collection2.add(modified); + } + } + return collection2; + } + + /** + * 过滤
+ * 过滤过程通过传入的Filter实现来过滤返回需要的元素内容，这个Filter实现可以实现以下功能： + * + * 
+	 * 1、过滤出需要的对象，{@link Filter#accept(Object)}方法返回true的对象将被加入结果集合中
+	 *
+ * + * @param 集合元素类型 + * @param collection 集合 + * @param filter 过滤器，{@code null}返回原集合 + * @return 过滤后的数组 + * @since 3.1.0 + */ + public static Collection filterNew(Collection collection, Filter filter) { + if (null == collection || null == filter) { + return collection; + } + return edit(collection, t -> filter.accept(t) ? t : null); + } + + /** + * 去掉集合中的多个元素，此方法直接修改原集合 + * + * @param 集合类型 + * @param 集合元素类型 + * @param collection 集合 + * @param elesRemoved 被去掉的元素数组 + * @return 原集合 + * @since 4.1.0 + */ + @SuppressWarnings("unchecked") + public static , E> T removeAny(T collection, E... elesRemoved) { + collection.removeAll(newHashSet(elesRemoved)); + return collection; + } + + /** + * 去除指定元素，此方法直接修改原集合 + * + * @param 集合类型 + * @param 集合元素类型 + * @param collection 集合 + * @param filter 过滤器 + * @return 处理后的集合 + * @since 4.6.5 + */ + public static , E> T filter(T collection, final Filter filter) { + return IterUtil.filter(collection, filter); + } + + /** + * 去除{@code null} 元素，此方法直接修改原集合 + * + * @param 集合类型 + * @param 集合元素类型 + * @param collection 集合 + * @return 处理后的集合 + * @since 3.2.2 + */ + public static , E> T removeNull(T collection) { + return filter(collection, Objects::nonNull); + } + + /** + * 去除{@code null}或者"" 元素，此方法直接修改原集合 + * + * @param 集合类型 + * @param 集合元素类型 + * @param collection 集合 + * @return 处理后的集合 + * @since 3.2.2 + */ + public static , E extends CharSequence> T removeEmpty(T collection) { + return filter(collection, StrUtil::isNotEmpty); + } + + /** + * 去除{@code null}或者""或者空白字符串 元素，此方法直接修改原集合 + * + * @param 集合类型 + * @param 集合元素类型 + * @param collection 集合 + * @return 处理后的集合 + * @since 3.2.2 + */ + public static , E extends CharSequence> T removeBlank(T collection) { + return filter(collection, StrUtil::isNotBlank); + } + + /** + * 移除集合中的多个元素，并将结果存放到指定的集合 + * 此方法直接修改原集合 + * + * @param 集合类型 + * @param 集合元素类型 + * @param resultCollection 存放移除结果的集合 + * @param targetCollection 被操作移除元素的集合 + * @param predicate 用于是否移除判断的过滤器 + * @return 移除结果的集合 + * @since 5.7.17 + */ + public static , E> T removeWithAddIf(T targetCollection, T resultCollection, Predicate predicate) { + Objects.requireNonNull(predicate); + final Iterator each = targetCollection.iterator(); + while (each.hasNext()) { + E next = each.next(); + if (predicate.test(next)) { + resultCollection.add(next); + each.remove(); + } + } + return resultCollection; + } + + /** + * 移除集合中的多个元素，并将结果存放到生成的新集合中后返回
+ * 此方法直接修改原集合 + * + * @param 集合类型 + * @param 集合元素类型 + * @param targetCollection 被操作移除元素的集合 + * @param predicate 用于是否移除判断的过滤器 + * @return 移除结果的集合 + * @since 5.7.17 + */ + public static , E> List removeWithAddIf(T targetCollection, Predicate predicate) { + final List removed = new ArrayList<>(); + removeWithAddIf(targetCollection, removed, predicate); + return removed; + } + + /** + * 通过Editor抽取集合元素中的某些值返回为新列表
+ * 例如提供的是一个Bean列表，通过Editor接口实现获取某个字段值，返回这个字段值组成的新列表 + * + * @param collection 原集合 + * @param editor 编辑器 + * @return 抽取后的新列表 + */ + public static List extract(Iterable collection, Editor editor) { + return extract(collection, editor, false); + } + + /** + * 通过Editor抽取集合元素中的某些值返回为新列表
+ * 例如提供的是一个Bean列表，通过Editor接口实现获取某个字段值，返回这个字段值组成的新列表 + * + * @param collection 原集合 + * @param editor 编辑器 + * @param ignoreNull 是否忽略空值 + * @return 抽取后的新列表 + * @see #map(Iterable, Function, boolean) + * @since 4.5.7 + */ + public static List extract(Iterable collection, Editor editor, boolean ignoreNull) { + return map(collection, editor::edit, ignoreNull); + } + + /** + * 通过func自定义一个规则，此规则将原集合中的元素转换成新的元素，生成新的列表返回
+ * 例如提供的是一个Bean列表，通过Function接口实现获取某个字段值，返回这个字段值组成的新列表 + * + * @param 集合元素类型 + * @param 返回集合元素类型 + * @param collection 原集合 + * @param func 编辑函数 + * @param ignoreNull 是否忽略空值，这里的空值包括函数处理前和处理后的null值 + * @return 抽取后的新列表 + * @since 5.3.5 + */ + public static List map(Iterable collection, Function func, boolean ignoreNull) { + final List fieldValueList = new ArrayList<>(); + if (null == collection) { + return fieldValueList; + } + + R value; + for (T t : collection) { + if (null == t && ignoreNull) { + continue; + } + value = func.apply(t); + if (null == value && ignoreNull) { + continue; + } + fieldValueList.add(value); + } + return fieldValueList; + } + + /** + * 获取给定Bean列表中指定字段名对应字段值的列表
+ * 列表元素支持Bean与Map + * + * @param collection Bean集合或Map集合 + * @param fieldName 字段名或map的键 + * @return 字段值列表 + * @since 3.1.0 + */ + public static List getFieldValues(Iterable collection, final String fieldName) { + return getFieldValues(collection, fieldName, false); + } + + /** + * 获取给定Bean列表中指定字段名对应字段值的列表
+ * 列表元素支持Bean与Map + * + * @param collection Bean集合或Map集合 + * @param fieldName 字段名或map的键 + * @param ignoreNull 是否忽略值为{@code null}的字段 + * @return 字段值列表 + * @since 4.5.7 + */ + public static List getFieldValues(Iterable collection, final String fieldName, boolean ignoreNull) { + return map(collection, bean -> { + if (bean instanceof Map) { + return ((Map) bean).get(fieldName); + } else { + return ReflectUtil.getFieldValue(bean, fieldName); + } + }, ignoreNull); + } + + /** + * 获取给定Bean列表中指定字段名对应字段值的列表
+ * 列表元素支持Bean与Map + * + * @param 元素类型 + * @param collection Bean集合或Map集合 + * @param fieldName 字段名或map的键 + * @param elementType 元素类型类 + * @return 字段值列表 + * @since 4.5.6 + */ + public static List getFieldValues(Iterable collection, final String fieldName, final Class elementType) { + List fieldValues = getFieldValues(collection, fieldName); + return Convert.toList(elementType, fieldValues); + } + + /** + * 字段值与列表值对应的Map，常用于元素对象中有唯一ID时需要按照这个ID查找对象的情况
+ * 例如：车牌号 =》车 + * + * @param 字段名对应值得类型，不确定请使用Object + * @param 对象类型 + * @param iterable 对象列表 + * @param fieldName 字段名（会通过反射获取其值） + * @return 某个字段值与对象对应Map + * @since 5.0.6 + */ + public static Map fieldValueMap(Iterable iterable, String fieldName) { + return IterUtil.fieldValueMap(IterUtil.getIter(iterable), fieldName); + } + + /** + * 两个字段值组成新的Map + * + * @param 字段名对应值得类型，不确定请使用Object + * @param 值类型，不确定使用Object + * @param iterable 对象列表 + * @param fieldNameForKey 做为键的字段名（会通过反射获取其值） + * @param fieldNameForValue 做为值的字段名（会通过反射获取其值） + * @return 某个字段值与对象对应Map + * @since 5.0.6 + */ + public static Map fieldValueAsMap(Iterable iterable, String fieldNameForKey, String fieldNameForValue) { + return IterUtil.fieldValueAsMap(IterUtil.getIter(iterable), fieldNameForKey, fieldNameForValue); + } + + /** + * 查找第一个匹配元素对象 + * + * @param 集合元素类型 + * @param collection 集合 + * @param filter 过滤器，满足过滤条件的第一个元素将被返回 + * @return 满足过滤条件的第一个元素 + * @since 3.1.0 + */ + public static T findOne(Iterable collection, Filter filter) { + if (null != collection) { + for (T t : collection) { + if (filter.accept(t)) { + return t; + } + } + } + return null; + } + + /** + * 查找第一个匹配元素对象
+ * 如果集合元素是Map，则比对键和值是否相同，相同则返回
+ * 如果为普通Bean，则通过反射比对元素字段名对应的字段值是否相同，相同则返回
+ * 如果给定字段值参数是{@code null} 且元素对象中的字段值也为{@code null}则认为相同 + * + * @param 集合元素类型 + * @param collection 集合，集合元素可以是Bean或者Map + * @param fieldName 集合元素对象的字段名或map的键 + * @param fieldValue 集合元素对象的字段值或map的值 + * @return 满足条件的第一个元素 + * @since 3.1.0 + */ + public static T findOneByField(Iterable collection, final String fieldName, final Object fieldValue) { + return findOne(collection, t -> { + if (t instanceof Map) { + final Map map = (Map) t; + final Object value = map.get(fieldName); + return ObjectUtil.equal(value, fieldValue); + } + + // 普通Bean + final Object value = ReflectUtil.getFieldValue(t, fieldName); + return ObjectUtil.equal(value, fieldValue); + }); + } + + /** + * 集合中匹配规则的数量 + * + * @param 集合元素类型 + * @param iterable {@link Iterable} + * @param matcher 匹配器，为空则全部匹配 + * @return 匹配数量 + */ + public static int count(Iterable iterable, Matcher matcher) { + int count = 0; + if (null != iterable) { + for (T t : iterable) { + if (null == matcher || matcher.match(t)) { + count++; + } + } + } + return count; + } + + /** + * 获取匹配规则定义中匹配到元素的第一个位置
+ * 此方法对于某些无序集合的位置信息，以转换为数组后的位置为准。 + * + * @param 元素类型 + * @param collection 集合 + * @param matcher 匹配器，为空则全部匹配 + * @return 第一个位置 + * @since 5.6.6 + */ + public static int indexOf(Collection collection, Matcher matcher) { + if (isNotEmpty(collection)) { + int index = 0; + for (T t : collection) { + if (null == matcher || matcher.match(t)) { + return index; + } + index++; + } + } + return -1; + } + + /** + * 获取匹配规则定义中匹配到元素的最后位置
+ * 此方法对于某些无序集合的位置信息，以转换为数组后的位置为准。 + * + * @param 元素类型 + * @param collection 集合 + * @param matcher 匹配器，为空则全部匹配 + * @return 最后一个位置 + * @since 5.6.6 + */ + public static int lastIndexOf(Collection collection, Matcher matcher) { + if (collection instanceof List) { + // List的查找最后一个有优化算法 + return ListUtil.lastIndexOf((List) collection, matcher); + } + int matchIndex = -1; + if (isNotEmpty(collection)) { + int index = 0; + for (T t : collection) { + if (null == matcher || matcher.match(t)) { + matchIndex = index; + } + index++; + } + } + return matchIndex; + } + + /** + * 获取匹配规则定义中匹配到元素的所有位置
+ * 此方法对于某些无序集合的位置信息，以转换为数组后的位置为准。 + * + * @param 元素类型 + * @param collection 集合 + * @param matcher 匹配器，为空则全部匹配 + * @return 位置数组 + * @since 5.2.5 + */ + public static int[] indexOfAll(Collection collection, Matcher matcher) { + final List indexList = new ArrayList<>(); + if (null != collection) { + int index = 0; + for (T t : collection) { + if (null == matcher || matcher.match(t)) { + indexList.add(index); + } + index++; + } + } + return Convert.convert(int[].class, indexList); + } + + // ---------------------------------------------------------------------- isEmpty + + /** + * 集合是否为空 + * + * @param collection 集合 + * @return 是否为空 + */ + public static boolean isEmpty(Collection collection) { + return collection == null || collection.isEmpty(); + } + + /** + * 如果给定集合为空，返回默认集合 + * + * @param 集合类型 + * @param 集合元素类型 + * @param collection 集合 + * @param defaultCollection 默认数组 + * @return 非空（empty）的原集合或默认集合 + * @since 4.6.9 + */ + public static , E> T defaultIfEmpty(T collection, T defaultCollection) { + return isEmpty(collection) ? defaultCollection : collection; + } + + /** + * 如果给定集合为空，返回默认集合 + * + * @param 集合类型 + * @param 集合元素类型 + * @param collection 集合 + * @param supplier 默认值懒加载函数 + * @return 非空（empty）的原集合或默认集合 + * @since 5.7.15 + */ + public static , E> T defaultIfEmpty(T collection, Supplier supplier) { + return isEmpty(collection) ? supplier.get() : collection; + } + + /** + * Iterable是否为空 + * + * @param iterable Iterable对象 + * @return 是否为空 + * @see IterUtil#isEmpty(Iterable) + */ + public static boolean isEmpty(Iterable iterable) { + return IterUtil.isEmpty(iterable); + } + + /** + * Iterator是否为空 + * + * @param Iterator Iterator对象 + * @return 是否为空 + * @see IterUtil#isEmpty(Iterator) + */ + public static boolean isEmpty(Iterator Iterator) { + return IterUtil.isEmpty(Iterator); + } + + /** + * Enumeration是否为空 + * + * @param enumeration {@link Enumeration} + * @return 是否为空 + */ + public static boolean isEmpty(Enumeration enumeration) { + return null == enumeration || false == enumeration.hasMoreElements(); + } + + /** + * Map是否为空 + * + * @param map 集合 + * @return 是否为空 + * @see MapUtil#isEmpty(Map) + * @since 5.7.4 + */ + public static boolean isEmpty(Map map) { + return MapUtil.isEmpty(map); + } + + // ---------------------------------------------------------------------- isNotEmpty + + /** + * 集合是否为非空 + * + * @param collection 集合 + * @return 是否为非空 + */ + public static boolean isNotEmpty(Collection collection) { + return false == isEmpty(collection); + } + + /** + * Iterable是否为空 + * + * @param iterable Iterable对象 + * @return 是否为空 + * @see IterUtil#isNotEmpty(Iterable) + */ + public static boolean isNotEmpty(Iterable iterable) { + return IterUtil.isNotEmpty(iterable); + } + + /** + * Iterator是否为空 + * + * @param Iterator Iterator对象 + * @return 是否为空 + * @see IterUtil#isNotEmpty(Iterator) + */ + public static boolean isNotEmpty(Iterator Iterator) { + return IterUtil.isNotEmpty(Iterator); + } + + /** + * Enumeration是否为空 + * + * @param enumeration {@link Enumeration} + * @return 是否为空 + */ + public static boolean isNotEmpty(Enumeration enumeration) { + return null != enumeration && enumeration.hasMoreElements(); + } + + /** + * 是否包含{@code null}元素 + * + * @param iterable 被检查的Iterable对象，如果为{@code null} 返回true + * @return 是否包含{@code null}元素 + * @see IterUtil#hasNull(Iterable) + * @since 3.0.7 + */ + public static boolean hasNull(Iterable iterable) { + return IterUtil.hasNull(iterable); + } + + /** + * Map是否为非空 + * + * @param map 集合 + * @return 是否为非空 + * @see MapUtil#isNotEmpty(Map) + * @since 5.7.4 + */ + public static boolean isNotEmpty(Map map) { + return MapUtil.isNotEmpty(map); + } + + // ---------------------------------------------------------------------- zip + + /** + * 映射键值（参考Python的zip()函数）
+ * 例如：
+ * keys = a,b,c,d
+ * values = 1,2,3,4
+ * delimiter = , 则得到的Map是 {a=1, b=2, c=3, d=4}
+ * 如果两个数组长度不同，则只对应最短部分 + * + * @param keys 键列表 + * @param values 值列表 + * @param delimiter 分隔符 + * @param isOrder 是否有序 + * @return Map + * @since 3.0.4 + */ + public static Map zip(String keys, String values, String delimiter, boolean isOrder) { + return ArrayUtil.zip(StrUtil.splitToArray(keys, delimiter), StrUtil.splitToArray(values, delimiter), isOrder); + } + + /** + * 映射键值（参考Python的zip()函数），返回Map无序
+ * 例如：
+ * keys = a,b,c,d
+ * values = 1,2,3,4
+ * delimiter = , 则得到的Map是 {a=1, b=2, c=3, d=4}
+ * 如果两个数组长度不同，则只对应最短部分 + * + * @param keys 键列表 + * @param values 值列表 + * @param delimiter 分隔符 + * @return Map + */ + public static Map zip(String keys, String values, String delimiter) { + return zip(keys, values, delimiter, false); + } + + /** + * 映射键值（参考Python的zip()函数）
+ * 例如：
+ * keys = [a,b,c,d]
+ * values = [1,2,3,4]
+ * 则得到的Map是 {a=1, b=2, c=3, d=4}
+ * 如果两个数组长度不同，则只对应最短部分 + * + * @param 键类型 + * @param 值类型 + * @param keys 键列表 + * @param values 值列表 + * @return Map + */ + public static Map zip(Collection keys, Collection values) { + if (isEmpty(keys) || isEmpty(values)) { + return MapUtil.empty(); + } + + int entryCount = Math.min(keys.size(), values.size()); + final Map map = MapUtil.newHashMap(entryCount); + + final Iterator keyIterator = keys.iterator(); + final Iterator valueIterator = values.iterator(); + while (entryCount > 0) { + map.put(keyIterator.next(), valueIterator.next()); + entryCount--; + } + + return map; + } + + /** + * 将Entry集合转换为HashMap + * + * @param 键类型 + * @param 值类型 + * @param entryIter entry集合 + * @return Map + * @see IterUtil#toMap(Iterable) + */ + public static HashMap toMap(Iterable> entryIter) { + return IterUtil.toMap(entryIter); + } + + /** + * 将数组转换为Map（HashMap），支持数组元素类型为： + * + * 
+	 * Map.Entry
+	 * 长度大于1的数组（取前两个值），如果不满足跳过此元素
+	 * Iterable 长度也必须大于1（取前两个值），如果不满足跳过此元素
+	 * Iterator 长度也必须大于1（取前两个值），如果不满足跳过此元素
+	 *
+ * + * 
+	 * Map<Object, Object> colorMap = CollectionUtil.toMap(new String[][] {{
+	 *     {"RED", "#FF0000"},
+	 *     {"GREEN", "#00FF00"},
+	 *     {"BLUE", "#0000FF"}});
+	 *
+ *

+ * 参考：commons-lang + * + * @param array 数组。元素类型为Map.Entry、数组、Iterable、Iterator + * @return {@link HashMap} + * @see MapUtil#of(Object[]) + * @since 3.0.8 + */ + public static HashMap toMap(Object[] array) { + return MapUtil.of(array); + } + + /** + * 将集合转换为排序后的TreeSet + * + * @param 集合元素类型 + * @param collection 集合 + * @param comparator 比较器 + * @return treeSet + */ + public static TreeSet toTreeSet(Collection collection, Comparator comparator) { + final TreeSet treeSet = new TreeSet<>(comparator); + treeSet.addAll(collection); + return treeSet; + } + + /** + * Iterator转换为Enumeration + *

+ * Adapt the specified {@link Iterator} to the {@link Enumeration} interface. + * + * @param 集合元素类型 + * @param iter {@link Iterator} + * @return {@link Enumeration} + */ + public static Enumeration asEnumeration(Iterator iter) { + return new IteratorEnumeration<>(iter); + } + + /** + * Enumeration转换为Iterator + *

+ * Adapt the specified {@code Enumeration} to the {@code Iterator} interface + * + * @param 集合元素类型 + * @param e {@link Enumeration} + * @return {@link Iterator} + * @see IterUtil#asIterator(Enumeration) + */ + public static Iterator asIterator(Enumeration e) { + return IterUtil.asIterator(e); + } + + /** + * {@link Iterator} 转为 {@link Iterable} + * + * @param 元素类型 + * @param iter {@link Iterator} + * @return {@link Iterable} + * @see IterUtil#asIterable(Iterator) + */ + public static Iterable asIterable(final Iterator iter) { + return IterUtil.asIterable(iter); + } + + /** + * {@link Iterable}转为{@link Collection}
+ * 首先尝试强转，强转失败则构建一个新的{@link ArrayList} + * + * @param 集合元素类型 + * @param iterable {@link Iterable} + * @return {@link Collection} 或者 {@link ArrayList} + * @since 3.0.9 + */ + public static Collection toCollection(Iterable iterable) { + return (iterable instanceof Collection) ? (Collection) iterable : newArrayList(iterable.iterator()); + } + + /** + * 行转列，合并相同的键，值合并为列表
+ * 将Map列表中相同key的值组成列表做为Map的value
+ * 是{@link #toMapList(Map)}的逆方法
+ * 比如传入数据： + * + * 

+	 * [
+	 *  {a: 1, b: 1, c: 1}
+	 *  {a: 2, b: 2}
+	 *  {a: 3, b: 3}
+	 *  {a: 4}
+	 * ]
+	 *
+ *

+ * 结果是： + * + * 

+	 * {
+	 *   a: [1,2,3,4]
+	 *   b: [1,2,3,]
+	 *   c: [1]
+	 * }
+	 *
+ * + * @param 键类型 + * @param 值类型 + * @param mapList Map列表 + * @return Map + * @see MapUtil#toListMap(Iterable) + */ + public static Map> toListMap(Iterable> mapList) { + return MapUtil.toListMap(mapList); + } + + /** + * 列转行。将Map中值列表分别按照其位置与key组成新的map。
+ * 是{@link #toListMap(Iterable)}的逆方法
+ * 比如传入数据： + * + * 
+	 * {
+	 *   a: [1,2,3,4]
+	 *   b: [1,2,3,]
+	 *   c: [1]
+	 * }
+	 *
+ *

+ * 结果是： + * + * 

+	 * [
+	 *  {a: 1, b: 1, c: 1}
+	 *  {a: 2, b: 2}
+	 *  {a: 3, b: 3}
+	 *  {a: 4}
+	 * ]
+	 *
+ * + * @param 键类型 + * @param 值类型 + * @param listMap 列表Map + * @return Map列表 + * @see MapUtil#toMapList(Map) + */ + public static List> toMapList(Map> listMap) { + return MapUtil.toMapList(listMap); + } + + /** + * 集合转换为Map，转换规则为：
+ * 按照keyFunc函数规则根据元素对象生成Key，元素作为值 + * + * @param Map键类型 + * @param Map值类型 + * @param values 数据列表 + * @param map Map对象，转换后的键值对加入此Map，通过传入此对象自定义Map类型 + * @param keyFunc 生成key的函数 + * @return 生成的map + * @since 5.2.6 + */ + public static Map toMap(Iterable values, Map map, Func1 keyFunc) { + return IterUtil.toMap(null == values ? null : values.iterator(), map, keyFunc); + } + + /** + * 集合转换为Map，转换规则为：
+ * 按照keyFunc函数规则根据元素对象生成Key，按照valueFunc函数规则根据元素对象生成value组成新的Map + * + * @param Map键类型 + * @param Map值类型 + * @param 元素类型 + * @param values 数据列表 + * @param map Map对象，转换后的键值对加入此Map，通过传入此对象自定义Map类型 + * @param keyFunc 生成key的函数 + * @param valueFunc 生成值的策略函数 + * @return 生成的map + * @since 5.2.6 + */ + public static Map toMap(Iterable values, Map map, Func1 keyFunc, Func1 valueFunc) { + return IterUtil.toMap(null == values ? null : values.iterator(), map, keyFunc, valueFunc); + } + + /** + * 一个对象不为空且不存在于该集合中时，加入到该集合中
+ * 
+	 *     null, null -> false
+	 *     [], null -> false
+	 *     null, "123" -> false
+	 *     ["123"], "123" -> false
+	 *     [], "123" -> true
+	 *     ["456"], "123" -> true
+	 *     [Animal{"name": "jack"}], Dog{"name": "jack"} -> true
+	 *
+ * + * @param collection 被加入的集合 + * @param object 要添加到集合的对象 + * @param 集合元素类型 + * @param 要添加的元素类型【为集合元素类型的类型或子类型】 + * @return 是否添加成功 + * @author Cloud-Style + */ + public static boolean addIfAbsent(Collection collection, S object) { + if (object == null || collection == null || collection.contains(object)) { + return false; + } + + return collection.add(object); + } + + /** + * 将指定对象全部加入到集合中
+ * 提供的对象如果为集合类型，会自动转换为目标元素类型
+ * + * @param 元素类型 + * @param collection 被加入的集合 + * @param value 对象，可能为Iterator、Iterable、Enumeration、Array + * @return 被加入集合 + */ + public static Collection addAll(Collection collection, Object value) { + return addAll(collection, value, TypeUtil.getTypeArgument(collection.getClass())); + } + + /** + * 将指定对象全部加入到集合中
+ * 提供的对象如果为集合类型，会自动转换为目标元素类型
+ * 如果为String，支持类似于[1,2,3,4] 或者 1,2,3,4 这种格式 + * + * @param 元素类型 + * @param collection 被加入的集合 + * @param value 对象，可能为Iterator、Iterable、Enumeration、Array，或者与集合元素类型一致 + * @param elementType 元素类型，为空时，使用Object类型来接纳所有类型 + * @return 被加入集合 + */ + @SuppressWarnings({"unchecked", "rawtypes"}) + public static Collection addAll(Collection collection, Object value, Type elementType) { + if (null == collection || null == value) { + return collection; + } + if (TypeUtil.isUnknown(elementType)) { + // 元素类型为空时，使用Object类型来接纳所有类型 + elementType = Object.class; + } + + Iterator iter; + if (value instanceof Iterator) { + iter = (Iterator) value; + } else if (value instanceof Iterable) { + iter = ((Iterable) value).iterator(); + } else if (value instanceof Enumeration) { + iter = new EnumerationIter<>((Enumeration) value); + } else if (ArrayUtil.isArray(value)) { + iter = new ArrayIter<>(value); + } else if (value instanceof CharSequence) { + // String按照逗号分隔的列表对待 + final String ArrayStr = StrUtil.unWrap((CharSequence) value, '[', ']'); + iter = StrUtil.splitTrim(ArrayStr, CharUtil.COMMA).iterator(); + } else { + // 其它类型按照单一元素处理 + iter = CollUtil.newArrayList(value).iterator(); + } + + final ConverterRegistry convert = ConverterRegistry.getInstance(); + while (iter.hasNext()) { + collection.add(convert.convert(elementType, iter.next())); + } + + return collection; + } + + /** + * 加入全部 + * + * @param 集合元素类型 + * @param collection 被加入的集合 {@link Collection} + * @param iterator 要加入的{@link Iterator} + * @return 原集合 + */ + public static Collection addAll(Collection collection, Iterator iterator) { + if (null != collection && null != iterator) { + while (iterator.hasNext()) { + collection.add(iterator.next()); + } + } + return collection; + } + + /** + * 加入全部 + * + * @param 集合元素类型 + * @param collection 被加入的集合 {@link Collection} + * @param iterable 要加入的内容{@link Iterable} + * @return 原集合 + */ + public static Collection addAll(Collection collection, Iterable iterable) { + if (iterable == null) { + return collection; + } + return addAll(collection, iterable.iterator()); + } + + /** + * 加入全部 + * + * @param 集合元素类型 + * @param collection 被加入的集合 {@link Collection} + * @param enumeration 要加入的内容{@link Enumeration} + * @return 原集合 + */ + public static Collection addAll(Collection collection, Enumeration enumeration) { + if (null != collection && null != enumeration) { + while (enumeration.hasMoreElements()) { + collection.add(enumeration.nextElement()); + } + } + return collection; + } + + /** + * 加入全部 + * + * @param 集合元素类型 + * @param collection 被加入的集合 {@link Collection} + * @param values 要加入的内容数组 + * @return 原集合 + * @since 3.0.8 + */ + public static Collection addAll(Collection collection, T[] values) { + if (null != collection && null != values) { + Collections.addAll(collection, values); + } + return collection; + } + + /** + * 将另一个列表中的元素加入到列表中，如果列表中已经存在此元素则忽略之 + * + * @param 集合元素类型 + * @param list 列表 + * @param otherList 其它列表 + * @return 此列表 + */ + public static List addAllIfNotContains(List list, List otherList) { + for (T t : otherList) { + if (false == list.contains(t)) { + list.add(t); + } + } + return list; + } + + /** + * 获取集合中指定下标的元素值，下标可以为负数，例如-1表示最后一个元素
+ * 如果元素越界，返回null + * + * @param 元素类型 + * @param collection 集合 + * @param index 下标，支持负数 + * @return 元素值 + * @since 4.0.6 + */ + public static T get(Collection collection, int index) { + if (null == collection) { + return null; + } + + final int size = collection.size(); + if (0 == size) { + return null; + } + + if (index < 0) { + index += size; + } + + // 检查越界 + if (index >= size || index < 0) { + return null; + } + + if (collection instanceof List) { + final List list = ((List) collection); + return list.get(index); + } else { + return IterUtil.get(collection.iterator(), index); + } + } + + /** + * 获取集合中指定多个下标的元素值，下标可以为负数，例如-1表示最后一个元素 + * + * @param 元素类型 + * @param collection 集合 + * @param indexes 下标，支持负数 + * @return 元素值列表 + * @since 4.0.6 + */ + @SuppressWarnings("unchecked") + public static List getAny(Collection collection, int... indexes) { + final int size = collection.size(); + final ArrayList result = new ArrayList<>(); + if (collection instanceof List) { + final List list = ((List) collection); + for (int index : indexes) { + if (index < 0) { + index += size; + } + result.add(list.get(index)); + } + } else { + final Object[] array = collection.toArray(); + for (int index : indexes) { + if (index < 0) { + index += size; + } + result.add((T) array[index]); + } + } + return result; + } + + /** + * 获取集合的第一个元素 + * + * @param 集合元素类型 + * @param iterable {@link Iterable} + * @return 第一个元素 + * @see IterUtil#getFirst(Iterable) + * @since 3.0.1 + */ + public static T getFirst(Iterable iterable) { + return IterUtil.getFirst(iterable); + } + + /** + * 获取集合的第一个元素 + * + * @param 集合元素类型 + * @param iterator {@link Iterator} + * @return 第一个元素 + * @see IterUtil#getFirst(Iterator) + * @since 3.0.1 + */ + public static T getFirst(Iterator iterator) { + return IterUtil.getFirst(iterator); + } + + /** + * 获取集合的最后一个元素 + * + * @param 集合元素类型 + * @param collection {@link Collection} + * @return 最后一个元素 + * @since 4.1.10 + */ + public static T getLast(Collection collection) { + return get(collection, -1); + } + + /** + * 获得{@link Iterable}对象的元素类型（通过第一个非空元素判断） + * + * @param iterable {@link Iterable} + * @return 元素类型，当列表为空或元素全部为null时，返回null + * @see IterUtil#getElementType(Iterable) + * @since 3.0.8 + * @deprecated 请使用 {@link IterUtil#getElementType(Iterable)} + */ + @Deprecated + public static Class getElementType(Iterable iterable) { + return IterUtil.getElementType(iterable); + } + + /** + * 获得{@link Iterator}对象的元素类型（通过第一个非空元素判断） + * + * @param iterator {@link Iterator} + * @return 元素类型，当列表为空或元素全部为null时，返回null + * @see IterUtil#getElementType(Iterator) + * @since 3.0.8 + * @deprecated 请使用 {@link IterUtil#getElementType(Iterator)} + */ + @Deprecated + public static Class getElementType(Iterator iterator) { + return IterUtil.getElementType(iterator); + } + + /** + * 从Map中获取指定键列表对应的值列表
+ * 如果key在map中不存在或key对应值为null，则返回值列表对应位置的值也为null + * + * @param 键类型 + * @param 值类型 + * @param map {@link Map} + * @param keys 键列表 + * @return 值列表 + * @since 3.0.8 + */ + @SuppressWarnings("unchecked") + public static ArrayList valuesOfKeys(Map map, K... keys) { + return MapUtil.valuesOfKeys(map, new ArrayIter<>(keys)); + } + + /** + * 从Map中获取指定键列表对应的值列表
+ * 如果key在map中不存在或key对应值为null，则返回值列表对应位置的值也为null + * + * @param 键类型 + * @param 值类型 + * @param map {@link Map} + * @param keys 键列表 + * @return 值列表 + * @since 3.0.9 + */ + public static ArrayList valuesOfKeys(Map map, Iterable keys) { + return valuesOfKeys(map, keys.iterator()); + } + + /** + * 从Map中获取指定键列表对应的值列表
+ * 如果key在map中不存在或key对应值为null，则返回值列表对应位置的值也为null + * + * @param 键类型 + * @param 值类型 + * @param map {@link Map} + * @param keys 键列表 + * @return 值列表 + * @since 3.0.9 + */ + public static ArrayList valuesOfKeys(Map map, Iterator keys) { + return MapUtil.valuesOfKeys(map, keys); + } + + // ------------------------------------------------------------------------------------------------- sort + + /** + * 将多个集合排序并显示不同的段落（分页）
+ * 采用{@link BoundedPriorityQueue}实现分页取局部 + * + * @param 集合元素类型 + * @param pageNo 页码，从0开始计数，0表示第一页 + * @param pageSize 每页的条目数 + * @param comparator 比较器 + * @param colls 集合数组 + * @return 分页后的段落内容 + */ + @SafeVarargs + public static List sortPageAll(int pageNo, int pageSize, Comparator comparator, Collection... colls) { + final List list = new ArrayList<>(pageNo * pageSize); + for (Collection coll : colls) { + list.addAll(coll); + } + if (null != comparator) { + list.sort(comparator); + } + + return page(pageNo, pageSize, list); + } + + /** + * 对指定List分页取值 + * + * @param 集合元素类型 + * @param pageNo 页码，从0开始计数，0表示第一页 + * @param pageSize 每页的条目数 + * @param list 列表 + * @return 分页后的段落内容 + * @since 4.1.20 + */ + public static List page(int pageNo, int pageSize, List list) { + return ListUtil.page(pageNo, pageSize, list); + } + + /** + * 排序集合，排序不会修改原集合 + * + * @param 集合元素类型 + * @param collection 集合 + * @param comparator 比较器 + * @return treeSet + */ + public static List sort(Collection collection, Comparator comparator) { + List list = new ArrayList<>(collection); + list.sort(comparator); + return list; + } + + /** + * 针对List排序，排序会修改原List + * + * @param 元素类型 + * @param list 被排序的List + * @param c {@link Comparator} + * @return 原list + * @see Collections#sort(List, Comparator) + */ + public static List sort(List list, Comparator c) { + return ListUtil.sort(list, c); + } + + /** + * 根据Bean的属性排序 + * + * @param 元素类型 + * @param collection 集合，会被转换为List + * @param property 属性名 + * @return 排序后的List + * @since 4.0.6 + */ + public static List sortByProperty(Collection collection, String property) { + return sort(collection, new PropertyComparator<>(property)); + } + + /** + * 根据Bean的属性排序 + * + * @param 元素类型 + * @param list List + * @param property 属性名 + * @return 排序后的List + * @since 4.0.6 + */ + public static List sortByProperty(List list, String property) { + return ListUtil.sortByProperty(list, property); + } + + /** + * 根据汉字的拼音顺序排序 + * + * @param collection 集合，会被转换为List + * @return 排序后的List + * @since 4.0.8 + */ + public static List sortByPinyin(Collection collection) { + return sort(collection, new PinyinComparator()); + } + + /** + * 根据汉字的拼音顺序排序 + * + * @param list List + * @return 排序后的List + * @since 4.0.8 + */ + public static List sortByPinyin(List list) { + return ListUtil.sortByPinyin(list); + } + + /** + * 排序Map + * + * @param 键类型 + * @param 值类型 + * @param map Map + * @param comparator Entry比较器 + * @return {@link TreeMap} + * @since 3.0.9 + */ + public static TreeMap sort(Map map, Comparator comparator) { + final TreeMap result = new TreeMap<>(comparator); + result.putAll(map); + return result; + } + + /** + * 通过Entry排序，可以按照键排序，也可以按照值排序，亦或者两者综合排序 + * + * @param 键类型 + * @param 值类型 + * @param entryCollection Entry集合 + * @param comparator {@link Comparator} + * @return {@link LinkedList} + * @since 3.0.9 + */ + public static LinkedHashMap sortToMap(Collection> entryCollection, Comparator> comparator) { + List> list = new LinkedList<>(entryCollection); + list.sort(comparator); + + LinkedHashMap result = new LinkedHashMap<>(); + for (Map.Entry entry : list) { + result.put(entry.getKey(), entry.getValue()); + } + return result; + } + + /** + * 通过Entry排序，可以按照键排序，也可以按照值排序，亦或者两者综合排序 + * + * @param 键类型 + * @param 值类型 + * @param map 被排序的Map + * @param comparator {@link Comparator} + * @return {@link LinkedList} + * @since 3.0.9 + */ + public static LinkedHashMap sortByEntry(Map map, Comparator> comparator) { + return sortToMap(map.entrySet(), comparator); + } + + /** + * 将Set排序（根据Entry的值） + * + * @param 键类型 + * @param 值类型 + * @param collection 被排序的{@link Collection} + * @return 排序后的Set + */ + @SuppressWarnings({"unchecked", "rawtypes"}) + public static List> sortEntryToList(Collection> collection) { + List> list = new LinkedList<>(collection); + list.sort((o1, o2) -> { + V v1 = o1.getValue(); + V v2 = o2.getValue(); + + if (v1 instanceof Comparable) { + return ((Comparable) v1).compareTo(v2); + } else { + return v1.toString().compareTo(v2.toString()); + } + }); + return list; + } + + // ------------------------------------------------------------------------------------------------- forEach + + /** + * 循环遍历 {@link Iterable}，使用{@link Consumer} 接受遍历的每条数据，并针对每条数据做处理 + * + * @param 集合元素类型 + * @param iterable {@link Iterable} + * @param consumer {@link Consumer} 遍历的每条数据处理器 + * @since 5.4.7 + */ + public static void forEach(Iterable iterable, Consumer consumer) { + if (iterable == null) { + return; + } + forEach(iterable.iterator(), consumer); + } + + /** + * 循环遍历 {@link Iterator}，使用{@link Consumer} 接受遍历的每条数据，并针对每条数据做处理 + * + * @param 集合元素类型 + * @param iterator {@link Iterator} + * @param consumer {@link Consumer} 遍历的每条数据处理器 + */ + public static void forEach(Iterator iterator, Consumer consumer) { + if (iterator == null) { + return; + } + int index = 0; + while (iterator.hasNext()) { + consumer.accept(iterator.next(), index); + index++; + } + } + + /** + * 循环遍历 {@link Enumeration}，使用{@link Consumer} 接受遍历的每条数据，并针对每条数据做处理 + * + * @param 集合元素类型 + * @param enumeration {@link Enumeration} + * @param consumer {@link Consumer} 遍历的每条数据处理器 + */ + public static void forEach(Enumeration enumeration, Consumer consumer) { + if (enumeration == null) { + return; + } + int index = 0; + while (enumeration.hasMoreElements()) { + consumer.accept(enumeration.nextElement(), index); + index++; + } + } + + /** + * 循环遍历Map，使用{@link KVConsumer} 接受遍历的每条数据，并针对每条数据做处理
+ * 和JDK8中的map.forEach不同的是，此方法支持index + * + * @param Key类型 + * @param Value类型 + * @param map {@link Map} + * @param kvConsumer {@link KVConsumer} 遍历的每条数据处理器 + */ + public static void forEach(Map map, KVConsumer kvConsumer) { + if (map == null) { + return; + } + int index = 0; + for (Entry entry : map.entrySet()) { + kvConsumer.accept(entry.getKey(), entry.getValue(), index); + index++; + } + } + + /** + * 分组，按照{@link Hash32}接口定义的hash算法，集合中的元素放入hash值对应的子列表中 + * + * @param 元素类型 + * @param collection 被分组的集合 + * @param hash Hash值算法，决定元素放在第几个分组的规则 + * @return 分组后的集合 + */ + public static List> group(Collection collection, Hash32 hash) { + final List> result = new ArrayList<>(); + if (isEmpty(collection)) { + return result; + } + if (null == hash) { + // 默认hash算法，按照元素的hashCode分组 + hash = t -> (null == t) ? 0 : t.hashCode(); + } + + int index; + List subList; + for (T t : collection) { + index = hash.hash32(t); + if (result.size() - 1 < index) { + while (result.size() - 1 < index) { + result.add(null); + } + result.set(index, newArrayList(t)); + } else { + subList = result.get(index); + if (null == subList) { + result.set(index, newArrayList(t)); + } else { + subList.add(t); + } + } + } + return result; + } + + /** + * 根据元素的指定字段名分组，非Bean都放在第一个分组中 + * + * @param 元素类型 + * @param collection 集合 + * @param fieldName 元素Bean中的字段名，非Bean都放在第一个分组中 + * @return 分组列表 + */ + public static List> groupByField(Collection collection, final String fieldName) { + return group(collection, new Hash32() { + private final List fieldNameList = new ArrayList<>(); + + @Override + public int hash32(T t) { + if (null == t || false == BeanUtil.isBean(t.getClass())) { + // 非Bean放在同一子分组中 + return 0; + } + final Object value = ReflectUtil.getFieldValue(t, fieldName); + int hash = fieldNameList.indexOf(value); + if (hash < 0) { + fieldNameList.add(value); + return fieldNameList.size() - 1; + } else { + return hash; + } + } + }); + } + + /** + * 反序给定List，会在原List基础上直接修改 + * + * @param 元素类型 + * @param list 被反转的List + * @return 反转后的List + * @since 4.0.6 + */ + public static List reverse(List list) { + return ListUtil.reverse(list); + } + + /** + * 反序给定List，会创建一个新的List，原List数据不变 + * + * @param 元素类型 + * @param list 被反转的List + * @return 反转后的List + * @since 4.0.6 + */ + public static List reverseNew(List list) { + return ListUtil.reverseNew(list); + } + + /** + * 设置或增加元素。当index小于List的长度时，替换指定位置的值，否则在尾部追加 + * + * @param 元素类型 + * @param list List列表 + * @param index 位置 + * @param element 新元素 + * @return 原List + * @since 4.1.2 + */ + public static List setOrAppend(List list, int index, T element) { + return ListUtil.setOrAppend(list, index, element); + } + + /** + * 获取指定Map列表中所有的Key + * + * @param 键类型 + * @param mapCollection Map列表 + * @return key集合 + * @since 4.5.12 + */ + public static Set keySet(Collection> mapCollection) { + if (isEmpty(mapCollection)) { + return new HashSet<>(); + } + final HashSet set = new HashSet<>(mapCollection.size() * 16); + for (Map map : mapCollection) { + set.addAll(map.keySet()); + } + + return set; + } + + /** + * 获取指定Map列表中所有的Value + * + * @param 值类型 + * @param mapCollection Map列表 + * @return Value集合 + * @since 4.5.12 + */ + public static List values(Collection> mapCollection) { + final List values = new ArrayList<>(); + for (Map map : mapCollection) { + values.addAll(map.values()); + } + + return values; + } + + /** + * 取最大值 + * + * @param 元素类型 + * @param coll 集合 + * @return 最大值 + * @see Collections#max(Collection) + * @since 4.6.5 + */ + public static > T max(Collection coll) { + return Collections.max(coll); + } + + /** + * 取最小值 + * + * @param 元素类型 + * @param coll 集合 + * @return 最小值 + * @see Collections#min(Collection) + * @since 4.6.5 + */ + public static > T min(Collection coll) { + return Collections.min(coll); + } + + /** + * 转为只读集合 + * + * @param 元素类型 + * @param c 集合 + * @return 只读集合 + * @since 5.2.6 + */ + public static Collection unmodifiable(Collection c) { + return Collections.unmodifiableCollection(c); + } + + /** + * 根据给定的集合类型，返回对应的空集合，支持类型包括： + * * + * 
+	 *     1. NavigableSet
+	 *     2. SortedSet
+	 *     3. Set
+	 *     4. List
+	 *
+ * + * @param 元素类型 + * @param 集合类型 + * @param collectionClass 集合类型 + * @return 空集合 + * @since 5.3.1 + */ + @SuppressWarnings("unchecked") + public static > T empty(Class collectionClass) { + if (null == collectionClass) { + return (T) Collections.emptyList(); + } + + if (Set.class.isAssignableFrom(collectionClass)) { + if (NavigableSet.class == collectionClass) { + return (T) Collections.emptyNavigableSet(); + } else if (SortedSet.class == collectionClass) { + return (T) Collections.emptySortedSet(); + } else { + return (T) Collections.emptySet(); + } + } else if (List.class.isAssignableFrom(collectionClass)) { + return (T) Collections.emptyList(); + } + + // 不支持空集合的集合类型 + throw new IllegalArgumentException(StrUtil.format("[{}] is not support to get empty!", collectionClass)); + } + + /** + * 清除一个或多个集合内的元素，每个集合调用clear()方法 + * + * @param collections 一个或多个集合 + * @since 5.3.6 + */ + public static void clear(Collection... collections) { + for (Collection collection : collections) { + if (isNotEmpty(collection)) { + collection.clear(); + } + } + } + + /** + * 填充List，以达到最小长度 + * + * @param 集合元素类型 + * @param list 列表 + * @param minLen 最小长度 + * @param padObj 填充的对象 + * @since 5.3.10 + */ + public static void padLeft(List list, int minLen, T padObj) { + Objects.requireNonNull(list); + if (list.isEmpty()) { + padRight(list, minLen, padObj); + return; + } + for (int i = list.size(); i < minLen; i++) { + list.add(0, padObj); + } + } + + /** + * 填充List，以达到最小长度 + * + * @param 集合元素类型 + * @param list 列表 + * @param minLen 最小长度 + * @param padObj 填充的对象 + * @since 5.3.10 + */ + public static void padRight(Collection list, int minLen, T padObj) { + Objects.requireNonNull(list); + for (int i = list.size(); i < minLen; i++) { + list.add(padObj); + } + } + + /** + * 使用给定的转换函数，转换源集合为新类型的集合 + * + * @param 源元素类型 + * @param 目标元素类型 + * @param collection 集合 + * @param function 转换函数 + * @return 新类型的集合 + * @since 5.4.3 + */ + public static Collection trans(Collection collection, Function function) { + return new TransCollection<>(collection, function); + } + + /** + * 使用给定的map将集合中的原素进行属性或者值的重新设定 + * + * @param 元素类型 + * @param 替换的键 + * @param 替换的值 + * @param iterable 集合 + * @param map 映射集 + * @param keyGenerate 映射键生成函数 + * @param biConsumer 封装映射到的值函数 + * @author nick_wys + * @since 5.7.18 + */ + public static void setValueByMap(Iterable iterable, Map map, Function keyGenerate, BiConsumer biConsumer) { + iterable.forEach(x -> Optional.ofNullable(map.get(keyGenerate.apply(x))).ifPresent(y -> biConsumer.accept(x, y))); + } + + // ---------------------------------------------------------------------------------------------- Interface start + + /** + * 针对一个参数做相应的操作
+ * 此函数接口与JDK8中Consumer不同是多提供了index参数，用于标记遍历对象是第几个。 + * + * @param 处理参数类型 + * @author Looly + */ + @FunctionalInterface + public interface Consumer extends Serializable { + /** + * 接受并处理一个参数 + * + * @param value 参数值 + * @param index 参数在集合中的索引 + */ + void accept(T value, int index); + } + + /** + * 针对两个参数做相应的操作，例如Map中的KEY和VALUE + * + * @param KEY类型 + * @param VALUE类型 + * @author Looly + */ + @FunctionalInterface + public interface KVConsumer extends Serializable { + /** + * 接受并处理一对参数 + * + * @param key 键 + * @param value 值 + * @param index 参数在集合中的索引 + */ + void accept(K key, V value, int index); + } + // ---------------------------------------------------------------------------------------------- Interface end + + /** + * 获取Collection或者iterator的大小，此方法可以处理的对象类型如下： + *
    + *
  • Collection - the collection size + *
  • Map - the map size + *
  • Array - the array size + *
  • Iterator - the number of elements remaining in the iterator + *
  • Enumeration - the number of elements remaining in the enumeration + *
+ * + * @param object 可以为空的对象 + * @return 如果object为空则返回0 + * @throws IllegalArgumentException 参数object不是Collection或者iterator + * @since 5.5.0 + */ + public static int size(final Object object) { + if (object == null) { + return 0; + } + + int total = 0; + if (object instanceof Map) { + total = ((Map) object).size(); + } else if (object instanceof Collection) { + total = ((Collection) object).size(); + } else if (object instanceof Iterable) { + total = IterUtil.size((Iterable) object); + } else if (object instanceof Iterator) { + total = IterUtil.size((Iterator) object); + } else if (object instanceof Enumeration) { + final Enumeration it = (Enumeration) object; + while (it.hasMoreElements()) { + total++; + it.nextElement(); + } + } else if (ArrayUtil.isArray(object)) { + total = ArrayUtil.length(object); + } else { + throw new IllegalArgumentException("Unsupported object type: " + object.getClass().getName()); + } + return total; + } + + /** + * 判断两个{@link Collection} 是否元素和顺序相同，返回{@code true}的条件是： + *
    + *
  • 两个{@link Collection}必须长度相同
    • + *
  • 两个{@link Collection}元素相同index的对象必须equals，满足{@link Objects#equals(Object, Object)}
    • + *
+ * 此方法来自Apache-Commons-Collections4。 + * + * @param list1 列表1 + * @param list2 列表2 + * @return 是否相同 + * @since 5.6.0 + */ + public static boolean isEqualList(final Collection list1, final Collection list2) { + if (list1 == list2) { + return true; + } + if (list1 == null || list2 == null || list1.size() != list2.size()) { + return false; + } + + return IterUtil.isEqualList(list1, list2); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/CollectionUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/CollectionUtil.java new file mode 100644 index 0000000..28f60fa --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/CollectionUtil.java @@ -0,0 +1,10 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +/** + * 集合相关工具类，包括数组，是 {@link CollUtil} 的别名工具类 + * + * @author xiaoleilu + * @see CollUtil + */ +public class CollectionUtil extends CollUtil{ +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ComputeIter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ComputeIter.java new file mode 100644 index 0000000..e051075 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ComputeIter.java @@ -0,0 +1,73 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import java.util.Iterator; +import java.util.NoSuchElementException; + +/** + * 带有计算属性的遍历器
+ * 通过继承此抽象遍历器，实现{@link #computeNext()}计算下一个节点，即可完成节点遍历
+ * 当调用{@link #hasNext()}时将此方法产生的节点缓存，直到调用{@link #next()}取出
+ * 当无下一个节点时，须返回{@code null}表示遍历结束 + * + * @param 节点类型 + * @author looly + * @since 5.7.14 + */ +public abstract class ComputeIter implements Iterator { + + private T next; + /** + * A flag indicating if the iterator has been fully read. + */ + private boolean finished; + + /** + * 计算新的节点，通过实现此方法，当调用{@link #hasNext()}时将此方法产生的节点缓存，直到调用{@link #next()}取出
+ * 当无下一个节点时，须返回{@code null}表示遍历结束 + * + * @return 节点值 + */ + protected abstract T computeNext(); + + @Override + public boolean hasNext() { + if (null != next) { + // 用户读取了节点，但是没有使用 + return true; + } else if (finished) { + // 读取结束 + return false; + } + + T result = computeNext(); + if (null == result) { + // 不再有新的节点，结束 + this.finished = true; + return false; + } else { + this.next = result; + return true; + } + + } + + @Override + public T next() { + if (false == hasNext()) { + throw new NoSuchElementException("No more lines"); + } + + T result = this.next; + // 清空cache，表示此节点读取完毕，下次计算新节点 + this.next = null; + return result; + } + + /** + * 手动结束遍历器，用于关闭操作等 + */ + public void finish(){ + this.finished = true; + this.next = null; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ConcurrentHashSet.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ConcurrentHashSet.java new file mode 100644 index 0000000..2325027 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ConcurrentHashSet.java @@ -0,0 +1,117 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.map.SafeConcurrentHashMap; + +import java.util.AbstractSet; +import java.util.Collection; +import java.util.Iterator; + +/** + * 通过{@link SafeConcurrentHashMap}实现的线程安全HashSet + * + * @author Looly + * + * @param 元素类型 + * @since 3.1.0 + */ +public class ConcurrentHashSet extends AbstractSet implements java.io.Serializable { + private static final long serialVersionUID = 7997886765361607470L; + + /** 持有对象。如果值为此对象表示有数据，否则无数据 */ + private static final Boolean PRESENT = true; + private final SafeConcurrentHashMap map; + + // ----------------------------------------------------------------------------------- Constructor start + /** + * 构造
+ * 触发因子为默认的0.75 + */ + public ConcurrentHashSet() { + map = new SafeConcurrentHashMap<>(); + } + + /** + * 构造
+ * 触发因子为默认的0.75 + * + * @param initialCapacity 初始大小 + */ + public ConcurrentHashSet(int initialCapacity) { + map = new SafeConcurrentHashMap<>(initialCapacity); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + * @param loadFactor 加载因子。此参数决定数据增长时触发的百分比 + */ + public ConcurrentHashSet(int initialCapacity, float loadFactor) { + map = new SafeConcurrentHashMap<>(initialCapacity, loadFactor); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + * @param loadFactor 触发因子。此参数决定数据增长时触发的百分比 + * @param concurrencyLevel 线程并发度 + */ + public ConcurrentHashSet(int initialCapacity, float loadFactor, int concurrencyLevel) { + map = new SafeConcurrentHashMap<>(initialCapacity, loadFactor, concurrencyLevel); + } + + /** + * 从已有集合中构造 + * @param iter {@link Iterable} + */ + public ConcurrentHashSet(Iterable iter) { + if(iter instanceof Collection) { + final Collection collection = (Collection)iter; + map = new SafeConcurrentHashMap<>((int)(collection.size() / 0.75f)); + this.addAll(collection); + }else { + map = new SafeConcurrentHashMap<>(); + for (E e : iter) { + this.add(e); + } + } + } + // ----------------------------------------------------------------------------------- Constructor end + + @Override + public Iterator iterator() { + return map.keySet().iterator(); + } + + @Override + public int size() { + return map.size(); + } + + @Override + public boolean isEmpty() { + return map.isEmpty(); + } + + @Override + public boolean contains(Object o) { + //noinspection SuspiciousMethodCalls + return map.containsKey(o); + } + + @Override + public boolean add(E e) { + return map.put(e, PRESENT) == null; + } + + @Override + public boolean remove(Object o) { + return PRESENT.equals(map.remove(o)); + } + + @Override + public void clear() { + map.clear(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/CopiedIter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/CopiedIter.java new file mode 100644 index 0000000..b376807 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/CopiedIter.java @@ -0,0 +1,68 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import java.io.Serializable; +import java.util.Iterator; +import java.util.List; + +/** + * 复制 {@link Iterator}
+ * 为了解决并发情况下{@link Iterator}遍历导致的问题（当Iterator被修改会抛出ConcurrentModificationException） + * ，故使用复制原Iterator的方式解决此问题。 + * + *

+ * 解决方法为：在构造方法中遍历Iterator中的元素，装入新的List中然后遍历之。 + * 当然，修改这个复制后的Iterator是没有意义的，因此remove方法将会抛出异常。 + * + *

+ * 需要注意的是，在构造此对象时需要保证原子性（原对象不被修改），最好加锁构造此对象，构造完毕后解锁。 + * + * @param 元素类型 + * @author Looly + * @since 3.0.7 + */ +public class CopiedIter implements IterableIter, Serializable { + private static final long serialVersionUID = 1L; + + private final Iterator listIterator; + + /** + * 根据已有{@link Iterator}，返回新的{@code CopiedIter} + * + * @param iterator {@link Iterator} + * @param 元素类型 + * @return {@code CopiedIter} + */ + public static CopiedIter copyOf(Iterator iterator) { + return new CopiedIter<>(iterator); + } + + /** + * 构造 + * + * @param iterator 被复制的Iterator + */ + public CopiedIter(Iterator iterator) { + final List eleList = ListUtil.toList(iterator); + this.listIterator = eleList.iterator(); + } + + @Override + public boolean hasNext() { + return this.listIterator.hasNext(); + } + + @Override + public E next() { + return this.listIterator.next(); + } + + /** + * 此对象不支持移除元素 + * + * @throws UnsupportedOperationException 当调用此方法时始终抛出此异常 + */ + @Override + public void remove() throws UnsupportedOperationException { + throw new UnsupportedOperationException("This is a read-only iterator."); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/EnumerationIter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/EnumerationIter.java new file mode 100644 index 0000000..4c9f2db --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/EnumerationIter.java @@ -0,0 +1,41 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import java.io.Serializable; +import java.util.Enumeration; +import java.util.Iterator; + +/** + * {@link Enumeration}对象转{@link Iterator}对象 + * @author Looly + * + * @param 元素类型 + * @since 4.1.1 + */ +public class EnumerationIter implements IterableIter, Serializable{ + private static final long serialVersionUID = 1L; + + private final Enumeration e; + + /** + * 构造 + * @param enumeration {@link Enumeration}对象 + */ + public EnumerationIter(Enumeration enumeration) { + this.e = enumeration; + } + + @Override + public boolean hasNext() { + return e.hasMoreElements(); + } + + @Override + public E next() { + return e.nextElement(); + } + + @Override + public void remove() { + throw new UnsupportedOperationException(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/FilterIter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/FilterIter.java new file mode 100755 index 0000000..6530475 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/FilterIter.java @@ -0,0 +1,96 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Filter; + +import java.util.Iterator; +import java.util.NoSuchElementException; + +/** + * 包装 {@link Iterator}并根据{@link Filter}定义，过滤元素输出
+ * 类实现来自Apache Commons Collection + * + * @author apache commons, looly + * @since 5.8.0 + */ +public class FilterIter implements Iterator { + + private final Iterator iterator; + private final Filter filter; + + /** + * 下一个元素 + */ + private E nextObject; + /** + * 标记下一个元素是否被计算 + */ + private boolean nextObjectSet = false; + + /** + * 构造 + * + * @param iterator 被包装的{@link Iterator} + * @param filter 过滤函数，{@code null}表示不过滤 + */ + public FilterIter(final Iterator iterator, final Filter filter) { + this.iterator = Assert.notNull(iterator); + this.filter = filter; + } + + @Override + public boolean hasNext() { + return nextObjectSet || setNextObject(); + } + + @Override + public E next() { + if (false == nextObjectSet && false == setNextObject()) { + throw new NoSuchElementException(); + } + nextObjectSet = false; + return nextObject; + } + + @Override + public void remove() { + if (nextObjectSet) { + throw new IllegalStateException("remove() cannot be called"); + } + iterator.remove(); + } + + /** + * 获取被包装的{@link Iterator} + * + * @return {@link Iterator} + */ + public Iterator getIterator() { + return iterator; + } + + /** + * 获取过滤函数 + * + * @return 过滤函数，可能为{@code null} + */ + public Filter getFilter() { + return filter; + } + + /** + * 设置下一个元素，如果存在返回{@code true}，否则{@code false} + */ + private boolean setNextObject() { + while (iterator.hasNext()) { + final E object = iterator.next(); + if (null == filter || filter.accept(object)) { + nextObject = object; + nextObjectSet = true; + return true; + } + } + return false; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/IterChain.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/IterChain.java new file mode 100644 index 0000000..77c1814 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/IterChain.java @@ -0,0 +1,91 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.lang.Chain; + +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; +import java.util.NoSuchElementException; + +/** + * 组合{@link Iterator}，将多个{@link Iterator}组合在一起，便于集中遍历。
+ * 来自Jodd + * + * @param 元素类型 + * @author looly, jodd + */ +public class IterChain implements Iterator, Chain, IterChain> { + + protected final List> allIterators = new ArrayList<>(); + + /** + * 构造 + * 可以使用 {@link #addChain(Iterator)} 方法加入更多的集合。 + */ + public IterChain() { + } + + /** + * 构造 + * @param iterators 多个{@link Iterator} + */ + @SafeVarargs + public IterChain(Iterator... iterators) { + for (final Iterator iterator : iterators) { + addChain(iterator); + } + } + + @Override + public IterChain addChain(Iterator iterator) { + if (allIterators.contains(iterator)) { + throw new IllegalArgumentException("Duplicate iterator"); + } + allIterators.add(iterator); + return this; + } + + // ---------------------------------------------------------------- interface + + protected int currentIter = -1; + + @Override + public boolean hasNext() { + if (currentIter == -1) { + currentIter = 0; + } + + final int size = allIterators.size(); + for (int i = currentIter; i < size; i++) { + final Iterator iterator = allIterators.get(i); + if (iterator.hasNext()) { + currentIter = i; + return true; + } + } + return false; + } + + @Override + public T next() { + if (false == hasNext()) { + throw new NoSuchElementException(); + } + + return allIterators.get(currentIter).next(); + } + + @Override + public void remove() { + if (-1 == currentIter) { + throw new IllegalStateException("next() has not yet been called"); + } + + allIterators.get(currentIter).remove(); + } + + @Override + public Iterator> iterator() { + return this.allIterators.iterator(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/IterUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/IterUtil.java new file mode 100755 index 0000000..723f2b0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/IterUtil.java @@ -0,0 +1,1064 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Editor; +import aiyh.utils.tool.cn.hutool.core.lang.Filter; +import aiyh.utils.tool.cn.hutool.core.lang.Matcher; +import aiyh.utils.tool.cn.hutool.core.lang.func.Func1; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.text.StrJoiner; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import org.w3c.dom.Node; +import org.w3c.dom.NodeList; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.Dictionary; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Objects; +import java.util.function.Consumer; +import java.util.function.Function; + +/** + * {@link Iterable} 和 {@link Iterator} 相关工具类 + * + * @author Looly + * @since 3.1.0 + */ +public class IterUtil { + + /** + * 获取{@link Iterator} + * + * @param iterable {@link Iterable} + * @param 元素类型 + * @return 当iterable为null返回{@code null}，否则返回对应的{@link Iterator} + * @since 5.7.2 + */ + public static Iterator getIter(Iterable iterable) { + return null == iterable ? null : iterable.iterator(); + } + + /** + * Iterable是否为空 + * + * @param iterable Iterable对象 + * @return 是否为空 + */ + public static boolean isEmpty(Iterable iterable) { + return null == iterable || isEmpty(iterable.iterator()); + } + + /** + * Iterator是否为空 + * + * @param Iterator Iterator对象 + * @return 是否为空 + */ + public static boolean isEmpty(Iterator Iterator) { + return null == Iterator || false == Iterator.hasNext(); + } + + /** + * Iterable是否为空 + * + * @param iterable Iterable对象 + * @return 是否为空 + */ + public static boolean isNotEmpty(Iterable iterable) { + return null != iterable && isNotEmpty(iterable.iterator()); + } + + /** + * Iterator是否为空 + * + * @param Iterator Iterator对象 + * @return 是否为空 + */ + public static boolean isNotEmpty(Iterator Iterator) { + return null != Iterator && Iterator.hasNext(); + } + + /** + * 是否包含{@code null}元素 + * + * @param iter 被检查的{@link Iterable}对象，如果为{@code null} 返回true + * @return 是否包含{@code null}元素 + */ + public static boolean hasNull(Iterable iter) { + return hasNull(null == iter ? null : iter.iterator()); + } + + /** + * 是否包含{@code null}元素 + * + * @param iter 被检查的{@link Iterator}对象，如果为{@code null} 返回true + * @return 是否包含{@code null}元素 + */ + public static boolean hasNull(Iterator iter) { + if (null == iter) { + return true; + } + while (iter.hasNext()) { + if (null == iter.next()) { + return true; + } + } + + return false; + } + + /** + * 是否全部元素为null + * + * @param iter iter 被检查的{@link Iterable}对象，如果为{@code null} 返回true + * @return 是否全部元素为null + * @since 3.3.0 + */ + public static boolean isAllNull(Iterable iter) { + return isAllNull(null == iter ? null : iter.iterator()); + } + + /** + * 是否全部元素为null + * + * @param iter iter 被检查的{@link Iterator}对象，如果为{@code null} 返回true + * @return 是否全部元素为null + * @since 3.3.0 + */ + public static boolean isAllNull(Iterator iter) { + return null == getFirstNoneNull(iter); + } + + /** + * 根据集合返回一个元素计数的 {@link Map}
+ * 所谓元素计数就是假如这个集合中某个元素出现了n次，那将这个元素做为key，n做为value
+ * 例如：[a,b,c,c,c] 得到：
+ * a: 1
+ * b: 1
+ * c: 3
+ * + * @param 集合元素类型 + * @param iter {@link Iterator}，如果为null返回一个空的Map + * @return {@link Map} + */ + public static Map countMap(Iterator iter) { + final HashMap countMap = new HashMap<>(); + if (null != iter) { + T t; + while (iter.hasNext()) { + t = iter.next(); + countMap.put(t, countMap.getOrDefault(t, 0) + 1); + } + } + return countMap; + } + + /** + * 字段值与列表值对应的Map，常用于元素对象中有唯一ID时需要按照这个ID查找对象的情况
+ * 例如：车牌号 =》车 + * + * @param 字段名对应值得类型，不确定请使用Object + * @param 对象类型 + * @param iter 对象列表 + * @param fieldName 字段名（会通过反射获取其值） + * @return 某个字段值与对象对应Map + * @since 4.0.4 + */ + @SuppressWarnings("unchecked") + public static Map fieldValueMap(Iterator iter, String fieldName) { + return toMap(iter, new HashMap<>(), (value) -> (K) ReflectUtil.getFieldValue(value, fieldName)); + } + + /** + * 两个字段值组成新的Map + * + * @param 字段名对应值得类型，不确定请使用Object + * @param 值类型，不确定使用Object + * @param iter 对象列表 + * @param fieldNameForKey 做为键的字段名（会通过反射获取其值） + * @param fieldNameForValue 做为值的字段名（会通过反射获取其值） + * @return 某个字段值与对象对应Map + * @since 4.0.10 + */ + @SuppressWarnings("unchecked") + public static Map fieldValueAsMap(Iterator iter, String fieldNameForKey, String fieldNameForValue) { + return toMap(iter, new HashMap<>(), + (value) -> (K) ReflectUtil.getFieldValue(value, fieldNameForKey), + (value) -> (V) ReflectUtil.getFieldValue(value, fieldNameForValue) + ); + } + + /** + * 获取指定Bean列表中某个字段，生成新的列表 + * + * @param 对象类型 + * @param iterable 对象列表 + * @param fieldName 字段名（会通过反射获取其值） + * @return 某个字段值与对象对应Map + * @since 4.6.2 + */ + public static List fieldValueList(Iterable iterable, String fieldName) { + return fieldValueList(getIter(iterable), fieldName); + } + + /** + * 获取指定Bean列表中某个字段，生成新的列表 + * + * @param 对象类型 + * @param iter 对象列表 + * @param fieldName 字段名（会通过反射获取其值） + * @return 某个字段值与对象对应Map + * @since 4.0.10 + */ + public static List fieldValueList(Iterator iter, String fieldName) { + final List result = new ArrayList<>(); + if (null != iter) { + V value; + while (iter.hasNext()) { + value = iter.next(); + result.add(ReflectUtil.getFieldValue(value, fieldName)); + } + } + return result; + } + + /** + * 以 conjunction 为分隔符将集合转换为字符串
+ * 如果集合元素为数组、{@link Iterable}或{@link Iterator}，则递归组合其为字符串 + * + * @param 集合元素类型 + * @param iterator 集合 + * @param conjunction 分隔符 + * @return 连接后的字符串 + */ + public static String join(Iterator iterator, CharSequence conjunction) { + return StrJoiner.of(conjunction).append(iterator).toString(); + } + + /** + * 以 conjunction 为分隔符将集合转换为字符串
+ * 如果集合元素为数组、{@link Iterable}或{@link Iterator}，则递归组合其为字符串 + * + * @param 集合元素类型 + * @param iterator 集合 + * @param conjunction 分隔符 + * @param prefix 每个元素添加的前缀，null表示不添加 + * @param suffix 每个元素添加的后缀，null表示不添加 + * @return 连接后的字符串 + * @since 4.0.10 + */ + public static String join(Iterator iterator, CharSequence conjunction, String prefix, String suffix) { + return StrJoiner.of(conjunction, prefix, suffix) + // 每个元素都添加前后缀 + .setWrapElement(true) + .append(iterator) + .toString(); + } + + /** + * 以 conjunction 为分隔符将集合转换为字符串
+ * 如果集合元素为数组、{@link Iterable}或{@link Iterator}，则递归组合其为字符串 + * + * @param 集合元素类型 + * @param iterator 集合 + * @param conjunction 分隔符 + * @param func 集合元素转换器，将元素转换为字符串 + * @return 连接后的字符串 + * @since 5.6.7 + */ + public static String join(Iterator iterator, CharSequence conjunction, Function func) { + if (null == iterator) { + return null; + } + + return StrJoiner.of(conjunction).append(iterator, func).toString(); + } + + /** + * 将Entry集合转换为HashMap + * + * @param 键类型 + * @param 值类型 + * @param entryIter entry集合 + * @return Map + */ + public static HashMap toMap(Iterable> entryIter) { + final HashMap map = new HashMap<>(); + if (isNotEmpty(entryIter)) { + for (Entry entry : entryIter) { + map.put(entry.getKey(), entry.getValue()); + } + } + return map; + } + + /** + * 将键列表和值列表转换为Map
+ * 以键为准，值与键位置需对应。如果键元素数多于值元素，多余部分值用null代替。
+ * 如果值多于键，忽略多余的值。 + * + * @param 键类型 + * @param 值类型 + * @param keys 键列表 + * @param values 值列表 + * @return 标题内容Map + * @since 3.1.0 + */ + public static Map toMap(Iterable keys, Iterable values) { + return toMap(keys, values, false); + } + + /** + * 将键列表和值列表转换为Map
+ * 以键为准，值与键位置需对应。如果键元素数多于值元素，多余部分值用null代替。
+ * 如果值多于键，忽略多余的值。 + * + * @param 键类型 + * @param 值类型 + * @param keys 键列表 + * @param values 值列表 + * @param isOrder 是否有序 + * @return 标题内容Map + * @since 4.1.12 + */ + public static Map toMap(Iterable keys, Iterable values, boolean isOrder) { + return toMap(null == keys ? null : keys.iterator(), null == values ? null : values.iterator(), isOrder); + } + + /** + * 将键列表和值列表转换为Map
+ * 以键为准，值与键位置需对应。如果键元素数多于值元素，多余部分值用null代替。
+ * 如果值多于键，忽略多余的值。 + * + * @param 键类型 + * @param 值类型 + * @param keys 键列表 + * @param values 值列表 + * @return 标题内容Map + * @since 3.1.0 + */ + public static Map toMap(Iterator keys, Iterator values) { + return toMap(keys, values, false); + } + + /** + * 将键列表和值列表转换为Map
+ * 以键为准，值与键位置需对应。如果键元素数多于值元素，多余部分值用null代替。
+ * 如果值多于键，忽略多余的值。 + * + * @param 键类型 + * @param 值类型 + * @param keys 键列表 + * @param values 值列表 + * @param isOrder 是否有序 + * @return 标题内容Map + * @since 4.1.12 + */ + public static Map toMap(Iterator keys, Iterator values, boolean isOrder) { + final Map resultMap = MapUtil.newHashMap(isOrder); + if (isNotEmpty(keys)) { + while (keys.hasNext()) { + resultMap.put(keys.next(), (null != values && values.hasNext()) ? values.next() : null); + } + } + return resultMap; + } + + /** + * 将列表转成值为List的HashMap + * + * @param iterable 值列表 + * @param keyMapper Map的键映射 + * @param 键类型 + * @param 值类型 + * @return HashMap + * @since 5.3.6 + */ + public static Map> toListMap(Iterable iterable, Function keyMapper) { + return toListMap(iterable, keyMapper, v -> v); + } + + /** + * 将列表转成值为List的HashMap + * + * @param iterable 值列表 + * @param keyMapper Map的键映射 + * @param valueMapper Map中List的值映射 + * @param 列表值类型 + * @param 键类型 + * @param 值类型 + * @return HashMap + * @since 5.3.6 + */ + public static Map> toListMap(Iterable iterable, Function keyMapper, Function valueMapper) { + return toListMap(MapUtil.newHashMap(), iterable, keyMapper, valueMapper); + } + + /** + * 将列表转成值为List的HashMap + * + * @param resultMap 结果Map，可自定义结果Map类型 + * @param iterable 值列表 + * @param keyMapper Map的键映射 + * @param valueMapper Map中List的值映射 + * @param 列表值类型 + * @param 键类型 + * @param 值类型 + * @return HashMap + * @since 5.3.6 + */ + public static Map> toListMap(Map> resultMap, Iterable iterable, Function keyMapper, Function valueMapper) { + if (null == resultMap) { + resultMap = MapUtil.newHashMap(); + } + if (ObjectUtil.isNull(iterable)) { + return resultMap; + } + + for (T value : iterable) { + resultMap.computeIfAbsent(keyMapper.apply(value), k -> new ArrayList<>()).add(valueMapper.apply(value)); + } + + return resultMap; + } + + /** + * 将列表转成HashMap + * + * @param iterable 值列表 + * @param keyMapper Map的键映射 + * @param 键类型 + * @param 值类型 + * @return HashMap + * @since 5.3.6 + */ + public static Map toMap(Iterable iterable, Function keyMapper) { + return toMap(iterable, keyMapper, v -> v); + } + + /** + * 将列表转成HashMap + * + * @param iterable 值列表 + * @param keyMapper Map的键映射 + * @param valueMapper Map的值映射 + * @param 列表值类型 + * @param 键类型 + * @param 值类型 + * @return HashMap + * @since 5.3.6 + */ + public static Map toMap(Iterable iterable, Function keyMapper, Function valueMapper) { + return toMap(MapUtil.newHashMap(), iterable, keyMapper, valueMapper); + } + + /** + * 将列表转成Map + * + * @param resultMap 结果Map，通过传入map对象决定结果的Map类型 + * @param iterable 值列表 + * @param keyMapper Map的键映射 + * @param valueMapper Map的值映射 + * @param 列表值类型 + * @param 键类型 + * @param 值类型 + * @return HashMap + * @since 5.3.6 + */ + public static Map toMap(Map resultMap, Iterable iterable, Function keyMapper, Function valueMapper) { + if (null == resultMap) { + resultMap = MapUtil.newHashMap(); + } + if (ObjectUtil.isNull(iterable)) { + return resultMap; + } + + for (T value : iterable) { + resultMap.put(keyMapper.apply(value), valueMapper.apply(value)); + } + + return resultMap; + } + + /** + * Iterator转List
+ * 不判断，直接生成新的List + * + * @param 元素类型 + * @param iter {@link Iterator} + * @return List + * @since 4.0.6 + */ + public static List toList(Iterable iter) { + if (null == iter) { + return null; + } + return toList(iter.iterator()); + } + + /** + * Iterator转List
+ * 不判断，直接生成新的List + * + * @param 元素类型 + * @param iter {@link Iterator} + * @return List + * @since 4.0.6 + */ + public static List toList(Iterator iter) { + return ListUtil.toList(iter); + } + + /** + * Enumeration转换为Iterator + *

+ * Adapt the specified {@code Enumeration} to the {@code Iterator} interface + * + * @param 集合元素类型 + * @param e {@link Enumeration} + * @return {@link Iterator} + */ + public static Iterator asIterator(Enumeration e) { + return new EnumerationIter<>(e); + } + + /** + * {@link Iterator} 转为 {@link Iterable} + * + * @param 元素类型 + * @param iter {@link Iterator} + * @return {@link Iterable} + */ + public static Iterable asIterable(final Iterator iter) { + return () -> iter; + } + + /** + * 遍历{@link Iterator}，获取指定index位置的元素 + * + * @param iterator {@link Iterator} + * @param index 位置 + * @param 元素类型 + * @return 元素，找不到元素返回{@code null} + * @since 5.8.0 + */ + public static E get(final Iterator iterator, int index) throws IndexOutOfBoundsException { + if(null == iterator){ + return null; + } + Assert.isTrue(index >= 0, "[index] must be >= 0"); + while (iterator.hasNext()) { + index--; + if (-1 == index) { + return iterator.next(); + } + iterator.next(); + } + return null; + } + + /** + * 获取集合的第一个元素，如果集合为空（null或者空集合），返回{@code null} + * + * @param 集合元素类型 + * @param iterable {@link Iterable} + * @return 第一个元素，为空返回{@code null} + */ + public static T getFirst(Iterable iterable) { + if (iterable instanceof List) { + final List list = (List) iterable; + return CollUtil.isEmpty(list) ? null: list.get(0); + } + + return getFirst(getIter(iterable)); + } + + /** + * 获取集合的第一个非空元素 + * + * @param 集合元素类型 + * @param iterable {@link Iterable} + * @return 第一个元素 + * @since 5.7.2 + */ + public static T getFirstNoneNull(Iterable iterable) { + if (null == iterable) { + return null; + } + return getFirstNoneNull(iterable.iterator()); + } + + /** + * 获取集合的第一个元素 + * + * @param 集合元素类型 + * @param iterator {@link Iterator} + * @return 第一个元素 + */ + public static T getFirst(Iterator iterator) { + return get(iterator, 0); + } + + /** + * 获取集合的第一个非空元素 + * + * @param 集合元素类型 + * @param iterator {@link Iterator} + * @return 第一个非空元素，null表示未找到 + * @since 5.7.2 + */ + public static T getFirstNoneNull(Iterator iterator) { + return firstMatch(iterator, Objects::nonNull); + } + + /** + * 返回{@link Iterator}中第一个匹配规则的值 + * + * @param 数组元素类型 + * @param iterator {@link Iterator} + * @param matcher 匹配接口，实现此接口自定义匹配规则 + * @return 匹配元素，如果不存在匹配元素或{@link Iterator}为空，返回 {@code null} + * @since 5.7.5 + */ + public static T firstMatch(Iterator iterator, Matcher matcher) { + Assert.notNull(matcher, "Matcher must be not null !"); + if (null != iterator) { + while (iterator.hasNext()) { + final T next = iterator.next(); + if (matcher.match(next)) { + return next; + } + } + } + return null; + } + + /** + * 获得{@link Iterable}对象的元素类型（通过第一个非空元素判断）
+ * 注意，此方法至少会调用多次next方法 + * + * @param iterable {@link Iterable} + * @return 元素类型，当列表为空或元素全部为null时，返回null + */ + public static Class getElementType(Iterable iterable) { + return getElementType(getIter(iterable)); + } + + /** + * 获得{@link Iterator}对象的元素类型（通过第一个非空元素判断）
+ * 注意，此方法至少会调用多次next方法 + * + * @param iterator {@link Iterator}，为 {@code null}返回{@code null} + * @return 元素类型，当列表为空或元素全部为{@code null}时，返回{@code null} + */ + public static Class getElementType(Iterator iterator) { + if (null == iterator) { + return null; + } + final Object ele = getFirstNoneNull(iterator); + return null == ele ? null : ele.getClass(); + } + + /** + * 编辑，此方法产生一个新{@link ArrayList}
+ * 编辑过程通过传入的Editor实现来返回需要的元素内容，这个Editor实现可以实现以下功能： + * + * 

+	 * 1、过滤出需要的对象，如果返回null表示这个元素对象抛弃
+	 * 2、修改元素对象，返回集合中为修改后的对象
+	 *
+ * + * @param 集合元素类型 + * @param iter 集合 + * @param editor 编辑器接口, {@code null}表示不编辑 + * @return 过滤后的集合 + * @since 5.7.1 + */ + public static List edit(Iterable iter, Editor editor) { + final List result = new ArrayList<>(); + if (null == iter) { + return result; + } + + T modified; + for (T t : iter) { + modified = (null == editor) ? t : editor.edit(t); + if (null != modified) { + result.add(modified); + } + } + return result; + } + + /** + * 过滤集合，此方法在原集合上直接修改
+ * 通过实现Filter接口，完成元素的过滤，这个Filter实现可以实现以下功能： + * + * 
+	 * 1、过滤出需要的对象，{@link Filter#accept(Object)}方法返回false的对象将被使用{@link Iterator#remove()}方法移除
+	 *
+ * + * @param 集合类型 + * @param 集合元素类型 + * @param iter 集合 + * @param filter 过滤器接口 + * @return 编辑后的集合 + * @since 4.6.5 + */ + public static , E> T filter(T iter, Filter filter) { + if (null == iter) { + return null; + } + + filter(iter.iterator(), filter); + + return iter; + } + + /** + * 过滤集合，此方法在原集合上直接修改
+ * 通过实现Filter接口，完成元素的过滤，这个Filter实现可以实现以下功能： + * + * 
+	 * 1、过滤出需要的对象，{@link Filter#accept(Object)}方法返回false的对象将被使用{@link Iterator#remove()}方法移除
+	 *
+ * + * @param 集合元素类型 + * @param iter 集合 + * @param filter 过滤器接口，删除{@link Filter#accept(Object)}为{@code false}的元素 + * @return 编辑后的集合 + * @since 4.6.5 + */ + public static Iterator filter(Iterator iter, Filter filter) { + if (null == iter || null == filter) { + return iter; + } + + while (iter.hasNext()) { + if (false == filter.accept(iter.next())) { + iter.remove(); + } + } + return iter; + } + + /** + * 过滤{@link Iterator}并将过滤后满足条件的元素添加到List中 + * + * @param 元素类型 + * @param iter {@link Iterator} + * @param filter 过滤器，保留{@link Filter#accept(Object)}为{@code true}的元素 + * @return ArrayList + * @since 5.7.22 + */ + public static List filterToList(Iterator iter, Filter filter) { + return toList(filtered(iter, filter)); + } + + /** + * 获取一个新的 {@link FilterIter}，用于过滤指定元素 + * + * @param iterator 被包装的 {@link Iterator} + * @param filter 过滤断言，当{@link Filter#accept(Object)}为{@code true}时保留元素，{@code false}抛弃元素 + * @param 元素类型 + * @return {@link FilterIter} + * @since 5.8.0 + */ + public static FilterIter filtered(final Iterator iterator, final Filter filter) { + return new FilterIter<>(iterator, filter); + } + + /** + * Iterator转换为Map，转换规则为：
+ * 按照keyFunc函数规则根据元素对象生成Key，元素作为值 + * + * @param Map键类型 + * @param Map值类型 + * @param iterator 数据列表 + * @param map Map对象，转换后的键值对加入此Map，通过传入此对象自定义Map类型 + * @param keyFunc 生成key的函数 + * @return 生成的map + * @since 5.2.6 + */ + public static Map toMap(Iterator iterator, Map map, Func1 keyFunc) { + return toMap(iterator, map, keyFunc, (value) -> value); + } + + /** + * 集合转换为Map，转换规则为：
+ * 按照keyFunc函数规则根据元素对象生成Key，按照valueFunc函数规则根据元素对象生成value组成新的Map + * + * @param Map键类型 + * @param Map值类型 + * @param 元素类型 + * @param iterator 数据列表 + * @param map Map对象，转换后的键值对加入此Map，通过传入此对象自定义Map类型 + * @param keyFunc 生成key的函数 + * @param valueFunc 生成值的策略函数 + * @return 生成的map + * @since 5.2.6 + */ + public static Map toMap(Iterator iterator, Map map, Func1 keyFunc, Func1 valueFunc) { + if (null == iterator) { + return map; + } + + if (null == map) { + map = MapUtil.newHashMap(true); + } + + E element; + while (iterator.hasNext()) { + element = iterator.next(); + try { + map.put(keyFunc.call(element), valueFunc.call(element)); + } catch (Exception e) { + throw new UtilException(e); + } + } + return map; + } + + /** + * 返回一个空Iterator + * + * @param 元素类型 + * @return 空Iterator + * @see Collections#emptyIterator() + * @since 5.3.1 + */ + public static Iterator empty() { + return Collections.emptyIterator(); + } + + /** + * 按照给定函数，转换{@link Iterator}为另一种类型的{@link Iterator} + * + * @param 源元素类型 + * @param 目标元素类型 + * @param iterator 源{@link Iterator} + * @param function 转换函数 + * @return 转换后的{@link Iterator} + * @since 5.4.3 + */ + public static Iterator trans(Iterator iterator, Function function) { + return new TransIter<>(iterator, function); + } + + /** + * 返回 Iterable 对象的元素数量 + * + * @param iterable Iterable对象 + * @return Iterable对象的元素数量 + * @since 5.5.0 + */ + public static int size(Iterable iterable) { + if (null == iterable) { + return 0; + } + + if (iterable instanceof Collection) { + return ((Collection) iterable).size(); + } else { + return size(iterable.iterator()); + } + } + + /** + * 返回 Iterator 对象的元素数量 + * + * @param iterator Iterator对象 + * @return Iterator对象的元素数量 + * @since 5.5.0 + */ + public static int size(Iterator iterator) { + int size = 0; + if (iterator != null) { + while (iterator.hasNext()) { + iterator.next(); + size++; + } + } + return size; + } + + /** + * 判断两个{@link Iterable} 是否元素和顺序相同，返回{@code true}的条件是： + *
    + *
  • 两个{@link Iterable}必须长度相同
    • + *
  • 两个{@link Iterable}元素相同index的对象必须equals，满足{@link Objects#equals(Object, Object)}
    • + *
+ * 此方法来自Apache-Commons-Collections4。 + * + * @param list1 列表1 + * @param list2 列表2 + * @return 是否相同 + * @since 5.6.0 + */ + public static boolean isEqualList(Iterable list1, Iterable list2) { + if (list1 == list2) { + return true; + } + + final Iterator it1 = list1.iterator(); + final Iterator it2 = list2.iterator(); + Object obj1; + Object obj2; + while (it1.hasNext() && it2.hasNext()) { + obj1 = it1.next(); + obj2 = it2.next(); + + if (false == Objects.equals(obj1, obj2)) { + return false; + } + } + + // 当两个Iterable长度不一致时返回false + return false == (it1.hasNext() || it2.hasNext()); + } + + /** + * 清空指定{@link Iterator}，此方法遍历后调用{@link Iterator#remove()}移除每个元素 + * + * @param iterator {@link Iterator} + * @since 5.7.23 + */ + public static void clear(Iterator iterator) { + if (null != iterator) { + while (iterator.hasNext()) { + iterator.next(); + iterator.remove(); + } + } + } + + /** + * 遍历{@link Iterator}
+ * 当consumer为{@code null}表示不处理，但是依旧遍历{@link Iterator} + * + * @param iterator {@link Iterator} + * @param consumer 节点消费，{@code null}表示不处理 + * @param 元素类型 + * @since 5.8.0 + */ + public static void forEach(final Iterator iterator, final Consumer consumer) { + if (iterator != null) { + while (iterator.hasNext()) { + final E element = iterator.next(); + if (null != consumer) { + consumer.accept(element); + } + } + } + } + + /** + * 拼接 {@link Iterator}为字符串 + * + * @param iterator {@link Iterator} + * @param 元素类型 + * @return 字符串 + * @since 5.8.0 + */ + public static String toStr(final Iterator iterator) { + return toStr(iterator, ObjectUtil::toString); + } + + /** + * 拼接 {@link Iterator}为字符串 + * + * @param iterator {@link Iterator} + * @param transFunc 元素转字符串函数 + * @param 元素类型 + * @return 字符串 + * @since 5.8.0 + */ + public static String toStr(final Iterator iterator, final Function transFunc) { + return toStr(iterator, transFunc, ", ", "[", "]"); + } + + /** + * 拼接 {@link Iterator}为字符串 + * + * @param iterator {@link Iterator} + * @param transFunc 元素转字符串函数 + * @param delimiter 分隔符 + * @param prefix 前缀 + * @param suffix 后缀 + * @param 元素类型 + * @return 字符串 + * @since 5.8.0 + */ + public static String toStr(final Iterator iterator, + final Function transFunc, + final String delimiter, + final String prefix, + final String suffix) { + final StrJoiner strJoiner = StrJoiner.of(delimiter, prefix, suffix); + strJoiner.append(iterator, transFunc); + return strJoiner.toString(); + } + + /** + * 从给定的对象中获取可能存在的{@link Iterator}，规则如下： + *
    + *
  • null - null
    • + *
  • Iterator - 直接返回
    • + *
  • Enumeration - {@link EnumerationIter}
    • + *
  • Collection - 调用{@link Collection#iterator()}
    • + *
  • Map - Entry的{@link Iterator}
    • + *
  • Dictionary - values (elements) enumeration returned as iterator
    • + *
  • array - {@link ArrayIter}
    • + *
  • NodeList - {@link NodeListIter}
    • + *
  • Node - 子节点
    • + *
  • object with iterator() public method，通过反射访问
    • + *
  • object - 单对象的{@link ArrayIter}
    • + *
+ * + * @param obj 可以获取{@link Iterator}的对象 + * @return {@link Iterator}，如果提供对象为{@code null}，返回{@code null} + */ + public static Iterator getIter(final Object obj) { + if (obj == null) { + return null; + } else if (obj instanceof Iterator) { + return (Iterator) obj; + } else if (obj instanceof Iterable) { + return ((Iterable) obj).iterator(); + } else if (ArrayUtil.isArray(obj)) { + return new ArrayIter<>(obj); + } else if (obj instanceof Enumeration) { + return new EnumerationIter<>((Enumeration) obj); + } else if (obj instanceof Map) { + return ((Map) obj).entrySet().iterator(); + } else if (obj instanceof NodeList) { + return new NodeListIter((NodeList) obj); + } else if (obj instanceof Node) { + // 遍历子节点 + return new NodeListIter(((Node) obj).getChildNodes()); + } else if (obj instanceof Dictionary) { + return new EnumerationIter<>(((Dictionary) obj).elements()); + } + + // 反射获取 + try { + final Object iterator = ReflectUtil.invoke(obj, "iterator"); + if (iterator instanceof Iterator) { + return (Iterator) iterator; + } + } catch (final RuntimeException ignore) { + // ignore + } + return new ArrayIter<>(new Object[]{obj}); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/IterableIter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/IterableIter.java new file mode 100644 index 0000000..605231a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/IterableIter.java @@ -0,0 +1,18 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import java.util.Iterator; + +/** + * 提供合成接口，共同提供{@link Iterable}和{@link Iterator}功能 + * + * @param 节点类型 + * @author looly + * @since 5.7.14 + */ +public interface IterableIter extends Iterable, Iterator { + + @Override + default Iterator iterator() { + return this; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/IteratorEnumeration.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/IteratorEnumeration.java new file mode 100644 index 0000000..8af71c2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/IteratorEnumeration.java @@ -0,0 +1,37 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import java.io.Serializable; +import java.util.Enumeration; +import java.util.Iterator; + +/** + * {@link Iterator}对象转{@link Enumeration} + * @author Looly + * + * @param 元素类型 + * @since 3.0.8 + */ +public class IteratorEnumeration implements Enumeration, Serializable{ + private static final long serialVersionUID = 1L; + + private final Iterator iterator; + + /** + * 构造 + * @param iterator {@link Iterator}对象 + */ + public IteratorEnumeration(Iterator iterator) { + this.iterator = iterator; + } + + @Override + public boolean hasMoreElements() { + return iterator.hasNext(); + } + + @Override + public E nextElement() { + return iterator.next(); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/LineIter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/LineIter.java new file mode 100644 index 0000000..e196a53 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/LineIter.java @@ -0,0 +1,101 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.io.BufferedReader; +import java.io.Closeable; +import java.io.IOException; +import java.io.InputStream; +import java.io.Reader; +import java.io.Serializable; +import java.nio.charset.Charset; + +/** + * 将Reader包装为一个按照行读取的Iterator
+ * 此对象遍历结束后，应关闭之，推荐使用方式: + * + * 
+ * LineIterator it = null;
+ * try {
+ * 	it = new LineIterator(reader);
+ * 	while (it.hasNext()) {
+ * 		String line = it.nextLine();
+ * 		// do something with line
+ * 	}
+ * } finally {
+ * 		it.close();
+ * }
+ *
+ * + * 此类来自于Apache Commons io + * + * @author looly + * @since 4.1.1 + */ +public class LineIter extends ComputeIter implements IterableIter, Closeable, Serializable { + private static final long serialVersionUID = 1L; + + private final BufferedReader bufferedReader; + + /** + * 构造 + * + * @param in {@link InputStream} + * @param charset 编码 + * @throws IllegalArgumentException reader为null抛出此异常 + */ + public LineIter(InputStream in, Charset charset) throws IllegalArgumentException { + this(IoUtil.getReader(in, charset)); + } + + /** + * 构造 + * + * @param reader {@link Reader}对象，不能为null + * @throws IllegalArgumentException reader为null抛出此异常 + */ + public LineIter(Reader reader) throws IllegalArgumentException { + Assert.notNull(reader, "Reader must not be null"); + this.bufferedReader = IoUtil.getReader(reader); + } + + // ----------------------------------------------------------------------- + @Override + protected String computeNext() { + try { + while (true) { + String line = bufferedReader.readLine(); + if (line == null) { + return null; + } else if (isValidLine(line)) { + return line; + } + // 无效行，则跳过进入下一行 + } + } catch (IOException ioe) { + close(); + throw new IORuntimeException(ioe); + } + } + + /** + * 关闭Reader + */ + @Override + public void close() { + super.finish(); + IoUtil.close(bufferedReader); + } + + /** + * 重写此方法来判断是否每一行都被返回，默认全部为true + * + * @param line 需要验证的行 + * @return 是否通过验证 + */ + protected boolean isValidLine(String line) { + return true; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ListUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ListUtil.java new file mode 100755 index 0000000..97e41e5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ListUtil.java @@ -0,0 +1,677 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.comparator.PinyinComparator; +import aiyh.utils.tool.cn.hutool.core.comparator.PropertyComparator; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Matcher; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.PageUtil; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.Comparator; +import java.util.Enumeration; +import java.util.Iterator; +import java.util.LinkedList; +import java.util.List; +import java.util.RandomAccess; +import java.util.concurrent.CopyOnWriteArrayList; +import java.util.function.Consumer; + +/** + * List相关工具类 + * + * @author looly + */ +public class ListUtil { + /** + * 新建一个空List + * + * @param 集合元素类型 + * @param isLinked 是否新建LinkedList + * @return List对象 + * @since 4.1.2 + */ + public static List list(boolean isLinked) { + return isLinked ? new LinkedList<>() : new ArrayList<>(); + } + + /** + * 新建一个List + * + * @param 集合元素类型 + * @param isLinked 是否新建LinkedList + * @param values 数组 + * @return List对象 + * @since 4.1.2 + */ + @SafeVarargs + public static List list(boolean isLinked, T... values) { + if (ArrayUtil.isEmpty(values)) { + return list(isLinked); + } + final List arrayList = isLinked ? new LinkedList<>() : new ArrayList<>(values.length); + Collections.addAll(arrayList, values); + return arrayList; + } + + /** + * 新建一个List + * + * @param 集合元素类型 + * @param isLinked 是否新建LinkedList + * @param collection 集合 + * @return List对象 + * @since 4.1.2 + */ + public static List list(boolean isLinked, Collection collection) { + if (null == collection) { + return list(isLinked); + } + return isLinked ? new LinkedList<>(collection) : new ArrayList<>(collection); + } + + /** + * 新建一个List
+ * 提供的参数为null时返回空{@link ArrayList} + * + * @param 集合元素类型 + * @param isLinked 是否新建LinkedList + * @param iterable {@link Iterable} + * @return List对象 + * @since 4.1.2 + */ + public static List list(boolean isLinked, Iterable iterable) { + if (null == iterable) { + return list(isLinked); + } + return list(isLinked, iterable.iterator()); + } + + /** + * 新建一个List
+ * 提供的参数为null时返回空{@link ArrayList} + * + * @param 集合元素类型 + * @param isLinked 是否新建LinkedList + * @param iter {@link Iterator} + * @return ArrayList对象 + * @since 4.1.2 + */ + public static List list(boolean isLinked, Iterator iter) { + final List list = list(isLinked); + if (null != iter) { + while (iter.hasNext()) { + list.add(iter.next()); + } + } + return list; + } + + /** + * 新建一个List
+ * 提供的参数为null时返回空{@link ArrayList} + * + * @param 集合元素类型 + * @param isLinked 是否新建LinkedList + * @param enumration {@link Enumeration} + * @return ArrayList对象 + * @since 3.0.8 + */ + public static List list(boolean isLinked, Enumeration enumration) { + final List list = list(isLinked); + if (null != enumration) { + while (enumration.hasMoreElements()) { + list.add(enumration.nextElement()); + } + } + return list; + } + + /** + * 新建一个ArrayList + * + * @param 集合元素类型 + * @param values 数组 + * @return ArrayList对象 + */ + @SafeVarargs + public static ArrayList toList(T... values) { + return (ArrayList) list(false, values); + } + + /** + * 新建LinkedList + * + * @param values 数组 + * @param 类型 + * @return LinkedList + * @since 4.1.2 + */ + @SafeVarargs + public static LinkedList toLinkedList(T... values) { + return (LinkedList) list(true, values); + } + + /** + * 数组转为一个不可变List
+ * 类似于Java9中的List.of + * + * @param ts 对象 + * @param 对象类型 + * @return 不可修改List + * @since 5.4.3 + */ + @SafeVarargs + public static List of(T... ts) { + if (ArrayUtil.isEmpty(ts)) { + return Collections.emptyList(); + } + return Collections.unmodifiableList(toList(ts)); + } + + /** + * 新建一个CopyOnWriteArrayList + * + * @param 集合元素类型 + * @param collection 集合 + * @return {@link CopyOnWriteArrayList} + */ + public static CopyOnWriteArrayList toCopyOnWriteArrayList(Collection collection) { + return (null == collection) ? (new CopyOnWriteArrayList<>()) : (new CopyOnWriteArrayList<>(collection)); + } + + /** + * 新建一个ArrayList + * + * @param 集合元素类型 + * @param collection 集合 + * @return ArrayList对象 + */ + public static ArrayList toList(Collection collection) { + return (ArrayList) list(false, collection); + } + + /** + * 新建一个ArrayList
+ * 提供的参数为null时返回空{@link ArrayList} + * + * @param 集合元素类型 + * @param iterable {@link Iterable} + * @return ArrayList对象 + * @since 3.1.0 + */ + public static ArrayList toList(Iterable iterable) { + return (ArrayList) list(false, iterable); + } + + /** + * 新建一个ArrayList
+ * 提供的参数为null时返回空{@link ArrayList} + * + * @param 集合元素类型 + * @param iterator {@link Iterator} + * @return ArrayList对象 + * @since 3.0.8 + */ + public static ArrayList toList(Iterator iterator) { + return (ArrayList) list(false, iterator); + } + + /** + * 新建一个ArrayList
+ * 提供的参数为null时返回空{@link ArrayList} + * + * @param 集合元素类型 + * @param enumeration {@link Enumeration} + * @return ArrayList对象 + * @since 3.0.8 + */ + public static ArrayList toList(Enumeration enumeration) { + return (ArrayList) list(false, enumeration); + } + + /** + * 对指定List分页取值 + * + * @param 集合元素类型 + * @param pageNo 页码，第一页的页码取决于{@link PageUtil#getFirstPageNo()}，默认0 + * @param pageSize 每页的条目数 + * @param list 列表 + * @return 分页后的段落内容 + * @since 4.1.20 + */ + public static List page(int pageNo, int pageSize, List list) { + if (CollUtil.isEmpty(list)) { + return new ArrayList<>(0); + } + + int resultSize = list.size(); + // 每页条目数大于总数直接返回所有 + if (resultSize <= pageSize) { + if (pageNo < (PageUtil.getFirstPageNo() + 1)) { + return unmodifiable(list); + } else { + // 越界直接返回空 + return new ArrayList<>(0); + } + } + // 相乘可能会导致越界 临时用long + if (((long) (pageNo - PageUtil.getFirstPageNo()) * pageSize) > resultSize) { + // 越界直接返回空 + return new ArrayList<>(0); + } + + final int[] startEnd = PageUtil.transToStartEnd(pageNo, pageSize); + if (startEnd[1] > resultSize) { + startEnd[1] = resultSize; + if (startEnd[0] > startEnd[1]) { + return new ArrayList<>(0); + } + } + + return sub(list, startEnd[0], startEnd[1]); + } + + /** + * 对指定List进行分页，逐页返回数据 + * + * @param 集合元素类型 + * @param list 源数据列表 + * @param pageSize 每页的条目数 + * @param pageListConsumer 单页数据函数式返回 + * @since 5.7.10 + */ + public static void page(List list, int pageSize, Consumer> pageListConsumer) { + if (CollUtil.isEmpty(list) || pageSize <= 0) { + return; + } + + final int total = list.size(); + final int totalPage = PageUtil.totalPage(total, pageSize); + for (int pageNo = PageUtil.getFirstPageNo(); pageNo < totalPage + PageUtil.getFirstPageNo(); pageNo++) { + // 获取当前页在列表中对应的起止序号 + final int[] startEnd = PageUtil.transToStartEnd(pageNo, pageSize); + if (startEnd[1] > total) { + startEnd[1] = total; + } + + // 返回数据 + pageListConsumer.accept(sub(list, startEnd[0], startEnd[1])); + } + } + + /** + * 针对List排序，排序会修改原List + * + * @param 元素类型 + * @param list 被排序的List + * @param c {@link Comparator} + * @return 原list + * @see Collections#sort(List, Comparator) + */ + public static List sort(List list, Comparator c) { + if (CollUtil.isEmpty(list)) { + return list; + } + list.sort(c); + return list; + } + + /** + * 根据Bean的属性排序 + * + * @param 元素类型 + * @param list List + * @param property 属性名 + * @return 排序后的List + * @since 4.0.6 + */ + public static List sortByProperty(List list, String property) { + return sort(list, new PropertyComparator<>(property)); + } + + /** + * 根据汉字的拼音顺序排序 + * + * @param list List + * @return 排序后的List + * @since 4.0.8 + */ + public static List sortByPinyin(List list) { + return sort(list, new PinyinComparator()); + } + + /** + * 反序给定List，会在原List基础上直接修改 + * + * @param 元素类型 + * @param list 被反转的List + * @return 反转后的List + * @since 4.0.6 + */ + public static List reverse(List list) { + Collections.reverse(list); + return list; + } + + /** + * 反序给定List，会创建一个新的List，原List数据不变 + * + * @param 元素类型 + * @param list 被反转的List + * @return 反转后的List + * @since 4.0.6 + */ + public static List reverseNew(List list) { + List list2 = ObjectUtil.clone(list); + if (null == list2) { + // 不支持clone + list2 = new ArrayList<>(list); + } + return reverse(list2); + } + + /** + * 设置或增加元素。当index小于List的长度时，替换指定位置的值，否则在尾部追加 + * + * @param 元素类型 + * @param list List列表 + * @param index 位置 + * @param element 新元素 + * @return 原List + * @since 4.1.2 + */ + public static List setOrAppend(List list, int index, T element) { + Assert.notNull(list, "List must be not null !"); + if (index < list.size()) { + list.set(index, element); + } else { + list.add(element); + } + return list; + } + + /** + * 在指定位置设置元素。当index小于List的长度时，替换指定位置的值，否则追加{@code null}直到到达index后，设置值 + * + * @param 元素类型 + * @param list List列表 + * @param index 位置 + * @param element 新元素 + * @return 原List + * @since 5。8.4 + */ + public static List setOrPadding(List list, int index, T element) { + return setOrPadding(list, index, element, null); + } + + /** + * 在指定位置设置元素。当index小于List的长度时，替换指定位置的值，否则追加{@code paddingElement}直到到达index后，设置值 + * + * @param 元素类型 + * @param list List列表 + * @param index 位置 + * @param element 新元素 + * @param paddingElement 填充的值 + * @return 原List + * @since 5。8.4 + */ + public static List setOrPadding(List list, int index, T element, T paddingElement) { + Assert.notNull(list, "List must be not null !"); + final int size = list.size(); + if (index < size) { + list.set(index, element); + } else { + for (int i = size; i < index; i++) { + list.add(paddingElement); + } + list.add(element); + } + return list; + } + + /** + * 截取集合的部分 + * + * @param 集合元素类型 + * @param list 被截取的数组 + * @param start 开始位置（包含） + * @param end 结束位置（不包含） + * @return 截取后的数组，当开始位置超过最大时，返回空的List + */ + public static List + sub(List list, int start, int end) { + return sub(list, start, end, 1); + } + + /** + * 截取集合的部分
+ * 此方法与{@link List#subList(int, int)} 不同在于子列表是新的副本，操作子列表不会影响原列表。 + * + * @param 集合元素类型 + * @param list 被截取的数组 + * @param start 开始位置（包含） + * @param end 结束位置（不包含） + * @param step 步进 + * @return 截取后的数组，当开始位置超过最大时，返回空的List + * @since 4.0.6 + */ + public static List sub(List list, int start, int end, int step) { + if (list == null) { + return null; + } + + if (list.isEmpty()) { + return new ArrayList<>(0); + } + + final int size = list.size(); + if (start < 0) { + start += size; + } + if (end < 0) { + end += size; + } + if (start == size) { + return new ArrayList<>(0); + } + if (start > end) { + int tmp = start; + start = end; + end = tmp; + } + if (end > size) { + if (start >= size) { + return new ArrayList<>(0); + } + end = size; + } + + if (step < 1) { + step = 1; + } + + final List result = new ArrayList<>(); + for (int i = start; i < end; i += step) { + result.add(list.get(i)); + } + return result; + } + + /** + * 获取匹配规则定义中匹配到元素的最后位置
+ * 此方法对于某些无序集合的位置信息，以转换为数组后的位置为准。 + * + * @param 元素类型 + * @param list List集合 + * @param matcher 匹配器，为空则全部匹配 + * @return 最后一个位置 + * @since 5.6.6 + */ + public static int lastIndexOf(List list, Matcher matcher) { + if (null != list) { + final int size = list.size(); + if (size > 0) { + for (int i = size - 1; i >= 0; i--) { + if (null == matcher || matcher.match(list.get(i))) { + return i; + } + } + } + } + return -1; + } + + /** + * 获取匹配规则定义中匹配到元素的所有位置 + * + * @param 元素类型 + * @param list 列表 + * @param matcher 匹配器，为空则全部匹配 + * @return 位置数组 + * @since 5.2.5 + */ + public static int[] indexOfAll(List list, Matcher matcher) { + return CollUtil.indexOfAll(list, matcher); + } + + /** + * 将对应List转换为不可修改的List + * + * @param list List + * @param 元素类型 + * @return 不可修改List + * @since 5.2.6 + */ + public static List unmodifiable(List list) { + if (null == list) { + return null; + } + return Collections.unmodifiableList(list); + } + + /** + * 获取一个空List，这个空List不可变 + * + * @param 元素类型 + * @return 空的List + * @see Collections#emptyList() + * @since 5.2.6 + */ + public static List empty() { + return Collections.emptyList(); + } + + /** + * 通过传入分区长度，将指定列表分区为不同的块，每块区域的长度相同（最后一块可能小于长度）
+ * 分区是在原List的基础上进行的，返回的分区是不可变的抽象列表，原列表元素变更，分区中元素也会变更。 + * + *

+ * 需要特别注意的是，此方法调用{@link List#subList(int, int)}切分List， + * 此方法返回的是原List的视图，也就是说原List有变更，切分后的结果也会变更。 + *

+ * + * @param 集合元素类型 + * @param list 列表，为空时返回{@link #empty()} + * @param size 每个段的长度，当长度超过list长度时，size按照list长度计算，即只返回一个节点 + * @return 分段列表 + * @since 5.4.5 + */ + public static List> partition(List list, int size) { + if (CollUtil.isEmpty(list)) { + return empty(); + } + + return (list instanceof RandomAccess) + ? new RandomAccessPartition<>(list, size) + : new Partition<>(list, size); + } + + /** + * 对集合按照指定长度分段，每一个段为单独的集合，返回这个集合的列表 + * + *

+ * 需要特别注意的是，此方法调用{@link List#subList(int, int)}切分List， + * 此方法返回的是原List的视图，也就是说原List有变更，切分后的结果也会变更。 + *

+ * + * @param 集合元素类型 + * @param list 列表，为空时返回{@link #empty()} + * @param size 每个段的长度，当长度超过list长度时，size按照list长度计算，即只返回一个节点 + * @return 分段列表 + * @see #partition(List, int) + * @since 5.4.5 + */ + public static List> split(List list, int size) { + return partition(list, size); + } + + /** + * 将集合平均分成多个list，返回这个集合的列表 + *

例：

+ * 
+	 *     ListUtil.splitAvg(null, 3);	// []
+	 *     ListUtil.splitAvg(Arrays.asList(1, 2, 3, 4), 2);	// [[1, 2], [3, 4]]
+	 *     ListUtil.splitAvg(Arrays.asList(1, 2, 3), 5);	// [[1], [2], [3], [], []]
+	 *     ListUtil.splitAvg(Arrays.asList(1, 2, 3), 2);	// [[1, 2], [3]]
+	 *
+ * + * @param 集合元素类型 + * @param list 集合 + * @param limit 要均分成几个list + * @return 分段列表 + * @author lileming + * @since 5.7.10 + */ + public static List> splitAvg(List list, int limit) { + if (CollUtil.isEmpty(list)) { + return empty(); + } + + return (list instanceof RandomAccess) + ? new RandomAccessAvgPartition<>(list, limit) + : new AvgPartition<>(list, limit); + } + + /** + * 将指定元素交换到指定索引位置,其他元素的索引值不变
+ * 交换会修改原List
+ * 如果集合中有多个相同元素，只交换第一个找到的元素 + * + * @param 元素类型 + * @param list 列表 + * @param element 需交换元素 + * @param targetIndex 目标索引 + * @since 5.7.13 + */ + public static void swapTo(List list, T element, Integer targetIndex) { + if (CollUtil.isNotEmpty(list)) { + final int index = list.indexOf(element); + if (index >= 0) { + Collections.swap(list, index, targetIndex); + } + } + } + + /** + * 将指定元素交换到指定元素位置,其他元素的索引值不变
+ * 交换会修改原List
+ * 如果集合中有多个相同元素，只交换第一个找到的元素 + * + * @param 元素类型 + * @param list 列表 + * @param element 需交换元素 + * @param targetElement 目标元素 + */ + public static void swapElement(List list, T element, T targetElement) { + if (CollUtil.isNotEmpty(list)) { + final int targetIndex = list.indexOf(targetElement); + if (targetIndex >= 0) { + swapTo(list, element, targetIndex); + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/NodeListIter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/NodeListIter.java new file mode 100644 index 0000000..8a81869 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/NodeListIter.java @@ -0,0 +1,63 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import org.w3c.dom.Node; +import org.w3c.dom.NodeList; + +import java.util.Iterator; +import java.util.NoSuchElementException; + +/** + * 包装 {@link NodeList} 的{@link Iterator} + *

+ * 此 iterator 不支持 {@link #remove()} 方法。 + * + * @author apache commons,looly + * @see NodeList + * @since 5.8.0 + */ +public class NodeListIter implements ResettableIter { + + private final NodeList nodeList; + /** + * 当前位置索引 + */ + private int index = 0; + + /** + * 构造, 根据给定{@link NodeList} 创建{@code NodeListIterator} + * + * @param nodeList {@link NodeList}，非空 + */ + public NodeListIter(final NodeList nodeList) { + this.nodeList = Assert.notNull(nodeList, "NodeList must not be null."); + } + + @Override + public boolean hasNext() { + return nodeList != null && index < nodeList.getLength(); + } + + @Override + public Node next() { + if (nodeList != null && index < nodeList.getLength()) { + return nodeList.item(index++); + } + throw new NoSuchElementException("underlying nodeList has no more elements"); + } + + /** + * Throws {@link UnsupportedOperationException}. + * + * @throws UnsupportedOperationException always + */ + @Override + public void remove() { + throw new UnsupportedOperationException("remove() method not supported for a NodeListIterator."); + } + + @Override + public void reset() { + this.index = 0; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/Partition.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/Partition.java new file mode 100644 index 0000000..6c32e0a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/Partition.java @@ -0,0 +1,59 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.util.AbstractList; +import java.util.List; + +/** + * 列表分区或分段
+ * 通过传入分区长度，将指定列表分区为不同的块，每块区域的长度相同（最后一块可能小于长度）
+ * 分区是在原List的基础上进行的，返回的分区是不可变的抽象列表，原列表元素变更，分区中元素也会变更。 + * 参考：Guava的Lists#Partition + * + * @param 元素类型 + * @author looly, guava + * @since 5.7.10 + */ +public class Partition extends AbstractList> { + + protected final List list; + protected final int size; + + /** + * 列表分区 + * + * @param list 被分区的列表，非空 + * @param size 每个分区的长度，必须>0 + */ + public Partition(List list, int size) { + this.list = Assert.notNull(list); + this.size = Math.min(list.size(), size); + } + + @Override + public List get(int index) { + final int start = index * size; + final int end = Math.min(start + size, list.size()); + return list.subList(start, end); + } + + @Override + public int size() { + // 此处采用动态计算，以应对list变 + final int size = this.size; + if(0 == size){ + return 0; + } + + final int total = list.size(); + // 类似于判断余数，当总数非整份size时，多余的数>=1，则相当于被除数多一个size，做到+1目的 + // 类似于：if(total % size > 0){length += 1;} + return (total + size - 1) / size; + } + + @Override + public boolean isEmpty() { + return list.isEmpty(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/PartitionIter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/PartitionIter.java new file mode 100644 index 0000000..5980927 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/PartitionIter.java @@ -0,0 +1,59 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +/** + * 分批迭代工具，可以分批处理数据 + *

    + *
  1. 比如调用其他客户的接口，传入的入参有限，需要分批
    2. + *
  2. 比如mysql/oracle用in语句查询，超过1000可以分批
    3. + *
  3. 比如数据库取出游标，可以把游标里的数据一批一批处理
    4. + *
+ * + * @param 字段类型 + * @author qiqi.chen + * @since 5.7.10 + */ +public class PartitionIter implements IterableIter>, Serializable { + private static final long serialVersionUID = 1L; + + /** + * 被分批的迭代器 + */ + protected final Iterator iterator; + /** + * 实际每批大小 + */ + protected final int partitionSize; + + /** + * 创建分组对象 + * + * @param iterator 迭代器 + * @param partitionSize 每批大小，最后一批不满一批算一批 + */ + public PartitionIter(Iterator iterator, int partitionSize) { + this.iterator = iterator; + this.partitionSize = partitionSize; + } + + @Override + public boolean hasNext() { + return this.iterator.hasNext(); + } + + @Override + public List next() { + final List list = new ArrayList<>(this.partitionSize); + for (int i = 0; i < this.partitionSize; i++) { + if (false == iterator.hasNext()) { + break; + } + list.add(iterator.next()); + } + return list; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/RandomAccessAvgPartition.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/RandomAccessAvgPartition.java new file mode 100644 index 0000000..a15c983 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/RandomAccessAvgPartition.java @@ -0,0 +1,32 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import java.util.List; +import java.util.RandomAccess; + +/** + * 列表分区或分段（可随机访问列表）
+ * 通过传入分区个数，将指定列表分区为不同的块，每块区域的长度均匀分布（个数差不超过1）
+ * 
+ *     [1,2,3,4] -》 [1,2], [3, 4]
+ *     [1,2,3,4] -》 [1,2], [3], [4]
+ *     [1,2,3,4] -》 [1], [2], [3], [4]
+ *     [1,2,3,4] -》 [1], [2], [3], [4], []
+ *
+ * 分区是在原List的基础上进行的，返回的分区是不可变的抽象列表，原列表元素变更，分区中元素也会变更。 + * + * @param 元素类型 + * @author looly + * @since 5.7.10 + */ +public class RandomAccessAvgPartition extends AvgPartition implements RandomAccess { + + /** + * 列表分区 + * + * @param list 被分区的列表 + * @param limit 分区个数 + */ + public RandomAccessAvgPartition(List list, int limit) { + super(list, limit); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/RandomAccessPartition.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/RandomAccessPartition.java new file mode 100644 index 0000000..1208b37 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/RandomAccessPartition.java @@ -0,0 +1,27 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import java.util.List; +import java.util.RandomAccess; + +/** + * 列表分区或分段（可随机访问列表）
+ * 通过传入分区长度，将指定列表分区为不同的块，每块区域的长度相同（最后一块可能小于长度）
+ * 分区是在原List的基础上进行的，返回的分区是不可变的抽象列表，原列表元素变更，分区中元素也会变更。 + * 参考：Guava的Lists#RandomAccessPartition + * + * @param 元素类型 + * @author looly, guava + * @since 5.7.10 + */ +public class RandomAccessPartition extends Partition implements RandomAccess { + + /** + * 构造 + * + * @param list 被分区的列表，必须实现{@link RandomAccess} + * @param size 每个分区的长度 + */ + public RandomAccessPartition(List list, int size) { + super(list, size); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ResettableIter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ResettableIter.java new file mode 100644 index 0000000..977ee37 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/ResettableIter.java @@ -0,0 +1,18 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import java.util.Iterator; + +/** + * 支持重置的{@link Iterator} 接口
+ * 通过实现{@link #reset()}，重置此{@link Iterator}后可实现复用重新遍历 + * + * @param 元素类型 + * @since 5.8.0 + */ +public interface ResettableIter extends Iterator { + + /** + * 重置，重置后可重新遍历 + */ + void reset(); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/RingIndexUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/RingIndexUtil.java new file mode 100644 index 0000000..4e83e2b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/RingIndexUtil.java @@ -0,0 +1,80 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicLong; + +/** + * 集合索引环形获取工具类 + * + * @author ZhouChuGang + * @since 5.7.15 + */ +public class RingIndexUtil { + + /** + * 通过cas操作 实现对指定值内的回环累加 + * + * @param object 集合 + *
    + *
  • Collection - the collection size + *
  • Map - the map size + *
  • Array - the array size + *
  • Iterator - the number of elements remaining in the iterator + *
  • Enumeration - the number of elements remaining in the enumeration + *
+ * @param atomicInteger 原子操作类 + * @return 索引位置 + */ + public static int ringNextIntByObj(Object object, AtomicInteger atomicInteger) { + Assert.notNull(object); + int modulo = CollUtil.size(object); + return ringNextInt(modulo, atomicInteger); + } + + /** + * 通过cas操作 实现对指定值内的回环累加 + * + * @param modulo 回环周期值 + * @param atomicInteger 原子操作类 + * @return 索引位置 + */ + public static int ringNextInt(int modulo, AtomicInteger atomicInteger) { + Assert.notNull(atomicInteger); + Assert.isTrue(modulo > 0); + if (modulo <= 1) { + return 0; + } + for (; ; ) { + int current = atomicInteger.get(); + int next = (current + 1) % modulo; + if (atomicInteger.compareAndSet(current, next)) { + return next; + } + } + } + + /** + * 通过cas操作 实现对指定值内的回环累加
+ * 此方法一般用于大量数据完成回环累加（如数据库中的值大于int最大值） + * + * @param modulo 回环周期值 + * @param atomicLong 原子操作类 + * @return 索引位置 + */ + public static long ringNextLong(long modulo, AtomicLong atomicLong) { + Assert.notNull(atomicLong); + Assert.isTrue(modulo > 0); + if (modulo <= 1) { + return 0; + } + for (; ; ) { + long current = atomicLong.get(); + long next = (current + 1) % modulo; + if (atomicLong.compareAndSet(current, next)) { + return next; + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/SpliteratorUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/SpliteratorUtil.java new file mode 100644 index 0000000..cb44952 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/SpliteratorUtil.java @@ -0,0 +1,26 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import java.util.Spliterator; +import java.util.function.Function; + +/** + * {@link Spliterator}相关工具类 + * + * @author looly + * @since 5.4.3 + */ +public class SpliteratorUtil { + + /** + * 使用给定的转换函数，转换源{@link Spliterator}为新类型的{@link Spliterator} + * + * @param 源元素类型 + * @param 目标元素类型 + * @param fromSpliterator 源{@link Spliterator} + * @param function 转换函数 + * @return 新类型的{@link Spliterator} + */ + public static Spliterator trans(Spliterator fromSpliterator, Function function) { + return new TransSpliterator<>(fromSpliterator, function); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/TransCollection.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/TransCollection.java new file mode 100755 index 0000000..fba34df --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/TransCollection.java @@ -0,0 +1,73 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.util.AbstractCollection; +import java.util.Collection; +import java.util.Iterator; +import java.util.Spliterator; +import java.util.function.Consumer; +import java.util.function.Function; +import java.util.function.Predicate; + +/** + * 使用给定的转换函数，转换源集合为新类型的集合 + * + * @param 源元素类型 + * @param 目标元素类型 + * @author looly + * @since 5.4.3 + */ +public class TransCollection extends AbstractCollection { + + private final Collection fromCollection; + private final Function function; + + /** + * 构造 + * + * @param fromCollection 源集合 + * @param function 转换函数 + */ + public TransCollection(Collection fromCollection, Function function) { + this.fromCollection = Assert.notNull(fromCollection); + this.function = Assert.notNull(function); + } + + @Override + public Iterator iterator() { + return IterUtil.trans(fromCollection.iterator(), function); + } + + @Override + public void clear() { + fromCollection.clear(); + } + + @Override + public boolean isEmpty() { + return fromCollection.isEmpty(); + } + + @Override + public void forEach(Consumer action) { + Assert.notNull(action); + fromCollection.forEach((f) -> action.accept(function.apply(f))); + } + + @Override + public boolean removeIf(Predicate filter) { + Assert.notNull(filter); + return fromCollection.removeIf(element -> filter.test(function.apply(element))); + } + + @Override + public Spliterator spliterator() { + return SpliteratorUtil.trans(fromCollection.spliterator(), function); + } + + @Override + public int size() { + return fromCollection.size(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/TransIter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/TransIter.java new file mode 100644 index 0000000..71ab27f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/TransIter.java @@ -0,0 +1,46 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.util.Iterator; +import java.util.function.Function; + +/** + * 使用给定的转换函数，转换源{@link Iterator}为新类型的{@link Iterator} + * + * @param 源元素类型 + * @param 目标元素类型 + * @author looly + * @since 5.4.3 + */ +public class TransIter implements Iterator { + + private final Iterator backingIterator; + private final Function func; + + /** + * 构造 + * + * @param backingIterator 源{@link Iterator} + * @param func 转换函数 + */ + public TransIter(final Iterator backingIterator, final Function func) { + this.backingIterator = Assert.notNull(backingIterator); + this.func = Assert.notNull(func); + } + + @Override + public final boolean hasNext() { + return backingIterator.hasNext(); + } + + @Override + public final T next() { + return func.apply(backingIterator.next()); + } + + @Override + public final void remove() { + backingIterator.remove(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/TransSpliterator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/TransSpliterator.java new file mode 100644 index 0000000..dd79926 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/TransSpliterator.java @@ -0,0 +1,51 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import java.util.Spliterator; +import java.util.function.Consumer; +import java.util.function.Function; + +/** + * 使用给定的转换函数，转换源{@link Spliterator}为新类型的{@link Spliterator} + * + * @param 源元素类型 + * @param 目标元素类型 + * @author looly + * @since 5.4.3 + */ +public class TransSpliterator implements Spliterator { + private final Spliterator fromSpliterator; + private final Function function; + + public TransSpliterator(Spliterator fromSpliterator, Function function) { + this.fromSpliterator = fromSpliterator; + this.function = function; + } + + @Override + public boolean tryAdvance(Consumer action) { + return fromSpliterator.tryAdvance( + fromElement -> action.accept(function.apply(fromElement))); + } + + @Override + public void forEachRemaining(Consumer action) { + fromSpliterator.forEachRemaining(fromElement -> action.accept(function.apply(fromElement))); + } + + @Override + public Spliterator trySplit() { + Spliterator fromSplit = fromSpliterator.trySplit(); + return (fromSplit != null) ? new TransSpliterator<>(fromSplit, function) : null; + } + + @Override + public long estimateSize() { + return fromSpliterator.estimateSize(); + } + + @Override + public int characteristics() { + return fromSpliterator.characteristics() + & ~(Spliterator.DISTINCT | Spliterator.NONNULL | Spliterator.SORTED); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/UniqueKeySet.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/UniqueKeySet.java new file mode 100755 index 0000000..181d053 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/UniqueKeySet.java @@ -0,0 +1,177 @@ +package aiyh.utils.tool.cn.hutool.core.collection; + +import aiyh.utils.tool.cn.hutool.core.map.MapBuilder; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.io.Serializable; +import java.util.AbstractSet; +import java.util.Collection; +import java.util.HashMap; +import java.util.Iterator; +import java.util.Map; +import java.util.function.Function; + +/** + * 唯一键的Set
+ * 通过自定义唯一键，通过{@link #uniqueGenerator}生成节点对象对应的键作为Map的key，确定唯一
+ * 此Set与HashSet不同的是，HashSet依赖于{@link Object#equals(Object)}确定唯一
+ * 但是很多时候我们无法对对象进行修改，此时在外部定义一个唯一规则，即可完成去重。 + * 
+ * {@code Set set = new UniqueKeySet<>(UniqueTestBean::getId);}
+ *
+ * + * @param 唯一键类型 + * @param 值对象 + * @author looly + * @since 5.7.23 + */ +public class UniqueKeySet extends AbstractSet implements Serializable { + private static final long serialVersionUID = 1L; + + private Map map; + private final Function uniqueGenerator; + + //region 构造 + + /** + * 构造 + * + * @param uniqueGenerator 唯一键生成规则函数，用于生成对象对应的唯一键 + */ + public UniqueKeySet(Function uniqueGenerator) { + this(false, uniqueGenerator); + } + + /** + * 构造 + * + * @param uniqueGenerator 唯一键生成规则函数，用于生成对象对应的唯一键 + * @param c 初始化加入的集合 + * @since 5.8.0 + */ + public UniqueKeySet(Function uniqueGenerator, Collection c) { + this(false, uniqueGenerator, c); + } + + /** + * 构造 + * + * @param isLinked 是否保持加入顺序 + * @param uniqueGenerator 唯一键生成规则函数，用于生成对象对应的唯一键 + */ + public UniqueKeySet(boolean isLinked, Function uniqueGenerator) { + this(MapBuilder.create(isLinked), uniqueGenerator); + } + + /** + * 构造 + * + * @param isLinked 是否保持加入顺序 + * @param uniqueGenerator 唯一键生成规则函数，用于生成对象对应的唯一键 + * @param c 初始化加入的集合 + * @since 5.8.0 + */ + public UniqueKeySet(boolean isLinked, Function uniqueGenerator, Collection c) { + this(isLinked, uniqueGenerator); + addAll(c); + } + + /** + * 构造 + * + * @param initialCapacity 初始容量 + * @param loadFactor 增长因子 + * @param uniqueGenerator 唯一键生成规则函数，用于生成对象对应的唯一键 + */ + public UniqueKeySet(int initialCapacity, float loadFactor, Function uniqueGenerator) { + this(MapBuilder.create(new HashMap<>(initialCapacity, loadFactor)), uniqueGenerator); + } + + /** + * 构造 + * + * @param builder 初始Map，定义了Map类型 + * @param uniqueGenerator 唯一键生成规则函数，用于生成对象对应的唯一键 + */ + public UniqueKeySet(MapBuilder builder, Function uniqueGenerator) { + this.map = builder.build(); + this.uniqueGenerator = uniqueGenerator; + } + + //endregion + + @Override + public Iterator iterator() { + return map.values().iterator(); + } + + @Override + public int size() { + return map.size(); + } + + @Override + public boolean isEmpty() { + return map.isEmpty(); + } + + @Override + public boolean contains(Object o) { + //noinspection unchecked + return map.containsKey(this.uniqueGenerator.apply((V) o)); + } + + @Override + public boolean add(V v) { + return null == map.put(this.uniqueGenerator.apply(v), v); + } + + /** + * 加入值，如果值已经存在，则忽略之 + * + * @param v 值 + * @return 是否成功加入 + */ + public boolean addIfAbsent(V v) { + return null == map.putIfAbsent(this.uniqueGenerator.apply(v), v); + } + + /** + * 加入集合中所有的值，如果值已经存在，则忽略之 + * + * @param c 集合 + * @return 是否有一个或多个被加入成功 + */ + public boolean addAllIfAbsent(Collection c) { + boolean modified = false; + for (V v : c) + if (addIfAbsent(v)) { + modified = true; + } + return modified; + } + + @Override + public boolean remove(Object o) { + //noinspection unchecked + return null != map.remove(this.uniqueGenerator.apply((V) o)); + } + + @Override + public void clear() { + map.clear(); + } + + @Override + @SuppressWarnings("unchecked") + public UniqueKeySet clone() { + try { + UniqueKeySet newSet = (UniqueKeySet) super.clone(); + newSet.map = ObjectUtil.clone(this.map); + return newSet; + } catch (CloneNotSupportedException e) { + throw new InternalError(e); + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/package-info.java new file mode 100644 index 0000000..92b7201 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/collection/package-info.java @@ -0,0 +1,7 @@ +/** + * 集合以及Iterator封装，包括集合工具CollUtil，Iterator和Iterable工具IterUtil + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.collection; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/BaseFieldComparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/BaseFieldComparator.java new file mode 100755 index 0000000..9ddf474 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/BaseFieldComparator.java @@ -0,0 +1,60 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; + +import java.io.Serializable; +import java.lang.reflect.Field; +import java.util.Comparator; + +/** + * Bean字段排序器
+ * 参阅feilong-core中的PropertyComparator + * + * @param 被比较的Bean + * @author jiangzeyin + * @deprecated 此类不再需要，使用FuncComparator代替更加灵活 + */ +@Deprecated +public abstract class BaseFieldComparator implements Comparator, Serializable { + private static final long serialVersionUID = -3482464782340308755L; + + /** + * 比较两个对象的同一个字段值 + * + * @param o1 对象1 + * @param o2 对象2 + * @param field 字段 + * @return 比较结果 + */ + protected int compareItem(T o1, T o2, Field field) { + if (o1 == o2) { + return 0; + } else if (null == o1) {// null 排在后面 + return 1; + } else if (null == o2) { + return -1; + } + + Comparable v1; + Comparable v2; + try { + v1 = (Comparable) ReflectUtil.getFieldValue(o1, field); + v2 = (Comparable) ReflectUtil.getFieldValue(o2, field); + } catch (Exception e) { + throw new ComparatorException(e); + } + + return compare(o1, o2, v1, v2); + } + + @SuppressWarnings({"rawtypes", "unchecked"}) + private int compare(T o1, T o2, Comparable fieldValue1, Comparable fieldValue2) { + int result = ObjectUtil.compare(fieldValue1, fieldValue2); + if (0 == result) { + //避免TreeSet / TreeMap 过滤掉排序字段相同但是对象不相同的情况 + result = CompareUtil.compare(o1, o2, true); + } + return result; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/ComparableComparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/ComparableComparator.java new file mode 100644 index 0000000..a877867 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/ComparableComparator.java @@ -0,0 +1,53 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import java.io.Serializable; +import java.util.Comparator; + +/** + * 针对 {@link Comparable}对象的默认比较器 + * + * @param 比较对象类型 + * @author Looly + * @since 3.0.7 + */ +public class ComparableComparator> implements Comparator, Serializable { + private static final long serialVersionUID = 3020871676147289162L; + + /** 单例 */ + @SuppressWarnings("rawtypes") + public static final ComparableComparator INSTANCE = new ComparableComparator<>(); + + /** + * 构造 + */ + public ComparableComparator() { + } + + /** + * 比较两个{@link Comparable}对象 + * + * 
+	 * obj1.compareTo(obj2)
+	 *
+ * + * @param obj1 被比较的第一个对象 + * @param obj2 the second object to compare + * @return obj1小返回负数，大返回正数，否则返回0 + * @throws NullPointerException obj1为{@code null}或者比较中抛出空指针异常 + */ + @Override + public int compare(final E obj1, final E obj2) { + return obj1.compareTo(obj2); + } + + @Override + public int hashCode() { + return "ComparableComparator".hashCode(); + } + + @Override + public boolean equals(final Object object) { + return this == object || null != object && object.getClass().equals(this.getClass()); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/ComparatorChain.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/ComparatorChain.java new file mode 100644 index 0000000..00ffa84 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/ComparatorChain.java @@ -0,0 +1,356 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import aiyh.utils.tool.cn.hutool.core.lang.Chain; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.BitSet; +import java.util.Comparator; +import java.util.Iterator; +import java.util.List; +import java.util.Objects; + +/** + * 比较器链。此链包装了多个比较器，最终比较结果按照比较器顺序综合多个比较器结果。
+ * 按照比较器链的顺序分别比较，如果比较出相等则转向下一个比较器，否则直接返回
+ * 此类copy from Apache-commons-collections + * + * @author looly + * @since 3.0.7 + */ +public class ComparatorChain implements Chain, ComparatorChain>, Comparator, Serializable { + private static final long serialVersionUID = -2426725788913962429L; + + /** + * 比较器链. + */ + private final List> chain; + /** + * 对应比较器位置是否反序. + */ + private final BitSet orderingBits; + /** + * 比较器是否被锁定。锁定的比较器链不能再添加新的比较器。比较器会在开始比较时开始加锁。 + */ + private boolean lock = false; + + //------------------------------------------------------------------------------------- Static method start + + /** + * 构建 {@link ComparatorChain} + * + * @param 被比较对象类型 + * @param comparator 比较器 + * @return {@link ComparatorChain} + * @since 5.4.3 + */ + public static ComparatorChain of(Comparator comparator) { + return of(comparator, false); + } + + /** + * 构建 {@link ComparatorChain} + * + * @param 被比较对象类型 + * @param comparator 比较器 + * @param reverse 是否反向 + * @return {@link ComparatorChain} + * @since 5.4.3 + */ + public static ComparatorChain of(Comparator comparator, boolean reverse) { + return new ComparatorChain<>(comparator, reverse); + } + + /** + * 构建 {@link ComparatorChain} + * + * @param 被比较对象类型 + * @param comparators 比较器数组 + * @return {@link ComparatorChain} + * @since 5.4.3 + */ + @SafeVarargs + public static ComparatorChain of(Comparator... comparators) { + return of(Arrays.asList(comparators)); + } + + /** + * 构建 {@link ComparatorChain} + * + * @param 被比较对象类型 + * @param comparators 比较器列表 + * @return {@link ComparatorChain} + * @since 5.4.3 + */ + public static ComparatorChain of(List> comparators) { + return new ComparatorChain<>(comparators); + } + + /** + * 构建 {@link ComparatorChain} + * + * @param 被比较对象类型 + * @param comparators 比较器列表 + * @param bits {@link Comparator} 列表对应的排序boolean值，true表示正序，false反序 + * @return {@link ComparatorChain} + * @since 5.4.3 + */ + public static ComparatorChain of(List> comparators, BitSet bits) { + return new ComparatorChain<>(comparators, bits); + } + //------------------------------------------------------------------------------------- Static method start + + /** + * 构造空的比较器链，必须至少有一个比较器，否则会在compare时抛出{@link UnsupportedOperationException} + */ + public ComparatorChain() { + this(new ArrayList<>(), new BitSet()); + } + + /** + * 构造，初始化单一比较器。比较器为正序 + * + * @param comparator 在比较器链中的第一个比较器 + */ + public ComparatorChain(final Comparator comparator) { + this(comparator, false); + } + + /** + * 构造，初始化单一比较器。自定义正序还是反序 + * + * @param comparator 在比较器链中的第一个比较器 + * @param reverse 是否反序，true表示反序，false正序 + */ + public ComparatorChain(final Comparator comparator, final boolean reverse) { + chain = new ArrayList<>(1); + chain.add(comparator); + orderingBits = new BitSet(1); + if (reverse == true) { + orderingBits.set(0); + } + } + + /** + * 构造，使用已有的比较器列表 + * + * @param list 比较器列表 + * @see #ComparatorChain(List, BitSet) + */ + public ComparatorChain(final List> list) { + this(list, new BitSet(list.size())); + } + + /** + * 构造，使用已有的比较器列表和对应的BitSet
+ * BitSet中的boolean值需与list中的{@link Comparator}一一对应，true表示正序，false反序 + * + * @param list {@link Comparator} 列表 + * @param bits {@link Comparator} 列表对应的排序boolean值，true表示正序，false反序 + */ + public ComparatorChain(final List> list, final BitSet bits) { + chain = list; + orderingBits = bits; + } + + /** + * 在链的尾部添加比较器，使用正向排序 + * + * @param comparator {@link Comparator} 比较器，正向 + * @return this + */ + public ComparatorChain addComparator(final Comparator comparator) { + return addComparator(comparator, false); + } + + /** + * 在链的尾部添加比较器，使用给定排序方式 + * + * @param comparator {@link Comparator} 比较器 + * @param reverse 是否反序，true表示正序，false反序 + * @return this + */ + public ComparatorChain addComparator(final Comparator comparator, final boolean reverse) { + checkLocked(); + + chain.add(comparator); + if (reverse == true) { + orderingBits.set(chain.size() - 1); + } + return this; + } + + /** + * 替换指定位置的比较器，保持原排序方式 + * + * @param index 位置 + * @param comparator {@link Comparator} + * @return this + * @throws IndexOutOfBoundsException if index < 0 or index >= size() + */ + public ComparatorChain setComparator(final int index, final Comparator comparator) throws IndexOutOfBoundsException { + return setComparator(index, comparator, false); + } + + /** + * 替换指定位置的比较器，替换指定排序方式 + * + * @param index 位置 + * @param comparator {@link Comparator} + * @param reverse 是否反序，true表示正序，false反序 + * @return this + */ + public ComparatorChain setComparator(final int index, final Comparator comparator, final boolean reverse) { + checkLocked(); + + chain.set(index, comparator); + if (reverse == true) { + orderingBits.set(index); + } else { + orderingBits.clear(index); + } + return this; + } + + /** + * 更改指定位置的排序方式为正序 + * + * @param index 位置 + * @return this + */ + public ComparatorChain setForwardSort(final int index) { + checkLocked(); + orderingBits.clear(index); + return this; + } + + /** + * 更改指定位置的排序方式为反序 + * + * @param index 位置 + * @return this + */ + public ComparatorChain setReverseSort(final int index) { + checkLocked(); + orderingBits.set(index); + return this; + } + + /** + * 比较器链中比较器个数 + * + * @return Comparator count + */ + public int size() { + return chain.size(); + } + + /** + * 是否已经被锁定。当开始比较时（调用compare方法）此值为true + * + * @return true = ComparatorChain cannot be modified; false = ComparatorChain can still be modified. + */ + public boolean isLocked() { + return lock; + } + + @Override + public Iterator> iterator() { + return this.chain.iterator(); + } + + @Override + public ComparatorChain addChain(Comparator element) { + return this.addComparator(element); + } + + /** + * 执行比较
+ * 按照比较器链的顺序分别比较，如果比较出相等则转向下一个比较器，否则直接返回 + * + * @param o1 第一个对象 + * @param o2 第二个对象 + * @return -1, 0, or 1 + * @throws UnsupportedOperationException 如果比较器链为空，无法完成比较 + */ + @Override + public int compare(final E o1, final E o2) throws UnsupportedOperationException { + if (lock == false) { + checkChainIntegrity(); + lock = true; + } + + final Iterator> comparators = chain.iterator(); + Comparator comparator; + int retval; + for (int comparatorIndex = 0; comparators.hasNext(); ++comparatorIndex) { + comparator = comparators.next(); + retval = comparator.compare(o1, o2); + if (retval != 0) { + // invert the order if it is a reverse sort + if (true == orderingBits.get(comparatorIndex)) { + retval = (retval > 0) ? -1 : 1; + } + return retval; + } + } + + // if comparators are exhausted, return 0 + return 0; + } + + @Override + public int hashCode() { + int hash = 0; + if (null != chain) { + hash ^= chain.hashCode(); + } + if (null != orderingBits) { + hash ^= orderingBits.hashCode(); + } + return hash; + } + + @Override + public boolean equals(final Object object) { + if (this == object) { + return true; + } + if (null == object) { + return false; + } + if (object.getClass().equals(this.getClass())) { + final ComparatorChain otherChain = (ComparatorChain) object; + // + return Objects.equals(this.orderingBits, otherChain.orderingBits) + && this.chain.equals(otherChain.chain); + } + return false; + } + + //------------------------------------------------------------------------------------------------------------------------------- Private method start + + /** + * 被锁定时抛出异常 + * + * @throws UnsupportedOperationException 被锁定抛出此异常 + */ + private void checkLocked() { + if (lock == true) { + throw new UnsupportedOperationException("Comparator ordering cannot be changed after the first comparison is performed"); + } + } + + /** + * 检查比较器链是否为空，为空抛出异常 + * + * @throws UnsupportedOperationException 为空抛出此异常 + */ + private void checkChainIntegrity() { + if (chain.size() == 0) { + throw new UnsupportedOperationException("ComparatorChains must contain at least one Comparator"); + } + } + //------------------------------------------------------------------------------------------------------------------------------- Private method start +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/ComparatorException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/ComparatorException.java new file mode 100644 index 0000000..44bbaf9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/ComparatorException.java @@ -0,0 +1,32 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import aiyh.utils.tool.cn.hutool.core.exceptions.ExceptionUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 比较异常 + * @author xiaoleilu + */ +public class ComparatorException extends RuntimeException{ + private static final long serialVersionUID = 4475602435485521971L; + + public ComparatorException(Throwable e) { + super(ExceptionUtil.getMessage(e), e); + } + + public ComparatorException(String message) { + super(message); + } + + public ComparatorException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public ComparatorException(String message, Throwable throwable) { + super(message, throwable); + } + + public ComparatorException(Throwable throwable, String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params), throwable); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/CompareUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/CompareUtil.java new file mode 100644 index 0000000..a529245 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/CompareUtil.java @@ -0,0 +1,190 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import java.util.Comparator; +import java.util.Objects; +import java.util.function.Function; + +/** + * 比较工具类 + * + * @author looly + */ +public class CompareUtil { + + /** + * 获取自然排序器，即默认排序器 + * + * @param 排序节点类型 + * @return 默认排序器 + * @since 5.7.21 + */ + @SuppressWarnings("unchecked") + public static > Comparator naturalComparator() { + return ComparableComparator.INSTANCE; + } + + /** + * 对象比较，比较结果取决于comparator，如果被比较对象为null，传入的comparator对象应处理此情况
+ * 如果传入comparator为null，则使用默认规则比较（此时被比较对象必须实现Comparable接口） + * + *

+ * 一般而言，如果c1 < c2，返回数小于0，c1==c2返回0，c1 > c2 大于0 + * + * @param 被比较对象类型 + * @param c1 对象1 + * @param c2 对象2 + * @param comparator 比较器 + * @return 比较结果 + * @see java.util.Comparator#compare(Object, Object) + * @since 4.6.9 + */ + @SuppressWarnings({"rawtypes", "unchecked"}) + public static int compare(T c1, T c2, Comparator comparator) { + if (null == comparator) { + return compare((Comparable) c1, (Comparable) c2); + } + return comparator.compare(c1, c2); + } + + /** + * {@code null}安全的对象比较，{@code null}对象小于任何对象 + * + * @param 被比较对象类型 + * @param c1 对象1，可以为{@code null} + * @param c2 对象2，可以为{@code null} + * @return 比较结果，如果c1 < c2，返回数小于0，c1==c2返回0，c1 > c2 大于0 + * @see java.util.Comparator#compare(Object, Object) + */ + public static > int compare(T c1, T c2) { + return compare(c1, c2, false); + } + + /** + * {@code null}安全的对象比较 + * + * @param 被比较对象类型（必须实现Comparable接口） + * @param c1 对象1，可以为{@code null} + * @param c2 对象2，可以为{@code null} + * @param isNullGreater 当被比较对象为null时是否排在后面，true表示null大于任何对象，false反之 + * @return 比较结果，如果c1 < c2，返回数小于0，c1==c2返回0，c1 > c2 大于0 + * @see java.util.Comparator#compare(Object, Object) + */ + public static > int compare(T c1, T c2, boolean isNullGreater) { + if (c1 == c2) { + return 0; + } else if (c1 == null) { + return isNullGreater ? 1 : -1; + } else if (c2 == null) { + return isNullGreater ? -1 : 1; + } + return c1.compareTo(c2); + } + + /** + * 自然比较两个对象的大小，比较规则如下： + * + * 

+	 * 1、如果实现Comparable调用compareTo比较
+	 * 2、o1.equals(o2)返回0
+	 * 3、比较hashCode值
+	 * 4、比较toString值
+	 *
+ * + * @param 被比较对象类型 + * @param o1 对象1 + * @param o2 对象2 + * @param isNullGreater null值是否做为最大值 + * @return 比较结果，如果o1 < o2，返回数小于0，o1==o2返回0，o1 > o2 大于0 + */ + @SuppressWarnings({"unchecked", "rawtypes"}) + public static int compare(T o1, T o2, boolean isNullGreater) { + if (o1 == o2) { + return 0; + } else if (null == o1) {// null 排在后面 + return isNullGreater ? 1 : -1; + } else if (null == o2) { + return isNullGreater ? -1 : 1; + } + + if (o1 instanceof Comparable && o2 instanceof Comparable) { + //如果bean可比较，直接比较bean + return ((Comparable) o1).compareTo(o2); + } + + if (o1.equals(o2)) { + return 0; + } + + int result = Integer.compare(o1.hashCode(), o2.hashCode()); + if (0 == result) { + result = compare(o1.toString(), o2.toString()); + } + + return result; + } + + /** + * 中文比较器 + * + * @param keyExtractor 从对象中提取中文(参与比较的内容) + * @param 对象类型 + * @return 中文比较器 + * @since 5.4.3 + */ + public static Comparator comparingPinyin(Function keyExtractor) { + return comparingPinyin(keyExtractor, false); + } + + /** + * 中文（拼音）比较器 + * + * @param keyExtractor 从对象中提取中文(参与比较的内容) + * @param reverse 是否反序 + * @param 对象类型 + * @return 中文比较器 + * @since 5.4.3 + */ + public static Comparator comparingPinyin(Function keyExtractor, boolean reverse) { + Objects.requireNonNull(keyExtractor); + PinyinComparator pinyinComparator = new PinyinComparator(); + if (reverse) { + return (o1, o2) -> pinyinComparator.compare(keyExtractor.apply(o2), keyExtractor.apply(o1)); + } + return (o1, o2) -> pinyinComparator.compare(keyExtractor.apply(o1), keyExtractor.apply(o2)); + } + + /** + * 索引比较器
+ * 通过keyExtractor函数，提取对象的某个属性或规则，根据提供的排序数组，完成比较
+ * + * @param keyExtractor 从对象中提取中文(参与比较的内容) + * @param objs 参与排序的数组，数组的元素位置决定了对象的排序先后 + * @param 对象类型 + * @param 数组对象类型 + * @return 索引比较器 + * @since 5.8.0 + */ + @SuppressWarnings("unchecked") + public static Comparator comparingIndexed(Function keyExtractor, U... objs) { + return comparingIndexed(keyExtractor, false, objs); + } + + /** + * 索引比较器
+ * 通过keyExtractor函数，提取对象的某个属性或规则，根据提供的排序数组，完成比较
+ * + * @param keyExtractor 从对象中提取排序键的函数(参与比较的内容) + * @param atEndIfMiss 如果不在列表中是否排在后边 + * @param objs 参与排序的数组，数组的元素位置决定了对象的排序先后 + * @param 对象类型 + * @param 数组对象类型 + * @return 索引比较器 + * @since 5.8.0 + */ + @SuppressWarnings("unchecked") + public static Comparator comparingIndexed(Function keyExtractor, boolean atEndIfMiss, U... objs) { + Objects.requireNonNull(keyExtractor); + IndexedComparator indexedComparator = new IndexedComparator<>(atEndIfMiss, objs); + return (o1, o2) -> indexedComparator.compare(keyExtractor.apply(o1), keyExtractor.apply(o2)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/FieldComparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/FieldComparator.java new file mode 100644 index 0000000..c23bde5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/FieldComparator.java @@ -0,0 +1,65 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.lang.reflect.Field; + +/** + * Bean字段排序器
+ * 参阅feilong-core中的PropertyComparator + * + * @param 被比较的Bean + * @author Looly + */ +public class FieldComparator extends FuncComparator { + private static final long serialVersionUID = 9157326766723846313L; + + /** + * 构造 + * + * @param beanClass Bean类 + * @param fieldName 字段名 + */ + public FieldComparator(Class beanClass, String fieldName) { + this(getNonNullField(beanClass, fieldName)); + } + + /** + * 构造 + * + * @param field 字段 + */ + public FieldComparator(Field field) { + this(true, field); + } + + /** + * 构造 + * + * @param nullGreater 是否{@code null}在后 + * @param field 字段 + */ + public FieldComparator(boolean nullGreater, Field field) { + super(nullGreater, (bean) -> + (Comparable) ReflectUtil.getFieldValue(bean, + Assert.notNull(field, "Field must be not null!"))); + } + + /** + * 获取字段，附带检查字段不存在的问题。 + * + * @param beanClass Bean类 + * @param fieldName 字段名 + * @return 非null字段 + */ + private static Field getNonNullField(Class beanClass, String fieldName) { + final Field field = ClassUtil.getDeclaredField(beanClass, fieldName); + if (field == null) { + throw new IllegalArgumentException(StrUtil.format("Field [{}] not found in Class [{}]", fieldName, beanClass.getName())); + } + return field; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/FieldsComparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/FieldsComparator.java new file mode 100644 index 0000000..9147e06 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/FieldsComparator.java @@ -0,0 +1,50 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; + +import java.lang.reflect.Field; + +/** + * Bean字段排序器
+ * 参阅feilong-core中的PropertyComparator + * + * @param 被比较的Bean + * @author Looly + */ +public class FieldsComparator extends NullComparator { + private static final long serialVersionUID = 8649196282886500803L; + + /** + * 构造 + * + * @param beanClass Bean类 + * @param fieldNames 多个字段名 + */ + public FieldsComparator(Class beanClass, String... fieldNames) { + this(true, beanClass, fieldNames); + } + + /** + * 构造 + * + * @param nullGreater 是否{@code null}在后 + * @param beanClass Bean类 + * @param fieldNames 多个字段名 + */ + public FieldsComparator(boolean nullGreater, Class beanClass, String... fieldNames) { + super(nullGreater, (a, b) -> { + Field field; + for (String fieldName : fieldNames) { + field = ClassUtil.getDeclaredField(beanClass, fieldName); + Assert.notNull(field, "Field [{}] not found in Class [{}]", fieldName, beanClass.getName()); + final int compare = new FieldComparator<>(field).compare(a, b); + if (0 != compare) { + return compare; + } + } + return 0; + }); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/FuncComparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/FuncComparator.java new file mode 100644 index 0000000..613735a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/FuncComparator.java @@ -0,0 +1,63 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.util.function.Function; + +/** + * 指定函数排序器 + * + * @param 被比较的对象 + * @author looly + */ +public class FuncComparator extends NullComparator { + private static final long serialVersionUID = 1L; + + private final Function> func; + + /** + * 构造 + * + * @param nullGreater 是否{@code null}在后 + * @param func 比较项获取函数 + */ + public FuncComparator(boolean nullGreater, Function> func) { + super(nullGreater, null); + this.func = func; + } + + @Override + protected int doCompare(T a, T b) { + Comparable v1; + Comparable v2; + try { + v1 = func.apply(a); + v2 = func.apply(b); + } catch (Exception e) { + throw new ComparatorException(e); + } + + return compare(a, b, v1, v2); + } + + /** + * 对象及对应比较的值的综合比较
+ * 考虑到如果对象对应的比较值相同，如对象的字段值相同，则返回相同结果，此时在TreeMap等容器比较去重时会去重。
+ * 因此需要比较下对象本身以避免去重 + * + * @param o1 对象1 + * @param o2 对象2 + * @param v1 被比较的值1 + * @param v2 被比较的值2 + * @return 比较结果 + */ + @SuppressWarnings({"rawtypes", "unchecked"}) + private int compare(T o1, T o2, Comparable v1, Comparable v2) { + int result = ObjectUtil.compare(v1, v2); + if (0 == result) { + //避免TreeSet / TreeMap 过滤掉排序字段相同但是对象不相同的情况 + result = CompareUtil.compare(o1, o2, this.nullGreater); + } + return result; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/IndexedComparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/IndexedComparator.java new file mode 100644 index 0000000..5d4d4a4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/IndexedComparator.java @@ -0,0 +1,75 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; + +import java.util.Comparator; + +/** + * 按照数组的顺序正序排列，数组的元素位置决定了对象的排序先后
+ * 默认的，如果参与排序的元素并不在数组中，则排序在前（可以通过atEndIfMiss设置) + * + * @param 被排序元素类型 + * @author looly + * @since 4.1.5 + */ +public class IndexedComparator implements Comparator { + + private final boolean atEndIfMiss; + private final T[] array; + + /** + * 构造 + * + * @param objs 参与排序的数组，数组的元素位置决定了对象的排序先后 + */ + @SuppressWarnings("unchecked") + public IndexedComparator(T... objs) { + this(false, objs); + } + + /** + * 构造 + * + * @param atEndIfMiss 如果不在列表中是否排在后边 + * @param objs 参与排序的数组，数组的元素位置决定了对象的排序先后 + */ + @SuppressWarnings("unchecked") + public IndexedComparator(boolean atEndIfMiss, T... objs) { + Assert.notNull(objs, "'objs' array must not be null"); + this.atEndIfMiss = atEndIfMiss; + this.array = objs; + } + + @Override + public int compare(T o1, T o2) { + final int index1 = getOrder(o1); + final int index2 = getOrder(o2); + + if (index1 == index2) { + if (index1 < 0 || index1 == this.array.length) { + // 任意一个元素不在列表中, 返回原顺序 + return 1; + } + + // 位置一样，认为是同一个元素 + return 0; + } + + return Integer.compare(index1, index2); + } + + /** + * 查找对象类型所在列表的位置 + * + * @param object 对象 + * @return 位置，未找到位置根据{@link #atEndIfMiss}取不同值，false返回-1，否则返回列表长度 + */ + private int getOrder(T object) { + int order = ArrayUtil.indexOf(array, object); + if (order < 0) { + order = this.atEndIfMiss ? this.array.length : -1; + } + return order; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/InstanceComparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/InstanceComparator.java new file mode 100644 index 0000000..77b7021 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/InstanceComparator.java @@ -0,0 +1,83 @@ +/* + * Copyright 2002-2019 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package aiyh.utils.tool.cn.hutool.core.comparator; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.util.Comparator; + +/** + * 按照指定类型顺序排序，对象顺序取决于对象对应的类在数组中的位置。 + * + *

如果对比的两个对象类型相同，返回{@code 0}，默认如果对象类型不在列表中，则排序在前

+ *

此类来自Spring，有所改造

+ * + * @param 用于比较的对象类型 + * @author Phillip Webb + * @since 5.4.1 + */ +public class InstanceComparator implements Comparator { + + private final boolean atEndIfMiss; + private final Class[] instanceOrder; + + /** + * 构造 + * + * @param instanceOrder 用于比较排序的对象类型数组，排序按照数组位置排序 + */ + public InstanceComparator(Class... instanceOrder) { + this(false, instanceOrder); + } + + /** + * 构造 + * + * @param atEndIfMiss 如果不在列表中是否排在后边 + * @param instanceOrder 用于比较排序的对象类型数组，排序按照数组位置排序 + */ + public InstanceComparator(boolean atEndIfMiss, Class... instanceOrder) { + Assert.notNull(instanceOrder, "'instanceOrder' array must not be null"); + this.atEndIfMiss = atEndIfMiss; + this.instanceOrder = instanceOrder; + } + + + @Override + public int compare(T o1, T o2) { + int i1 = getOrder(o1); + int i2 = getOrder(o2); + return Integer.compare(i1, i2); + } + + /** + * 查找对象类型所在列表的位置 + * + * @param object 对象 + * @return 位置，未找到位置根据{@link #atEndIfMiss}取不同值，false返回-1，否则返回列表长度 + */ + private int getOrder(T object) { + if (object != null) { + for (int i = 0; i < this.instanceOrder.length; i++) { + if (this.instanceOrder[i].isInstance(object)) { + return i; + } + } + } + return this.atEndIfMiss ? this.instanceOrder.length : -1; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/LengthComparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/LengthComparator.java new file mode 100755 index 0000000..c5cc8d2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/LengthComparator.java @@ -0,0 +1,25 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import java.util.Comparator; + +/** + * 字符串长度比较器，短在前 + * + * @author looly + * @since 5.8.9 + */ +public class LengthComparator implements Comparator { + /** + * 单例的字符串长度比较器，短在前 + */ + public static final LengthComparator INSTANCE = new LengthComparator(); + + @Override + public int compare(CharSequence o1, CharSequence o2) { + int result = Integer.compare(o1.length(), o2.length()); + if (0 == result) { + result = CompareUtil.compare(o1.toString(), o2.toString()); + } + return result; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/NullComparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/NullComparator.java new file mode 100644 index 0000000..31878ac --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/NullComparator.java @@ -0,0 +1,78 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import java.io.Serializable; +import java.util.Comparator; +import java.util.Objects; + +/** + * {@code null}友好的比较器包装，如果nullGreater，则{@code null} > non-null，否则反之。
+ * 如果二者皆为{@code null}，则为相等，返回0。
+ * 如果二者都非{@code null}，则使用传入的比较器排序。
+ * 传入比较器为{@code null}，则看被比较的两个对象是否都实现了{@link Comparable}实现则调用{@link Comparable#compareTo(Object)}。 + * 如果两者至少一个未实现，则视为所有元素相等。 + * + * @param 被比较的对象 + * @author looly + * @since 5.7.10 + */ +public class NullComparator implements Comparator, Serializable { + private static final long serialVersionUID = 1L; + + protected final boolean nullGreater; + protected final Comparator comparator; + + /** + * 构造 + * @param nullGreater 是否{@code null}最大，排在最后 + * @param comparator 实际比较器 + */ + @SuppressWarnings("unchecked") + public NullComparator(boolean nullGreater, Comparator comparator) { + this.nullGreater = nullGreater; + this.comparator = (Comparator) comparator; + } + + @Override + public int compare(T a, T b) { + if (a == b) { + return 0; + }if (a == null) { + return nullGreater ? 1 : -1; + } else if (b == null) { + return nullGreater ? -1 : 1; + } else { + return doCompare(a, b); + } + } + + @Override + public Comparator thenComparing(Comparator other) { + Objects.requireNonNull(other); + return new NullComparator<>(nullGreater, comparator == null ? other : comparator.thenComparing(other)); + } + + @Override + public Comparator reversed() { + return new NullComparator<>((false == nullGreater), comparator == null ? null : comparator.reversed()); + } + + /** + * 不检查{@code null}的比较方法
+ * 用户可自行重写此方法自定义比较方式 + * + * @param a A值 + * @param b B值 + * @return 比较结果，-1:a小于b，0:相等，1:a大于b + */ + @SuppressWarnings({"rawtypes", "unchecked"}) + protected int doCompare(T a, T b) { + if (null == comparator) { + if (a instanceof Comparable && b instanceof Comparable) { + return ((Comparable) a).compareTo(b); + } + return 0; + } + + return comparator.compare(a, b); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/PinyinComparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/PinyinComparator.java new file mode 100644 index 0000000..fd6f0da --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/PinyinComparator.java @@ -0,0 +1,31 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import java.io.Serializable; +import java.text.Collator; +import java.util.Comparator; +import java.util.Locale; + +/** + * 按照GBK拼音顺序对给定的汉字字符串排序 + * + * @author looly + * @since 4.0.8 + */ +public class PinyinComparator implements Comparator, Serializable { + private static final long serialVersionUID = 1L; + + final Collator collator; + + /** + * 构造 + */ + public PinyinComparator() { + collator = Collator.getInstance(Locale.CHINESE); + } + + @Override + public int compare(String o1, String o2) { + return collator.compare(o1, o2); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/PropertyComparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/PropertyComparator.java new file mode 100644 index 0000000..cafb14c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/PropertyComparator.java @@ -0,0 +1,34 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; + +/** + * Bean属性排序器
+ * 支持读取Bean多层次下的属性 + * + * @author Looly + * + * @param 被比较的Bean + */ +public class PropertyComparator extends FuncComparator { + private static final long serialVersionUID = 9157326766723846313L; + + /** + * 构造 + * + * @param property 属性名 + */ + public PropertyComparator(String property) { + this(property, true); + } + + /** + * 构造 + * + * @param property 属性名 + * @param isNullGreater null值是否排在后（从小到大排序） + */ + public PropertyComparator(String property, boolean isNullGreater) { + super(isNullGreater, (bean)-> BeanUtil.getProperty(bean, property)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/ReverseComparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/ReverseComparator.java new file mode 100644 index 0000000..59a36b3 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/ReverseComparator.java @@ -0,0 +1,49 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import java.io.Serializable; +import java.util.Comparator; + +/** + * 反转比较器 + * + * @author Looly + * + * @param 被比较对象类型 + */ +public class ReverseComparator implements Comparator, Serializable { + private static final long serialVersionUID = 8083701245147495562L; + + /** 原始比较器 */ + private final Comparator comparator; + + @SuppressWarnings("unchecked") + public ReverseComparator(Comparator comparator) { + this.comparator = (null == comparator) ? ComparableComparator.INSTANCE : comparator; + } + + //----------------------------------------------------------------------------------------------------- + @Override + public int compare(E o1, E o2) { + return comparator.compare(o2, o1); + } + + @Override + public int hashCode() { + return "ReverseComparator".hashCode() ^ comparator.hashCode(); + } + + @Override + public boolean equals(final Object object) { + if (this == object) { + return true; + } + if (null == object) { + return false; + } + if (object.getClass().equals(this.getClass())) { + final ReverseComparator thatrc = (ReverseComparator) object; + return comparator.equals(thatrc.comparator); + } + return false; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/VersionComparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/VersionComparator.java new file mode 100644 index 0000000..90b6acc --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/VersionComparator.java @@ -0,0 +1,88 @@ +package aiyh.utils.tool.cn.hutool.core.comparator; + +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.util.Comparator; +import java.util.List; + +/** + * 版本比较器
+ * 比较两个版本的大小
+ * 排序时版本从小到大排序，即比较时小版本在前，大版本在后
+ * 支持如：1.3.20.8，6.82.20160101，8.5a/8.5c等版本形式
+ * 参考：https://www.cnblogs.com/shihaiming/p/6286575.html + * + * @author Looly + * @since 4.0.2 + */ +public class VersionComparator implements Comparator, Serializable { + private static final long serialVersionUID = 8083701245147495562L; + + /** 单例 */ + public static final VersionComparator INSTANCE = new VersionComparator(); + + /** + * 默认构造 + */ + public VersionComparator() { + } + + // ----------------------------------------------------------------------------------------------------- + /** + * 比较两个版本
+ * null版本排在最小：即： + * 
+	 * compare(null, "v1") < 0
+	 * compare("v1", "v1")  = 0
+	 * compare(null, null)   = 0
+	 * compare("v1", null) > 0
+	 * compare("1.0.0", "1.0.2") < 0
+	 * compare("1.0.2", "1.0.2a") < 0
+	 * compare("1.13.0", "1.12.1c") > 0
+	 * compare("V0.0.20170102", "V0.0.20170101") > 0
+	 *
+ * + * @param version1 版本1 + * @param version2 版本2 + */ + @Override + public int compare(String version1, String version2) { + if(ObjectUtil.equal(version1, version2)) { + return 0; + } + if (version1 == null && version2 == null) { + return 0; + } else if (version1 == null) {// null视为最小版本，排在前 + return -1; + } else if (version2 == null) { + return 1; + } + + final List v1s = StrUtil.split(version1, CharUtil.DOT); + final List v2s = StrUtil.split(version2, CharUtil.DOT); + + int diff = 0; + int minLength = Math.min(v1s.size(), v2s.size());// 取最小长度值 + String v1; + String v2; + for (int i = 0; i < minLength; i++) { + v1 = v1s.get(i); + v2 = v2s.get(i); + // 先比较长度 + diff = v1.length() - v2.length(); + if (0 == diff) { + diff = v1.compareTo(v2); + } + if(diff != 0) { + //已有结果，结束 + break; + } + } + + // 如果已经分出大小，则直接返回，如果未分出大小，则再比较位数，有子版本的为大； + return (diff != 0) ? diff : v1s.size() - v2s.size(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/package-info.java new file mode 100644 index 0000000..0aaa8eb --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/comparator/package-info.java @@ -0,0 +1,7 @@ +/** + * 各种比较器（Comparator）实现和封装 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.comparator; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/CompilerException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/CompilerException.java new file mode 100644 index 0000000..4077d43 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/CompilerException.java @@ -0,0 +1,34 @@ +package aiyh.utils.tool.cn.hutool.core.compiler; + +import aiyh.utils.tool.cn.hutool.core.exceptions.ExceptionUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 编译异常 + * + * @author looly + * @since 5.5.2 + */ +public class CompilerException extends RuntimeException { + private static final long serialVersionUID = 1L; + + public CompilerException(Throwable e) { + super(ExceptionUtil.getMessage(e), e); + } + + public CompilerException(String message) { + super(message); + } + + public CompilerException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public CompilerException(String message, Throwable throwable) { + super(message, throwable); + } + + public CompilerException(Throwable throwable, String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params), throwable); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/CompilerUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/CompilerUtil.java new file mode 100644 index 0000000..20852d0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/CompilerUtil.java @@ -0,0 +1,80 @@ +package aiyh.utils.tool.cn.hutool.core.compiler; + +import javax.tools.DiagnosticListener; +import javax.tools.JavaCompiler; +import javax.tools.JavaFileManager; +import javax.tools.JavaFileObject; +import javax.tools.StandardJavaFileManager; +import javax.tools.ToolProvider; + +/** + * 源码编译工具类，主要封装{@link JavaCompiler} 相关功能 + * + * @author looly + * @since 5.5.2 + */ +public class CompilerUtil { + + /** + * java 编译器 + */ + public static final JavaCompiler SYSTEM_COMPILER = ToolProvider.getSystemJavaCompiler(); + + /** + * 编译指定的源码文件 + * + * @param sourceFiles 源码文件路径 + * @return 0表示成功，否则其他 + */ + public static boolean compile(String... sourceFiles) { + return 0 == SYSTEM_COMPILER.run(null, null, null, sourceFiles); + } + + /** + * 获取{@link StandardJavaFileManager} + * + * @return {@link StandardJavaFileManager} + */ + public static StandardJavaFileManager getFileManager() { + return getFileManager(null); + } + + /** + * 获取{@link StandardJavaFileManager} + * + * @param diagnosticListener 异常收集器 + * @return {@link StandardJavaFileManager} + * @since 5.5.8 + */ + public static StandardJavaFileManager getFileManager(DiagnosticListener diagnosticListener) { + return SYSTEM_COMPILER.getStandardFileManager(diagnosticListener, null, null); + } + + /** + * 新建编译任务 + * + * @param fileManager {@link JavaFileManager}，用于管理已经编译好的文件 + * @param diagnosticListener 诊断监听 + * @param options 选项，例如 -cpXXX等 + * @param compilationUnits 编译单元，即需要编译的对象 + * @return {@link JavaCompiler.CompilationTask} + */ + public static JavaCompiler.CompilationTask getTask( + JavaFileManager fileManager, + DiagnosticListener diagnosticListener, + Iterable options, + Iterable compilationUnits) { + return SYSTEM_COMPILER.getTask(null, fileManager, diagnosticListener, options, null, compilationUnits); + } + + /** + * 获取{@link JavaSourceCompiler} + * + * @param parent 父{@link ClassLoader} + * @return {@link JavaSourceCompiler} + * @see JavaSourceCompiler#create(ClassLoader) + */ + public static JavaSourceCompiler getCompiler(ClassLoader parent) { + return JavaSourceCompiler.create(parent); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/DiagnosticUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/DiagnosticUtil.java new file mode 100644 index 0000000..28baec8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/DiagnosticUtil.java @@ -0,0 +1,26 @@ +package aiyh.utils.tool.cn.hutool.core.compiler; + +import javax.tools.DiagnosticCollector; +import java.util.List; +import java.util.stream.Collectors; + +/** + * 诊断工具类 + * + * @author looly + * @since 5.5.2 + */ +public class DiagnosticUtil { + + /** + * 获取{@link DiagnosticCollector}收集到的诊断信息，以文本返回 + * + * @param collector {@link DiagnosticCollector} + * @return 诊断消息 + */ + public static String getMessages(DiagnosticCollector collector) { + final List diagnostics = collector.getDiagnostics(); + return diagnostics.stream().map(String::valueOf) + .collect(Collectors.joining(System.lineSeparator())); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaClassFileManager.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaClassFileManager.java new file mode 100644 index 0000000..b272e86 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaClassFileManager.java @@ -0,0 +1,78 @@ +package aiyh.utils.tool.cn.hutool.core.compiler; + +import aiyh.utils.tool.cn.hutool.core.io.resource.FileObjectResource; +import aiyh.utils.tool.cn.hutool.core.lang.ResourceClassLoader; +import aiyh.utils.tool.cn.hutool.core.util.ClassLoaderUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import javax.tools.FileObject; +import javax.tools.ForwardingJavaFileManager; +import javax.tools.JavaFileManager; +import javax.tools.JavaFileObject; +import javax.tools.JavaFileObject.Kind; +import java.util.HashMap; +import java.util.Map; + +/** + * Java 字节码文件对象管理器 + * + *

+ * 正常我们使用javac命令编译源码时会将class文件写入到磁盘中，但在运行时动态编译类不适合保存在磁盘中 + * 我们采取此对象来管理运行时动态编译类生成的字节码。 + *

+ * + * @author lzpeng + * @since 5.5.2 + */ +class JavaClassFileManager extends ForwardingJavaFileManager { + + /** + * 存储java字节码文件对象映射 + */ + private final Map classFileObjectMap = new HashMap<>(); + + /** + * 加载动态编译生成类的父类加载器 + */ + private final ClassLoader parent; + + /** + * 构造 + * + * @param parent 父类加载器 + * @param fileManager 字节码文件管理器 + */ + protected JavaClassFileManager(ClassLoader parent, JavaFileManager fileManager) { + super(fileManager); + this.parent = ObjectUtil.defaultIfNull(parent, ClassLoaderUtil::getClassLoader); + } + + /** + * 获得动态编译生成的类的类加载器 + * + * @param location 源码位置 + * @return 动态编译生成的类的类加载器 + */ + @Override + public ClassLoader getClassLoader(final Location location) { + return new ResourceClassLoader<>(this.parent, this.classFileObjectMap); + } + + /** + * 获得Java字节码文件对象 + * 编译器编译源码时会将Java源码对象编译转为Java字节码对象 + * + * @param location 源码位置 + * @param className 类名 + * @param kind 文件类型 + * @param sibling Java源码对象 + * @return Java字节码文件对象 + */ + @Override + public JavaFileObject getJavaFileForOutput(final Location location, final String className, final Kind kind, final FileObject sibling) { + final JavaFileObject javaFileObject = new JavaClassFileObject(className); + this.classFileObjectMap.put(className, new FileObjectResource(javaFileObject)); + return javaFileObject; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaClassFileObject.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaClassFileObject.java new file mode 100644 index 0000000..c93b005 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaClassFileObject.java @@ -0,0 +1,60 @@ +package aiyh.utils.tool.cn.hutool.core.compiler; + + +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; + +import javax.tools.SimpleJavaFileObject; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.InputStream; +import java.io.OutputStream; + +/** + * Java 字节码文件对象，用于在内存中暂存class字节码，从而可以在ClassLoader中动态加载。 + * + * @author lzpeng + * @since 5.5.2 + */ +class JavaClassFileObject extends SimpleJavaFileObject { + + /** + * 字节码输出流 + */ + private final ByteArrayOutputStream byteArrayOutputStream; + + /** + * 构造 + * + * @param className 编译后的class文件的类名 + * @see JavaClassFileManager#getJavaFileForOutput(javax.tools.JavaFileManager.Location, java.lang.String, javax.tools.JavaFileObject.Kind, javax.tools.FileObject) + */ + protected JavaClassFileObject(String className) { + super(URLUtil.getStringURI(className.replace(CharUtil.DOT, CharUtil.SLASH) + Kind.CLASS.extension), Kind.CLASS); + this.byteArrayOutputStream = new ByteArrayOutputStream(); + } + + /** + * 获得字节码输入流 + * 编译器编辑源码后，我们将通过此输出流获得编译后的字节码，以便运行时加载类 + * + * @return 字节码输入流 + * @see JavaClassFileManager#getClassLoader(javax.tools.JavaFileManager.Location) + */ + @Override + public InputStream openInputStream() { + return new ByteArrayInputStream(byteArrayOutputStream.toByteArray()); + } + + /** + * 获得字节码输出流 + * 编译器编辑源码时，会将编译结果输出到本输出流中 + * + * @return 字节码输出流 + */ + @Override + public OutputStream openOutputStream() { + return this.byteArrayOutputStream; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaFileObjectUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaFileObjectUtil.java new file mode 100644 index 0000000..351bcba --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaFileObjectUtil.java @@ -0,0 +1,75 @@ +package aiyh.utils.tool.cn.hutool.core.compiler; + +import aiyh.utils.tool.cn.hutool.core.io.file.FileNameUtil; +import aiyh.utils.tool.cn.hutool.core.util.ZipUtil; + +import javax.tools.JavaFileObject; +import java.io.File; +import java.util.ArrayList; +import java.util.List; +import java.util.zip.ZipFile; + +/** + * {@link JavaFileObject} 相关工具类封装 + * + * @author lzpeng, looly + * @since 5.5.2 + */ +public class JavaFileObjectUtil { + + /** + * 获取指定文件下的所有待编译的java文件，并以{@link JavaFileObject}形式返回 + * + * @param file 文件或目录，文件支持.java、.jar和.zip文件 + * @return 所有待编译的 {@link JavaFileObject} + */ + public static List getJavaFileObjects(File file) { + final List result = new ArrayList<>(); + final String fileName = file.getName(); + + if (isJavaFile(fileName)) { + result.add(new JavaSourceFileObject(file.toURI())); + } else if (isJarOrZipFile(fileName)) { + result.addAll(getJavaFileObjectByZipOrJarFile(file)); + } + return result; + } + + /** + * 是否是jar 或 zip 文件 + * + * @param fileName 文件名 + * @return 是否是jar 或 zip 文件 + */ + public static boolean isJarOrZipFile(String fileName) { + return FileNameUtil.isType(fileName, "jar", "zip"); + } + + /** + * 是否是java文件 + * + * @param fileName 文件名 + * @return 是否是.java文件 + */ + public static boolean isJavaFile(String fileName) { + return FileNameUtil.isType(fileName, "java"); + } + + /** + * 通过zip包或jar包创建Java文件对象 + * + * @param file 压缩文件 + * @return Java文件对象 + */ + private static List getJavaFileObjectByZipOrJarFile(File file) { + final List collection = new ArrayList<>(); + final ZipFile zipFile = ZipUtil.toZipFile(file, null); + ZipUtil.read(zipFile, (zipEntry) -> { + final String name = zipEntry.getName(); + if (isJavaFile(name)) { + collection.add(new JavaSourceFileObject(name, ZipUtil.getStream(zipFile, zipEntry))); + } + }); + return collection; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaSourceCompiler.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaSourceCompiler.java new file mode 100644 index 0000000..bab5ad0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaSourceCompiler.java @@ -0,0 +1,269 @@ +package aiyh.utils.tool.cn.hutool.core.compiler; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.io.resource.FileResource; +import aiyh.utils.tool.cn.hutool.core.io.resource.Resource; +import aiyh.utils.tool.cn.hutool.core.io.resource.StringResource; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.ClassLoaderUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; + +import javax.tools.DiagnosticCollector; +import javax.tools.JavaCompiler.CompilationTask; +import javax.tools.JavaFileObject; +import javax.tools.StandardLocation; +import java.io.File; +import java.net.URL; +import java.net.URLClassLoader; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +/** + * Java 源码编译器 + *

通过此类可以动态编译java源码，并加载到ClassLoader，从而动态获取加载的类。

+ *

JavaSourceCompiler支持加载的源码类型包括：

+ *
    + *
  • 源码文件
    • + *
  • 源码文件源码字符串
    • + *
+ * + *

使用方法如下：

+ * 
+ *     ClassLoader classLoader = JavaSourceCompiler.create(null)
+ *         .addSource(FileUtil.file("test-compile/b/B.java"))
+ *         .addSource("c.C", FileUtil.readUtf8String("test-compile/c/C.java"))
+ *         // 增加编译依赖的类库
+ *         .addLibrary(libFile)
+ *         .compile();
+ *     Class<?> clazz = classLoader.loadClass("c.C");
+ *
+ * + * @author lzpeng + */ +public class JavaSourceCompiler { + + /** + * 待编译的资源，支持： + * + *
    + *
  • 源码字符串，使用{@link StringResource}
    • + *
  • 源码文件、源码jar包或源码zip包，亦或者文件夹，使用{@link FileResource}
    • + *
+ * 可以是 .java文件 压缩文件 文件夹 递归搜索文件夹内的zip包和jar包 + */ + private final List sourceList = new ArrayList<>(); + + /** + * 编译时需要加入classpath中的文件 可以是 压缩文件 文件夹递归搜索文件夹内的zip包和jar包 + */ + private final List libraryFileList = new ArrayList<>(); + + /** + * 编译类时使用的父类加载器 + */ + private final ClassLoader parentClassLoader; + + /** + * 创建Java源码编译器 + * + * @param parent 父类加载器 + * @return Java源码编译器 + */ + public static JavaSourceCompiler create(ClassLoader parent) { + return new JavaSourceCompiler(parent); + } + + /** + * 构造 + * + * @param parent 父类加载器，null则使用默认类加载器 + */ + private JavaSourceCompiler(ClassLoader parent) { + this.parentClassLoader = ObjectUtil.defaultIfNull(parent, ClassLoaderUtil::getClassLoader); + } + + /** + * 向编译器中加入待编译的资源
+ * 支持 .java, 文件夹, 压缩文件 递归搜索文件夹内的压缩文件和jar包 + * + * @param resources 待编译的资源，支持 .java, 文件夹, 压缩文件 递归搜索文件夹内的压缩文件和jar包 + * @return Java源码编译器 + */ + public JavaSourceCompiler addSource(Resource... resources) { + if (ArrayUtil.isNotEmpty(resources)) { + this.sourceList.addAll(Arrays.asList(resources)); + } + return this; + } + + /** + * 向编译器中加入待编译的文件
+ * 支持 .java, 文件夹, 压缩文件 递归搜索文件夹内的压缩文件和jar包 + * + * @param files 待编译的文件 支持 .java, 文件夹, 压缩文件 递归搜索文件夹内的压缩文件和jar包 + * @return Java源码编译器 + */ + public JavaSourceCompiler addSource(File... files) { + if (ArrayUtil.isNotEmpty(files)) { + for (File file : files) { + this.sourceList.add(new FileResource(file)); + } + } + return this; + } + + /** + * 向编译器中加入待编译的源码Map + * + * @param sourceCodeMap 源码Map key: 类名 value 源码 + * @return Java源码编译器 + */ + public JavaSourceCompiler addSource(Map sourceCodeMap) { + if (MapUtil.isNotEmpty(sourceCodeMap)) { + sourceCodeMap.forEach(this::addSource); + } + return this; + } + + /** + * 向编译器中加入待编译的源码 + * + * @param className 类名 + * @param sourceCode 源码 + * @return Java文件编译器 + */ + public JavaSourceCompiler addSource(String className, String sourceCode) { + if (className != null && sourceCode != null) { + this.sourceList.add(new StringResource(sourceCode, className)); + } + return this; + } + + /** + * 加入编译Java源码时所需要的jar包，jar包中必须为字节码 + * + * @param files 编译Java源码时所需要的jar包 + * @return Java源码编译器 + */ + public JavaSourceCompiler addLibrary(File... files) { + if (ArrayUtil.isNotEmpty(files)) { + this.libraryFileList.addAll(Arrays.asList(files)); + } + return this; + } + + /** + * 编译所有文件并返回类加载器 + * + * @return 类加载器 + */ + public ClassLoader compile() { + // 获得classPath + final List classPath = getClassPath(); + final URL[] urLs = URLUtil.getURLs(classPath.toArray(new File[0])); + final URLClassLoader ucl = URLClassLoader.newInstance(urLs, this.parentClassLoader); + if (sourceList.isEmpty()) { + // 没有需要编译的源码文件返回加载zip或jar包的类加载器 + return ucl; + } + + // 创建编译器 + final JavaClassFileManager javaFileManager = new JavaClassFileManager(ucl, CompilerUtil.getFileManager()); + + // classpath + final List options = new ArrayList<>(); + if (false == classPath.isEmpty()) { + final List cp = CollUtil.map(classPath, File::getAbsolutePath, true); + options.add("-cp"); + options.add(CollUtil.join(cp, FileUtil.isWindows() ? ";" : ":")); + } + + // 编译文件 + final DiagnosticCollector diagnosticCollector = new DiagnosticCollector<>(); + final List javaFileObjectList = getJavaFileObject(); + final CompilationTask task = CompilerUtil.getTask(javaFileManager, diagnosticCollector, options, javaFileObjectList); + try { + if (task.call()) { + // 加载编译后的类 + return javaFileManager.getClassLoader(StandardLocation.CLASS_OUTPUT); + } + } finally { + IoUtil.close(javaFileManager); + } + //编译失败,收集错误信息 + throw new CompilerException(DiagnosticUtil.getMessages(diagnosticCollector)); + } + + /** + * 获得编译源码时需要的classpath + * + * @return 编译源码时需要的classpath + */ + private List getClassPath() { + List classPathFileList = new ArrayList<>(); + for (File file : libraryFileList) { + List jarOrZipFile = FileUtil.loopFiles(file, (subFile) -> JavaFileObjectUtil.isJarOrZipFile(subFile.getName())); + classPathFileList.addAll(jarOrZipFile); + if (file.isDirectory()) { + classPathFileList.add(file); + } + } + return classPathFileList; + } + + /** + * 获得待编译的Java文件对象 + * + * @return 待编译的Java文件对象 + */ + private List getJavaFileObject() { + final List list = new ArrayList<>(); + + for (Resource resource : this.sourceList) { + if (resource instanceof FileResource) { + final File file = ((FileResource) resource).getFile(); + FileUtil.walkFiles(file, (subFile) -> list.addAll(JavaFileObjectUtil.getJavaFileObjects(file))); + } else { + list.add(new JavaSourceFileObject(resource.getName(), resource.getStream())); + } + } + + return list; + } + + /** + * 通过源码Map获得Java文件对象 + * + * @param sourceCodeMap 源码Map + * @return Java文件对象集合 + */ + private Collection getJavaFileObjectByMap(final Map sourceCodeMap) { + if (MapUtil.isNotEmpty(sourceCodeMap)) { + return sourceCodeMap.entrySet().stream() + .map(entry -> new JavaSourceFileObject(entry.getKey(), entry.getValue(), CharsetUtil.CHARSET_UTF_8)) + .collect(Collectors.toList()); + } + return Collections.emptySet(); + } + + /** + * 通过.java文件创建Java文件对象 + * + * @param file .java文件 + * @return Java文件对象 + */ + private JavaFileObject getJavaFileObjectByJavaFile(final File file) { + return new JavaSourceFileObject(file.toURI()); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaSourceFileObject.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaSourceFileObject.java new file mode 100644 index 0000000..d6ac371 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/JavaSourceFileObject.java @@ -0,0 +1,90 @@ +package aiyh.utils.tool.cn.hutool.core.compiler; + +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; + +import javax.tools.SimpleJavaFileObject; +import java.io.BufferedInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.net.URI; +import java.nio.charset.Charset; + +/** + * Java 源码文件对象，支持：
+ *
    + *
  1. 源文件，通过文件的uri传入
    2. + *
  2. 代码内容，通过流传入
    3. + *
+ * + * @author lzpeng + * @since 5.5.2 + */ +class JavaSourceFileObject extends SimpleJavaFileObject { + + /** + * 输入流 + */ + private InputStream inputStream; + + /** + * 构造，支持File等路径类型的源码 + * + * @param uri 需要编译的文件uri + */ + protected JavaSourceFileObject(URI uri) { + super(uri, Kind.SOURCE); + } + + /** + * 构造，支持String类型的源码 + * + * @param className 需要编译的类名 + * @param code 需要编译的类源码 + */ + protected JavaSourceFileObject(String className, String code, Charset charset) { + this(className, IoUtil.toStream(code, charset)); + } + + /** + * 构造，支持流中读取源码（例如zip或网络等） + * + * @param name 需要编译的文件名 + * @param inputStream 输入流 + */ + protected JavaSourceFileObject(String name, InputStream inputStream) { + this(URLUtil.getStringURI(name.replace(CharUtil.DOT, CharUtil.SLASH) + Kind.SOURCE.extension)); + this.inputStream = inputStream; + } + + /** + * 获得类源码的输入流 + * + * @return 类源码的输入流 + * @throws IOException IO 异常 + */ + @Override + public InputStream openInputStream() throws IOException { + if (inputStream == null) { + inputStream = toUri().toURL().openStream(); + } + return new BufferedInputStream(inputStream); + } + + /** + * 获得类源码 + * 编译器编辑源码前，会通过此方法获取类的源码 + * + * @param ignoreEncodingErrors 是否忽略编码错误 + * @return 需要编译的类的源码 + * @throws IOException IO异常 + */ + @Override + public CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException { + try(final InputStream in = openInputStream()){ + return IoUtil.readUtf8(in); + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/package-info.java new file mode 100644 index 0000000..08b4750 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compiler/package-info.java @@ -0,0 +1,6 @@ +/** + * 运行时编译java源码,动态从字符串或外部文件加载类 + * + * @author : Lzpeng + */ +package aiyh.utils.tool.cn.hutool.core.compiler; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/Deflate.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/Deflate.java new file mode 100755 index 0000000..c6e7a8d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/Deflate.java @@ -0,0 +1,102 @@ +package aiyh.utils.tool.cn.hutool.core.compress; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; + +import java.io.Closeable; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.util.zip.Deflater; +import java.util.zip.DeflaterOutputStream; +import java.util.zip.Inflater; +import java.util.zip.InflaterOutputStream; + +/** + * Deflate算法
+ * Deflate是同时使用了LZ77算法与哈夫曼编码（Huffman Coding）的一个无损数据压缩算法。 + * + * @author looly + * @since 5.7.8 + */ +public class Deflate implements Closeable { + + private final InputStream source; + private OutputStream target; + private final boolean nowrap; + + /** + * 创建Deflate + * + * @param source 源流 + * @param target 目标流 + * @param nowrap {@code true}表示兼容Gzip压缩 + * @return this + */ + public static Deflate of(InputStream source, OutputStream target, boolean nowrap) { + return new Deflate(source, target, nowrap); + } + + /** + * 构造 + * + * @param source 源流 + * @param target 目标流 + * @param nowrap {@code true}表示兼容Gzip压缩 + */ + public Deflate(InputStream source, OutputStream target, boolean nowrap) { + this.source = source; + this.target = target; + this.nowrap = nowrap; + } + + /** + * 获取目标流 + * + * @return 目标流 + */ + public OutputStream getTarget() { + return this.target; + } + + /** + * 将普通数据流压缩 + * + * @param level 压缩级别，0~9 + * @return this + */ + public Deflate deflater(int level) { + target= (target instanceof DeflaterOutputStream) ? + (DeflaterOutputStream) target : new DeflaterOutputStream(target, new Deflater(level, nowrap)); + IoUtil.copy(source, target); + try { + ((DeflaterOutputStream)target).finish(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + return this; + } + + /** + * 将压缩流解压到target中 + * + * @return this + */ + public Deflate inflater() { + target = (target instanceof InflaterOutputStream) ? + (InflaterOutputStream) target : new InflaterOutputStream(target, new Inflater(nowrap)); + IoUtil.copy(source, target); + try { + ((InflaterOutputStream)target).finish(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + return this; + } + + @Override + public void close() { + IoUtil.close(this.target); + IoUtil.close(this.source); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/Gzip.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/Gzip.java new file mode 100755 index 0000000..7b41d8a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/Gzip.java @@ -0,0 +1,94 @@ +package aiyh.utils.tool.cn.hutool.core.compress; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; + +import java.io.Closeable; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.util.zip.GZIPInputStream; +import java.util.zip.GZIPOutputStream; + +/** + * GZIP是用于Unix系统的文件压缩
+ * gzip的基础是DEFLATE + * + * @author looly + * @since 5.7.8 + */ +public class Gzip implements Closeable { + + private InputStream source; + private OutputStream target; + + /** + * 创建Gzip + * + * @param source 源流 + * @param target 目标流 + * @return Gzip + */ + public static Gzip of(InputStream source, OutputStream target) { + return new Gzip(source, target); + } + + /** + * 构造 + * + * @param source 源流 + * @param target 目标流 + */ + public Gzip(InputStream source, OutputStream target) { + this.source = source; + this.target = target; + } + + /** + * 获取目标流 + * + * @return 目标流 + */ + public OutputStream getTarget() { + return this.target; + } + + /** + * 将普通数据流压缩 + * + * @return Gzip + */ + public Gzip gzip() { + try { + target = (target instanceof GZIPOutputStream) ? + (GZIPOutputStream) target : new GZIPOutputStream(target); + IoUtil.copy(source, target); + ((GZIPOutputStream) target).finish(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + return this; + } + + /** + * 将压缩流解压到target中 + * + * @return Gzip + */ + public Gzip unGzip() { + try { + source = (source instanceof GZIPInputStream) ? + (GZIPInputStream) source : new GZIPInputStream(source); + IoUtil.copy(source, target); + } catch (IOException e) { + throw new IORuntimeException(e); + } + return this; + } + + @Override + public void close() { + IoUtil.close(this.target); + IoUtil.close(this.source); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/ZipCopyVisitor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/ZipCopyVisitor.java new file mode 100644 index 0000000..1f39e04 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/ZipCopyVisitor.java @@ -0,0 +1,88 @@ +package aiyh.utils.tool.cn.hutool.core.compress; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.IOException; +import java.nio.file.CopyOption; +import java.nio.file.DirectoryNotEmptyException; +import java.nio.file.FileAlreadyExistsException; +import java.nio.file.FileSystem; +import java.nio.file.FileVisitResult; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.SimpleFileVisitor; +import java.nio.file.attribute.BasicFileAttributes; + +/** + * Zip文件拷贝的FileVisitor实现，zip中追加文件，此类非线程安全
+ * 此类在遍历源目录并复制过程中会自动创建目标目录中不存在的上级目录。 + * + * @author looly + * @since 5.7.15 + */ +public class ZipCopyVisitor extends SimpleFileVisitor { + + /** + * 源Path，或基准路径，用于计算被拷贝文件的相对路径 + */ + private final Path source; + private final FileSystem fileSystem; + private final CopyOption[] copyOptions; + + /** + * 构造 + * + * @param source 源Path，或基准路径，用于计算被拷贝文件的相对路径 + * @param fileSystem 目标Zip文件 + * @param copyOptions 拷贝选项，如跳过已存在等 + */ + public ZipCopyVisitor(Path source, FileSystem fileSystem, CopyOption... copyOptions) { + this.source = source; + this.fileSystem = fileSystem; + this.copyOptions = copyOptions; + } + + @Override + public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException { + final Path targetDir = resolveTarget(dir); + if(StrUtil.isNotEmpty(targetDir.toString())){ + // 在目标的Zip文件中的相对位置创建目录 + try { + Files.copy(dir, targetDir, copyOptions); + } catch (final DirectoryNotEmptyException ignore) { + // 目录已经存在，则跳过 + } catch (FileAlreadyExistsException e) { + if (false == Files.isDirectory(targetDir)) { + throw e; + } + // 目录非空情况下，跳过创建目录 + } + } + + return FileVisitResult.CONTINUE; + } + + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException { + // 如果目标存在，无论目录还是文件都抛出FileAlreadyExistsException异常，此处不做特别处理 + Files.copy(file, resolveTarget(file), copyOptions); + + return FileVisitResult.CONTINUE; + } + + /** + * 根据源文件或目录路径，拼接生成目标的文件或目录路径
+ * 原理是首先截取源路径，得到相对路径，再和目标路径拼接 + * + *

+ * 如：源路径是 /opt/test/，需要拷贝的文件是 /opt/test/a/a.txt，得到相对路径 a/a.txt
+ * 目标路径是/home/，则得到最终目标路径是 /home/a/a.txt + *

+ * + * @param file 需要拷贝的文件或目录Path + * @return 目标Path + */ + private Path resolveTarget(Path file) { + return fileSystem.getPath(source.relativize(file).toString()); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/ZipReader.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/ZipReader.java new file mode 100755 index 0000000..7999e88 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/ZipReader.java @@ -0,0 +1,251 @@ +package aiyh.utils.tool.cn.hutool.core.compress; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Filter; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import aiyh.utils.tool.cn.hutool.core.util.ZipUtil; + +import java.io.Closeable; +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.Charset; +import java.util.Enumeration; +import java.util.function.Consumer; +import java.util.zip.ZipEntry; +import java.util.zip.ZipFile; +import java.util.zip.ZipInputStream; + +/** + * Zip文件或流读取器，一般用于Zip文件解压 + * + * @author looly + * @since 5.7.8 + */ +public class ZipReader implements Closeable { + + // size of uncompressed zip entry shouldn't be bigger of compressed in MAX_SIZE_DIFF times + private static final int MAX_SIZE_DIFF = 100; + + private ZipFile zipFile; + private ZipInputStream in; + + /** + * 创建ZipReader + * + * @param zipFile 生成的Zip文件 + * @param charset 编码 + * @return ZipReader + */ + public static ZipReader of(File zipFile, Charset charset) { + return new ZipReader(zipFile, charset); + } + + /** + * 创建ZipReader + * + * @param in Zip输入的流，一般为输入文件流 + * @param charset 编码 + * @return ZipReader + */ + public static ZipReader of(InputStream in, Charset charset) { + return new ZipReader(in, charset); + } + + /** + * 构造 + * + * @param zipFile 读取的的Zip文件 + * @param charset 编码 + */ + public ZipReader(File zipFile, Charset charset) { + this.zipFile = ZipUtil.toZipFile(zipFile, charset); + } + + /** + * 构造 + * + * @param zipFile 读取的的Zip文件 + */ + public ZipReader(ZipFile zipFile) { + this.zipFile = zipFile; + } + + /** + * 构造 + * + * @param in 读取的的Zip文件流 + * @param charset 编码 + */ + public ZipReader(InputStream in, Charset charset) { + this.in = new ZipInputStream(in, charset); + } + + /** + * 构造 + * + * @param zin 读取的的Zip文件流 + */ + public ZipReader(ZipInputStream zin) { + this.in = zin; + } + + /** + * 获取指定路径的文件流
+ * 如果是文件模式，则直接获取Entry对应的流，如果是流模式，则遍历entry后，找到对应流返回 + * + * @param path 路径 + * @return 文件流 + */ + public InputStream get(String path) { + if (null != this.zipFile) { + final ZipFile zipFile = this.zipFile; + final ZipEntry entry = zipFile.getEntry(path); + if (null != entry) { + return ZipUtil.getStream(zipFile, entry); + } + } else { + try { + this.in.reset(); + ZipEntry zipEntry; + while (null != (zipEntry = in.getNextEntry())) { + if (zipEntry.getName().equals(path)) { + return this.in; + } + } + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + return null; + } + + /** + * 解压到指定目录中 + * + * @param outFile 解压到的目录 + * @return 解压的目录 + * @throws IORuntimeException IO异常 + */ + public File readTo(File outFile) throws IORuntimeException { + return readTo(outFile, null); + } + + /** + * 解压到指定目录中 + * + * @param outFile 解压到的目录 + * @param entryFilter 过滤器，排除不需要的文件 + * @return 解压的目录 + * @throws IORuntimeException IO异常 + * @since 5.7.12 + */ + public File readTo(File outFile, Filter entryFilter) throws IORuntimeException { + read((zipEntry) -> { + if (null == entryFilter || entryFilter.accept(zipEntry)) { + //gitee issue #I4ZDQI + String path = zipEntry.getName(); + if (FileUtil.isWindows()) { + // Win系统下 + path = StrUtil.replace(path, "*", "_"); + } + // FileUtil.file会检查slip漏洞，漏洞说明见http://blog.nsfocus.net/zip-slip-2/ + final File outItemFile = FileUtil.file(outFile, path); + if (zipEntry.isDirectory()) { + // 目录 + //noinspection ResultOfMethodCallIgnored + outItemFile.mkdirs(); + } else { + InputStream in; + if (null != this.zipFile) { + in = ZipUtil.getStream(this.zipFile, zipEntry); + } else { + in = this.in; + } + // 文件 + FileUtil.writeFromStream(in, outItemFile, false); + } + } + }); + return outFile; + } + + /** + * 读取并处理Zip文件中的每一个{@link ZipEntry} + * + * @param consumer {@link ZipEntry}处理器 + * @return this + * @throws IORuntimeException IO异常 + */ + public ZipReader read(Consumer consumer) throws IORuntimeException { + if (null != this.zipFile) { + readFromZipFile(consumer); + } else { + readFromStream(consumer); + } + return this; + } + + @Override + public void close() throws IORuntimeException { + if (null != this.zipFile) { + IoUtil.close(this.zipFile); + } else { + IoUtil.close(this.in); + } + } + + /** + * 读取并处理Zip文件中的每一个{@link ZipEntry} + * + * @param consumer {@link ZipEntry}处理器 + */ + private void readFromZipFile(Consumer consumer) { + final Enumeration em = zipFile.entries(); + while (em.hasMoreElements()) { + consumer.accept(checkZipBomb(em.nextElement())); + } + } + + /** + * 读取并处理Zip流中的每一个{@link ZipEntry} + * + * @param consumer {@link ZipEntry}处理器 + * @throws IORuntimeException IO异常 + */ + private void readFromStream(Consumer consumer) throws IORuntimeException { + try { + ZipEntry zipEntry; + while (null != (zipEntry = in.getNextEntry())) { + consumer.accept(checkZipBomb(zipEntry)); + } + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 检查Zip bomb漏洞 + * + * @param entry {@link ZipEntry} + * @return 检查后的{@link ZipEntry} + */ + private static ZipEntry checkZipBomb(ZipEntry entry) { + if (null == entry) { + return null; + } + final long compressedSize = entry.getCompressedSize(); + final long uncompressedSize = entry.getSize(); + if (compressedSize < 0 || uncompressedSize < 0 || + // 默认压缩比例是100倍，一旦发现压缩率超过这个阈值，被认为是Zip bomb + compressedSize * MAX_SIZE_DIFF < uncompressedSize) { + throw new UtilException("Zip bomb attack detected, invalid sizes: compressed {}, uncompressed {}, name {}", + compressedSize, uncompressedSize, entry.getName()); + } + return entry; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/ZipWriter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/ZipWriter.java new file mode 100755 index 0000000..b8036cb --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/ZipWriter.java @@ -0,0 +1,287 @@ +package aiyh.utils.tool.cn.hutool.core.compress; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.io.resource.Resource; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import aiyh.utils.tool.cn.hutool.core.util.ZipUtil; + +import java.io.Closeable; +import java.io.File; +import java.io.FileFilter; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.charset.Charset; +import java.util.zip.ZipEntry; +import java.util.zip.ZipOutputStream; + +/** + * Zip生成封装 + * + * @author looly + * @since 5.7.8 + */ +public class ZipWriter implements Closeable { + + /** + * 创建ZipWriter + * + * @param zipFile 生成的Zip文件 + * @param charset 编码 + * @return ZipWriter + */ + public static ZipWriter of(File zipFile, Charset charset) { + return new ZipWriter(zipFile, charset); + } + + /** + * 创建ZipWriter + * + * @param out Zip输出的流，一般为输出文件流 + * @param charset 编码 + * @return ZipWriter + */ + public static ZipWriter of(OutputStream out, Charset charset) { + return new ZipWriter(out, charset); + } + + private final ZipOutputStream out; + + /** + * 构造 + * + * @param zipFile 生成的Zip文件 + * @param charset 编码 + */ + public ZipWriter(File zipFile, Charset charset) { + this.out = getZipOutputStream(zipFile, charset); + } + + /** + * 构造 + * + * @param out {@link ZipOutputStream} + * @param charset 编码 + */ + public ZipWriter(OutputStream out, Charset charset) { + this.out = ZipUtil.getZipOutputStream(out, charset); + } + + /** + * 构造 + * + * @param out {@link ZipOutputStream} + */ + public ZipWriter(ZipOutputStream out) { + this.out = out; + } + + /** + * 设置压缩级别，可选1~9，-1表示默认 + * + * @param level 压缩级别 + * @return this + */ + public ZipWriter setLevel(int level) { + this.out.setLevel(level); + return this; + } + + /** + * 设置注释 + * + * @param comment 注释 + * @return this + */ + public ZipWriter setComment(String comment) { + this.out.setComment(comment); + return this; + } + + /** + * 获取原始的{@link ZipOutputStream} + * + * @return {@link ZipOutputStream} + */ + public ZipOutputStream getOut() { + return this.out; + } + + /** + * 对文件或文件目录进行压缩 + * + * @param withSrcDir 是否包含被打包目录，只针对压缩目录有效。若为false，则只压缩目录下的文件或目录，为true则将本目录也压缩 + * @param filter 文件过滤器，通过实现此接口，自定义要过滤的文件（过滤掉哪些文件或文件夹不加入压缩），{@code null}表示不过滤 + * @param files 要压缩的源文件或目录。如果压缩一个文件，则为该文件的全路径；如果压缩一个目录，则为该目录的顶层目录路径 + * @return this + * @throws IORuntimeException IO异常 + * @since 5.1.1 + */ + public ZipWriter add(boolean withSrcDir, FileFilter filter, File... files) throws IORuntimeException { + for (File file : files) { + // 如果只是压缩一个文件，则需要截取该文件的父目录 + String srcRootDir; + try { + srcRootDir = file.getCanonicalPath(); + if ((false == file.isDirectory()) || withSrcDir) { + // 若是文件，则将父目录完整路径都截取掉；若设置包含目录，则将上级目录全部截取掉，保留本目录名 + srcRootDir = file.getCanonicalFile().getParentFile().getCanonicalPath(); + } + } catch (IOException e) { + throw new IORuntimeException(e); + } + + _add(file, srcRootDir, filter); + } + return this; + } + + /** + * 添加资源到压缩包，添加后关闭资源流 + * + * @param resources 需要压缩的资源，资源的路径为{@link Resource#getName()} + * @return this + * @throws IORuntimeException IO异常 + */ + public ZipWriter add(Resource... resources) throws IORuntimeException { + for (Resource resource : resources) { + if (null != resource) { + add(resource.getName(), resource.getStream()); + } + } + return this; + } + + /** + * 添加文件流到压缩包，添加后关闭输入文件流
+ * 如果输入流为{@code null}，则只创建空目录 + * + * @param path 压缩的路径, {@code null}和""表示根目录下 + * @param in 需要压缩的输入流，使用完后自动关闭，{@code null}表示加入空目录 + * @return this + * @throws IORuntimeException IO异常 + */ + public ZipWriter add(String path, InputStream in) throws IORuntimeException { + path = StrUtil.nullToEmpty(path); + if (null == in) { + // 空目录需要检查路径规范性，目录以"/"结尾 + path = StrUtil.addSuffixIfNot(path, StrUtil.SLASH); + if (StrUtil.isBlank(path)) { + return this; + } + } + + return putEntry(path, in); + } + + /** + * 对流中的数据加入到压缩文件
+ * 路径列表和流列表长度必须一致 + * + * @param paths 流数据在压缩文件中的路径或文件名 + * @param ins 要压缩的源，添加完成后自动关闭流 + * @return 压缩文件 + * @throws IORuntimeException IO异常 + * @since 5.8.0 + */ + public ZipWriter add(String[] paths, InputStream[] ins) throws IORuntimeException { + if (ArrayUtil.isEmpty(paths) || ArrayUtil.isEmpty(ins)) { + throw new IllegalArgumentException("Paths or ins is empty !"); + } + if (paths.length != ins.length) { + throw new IllegalArgumentException("Paths length is not equals to ins length !"); + } + + for (int i = 0; i < paths.length; i++) { + add(paths[i], ins[i]); + } + + return this; + } + + @Override + public void close() throws IORuntimeException { + try { + out.finish(); + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + IoUtil.close(this.out); + } + } + + /** + * 获得 {@link ZipOutputStream} + * + * @param zipFile 压缩文件 + * @param charset 编码 + * @return {@link ZipOutputStream} + */ + private static ZipOutputStream getZipOutputStream(File zipFile, Charset charset) { + return ZipUtil.getZipOutputStream(FileUtil.getOutputStream(zipFile), charset); + } + + /** + * 递归压缩文件夹或压缩文件
+ * srcRootDir决定了路径截取的位置，例如：
+ * file的路径为d:/a/b/c/d.txt，srcRootDir为d:/a/b，则压缩后的文件与目录为结构为c/d.txt + * + * @param srcRootDir 被压缩的文件夹根目录 + * @param file 当前递归压缩的文件或目录对象 + * @param filter 文件过滤器，通过实现此接口，自定义要过滤的文件（过滤掉哪些文件或文件夹不加入压缩），{@code null}表示不过滤 + * @throws IORuntimeException IO异常 + */ + private ZipWriter _add(File file, String srcRootDir, FileFilter filter) throws IORuntimeException { + if (null == file || (null != filter && false == filter.accept(file))) { + return this; + } + + // 获取文件相对于压缩文件夹根目录的子路径 + final String subPath = FileUtil.subPath(srcRootDir, file); + if (file.isDirectory()) { + // 如果是目录，则压缩压缩目录中的文件或子目录 + final File[] files = file.listFiles(); + if (ArrayUtil.isEmpty(files)) { + // 加入目录，只有空目录时才加入目录，非空时会在创建文件时自动添加父级目录 + add(subPath, null); + } else { + // 压缩目录下的子文件或目录 + for (File childFile : files) { + _add(childFile, srcRootDir, filter); + } + } + } else { + // 如果是文件或其它符号，则直接压缩该文件 + putEntry(subPath, FileUtil.getInputStream(file)); + } + return this; + } + + /** + * 添加文件流到压缩包，添加后关闭输入文件流
+ * 如果输入流为{@code null}，则只创建空目录 + * + * @param path 压缩的路径, {@code null}和""表示根目录下 + * @param in 需要压缩的输入流，使用完后自动关闭，{@code null}表示加入空目录 + * @throws IORuntimeException IO异常 + */ + private ZipWriter putEntry(String path, InputStream in) throws IORuntimeException { + try { + out.putNextEntry(new ZipEntry(path)); + if (null != in) { + IoUtil.copy(in, out); + } + out.closeEntry(); + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + IoUtil.close(in); + } + + IoUtil.flush(this.out); + return this; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/package-info.java new file mode 100755 index 0000000..1d59b8a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/compress/package-info.java @@ -0,0 +1,7 @@ +/** + * 压缩解压封装 + * + * @author looly + * @since 5.7.8 + */ +package aiyh.utils.tool.cn.hutool.core.compress; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/AbstractConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/AbstractConverter.java new file mode 100644 index 0000000..5991d04 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/AbstractConverter.java @@ -0,0 +1,117 @@ +package aiyh.utils.tool.cn.hutool.core.convert; + +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.util.Map; + +/** + * 抽象转换器，提供通用的转换逻辑，同时通过convertInternal实现对应类型的专属逻辑
+ * 转换器不会抛出转换异常，转换失败时会返回{@code null} + * + * @author Looly + * + */ +public abstract class AbstractConverter implements Converter, Serializable { + private static final long serialVersionUID = 1L; + + /** + * 不抛异常转换
+ * 当转换失败时返回默认值 + * + * @param value 被转换的值 + * @param defaultValue 默认值 + * @return 转换后的值 + * @since 4.5.7 + */ + public T convertQuietly(Object value, T defaultValue) { + try { + return convert(value, defaultValue); + } catch (Exception e) { + return defaultValue; + } + } + + @Override + @SuppressWarnings("unchecked") + public T convert(Object value, T defaultValue) { + Class targetType = getTargetType(); + if (null == targetType && null == defaultValue) { + throw new NullPointerException(StrUtil.format("[type] and [defaultValue] are both null for Converter [{}], we can not know what type to convert !", this.getClass().getName())); + } + if (null == targetType) { + // 目标类型不确定时使用默认值的类型 + targetType = (Class) defaultValue.getClass(); + } + if (null == value) { + return defaultValue; + } + + if (null == defaultValue || targetType.isInstance(defaultValue)) { + if (targetType.isInstance(value) && false == Map.class.isAssignableFrom(targetType)) { + // 除Map外，已经是目标类型，不需要转换（Map类型涉及参数类型，需要单独转换） + return targetType.cast(value); + } + final T result = convertInternal(value); + return ((null == result) ? defaultValue : result); + } else { + throw new IllegalArgumentException( + StrUtil.format("Default value [{}]({}) is not the instance of [{}]", defaultValue, defaultValue.getClass(), targetType)); + } + } + + /** + * 内部转换器，被 {@link AbstractConverter#convert(Object, Object)} 调用，实现基本转换逻辑
+ * 内部转换器转换后如果转换失败可以做如下操作，处理结果都为返回默认值： + * + * 
+	 * 1、返回{@code null}
+	 * 2、抛出一个{@link RuntimeException}异常
+	 *
+ * + * @param value 值 + * @return 转换后的类型 + */ + protected abstract T convertInternal(Object value); + + /** + * 值转为String，用于内部转换中需要使用String中转的情况
+ * 转换规则为： + * + * 
+	 * 1、字符串类型将被强转
+	 * 2、数组将被转换为逗号分隔的字符串
+	 * 3、其它类型将调用默认的toString()方法
+	 *
+ * + * @param value 值 + * @return String + */ + protected String convertToStr(Object value) { + if (null == value) { + return null; + } + if (value instanceof CharSequence) { + return value.toString(); + } else if (ArrayUtil.isArray(value)) { + return ArrayUtil.toString(value); + } else if(CharUtil.isChar(value)) { + //对于ASCII字符使用缓存加速转换，减少空间创建 + return CharUtil.toString((char)value); + } + return value.toString(); + } + + /** + * 获得此类实现类的泛型类型 + * + * @return 此类的泛型类型，可能为{@code null} + */ + @SuppressWarnings("unchecked") + public Class getTargetType() { + return (Class) ClassUtil.getTypeArgument(getClass()); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/BasicType.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/BasicType.java new file mode 100644 index 0000000..9ccb61b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/BasicType.java @@ -0,0 +1,60 @@ +package aiyh.utils.tool.cn.hutool.core.convert; + +import aiyh.utils.tool.cn.hutool.core.map.SafeConcurrentHashMap; + +import java.util.Map; + +/** + * 基本变量类型的枚举
+ * 基本类型枚举包括原始类型和包装类型 + * @author xiaoleilu + */ +public enum BasicType { + BYTE, SHORT, INT, INTEGER, LONG, DOUBLE, FLOAT, BOOLEAN, CHAR, CHARACTER, STRING; + + /** 包装类型为Key，原始类型为Value，例如： Integer.class =》 int.class. */ + public static final Map, Class> WRAPPER_PRIMITIVE_MAP = new SafeConcurrentHashMap<>(8); + /** 原始类型为Key，包装类型为Value，例如： int.class =》 Integer.class. */ + public static final Map, Class> PRIMITIVE_WRAPPER_MAP = new SafeConcurrentHashMap<>(8); + + static { + WRAPPER_PRIMITIVE_MAP.put(Boolean.class, boolean.class); + WRAPPER_PRIMITIVE_MAP.put(Byte.class, byte.class); + WRAPPER_PRIMITIVE_MAP.put(Character.class, char.class); + WRAPPER_PRIMITIVE_MAP.put(Double.class, double.class); + WRAPPER_PRIMITIVE_MAP.put(Float.class, float.class); + WRAPPER_PRIMITIVE_MAP.put(Integer.class, int.class); + WRAPPER_PRIMITIVE_MAP.put(Long.class, long.class); + WRAPPER_PRIMITIVE_MAP.put(Short.class, short.class); + + for (Map.Entry, Class> entry : WRAPPER_PRIMITIVE_MAP.entrySet()) { + PRIMITIVE_WRAPPER_MAP.put(entry.getValue(), entry.getKey()); + } + } + + /** + * 原始类转为包装类，非原始类返回原类 + * @param clazz 原始类 + * @return 包装类 + */ + public static Class wrap(Class clazz){ + if(null == clazz || false == clazz.isPrimitive()){ + return clazz; + } + Class result = PRIMITIVE_WRAPPER_MAP.get(clazz); + return (null == result) ? clazz : result; + } + + /** + * 包装类转为原始类，非包装类返回原类 + * @param clazz 包装类 + * @return 原始类 + */ + public static Class unWrap(Class clazz){ + if(null == clazz || clazz.isPrimitive()){ + return clazz; + } + Class result = WRAPPER_PRIMITIVE_MAP.get(clazz); + return (null == result) ? clazz : result; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/CastUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/CastUtil.java new file mode 100644 index 0000000..7798b8f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/CastUtil.java @@ -0,0 +1,118 @@ +package aiyh.utils.tool.cn.hutool.core.convert; + +import java.util.Collection; +import java.util.List; +import java.util.Map; +import java.util.Set; + +/** + * 转换工具类，提供集合、Map等向上向下转换工具 + * + * @author looly + * @since 5.8.1 + */ +public class CastUtil { + /** + * 泛型集合向上转型。例如将Collection<Integer>转换为Collection<Number> + * + * @param collection 集合 + * @param 元素类型 + * @return 转换后的集合 + * @since 5.8.1 + */ + @SuppressWarnings("unchecked") + public static Collection castUp(Collection collection) { + return (Collection) collection; + } + + /** + * 泛型集合向下转型。例如将Collection<Number>转换为Collection<Integer> + * + * @param collection 集合 + * @param 元素类型 + * @return 转换后的集合 + * @since 5.8.1 + */ + @SuppressWarnings("unchecked") + public static Collection castDown(Collection collection) { + return (Collection) collection; + } + + /** + * 泛型集合向上转型。例如将Set<Integer>转换为Set<Number> + * + * @param set 集合 + * @param 泛型 + * @return 泛化集合 + * @since 5.8.1 + */ + @SuppressWarnings("unchecked") + public static Set castUp(Set set) { + return (Set) set; + } + + /** + * 泛型集合向下转型。例如将Set<Number>转换为Set<Integer> + * + * @param set 集合 + * @param 泛型子类 + * @return 泛化集合 + * @since 5.8.1 + */ + @SuppressWarnings("unchecked") + public static Set castDown(Set set) { + return (Set) set; + } + + /** + * 泛型接口向上转型。例如将List<Integer>转换为List<Number> + * + * @param list 集合 + * @param 泛型的父类 + * @return 泛化集合 + */ + @SuppressWarnings("unchecked") + public static List castUp(List list) { + return (List) list; + } + + /** + * 泛型集合向下转型。例如将List<Number>转换为List<Integer> + * + * @param list 集合 + * @param 泛型的子类 + * @return 泛化集合 + */ + @SuppressWarnings("unchecked") + public static List castDown(List list) { + return (List) list; + } + + /** + * 泛型集合向下转型。例如将Map<Integer, Integer>转换为Map<Number,Number> + * + * @param map 集合 + * @param 泛型父类 + * @param 泛型父类 + * @return 泛化集合 + * @since 5.8.1 + */ + @SuppressWarnings("unchecked") + public static Map castUp(Map map) { + return (Map) map; + } + + /** + * 泛型集合向下转型。例如将Map<Number,Number>转换为Map<Integer, Integer> + * + * @param map 集合 + * @param 泛型子类 + * @param 泛型子类 + * @return 泛化集合 + * @since 5.8.1 + */ + @SuppressWarnings("unchecked") + public static Map castDown(Map map) { + return (Map) map; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/Convert.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/Convert.java new file mode 100755 index 0000000..16435df --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/Convert.java @@ -0,0 +1,1162 @@ +package aiyh.utils.tool.cn.hutool.core.convert; + +import aiyh.utils.tool.cn.hutool.core.convert.impl.CollectionConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.EnumConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.MapConverter; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.TypeReference; +import aiyh.utils.tool.cn.hutool.core.text.UnicodeUtil; +import aiyh.utils.tool.cn.hutool.core.util.ByteUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.HexUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.lang.reflect.Type; +import java.math.BigDecimal; +import java.math.BigInteger; +import java.nio.charset.Charset; +import java.time.Instant; +import java.time.LocalDateTime; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Date; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.TimeUnit; + +/** + * 类型转换器 + * + * @author xiaoleilu + */ +public class Convert { + + /** + * 转换为字符串
+ * 如果给定的值为null，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + */ + public static String toStr(Object value, String defaultValue) { + return convertQuietly(String.class, value, defaultValue); + } + + /** + * 转换为字符串
+ * 如果给定的值为{@code null}，或者转换失败，返回默认值{@code null}
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + */ + public static String toStr(Object value) { + return toStr(value, null); + } + + /** + * 转换为String数组 + * + * @param value 被转换的值 + * @return String数组 + * @since 3.2.0 + */ + public static String[] toStrArray(Object value) { + return convert(String[].class, value); + } + + /** + * 转换为字符
+ * 如果给定的值为null，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + */ + public static Character toChar(Object value, Character defaultValue) { + return convertQuietly(Character.class, value, defaultValue); + } + + /** + * 转换为字符
+ * 如果给定的值为{@code null}，或者转换失败，返回默认值{@code null}
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + */ + public static Character toChar(Object value) { + return toChar(value, null); + } + + /** + * 转换为Character数组 + * + * @param value 被转换的值 + * @return Character数组 + * @since 3.2.0 + */ + public static Character[] toCharArray(Object value) { + return convert(Character[].class, value); + } + + /** + * 转换为byte
+ * 如果给定的值为{@code null}，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + */ + public static Byte toByte(Object value, Byte defaultValue) { + return convertQuietly(Byte.class, value, defaultValue); + } + + /** + * 转换为byte
+ * 如果给定的值为{@code null}，或者转换失败，返回默认值{@code null}
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + */ + public static Byte toByte(Object value) { + return toByte(value, null); + } + + /** + * 转换为Byte数组 + * + * @param value 被转换的值 + * @return Byte数组 + * @since 3.2.0 + */ + public static Byte[] toByteArray(Object value) { + return convert(Byte[].class, value); + } + + /** + * 转换为Byte数组 + * + * @param value 被转换的值 + * @return Byte数组 + * @since 5.1.1 + */ + public static byte[] toPrimitiveByteArray(Object value) { + return convert(byte[].class, value); + } + + /** + * 转换为Short
+ * 如果给定的值为{@code null}，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + */ + public static Short toShort(Object value, Short defaultValue) { + return convertQuietly(Short.class, value, defaultValue); + } + + /** + * 转换为Short
+ * 如果给定的值为{@code null}，或者转换失败，返回默认值{@code null}
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + */ + public static Short toShort(Object value) { + return toShort(value, null); + } + + /** + * 转换为Short数组 + * + * @param value 被转换的值 + * @return Short数组 + * @since 3.2.0 + */ + public static Short[] toShortArray(Object value) { + return convert(Short[].class, value); + } + + /** + * 转换为Number
+ * 如果给定的值为空，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + */ + public static Number toNumber(Object value, Number defaultValue) { + return convertQuietly(Number.class, value, defaultValue); + } + + /** + * 转换为Number
+ * 如果给定的值为空，或者转换失败，返回默认值{@code null}
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + */ + public static Number toNumber(Object value) { + return toNumber(value, null); + } + + /** + * 转换为Number数组 + * + * @param value 被转换的值 + * @return Number数组 + * @since 3.2.0 + */ + public static Number[] toNumberArray(Object value) { + return convert(Number[].class, value); + } + + /** + * 转换为int
+ * 如果给定的值为空，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + */ + public static Integer toInt(Object value, Integer defaultValue) { + return convertQuietly(Integer.class, value, defaultValue); + } + + /** + * 转换为int
+ * 如果给定的值为{@code null}，或者转换失败，返回默认值{@code null}
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + */ + public static Integer toInt(Object value) { + return toInt(value, null); + } + + /** + * 转换为Integer数组
+ * + * @param value 被转换的值 + * @return 结果 + */ + public static Integer[] toIntArray(Object value) { + return convert(Integer[].class, value); + } + + /** + * 转换为long
+ * 如果给定的值为空，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + */ + public static Long toLong(Object value, Long defaultValue) { + return convertQuietly(Long.class, value, defaultValue); + } + + /** + * 转换为long
+ * 如果给定的值为{@code null}，或者转换失败，返回默认值{@code null}
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + */ + public static Long toLong(Object value) { + return toLong(value, null); + } + + /** + * 转换为Long数组
+ * + * @param value 被转换的值 + * @return 结果 + */ + public static Long[] toLongArray(Object value) { + return convert(Long[].class, value); + } + + /** + * 转换为double
+ * 如果给定的值为空，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + */ + public static Double toDouble(Object value, Double defaultValue) { + return convertQuietly(Double.class, value, defaultValue); + } + + /** + * 转换为double
+ * 如果给定的值为空，或者转换失败，返回默认值{@code null}
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + */ + public static Double toDouble(Object value) { + return toDouble(value, null); + } + + /** + * 转换为Double数组
+ * + * @param value 被转换的值 + * @return 结果 + */ + public static Double[] toDoubleArray(Object value) { + return convert(Double[].class, value); + } + + /** + * 转换为Float
+ * 如果给定的值为空，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + */ + public static Float toFloat(Object value, Float defaultValue) { + return convertQuietly(Float.class, value, defaultValue); + } + + /** + * 转换为Float
+ * 如果给定的值为空，或者转换失败，返回默认值{@code null}
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + */ + public static Float toFloat(Object value) { + return toFloat(value, null); + } + + /** + * 转换为Float数组
+ * + * @param value 被转换的值 + * @return 结果 + */ + public static Float[] toFloatArray(Object value) { + return convert(Float[].class, value); + } + + /** + * 转换为boolean
+ * String支持的值为：true、false、yes、ok、no，1,0 如果给定的值为空，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + */ + public static Boolean toBool(Object value, Boolean defaultValue) { + return convertQuietly(Boolean.class, value, defaultValue); + } + + /** + * 转换为boolean
+ * 如果给定的值为空，或者转换失败，返回默认值{@code null}
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + */ + public static Boolean toBool(Object value) { + return toBool(value, null); + } + + /** + * 转换为Boolean数组
+ * + * @param value 被转换的值 + * @return 结果 + */ + public static Boolean[] toBooleanArray(Object value) { + return convert(Boolean[].class, value); + } + + /** + * 转换为BigInteger
+ * 如果给定的值为空，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + */ + public static BigInteger toBigInteger(Object value, BigInteger defaultValue) { + return convertQuietly(BigInteger.class, value, defaultValue); + } + + /** + * 转换为BigInteger
+ * 如果给定的值为空，或者转换失败，返回默认值{@code null}
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + */ + public static BigInteger toBigInteger(Object value) { + return toBigInteger(value, null); + } + + /** + * 转换为BigDecimal
+ * 如果给定的值为空，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + */ + public static BigDecimal toBigDecimal(Object value, BigDecimal defaultValue) { + return convertQuietly(BigDecimal.class, value, defaultValue); + } + + /** + * 转换为BigDecimal
+ * 如果给定的值为空，或者转换失败，返回null
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + */ + public static BigDecimal toBigDecimal(Object value) { + return toBigDecimal(value, null); + } + + /** + * 转换为Date
+ * 如果给定的值为空，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + * @since 4.1.6 + */ + public static Date toDate(Object value, Date defaultValue) { + return convertQuietly(Date.class, value, defaultValue); + } + + /** + * LocalDateTime
+ * 如果给定的值为空，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + * @since 5.0.7 + */ + public static LocalDateTime toLocalDateTime(Object value, LocalDateTime defaultValue) { + return convertQuietly(LocalDateTime.class, value, defaultValue); + } + + /** + * 转换为LocalDateTime
+ * 如果给定的值为空，或者转换失败，返回{@code null}
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + */ + public static LocalDateTime toLocalDateTime(Object value) { + return toLocalDateTime(value, null); + } + + /** + * Instant
+ * 如果给定的值为空，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param defaultValue 转换错误时的默认值 + * @return 结果 + * @since 5.0.7 + */ + public static Date toInstant(Object value, Date defaultValue) { + return convertQuietly(Instant.class, value, defaultValue); + } + + /** + * 转换为Date
+ * 如果给定的值为空，或者转换失败，返回{@code null}
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @return 结果 + * @since 4.1.6 + */ + public static Date toDate(Object value) { + return toDate(value, null); + } + + /** + * 转换为Enum对象
+ * 如果给定的值为空，或者转换失败，返回默认值
+ * + * @param 枚举类型 + * @param clazz Enum的Class + * @param value 值 + * @param defaultValue 默认值 + * @return Enum + */ + @SuppressWarnings("unchecked") + public static > E toEnum(Class clazz, Object value, E defaultValue) { + return (E) (new EnumConverter(clazz)).convertQuietly(value, defaultValue); + } + + /** + * 转换为Enum对象
+ * 如果给定的值为空，或者转换失败，返回默认值{@code null}
+ * + * @param 枚举类型 + * @param clazz Enum的Class + * @param value 值 + * @return Enum + */ + public static > E toEnum(Class clazz, Object value) { + return toEnum(clazz, value, null); + } + + /** + * 转换为集合类 + * + * @param collectionType 集合类型 + * @param elementType 集合中元素类型 + * @param value 被转换的值 + * @return {@link Collection} + * @since 3.0.8 + */ + public static Collection toCollection(Class collectionType, Class elementType, Object value) { + return new CollectionConverter(collectionType, elementType).convert(value, null); + } + + /** + * 转换为ArrayList，元素类型默认Object + * + * @param value 被转换的值 + * @return {@link List} + * @since 4.1.11 + */ + public static List toList(Object value) { + return convert(List.class, value); + } + + /** + * 转换为ArrayList + * + * @param 元素类型 + * @param elementType 集合中元素类型 + * @param value 被转换的值 + * @return {@link ArrayList} + * @since 4.1.20 + */ + @SuppressWarnings("unchecked") + public static List toList(Class elementType, Object value) { + return (List) toCollection(ArrayList.class, elementType, value); + } + + /** + * 转换为HashSet + * + * @param 元素类型 + * @param elementType 集合中元素类型 + * @param value 被转换的值 + * @return {@link HashSet} + * @since 5.7.3 + */ + @SuppressWarnings("unchecked") + public static Set toSet(Class elementType, Object value) { + return (Set) toCollection(HashSet.class, elementType, value); + } + + /** + * 转换为Map，若value原本就是Map，则转为原始类型，若不是则默认转为HashMap + * + * @param 键类型 + * @param 值类型 + * @param keyType 键类型 + * @param valueType 值类型 + * @param value 被转换的值 + * @return {@link Map} + * @since 4.6.8 + */ + @SuppressWarnings("unchecked") + public static Map toMap(Class keyType, Class valueType, Object value) { + if (value instanceof Map) { + return toMap((Class>) value.getClass(), keyType, valueType, value); + } else { + return toMap(HashMap.class, keyType, valueType, value); + } + } + + /** + * 转换为Map + * + * @param mapType 转后的具体Map类型 + * @param 键类型 + * @param 值类型 + * @param keyType 键类型 + * @param valueType 值类型 + * @param value 被转换的值 + * @return {@link Map} + */ + @SuppressWarnings({"unchecked", "rawtypes"}) + public static Map toMap(Class mapType, Class keyType, Class valueType, Object value) { + return (Map) new MapConverter(mapType, keyType, valueType).convert(value, null); + } + + /** + * 转换值为指定类型，类型采用字符串表示 + * + * @param 目标类型 + * @param className 类的字符串表示 + * @param value 值 + * @return 转换后的值 + * @throws ConvertException 转换器不存在 + * @since 4.0.7 + */ + public static T convertByClassName(String className, Object value) throws ConvertException { + return convert(ClassUtil.loadClass(className), value); + } + + /** + * 转换值为指定类型 + * + * @param 目标类型 + * @param type 类型 + * @param value 值 + * @return 转换后的值 + * @throws ConvertException 转换器不存在 + * @since 4.0.0 + */ + public static T convert(Class type, Object value) throws ConvertException { + return convert((Type) type, value); + } + + /** + * 转换值为指定类型 + * + * @param 目标类型 + * @param reference 类型参考，用于持有转换后的泛型类型 + * @param value 值 + * @return 转换后的值 + * @throws ConvertException 转换器不存在 + */ + public static T convert(TypeReference reference, Object value) throws ConvertException { + return convert(reference.getType(), value, null); + } + + /** + * 转换值为指定类型 + * + * @param 目标类型 + * @param type 类型 + * @param value 值 + * @return 转换后的值 + * @throws ConvertException 转换器不存在 + */ + public static T convert(Type type, Object value) throws ConvertException { + return convert(type, value, null); + } + + /** + * 转换值为指定类型 + * + * @param 目标类型 + * @param type 类型 + * @param value 值 + * @param defaultValue 默认值 + * @return 转换后的值 + * @throws ConvertException 转换器不存在 + * @since 4.0.0 + */ + public static T convert(Class type, Object value, T defaultValue) throws ConvertException { + return convert((Type) type, value, defaultValue); + } + + /** + * 转换值为指定类型 + * + * @param 目标类型 + * @param type 类型 + * @param value 值 + * @param defaultValue 默认值 + * @return 转换后的值 + * @throws ConvertException 转换器不存在 + */ + public static T convert(Type type, Object value, T defaultValue) throws ConvertException { + return convertWithCheck(type, value, defaultValue, false); + } + + /** + * 转换值为指定类型，不抛异常转换
+ * 当转换失败时返回{@code null} + * + * @param 目标类型 + * @param type 目标类型 + * @param value 值 + * @return 转换后的值，转换失败返回null + * @since 4.5.10 + */ + public static T convertQuietly(Type type, Object value) { + return convertQuietly(type, value, null); + } + + /** + * 转换值为指定类型，不抛异常转换
+ * 当转换失败时返回默认值 + * + * @param 目标类型 + * @param type 目标类型 + * @param value 值 + * @param defaultValue 默认值 + * @return 转换后的值 + * @since 4.5.10 + */ + public static T convertQuietly(Type type, Object value, T defaultValue) { + return convertWithCheck(type, value, defaultValue, true); + } + + /** + * 转换值为指定类型，可选是否不抛异常转换
+ * 当转换失败时返回默认值 + * + * @param 目标类型 + * @param type 目标类型 + * @param value 值 + * @param defaultValue 默认值 + * @param quietly 是否静默转换，true不抛异常 + * @return 转换后的值 + * @since 5.3.2 + */ + public static T convertWithCheck(Type type, Object value, T defaultValue, boolean quietly) { + final ConverterRegistry registry = ConverterRegistry.getInstance(); + try { + return registry.convert(type, value, defaultValue); + } catch (Exception e) { + if (quietly) { + return defaultValue; + } + throw e; + } + } + + // ----------------------------------------------------------------------- 全角半角转换 + + /** + * 半角转全角，{@code null}返回{@code null} + * + * @param input String. + * @return 全角字符串，{@code null}返回{@code null} + */ + public static String toSBC(String input) { + return toSBC(input, null); + } + + /** + * 半角转全角，{@code null}返回{@code null} + * + * @param input String + * @param notConvertSet 不替换的字符集合 + * @return 全角字符串，{@code null}返回{@code null} + */ + public static String toSBC(String input, Set notConvertSet) { + if (StrUtil.isEmpty(input)) { + return input; + } + final char[] c = input.toCharArray(); + for (int i = 0; i < c.length; i++) { + if (null != notConvertSet && notConvertSet.contains(c[i])) { + // 跳过不替换的字符 + continue; + } + + if (c[i] == CharUtil.SPACE) { + c[i] = '\u3000'; + } else if (c[i] < '\177') { + c[i] = (char) (c[i] + 65248); + } + } + return new String(c); + } + + /** + * 全角转半角 + * + * @param input String. + * @return 半角字符串 + */ + public static String toDBC(String input) { + return toDBC(input, null); + } + + /** + * 替换全角为半角 + * + * @param text 文本 + * @param notConvertSet 不替换的字符集合 + * @return 替换后的字符 + */ + public static String toDBC(String text, Set notConvertSet) { + if (StrUtil.isBlank(text)) { + return text; + } + final char[] c = text.toCharArray(); + for (int i = 0; i < c.length; i++) { + if (null != notConvertSet && notConvertSet.contains(c[i])) { + // 跳过不替换的字符 + continue; + } + + if (c[i] == '\u3000' || c[i] == '\u00a0' || c[i] == '\u2007' || c[i] == '\u202F') { + // \u3000是中文全角空格，\u00a0、\u2007、\u202F是不间断空格 + c[i] = ' '; + } else if (c[i] > '\uFF00' && c[i] < '\uFF5F') { + c[i] = (char) (c[i] - 65248); + } + } + + return new String(c); + } + + // --------------------------------------------------------------------- hex + + /** + * 字符串转换成十六进制字符串，结果为小写 + * + * @param str 待转换的ASCII字符串 + * @param charset 编码 + * @return 16进制字符串 + * @see HexUtil#encodeHexStr(String, Charset) + */ + public static String toHex(String str, Charset charset) { + return HexUtil.encodeHexStr(str, charset); + } + + /** + * byte数组转16进制串 + * + * @param bytes 被转换的byte数组 + * @return 转换后的值 + * @see HexUtil#encodeHexStr(byte[]) + */ + public static String toHex(byte[] bytes) { + return HexUtil.encodeHexStr(bytes); + } + + /** + * Hex字符串转换为Byte值 + * + * @param src Byte字符串，每个Byte之间没有分隔符 + * @return byte[] + * @see HexUtil#decodeHex(char[]) + */ + public static byte[] hexToBytes(String src) { + return HexUtil.decodeHex(src.toCharArray()); + } + + /** + * 十六进制转换字符串 + * + * @param hexStr Byte字符串(Byte之间无分隔符 如:[616C6B]) + * @param charset 编码 {@link Charset} + * @return 对应的字符串 + * @see HexUtil#decodeHexStr(String, Charset) + * @since 4.1.11 + */ + public static String hexToStr(String hexStr, Charset charset) { + return HexUtil.decodeHexStr(hexStr, charset); + } + + /** + * String的字符串转换成unicode的String + * + * @param strText 全角字符串 + * @return String 每个unicode之间无分隔符 + * @see UnicodeUtil#toUnicode(String) + */ + public static String strToUnicode(String strText) { + return UnicodeUtil.toUnicode(strText); + } + + /** + * unicode的String转换成String的字符串 + * + * @param unicode Unicode符 + * @return String 字符串 + * @see UnicodeUtil#toString(String) + */ + public static String unicodeToStr(String unicode) { + return UnicodeUtil.toString(unicode); + } + + /** + * 给定字符串转换字符编码
+ * 如果参数为空，则返回原字符串，不报错。 + * + * @param str 被转码的字符串 + * @param sourceCharset 原字符集 + * @param destCharset 目标字符集 + * @return 转换后的字符串 + * @see CharsetUtil#convert(String, String, String) + */ + public static String convertCharset(String str, String sourceCharset, String destCharset) { + if (StrUtil.hasBlank(str, sourceCharset, destCharset)) { + return str; + } + + return CharsetUtil.convert(str, sourceCharset, destCharset); + } + + /** + * 转换时间单位 + * + * @param sourceDuration 时长 + * @param sourceUnit 源单位 + * @param destUnit 目标单位 + * @return 目标单位的时长 + */ + public static long convertTime(long sourceDuration, TimeUnit sourceUnit, TimeUnit destUnit) { + Assert.notNull(sourceUnit, "sourceUnit is null !"); + Assert.notNull(destUnit, "destUnit is null !"); + return destUnit.convert(sourceDuration, sourceUnit); + } + + // --------------------------------------------------------------- 原始包装类型转换 + + /** + * 原始类转为包装类，非原始类返回原类 + * + * @param clazz 原始类 + * @return 包装类 + * @see BasicType#wrap(Class) + * @see BasicType#wrap(Class) + */ + public static Class wrap(Class clazz) { + return BasicType.wrap(clazz); + } + + /** + * 包装类转为原始类，非包装类返回原类 + * + * @param clazz 包装类 + * @return 原始类 + * @see BasicType#unWrap(Class) + * @see BasicType#unWrap(Class) + */ + public static Class unWrap(Class clazz) { + return BasicType.unWrap(clazz); + } + + // -------------------------------------------------------------------------- 数字和英文转换 + + /** + * 将阿拉伯数字转为英文表达方式 + * + * @param number {@link Number}对象 + * @return 英文表达式 + * @since 3.0.9 + */ + public static String numberToWord(Number number) { + return NumberWordFormatter.format(number); + } + + /** + * 将阿拉伯数字转为精简表示形式，例如: + * + * 
+	 *     1200 -》 1.2k
+	 *
+ * + * @param number {@link Number}对象 + * @return 英文表达式 + * @since 5.5.9 + */ + public static String numberToSimple(Number number) { + return NumberWordFormatter.formatSimple(number.longValue()); + } + + /** + * 将阿拉伯数字转为中文表达方式 + * + * @param number 数字 + * @param isUseTraditional 是否使用繁体字（金额形式） + * @return 中文 + * @since 3.2.3 + */ + public static String numberToChinese(double number, boolean isUseTraditional) { + return NumberChineseFormatter.format(number, isUseTraditional); + } + + /** + * 数字中文表示形式转数字 + *
    + *
  • 一百一十二 -》 112
    • + *
  • 一千零一十二 -》 1012
    • + *
+ * + * @param number 数字中文表示 + * @return 数字 + * @since 5.6.0 + */ + public static int chineseToNumber(String number) { + return NumberChineseFormatter.chineseToNumber(number); + } + + /** + * 金额转为中文形式 + * + * @param n 数字 + * @return 中文大写数字 + * @since 3.2.3 + */ + public static String digitToChinese(Number n) { + if (null == n) { + return "零"; + } + return NumberChineseFormatter.format(n.doubleValue(), true, true); + } + + /** + * 中文大写数字金额转换为数字，返回结果以元为单位的BigDecimal类型数字
+ * 如： + * “陆万柒仟伍佰伍拾陆元叁角贰分”返回“67556.32” + * “叁角贰分”返回“0.32” + * + * @param chineseMoneyAmount 中文大写数字金额 + * @return 返回结果以元为单位的BigDecimal类型数字 + * @since 5.8.5 + */ + public static BigDecimal chineseMoneyToNumber(String chineseMoneyAmount) { + return NumberChineseFormatter.chineseMoneyToNumber(chineseMoneyAmount); + } + + // -------------------------------------------------------------------------- 数字转换 + + /** + * int转byte + * + * @param intValue int值 + * @return byte值 + * @since 3.2.0 + */ + public static byte intToByte(int intValue) { + return (byte) intValue; + } + + /** + * byte转无符号int + * + * @param byteValue byte值 + * @return 无符号int值 + * @since 3.2.0 + */ + public static int byteToUnsignedInt(byte byteValue) { + // Java 总是把 byte 当做有符处理；我们可以通过将其和 0xFF 进行二进制与得到它的无符值 + return byteValue & 0xFF; + } + + /** + * byte数组转short
+ * 默认以小端序转换 + * + * @param bytes byte数组 + * @return short值 + * @since 5.6.3 + */ + public static short bytesToShort(byte[] bytes) { + return ByteUtil.bytesToShort(bytes); + } + + /** + * short转byte数组
+ * 默认以小端序转换 + * + * @param shortValue short值 + * @return byte数组 + * @since 5.6.3 + */ + public static byte[] shortToBytes(short shortValue) { + return ByteUtil.shortToBytes(shortValue); + } + + /** + * byte[]转int值
+ * 默认以小端序转换 + * + * @param bytes byte数组 + * @return int值 + * @since 5.6.3 + */ + public static int bytesToInt(byte[] bytes) { + return ByteUtil.bytesToInt(bytes); + } + + /** + * int转byte数组
+ * 默认以小端序转换 + * + * @param intValue int值 + * @return byte数组 + * @since 5.6.3 + */ + public static byte[] intToBytes(int intValue) { + return ByteUtil.intToBytes(intValue); + } + + /** + * long转byte数组
+ * 默认以小端序转换
+ * from: https://stackoverflow.com/questions/4485128/how-do-i-convert-long-to-byte-and-back-in-java + * + * @param longValue long值 + * @return byte数组 + * @since 5.6.3 + */ + public static byte[] longToBytes(long longValue) { + return ByteUtil.longToBytes(longValue); + } + + /** + * byte数组转long
+ * 默认以小端序转换
+ * from: https://stackoverflow.com/questions/4485128/how-do-i-convert-long-to-byte-and-back-in-java + * + * @param bytes byte数组 + * @return long值 + * @since 5.6.3 + */ + public static long bytesToLong(byte[] bytes) { + return ByteUtil.bytesToLong(bytes); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/ConvertException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/ConvertException.java new file mode 100644 index 0000000..0bb1077 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/ConvertException.java @@ -0,0 +1,32 @@ +package aiyh.utils.tool.cn.hutool.core.convert; + +import aiyh.utils.tool.cn.hutool.core.exceptions.ExceptionUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 转换异常 + * @author xiaoleilu + */ +public class ConvertException extends RuntimeException{ + private static final long serialVersionUID = 4730597402855274362L; + + public ConvertException(Throwable e) { + super(ExceptionUtil.getMessage(e), e); + } + + public ConvertException(String message) { + super(message); + } + + public ConvertException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public ConvertException(String message, Throwable throwable) { + super(message, throwable); + } + + public ConvertException(Throwable throwable, String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params), throwable); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/Converter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/Converter.java new file mode 100644 index 0000000..59890ba --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/Converter.java @@ -0,0 +1,43 @@ +package aiyh.utils.tool.cn.hutool.core.convert; + +/** + * 转换器接口，实现类型转换 + * + * @param 转换到的目标类型 + * @author Looly + */ +public interface Converter { + + /** + * 转换为指定类型
+ * 如果类型无法确定，将读取默认值的类型做为目标类型 + * + * @param value 原始值 + * @param defaultValue 默认值 + * @return 转换后的值 + * @throws IllegalArgumentException 无法确定目标类型，且默认值为{@code null}，无法确定类型 + */ + T convert(Object value, T defaultValue) throws IllegalArgumentException; + + /** + * 转换值为指定类型，可选是否不抛异常转换
+ * 当转换失败时返回默认值 + * + * @param value 值 + * @param defaultValue 默认值 + * @param quietly 是否静默转换，true不抛异常 + * @return 转换后的值 + * @since 5.8.0 + * @see #convert(Object, Object) + */ + default T convertWithCheck(Object value, T defaultValue, boolean quietly) { + try { + return convert(value, defaultValue); + } catch (Exception e) { + if(quietly){ + return defaultValue; + } + throw e; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/ConverterRegistry.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/ConverterRegistry.java new file mode 100755 index 0000000..9358a43 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/ConverterRegistry.java @@ -0,0 +1,463 @@ +package aiyh.utils.tool.cn.hutool.core.convert; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.convert.impl.ArrayConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.AtomicBooleanConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.AtomicIntegerArrayConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.AtomicLongArrayConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.AtomicReferenceConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.BeanConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.BooleanConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.CalendarConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.CharacterConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.CharsetConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.ClassConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.CollectionConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.CurrencyConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.DateConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.DurationConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.EnumConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.LocaleConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.MapConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.NumberConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.OptConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.OptionalConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.PathConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.PeriodConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.PrimitiveConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.ReferenceConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.StackTraceElementConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.StringConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.TemporalAccessorConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.TimeZoneConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.URIConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.URLConverter; +import aiyh.utils.tool.cn.hutool.core.convert.impl.UUIDConverter; +import aiyh.utils.tool.cn.hutool.core.date.DateTime; +import aiyh.utils.tool.cn.hutool.core.lang.Opt; +import aiyh.utils.tool.cn.hutool.core.lang.TypeReference; +import aiyh.utils.tool.cn.hutool.core.map.SafeConcurrentHashMap; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import aiyh.utils.tool.cn.hutool.core.util.ServiceLoaderUtil; +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +import java.io.Serializable; +import java.lang.ref.SoftReference; +import java.lang.ref.WeakReference; +import java.lang.reflect.Type; +import java.math.BigDecimal; +import java.math.BigInteger; +import java.net.URI; +import java.net.URL; +import java.nio.charset.Charset; +import java.nio.file.Path; +import java.time.DayOfWeek; +import java.time.Duration; +import java.time.Instant; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.time.LocalTime; +import java.time.Month; +import java.time.MonthDay; +import java.time.OffsetDateTime; +import java.time.OffsetTime; +import java.time.Period; +import java.time.ZonedDateTime; +import java.time.temporal.TemporalAccessor; +import java.util.Calendar; +import java.util.Collection; +import java.util.Currency; +import java.util.Locale; +import java.util.Map; +import java.util.Optional; +import java.util.TimeZone; +import java.util.UUID; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicIntegerArray; +import java.util.concurrent.atomic.AtomicLong; +import java.util.concurrent.atomic.AtomicLongArray; +import java.util.concurrent.atomic.AtomicReference; +import java.util.concurrent.atomic.DoubleAdder; +import java.util.concurrent.atomic.LongAdder; + +/** + * 转换器登记中心 + *

+ * 将各种类型Convert对象放入登记中心，通过convert方法查找目标类型对应的转换器，将被转换对象转换之。 + *

+ *

+ * 在此类中，存放着默认转换器和自定义转换器，默认转换器是Hutool中预定义的一些转换器，自定义转换器存放用户自定的转换器。 + *

+ * + * @author Looly + */ +public class ConverterRegistry implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * 默认类型转换器 + */ + private Map> defaultConverterMap; + /** + * 用户自定义类型转换器 + */ + private volatile Map> customConverterMap; + + /** + * 类级的内部类，也就是静态的成员式内部类，该内部类的实例与外部类的实例 没有绑定关系，而且只有被调用到才会装载，从而实现了延迟加载 + */ + private static class SingletonHolder { + /** + * 静态初始化器，由JVM来保证线程安全 + */ + private static final ConverterRegistry INSTANCE = new ConverterRegistry(); + } + + /** + * 获得单例的 ConverterRegistry + * + * @return ConverterRegistry + */ + public static ConverterRegistry getInstance() { + return SingletonHolder.INSTANCE; + } + + /** + * 构造 + */ + public ConverterRegistry() { + defaultConverter(); + putCustomBySpi(); + } + + /** + * 使用SPI加载转换器 + */ + private void putCustomBySpi() { + ServiceLoaderUtil.load(Converter.class).forEach(converter -> { + try { + Type type = TypeUtil.getTypeArgument(ClassUtil.getClass(converter)); + if (null != type) { + putCustom(type, converter); + } + } catch (Exception e) { + // 忽略注册失败的 + } + }); + } + + /** + * 登记自定义转换器 + * + * @param type 转换的目标类型 + * @param converterClass 转换器类，必须有默认构造方法 + * @return ConverterRegistry + */ + public ConverterRegistry putCustom(Type type, Class> converterClass) { + return putCustom(type, ReflectUtil.newInstance(converterClass)); + } + + /** + * 登记自定义转换器 + * + * @param type 转换的目标类型 + * @param converter 转换器 + * @return ConverterRegistry + */ + public ConverterRegistry putCustom(Type type, Converter converter) { + if (null == customConverterMap) { + synchronized (this) { + if (null == customConverterMap) { + customConverterMap = new SafeConcurrentHashMap<>(); + } + } + } + customConverterMap.put(type, converter); + return this; + } + + /** + * 获得转换器
+ * + * @param 转换的目标类型 + * @param type 类型 + * @param isCustomFirst 是否自定义转换器优先 + * @return 转换器 + */ + public Converter getConverter(Type type, boolean isCustomFirst) { + Converter converter; + if (isCustomFirst) { + converter = this.getCustomConverter(type); + if (null == converter) { + converter = this.getDefaultConverter(type); + } + } else { + converter = this.getDefaultConverter(type); + if (null == converter) { + converter = this.getCustomConverter(type); + } + } + return converter; + } + + /** + * 获得默认转换器 + * + * @param 转换的目标类型（转换器转换到的类型） + * @param type 类型 + * @return 转换器 + */ + @SuppressWarnings("unchecked") + public Converter getDefaultConverter(Type type) { + return (null == defaultConverterMap) ? null : (Converter) defaultConverterMap.get(type); + } + + /** + * 获得自定义转换器 + * + * @param 转换的目标类型（转换器转换到的类型） + * @param type 类型 + * @return 转换器 + */ + @SuppressWarnings("unchecked") + public Converter getCustomConverter(Type type) { + return (null == customConverterMap) ? null : (Converter) customConverterMap.get(type); + } + + /** + * 转换值为指定类型 + * + * @param 转换的目标类型（转换器转换到的类型） + * @param type 类型目标 + * @param value 被转换值 + * @param defaultValue 默认值 + * @param isCustomFirst 是否自定义转换器优先 + * @return 转换后的值 + * @throws ConvertException 转换器不存在 + */ + @SuppressWarnings("unchecked") + public T convert(Type type, Object value, T defaultValue, boolean isCustomFirst) throws ConvertException { + if (TypeUtil.isUnknown(type) && null == defaultValue) { + // 对于用户不指定目标类型的情况，返回原值 + return (T) value; + } + if (ObjectUtil.isNull(value)) { + return defaultValue; + } + if (TypeUtil.isUnknown(type)) { + type = defaultValue.getClass(); + } + + if (type instanceof TypeReference) { + type = ((TypeReference) type).getType(); + } + + // 标准转换器 + final Converter converter = getConverter(type, isCustomFirst); + if (null != converter) { + return converter.convert(value, defaultValue); + } + + Class rowType = (Class) TypeUtil.getClass(type); + if (null == rowType) { + if (null != defaultValue) { + rowType = (Class) defaultValue.getClass(); + } else { + // 无法识别的泛型类型，按照Object处理 + return (T) value; + } + } + + // 特殊类型转换，包括Collection、Map、强转、Array等 + final T result = convertSpecial(type, rowType, value, defaultValue); + if (null != result) { + return result; + } + + // 尝试转Bean + if (BeanUtil.isBean(rowType)) { + return new BeanConverter(type).convert(value, defaultValue); + } + + // 无法转换 + throw new ConvertException("Can not Converter from [{}] to [{}]", value.getClass().getName(), type.getTypeName()); + } + + /** + * 转换值为指定类型
+ * 自定义转换器优先 + * + * @param 转换的目标类型（转换器转换到的类型） + * @param type 类型 + * @param value 值 + * @param defaultValue 默认值 + * @return 转换后的值 + * @throws ConvertException 转换器不存在 + */ + public T convert(Type type, Object value, T defaultValue) throws ConvertException { + return convert(type, value, defaultValue, true); + } + + /** + * 转换值为指定类型 + * + * @param 转换的目标类型（转换器转换到的类型） + * @param type 类型 + * @param value 值 + * @return 转换后的值，默认为{@code null} + * @throws ConvertException 转换器不存在 + */ + public T convert(Type type, Object value) throws ConvertException { + return convert(type, value, null); + } + + // ----------------------------------------------------------- Private method start + + /** + * 特殊类型转换
+ * 包括： + * + * 
+	 * Collection
+	 * Map
+	 * 强转（无需转换）
+	 * 数组
+	 *
+ * + * @param 转换的目标类型（转换器转换到的类型） + * @param type 类型 + * @param value 值 + * @param defaultValue 默认值 + * @return 转换后的值 + */ + @SuppressWarnings("unchecked") + private T convertSpecial(Type type, Class rowType, Object value, T defaultValue) { + if (null == rowType) { + return null; + } + + // 集合转换（不可以默认强转） + if (Collection.class.isAssignableFrom(rowType)) { + final CollectionConverter collectionConverter = new CollectionConverter(type); + return (T) collectionConverter.convert(value, (Collection) defaultValue); + } + + // Map类型（不可以默认强转） + if (Map.class.isAssignableFrom(rowType)) { + final MapConverter mapConverter = new MapConverter(type); + return (T) mapConverter.convert(value, (Map) defaultValue); + } + + // 默认强转 + if (rowType.isInstance(value)) { + return (T) value; + } + + // 枚举转换 + if (rowType.isEnum()) { + return (T) new EnumConverter(rowType).convert(value, defaultValue); + } + + // 数组转换 + if (rowType.isArray()) { + final ArrayConverter arrayConverter = new ArrayConverter(rowType); + return (T) arrayConverter.convert(value, defaultValue); + } + + // 表示非需要特殊转换的对象 + return null; + } + + /** + * 注册默认转换器 + * + * @return 转换器 + */ + private ConverterRegistry defaultConverter() { + defaultConverterMap = new SafeConcurrentHashMap<>(); + + // 原始类型转换器 + defaultConverterMap.put(int.class, new PrimitiveConverter(int.class)); + defaultConverterMap.put(long.class, new PrimitiveConverter(long.class)); + defaultConverterMap.put(byte.class, new PrimitiveConverter(byte.class)); + defaultConverterMap.put(short.class, new PrimitiveConverter(short.class)); + defaultConverterMap.put(float.class, new PrimitiveConverter(float.class)); + defaultConverterMap.put(double.class, new PrimitiveConverter(double.class)); + defaultConverterMap.put(char.class, new PrimitiveConverter(char.class)); + defaultConverterMap.put(boolean.class, new PrimitiveConverter(boolean.class)); + + // 包装类转换器 + defaultConverterMap.put(Number.class, new NumberConverter()); + defaultConverterMap.put(Integer.class, new NumberConverter(Integer.class)); + defaultConverterMap.put(AtomicInteger.class, new NumberConverter(AtomicInteger.class));// since 3.0.8 + defaultConverterMap.put(Long.class, new NumberConverter(Long.class)); + defaultConverterMap.put(LongAdder.class, new NumberConverter(LongAdder.class)); + defaultConverterMap.put(AtomicLong.class, new NumberConverter(AtomicLong.class));// since 3.0.8 + defaultConverterMap.put(Byte.class, new NumberConverter(Byte.class)); + defaultConverterMap.put(Short.class, new NumberConverter(Short.class)); + defaultConverterMap.put(Float.class, new NumberConverter(Float.class)); + defaultConverterMap.put(Double.class, new NumberConverter(Double.class)); + defaultConverterMap.put(DoubleAdder.class, new NumberConverter(DoubleAdder.class)); + defaultConverterMap.put(Character.class, new CharacterConverter()); + defaultConverterMap.put(Boolean.class, new BooleanConverter()); + defaultConverterMap.put(AtomicBoolean.class, new AtomicBooleanConverter());// since 3.0.8 + defaultConverterMap.put(BigDecimal.class, new NumberConverter(BigDecimal.class)); + defaultConverterMap.put(BigInteger.class, new NumberConverter(BigInteger.class)); + defaultConverterMap.put(CharSequence.class, new StringConverter()); + defaultConverterMap.put(String.class, new StringConverter()); + + // URI and URL + defaultConverterMap.put(URI.class, new URIConverter()); + defaultConverterMap.put(URL.class, new URLConverter()); + + // 日期时间 + defaultConverterMap.put(Calendar.class, new CalendarConverter()); + defaultConverterMap.put(java.util.Date.class, new DateConverter(java.util.Date.class)); + defaultConverterMap.put(DateTime.class, new DateConverter(DateTime.class)); + defaultConverterMap.put(java.sql.Date.class, new DateConverter(java.sql.Date.class)); + defaultConverterMap.put(java.sql.Time.class, new DateConverter(java.sql.Time.class)); + defaultConverterMap.put(java.sql.Timestamp.class, new DateConverter(java.sql.Timestamp.class)); + + // 日期时间 JDK8+(since 5.0.0) + defaultConverterMap.put(TemporalAccessor.class, new TemporalAccessorConverter(Instant.class)); + defaultConverterMap.put(Instant.class, new TemporalAccessorConverter(Instant.class)); + defaultConverterMap.put(LocalDateTime.class, new TemporalAccessorConverter(LocalDateTime.class)); + defaultConverterMap.put(LocalDate.class, new TemporalAccessorConverter(LocalDate.class)); + defaultConverterMap.put(LocalTime.class, new TemporalAccessorConverter(LocalTime.class)); + defaultConverterMap.put(ZonedDateTime.class, new TemporalAccessorConverter(ZonedDateTime.class)); + defaultConverterMap.put(OffsetDateTime.class, new TemporalAccessorConverter(OffsetDateTime.class)); + defaultConverterMap.put(OffsetTime.class, new TemporalAccessorConverter(OffsetTime.class)); + defaultConverterMap.put(DayOfWeek.class, new TemporalAccessorConverter(DayOfWeek.class)); + defaultConverterMap.put(Month.class, new TemporalAccessorConverter(Month.class)); + defaultConverterMap.put(MonthDay.class, new TemporalAccessorConverter(MonthDay.class)); + defaultConverterMap.put(Period.class, new PeriodConverter()); + defaultConverterMap.put(Duration.class, new DurationConverter()); + + // Reference + defaultConverterMap.put(WeakReference.class, new ReferenceConverter(WeakReference.class));// since 3.0.8 + defaultConverterMap.put(SoftReference.class, new ReferenceConverter(SoftReference.class));// since 3.0.8 + defaultConverterMap.put(AtomicReference.class, new AtomicReferenceConverter());// since 3.0.8 + + //AtomicXXXArray，since 5.4.5 + defaultConverterMap.put(AtomicIntegerArray.class, new AtomicIntegerArrayConverter()); + defaultConverterMap.put(AtomicLongArray.class, new AtomicLongArrayConverter()); + + // 其它类型 + defaultConverterMap.put(Class.class, new ClassConverter()); + defaultConverterMap.put(TimeZone.class, new TimeZoneConverter()); + defaultConverterMap.put(Locale.class, new LocaleConverter()); + defaultConverterMap.put(Charset.class, new CharsetConverter()); + defaultConverterMap.put(Path.class, new PathConverter()); + defaultConverterMap.put(Currency.class, new CurrencyConverter());// since 3.0.8 + defaultConverterMap.put(UUID.class, new UUIDConverter());// since 4.0.10 + defaultConverterMap.put(StackTraceElement.class, new StackTraceElementConverter());// since 4.5.2 + defaultConverterMap.put(Optional.class, new OptionalConverter());// since 5.0.0 + defaultConverterMap.put(Opt.class, new OptConverter());// since 5.7.16 + + return this; + } + // ----------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/NumberChineseFormatter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/NumberChineseFormatter.java new file mode 100644 index 0000000..605622d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/NumberChineseFormatter.java @@ -0,0 +1,617 @@ +package aiyh.utils.tool.cn.hutool.core.convert; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.math.BigDecimal; +import java.math.RoundingMode; + +/** + * 数字转中文类
+ * 包括： + * 
+ * 1. 数字转中文大写形式，比如一百二十一
+ * 2. 数字转金额用的大写形式，比如：壹佰贰拾壹
+ * 3. 转金额形式，比如：壹佰贰拾壹整
+ *
+ * + * @author fanqun, looly + **/ +public class NumberChineseFormatter { + + /** + * 中文形式，奇数位置是简体，偶数位置是记账繁体，0共用
+ * 使用混合数组提高效率和数组复用 + **/ + private static final char[] DIGITS = {'零', '一', '壹', '二', '贰', '三', '叁', '四', '肆', '五', '伍', + '六', '陆', '七', '柒', '八', '捌', '九', '玖'}; + + /** + * 汉字转阿拉伯数字的 + */ + private static final ChineseUnit[] CHINESE_NAME_VALUE = { + new ChineseUnit(' ', 1, false), + new ChineseUnit('十', 10, false), + new ChineseUnit('拾', 10, false), + new ChineseUnit('百', 100, false), + new ChineseUnit('佰', 100, false), + new ChineseUnit('千', 1000, false), + new ChineseUnit('仟', 1000, false), + new ChineseUnit('万', 1_0000, true), + new ChineseUnit('亿', 1_0000_0000, true), + }; + + /** + * 阿拉伯数字转换成中文,小数点后四舍五入保留两位. 使用于整数、小数的转换. + * + * @param amount 数字 + * @param isUseTraditional 是否使用繁体 + * @return 中文 + */ + public static String format(double amount, boolean isUseTraditional) { + return format(amount, isUseTraditional, false); + } + + /** + * 阿拉伯数字转换成中文. + * + *

主要是对发票票面金额转换的扩展 + *

如：-12.32 + *

发票票面转换为：(负数)壹拾贰圆叁角贰分 + *

而非：负壹拾贰元叁角贰分 + *

共两点不同：1、(负数) 而非 负；2、圆 而非 元 + * 2022/3/9 + * + * @param amount 数字 + * @param isUseTraditional 是否使用繁体 + * @param isMoneyMode 是否金额模式 + * @param negativeName 负号转换名称 如：负、(负数) + * @param unitName 单位名称 如：元、圆 + * @return java.lang.String + * @author machuanpeng + * @since 5.7.23 + */ + public static String format(double amount, boolean isUseTraditional, boolean isMoneyMode, String negativeName, String unitName) { + if (0 == amount) { + return "零"; + } + Assert.checkBetween(amount, -99_9999_9999_9999.99, 99_9999_9999_9999.99, + "Number support only: (-99999999999999.99 ~ 99999999999999.99)！"); + + final StringBuilder chineseStr = new StringBuilder(); + + // 负数 + if (amount < 0) { + chineseStr.append(StrUtil.isNullOrUndefined(negativeName) ? "负" : negativeName); + amount = -amount; + } + + long yuan = Math.round(amount * 100); + final int fen = (int) (yuan % 10); + yuan = yuan / 10; + final int jiao = (int) (yuan % 10); + yuan = yuan / 10; + + // 元 + if (false == isMoneyMode || 0 != yuan) { + // 金额模式下，无需“零元” + chineseStr.append(longToChinese(yuan, isUseTraditional)); + if (isMoneyMode) { + chineseStr.append(StrUtil.isNullOrUndefined(unitName) ? "元" : unitName); + } + } + + if (0 == jiao && 0 == fen) { + //无小数部分的金额结尾 + if (isMoneyMode) { + chineseStr.append("整"); + } + return chineseStr.toString(); + } + + // 小数部分 + if (false == isMoneyMode) { + chineseStr.append("点"); + } + + // 角 + if (0 == yuan && 0 == jiao) { + // 元和角都为0时，只有非金额模式下补“零” + if (false == isMoneyMode) { + chineseStr.append("零"); + } + } else { + chineseStr.append(numberToChinese(jiao, isUseTraditional)); + if (isMoneyMode && 0 != jiao) { + chineseStr.append("角"); + } + } + + // 分 + if (0 != fen) { + chineseStr.append(numberToChinese(fen, isUseTraditional)); + if (isMoneyMode) { + chineseStr.append("分"); + } + } + + return chineseStr.toString(); + } + + /** + * 阿拉伯数字转换成中文,小数点后四舍五入保留两位. 使用于整数、小数的转换. + * + * @param amount 数字 + * @param isUseTraditional 是否使用繁体 + * @param isMoneyMode 是否为金额模式 + * @return 中文 + */ + public static String format(double amount, boolean isUseTraditional, boolean isMoneyMode) { + return format(amount, isUseTraditional, isMoneyMode, "负", "元"); + } + + /** + * 阿拉伯数字（支持正负整数）转换成中文 + * + * @param amount 数字 + * @param isUseTraditional 是否使用繁体 + * @return 中文 + * @since 5.7.17 + */ + public static String format(long amount, boolean isUseTraditional) { + if (0 == amount) { + return "零"; + } + Assert.checkBetween(amount, -99_9999_9999_9999.99, 99_9999_9999_9999.99, + "Number support only: (-99999999999999.99 ~ 99999999999999.99)！"); + + final StringBuilder chineseStr = new StringBuilder(); + + // 负数 + if (amount < 0) { + chineseStr.append("负"); + amount = -amount; + } + + chineseStr.append(longToChinese(amount, isUseTraditional)); + return chineseStr.toString(); + } + + /** + * 阿拉伯数字（支持正负整数）四舍五入后转换成中文节权位简洁计数单位，例如 -5_5555 =》 -5.56万 + * + * @param amount 数字 + * @return 中文 + */ + public static String formatSimple(long amount) { + if (amount < 1_0000 && amount > -1_0000) { + return String.valueOf(amount); + } + String res; + if (amount < 1_0000_0000 && amount > -1_0000_0000) { + res = NumberUtil.div(amount, 1_0000, 2) + "万"; + } else if (amount < 1_0000_0000_0000L && amount > -1_0000_0000_0000L) { + res = NumberUtil.div(amount, 1_0000_0000, 2) + "亿"; + } else { + res = NumberUtil.div(amount, 1_0000_0000_0000L, 2) + "万亿"; + } + return res; + } + + /** + * 格式化-999~999之间的数字
+ * 这个方法显示10~19以下的数字时使用"十一"而非"一十一"。 + * + * @param amount 数字 + * @param isUseTraditional 是否使用繁体 + * @return 中文 + * @since 5.7.17 + */ + public static String formatThousand(int amount, boolean isUseTraditional) { + Assert.checkBetween(amount, -999, 999, "Number support only: (-999 ~ 999)！"); + + final String chinese = thousandToChinese(amount, isUseTraditional); + if (amount < 20 && amount >= 10) { + // "十一"而非"一十一" + return chinese.substring(1); + } + return chinese; + } + + /** + * 数字字符转中文，非数字字符原样返回 + * + * @param c 数字字符 + * @param isUseTraditional 是否繁体 + * @return 中文字符 + * @since 5.3.9 + */ + public static String numberCharToChinese(char c, boolean isUseTraditional) { + if (c < '0' || c > '9') { + return String.valueOf(c); + } + return String.valueOf(numberToChinese(c - '0', isUseTraditional)); + } + + /** + * 中文大写数字金额转换为数字，返回结果以元为单位的BigDecimal类型数字 + * 如： + * “陆万柒仟伍佰伍拾陆元叁角贰分”返回“67556.32” + * “叁角贰分”返回“0.32” + * + * @param chineseMoneyAmount 中文大写数字金额 + * @return 返回结果以元为单位的BigDecimal类型数字 + */ + @SuppressWarnings("ConstantConditions") + public static BigDecimal chineseMoneyToNumber(String chineseMoneyAmount){ + if(StrUtil.isBlank(chineseMoneyAmount)){ + return null; + } + + int yi = chineseMoneyAmount.indexOf("元"); + if(yi == -1){ + yi = chineseMoneyAmount.indexOf("圆"); + } + final int ji = chineseMoneyAmount.indexOf("角"); + final int fi = chineseMoneyAmount.indexOf("分"); + + // 先找到单位为元的数字 + String yStr = null; + if(yi > 0) { + yStr = chineseMoneyAmount.substring(0, yi); + } + + // 再找到单位为角的数字 + String jStr = null; + if(ji > 0){ + if(yi >= 0){ + //前面有元,角肯定要在元后面 + if(ji > yi){ + jStr = chineseMoneyAmount.substring(yi+1, ji); + } + }else{ + //没有元，只有角 + jStr = chineseMoneyAmount.substring(0, ji); + } + } + + // 再找到单位为分的数字 + String fStr = null; + if(fi > 0){ + if(ji >= 0){ + //有角，分肯定在角后面 + if(fi > ji){ + fStr = chineseMoneyAmount.substring(ji+1, fi); + } + }else if(yi > 0){ + //没有角，有元，那就坐元后面找 + if(fi > yi){ + fStr = chineseMoneyAmount.substring(yi+1, fi); + } + }else { + //没有元、角，只有分 + fStr = chineseMoneyAmount.substring(0, fi); + } + } + + //元、角、分 + int y = 0, j = 0, f = 0; + if(StrUtil.isNotBlank(yStr)) { + y = NumberChineseFormatter.chineseToNumber(yStr); + } + if(StrUtil.isNotBlank(jStr)){ + j = NumberChineseFormatter.chineseToNumber(jStr); + } + if(StrUtil.isNotBlank(fStr)){ + f = NumberChineseFormatter.chineseToNumber(fStr); + } + + BigDecimal amount = new BigDecimal(y); + amount = amount.add(BigDecimal.valueOf(j).divide(BigDecimal.TEN, 2, RoundingMode.HALF_UP)); + amount = amount.add(BigDecimal.valueOf(f).divide(BigDecimal.valueOf(100), 2, RoundingMode.HALF_UP)); + return amount; + } + + /** + * 阿拉伯数字整数部分转换成中文，只支持正数 + * + * @param amount 数字 + * @param isUseTraditional 是否使用繁体 + * @return 中文 + */ + private static String longToChinese(long amount, boolean isUseTraditional) { + if (0 == amount) { + return "零"; + } + + //将数字以万为单位分为多份 + int[] parts = new int[4]; + for (int i = 0; amount != 0; i++) { + parts[i] = (int) (amount % 10000); + amount = amount / 10000; + } + + final StringBuilder chineseStr = new StringBuilder(); + int partValue; + String partChinese; + + // 千 + partValue = parts[0]; + if (partValue > 0) { + partChinese = thousandToChinese(partValue, isUseTraditional); + chineseStr.insert(0, partChinese); + + if (partValue < 1000) { + // 和万位之间空0，则补零，如一万零三百 + addPreZero(chineseStr); + } + } + + // 万 + partValue = parts[1]; + if (partValue > 0) { + if ((partValue % 10 == 0 && parts[0] > 0)) { + // 如果"万"的个位是0，则补零，如十万零八千 + addPreZero(chineseStr); + } + partChinese = thousandToChinese(partValue, isUseTraditional); + chineseStr.insert(0, partChinese + "万"); + + if (partValue < 1000) { + // 和亿位之间空0，则补零，如一亿零三百万 + addPreZero(chineseStr); + } + } else { + addPreZero(chineseStr); + } + + // 亿 + partValue = parts[2]; + if (partValue > 0) { + if ((partValue % 10 == 0 && parts[1] > 0)) { + // 如果"万"的个位是0，则补零，如十万零八千 + addPreZero(chineseStr); + } + + partChinese = thousandToChinese(partValue, isUseTraditional); + chineseStr.insert(0, partChinese + "亿"); + + if (partValue < 1000) { + // 和万亿位之间空0，则补零，如一万亿零三百亿 + addPreZero(chineseStr); + } + } else { + addPreZero(chineseStr); + } + + // 万亿 + partValue = parts[3]; + if (partValue > 0) { + if (parts[2] == 0) { + chineseStr.insert(0, "亿"); + } + partChinese = thousandToChinese(partValue, isUseTraditional); + chineseStr.insert(0, partChinese + "万"); + } + + if (StrUtil.isNotEmpty(chineseStr) && '零' == chineseStr.charAt(0)) { + return chineseStr.substring(1); + } + + return chineseStr.toString(); + } + + /** + * 把一个 0~9999 之间的整数转换为汉字的字符串，如果是 0 则返回 "" + * + * @param amountPart 数字部分 + * @param isUseTraditional 是否使用繁体单位 + * @return 转换后的汉字 + */ + private static String thousandToChinese(int amountPart, boolean isUseTraditional) { + if (amountPart == 0) { + // issue#I4R92H@Gitee + return String.valueOf(DIGITS[0]); + } + + int temp = amountPart; + + StringBuilder chineseStr = new StringBuilder(); + boolean lastIsZero = true; // 在从低位往高位循环时，记录上一位数字是不是 0 + for (int i = 0; temp > 0; i++) { + int digit = temp % 10; + if (digit == 0) { // 取到的数字为 0 + if (false == lastIsZero) { + // 前一个数字不是 0，则在当前汉字串前加“零”字; + chineseStr.insert(0, "零"); + } + lastIsZero = true; + } else { // 取到的数字不是 0 + chineseStr.insert(0, numberToChinese(digit, isUseTraditional) + getUnitName(i, isUseTraditional)); + lastIsZero = false; + } + temp = temp / 10; + } + return chineseStr.toString(); + } + + /** + * 把中文转换为数字 如 二百二十 220
+ *

    + *
  • 一百一十二 -》 112
    • + *
  • 一千零一十二 -》 1012
    • + *
+ * + * @param chinese 中文字符 + * @return 数字 + * @since 5.6.0 + */ + public static int chineseToNumber(String chinese) { + final int length = chinese.length(); + int result = 0; + + // 节总和 + int section = 0; + int number = 0; + ChineseUnit unit = null; + char c; + for (int i = 0; i < length; i++) { + c = chinese.charAt(i); + final int num = chineseToNumber(c); + if (num >= 0) { + if (num == 0) { + // 遇到零时节结束，权位失效，比如两万二零一十 + if (number > 0 && null != unit) { + section += number * (unit.value / 10); + } + unit = null; + } else if (number > 0) { + // 多个数字同时出现，报错 + throw new IllegalArgumentException(StrUtil.format("Bad number '{}{}' at: {}", chinese.charAt(i - 1), c, i)); + } + // 普通数字 + number = num; + } else { + unit = chineseToUnit(c); + if (null == unit) { + // 出现非法字符 + throw new IllegalArgumentException(StrUtil.format("Unknown unit '{}' at: {}", c, i)); + } + + //单位 + if (unit.secUnit) { + // 节单位，按照节求和 + section = (section + number) * unit.value; + result += section; + section = 0; + } else { + // 非节单位，和单位前的单数字组合为值 + int unitNumber = number; + if (0 == number && 0 == i) { + // issue#1726，对于单位开头的数组，默认赋予1 + // 十二 -> 一十二 + // 百二 -> 一百二 + unitNumber = 1; + } + section += (unitNumber * unit.value); + } + number = 0; + } + } + + if (number > 0 && null != unit) { + number = number * (unit.value / 10); + } + + return result + section + number; + } + + /** + * 查找对应的权对象 + * + * @param chinese 中文权位名 + * @return 权对象 + */ + private static ChineseUnit chineseToUnit(char chinese) { + for (ChineseUnit chineseNameValue : CHINESE_NAME_VALUE) { + if (chineseNameValue.name == chinese) { + return chineseNameValue; + } + } + return null; + } + + /** + * 将汉字单个数字转换为int类型数字 + * + * @param chinese 汉字数字，支持简体和繁体 + * @return 数字，-1表示未找到 + * @since 5.6.4 + */ + private static int chineseToNumber(char chinese) { + if ('两' == chinese) { + // 口语纠正 + chinese = '二'; + } + final int i = ArrayUtil.indexOf(DIGITS, chinese); + if (i > 0) { + return (i + 1) / 2; + } + return i; + } + + /** + * 单个数字转汉字 + * + * @param number 数字 + * @param isUseTraditional 是否使用繁体 + * @return 汉字 + */ + private static char numberToChinese(int number, boolean isUseTraditional) { + if (0 == number) { + return DIGITS[0]; + } + return DIGITS[number * 2 - (isUseTraditional ? 0 : 1)]; + } + + /** + * 获取对应级别的单位 + * + * @param index 级别，0表示各位，1表示十位，2表示百位，以此类推 + * @param isUseTraditional 是否使用繁体 + * @return 单位 + */ + private static String getUnitName(int index, boolean isUseTraditional) { + if (0 == index) { + return StrUtil.EMPTY; + } + return String.valueOf(CHINESE_NAME_VALUE[index * 2 - (isUseTraditional ? 0 : 1)].name); + } + + /** + * 权位 + * + * @author totalo + * @since 5.6.0 + */ + private static class ChineseUnit { + /** + * 中文权名称 + */ + private final char name; + /** + * 10的倍数值 + */ + private final int value; + /** + * 是否为节权位，它不是与之相邻的数字的倍数，而是整个小节的倍数。
+ * 例如二十三万，万是节权位，与三无关，而和二十三关联 + */ + private final boolean secUnit; + + /** + * 构造 + * + * @param name 名称 + * @param value 值，即10的倍数 + * @param secUnit 是否为节权位 + */ + public ChineseUnit(char name, int value, boolean secUnit) { + this.name = name; + this.value = value; + this.secUnit = secUnit; + } + } + + private static void addPreZero(StringBuilder chineseStr) { + if (StrUtil.isEmpty(chineseStr)) { + return; + } + final char c = chineseStr.charAt(0); + if ('零' != c) { + chineseStr.insert(0, '零'); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/NumberWordFormatter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/NumberWordFormatter.java new file mode 100644 index 0000000..5594a16 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/NumberWordFormatter.java @@ -0,0 +1,182 @@ +package aiyh.utils.tool.cn.hutool.core.convert; + +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 将浮点数类型的number转换成英语的表达方式
+ * 参考博客：http://blog.csdn.net/eric_sunah/article/details/8713226 + * + * @author Looly,totalo + * @since 3.0.9 + */ +public class NumberWordFormatter { + + private static final String[] NUMBER = new String[]{"", "ONE", "TWO", "THREE", "FOUR", "FIVE", "SIX", "SEVEN", + "EIGHT", "NINE"}; + private static final String[] NUMBER_TEEN = new String[]{"TEN", "ELEVEN", "TWELVE", "THIRTEEN", "FOURTEEN", + "FIFTEEN", "SIXTEEN", "SEVENTEEN", "EIGHTEEN", "NINETEEN"}; + private static final String[] NUMBER_TEN = new String[]{"TEN", "TWENTY", "THIRTY", "FORTY", "FIFTY", "SIXTY", + "SEVENTY", "EIGHTY", "NINETY"}; + private static final String[] NUMBER_MORE = new String[]{"", "THOUSAND", "MILLION", "BILLION"}; + + private static final String[] NUMBER_SUFFIX = new String[]{"k", "w", "", "m", "", "", "b", "", "", "t", "", "", "p", "", "", "e"}; + + /** + * 将阿拉伯数字转为英文表达式 + * + * @param x 阿拉伯数字，可以为{@link Number}对象，也可以是普通对象，最后会使用字符串方式处理 + * @return 英文表达式 + */ + public static String format(Object x) { + if (x != null) { + return format(x.toString()); + } else { + return StrUtil.EMPTY; + } + } + + /** + * 将阿拉伯数字转化为简洁计数单位，例如 2100 =》 2.1k + * 范围默认只到w + * + * @param value 被格式化的数字 + * @return 格式化后的数字 + * @since 5.5.9 + */ + public static String formatSimple(long value) { + return formatSimple(value, true); + } + + /** + * 将阿拉伯数字转化为简介计数单位，例如 2100 =》 2.1k + * + * @param value 对应数字的值 + * @param isTwo 控制是否为只为k、w，例如当为{@code false}时返回4.38m，{@code true}返回438.43w + * @return 格式化后的数字 + * @since 5.5.9 + */ + public static String formatSimple(long value, boolean isTwo) { + if (value < 1000) { + return String.valueOf(value); + } + int index = -1; + double res = value; + while (res > 10 && (false == isTwo || index < 1)) { + if (res >= 1000) { + res = res / 1000; + index++; + } + if (res > 10) { + res = res / 10; + index++; + } + } + return String.format("%s%s", NumberUtil.decimalFormat("#.##", res), NUMBER_SUFFIX[index]); + } + + /** + * 将阿拉伯数字转为英文表达式 + * + * @param x 阿拉伯数字字符串 + * @return 英文表达式 + */ + private static String format(String x) { + int z = x.indexOf("."); // 取小数点位置 + String lstr, rstr = ""; + if (z > -1) { // 看是否有小数，如果有，则分别取左边和右边 + lstr = x.substring(0, z); + rstr = x.substring(z + 1); + } else { + // 否则就是全部 + lstr = x; + } + + String lstrrev = StrUtil.reverse(lstr); // 对左边的字串取反 + String[] a = new String[5]; // 定义5个字串变量来存放解析出来的叁位一组的字串 + + switch (lstrrev.length() % 3) { + case 1: + lstrrev += "00"; + break; + case 2: + lstrrev += "0"; + break; + } + StringBuilder lm = new StringBuilder(); // 用来存放转换后的整数部分 + for (int i = 0; i < lstrrev.length() / 3; i++) { + a[i] = StrUtil.reverse(lstrrev.substring(3 * i, 3 * i + 3)); // 截取第一个三位 + if (false == "000".equals(a[i])) { // 用来避免这种情况：1000000 = one million + // thousand only + if (i != 0) { + lm.insert(0, transThree(a[i]) + " " + parseMore(i) + " "); // 加: + // thousand、million、billion + } else { + // 防止i=0时， 在多加两个空格. + lm = new StringBuilder(transThree(a[i])); + } + } else { + lm.append(transThree(a[i])); + } + } + + String xs = ""; // 用来存放转换后小数部分 + if (z > -1) { + xs = "AND CENTS " + transTwo(rstr) + " "; // 小数部分存在时转换小数 + } + + return lm.toString().trim() + " " + xs + "ONLY"; + } + + private static String parseFirst(String s) { + return NUMBER[Integer.parseInt(s.substring(s.length() - 1))]; + } + + private static String parseTeen(String s) { + return NUMBER_TEEN[Integer.parseInt(s) - 10]; + } + + private static String parseTen(String s) { + return NUMBER_TEN[Integer.parseInt(s.substring(0, 1)) - 1]; + } + + private static String parseMore(int i) { + return NUMBER_MORE[i]; + } + + // 两位 + private static String transTwo(String s) { + String value; + // 判断位数 + if (s.length() > 2) { + s = s.substring(0, 2); + } else if (s.length() < 2) { + s = "0" + s; + } + + if (s.startsWith("0")) {// 07 - seven 是否小於10 + value = parseFirst(s); + } else if (s.startsWith("1")) {// 17 seventeen 是否在10和20之间 + value = parseTeen(s); + } else if (s.endsWith("0")) {// 是否在10与100之间的能被10整除的数 + value = parseTen(s); + } else { + value = parseTen(s) + " " + parseFirst(s); + } + return value; + } + + // 制作叁位的数 + // s.length = 3 + private static String transThree(String s) { + String value; + if (s.startsWith("0")) {// 是否小於100 + value = transTwo(s.substring(1)); + } else if ("00".equals(s.substring(1))) {// 是否被100整除 + value = parseFirst(s.substring(0, 1)) + " HUNDRED"; + } else { + value = parseFirst(s.substring(0, 1)) + " HUNDRED AND " + transTwo(s.substring(1)); + } + return value; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/TypeConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/TypeConverter.java new file mode 100644 index 0000000..ddef1d4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/TypeConverter.java @@ -0,0 +1,24 @@ +package aiyh.utils.tool.cn.hutool.core.convert; + +import java.lang.reflect.Type; + +/** + * 类型转换接口函数，根据给定的值和目标类型，由用户自定义转换规则。 + * + * @author looly + * @since 5.8.0 + */ +@FunctionalInterface +public interface TypeConverter { + + /** + * 转换为指定类型
+ * 如果类型无法确定，将读取默认值的类型做为目标类型 + * + * @param targetType 目标Type，非泛型类使用 + * @param value 原始值 + * @return 转换后的值 + * @throws IllegalArgumentException 无法确定目标类型，且默认值为{@code null}，无法确定类型 + */ + Object convert(Type targetType, Object value); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/ArrayConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/ArrayConverter.java new file mode 100644 index 0000000..e22e25d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/ArrayConverter.java @@ -0,0 +1,212 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.codec.Base64; +import aiyh.utils.tool.cn.hutool.core.collection.IterUtil; +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ByteUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.lang.reflect.Array; +import java.util.Collection; +import java.util.Iterator; +import java.util.List; + +/** + * 数组转换器，包括原始类型数组 + * + * @author Looly + */ +public class ArrayConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + private final Class targetType; + /** + * 目标元素类型 + */ + private final Class targetComponentType; + + /** + * 是否忽略元素转换错误 + */ + private boolean ignoreElementError; + + /** + * 构造 + * + * @param targetType 目标数组类型 + */ + public ArrayConverter(Class targetType) { + this(targetType, false); + } + + /** + * 构造 + * + * @param targetType 目标数组类型 + * @param ignoreElementError 是否忽略元素转换错误 + */ + public ArrayConverter(Class targetType, boolean ignoreElementError) { + if (null == targetType) { + // 默认Object数组 + targetType = Object[].class; + } + + if (targetType.isArray()) { + this.targetType = targetType; + this.targetComponentType = targetType.getComponentType(); + } else { + //用户传入类为非数组时，按照数组元素类型对待 + this.targetComponentType = targetType; + this.targetType = ArrayUtil.getArrayType(targetType); + } + + this.ignoreElementError = ignoreElementError; + } + + @Override + protected Object convertInternal(Object value) { + return value.getClass().isArray() ? convertArrayToArray(value) : convertObjectToArray(value); + } + + @SuppressWarnings({"unchecked", "rawtypes"}) + @Override + public Class getTargetType() { + return this.targetType; + } + + /** + * 设置是否忽略元素转换错误 + * + * @param ignoreElementError 是否忽略元素转换错误 + * @since 5.4.3 + */ + public void setIgnoreElementError(boolean ignoreElementError) { + this.ignoreElementError = ignoreElementError; + } + + // -------------------------------------------------------------------------------------- Private method start + + /** + * 数组对数组转换 + * + * @param array 被转换的数组值 + * @return 转换后的数组 + */ + private Object convertArrayToArray(Object array) { + final Class valueComponentType = ArrayUtil.getComponentType(array); + + if (valueComponentType == targetComponentType) { + return array; + } + + final int len = ArrayUtil.length(array); + final Object result = Array.newInstance(targetComponentType, len); + + for (int i = 0; i < len; i++) { + Array.set(result, i, convertComponentType(Array.get(array, i))); + } + return result; + } + + /** + * 非数组对数组转换 + * + * @param value 被转换值 + * @return 转换后的数组 + */ + private Object convertObjectToArray(Object value) { + if (value instanceof CharSequence) { + if (targetComponentType == char.class || targetComponentType == Character.class) { + return convertArrayToArray(value.toString().toCharArray()); + } + + //issue#2365 + // 字符串转bytes，首先判断是否为Base64，是则转换，否则按照默认getBytes方法。 + if(targetComponentType == byte.class){ + final String str = value.toString(); + if(Base64.isBase64(str)){ + return Base64.decode(value.toString()); + } + return str.getBytes(); + } + + // 单纯字符串情况下按照逗号分隔后劈开 + final String[] strings = StrUtil.splitToArray(value.toString(), CharUtil.COMMA); + return convertArrayToArray(strings); + } + + Object result; + if (value instanceof List) { + // List转数组 + final List list = (List) value; + result = Array.newInstance(targetComponentType, list.size()); + for (int i = 0; i < list.size(); i++) { + Array.set(result, i, convertComponentType(list.get(i))); + } + } else if (value instanceof Collection) { + // 集合转数组 + final Collection collection = (Collection) value; + result = Array.newInstance(targetComponentType, collection.size()); + + int i = 0; + for (Object element : collection) { + Array.set(result, i, convertComponentType(element)); + i++; + } + } else if (value instanceof Iterable) { + // 可循环对象转数组，可循环对象无法获取长度，因此先转为List后转为数组 + final List list = IterUtil.toList((Iterable) value); + result = Array.newInstance(targetComponentType, list.size()); + for (int i = 0; i < list.size(); i++) { + Array.set(result, i, convertComponentType(list.get(i))); + } + } else if (value instanceof Iterator) { + // 可循环对象转数组，可循环对象无法获取长度，因此先转为List后转为数组 + final List list = IterUtil.toList((Iterator) value); + result = Array.newInstance(targetComponentType, list.size()); + for (int i = 0; i < list.size(); i++) { + Array.set(result, i, convertComponentType(list.get(i))); + } + }else if (value instanceof Number && byte.class == targetComponentType) { + // 用户可能想序列化指定对象 + result = ByteUtil.numberToBytes((Number)value); + } else if (value instanceof Serializable && byte.class == targetComponentType) { + // 用户可能想序列化指定对象 + result = ObjectUtil.serialize(value); + } else { + // everything else: + result = convertToSingleElementArray(value); + } + + return result; + } + + /** + * 单元素数组 + * + * @param value 被转换的值 + * @return 数组，只包含一个元素 + */ + private Object[] convertToSingleElementArray(Object value) { + final Object[] singleElementArray = ArrayUtil.newArray(targetComponentType, 1); + singleElementArray[0] = convertComponentType(value); + return singleElementArray; + } + + /** + * 转换元素类型 + * + * @param value 值 + * @return 转换后的值，转换失败若{@link #ignoreElementError}为true，返回null，否则抛出异常 + * @since 5.4.3 + */ + private Object convertComponentType(Object value) { + return Convert.convertWithCheck(this.targetComponentType, value, null, this.ignoreElementError); + } + // -------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/AtomicBooleanConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/AtomicBooleanConverter.java new file mode 100644 index 0000000..6007f95 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/AtomicBooleanConverter.java @@ -0,0 +1,26 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import java.util.concurrent.atomic.AtomicBoolean; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.util.BooleanUtil; + +/** + * {@link AtomicBoolean}转换器 + * + * @author Looly + * @since 3.0.8 + */ +public class AtomicBooleanConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + @Override + protected AtomicBoolean convertInternal(Object value) { + if (value instanceof Boolean) { + return new AtomicBoolean((Boolean) value); + } + final String valueStr = convertToStr(value); + return new AtomicBoolean(BooleanUtil.toBoolean(valueStr)); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/AtomicIntegerArrayConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/AtomicIntegerArrayConverter.java new file mode 100644 index 0000000..aa8d0a5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/AtomicIntegerArrayConverter.java @@ -0,0 +1,22 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; + +import java.util.concurrent.atomic.AtomicIntegerArray; + +/** + * {@link AtomicIntegerArray}转换器 + * + * @author Looly + * @since 5.4.5 + */ +public class AtomicIntegerArrayConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + @Override + protected AtomicIntegerArray convertInternal(Object value) { + return new AtomicIntegerArray(Convert.convert(int[].class, value)); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/AtomicLongArrayConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/AtomicLongArrayConverter.java new file mode 100644 index 0000000..642c625 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/AtomicLongArrayConverter.java @@ -0,0 +1,22 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; + +import java.util.concurrent.atomic.AtomicLongArray; + +/** + * {@link AtomicLongArray}转换器 + * + * @author Looly + * @since 5.4.5 + */ +public class AtomicLongArrayConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + @Override + protected AtomicLongArray convertInternal(Object value) { + return new AtomicLongArray(Convert.convert(long[].class, value)); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/AtomicReferenceConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/AtomicReferenceConverter.java new file mode 100644 index 0000000..16c80a0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/AtomicReferenceConverter.java @@ -0,0 +1,36 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import java.lang.reflect.Type; +import java.util.concurrent.atomic.AtomicReference; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.convert.ConverterRegistry; +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +/** + * {@link AtomicReference}转换器 + * + * @author Looly + * @since 3.0.8 + */ +@SuppressWarnings("rawtypes") +public class AtomicReferenceConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + @Override + protected AtomicReference convertInternal(Object value) { + + //尝试将值转换为Reference泛型的类型 + Object targetValue = null; + final Type paramType = TypeUtil.getTypeArgument(AtomicReference.class); + if(false == TypeUtil.isUnknown(paramType)){ + targetValue = ConverterRegistry.getInstance().convert(paramType, value); + } + if(null == targetValue){ + targetValue = value; + } + + return new AtomicReference<>(targetValue); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/BeanConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/BeanConverter.java new file mode 100644 index 0000000..fd1bad0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/BeanConverter.java @@ -0,0 +1,91 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.bean.copier.BeanCopier; +import aiyh.utils.tool.cn.hutool.core.bean.copier.CopyOptions; +import aiyh.utils.tool.cn.hutool.core.bean.copier.ValueProvider; +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.convert.ConvertException; +import aiyh.utils.tool.cn.hutool.core.map.MapProxy; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +import java.lang.reflect.Type; +import java.util.Map; + +/** + * Bean转换器，支持： + * 
+ * Map =》 Bean
+ * Bean =》 Bean
+ * ValueProvider =》 Bean
+ *
+ * + * @param Bean类型 + * @author Looly + * @since 4.0.2 + */ +public class BeanConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + private final Type beanType; + private final Class beanClass; + private final CopyOptions copyOptions; + + /** + * 构造，默认转换选项，注入失败的字段忽略 + * + * @param beanType 转换成的目标Bean类型 + */ + public BeanConverter(Type beanType) { + this(beanType, CopyOptions.create().setIgnoreError(true)); + } + + /** + * 构造，默认转换选项，注入失败的字段忽略 + * + * @param beanClass 转换成的目标Bean类 + */ + public BeanConverter(Class beanClass) { + this(beanClass, CopyOptions.create().setIgnoreError(true)); + } + + /** + * 构造 + * + * @param beanType 转换成的目标Bean类 + * @param copyOptions Bean转换选项参数 + */ + @SuppressWarnings("unchecked") + public BeanConverter(Type beanType, CopyOptions copyOptions) { + this.beanType = beanType; + this.beanClass = (Class) TypeUtil.getClass(beanType); + this.copyOptions = copyOptions; + } + + @Override + protected T convertInternal(Object value) { + if(value instanceof Map || + value instanceof ValueProvider || + BeanUtil.isBean(value.getClass())) { + if(value instanceof Map && this.beanClass.isInterface()) { + // 将Map动态代理为Bean + return MapProxy.create((Map)value).toProxyBean(this.beanClass); + } + + //限定被转换对象类型 + return BeanCopier.create(value, ReflectUtil.newInstanceIfPossible(this.beanClass), this.beanType, this.copyOptions).copy(); + } else if(value instanceof byte[]){ + // 尝试反序列化 + return ObjectUtil.deserialize((byte[])value); + } + + throw new ConvertException("Unsupported source type: {}", value.getClass()); + } + + @Override + public Class getTargetType() { + return this.beanClass; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/BooleanConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/BooleanConverter.java new file mode 100644 index 0000000..1ca0cc0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/BooleanConverter.java @@ -0,0 +1,32 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.util.BooleanUtil; + +/** + * 布尔转换器 + * + *

+ * 对象转为boolean，规则如下： + *

+ * 
+ *     1、数字0为false，其它数字为true
+ *     2、转换为字符串，形如"true", "yes", "y", "t", "ok", "1", "on", "是", "对", "真", "對", "√"为true，其它字符串为false.
+ *
+ * + * @author Looly + */ +public class BooleanConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + @Override + protected Boolean convertInternal(Object value) { + if (value instanceof Number) { + // 0为false，其它数字为true + return 0 != ((Number) value).doubleValue(); + } + //Object不可能出现Primitive类型，故忽略 + return BooleanUtil.toBoolean(convertToStr(value)); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CalendarConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CalendarConverter.java new file mode 100644 index 0000000..8b42b27 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CalendarConverter.java @@ -0,0 +1,57 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import java.util.Calendar; +import java.util.Date; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.date.DateUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 日期转换器 + * + * @author Looly + * + */ +public class CalendarConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + /** 日期格式化 */ + private String format; + + /** + * 获取日期格式 + * + * @return 设置日期格式 + */ + public String getFormat() { + return format; + } + + /** + * 设置日期格式 + * + * @param format 日期格式 + */ + public void setFormat(String format) { + this.format = format; + } + + @Override + protected Calendar convertInternal(Object value) { + // Handle Date + if (value instanceof Date) { + return DateUtil.calendar((Date)value); + } + + // Handle Long + if (value instanceof Long) { + //此处使用自动拆装箱 + return DateUtil.calendar((Long)value); + } + + final String valueStr = convertToStr(value); + return DateUtil.calendar(StrUtil.isBlank(format) ? DateUtil.parse(valueStr) : DateUtil.parse(valueStr, format)); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CastConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CastConverter.java new file mode 100644 index 0000000..f792f21 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CastConverter.java @@ -0,0 +1,28 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.convert.ConvertException; + +/** + * 强转转换器 + * + * @author Looly + * @param 强制转换到的类型 + * @since 4.0.2 + */ +public class CastConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + private Class targetType; + + @Override + protected T convertInternal(Object value) { + // 由于在AbstractConverter中已经有类型判断并强制转换，因此当在上一步强制转换失败时直接抛出异常 + throw new ConvertException("Can not cast value to [{}]", this.targetType); + } + + @Override + public Class getTargetType() { + return this.targetType; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CharacterConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CharacterConverter.java new file mode 100644 index 0000000..565461a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CharacterConverter.java @@ -0,0 +1,29 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.util.BooleanUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 字符转换器 + * + * @author Looly + * + */ +public class CharacterConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + @Override + protected Character convertInternal(Object value) { + if (value instanceof Boolean) { + return BooleanUtil.toCharacter((Boolean) value); + } else { + final String valueStr = convertToStr(value); + if (StrUtil.isNotBlank(valueStr)) { + return valueStr.charAt(0); + } + } + return null; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CharsetConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CharsetConverter.java new file mode 100644 index 0000000..87ceebe --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CharsetConverter.java @@ -0,0 +1,21 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import java.nio.charset.Charset; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; + +/** + * 编码对象转换器 + * @author Looly + * + */ +public class CharsetConverter extends AbstractConverter{ + private static final long serialVersionUID = 1L; + + @Override + protected Charset convertInternal(Object value) { + return CharsetUtil.charset(convertToStr(value)); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/ClassConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/ClassConverter.java new file mode 100644 index 0000000..6a92a22 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/ClassConverter.java @@ -0,0 +1,39 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.util.ClassLoaderUtil; + +/** + * 类转换器
+ * 将类名转换为类，默认初始化这个类（执行static块） + * + * @author Looly + */ +public class ClassConverter extends AbstractConverter> { + private static final long serialVersionUID = 1L; + + private final boolean isInitialized; + + /** + * 构造 + */ + public ClassConverter() { + this(true); + } + + /** + * 构造 + * + * @param isInitialized 是否初始化类（调用static模块内容和初始化static属性） + * @since 5.5.0 + */ + public ClassConverter(boolean isInitialized) { + this.isInitialized = isInitialized; + } + + @Override + protected Class convertInternal(Object value) { + return ClassLoaderUtil.loadClass(convertToStr(value), isInitialized); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CollectionConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CollectionConverter.java new file mode 100644 index 0000000..5c30c62 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CollectionConverter.java @@ -0,0 +1,78 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.convert.Converter; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +import java.lang.reflect.Type; +import java.util.Collection; + +/** + * 各种集合类转换器 + * + * @author Looly + * @since 3.0.8 + */ +public class CollectionConverter implements Converter> { + + /** 集合类型 */ + private final Type collectionType; + /** 集合元素类型 */ + private final Type elementType; + + /** + * 构造，默认集合类型使用{@link Collection} + */ + public CollectionConverter() { + this(Collection.class); + } + + // ---------------------------------------------------------------------------------------------- Constractor start + /** + * 构造 + * + * @param collectionType 集合类型 + */ + public CollectionConverter(Type collectionType) { + this(collectionType, TypeUtil.getTypeArgument(collectionType)); + } + + /** + * 构造 + * + * @param collectionType 集合类型 + */ + public CollectionConverter(Class collectionType) { + this(collectionType, TypeUtil.getTypeArgument(collectionType)); + } + + /** + * 构造 + * + * @param collectionType 集合类型 + * @param elementType 集合元素类型 + */ + public CollectionConverter(Type collectionType, Type elementType) { + this.collectionType = collectionType; + this.elementType = elementType; + } + // ---------------------------------------------------------------------------------------------- Constractor end + + @Override + public Collection convert(Object value, Collection defaultValue) throws IllegalArgumentException { + final Collection result = convertInternal(value); + return ObjectUtil.defaultIfNull(result, defaultValue); + } + + /** + * 内部转换 + * + * @param value 值 + * @return 转换后的集合对象 + */ + protected Collection convertInternal(Object value) { + final Collection collection = CollUtil.create(TypeUtil.getClass(this.collectionType), TypeUtil.getClass(this.elementType)); + return CollUtil.addAll(collection, value, this.elementType); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CurrencyConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CurrencyConverter.java new file mode 100644 index 0000000..c5e2ac8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/CurrencyConverter.java @@ -0,0 +1,21 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import java.util.Currency; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; + +/** + * 货币{@link Currency} 转换器 + * + * @author Looly + * @since 3.0.8 + */ +public class CurrencyConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + @Override + protected Currency convertInternal(Object value) { + return Currency.getInstance(convertToStr(value)); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/DateConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/DateConverter.java new file mode 100644 index 0000000..1e8f6f9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/DateConverter.java @@ -0,0 +1,148 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.convert.ConvertException; +import aiyh.utils.tool.cn.hutool.core.date.DateTime; +import aiyh.utils.tool.cn.hutool.core.date.DateUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.time.temporal.TemporalAccessor; +import java.util.Calendar; + +/** + * 日期转换器 + * + * @author Looly + */ +public class DateConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + private final Class targetType; + /** + * 日期格式化 + */ + private String format; + + /** + * 构造 + * + * @param targetType 目标类型 + */ + public DateConverter(Class targetType) { + this.targetType = targetType; + } + + /** + * 构造 + * + * @param targetType 目标类型 + * @param format 日期格式 + */ + public DateConverter(Class targetType, String format) { + this.targetType = targetType; + this.format = format; + } + + /** + * 获取日期格式 + * + * @return 设置日期格式 + */ + public String getFormat() { + return format; + } + + /** + * 设置日期格式 + * + * @param format 日期格式 + */ + public void setFormat(String format) { + this.format = format; + } + + @Override + protected java.util.Date convertInternal(Object value) { + if (value == null || (value instanceof CharSequence && StrUtil.isBlank(value.toString()))) { + return null; + } + if (value instanceof TemporalAccessor) { + return wrap(DateUtil.date((TemporalAccessor) value)); + } else if (value instanceof Calendar) { + return wrap(DateUtil.date((Calendar) value)); + } else if (value instanceof Number) { + return wrap(((Number) value).longValue()); + } else { + // 统一按照字符串处理 + final String valueStr = convertToStr(value); + final DateTime dateTime = StrUtil.isBlank(this.format) // + ? DateUtil.parse(valueStr) // + : DateUtil.parse(valueStr, this.format); + if (null != dateTime) { + return wrap(dateTime); + } + } + + throw new ConvertException("Can not convert {}:[{}] to {}", value.getClass().getName(), value, this.targetType.getName()); + } + + /** + * java.util.Date转为子类型 + * + * @param date Date + * @return 目标类型对象 + */ + private java.util.Date wrap(DateTime date) { + // 返回指定类型 + if (java.util.Date.class == targetType) { + return date.toJdkDate(); + } + if (DateTime.class == targetType) { + return date; + } + if (java.sql.Date.class == targetType) { + return date.toSqlDate(); + } + if (java.sql.Time.class == targetType) { + return new java.sql.Time(date.getTime()); + } + if (java.sql.Timestamp.class == targetType) { + return date.toTimestamp(); + } + + throw new UnsupportedOperationException(StrUtil.format("Unsupported target Date type: {}", this.targetType.getName())); + } + + /** + * java.util.Date转为子类型 + * + * @param mills Date + * @return 目标类型对象 + */ + private java.util.Date wrap(long mills) { + // 返回指定类型 + if (java.util.Date.class == targetType) { + return new java.util.Date(mills); + } + if (DateTime.class == targetType) { + return DateUtil.date(mills); + } + if (java.sql.Date.class == targetType) { + return new java.sql.Date(mills); + } + if (java.sql.Time.class == targetType) { + return new java.sql.Time(mills); + } + if (java.sql.Timestamp.class == targetType) { + return new java.sql.Timestamp(mills); + } + + throw new UnsupportedOperationException(StrUtil.format("Unsupported target Date type: {}", this.targetType.getName())); + } + + @SuppressWarnings("unchecked") + @Override + public Class getTargetType() { + return (Class) this.targetType; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/DurationConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/DurationConverter.java new file mode 100644 index 0000000..e91d653 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/DurationConverter.java @@ -0,0 +1,29 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; + +import java.time.Duration; +import java.time.temporal.TemporalAmount; + +/** + * + * {@link Duration}对象转换器 + * + * @author Looly + * @since 5.0.0 + */ +public class DurationConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + @Override + protected Duration convertInternal(Object value) { + if(value instanceof TemporalAmount){ + return Duration.from((TemporalAmount) value); + } else if(value instanceof Long){ + return Duration.ofMillis((Long) value); + } else { + return Duration.parse(convertToStr(value)); + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/EnumConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/EnumConverter.java new file mode 100755 index 0000000..4c7e3c1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/EnumConverter.java @@ -0,0 +1,142 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.convert.ConvertException; +import aiyh.utils.tool.cn.hutool.core.lang.EnumItem; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.map.WeakConcurrentMap; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.EnumUtil; +import aiyh.utils.tool.cn.hutool.core.util.ModifierUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; + +import java.lang.reflect.Method; +import java.util.Arrays; +import java.util.Map; +import java.util.stream.Collectors; + +/** + * 无泛型检查的枚举转换器 + * + * @author Looly + * @since 4.0.2 + */ +@SuppressWarnings({"unchecked", "rawtypes"}) +public class EnumConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + private static final WeakConcurrentMap, Map, Method>> VALUE_OF_METHOD_CACHE = new WeakConcurrentMap<>(); + + private final Class enumClass; + + /** + * 构造 + * + * @param enumClass 转换成的目标Enum类 + */ + public EnumConverter(Class enumClass) { + this.enumClass = enumClass; + } + + @Override + protected Object convertInternal(Object value) { + Enum enumValue = tryConvertEnum(value, this.enumClass); + if (null == enumValue && false == value instanceof String) { + // 最后尝试先将value转String，再valueOf转换 + enumValue = Enum.valueOf(this.enumClass, convertToStr(value)); + } + + if (null != enumValue) { + return enumValue; + } + + throw new ConvertException("Can not convert {} to {}", value, this.enumClass); + } + + @Override + public Class getTargetType() { + return this.enumClass; + } + + /** + * 尝试转换，转换规则为： + *
    + *
  • 如果实现{@link EnumItem}接口，则调用fromInt或fromStr转换
    • + *
  • 找到类似转换的静态方法调用实现转换且优先使用
    • + *
  • 约定枚举类应该提供 valueOf(String) 和 valueOf(Integer)用于转换
    • + *
  • oriInt /name 转换托底
    • + *
+ * + * @param value 被转换的值 + * @param enumClass enum类 + * @return 对应的枚举值 + */ + protected static Enum tryConvertEnum(Object value, Class enumClass) { + if (value == null) { + return null; + } + + // EnumItem实现转换 + if (EnumItem.class.isAssignableFrom(enumClass)) { + final EnumItem first = (EnumItem) EnumUtil.getEnumAt(enumClass, 0); + if (null != first) { + if (value instanceof Integer) { + return (Enum) first.fromInt((Integer) value); + } else if (value instanceof String) { + return (Enum) first.fromStr(value.toString()); + } + } + } + + // 用户自定义方法 + // 查找枚举中所有返回值为目标枚举对象的方法，如果发现方法参数匹配，就执行之 + try { + final Map, Method> methodMap = getMethodMap(enumClass); + if (MapUtil.isNotEmpty(methodMap)) { + final Class valueClass = value.getClass(); + for (Map.Entry, Method> entry : methodMap.entrySet()) { + if (ClassUtil.isAssignable(entry.getKey(), valueClass)) { + return ReflectUtil.invokeStatic(entry.getValue(), value); + } + } + } + } catch (Exception ignore) { + //ignore + } + + //oriInt 应该滞后使用 以 GB/T 2261.1-2003 性别编码为例，对应整数并非连续数字会导致数字转枚举时失败 + //0 - 未知的性别 + //1 - 男性 + //2 - 女性 + //5 - 女性改(变)为男性 + //6 - 男性改(变)为女性 + //9 - 未说明的性别 + Enum enumResult = null; + if (value instanceof Integer) { + enumResult = EnumUtil.getEnumAt(enumClass, (Integer) value); + } else if (value instanceof String) { + try { + enumResult = Enum.valueOf(enumClass, (String) value); + } catch (IllegalArgumentException e) { + //ignore + } + } + + return enumResult; + } + + /** + * 获取用于转换为enum的所有static方法 + * + * @param enumClass 枚举类 + * @return 转换方法map，key为方法参数类型，value为方法 + */ + private static Map, Method> getMethodMap(Class enumClass) { + return VALUE_OF_METHOD_CACHE.computeIfAbsent(enumClass, (key) -> Arrays.stream(enumClass.getMethods()) + .filter(ModifierUtil::isStatic) + .filter(m -> m.getReturnType() == enumClass) + .filter(m -> m.getParameterCount() == 1) + .filter(m -> false == "valueOf".equals(m.getName())) + .collect(Collectors.toMap(m -> m.getParameterTypes()[0], m -> m, (k1, k2) -> k1))); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/LocaleConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/LocaleConverter.java new file mode 100644 index 0000000..bcd9431 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/LocaleConverter.java @@ -0,0 +1,41 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import java.util.Locale; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * + * {@link Locale}对象转换器
+ * 只提供String转换支持 + * + * @author Looly + * @since 4.5.2 + */ +public class LocaleConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + @Override + protected Locale convertInternal(Object value) { + try { + String str = convertToStr(value); + if (StrUtil.isEmpty(str)) { + return null; + } + + final String[] items = str.split("_"); + if (items.length == 1) { + return new Locale(items[0]); + } + if (items.length == 2) { + return new Locale(items[0], items[1]); + } + return new Locale(items[0], items[1], items[2]); + } catch (Exception e) { + // Ignore Exception + } + return null; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/MapConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/MapConverter.java new file mode 100644 index 0000000..b6aba6d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/MapConverter.java @@ -0,0 +1,100 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.convert.ConverterRegistry; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +import java.lang.reflect.Type; +import java.util.Map; +import java.util.Objects; + +/** + * {@link Map} 转换器 + * + * @author Looly + * @since 3.0.8 + */ +public class MapConverter extends AbstractConverter> { + private static final long serialVersionUID = 1L; + + /** Map类型 */ + private final Type mapType; + /** 键类型 */ + private final Type keyType; + /** 值类型 */ + private final Type valueType; + + /** + * 构造，Map的key和value泛型类型自动获取 + * + * @param mapType Map类型 + */ + public MapConverter(Type mapType) { + this(mapType, TypeUtil.getTypeArgument(mapType, 0), TypeUtil.getTypeArgument(mapType, 1)); + } + + /** + * 构造 + * + * @param mapType Map类型 + * @param keyType 键类型 + * @param valueType 值类型 + */ + public MapConverter(Type mapType, Type keyType, Type valueType) { + this.mapType = mapType; + this.keyType = keyType; + this.valueType = valueType; + } + + @Override + @SuppressWarnings({ "rawtypes", "unchecked" }) + protected Map convertInternal(Object value) { + Map map; + if (value instanceof Map) { + final Class valueClass = value.getClass(); + if(valueClass.equals(this.mapType)){ + final Type[] typeArguments = TypeUtil.getTypeArguments(valueClass); + if (null != typeArguments // + && 2 == typeArguments.length// + && Objects.equals(this.keyType, typeArguments[0]) // + && Objects.equals(this.valueType, typeArguments[1])) { + //对于键值对类型一致的Map对象，不再做转换，直接返回原对象 + return (Map) value; + } + } + map = MapUtil.createMap(TypeUtil.getClass(this.mapType)); + convertMapToMap((Map) value, map); + } else if (BeanUtil.isBean(value.getClass())) { + map = BeanUtil.beanToMap(value); + // 二次转换，转换键值类型 + map = convertInternal(map); + } else { + throw new UnsupportedOperationException(StrUtil.format("Unsupport toMap value type: {}", value.getClass().getName())); + } + return map; + } + + /** + * Map转Map + * + * @param srcMap 源Map + * @param targetMap 目标Map + */ + private void convertMapToMap(Map srcMap, Map targetMap) { + final ConverterRegistry convert = ConverterRegistry.getInstance(); + srcMap.forEach((key, value)->{ + key = TypeUtil.isUnknown(this.keyType) ? key : convert.convert(this.keyType, key); + value = TypeUtil.isUnknown(this.valueType) ? value : convert.convert(this.valueType, value); + targetMap.put(key, value); + }); + } + + @Override + @SuppressWarnings("unchecked") + public Class> getTargetType() { + return (Class>) TypeUtil.getClass(this.mapType); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/NumberConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/NumberConverter.java new file mode 100644 index 0000000..05d600f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/NumberConverter.java @@ -0,0 +1,258 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.date.DateUtil; +import aiyh.utils.tool.cn.hutool.core.util.BooleanUtil; +import aiyh.utils.tool.cn.hutool.core.util.ByteUtil; +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.math.BigDecimal; +import java.math.BigInteger; +import java.time.temporal.TemporalAccessor; +import java.util.Calendar; +import java.util.Date; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicLong; +import java.util.concurrent.atomic.DoubleAdder; +import java.util.concurrent.atomic.LongAdder; +import java.util.function.Function; + +/** + * 数字转换器
+ * 支持类型为：
+ *
    + *
  • {@code java.lang.Byte}
    • + *
  • {@code java.lang.Short}
    • + *
  • {@code java.lang.Integer}
    • + *
  • {@code java.util.concurrent.atomic.AtomicInteger}
    • + *
  • {@code java.lang.Long}
    • + *
  • {@code java.util.concurrent.atomic.AtomicLong}
    • + *
  • {@code java.lang.Float}
    • + *
  • {@code java.lang.Double}
    • + *
  • {@code java.math.BigDecimal}
    • + *
  • {@code java.math.BigInteger}
    • + *
+ * + * @author Looly + */ +public class NumberConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + private final Class targetType; + + public NumberConverter() { + this.targetType = Number.class; + } + + /** + * 构造
+ * + * @param clazz 需要转换的数字类型，默认 {@link Number} + */ + public NumberConverter(Class clazz) { + this.targetType = (null == clazz) ? Number.class : clazz; + } + + @Override + @SuppressWarnings("unchecked") + public Class getTargetType() { + return (Class) this.targetType; + } + + @Override + protected Number convertInternal(Object value) { + return convert(value, this.targetType, this::convertToStr); + } + + @Override + protected String convertToStr(Object value) { + String result = StrUtil.trim(super.convertToStr(value)); + if (null != result && result.length() > 1) { + final char c = Character.toUpperCase(result.charAt(result.length() - 1)); + if (c == 'D' || c == 'L' || c == 'F') { + // 类型标识形式（例如123.6D） + return StrUtil.subPre(result, -1); + } + } + + return result; + } + + /** + * 转换对象为数字，支持的对象包括： + *
    + *
  • Number对象
    • + *
  • Boolean
    • + *
  • byte[]
    • + *
  • String
    • + *
+ * + * + * @param value 对象值 + * @param targetType 目标的数字类型 + * @param toStrFunc 转换为字符串的函数 + * @return 转换后的数字 + * @since 5.5.0 + */ + protected static Number convert(Object value, Class targetType, Function toStrFunc) { + // 枚举转换为数字默认为其顺序 + if (value instanceof Enum) { + return convert(((Enum) value).ordinal(), targetType, toStrFunc); + } + + // since 5.7.18 + if(value instanceof byte[]){ + return ByteUtil.bytesToNumber((byte[])value, targetType, ByteUtil.DEFAULT_ORDER); + } + + if (Byte.class == targetType) { + if (value instanceof Number) { + return ((Number) value).byteValue(); + } else if (value instanceof Boolean) { + return BooleanUtil.toByteObj((Boolean) value); + } + final String valueStr = toStrFunc.apply(value); + try{ + return StrUtil.isBlank(valueStr) ? null : Byte.valueOf(valueStr); + } catch (NumberFormatException e){ + return NumberUtil.parseNumber(valueStr).byteValue(); + } + } else if (Short.class == targetType) { + if (value instanceof Number) { + return ((Number) value).shortValue(); + } else if (value instanceof Boolean) { + return BooleanUtil.toShortObj((Boolean) value); + } + final String valueStr = toStrFunc.apply((value)); + try{ + return StrUtil.isBlank(valueStr) ? null : Short.valueOf(valueStr); + } catch (NumberFormatException e){ + return NumberUtil.parseNumber(valueStr).shortValue(); + } + } else if (Integer.class == targetType) { + if (value instanceof Number) { + return ((Number) value).intValue(); + } else if (value instanceof Boolean) { + return BooleanUtil.toInteger((Boolean) value); + } else if (value instanceof Date) { + return (int) ((Date) value).getTime(); + } else if (value instanceof Calendar) { + return (int) ((Calendar) value).getTimeInMillis(); + } else if (value instanceof TemporalAccessor) { + return (int) DateUtil.toInstant((TemporalAccessor) value).toEpochMilli(); + } + final String valueStr = toStrFunc.apply((value)); + return StrUtil.isBlank(valueStr) ? null : NumberUtil.parseInt(valueStr); + } else if (AtomicInteger.class == targetType) { + final Number number = convert(value, Integer.class, toStrFunc); + if (null != number) { + return new AtomicInteger(number.intValue()); + } + } else if (Long.class == targetType) { + if (value instanceof Number) { + return ((Number) value).longValue(); + } else if (value instanceof Boolean) { + return BooleanUtil.toLongObj((Boolean) value); + } else if (value instanceof Date) { + return ((Date) value).getTime(); + } else if (value instanceof Calendar) { + return ((Calendar) value).getTimeInMillis(); + } else if (value instanceof TemporalAccessor) { + return DateUtil.toInstant((TemporalAccessor) value).toEpochMilli(); + } + final String valueStr = toStrFunc.apply((value)); + return StrUtil.isBlank(valueStr) ? null : NumberUtil.parseLong(valueStr); + } else if (AtomicLong.class == targetType) { + final Number number = convert(value, Long.class, toStrFunc); + if (null != number) { + return new AtomicLong(number.longValue()); + } + } else if (LongAdder.class == targetType) { + //jdk8 新增 + final Number number = convert(value, Long.class, toStrFunc); + if (null != number) { + final LongAdder longValue = new LongAdder(); + longValue.add(number.longValue()); + return longValue; + } + } else if (Float.class == targetType) { + if (value instanceof Number) { + return ((Number) value).floatValue(); + } else if (value instanceof Boolean) { + return BooleanUtil.toFloatObj((Boolean) value); + } + final String valueStr = toStrFunc.apply((value)); + return StrUtil.isBlank(valueStr) ? null : NumberUtil.parseFloat(valueStr); + } else if (Double.class == targetType) { + if (value instanceof Number) { + return NumberUtil.toDouble((Number) value); + } else if (value instanceof Boolean) { + return BooleanUtil.toDoubleObj((Boolean) value); + } + final String valueStr = toStrFunc.apply((value)); + return StrUtil.isBlank(valueStr) ? null : NumberUtil.parseDouble(valueStr); + } else if (DoubleAdder.class == targetType) { + //jdk8 新增 + final Number number = convert(value, Double.class, toStrFunc); + if (null != number) { + final DoubleAdder doubleAdder = new DoubleAdder(); + doubleAdder.add(number.doubleValue()); + return doubleAdder; + } + } else if (BigDecimal.class == targetType) { + return toBigDecimal(value, toStrFunc); + } else if (BigInteger.class == targetType) { + return toBigInteger(value, toStrFunc); + } else if (Number.class == targetType) { + if (value instanceof Number) { + return (Number) value; + } else if (value instanceof Boolean) { + return BooleanUtil.toInteger((Boolean) value); + } + final String valueStr = toStrFunc.apply((value)); + return StrUtil.isBlank(valueStr) ? null : NumberUtil.parseNumber(valueStr); + } + + throw new UnsupportedOperationException(StrUtil.format("Unsupport Number type: {}", targetType.getName())); + } + + /** + * 转换为BigDecimal
+ * 如果给定的值为空，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param toStrFunc 转换为字符串的函数规则 + * @return 结果 + */ + private static BigDecimal toBigDecimal(Object value, Function toStrFunc) { + if (value instanceof Number) { + return NumberUtil.toBigDecimal((Number) value); + } else if (value instanceof Boolean) { + return ((boolean) value) ? BigDecimal.ONE : BigDecimal.ZERO; + } + + //对于Double类型，先要转换为String，避免精度问题 + return NumberUtil.toBigDecimal(toStrFunc.apply(value)); + } + + /** + * 转换为BigInteger
+ * 如果给定的值为空，或者转换失败，返回默认值
+ * 转换失败不会报错 + * + * @param value 被转换的值 + * @param toStrFunc 转换为字符串的函数规则 + * @return 结果 + */ + private static BigInteger toBigInteger(Object value, Function toStrFunc) { + if (value instanceof Long) { + return BigInteger.valueOf((Long) value); + } else if (value instanceof Boolean) { + return (boolean) value ? BigInteger.ONE : BigInteger.ZERO; + } + + return NumberUtil.toBigInteger(toStrFunc.apply(value)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/OptConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/OptConverter.java new file mode 100644 index 0000000..7c48b6a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/OptConverter.java @@ -0,0 +1,21 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.lang.Opt; + +/** + * + * {@link Opt}对象转换器 + * + * @author Looly + * @since 5.7.16 + */ +public class OptConverter extends AbstractConverter> { + private static final long serialVersionUID = 1L; + + @Override + protected Opt convertInternal(Object value) { + return Opt.ofNullable(value); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/OptionalConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/OptionalConverter.java new file mode 100644 index 0000000..ba044f2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/OptionalConverter.java @@ -0,0 +1,22 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; + +import java.util.Optional; + +/** + * + * {@link Optional}对象转换器 + * + * @author Looly + * @since 5.0.0 + */ +public class OptionalConverter extends AbstractConverter> { + private static final long serialVersionUID = 1L; + + @Override + protected Optional convertInternal(Object value) { + return Optional.ofNullable(value); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/PathConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/PathConverter.java new file mode 100644 index 0000000..d6da1e6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/PathConverter.java @@ -0,0 +1,41 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import java.io.File; +import java.net.URI; +import java.net.URL; +import java.nio.file.Path; +import java.nio.file.Paths; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; + +/** + * 字符串转换器 + * @author Looly + * + */ +public class PathConverter extends AbstractConverter{ + private static final long serialVersionUID = 1L; + + @Override + protected Path convertInternal(Object value) { + try { + if(value instanceof URI){ + return Paths.get((URI)value); + } + + if(value instanceof URL){ + return Paths.get(((URL)value).toURI()); + } + + if(value instanceof File){ + return ((File)value).toPath(); + } + + return Paths.get(convertToStr(value)); + } catch (Exception e) { + // Ignore Exception + } + return null; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/PeriodConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/PeriodConverter.java new file mode 100644 index 0000000..5707748 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/PeriodConverter.java @@ -0,0 +1,29 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; + +import java.time.Period; +import java.time.temporal.TemporalAmount; + +/** + * + * {@link Period}对象转换器 + * + * @author Looly + * @since 5.0.0 + */ +public class PeriodConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + @Override + protected Period convertInternal(Object value) { + if(value instanceof TemporalAmount){ + return Period.from((TemporalAmount) value); + }else if(value instanceof Integer){ + return Period.ofDays((Integer) value); + } else { + return Period.parse(convertToStr(value)); + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/PrimitiveConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/PrimitiveConverter.java new file mode 100644 index 0000000..1c79691 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/PrimitiveConverter.java @@ -0,0 +1,92 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.convert.ConvertException; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.function.Function; + +/** + * 原始类型转换器
+ * 支持类型为：
+ *
    + *
  • {@code byte}
    • + *
  • {@code short}
    • + *
  • {@code int}
    • + *
  • {@code long}
    • + *
  • {@code float}
    • + *
  • {@code double}
    • + *
  • {@code char}
    • + *
  • {@code boolean}
    • + *
+ * + * @author Looly + */ +public class PrimitiveConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + private final Class targetType; + + /** + * 构造
+ * + * @param clazz 需要转换的原始 + * @throws IllegalArgumentException 传入的转换类型非原始类型时抛出 + */ + public PrimitiveConverter(Class clazz) { + if (null == clazz) { + throw new NullPointerException("PrimitiveConverter not allow null target type!"); + } else if (false == clazz.isPrimitive()) { + throw new IllegalArgumentException("[" + clazz + "] is not a primitive class!"); + } + this.targetType = clazz; + } + + @Override + protected Object convertInternal(Object value) { + return PrimitiveConverter.convert(value, this.targetType, this::convertToStr); + } + + @Override + protected String convertToStr(Object value) { + return StrUtil.trim(super.convertToStr(value)); + } + + @Override + @SuppressWarnings("unchecked") + public Class getTargetType() { + return (Class) this.targetType; + } + + /** + * 将指定值转换为原始类型的值 + * @param value 值 + * @param primitiveClass 原始类型 + * @param toStringFunc 当无法直接转换时，转为字符串后再转换的函数 + * @return 转换结果 + * @since 5.5.0 + */ + protected static Object convert(Object value, Class primitiveClass, Function toStringFunc) { + if (byte.class == primitiveClass) { + return ObjectUtil.defaultIfNull(NumberConverter.convert(value, Byte.class, toStringFunc), 0); + } else if (short.class == primitiveClass) { + return ObjectUtil.defaultIfNull(NumberConverter.convert(value, Short.class, toStringFunc), 0); + } else if (int.class == primitiveClass) { + return ObjectUtil.defaultIfNull(NumberConverter.convert(value, Integer.class, toStringFunc), 0); + } else if (long.class == primitiveClass) { + return ObjectUtil.defaultIfNull(NumberConverter.convert(value, Long.class, toStringFunc), 0); + } else if (float.class == primitiveClass) { + return ObjectUtil.defaultIfNull(NumberConverter.convert(value, Float.class, toStringFunc), 0); + } else if (double.class == primitiveClass) { + return ObjectUtil.defaultIfNull(NumberConverter.convert(value, Double.class, toStringFunc), 0); + } else if (char.class == primitiveClass) { + return Convert.convert(Character.class, value); + } else if (boolean.class == primitiveClass) { + return Convert.convert(Boolean.class, value); + } + + throw new ConvertException("Unsupported target type: {}", primitiveClass); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/ReferenceConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/ReferenceConverter.java new file mode 100644 index 0000000..dee1062 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/ReferenceConverter.java @@ -0,0 +1,56 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.convert.ConverterRegistry; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +import java.lang.ref.Reference; +import java.lang.ref.SoftReference; +import java.lang.ref.WeakReference; +import java.lang.reflect.Type; + +/** + * {@link Reference}转换器 + * + * @author Looly + * @since 3.0.8 + */ +@SuppressWarnings("rawtypes") +public class ReferenceConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + private final Class targetType; + + /** + * 构造 + * @param targetType {@link Reference}实现类型 + */ + public ReferenceConverter(Class targetType) { + this.targetType = targetType; + } + + @SuppressWarnings("unchecked") + @Override + protected Reference convertInternal(Object value) { + + //尝试将值转换为Reference泛型的类型 + Object targetValue = null; + final Type paramType = TypeUtil.getTypeArgument(targetType); + if(false == TypeUtil.isUnknown(paramType)){ + targetValue = ConverterRegistry.getInstance().convert(paramType, value); + } + if(null == targetValue){ + targetValue = value; + } + + if(this.targetType == WeakReference.class){ + return new WeakReference(targetValue); + }else if(this.targetType == SoftReference.class){ + return new SoftReference(targetValue); + } + + throw new UnsupportedOperationException(StrUtil.format("Unsupport Reference type: {}", this.targetType.getName())); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/StackTraceElementConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/StackTraceElementConverter.java new file mode 100644 index 0000000..0de662a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/StackTraceElementConverter.java @@ -0,0 +1,34 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import java.util.Map; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +/** + * {@link StackTraceElement} 转换器
+ * 只支持Map方式转换 + * + * @author Looly + * @since 3.0.8 + */ +public class StackTraceElementConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + @Override + protected StackTraceElement convertInternal(Object value) { + if (value instanceof Map) { + final Map map = (Map) value; + + final String declaringClass = MapUtil.getStr(map, "className"); + final String methodName = MapUtil.getStr(map, "methodName"); + final String fileName = MapUtil.getStr(map, "fileName"); + final Integer lineNumber = MapUtil.getInt(map, "lineNumber"); + + return new StackTraceElement(declaringClass, methodName, fileName, ObjectUtil.defaultIfNull(lineNumber, 0)); + } + return null; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/StringConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/StringConverter.java new file mode 100644 index 0000000..b73429e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/StringConverter.java @@ -0,0 +1,80 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.convert.ConvertException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.XmlUtil; + +import java.io.InputStream; +import java.io.Reader; +import java.lang.reflect.Type; +import java.sql.Blob; +import java.sql.Clob; +import java.sql.SQLException; +import java.util.TimeZone; + +/** + * 字符串转换器，提供各种对象转换为字符串的逻辑封装 + * + * @author Looly + */ +public class StringConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + @Override + protected String convertInternal(Object value) { + if (value instanceof TimeZone) { + return ((TimeZone) value).getID(); + } else if (value instanceof org.w3c.dom.Node) { + return XmlUtil.toStr((org.w3c.dom.Node) value); + } else if (value instanceof Clob) { + return clobToStr((Clob) value); + } else if (value instanceof Blob) { + return blobToStr((Blob) value); + } else if (value instanceof Type) { + return ((Type) value).getTypeName(); + } + + // 其它情况 + return convertToStr(value); + } + + /** + * Clob字段值转字符串 + * + * @param clob {@link Clob} + * @return 字符串 + * @since 5.4.5 + */ + private static String clobToStr(Clob clob) { + Reader reader = null; + try { + reader = clob.getCharacterStream(); + return IoUtil.read(reader); + } catch (SQLException e) { + throw new ConvertException(e); + } finally { + IoUtil.close(reader); + } + } + + /** + * Blob字段值转字符串 + * + * @param blob {@link Blob} + * @return 字符串 + * @since 5.4.5 + */ + private static String blobToStr(Blob blob) { + InputStream in = null; + try { + in = blob.getBinaryStream(); + return IoUtil.read(in, CharsetUtil.CHARSET_UTF_8); + } catch (SQLException e) { + throw new ConvertException(e); + } finally { + IoUtil.close(in); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/TemporalAccessorConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/TemporalAccessorConverter.java new file mode 100644 index 0000000..a55fab3 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/TemporalAccessorConverter.java @@ -0,0 +1,300 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.convert.ConvertException; +import aiyh.utils.tool.cn.hutool.core.date.DateTime; +import aiyh.utils.tool.cn.hutool.core.date.DateUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.time.DayOfWeek; +import java.time.Instant; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.time.LocalTime; +import java.time.Month; +import java.time.MonthDay; +import java.time.OffsetDateTime; +import java.time.OffsetTime; +import java.time.ZoneId; +import java.time.ZonedDateTime; +import java.time.chrono.Era; +import java.time.chrono.IsoEra; +import java.time.format.DateTimeFormatter; +import java.time.temporal.TemporalAccessor; +import java.util.Calendar; +import java.util.Date; +import java.util.Map; +import java.util.Objects; + +/** + * JDK8中新加入的java.time包对象解析转换器
+ * 支持的对象包括： + * + * 
+ * java.time.Instant
+ * java.time.LocalDateTime
+ * java.time.LocalDate
+ * java.time.LocalTime
+ * java.time.ZonedDateTime
+ * java.time.OffsetDateTime
+ * java.time.OffsetTime
+ *
+ * + * @author looly + * @since 5.0.0 + */ +public class TemporalAccessorConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + private final Class targetType; + /** + * 日期格式化 + */ + private String format; + + /** + * 构造 + * + * @param targetType 目标类型 + */ + public TemporalAccessorConverter(Class targetType) { + this(targetType, null); + } + + /** + * 构造 + * + * @param targetType 目标类型 + * @param format 日期格式 + */ + public TemporalAccessorConverter(Class targetType, String format) { + this.targetType = targetType; + this.format = format; + } + + /** + * 获取日期格式 + * + * @return 设置日期格式 + */ + public String getFormat() { + return format; + } + + /** + * 设置日期格式 + * + * @param format 日期格式 + */ + public void setFormat(String format) { + this.format = format; + } + + @SuppressWarnings("unchecked") + @Override + public Class getTargetType() { + return (Class) this.targetType; + } + + @Override + protected TemporalAccessor convertInternal(Object value) { + if (value instanceof Long) { + return parseFromLong((Long) value); + } else if (value instanceof Integer) { + return parseFromLong((long) (Integer) value); + } else if (value instanceof TemporalAccessor) { + return parseFromTemporalAccessor((TemporalAccessor) value); + } else if (value instanceof Date) { + final DateTime dateTime = DateUtil.date((Date) value); + return parseFromInstant(dateTime.toInstant(), dateTime.getZoneId()); + } else if (value instanceof Calendar) { + final Calendar calendar = (Calendar) value; + return parseFromInstant(calendar.toInstant(), calendar.getTimeZone().toZoneId()); + } else if (value instanceof Map) { + final Map map = (Map) value; + if (LocalDate.class.equals(this.targetType)) { + return LocalDate.of(Convert.toInt(map.get("year")), Convert.toInt(map.get("month")), Convert.toInt(map.get("day"))); + } else if (LocalDateTime.class.equals(this.targetType)) { + return LocalDateTime.of(Convert.toInt(map.get("year")), Convert.toInt(map.get("month")), Convert.toInt(map.get("day")), + Convert.toInt(map.get("hour")), Convert.toInt(map.get("minute")), Convert.toInt(map.get("second")), Convert.toInt(map.get("second"))); + } else if (LocalTime.class.equals(this.targetType)) { + return LocalTime.of(Convert.toInt(map.get("hour")), Convert.toInt(map.get("minute")), Convert.toInt(map.get("second")), Convert.toInt(map.get("nano"))); + } + throw new ConvertException("Unsupported type: [{}] from map: [{}]", this.targetType, map); + } else { + return parseFromCharSequence(convertToStr(value)); + } + } + + /** + * 通过反射从字符串转java.time中的对象 + * + * @param value 字符串值 + * @return 日期对象 + */ + private TemporalAccessor parseFromCharSequence(CharSequence value) { + if (StrUtil.isBlank(value)) { + return null; + } + + if(DayOfWeek.class.equals(this.targetType)){ + return DayOfWeek.valueOf(StrUtil.toString(value)); + } else if(Month.class.equals(this.targetType)){ + return Month.valueOf(StrUtil.toString(value)); + } else if(Era.class.equals(this.targetType)){ + return IsoEra.valueOf(StrUtil.toString(value)); + } else if(MonthDay.class.equals(this.targetType)){ + return MonthDay.parse(value); + } + + final Instant instant; + ZoneId zoneId; + if (null != this.format) { + final DateTimeFormatter formatter = DateTimeFormatter.ofPattern(this.format); + instant = formatter.parse(value, Instant::from); + zoneId = formatter.getZone(); + } else { + final DateTime dateTime = DateUtil.parse(value); + instant = Objects.requireNonNull(dateTime).toInstant(); + zoneId = dateTime.getZoneId(); + } + return parseFromInstant(instant, zoneId); + } + + /** + * 将Long型时间戳转换为java.time中的对象 + * + * @param time 时间戳 + * @return java.time中的对象 + */ + private TemporalAccessor parseFromLong(Long time) { + if(DayOfWeek.class.equals(this.targetType)){ + return DayOfWeek.of(Math.toIntExact(time)); + } else if(Month.class.equals(this.targetType)){ + return Month.of(Math.toIntExact(time)); + } else if(Era.class.equals(this.targetType)){ + return IsoEra.of(Math.toIntExact(time)); + } + return parseFromInstant(Instant.ofEpochMilli(time), null); + } + + /** + * 将TemporalAccessor型时间戳转换为java.time中的对象 + * + * @param temporalAccessor TemporalAccessor对象 + * @return java.time中的对象 + */ + private TemporalAccessor parseFromTemporalAccessor(TemporalAccessor temporalAccessor) { + if(DayOfWeek.class.equals(this.targetType)){ + return DayOfWeek.from(temporalAccessor); + } else if(Month.class.equals(this.targetType)){ + return Month.from(temporalAccessor); + } else if(MonthDay.class.equals(this.targetType)){ + return MonthDay.from(temporalAccessor); + } + + TemporalAccessor result = null; + if (temporalAccessor instanceof LocalDateTime) { + result = parseFromLocalDateTime((LocalDateTime) temporalAccessor); + } else if (temporalAccessor instanceof ZonedDateTime) { + result = parseFromZonedDateTime((ZonedDateTime) temporalAccessor); + } + + if (null == result) { + result = parseFromInstant(DateUtil.toInstant(temporalAccessor), null); + } + + return result; + } + + /** + * 将TemporalAccessor型时间戳转换为java.time中的对象 + * + * @param localDateTime {@link LocalDateTime}对象 + * @return java.time中的对象 + */ + private TemporalAccessor parseFromLocalDateTime(LocalDateTime localDateTime) { + if (Instant.class.equals(this.targetType)) { + return DateUtil.toInstant(localDateTime); + } + if (LocalDate.class.equals(this.targetType)) { + return localDateTime.toLocalDate(); + } + if (LocalTime.class.equals(this.targetType)) { + return localDateTime.toLocalTime(); + } + if (ZonedDateTime.class.equals(this.targetType)) { + return localDateTime.atZone(ZoneId.systemDefault()); + } + if (OffsetDateTime.class.equals(this.targetType)) { + return localDateTime.atZone(ZoneId.systemDefault()).toOffsetDateTime(); + } + if (OffsetTime.class.equals(this.targetType)) { + return localDateTime.atZone(ZoneId.systemDefault()).toOffsetDateTime().toOffsetTime(); + } + + return null; + } + + /** + * 将TemporalAccessor型时间戳转换为java.time中的对象 + * + * @param zonedDateTime {@link ZonedDateTime}对象 + * @return java.time中的对象 + */ + private TemporalAccessor parseFromZonedDateTime(ZonedDateTime zonedDateTime) { + if (Instant.class.equals(this.targetType)) { + return DateUtil.toInstant(zonedDateTime); + } + if (LocalDateTime.class.equals(this.targetType)) { + return zonedDateTime.toLocalDateTime(); + } + if (LocalDate.class.equals(this.targetType)) { + return zonedDateTime.toLocalDate(); + } + if (LocalTime.class.equals(this.targetType)) { + return zonedDateTime.toLocalTime(); + } + if (OffsetDateTime.class.equals(this.targetType)) { + return zonedDateTime.toOffsetDateTime(); + } + if (OffsetTime.class.equals(this.targetType)) { + return zonedDateTime.toOffsetDateTime().toOffsetTime(); + } + + return null; + } + + /** + * 将TemporalAccessor型时间戳转换为java.time中的对象 + * + * @param instant {@link Instant}对象 + * @param zoneId 时区ID，null表示当前系统默认的时区 + * @return java.time中的对象 + */ + private TemporalAccessor parseFromInstant(Instant instant, ZoneId zoneId) { + if (Instant.class.equals(this.targetType)) { + return instant; + } + + zoneId = ObjectUtil.defaultIfNull(zoneId, ZoneId::systemDefault); + + TemporalAccessor result = null; + if (LocalDateTime.class.equals(this.targetType)) { + result = LocalDateTime.ofInstant(instant, zoneId); + } else if (LocalDate.class.equals(this.targetType)) { + result = instant.atZone(zoneId).toLocalDate(); + } else if (LocalTime.class.equals(this.targetType)) { + result = instant.atZone(zoneId).toLocalTime(); + } else if (ZonedDateTime.class.equals(this.targetType)) { + result = instant.atZone(zoneId); + } else if (OffsetDateTime.class.equals(this.targetType)) { + result = OffsetDateTime.ofInstant(instant, zoneId); + } else if (OffsetTime.class.equals(this.targetType)) { + result = OffsetTime.ofInstant(instant, zoneId); + } + return result; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/TimeZoneConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/TimeZoneConverter.java new file mode 100644 index 0000000..45c4085 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/TimeZoneConverter.java @@ -0,0 +1,20 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import java.util.TimeZone; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; + +/** + * TimeZone转换器 + * @author Looly + * + */ +public class TimeZoneConverter extends AbstractConverter{ + private static final long serialVersionUID = 1L; + + @Override + protected TimeZone convertInternal(Object value) { + return TimeZone.getTimeZone(convertToStr(value)); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/URIConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/URIConverter.java new file mode 100644 index 0000000..b2c829a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/URIConverter.java @@ -0,0 +1,34 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import java.io.File; +import java.net.URI; +import java.net.URL; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; + +/** + * URI对象转换器 + * @author Looly + * + */ +public class URIConverter extends AbstractConverter{ + private static final long serialVersionUID = 1L; + + @Override + protected URI convertInternal(Object value) { + try { + if(value instanceof File){ + return ((File)value).toURI(); + } + + if(value instanceof URL){ + return ((URL)value).toURI(); + } + return new URI(convertToStr(value)); + } catch (Exception e) { + // Ignore Exception + } + return null; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/URLConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/URLConverter.java new file mode 100644 index 0000000..c70a16f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/URLConverter.java @@ -0,0 +1,34 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import java.io.File; +import java.net.URI; +import java.net.URL; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; + +/** + * URL对象转换器 + * @author Looly + * + */ +public class URLConverter extends AbstractConverter{ + private static final long serialVersionUID = 1L; + + @Override + protected URL convertInternal(Object value) { + try { + if(value instanceof File){ + return ((File)value).toURI().toURL(); + } + + if(value instanceof URI){ + return ((URI)value).toURL(); + } + return new URL(convertToStr(value)); + } catch (Exception e) { + // Ignore Exception + } + return null; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/UUIDConverter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/UUIDConverter.java new file mode 100644 index 0000000..3c3fdcf --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/UUIDConverter.java @@ -0,0 +1,22 @@ +package aiyh.utils.tool.cn.hutool.core.convert.impl; + +import java.util.UUID; + +import aiyh.utils.tool.cn.hutool.core.convert.AbstractConverter; + +/** + * UUID对象转换器转换器 + * + * @author Looly + * @since 4.0.10 + * + */ +public class UUIDConverter extends AbstractConverter { + private static final long serialVersionUID = 1L; + + @Override + protected UUID convertInternal(Object value) { + return UUID.fromString(convertToStr(value)); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/package-info.java new file mode 100644 index 0000000..8a2c795 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/impl/package-info.java @@ -0,0 +1,7 @@ +/** + * 各种类型转换的实现类，其都为Converter接口的实现，用于将未知的Object类型转换为指定类型 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.convert.impl; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/package-info.java new file mode 100644 index 0000000..7abc364 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/convert/package-info.java @@ -0,0 +1,7 @@ +/** + * 万能类型转换器以及各种类型转换的实现类，其中Convert为转换器入口，提供各种toXXX方法和convert方法 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.convert; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/BetweenFormatter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/BetweenFormatter.java new file mode 100644 index 0000000..49c3fe5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/BetweenFormatter.java @@ -0,0 +1,208 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; + +/** + * 时长格式化器，用于格式化输出两个日期相差的时长
+ * 根据{@link Level}不同，调用{@link #format()}方法后返回类似于： + *
    + *
  • XX小时XX分XX秒
    • + *
  • XX天XX小时
    • + *
  • XX月XX天XX小时
    • + *
+ * + * @author Looly + */ +public class BetweenFormatter implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * 时长毫秒数 + */ + private long betweenMs; + /** + * 格式化级别 + */ + private Level level; + /** + * 格式化级别的最大个数 + */ + private final int levelMaxCount; + + /** + * 构造 + * + * @param betweenMs 日期间隔 + * @param level 级别，按照天、小时、分、秒、毫秒分为5个等级，根据传入等级，格式化到相应级别 + */ + public BetweenFormatter(long betweenMs, Level level) { + this(betweenMs, level, 0); + } + + /** + * 构造 + * + * @param betweenMs 日期间隔 + * @param level 级别，按照天、小时、分、秒、毫秒分为5个等级，根据传入等级，格式化到相应级别 + * @param levelMaxCount 格式化级别的最大个数，假如级别个数为1，但是级别到秒，那只显示一个级别 + */ + public BetweenFormatter(long betweenMs, Level level, int levelMaxCount) { + this.betweenMs = betweenMs; + this.level = level; + this.levelMaxCount = levelMaxCount; + } + + /** + * 格式化日期间隔输出
+ * + * @return 格式化后的字符串 + */ + public String format() { + final StringBuilder sb = new StringBuilder(); + if (betweenMs > 0) { + long day = betweenMs / DateUnit.DAY.getMillis(); + long hour = betweenMs / DateUnit.HOUR.getMillis() - day * 24; + long minute = betweenMs / DateUnit.MINUTE.getMillis() - day * 24 * 60 - hour * 60; + + final long BetweenOfSecond = ((day * 24 + hour) * 60 + minute) * 60; + long second = betweenMs / DateUnit.SECOND.getMillis() - BetweenOfSecond; + long millisecond = betweenMs - (BetweenOfSecond + second) * 1000; + + final int level = this.level.ordinal(); + int levelCount = 0; + + if (isLevelCountValid(levelCount) && 0 != day && level >= Level.DAY.ordinal()) { + sb.append(day).append(Level.DAY.name); + levelCount++; + } + if (isLevelCountValid(levelCount) && 0 != hour && level >= Level.HOUR.ordinal()) { + sb.append(hour).append(Level.HOUR.name); + levelCount++; + } + if (isLevelCountValid(levelCount) && 0 != minute && level >= Level.MINUTE.ordinal()) { + sb.append(minute).append(Level.MINUTE.name); + levelCount++; + } + if (isLevelCountValid(levelCount) && 0 != second && level >= Level.SECOND.ordinal()) { + sb.append(second).append(Level.SECOND.name); + levelCount++; + } + if (isLevelCountValid(levelCount) && 0 != millisecond && level >= Level.MILLISECOND.ordinal()) { + sb.append(millisecond).append(Level.MILLISECOND.name); + // levelCount++; + } + } + + if (StrUtil.isEmpty(sb)) { + sb.append(0).append(this.level.name); + } + + return sb.toString(); + } + + /** + * 获得 时长毫秒数 + * + * @return 时长毫秒数 + */ + public long getBetweenMs() { + return betweenMs; + } + + /** + * 设置 时长毫秒数 + * + * @param betweenMs 时长毫秒数 + */ + public void setBetweenMs(long betweenMs) { + this.betweenMs = betweenMs; + } + + /** + * 获得 格式化级别 + * + * @return 格式化级别 + */ + public Level getLevel() { + return level; + } + + /** + * 设置格式化级别 + * + * @param level 格式化级别 + */ + public void setLevel(Level level) { + this.level = level; + } + + /** + * 格式化等级枚举 + * + * @author Looly + */ + public enum Level { + + /** + * 天 + */ + DAY("天"), + /** + * 小时 + */ + HOUR("小时"), + /** + * 分钟 + */ + MINUTE("分"), + /** + * 秒 + */ + SECOND("秒"), + /** + * 毫秒 + */ + MILLISECOND("毫秒"); + + /** + * 级别名称 + */ + private final String name; + + /** + * 构造 + * + * @param name 级别名称 + */ + Level(String name) { + this.name = name; + } + + /** + * 获取级别名称 + * + * @return 级别名称 + */ + public String getName() { + return this.name; + } + } + + @Override + public String toString() { + return format(); + } + + /** + * 等级数量是否有效
+ * 有效的定义是：levelMaxCount大于0（被设置），当前等级数量没有超过这个最大值 + * + * @param levelCount 登记数量 + * @return 是否有效 + */ + private boolean isLevelCountValid(int levelCount) { + return this.levelMaxCount <= 0 || levelCount < this.levelMaxCount; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/CalendarUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/CalendarUtil.java new file mode 100644 index 0000000..4c3c51a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/CalendarUtil.java @@ -0,0 +1,768 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.comparator.CompareUtil; +import aiyh.utils.tool.cn.hutool.core.convert.NumberChineseFormatter; +import aiyh.utils.tool.cn.hutool.core.date.format.DateParser; +import aiyh.utils.tool.cn.hutool.core.date.format.FastDateParser; +import aiyh.utils.tool.cn.hutool.core.date.format.GlobalCustomFormat; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.text.ParsePosition; +import java.time.Instant; +import java.time.LocalDateTime; +import java.util.Calendar; +import java.util.Date; +import java.util.LinkedHashSet; +import java.util.Locale; +import java.util.TimeZone; + +/** + * 针对{@link Calendar} 对象封装工具类 + * + * @author looly + * @since 5.3.0 + */ +public class CalendarUtil { + + /** + * 创建Calendar对象，时间为默认时区的当前时间 + * + * @return Calendar对象 + * @since 4.6.6 + */ + public static Calendar calendar() { + return Calendar.getInstance(); + } + + /** + * 转换为Calendar对象 + * + * @param date 日期对象 + * @return Calendar对象 + */ + public static Calendar calendar(Date date) { + if (date instanceof DateTime) { + return ((DateTime) date).toCalendar(); + } else { + return calendar(date.getTime()); + } + } + + /** + * 转换为Calendar对象，使用当前默认时区 + * + * @param millis 时间戳 + * @return Calendar对象 + */ + public static Calendar calendar(long millis) { + return calendar(millis, TimeZone.getDefault()); + } + + /** + * 转换为Calendar对象 + * + * @param millis 时间戳 + * @param timeZone 时区 + * @return Calendar对象 + * @since 5.7.22 + */ + public static Calendar calendar(long millis, TimeZone timeZone) { + final Calendar cal = Calendar.getInstance(timeZone); + cal.setTimeInMillis(millis); + return cal; + } + + /** + * 是否为上午 + * + * @param calendar {@link Calendar} + * @return 是否为上午 + */ + public static boolean isAM(Calendar calendar) { + return Calendar.AM == calendar.get(Calendar.AM_PM); + } + + /** + * 是否为下午 + * + * @param calendar {@link Calendar} + * @return 是否为下午 + */ + public static boolean isPM(Calendar calendar) { + return Calendar.PM == calendar.get(Calendar.AM_PM); + } + + /** + * 修改日期为某个时间字段起始时间 + * + * @param calendar {@link Calendar} + * @param dateField 保留到的时间字段，如定义为 {@link DateField#SECOND}，表示这个字段不变，这个字段以下字段全部归0 + * @return 原{@link Calendar} + */ + public static Calendar truncate(Calendar calendar, DateField dateField) { + return DateModifier.modify(calendar, dateField.getValue(), DateModifier.ModifyType.TRUNCATE); + } + + /** + * 修改日期为某个时间字段四舍五入时间 + * + * @param calendar {@link Calendar} + * @param dateField 时间字段 + * @return 原{@link Calendar} + */ + public static Calendar round(Calendar calendar, DateField dateField) { + return DateModifier.modify(calendar, dateField.getValue(), DateModifier.ModifyType.ROUND); + } + + /** + * 修改日期为某个时间字段结束时间 + * + * @param calendar {@link Calendar} + * @param dateField 保留到的时间字段，如定义为 {@link DateField#SECOND}，表示这个字段不变，这个字段以下字段全部取最大值 + * @return 原{@link Calendar} + */ + public static Calendar ceiling(Calendar calendar, DateField dateField) { + return DateModifier.modify(calendar, dateField.getValue(), DateModifier.ModifyType.CEILING); + } + + /** + * 修改日期为某个时间字段结束时间
+ * 可选是否归零毫秒。 + * + *

+ * 有时候由于毫秒部分必须为0（如MySQL数据库中），因此在此加上选项。 + *

+ * + * @param calendar {@link Calendar} + * @param dateField 时间字段 + * @param truncateMillisecond 是否毫秒归零 + * @return 原{@link Calendar} + */ + public static Calendar ceiling(Calendar calendar, DateField dateField, boolean truncateMillisecond) { + return DateModifier.modify(calendar, dateField.getValue(), DateModifier.ModifyType.CEILING, truncateMillisecond); + } + + /** + * 修改秒级别的开始时间，即忽略毫秒部分 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + * @since 4.6.2 + */ + public static Calendar beginOfSecond(Calendar calendar) { + return truncate(calendar, DateField.SECOND); + } + + /** + * 修改秒级别的结束时间，即毫秒设置为999 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + * @since 4.6.2 + */ + public static Calendar endOfSecond(Calendar calendar) { + return ceiling(calendar, DateField.SECOND); + } + + /** + * 修改某小时的开始时间 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + */ + public static Calendar beginOfHour(Calendar calendar) { + return truncate(calendar, DateField.HOUR_OF_DAY); + } + + /** + * 修改某小时的结束时间 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + */ + public static Calendar endOfHour(Calendar calendar) { + return ceiling(calendar, DateField.HOUR_OF_DAY); + } + + /** + * 修改某分钟的开始时间 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + */ + public static Calendar beginOfMinute(Calendar calendar) { + return truncate(calendar, DateField.MINUTE); + } + + /** + * 修改某分钟的结束时间 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + */ + public static Calendar endOfMinute(Calendar calendar) { + return ceiling(calendar, DateField.MINUTE); + } + + /** + * 修改某天的开始时间 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + */ + public static Calendar beginOfDay(Calendar calendar) { + return truncate(calendar, DateField.DAY_OF_MONTH); + } + + /** + * 修改某天的结束时间 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + */ + public static Calendar endOfDay(Calendar calendar) { + return ceiling(calendar, DateField.DAY_OF_MONTH); + } + + /** + * 修改给定日期当前周的开始时间，周一定为一周的开始时间 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + */ + public static Calendar beginOfWeek(Calendar calendar) { + return beginOfWeek(calendar, true); + } + + /** + * 修改给定日期当前周的开始时间 + * + * @param calendar 日期 {@link Calendar} + * @param isMondayAsFirstDay 是否周一做为一周的第一天（false表示周日做为第一天） + * @return {@link Calendar} + * @since 3.1.2 + */ + public static Calendar beginOfWeek(Calendar calendar, boolean isMondayAsFirstDay) { + calendar.setFirstDayOfWeek(isMondayAsFirstDay ? Calendar.MONDAY : Calendar.SUNDAY); + // WEEK_OF_MONTH为上限的字段（不包括），实际调整的为DAY_OF_MONTH + return truncate(calendar, DateField.WEEK_OF_MONTH); + } + + /** + * 修改某周的结束时间，周日定为一周的结束 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + */ + public static Calendar endOfWeek(Calendar calendar) { + return endOfWeek(calendar, true); + } + + /** + * 修改某周的结束时间 + * + * @param calendar 日期 {@link Calendar} + * @param isSundayAsLastDay 是否周日做为一周的最后一天（false表示周六做为最后一天） + * @return {@link Calendar} + */ + public static Calendar endOfWeek(Calendar calendar, boolean isSundayAsLastDay) { + calendar.setFirstDayOfWeek(isSundayAsLastDay ? Calendar.MONDAY : Calendar.SUNDAY); + // WEEK_OF_MONTH为上限的字段（不包括），实际调整的为DAY_OF_MONTH + return ceiling(calendar, DateField.WEEK_OF_MONTH); + } + + /** + * 修改某月的开始时间 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + */ + public static Calendar beginOfMonth(Calendar calendar) { + return truncate(calendar, DateField.MONTH); + } + + /** + * 修改某月的结束时间 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + */ + public static Calendar endOfMonth(Calendar calendar) { + return ceiling(calendar, DateField.MONTH); + } + + /** + * 修改某季度的开始时间 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + * @since 4.1.0 + */ + public static Calendar beginOfQuarter(Calendar calendar) { + //noinspection MagicConstant + calendar.set(Calendar.MONTH, calendar.get(DateField.MONTH.getValue()) / 3 * 3); + calendar.set(Calendar.DAY_OF_MONTH, 1); + return beginOfDay(calendar); + } + + /** + * 获取某季度的结束时间 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + * @since 4.1.0 + */ + @SuppressWarnings({"MagicConstant", "ConstantConditions"}) + public static Calendar endOfQuarter(Calendar calendar) { + final int year = calendar.get(Calendar.YEAR); + final int month = calendar.get(DateField.MONTH.getValue()) / 3 * 3 + 2; + + final Calendar resultCal = Calendar.getInstance(calendar.getTimeZone()); + resultCal.set(year, month, Month.of(month).getLastDay(DateUtil.isLeapYear(year))); + + return endOfDay(resultCal); + } + + /** + * 修改某年的开始时间 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + */ + public static Calendar beginOfYear(Calendar calendar) { + return truncate(calendar, DateField.YEAR); + } + + /** + * 修改某年的结束时间 + * + * @param calendar 日期 {@link Calendar} + * @return {@link Calendar} + */ + public static Calendar endOfYear(Calendar calendar) { + return ceiling(calendar, DateField.YEAR); + } + + /** + * 比较两个日期是否为同一天 + * + * @param cal1 日期1 + * @param cal2 日期2 + * @return 是否为同一天 + */ + public static boolean isSameDay(Calendar cal1, Calendar cal2) { + if (cal1 == null || cal2 == null) { + throw new IllegalArgumentException("The date must not be null"); + } + return cal1.get(Calendar.DAY_OF_YEAR) == cal2.get(Calendar.DAY_OF_YEAR) && // + cal1.get(Calendar.YEAR) == cal2.get(Calendar.YEAR) && // + cal1.get(Calendar.ERA) == cal2.get(Calendar.ERA); + } + + /** + * 比较两个日期是否为同一周 + * + * @param cal1 日期1 + * @param cal2 日期2 + * @param isMon 是否为周一。国内第一天为星期一，国外第一天为星期日 + * @return 是否为同一周 + * @since 5.7.21 + */ + public static boolean isSameWeek(Calendar cal1, Calendar cal2, boolean isMon) { + if (cal1 == null || cal2 == null) { + throw new IllegalArgumentException("The date must not be null"); + } + + // 防止比较前修改原始Calendar对象 + cal1 = (Calendar) cal1.clone(); + cal2 = (Calendar) cal2.clone(); + + // 把所传日期设置为其当前周的第一天 + // 比较设置后的两个日期是否是同一天：true 代表同一周 + if (isMon) { + cal1.setFirstDayOfWeek(Calendar.MONDAY); + cal1.set(Calendar.DAY_OF_WEEK, Calendar.MONDAY); + cal2.setFirstDayOfWeek(Calendar.MONDAY); + cal2.set(Calendar.DAY_OF_WEEK, Calendar.MONDAY); + } else { + cal1.setFirstDayOfWeek(Calendar.SUNDAY); + cal1.set(Calendar.DAY_OF_WEEK, Calendar.SUNDAY); + cal2.setFirstDayOfWeek(Calendar.SUNDAY); + cal2.set(Calendar.DAY_OF_WEEK, Calendar.SUNDAY); + } + return isSameDay(cal1, cal2); + } + + /** + * 比较两个日期是否为同一月 + * + * @param cal1 日期1 + * @param cal2 日期2 + * @return 是否为同一月 + * @since 5.4.1 + */ + public static boolean isSameMonth(Calendar cal1, Calendar cal2) { + if (cal1 == null || cal2 == null) { + throw new IllegalArgumentException("The date must not be null"); + } + return cal1.get(Calendar.YEAR) == cal2.get(Calendar.YEAR) && // + cal1.get(Calendar.MONTH) == cal2.get(Calendar.MONTH); + } + + /** + *

检查两个Calendar时间戳是否相同。

+ * + *

此方法检查两个Calendar的毫秒数时间戳是否相同。

+ * + * @param date1 时间1 + * @param date2 时间2 + * @return 两个Calendar时间戳是否相同。如果两个时间都为{@code null}返回true，否则有{@code null}返回false + * @since 5.3.11 + */ + public static boolean isSameInstant(Calendar date1, Calendar date2) { + if (null == date1) { + return null == date2; + } + if (null == date2) { + return false; + } + + return date1.getTimeInMillis() == date2.getTimeInMillis(); + } + + /** + * 获得指定日期区间内的年份和季度
+ * + * @param startDate 起始日期（包含） + * @param endDate 结束日期（包含） + * @return 季度列表 ，元素类似于 20132 + * @since 4.1.15 + */ + public static LinkedHashSet yearAndQuarter(long startDate, long endDate) { + LinkedHashSet quarters = new LinkedHashSet<>(); + final Calendar cal = calendar(startDate); + while (startDate <= endDate) { + // 如果开始时间超出结束时间，让结束时间为开始时间，处理完后结束循环 + quarters.add(yearAndQuarter(cal)); + + cal.add(Calendar.MONTH, 3); + startDate = cal.getTimeInMillis(); + } + + return quarters; + } + + /** + * 获得指定日期年份和季度
+ * 格式：[20131]表示2013年第一季度 + * + * @param cal 日期 + * @return 年和季度，格式类似于20131 + */ + public static String yearAndQuarter(Calendar cal) { + return StrUtil.builder().append(cal.get(Calendar.YEAR)).append(cal.get(Calendar.MONTH) / 3 + 1).toString(); + } + + /** + * 获取指定日期字段的最小值，例如分钟的最小值是0 + * + * @param calendar {@link Calendar} + * @param dateField {@link DateField} + * @return 字段最小值 + * @see Calendar#getActualMinimum(int) + * @since 5.4.2 + */ + public static int getBeginValue(Calendar calendar, DateField dateField) { + return getBeginValue(calendar, dateField.getValue()); + } + + /** + * 获取指定日期字段的最小值，例如分钟的最小值是0 + * + * @param calendar {@link Calendar} + * @param dateField {@link DateField} + * @return 字段最小值 + * @see Calendar#getActualMinimum(int) + * @since 4.5.7 + */ + public static int getBeginValue(Calendar calendar, int dateField) { + if (Calendar.DAY_OF_WEEK == dateField) { + return calendar.getFirstDayOfWeek(); + } + return calendar.getActualMinimum(dateField); + } + + /** + * 获取指定日期字段的最大值，例如分钟的最大值是59 + * + * @param calendar {@link Calendar} + * @param dateField {@link DateField} + * @return 字段最大值 + * @see Calendar#getActualMaximum(int) + * @since 5.4.2 + */ + public static int getEndValue(Calendar calendar, DateField dateField) { + return getEndValue(calendar, dateField.getValue()); + } + + /** + * 获取指定日期字段的最大值，例如分钟的最大值是59 + * + * @param calendar {@link Calendar} + * @param dateField {@link DateField} + * @return 字段最大值 + * @see Calendar#getActualMaximum(int) + * @since 4.5.7 + */ + public static int getEndValue(Calendar calendar, int dateField) { + if (Calendar.DAY_OF_WEEK == dateField) { + return (calendar.getFirstDayOfWeek() + 6) % 7; + } + return calendar.getActualMaximum(dateField); + } + + /** + * Calendar{@link Instant}对象 + * + * @param calendar Date对象 + * @return {@link Instant}对象 + * @since 5.0.5 + */ + public static Instant toInstant(Calendar calendar) { + return null == calendar ? null : calendar.toInstant(); + } + + /** + * {@link Calendar} 转换为 {@link LocalDateTime}，使用系统默认时区 + * + * @param calendar {@link Calendar} + * @return {@link LocalDateTime} + * @since 5.0.5 + */ + public static LocalDateTime toLocalDateTime(Calendar calendar) { + return LocalDateTime.ofInstant(calendar.toInstant(), calendar.getTimeZone().toZoneId()); + } + + /** + * {@code null}安全的{@link Calendar}比较，{@code null}小于任何日期 + * + * @param calendar1 日期1 + * @param calendar2 日期2 + * @return 比较结果，如果calendar1 < calendar2，返回数小于0，calendar1==calendar2返回0，calendar1 > calendar2 大于0 + * @since 4.6.2 + */ + public static int compare(Calendar calendar1, Calendar calendar2) { + return CompareUtil.compare(calendar1, calendar2); + } + + /** + * 计算相对于dateToCompare的年龄，长用于计算指定生日在某年的年龄 + * + * @param birthday 生日 + * @param dateToCompare 需要对比的日期 + * @return 年龄 + */ + public static int age(Calendar birthday, Calendar dateToCompare) { + return age(birthday.getTimeInMillis(), dateToCompare.getTimeInMillis()); + } + + /** + * 将指定Calendar时间格式化为纯中文形式，比如： + * + * 
+	 *     2018-02-24 12:13:14 转换为 二〇一八年二月二十四日（withTime为false）
+	 *     2018-02-24 12:13:14 转换为 二〇一八年二月二十四日十二时十三分十四秒（withTime为true）
+	 *
+ * + * @param calendar {@link Calendar} + * @param withTime 是否包含时间部分 + * @return 格式化后的字符串 + * @since 5.3.9 + */ + public static String formatChineseDate(Calendar calendar, boolean withTime) { + final StringBuilder result = StrUtil.builder(); + + // 年 + final String year = String.valueOf(calendar.get(Calendar.YEAR)); + final int length = year.length(); + for (int i = 0; i < length; i++) { + result.append(NumberChineseFormatter.numberCharToChinese(year.charAt(i), false)); + } + result.append('年'); + + // 月 + int month = calendar.get(Calendar.MONTH) + 1; + result.append(NumberChineseFormatter.formatThousand(month, false)); + result.append('月'); + + // 日 + int day = calendar.get(Calendar.DAY_OF_MONTH); + result.append(NumberChineseFormatter.formatThousand(day, false)); + result.append('日'); + + // 只替换年月日，时分秒中零不需要替换 + String temp = result.toString().replace('零', '〇'); + result.delete(0, result.length()); + result.append(temp); + + + if (withTime) { + // 时 + int hour = calendar.get(Calendar.HOUR_OF_DAY); + result.append(NumberChineseFormatter.formatThousand(hour, false)); + result.append('时'); + // 分 + int minute = calendar.get(Calendar.MINUTE); + result.append(NumberChineseFormatter.formatThousand(minute, false)); + result.append('分'); + // 秒 + int second = calendar.get(Calendar.SECOND); + result.append(NumberChineseFormatter.formatThousand(second, false)); + result.append('秒'); + } + + return result.toString(); + } + + /** + * 计算相对于dateToCompare的年龄，长用于计算指定生日在某年的年龄 + * + * @param birthday 生日 + * @param dateToCompare 需要对比的日期 + * @return 年龄 + */ + protected static int age(long birthday, long dateToCompare) { + if (birthday > dateToCompare) { + throw new IllegalArgumentException("Birthday is after dateToCompare!"); + } + + final Calendar cal = Calendar.getInstance(); + cal.setTimeInMillis(dateToCompare); + + final int year = cal.get(Calendar.YEAR); + final int month = cal.get(Calendar.MONTH); + final int dayOfMonth = cal.get(Calendar.DAY_OF_MONTH); + final boolean isLastDayOfMonth = dayOfMonth == cal.getActualMaximum(Calendar.DAY_OF_MONTH); + + cal.setTimeInMillis(birthday); + int age = year - cal.get(Calendar.YEAR); + + final int monthBirth = cal.get(Calendar.MONTH); + if (month == monthBirth) { + + final int dayOfMonthBirth = cal.get(Calendar.DAY_OF_MONTH); + final boolean isLastDayOfMonthBirth = dayOfMonthBirth == cal.getActualMaximum(Calendar.DAY_OF_MONTH); + if ((false == isLastDayOfMonth || false == isLastDayOfMonthBirth) && dayOfMonth < dayOfMonthBirth) { + // 如果生日在当月，但是未达到生日当天的日期，年龄减一 + age--; + } + } else if (month < monthBirth) { + // 如果当前月份未达到生日的月份，年龄计算减一 + age--; + } + + return age; + } + + /** + * 通过给定的日期格式解析日期时间字符串。
+ * 传入的日期格式会逐个尝试，直到解析成功，返回{@link Calendar}对象，否则抛出{@link DateException}异常。 + * 方法来自：Apache Commons-Lang3 + * + * @param str 日期时间字符串，非空 + * @param parsePatterns 需要尝试的日期时间格式数组，非空, 见SimpleDateFormat + * @return 解析后的Calendar + * @throws IllegalArgumentException if the date string or pattern array is null + * @throws DateException if none of the date patterns were suitable + * @since 5.3.11 + */ + public static Calendar parseByPatterns(String str, String... parsePatterns) throws DateException { + return parseByPatterns(str, null, parsePatterns); + } + + /** + * 通过给定的日期格式解析日期时间字符串。
+ * 传入的日期格式会逐个尝试，直到解析成功，返回{@link Calendar}对象，否则抛出{@link DateException}异常。 + * 方法来自：Apache Commons-Lang3 + * + * @param str 日期时间字符串，非空 + * @param locale 地区，当为{@code null}时使用{@link Locale#getDefault()} + * @param parsePatterns 需要尝试的日期时间格式数组，非空, 见SimpleDateFormat + * @return 解析后的Calendar + * @throws IllegalArgumentException if the date string or pattern array is null + * @throws DateException if none of the date patterns were suitable + * @since 5.3.11 + */ + public static Calendar parseByPatterns(String str, Locale locale, String... parsePatterns) throws DateException { + return parseByPatterns(str, locale, true, parsePatterns); + } + + /** + * 通过给定的日期格式解析日期时间字符串。
+ * 传入的日期格式会逐个尝试，直到解析成功，返回{@link Calendar}对象，否则抛出{@link DateException}异常。 + * 方法来自：Apache Commons-Lang3 + * + * @param str 日期时间字符串，非空 + * @param locale 地区，当为{@code null}时使用{@link Locale#getDefault()} + * @param lenient 日期时间解析是否使用严格模式 + * @param parsePatterns 需要尝试的日期时间格式数组，非空, 见SimpleDateFormat + * @return 解析后的Calendar + * @throws IllegalArgumentException if the date string or pattern array is null + * @throws DateException if none of the date patterns were suitable + * @see java.util.Calendar#isLenient() + * @since 5.3.11 + */ + public static Calendar parseByPatterns(String str, Locale locale, boolean lenient, String... parsePatterns) throws DateException { + if (str == null || parsePatterns == null) { + throw new IllegalArgumentException("Date and Patterns must not be null"); + } + + final TimeZone tz = TimeZone.getDefault(); + final Locale lcl = ObjectUtil.defaultIfNull(locale, Locale.getDefault()); + final ParsePosition pos = new ParsePosition(0); + final Calendar calendar = Calendar.getInstance(tz, lcl); + calendar.setLenient(lenient); + + for (final String parsePattern : parsePatterns) { + if (GlobalCustomFormat.isCustomFormat(parsePattern)) { + final Date parse = GlobalCustomFormat.parse(str, parsePattern); + if (null == parse) { + continue; + } + calendar.setTime(parse); + return calendar; + } + + final FastDateParser fdp = new FastDateParser(parsePattern, tz, lcl); + calendar.clear(); + try { + if (fdp.parse(str, pos, calendar) && pos.getIndex() == str.length()) { + return calendar; + } + } catch (final IllegalArgumentException ignore) { + // leniency is preventing calendar from being set + } + pos.setIndex(0); + } + + throw new DateException("Unable to parse the date: {}", str); + } + + /** + * 使用指定{@link DateParser}解析字符串为{@link Calendar} + * + * @param str 日期字符串 + * @param lenient 是否宽容模式 + * @param parser {@link DateParser} + * @return 解析后的 {@link Calendar}，解析失败返回{@code null} + * @since 5.7.14 + */ + public static Calendar parse(CharSequence str, boolean lenient, DateParser parser) { + final Calendar calendar = Calendar.getInstance(parser.getTimeZone(), parser.getLocale()); + calendar.clear(); + calendar.setLenient(lenient); + + return parser.parse(StrUtil.str(str), new ParsePosition(0), calendar) ? calendar : null; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/ChineseDate.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/ChineseDate.java new file mode 100644 index 0000000..c36605e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/ChineseDate.java @@ -0,0 +1,462 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.convert.NumberChineseFormatter; +import aiyh.utils.tool.cn.hutool.core.date.chinese.ChineseMonth; +import aiyh.utils.tool.cn.hutool.core.date.chinese.GanZhi; +import aiyh.utils.tool.cn.hutool.core.date.chinese.LunarFestival; +import aiyh.utils.tool.cn.hutool.core.date.chinese.LunarInfo; +import aiyh.utils.tool.cn.hutool.core.date.chinese.SolarTerms; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.time.LocalDate; +import java.util.Calendar; +import java.util.Date; + + +/** + * 农历日期工具，最大支持到2099年，支持： + * + *
    + *
  • 通过公历日期构造获取对应农历
    • + *
  • 通过农历日期直接构造
    • + *
+ * + * @author zjw, looly + * @since 5.1.1 + */ +public class ChineseDate { + + //农历年 + private final int year; + //农历月，润N月这个值就是N+1，其他月按照显示月份赋值 + private final int month; + // 当前月份是否闰月 + private final boolean isLeapMonth; + //农历日 + private final int day; + + //公历年 + private final int gyear; + //公历月，从1开始计数 + private final int gmonthBase1; + //公历日 + private final int gday; + + /** + * 通过公历日期构造 + * + * @param date 公历日期 + */ + public ChineseDate(Date date) { + this(LocalDateTimeUtil.ofDate(date.toInstant())); + } + + /** + * 通过公历日期构造 + * + * @param localDate 公历日期 + * @since 5.7.22 + */ + public ChineseDate(LocalDate localDate) { + // 公历 + gyear = localDate.getYear(); + gmonthBase1 = localDate.getMonthValue(); + gday = localDate.getDayOfMonth(); + + // 求出和1900年1月31日相差的天数 + int offset = (int) (localDate.toEpochDay() - LunarInfo.BASE_DAY); + + // 计算农历年份 + // 用offset减去每农历年的天数，计算当天是农历第几天，offset是当年的第几天 + int daysOfYear; + int iYear; + for (iYear = LunarInfo.BASE_YEAR; iYear <= LunarInfo.MAX_YEAR; iYear++) { + daysOfYear = LunarInfo.yearDays(iYear); + if (offset < daysOfYear) { + break; + } + offset -= daysOfYear; + } + + year = iYear; + // 计算农历月份 + final int leapMonth = LunarInfo.leapMonth(iYear); // 闰哪个月,1-12 + // 用当年的天数offset,逐个减去每月（农历）的天数，求出当天是本月的第几天 + int month; + int daysOfMonth; + boolean hasLeapMonth = false; + for (month = 1; month < 13; month++) { + // 闰月，如润的是五月，则5表示五月，6表示润五月 + if (leapMonth > 0 && month == (leapMonth + 1)) { + daysOfMonth = LunarInfo.leapDays(year); + hasLeapMonth = true; + } else { + // 普通月，当前面的月份存在闰月时，普通月份要-1，递补闰月的数字 + // 如2月是闰月，此时3月实际是第四个月 + daysOfMonth = LunarInfo.monthDays(year, hasLeapMonth ? month - 1 : month); + } + + if (offset < daysOfMonth) { + // offset不足月，结束 + break; + } + offset -= daysOfMonth; + } + + this.isLeapMonth = leapMonth > 0 && (month == (leapMonth + 1)); + if (hasLeapMonth && false == this.isLeapMonth) { + // 当前月份前有闰月，则月份显示要-1，除非当前月份就是润月 + month--; + } + this.month = month; + this.day = offset + 1; + } + + /** + * 构造方法传入日期
+ * 此方法自动判断闰月，如果chineseMonth为本年的闰月，则按照闰月计算 + * + * @param chineseYear 农历年 + * @param chineseMonth 农历月，1表示一月（正月） + * @param chineseDay 农历日，1表示初一 + * @since 5.2.4 + */ + public ChineseDate(int chineseYear, int chineseMonth, int chineseDay) { + this(chineseYear, chineseMonth, chineseDay, chineseMonth == LunarInfo.leapMonth(chineseYear)); + } + + /** + * 构造方法传入日期
+ * 通过isLeapMonth参数区分是否闰月，如五月是闰月，当isLeapMonth为{@code true}时，表示润五月，{@code false}表示五月 + * + * @param chineseYear 农历年 + * @param chineseMonth 农历月，1表示一月（正月），如果isLeapMonth为{@code true}，1表示润一月 + * @param chineseDay 农历日，1表示初一 + * @param isLeapMonth 当前月份是否闰月 + * @since 5.7.18 + */ + public ChineseDate(int chineseYear, int chineseMonth, int chineseDay, boolean isLeapMonth) { + if(chineseMonth != LunarInfo.leapMonth(chineseYear)){ + // issue#I5YB1A，用户传入的月份可能非闰月，此时此参数无效。 + isLeapMonth = false; + } + + this.day = chineseDay; + // 当月是闰月的后边的月定义为闰月，如润的是五月，则5表示五月，6表示润五月 + this.isLeapMonth = isLeapMonth; + // 闰月时，农历月份+1，如6表示润五月 + this.month = isLeapMonth ? chineseMonth + 1 : chineseMonth; + this.year = chineseYear; + + final DateTime dateTime = lunar2solar(chineseYear, chineseMonth, chineseDay, isLeapMonth); + if (null != dateTime) { + //初始化公历年 + this.gday = dateTime.dayOfMonth(); + //初始化公历月 + this.gmonthBase1 = dateTime.month() + 1; + //初始化公历日 + this.gyear = dateTime.year(); + } else { + //初始化公历年 + this.gday = -1; + //初始化公历月 + this.gmonthBase1 = -1; + //初始化公历日 + this.gyear = -1; + } + } + + /** + * 获得农历年份 + * + * @return 返回农历年份 + */ + public int getChineseYear() { + return this.year; + } + + /** + * 获取公历的年 + * + * @return 公历年 + * @since 5.6.1 + */ + public int getGregorianYear() { + return this.gyear; + } + + /** + * 获取农历的月，从1开始计数
+ * 此方法返回实际的月序号，如一月是闰月，则一月返回1，润一月返回2 + * + * @return 农历的月 + * @since 5.2.4 + */ + public int getMonth() { + return this.month; + } + + /** + * 获取公历的月，从1开始计数 + * + * @return 公历月 + * @since 5.6.1 + */ + public int getGregorianMonthBase1() { + return this.gmonthBase1; + } + + /** + * 获取公历的月，从0开始计数 + * + * @return 公历月 + * @since 5.6.1 + */ + public int getGregorianMonth() { + return this.gmonthBase1 - 1; + } + + /** + * 当前农历月份是否为闰月 + * + * @return 是否为闰月 + * @since 5.4.2 + */ + public boolean isLeapMonth() { + return this.isLeapMonth; + } + + + /** + * 获得农历月份（中文，例如二月，十二月，或者润一月） + * + * @return 返回农历月份 + */ + public String getChineseMonth() { + return getChineseMonth(false); + } + + /** + * 获得农历月称呼（中文，例如二月，腊月，或者润正月） + * + * @return 返回农历月份称呼 + */ + public String getChineseMonthName() { + return getChineseMonth(true); + } + + /** + * 获得农历月份（中文，例如二月，十二月，或者润一月） + * + * @param isTraditional 是否传统表示，例如一月传统表示为正月 + * @return 返回农历月份 + * @since 5.7.18 + */ + public String getChineseMonth(boolean isTraditional) { + return ChineseMonth.getChineseMonthName(isLeapMonth(), + isLeapMonth() ? this.month - 1 : this.month, isTraditional); + } + + /** + * 获取农历的日，从1开始计数 + * + * @return 农历的日，从1开始计数 + * @since 5.2.4 + */ + public int getDay() { + return this.day; + } + + /** + * 获取公历的日 + * + * @return 公历日 + * @since 5.6.1 + */ + public int getGregorianDay() { + return this.gday; + } + + /** + * 获得农历日 + * + * @return 获得农历日 + */ + public String getChineseDay() { + String[] chineseTen = {"初", "十", "廿", "卅"}; + int n = (day % 10 == 0) ? 9 : (day % 10 - 1); + if (day > 30) { + return ""; + } + switch (day) { + case 10: + return "初十"; + case 20: + return "二十"; + case 30: + return "三十"; + default: + return chineseTen[day / 10] + NumberChineseFormatter.format(n + 1, false); + } + } + + /** + * 获取公历的Date + * + * @return 公历Date + * @since 5.6.1 + */ + public Date getGregorianDate() { + return DateUtil.date(getGregorianCalendar()); + } + + /** + * 获取公历的Calendar + * + * @return 公历Calendar + * @since 5.6.1 + */ + public Calendar getGregorianCalendar() { + final Calendar calendar = CalendarUtil.calendar(); + //noinspection MagicConstant + calendar.set(this.gyear, getGregorianMonth(), this.gday, 0, 0, 0); + return calendar; + } + + /** + * 获得节日，闰月不计入节日中 + * + * @return 获得农历节日 + */ + public String getFestivals() { + return StrUtil.join(",", LunarFestival.getFestivals(this.year, this.month, day)); + } + + /** + * 获得年份生肖 + * + * @return 获得年份生肖 + */ + public String getChineseZodiac() { + return Zodiac.getChineseZodiac(this.year); + } + + + /** + * 获得年的天干地支 + * + * @return 获得天干地支 + */ + public String getCyclical() { + return GanZhi.getGanzhiOfYear(this.year); + } + + /** + * 干支纪年信息 + * + * @return 获得天干地支的年月日信息 + */ + public String getCyclicalYMD() { + if (gyear >= LunarInfo.BASE_YEAR && gmonthBase1 > 0 && gday > 0) { + return cyclicalm(gyear, gmonthBase1, gday); + } + return null; + } + + + /** + * 获得节气 + * + * @return 获得节气 + * @since 5.6.3 + */ + public String getTerm() { + return SolarTerms.getTerm(gyear, gmonthBase1, gday); + } + + /** + * 转换为标准的日期格式来表示农历日期，例如2020-01-13
+ * 如果存在闰月，显示闰月月份，如润二月显示2 + * + * @return 标准的日期格式 + * @since 5.2.4 + */ + public String toStringNormal() { + return String.format("%04d-%02d-%02d", this.year, + isLeapMonth() ? this.month - 1 : this.month, this.day); + } + + @Override + public String toString() { + return String.format("%s%s年 %s%s", getCyclical(), getChineseZodiac(), getChineseMonthName(), getChineseDay()); + } + + // ------------------------------------------------------- private method start + + /** + * 这里同步处理年月日的天干地支信息 + * + * @param year 公历年 + * @param month 公历月，从1开始 + * @param day 公历日 + * @return 天干地支信息 + */ + private String cyclicalm(int year, int month, int day) { + return StrUtil.format("{}年{}月{}日", + GanZhi.getGanzhiOfYear(this.year), + GanZhi.getGanzhiOfMonth(year, month, day), + GanZhi.getGanzhiOfDay(year, month, day)); + } + + /** + * 通过农历年月日信息 返回公历信息 提供给构造函数 + * + * @param chineseYear 农历年 + * @param chineseMonth 农历月 + * @param chineseDay 农历日 + * @param isLeapMonth 传入的月是不是闰月 + * @return 公历信息 + */ + private DateTime lunar2solar(int chineseYear, int chineseMonth, int chineseDay, boolean isLeapMonth) { + //超出了最大极限值 + if ((chineseYear == 2100 && chineseMonth == 12 && chineseDay > 1) || + (chineseYear == LunarInfo.BASE_YEAR && chineseMonth == 1 && chineseDay < 31)) { + return null; + } + int day = LunarInfo.monthDays(chineseYear, chineseMonth); + int _day = day; + if (isLeapMonth) { + _day = LunarInfo.leapDays(chineseYear); + } + //参数合法性效验 + if (chineseYear < LunarInfo.BASE_YEAR || chineseYear > 2100 || chineseDay > _day) { + return null; + } + //计算农历的时间差 + int offset = 0; + for (int i = LunarInfo.BASE_YEAR; i < chineseYear; i++) { + offset += LunarInfo.yearDays(i); + } + int leap; + boolean isAdd = false; + for (int i = 1; i < chineseMonth; i++) { + leap = LunarInfo.leapMonth(chineseYear); + if (false == isAdd) {//处理闰月 + if (leap <= i && leap > 0) { + offset += LunarInfo.leapDays(chineseYear); + isAdd = true; + } + } + offset += LunarInfo.monthDays(chineseYear, i); + } + //转换闰月农历 需补充该年闰月的前一个月的时差 + if (isLeapMonth) { + offset += day; + } + //1900年农历正月一日的公历时间为1900年1月30日0时0分0秒(该时间也是本农历的最开始起始点) -2203804800000 + return DateUtil.date(((offset + chineseDay - 31) * 86400000L) - 2203804800000L); + } + + // ------------------------------------------------------- private method end + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateBetween.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateBetween.java new file mode 100644 index 0000000..42803f5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateBetween.java @@ -0,0 +1,185 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.io.Serializable; +import java.util.Calendar; +import java.util.Date; + +/** + * 日期间隔 + * + * @author Looly + */ +public class DateBetween implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * 开始日期 + */ + private final Date begin; + /** + * 结束日期 + */ + private final Date end; + + /** + * 创建
+ * 在前的日期做为起始时间，在后的做为结束时间，间隔只保留绝对值正数 + * + * @param begin 起始时间 + * @param end 结束时间 + * @return DateBetween + * @since 3.2.3 + */ + public static DateBetween create(Date begin, Date end) { + return new DateBetween(begin, end); + } + + /** + * 创建
+ * 在前的日期做为起始时间，在后的做为结束时间，间隔只保留绝对值正数 + * + * @param begin 起始时间 + * @param end 结束时间 + * @param isAbs 日期间隔是否只保留绝对值正数 + * @return DateBetween + * @since 3.2.3 + */ + public static DateBetween create(Date begin, Date end, boolean isAbs) { + return new DateBetween(begin, end, isAbs); + } + + /** + * 构造
+ * 在前的日期做为起始时间，在后的做为结束时间，间隔只保留绝对值正数 + * + * @param begin 起始时间 + * @param end 结束时间 + */ + public DateBetween(Date begin, Date end) { + this(begin, end, true); + } + + /** + * 构造
+ * 在前的日期做为起始时间，在后的做为结束时间 + * + * @param begin 起始时间 + * @param end 结束时间 + * @param isAbs 日期间隔是否只保留绝对值正数 + * @since 3.1.1 + */ + public DateBetween(Date begin, Date end, boolean isAbs) { + Assert.notNull(begin, "Begin date is null !"); + Assert.notNull(end, "End date is null !"); + + if (isAbs && begin.after(end)) { + // 间隔只为正数的情况下，如果开始日期晚于结束日期，置换之 + this.begin = end; + this.end = begin; + } else { + this.begin = begin; + this.end = end; + } + } + + /** + * 判断两个日期相差的时长
+ * 返回 给定单位的时长差 + * + * @param unit 相差的单位：相差 天{@link DateUnit#DAY}、小时{@link DateUnit#HOUR} 等 + * @return 时长差 + */ + public long between(DateUnit unit) { + long diff = end.getTime() - begin.getTime(); + return diff / unit.getMillis(); + } + + /** + * 计算两个日期相差月数
+ * 在非重置情况下，如果起始日期的天大于结束日期的天，月数要少算1（不足1个月） + * + * @param isReset 是否重置时间为起始时间（重置天时分秒） + * @return 相差月数 + * @since 3.0.8 + */ + public long betweenMonth(boolean isReset) { + final Calendar beginCal = DateUtil.calendar(begin); + final Calendar endCal = DateUtil.calendar(end); + + final int betweenYear = endCal.get(Calendar.YEAR) - beginCal.get(Calendar.YEAR); + final int betweenMonthOfYear = endCal.get(Calendar.MONTH) - beginCal.get(Calendar.MONTH); + + int result = betweenYear * 12 + betweenMonthOfYear; + if (false == isReset) { + endCal.set(Calendar.YEAR, beginCal.get(Calendar.YEAR)); + endCal.set(Calendar.MONTH, beginCal.get(Calendar.MONTH)); + long between = endCal.getTimeInMillis() - beginCal.getTimeInMillis(); + if (between < 0) { + return result - 1; + } + } + return result; + } + + /** + * 计算两个日期相差年数
+ * 在非重置情况下，如果起始日期的月大于结束日期的月，年数要少算1（不足1年） + * + * @param isReset 是否重置时间为起始时间（重置月天时分秒） + * @return 相差年数 + * @since 3.0.8 + */ + public long betweenYear(boolean isReset) { + final Calendar beginCal = DateUtil.calendar(begin); + final Calendar endCal = DateUtil.calendar(end); + + int result = endCal.get(Calendar.YEAR) - beginCal.get(Calendar.YEAR); + if (false == isReset) { + // 考虑闰年的2月情况 + if (Calendar.FEBRUARY == beginCal.get(Calendar.MONTH) && Calendar.FEBRUARY == endCal.get(Calendar.MONTH)) { + if (beginCal.get(Calendar.DAY_OF_MONTH) == beginCal.getActualMaximum(Calendar.DAY_OF_MONTH) + && endCal.get(Calendar.DAY_OF_MONTH) == endCal.getActualMaximum(Calendar.DAY_OF_MONTH)) { + // 两个日期都位于2月的最后一天，此时月数按照相等对待，此时都设置为1号 + beginCal.set(Calendar.DAY_OF_MONTH, 1); + endCal.set(Calendar.DAY_OF_MONTH, 1); + } + } + + endCal.set(Calendar.YEAR, beginCal.get(Calendar.YEAR)); + long between = endCal.getTimeInMillis() - beginCal.getTimeInMillis(); + if (between < 0) { + return result - 1; + } + } + return result; + } + + /** + * 格式化输出时间差 + * + * @param unit 日期单位 + * @param level 级别 + * @return 字符串 + * @since 5.7.17 + */ + public String toString(DateUnit unit, BetweenFormatter.Level level) { + return DateUtil.formatBetween(between(unit), level); + } + + /** + * 格式化输出时间差 + * + * @param level 级别 + * @return 字符串 + */ + public String toString(BetweenFormatter.Level level) { + return toString(DateUnit.MS, level); + } + + @Override + public String toString() { + return toString(BetweenFormatter.Level.MILLISECOND); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateException.java new file mode 100644 index 0000000..0e4c767 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateException.java @@ -0,0 +1,32 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.exceptions.ExceptionUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 工具类异常 + * @author xiaoleilu + */ +public class DateException extends RuntimeException{ + private static final long serialVersionUID = 8247610319171014183L; + + public DateException(Throwable e) { + super(ExceptionUtil.getMessage(e), e); + } + + public DateException(String message) { + super(message); + } + + public DateException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public DateException(String message, Throwable throwable) { + super(message, throwable); + } + + public DateException(Throwable throwable, String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params), throwable); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateField.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateField.java new file mode 100644 index 0000000..bc07846 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateField.java @@ -0,0 +1,158 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import java.util.Calendar; + +/** + * 日期各个部分的枚举
+ * 与Calendar相应值对应 + * + * @author Looly + * + */ +public enum DateField { + + /** + * 世纪 + * + * @see Calendar#ERA + */ + ERA(Calendar.ERA), + /** + * 年 + * + * @see Calendar#YEAR + */ + YEAR(Calendar.YEAR), + /** + * 月 + * + * @see Calendar#MONTH + */ + MONTH(Calendar.MONTH), + /** + * 一年中第几周 + * + * @see Calendar#WEEK_OF_YEAR + */ + WEEK_OF_YEAR(Calendar.WEEK_OF_YEAR), + /** + * 一月中第几周 + * + * @see Calendar#WEEK_OF_MONTH + */ + WEEK_OF_MONTH(Calendar.WEEK_OF_MONTH), + /** + * 一月中的第几天 + * + * @see Calendar#DAY_OF_MONTH + */ + DAY_OF_MONTH(Calendar.DAY_OF_MONTH), + /** + * 一年中的第几天 + * + * @see Calendar#DAY_OF_YEAR + */ + DAY_OF_YEAR(Calendar.DAY_OF_YEAR), + /** + * 周几，1表示周日，2表示周一 + * + * @see Calendar#DAY_OF_WEEK + */ + DAY_OF_WEEK(Calendar.DAY_OF_WEEK), + /** + * 天所在的周是这个月的第几周 + * + * @see Calendar#DAY_OF_WEEK_IN_MONTH + */ + DAY_OF_WEEK_IN_MONTH(Calendar.DAY_OF_WEEK_IN_MONTH), + /** + * 上午或者下午 + * + * @see Calendar#AM_PM + */ + AM_PM(Calendar.AM_PM), + /** + * 小时，用于12小时制 + * + * @see Calendar#HOUR + */ + HOUR(Calendar.HOUR), + /** + * 小时，用于24小时制 + * + * @see Calendar#HOUR + */ + HOUR_OF_DAY(Calendar.HOUR_OF_DAY), + /** + * 分钟 + * + * @see Calendar#MINUTE + */ + MINUTE(Calendar.MINUTE), + /** + * 秒 + * + * @see Calendar#SECOND + */ + SECOND(Calendar.SECOND), + /** + * 毫秒 + * + * @see Calendar#MILLISECOND + */ + MILLISECOND(Calendar.MILLISECOND); + + // --------------------------------------------------------------- + private final int value; + + DateField(int value) { + this.value = value; + } + + public int getValue() { + return this.value; + } + + /** + * 将 {@link Calendar}相关值转换为DatePart枚举对象
+ * + * @param calendarPartIntValue Calendar中关于Week的int值 + * @return DateField + */ + public static DateField of(int calendarPartIntValue) { + switch (calendarPartIntValue) { + case Calendar.ERA: + return ERA; + case Calendar.YEAR: + return YEAR; + case Calendar.MONTH: + return MONTH; + case Calendar.WEEK_OF_YEAR: + return WEEK_OF_YEAR; + case Calendar.WEEK_OF_MONTH: + return WEEK_OF_MONTH; + case Calendar.DAY_OF_MONTH: + return DAY_OF_MONTH; + case Calendar.DAY_OF_YEAR: + return DAY_OF_YEAR; + case Calendar.DAY_OF_WEEK: + return DAY_OF_WEEK; + case Calendar.DAY_OF_WEEK_IN_MONTH: + return DAY_OF_WEEK_IN_MONTH; + case Calendar.AM_PM: + return AM_PM; + case Calendar.HOUR: + return HOUR; + case Calendar.HOUR_OF_DAY: + return HOUR_OF_DAY; + case Calendar.MINUTE: + return MINUTE; + case Calendar.SECOND: + return SECOND; + case Calendar.MILLISECOND: + return MILLISECOND; + default: + return null; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateModifier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateModifier.java new file mode 100644 index 0000000..73aa548 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateModifier.java @@ -0,0 +1,176 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; + +import java.util.Calendar; + +/** + * 日期修改器
+ * 用于实现自定义某个日期字段的调整，包括： + * + * 
+ * 1. 获取指定字段的起始时间
+ * 2. 获取指定字段的四舍五入时间
+ * 3. 获取指定字段的结束时间
+ *
+ * + * @author looly + */ +public class DateModifier { + + /** + * 忽略的计算的字段 + */ + private static final int[] IGNORE_FIELDS = new int[]{ // + Calendar.HOUR_OF_DAY, // 与HOUR同名 + Calendar.AM_PM, // 此字段单独处理，不参与计算起始和结束 + Calendar.DAY_OF_WEEK_IN_MONTH, // 不参与计算 + Calendar.DAY_OF_YEAR, // DAY_OF_MONTH体现 + Calendar.WEEK_OF_MONTH, // 特殊处理 + Calendar.WEEK_OF_YEAR // WEEK_OF_MONTH体现 + }; + + /** + * 修改日期 + * + * @param calendar {@link Calendar} + * @param dateField 日期字段，即保留到哪个日期字段 + * @param modifyType 修改类型，包括舍去、四舍五入、进一等 + * @return 修改后的{@link Calendar} + */ + public static Calendar modify(Calendar calendar, int dateField, ModifyType modifyType) { + return modify(calendar, dateField, modifyType, false); + } + + /** + * 修改日期，取起始值或者结束值
+ * 可选是否归零毫秒。 + * + *

+ * 在{@link ModifyType#TRUNCATE}模式下，毫秒始终要归零, + * 但是在{@link ModifyType#CEILING}和{@link ModifyType#ROUND}模式下， + * 有时候由于毫秒部分必须为0（如MySQL数据库中），因此在此加上选项。 + *

+ * + * @param calendar {@link Calendar} + * @param dateField 日期字段，即保留到哪个日期字段 + * @param modifyType 修改类型，包括舍去、四舍五入、进一等 + * @param truncateMillisecond 是否归零毫秒 + * @return 修改后的{@link Calendar} + * @since 5.7.5 + */ + public static Calendar modify(Calendar calendar, int dateField, ModifyType modifyType, boolean truncateMillisecond) { + // AM_PM上下午特殊处理 + if (Calendar.AM_PM == dateField) { + boolean isAM = DateUtil.isAM(calendar); + switch (modifyType) { + case TRUNCATE: + calendar.set(Calendar.HOUR_OF_DAY, isAM ? 0 : 12); + break; + case CEILING: + calendar.set(Calendar.HOUR_OF_DAY, isAM ? 11 : 23); + break; + case ROUND: + int min = isAM ? 0 : 12; + int max = isAM ? 11 : 23; + int href = (max - min) / 2 + 1; + int value = calendar.get(Calendar.HOUR_OF_DAY); + calendar.set(Calendar.HOUR_OF_DAY, (value < href) ? min : max); + break; + } + // 处理下一级别字段 + return modify(calendar, dateField + 1, modifyType); + } + + final int endField = truncateMillisecond ? Calendar.SECOND : Calendar.MILLISECOND; + // 循环处理各级字段，精确到毫秒字段 + for (int i = dateField + 1; i <= endField; i++) { + if (ArrayUtil.contains(IGNORE_FIELDS, i)) { + // 忽略无关字段（WEEK_OF_MONTH）始终不做修改 + continue; + } + + // 在计算本周的起始和结束日时，月相关的字段忽略。 + if (Calendar.WEEK_OF_MONTH == dateField || Calendar.WEEK_OF_YEAR == dateField) { + if (Calendar.DAY_OF_MONTH == i) { + continue; + } + } else { + // 其它情况忽略周相关字段计算 + if (Calendar.DAY_OF_WEEK == i) { + continue; + } + } + + modifyField(calendar, i, modifyType); + } + + if (truncateMillisecond) { + calendar.set(Calendar.MILLISECOND, 0); + } + + return calendar; + } + + // -------------------------------------------------------------------------------------------------- Private method start + + /** + * 修改日期字段值 + * + * @param calendar {@link Calendar} + * @param field 字段，见{@link Calendar} + * @param modifyType {@link ModifyType} + */ + private static void modifyField(Calendar calendar, int field, ModifyType modifyType) { + if (Calendar.HOUR == field) { + // 修正小时。HOUR为12小时制，上午的结束时间为12:00，此处改为HOUR_OF_DAY: 23:59 + field = Calendar.HOUR_OF_DAY; + } + + switch (modifyType) { + case TRUNCATE: + calendar.set(field, DateUtil.getBeginValue(calendar, field)); + break; + case CEILING: + calendar.set(field, DateUtil.getEndValue(calendar, field)); + break; + case ROUND: + int min = DateUtil.getBeginValue(calendar, field); + int max = DateUtil.getEndValue(calendar, field); + int href; + if (Calendar.DAY_OF_WEEK == field) { + // 星期特殊处理，假设周一是第一天，中间的为周四 + href = (min + 3) % 7; + } else { + href = (max - min) / 2 + 1; + } + int value = calendar.get(field); + calendar.set(field, (value < href) ? min : max); + break; + } + // Console.log("# {} -> {}", DateField.of(field), calendar.get(field)); + } + // -------------------------------------------------------------------------------------------------- Private method end + + /** + * 修改类型 + * + * @author looly + */ + public enum ModifyType { + /** + * 取指定日期短的起始值. + */ + TRUNCATE, + + /** + * 指定日期属性按照四舍五入处理 + */ + ROUND, + + /** + * 指定日期属性按照进一法处理 + */ + CEILING + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DatePattern.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DatePattern.java new file mode 100644 index 0000000..0ab0ab9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DatePattern.java @@ -0,0 +1,322 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.date.format.FastDateFormat; + +import java.time.ZoneId; +import java.time.format.DateTimeFormatter; +import java.util.Locale; +import java.util.TimeZone; +import java.util.regex.Pattern; + +/** + * 日期格式化类，提供常用的日期格式化对象 + * + * @author Looly + */ +public class DatePattern { + + /** + * 标准日期时间正则，每个字段支持单个数字或2个数字，包括： + * 
+	 *     yyyy-MM-dd HH:mm:ss.SSSSSS
+	 *     yyyy-MM-dd HH:mm:ss.SSS
+	 *     yyyy-MM-dd HH:mm:ss
+	 *     yyyy-MM-dd HH:mm
+	 *     yyyy-MM-dd
+	 *
+ * + * @since 5.3.6 + */ + public static final Pattern REGEX_NORM = Pattern.compile("\\d{4}-\\d{1,2}-\\d{1,2}(\\s\\d{1,2}:\\d{1,2}(:\\d{1,2})?)?(.\\d{1,6})?"); + + //-------------------------------------------------------------------------------------------------------------------------------- Normal + /** + * 年格式：yyyy + */ + public static final String NORM_YEAR_PATTERN = "yyyy"; + /** + * 年月格式：yyyy-MM + */ + public static final String NORM_MONTH_PATTERN = "yyyy-MM"; + /** + * 年月格式 {@link FastDateFormat}：yyyy-MM + */ + public static final FastDateFormat NORM_MONTH_FORMAT = FastDateFormat.getInstance(NORM_MONTH_PATTERN); + /** + * 年月格式 {@link FastDateFormat}：yyyy-MM + */ + public static final DateTimeFormatter NORM_MONTH_FORMATTER = createFormatter(NORM_MONTH_PATTERN); + + /** + * 简单年月格式：yyyyMM + */ + public static final String SIMPLE_MONTH_PATTERN = "yyyyMM"; + /** + * 简单年月格式 {@link FastDateFormat}：yyyyMM + */ + public static final FastDateFormat SIMPLE_MONTH_FORMAT = FastDateFormat.getInstance(SIMPLE_MONTH_PATTERN); + /** + * 简单年月格式 {@link FastDateFormat}：yyyyMM + */ + public static final DateTimeFormatter SIMPLE_MONTH_FORMATTER = createFormatter(SIMPLE_MONTH_PATTERN); + + /** + * 标准日期格式：yyyy-MM-dd + */ + public static final String NORM_DATE_PATTERN = "yyyy-MM-dd"; + /** + * 标准日期格式 {@link FastDateFormat}：yyyy-MM-dd + */ + public static final FastDateFormat NORM_DATE_FORMAT = FastDateFormat.getInstance(NORM_DATE_PATTERN); + /** + * 标准日期格式 {@link FastDateFormat}：yyyy-MM-dd + */ + public static final DateTimeFormatter NORM_DATE_FORMATTER = createFormatter(NORM_DATE_PATTERN); + + /** + * 标准时间格式：HH:mm:ss + */ + public static final String NORM_TIME_PATTERN = "HH:mm:ss"; + /** + * 标准时间格式 {@link FastDateFormat}：HH:mm:ss + */ + public static final FastDateFormat NORM_TIME_FORMAT = FastDateFormat.getInstance(NORM_TIME_PATTERN); + /** + * 标准日期格式 {@link FastDateFormat}：HH:mm:ss + */ + public static final DateTimeFormatter NORM_TIME_FORMATTER = createFormatter(NORM_TIME_PATTERN); + + /** + * 标准日期时间格式，精确到分：yyyy-MM-dd HH:mm + */ + public static final String NORM_DATETIME_MINUTE_PATTERN = "yyyy-MM-dd HH:mm"; + /** + * 标准日期时间格式，精确到分 {@link FastDateFormat}：yyyy-MM-dd HH:mm + */ + public static final FastDateFormat NORM_DATETIME_MINUTE_FORMAT = FastDateFormat.getInstance(NORM_DATETIME_MINUTE_PATTERN); + /** + * 标准日期格式 {@link FastDateFormat}：yyyy-MM-dd HH:mm + */ + public static final DateTimeFormatter NORM_DATETIME_MINUTE_FORMATTER = createFormatter(NORM_DATETIME_MINUTE_PATTERN); + + /** + * 标准日期时间格式，精确到秒：yyyy-MM-dd HH:mm:ss + */ + public static final String NORM_DATETIME_PATTERN = "yyyy-MM-dd HH:mm:ss"; + /** + * 标准日期时间格式，精确到秒 {@link FastDateFormat}：yyyy-MM-dd HH:mm:ss + */ + public static final FastDateFormat NORM_DATETIME_FORMAT = FastDateFormat.getInstance(NORM_DATETIME_PATTERN); + /** + * 标准日期时间格式，精确到秒 {@link FastDateFormat}：yyyy-MM-dd HH:mm:ss + */ + public static final DateTimeFormatter NORM_DATETIME_FORMATTER = createFormatter(NORM_DATETIME_PATTERN); + + /** + * 标准日期时间格式，精确到毫秒：yyyy-MM-dd HH:mm:ss.SSS + */ + public static final String NORM_DATETIME_MS_PATTERN = "yyyy-MM-dd HH:mm:ss.SSS"; + /** + * 标准日期时间格式，精确到毫秒 {@link FastDateFormat}：yyyy-MM-dd HH:mm:ss.SSS + */ + public static final FastDateFormat NORM_DATETIME_MS_FORMAT = FastDateFormat.getInstance(NORM_DATETIME_MS_PATTERN); + /** + * 标准日期时间格式，精确到毫秒 {@link FastDateFormat}：yyyy-MM-dd HH:mm:ss.SSS + */ + public static final DateTimeFormatter NORM_DATETIME_MS_FORMATTER = createFormatter(NORM_DATETIME_MS_PATTERN); + + /** + * ISO8601日期时间格式，精确到毫秒：yyyy-MM-dd HH:mm:ss,SSS + */ + public static final String ISO8601_PATTERN = "yyyy-MM-dd HH:mm:ss,SSS"; + /** + * ISO8601日期时间格式，精确到毫秒 {@link FastDateFormat}：yyyy-MM-dd HH:mm:ss,SSS + */ + public static final FastDateFormat ISO8601_FORMAT = FastDateFormat.getInstance(ISO8601_PATTERN); + /** + * 标准日期格式 {@link FastDateFormat}：yyyy-MM-dd HH:mm:ss,SSS + */ + public static final DateTimeFormatter ISO8601_FORMATTER = createFormatter(ISO8601_PATTERN); + + /** + * 标准日期格式：yyyy年MM月dd日 + */ + public static final String CHINESE_DATE_PATTERN = "yyyy年MM月dd日"; + /** + * 标准日期格式 {@link FastDateFormat}：yyyy年MM月dd日 + */ + public static final FastDateFormat CHINESE_DATE_FORMAT = FastDateFormat.getInstance(CHINESE_DATE_PATTERN); + /** + * 标准日期格式 {@link FastDateFormat}：yyyy年MM月dd日 + */ + public static final DateTimeFormatter CHINESE_DATE_FORMATTER = createFormatter(CHINESE_DATE_PATTERN); + + /** + * 标准日期格式：yyyy年MM月dd日 HH时mm分ss秒 + */ + public static final String CHINESE_DATE_TIME_PATTERN = "yyyy年MM月dd日HH时mm分ss秒"; + /** + * 标准日期格式 {@link FastDateFormat}：yyyy年MM月dd日HH时mm分ss秒 + */ + public static final FastDateFormat CHINESE_DATE_TIME_FORMAT = FastDateFormat.getInstance(CHINESE_DATE_TIME_PATTERN); + /** + * 标准日期格式 {@link FastDateFormat}：yyyy年MM月dd日HH时mm分ss秒 + */ + public static final DateTimeFormatter CHINESE_DATE_TIME_FORMATTER = createFormatter(CHINESE_DATE_TIME_PATTERN); + + //-------------------------------------------------------------------------------------------------------------------------------- Pure + /** + * 标准日期格式：yyyyMMdd + */ + public static final String PURE_DATE_PATTERN = "yyyyMMdd"; + /** + * 标准日期格式 {@link FastDateFormat}：yyyyMMdd + */ + public static final FastDateFormat PURE_DATE_FORMAT = FastDateFormat.getInstance(PURE_DATE_PATTERN); + /** + * 标准日期格式 {@link FastDateFormat}：yyyyMMdd + */ + public static final DateTimeFormatter PURE_DATE_FORMATTER = createFormatter(PURE_DATE_PATTERN); + + /** + * 标准日期格式：HHmmss + */ + public static final String PURE_TIME_PATTERN = "HHmmss"; + /** + * 标准日期格式 {@link FastDateFormat}：HHmmss + */ + public static final FastDateFormat PURE_TIME_FORMAT = FastDateFormat.getInstance(PURE_TIME_PATTERN); + /** + * 标准日期格式 {@link FastDateFormat}：HHmmss + */ + public static final DateTimeFormatter PURE_TIME_FORMATTER = createFormatter(PURE_TIME_PATTERN); + + /** + * 标准日期格式：yyyyMMddHHmmss + */ + public static final String PURE_DATETIME_PATTERN = "yyyyMMddHHmmss"; + /** + * 标准日期格式 {@link FastDateFormat}：yyyyMMddHHmmss + */ + public static final FastDateFormat PURE_DATETIME_FORMAT = FastDateFormat.getInstance(PURE_DATETIME_PATTERN); + /** + * 标准日期格式 {@link FastDateFormat}：yyyyMMddHHmmss + */ + public static final DateTimeFormatter PURE_DATETIME_FORMATTER = createFormatter(PURE_DATETIME_PATTERN); + + /** + * 标准日期格式：yyyyMMddHHmmssSSS + */ + public static final String PURE_DATETIME_MS_PATTERN = "yyyyMMddHHmmssSSS"; + /** + * 标准日期格式 {@link FastDateFormat}：yyyyMMddHHmmssSSS + */ + public static final FastDateFormat PURE_DATETIME_MS_FORMAT = FastDateFormat.getInstance(PURE_DATETIME_MS_PATTERN); + /** + * 标准日期格式 {@link FastDateFormat}：yyyyMMddHHmmssSSS + */ + public static final DateTimeFormatter PURE_DATETIME_MS_FORMATTER = createFormatter(PURE_DATETIME_MS_PATTERN); + + //-------------------------------------------------------------------------------------------------------------------------------- Others + /** + * HTTP头中日期时间格式：EEE, dd MMM yyyy HH:mm:ss z + */ + public static final String HTTP_DATETIME_PATTERN = "EEE, dd MMM yyyy HH:mm:ss z"; + /** + * HTTP头中日期时间格式 {@link FastDateFormat}：EEE, dd MMM yyyy HH:mm:ss z + */ + public static final FastDateFormat HTTP_DATETIME_FORMAT = FastDateFormat.getInstance(HTTP_DATETIME_PATTERN, TimeZone.getTimeZone("GMT"), Locale.US); + + /** + * JDK中日期时间格式：EEE MMM dd HH:mm:ss zzz yyyy + */ + public static final String JDK_DATETIME_PATTERN = "EEE MMM dd HH:mm:ss zzz yyyy"; + /** + * JDK中日期时间格式 {@link FastDateFormat}：EEE MMM dd HH:mm:ss zzz yyyy + */ + public static final FastDateFormat JDK_DATETIME_FORMAT = FastDateFormat.getInstance(JDK_DATETIME_PATTERN, Locale.US); + + /** + * UTC时间：yyyy-MM-dd'T'HH:mm:ss + */ + public static final String UTC_SIMPLE_PATTERN = "yyyy-MM-dd'T'HH:mm:ss"; + /** + * UTC时间{@link FastDateFormat}：yyyy-MM-dd'T'HH:mm:ss + */ + public static final FastDateFormat UTC_SIMPLE_FORMAT = FastDateFormat.getInstance(UTC_SIMPLE_PATTERN, TimeZone.getTimeZone("UTC")); + + /** + * UTC时间：yyyy-MM-dd'T'HH:mm:ss.SSS + */ + public static final String UTC_SIMPLE_MS_PATTERN = "yyyy-MM-dd'T'HH:mm:ss.SSS"; + /** + * UTC时间{@link FastDateFormat}：yyyy-MM-dd'T'HH:mm:ss.SSS + */ + public static final FastDateFormat UTC_SIMPLE_MS_FORMAT = FastDateFormat.getInstance(UTC_SIMPLE_MS_PATTERN, TimeZone.getTimeZone("UTC")); + + /** + * UTC时间：yyyy-MM-dd'T'HH:mm:ss'Z' + */ + public static final String UTC_PATTERN = "yyyy-MM-dd'T'HH:mm:ss'Z'"; + /** + * UTC时间{@link FastDateFormat}：yyyy-MM-dd'T'HH:mm:ss'Z' + */ + public static final FastDateFormat UTC_FORMAT = FastDateFormat.getInstance(UTC_PATTERN, TimeZone.getTimeZone("UTC")); + + /** + * UTC时间：yyyy-MM-dd'T'HH:mm:ssZ + */ + public static final String UTC_WITH_ZONE_OFFSET_PATTERN = "yyyy-MM-dd'T'HH:mm:ssZ"; + /** + * UTC时间{@link FastDateFormat}：yyyy-MM-dd'T'HH:mm:ssZ + */ + public static final FastDateFormat UTC_WITH_ZONE_OFFSET_FORMAT = FastDateFormat.getInstance(UTC_WITH_ZONE_OFFSET_PATTERN, TimeZone.getTimeZone("UTC")); + + /** + * UTC时间：yyyy-MM-dd'T'HH:mm:ssXXX + */ + public static final String UTC_WITH_XXX_OFFSET_PATTERN = "yyyy-MM-dd'T'HH:mm:ssXXX"; + /** + * UTC时间{@link FastDateFormat}：yyyy-MM-dd'T'HH:mm:ssXXX + */ + public static final FastDateFormat UTC_WITH_XXX_OFFSET_FORMAT = FastDateFormat.getInstance(UTC_WITH_XXX_OFFSET_PATTERN); + + /** + * UTC时间：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' + */ + public static final String UTC_MS_PATTERN = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"; + /** + * UTC时间{@link FastDateFormat}：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' + */ + public static final FastDateFormat UTC_MS_FORMAT = FastDateFormat.getInstance(UTC_MS_PATTERN, TimeZone.getTimeZone("UTC")); + + /** + * UTC时间：yyyy-MM-dd'T'HH:mm:ssZ + */ + public static final String UTC_MS_WITH_ZONE_OFFSET_PATTERN = "yyyy-MM-dd'T'HH:mm:ss.SSSZ"; + /** + * UTC时间{@link FastDateFormat}：yyyy-MM-dd'T'HH:mm:ssZ + */ + public static final FastDateFormat UTC_MS_WITH_ZONE_OFFSET_FORMAT = FastDateFormat.getInstance(UTC_MS_WITH_ZONE_OFFSET_PATTERN, TimeZone.getTimeZone("UTC")); + + /** + * UTC时间：yyyy-MM-dd'T'HH:mm:ss.SSSXXX + */ + public static final String UTC_MS_WITH_XXX_OFFSET_PATTERN = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"; + /** + * UTC时间{@link FastDateFormat}：yyyy-MM-dd'T'HH:mm:ss.SSSXXX + */ + public static final FastDateFormat UTC_MS_WITH_XXX_OFFSET_FORMAT = FastDateFormat.getInstance(UTC_MS_WITH_XXX_OFFSET_PATTERN); + + /** + * 创建并为 {@link DateTimeFormatter} 赋予默认时区和位置信息，默认值为系统默认值。 + * + * @param pattern 日期格式 + * @return {@link DateTimeFormatter} + * @since 5.7.5 + */ + public static DateTimeFormatter createFormatter(String pattern) { + return DateTimeFormatter.ofPattern(pattern, Locale.getDefault()) + .withZone(ZoneId.systemDefault()); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateRange.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateRange.java new file mode 100644 index 0000000..6fbeb06 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateRange.java @@ -0,0 +1,59 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.lang.Range; + +import java.util.Date; + +/** + * 日期范围 + * + * @author looly + * @since 4.1.0 + */ +public class DateRange extends Range { + private static final long serialVersionUID = 1L; + + /** + * 构造，包含开始和结束日期时间 + * + * @param start 起始日期时间（包括） + * @param end 结束日期时间（包括） + * @param unit 步进单位 + */ + public DateRange(Date start, Date end, DateField unit) { + this(start, end, unit, 1); + } + + /** + * 构造，包含开始和结束日期时间 + * + * @param start 起始日期时间（包括） + * @param end 结束日期时间（包括） + * @param unit 步进单位 + * @param step 步进数 + */ + public DateRange(Date start, Date end, DateField unit, int step) { + this(start, end, unit, step, true, true); + } + + /** + * 构造 + * + * @param start 起始日期时间 + * @param end 结束日期时间 + * @param unit 步进单位 + * @param step 步进数 + * @param isIncludeStart 是否包含开始的时间 + * @param isIncludeEnd 是否包含结束的时间 + */ + public DateRange(Date start, Date end, DateField unit, int step, boolean isIncludeStart, boolean isIncludeEnd) { + super(DateUtil.date(start), DateUtil.date(end), (current, end1, index) -> { + final DateTime dt = DateUtil.date(start).offsetNew(unit, (index + 1) * step); + if (dt.isAfter(end1)) { + return null; + } + return dt; + }, isIncludeStart, isIncludeEnd); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateTime.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateTime.java new file mode 100644 index 0000000..53585e1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateTime.java @@ -0,0 +1,1132 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.date.format.DateParser; +import aiyh.utils.tool.cn.hutool.core.date.format.DatePrinter; +import aiyh.utils.tool.cn.hutool.core.date.format.FastDateFormat; +import aiyh.utils.tool.cn.hutool.core.date.format.GlobalCustomFormat; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import aiyh.utils.tool.cn.hutool.core.util.SystemPropsUtil; + +import java.sql.Timestamp; +import java.text.DateFormat; +import java.text.SimpleDateFormat; +import java.time.Instant; +import java.time.LocalDateTime; +import java.time.ZoneId; +import java.time.ZonedDateTime; +import java.time.format.DateTimeFormatter; +import java.time.temporal.TemporalAccessor; +import java.util.Calendar; +import java.util.Date; +import java.util.Locale; +import java.util.TimeZone; + +/** + * 包装{@link Date}
+ * 此类继承了{@link Date}，并提供扩展方法，如时区等。
+ * 此类重写了父类的{@code toString()}方法，返回值为"yyyy-MM-dd HH:mm:ss"格式 + * + * @author xiaoleilu + */ +public class DateTime extends Date { + private static final long serialVersionUID = -5395712593979185936L; + + private static boolean useJdkToStringStyle = false; + + /** + * 设置全局的，是否使用{@link Date}默认的toString()格式
+ * 如果为{@code true}，则调用toString()时返回"EEE MMM dd HH:mm:ss zzz yyyy"格式，
+ * 如果为{@code false}，则返回"yyyy-MM-dd HH:mm:ss"，
+ * 默认为{@code false} + * + * @param customUseJdkToStringStyle 是否使用{@link Date}默认的toString()格式 + * @since 5.7.21 + */ + public static void setUseJdkToStringStyle(boolean customUseJdkToStringStyle){ + useJdkToStringStyle = customUseJdkToStringStyle; + } + + /** + * 是否可变对象 + */ + private boolean mutable = true; + /** + * 一周的第一天，默认是周一， 在设置或获得 WEEK_OF_MONTH 或 WEEK_OF_YEAR 字段时，Calendar 必须确定一个月或一年的第一个星期，以此作为参考点。 + */ + private Week firstDayOfWeek = Week.MONDAY; + /** + * 时区 + */ + private TimeZone timeZone; + + /** + * 第一周最少天数 + */ + private int minimalDaysInFirstWeek; + + /** + * 转换时间戳为 DateTime + * + * @param timeMillis 时间戳，毫秒数 + * @return DateTime + * @since 4.6.3 + */ + public static DateTime of(long timeMillis) { + return new DateTime(timeMillis); + } + + /** + * 转换JDK date为 DateTime + * + * @param date JDK Date + * @return DateTime + */ + public static DateTime of(Date date) { + if (date instanceof DateTime) { + return (DateTime) date; + } + return new DateTime(date); + } + + /** + * 转换 {@link Calendar} 为 DateTime + * + * @param calendar {@link Calendar} + * @return DateTime + */ + public static DateTime of(Calendar calendar) { + return new DateTime(calendar); + } + + /** + * 构造 + * + * @param dateStr Date字符串 + * @param format 格式 + * @return this + * @see DatePattern + */ + public static DateTime of(String dateStr, String format) { + return new DateTime(dateStr, format); + } + + /** + * 现在的时间 + * + * @return 现在的时间 + */ + public static DateTime now() { + return new DateTime(); + } + + // -------------------------------------------------------------------- Constructor start + + /** + * 当前时间 + */ + public DateTime() { + this(TimeZone.getDefault()); + } + + /** + * 当前时间 + * + * @param timeZone 时区 + * @since 4.1.2 + */ + public DateTime(TimeZone timeZone) { + this(System.currentTimeMillis(), timeZone); + } + + /** + * 给定日期的构造 + * + * @param date 日期 + */ + public DateTime(Date date) { + this( + date,// + (date instanceof DateTime) ? ((DateTime) date).timeZone : TimeZone.getDefault() + ); + } + + /** + * 给定日期的构造 + * + * @param date 日期 + * @param timeZone 时区 + * @since 4.1.2 + */ + public DateTime(Date date, TimeZone timeZone) { + this(ObjectUtil.defaultIfNull(date, new Date()).getTime(), timeZone); + } + + /** + * 给定日期的构造 + * + * @param calendar {@link Calendar} + */ + public DateTime(Calendar calendar) { + this(calendar.getTime(), calendar.getTimeZone()); + this.setFirstDayOfWeek(Week.of(calendar.getFirstDayOfWeek())); + } + + /** + * 给定日期Instant的构造 + * + * @param instant {@link Instant} 对象 + * @since 5.0.0 + */ + public DateTime(Instant instant) { + this(instant.toEpochMilli()); + } + + /** + * 给定日期Instant的构造 + * + * @param instant {@link Instant} 对象 + * @param zoneId 时区ID + * @since 5.0.5 + */ + public DateTime(Instant instant, ZoneId zoneId) { + this(instant.toEpochMilli(), ZoneUtil.toTimeZone(zoneId)); + } + + /** + * 给定日期TemporalAccessor的构造 + * + * @param temporalAccessor {@link TemporalAccessor} 对象 + * @since 5.0.0 + */ + public DateTime(TemporalAccessor temporalAccessor) { + this(TemporalAccessorUtil.toInstant(temporalAccessor)); + } + + /** + * 给定日期ZonedDateTime的构造 + * + * @param zonedDateTime {@link ZonedDateTime} 对象 + * @since 5.0.5 + */ + public DateTime(ZonedDateTime zonedDateTime) { + this(zonedDateTime.toInstant(), zonedDateTime.getZone()); + } + + /** + * 给定日期毫秒数的构造 + * + * @param timeMillis 日期毫秒数 + * @since 4.1.2 + */ + public DateTime(long timeMillis) { + this(timeMillis, TimeZone.getDefault()); + } + + /** + * 给定日期毫秒数的构造 + * + * @param timeMillis 日期毫秒数 + * @param timeZone 时区 + * @since 4.1.2 + */ + public DateTime(long timeMillis, TimeZone timeZone) { + super(timeMillis); + this.timeZone = ObjectUtil.defaultIfNull(timeZone, TimeZone::getDefault); + } + + /** + * 构造格式：
+ *
    + *
  1. yyyy-MM-dd HH:mm:ss
    2. + *
  2. yyyy/MM/dd HH:mm:ss
    3. + *
  3. yyyy.MM.dd HH:mm:ss
    4. + *
  4. yyyy年MM月dd日 HH时mm分ss秒
    5. + *
  5. yyyy-MM-dd
    6. + *
  6. yyyy/MM/dd
    7. + *
  7. yyyy.MM.dd
    8. + *
  8. HH:mm:ss
    9. + *
  9. HH时mm分ss秒
    10. + *
  10. yyyy-MM-dd HH:mm
    11. + *
  11. yyyy-MM-dd HH:mm:ss.SSS
    12. + *
  12. yyyyMMddHHmmss
    13. + *
  13. yyyyMMddHHmmssSSS
    14. + *
  14. yyyyMMdd
    15. + *
  15. EEE, dd MMM yyyy HH:mm:ss z
    16. + *
  16. EEE MMM dd HH:mm:ss zzz yyyy
    17. + *
  17. yyyy-MM-dd'T'HH:mm:ss'Z'
    18. + *
  18. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
    19. + *
  19. yyyy-MM-dd'T'HH:mm:ssZ
    20. + *
  20. yyyy-MM-dd'T'HH:mm:ss.SSSZ
    21. + *
+ * + * @param dateStr Date字符串 + * @since 5.6.2 + */ + public DateTime(CharSequence dateStr) { + this(DateUtil.parse(dateStr)); + } + + /** + * 构造 + * + * @param dateStr Date字符串 + * @param format 格式 + * @see DatePattern + */ + public DateTime(CharSequence dateStr, String format) { + this(GlobalCustomFormat.isCustomFormat(format) + ? GlobalCustomFormat.parse(dateStr, format) + : parse(dateStr, DateUtil.newSimpleFormat(format))); + } + + /** + * 构造 + * + * @param dateStr Date字符串 + * @param dateFormat 格式化器 {@link SimpleDateFormat} + * @see DatePattern + */ + public DateTime(CharSequence dateStr, DateFormat dateFormat) { + this(parse(dateStr, dateFormat), dateFormat.getTimeZone()); + } + + /** + * 构建DateTime对象 + * + * @param dateStr Date字符串 + * @param formatter 格式化器,{@link DateTimeFormatter} + * @since 5.0.0 + */ + public DateTime(CharSequence dateStr, DateTimeFormatter formatter) { + this(TemporalAccessorUtil.toInstant(formatter.parse(dateStr)), formatter.getZone()); + } + + /** + * 构造 + * + * @param dateStr Date字符串 + * @param dateParser 格式化器 {@link DateParser}，可以使用 {@link FastDateFormat} + * @see DatePattern + */ + public DateTime(CharSequence dateStr, DateParser dateParser) { + this(dateStr, dateParser, SystemPropsUtil.getBoolean(SystemPropsUtil.HUTOOL_DATE_LENIENT, true)); + } + + /** + * 构造 + * + * @param dateStr Date字符串 + * @param dateParser 格式化器 {@link DateParser}，可以使用 {@link FastDateFormat} + * @param lenient 是否宽容模式 + * @see DatePattern + */ + public DateTime(CharSequence dateStr, DateParser dateParser, boolean lenient) { + this(parse(dateStr, dateParser, lenient)); + } + + // -------------------------------------------------------------------- Constructor end + + // -------------------------------------------------------------------- offset start + + /** + * 调整日期和时间
+ * 如果此对象为可变对象，返回自身，否则返回新对象，设置是否可变对象见{@link #setMutable(boolean)} + * + * @param datePart 调整的部分 {@link DateField} + * @param offset 偏移量，正数为向后偏移，负数为向前偏移 + * @return 如果此对象为可变对象，返回自身，否则返回新对象 + */ + public DateTime offset(DateField datePart, int offset) { + if (DateField.ERA == datePart) { + throw new IllegalArgumentException("ERA is not support offset!"); + } + + final Calendar cal = toCalendar(); + //noinspection MagicConstant + cal.add(datePart.getValue(), offset); + + DateTime dt = mutable ? this : ObjectUtil.clone(this); + return dt.setTimeInternal(cal.getTimeInMillis()); + } + + /** + * 调整日期和时间
+ * 返回调整后的新DateTime，不影响原对象 + * + * @param datePart 调整的部分 {@link DateField} + * @param offset 偏移量，正数为向后偏移，负数为向前偏移 + * @return 如果此对象为可变对象，返回自身，否则返回新对象 + * @since 3.0.9 + */ + public DateTime offsetNew(DateField datePart, int offset) { + final Calendar cal = toCalendar(); + //noinspection MagicConstant + cal.add(datePart.getValue(), offset); + + return ObjectUtil.clone(this).setTimeInternal(cal.getTimeInMillis()); + } + // -------------------------------------------------------------------- offset end + + // -------------------------------------------------------------------- Part of Date start + + /** + * 获得日期的某个部分
+ * 例如获得年的部分，则使用 getField(DatePart.YEAR) + * + * @param field 表示日期的哪个部分的枚举 {@link DateField} + * @return 某个部分的值 + */ + public int getField(DateField field) { + return getField(field.getValue()); + } + + /** + * 获得日期的某个部分
+ * 例如获得年的部分，则使用 getField(Calendar.YEAR) + * + * @param field 表示日期的哪个部分的int值 {@link Calendar} + * @return 某个部分的值 + */ + public int getField(int field) { + return toCalendar().get(field); + } + + /** + * 设置日期的某个部分
+ * 如果此对象为可变对象，返回自身，否则返回新对象，设置是否可变对象见{@link #setMutable(boolean)} + * + * @param field 表示日期的哪个部分的枚举 {@link DateField} + * @param value 值 + * @return this + */ + public DateTime setField(DateField field, int value) { + return setField(field.getValue(), value); + } + + /** + * 设置日期的某个部分
+ * 如果此对象为可变对象，返回自身，否则返回新对象，设置是否可变对象见{@link #setMutable(boolean)} + * + * @param field 表示日期的哪个部分的int值 {@link Calendar} + * @param value 值 + * @return this + */ + public DateTime setField(int field, int value) { + final Calendar calendar = toCalendar(); + calendar.set(field, value); + + DateTime dt = this; + if (false == mutable) { + dt = ObjectUtil.clone(this); + } + return dt.setTimeInternal(calendar.getTimeInMillis()); + } + + @Override + public void setTime(long time) { + if (mutable) { + super.setTime(time); + } else { + throw new DateException("This is not a mutable object !"); + } + } + + /** + * 获得年的部分 + * + * @return 年的部分 + */ + public int year() { + return getField(DateField.YEAR); + } + + /** + * 获得当前日期所属季度，从1开始计数
+ * + * @return 第几个季度 {@link Quarter} + */ + public int quarter() { + return month() / 3 + 1; + } + + /** + * 获得当前日期所属季度
+ * + * @return 第几个季度 {@link Quarter} + */ + public Quarter quarterEnum() { + return Quarter.of(quarter()); + } + + /** + * 获得月份，从0开始计数 + * + * @return 月份 + */ + public int month() { + return getField(DateField.MONTH); + } + + /** + * 获取月，从1开始计数 + * + * @return 月份，1表示一月 + * @since 5.4.1 + */ + public int monthBaseOne() { + return month() + 1; + } + + /** + * 获得月份，从1开始计数
+ * 由于{@link Calendar} 中的月份按照0开始计数，导致某些需求容易误解，因此如果想用1表示一月，2表示二月则调用此方法 + * + * @return 月份 + */ + public int monthStartFromOne() { + return month() + 1; + } + + /** + * 获得月份 + * + * @return {@link Month} + */ + public Month monthEnum() { + return Month.of(month()); + } + + /** + * 获得指定日期是所在年份的第几周
+ * 此方法返回值与一周的第一天有关，比如：
+ * 2016年1月3日为周日，如果一周的第一天为周日，那这天是第二周（返回2）
+ * 如果一周的第一天为周一，那这天是第一周（返回1）
+ * 跨年的那个星期得到的结果总是1 + * + * @return 周 + * @see #setFirstDayOfWeek(Week) + */ + public int weekOfYear() { + return getField(DateField.WEEK_OF_YEAR); + } + + /** + * 获得指定日期是所在月份的第几周
+ * 此方法返回值与一周的第一天有关，比如：
+ * 2016年1月3日为周日，如果一周的第一天为周日，那这天是第二周（返回2）
+ * 如果一周的第一天为周一，那这天是第一周（返回1） + * + * @return 周 + * @see #setFirstDayOfWeek(Week) + */ + public int weekOfMonth() { + return getField(DateField.WEEK_OF_MONTH); + } + + /** + * 获得指定日期是这个日期所在月份的第几天，从1开始 + * + * @return 天，1表示第一天 + */ + public int dayOfMonth() { + return getField(DateField.DAY_OF_MONTH); + } + + /** + * 获得指定日期是这个日期所在年份的第几天，从1开始 + * + * @return 天，1表示第一天 + * @since 5.3.6 + */ + public int dayOfYear() { + return getField(DateField.DAY_OF_YEAR); + } + + /** + * 获得指定日期是星期几，1表示周日，2表示周一 + * + * @return 星期几 + */ + public int dayOfWeek() { + return getField(DateField.DAY_OF_WEEK); + } + + /** + * 获得天所在的周是这个月的第几周 + * + * @return 天 + */ + public int dayOfWeekInMonth() { + return getField(DateField.DAY_OF_WEEK_IN_MONTH); + } + + /** + * 获得指定日期是星期几 + * + * @return {@link Week} + */ + public Week dayOfWeekEnum() { + return Week.of(dayOfWeek()); + } + + /** + * 获得指定日期的小时数部分
+ * + * @param is24HourClock 是否24小时制 + * @return 小时数 + */ + public int hour(boolean is24HourClock) { + return getField(is24HourClock ? DateField.HOUR_OF_DAY : DateField.HOUR); + } + + /** + * 获得指定日期的分钟数部分
+ * 例如：10:04:15.250 =》 4 + * + * @return 分钟数 + */ + public int minute() { + return getField(DateField.MINUTE); + } + + /** + * 获得指定日期的秒数部分
+ * + * @return 秒数 + */ + public int second() { + return getField(DateField.SECOND); + } + + /** + * 获得指定日期的毫秒数部分
+ * + * @return 毫秒数 + */ + public int millisecond() { + return getField(DateField.MILLISECOND); + } + + /** + * 是否为上午 + * + * @return 是否为上午 + */ + public boolean isAM() { + return Calendar.AM == getField(DateField.AM_PM); + } + + /** + * 是否为下午 + * + * @return 是否为下午 + */ + public boolean isPM() { + return Calendar.PM == getField(DateField.AM_PM); + } + + /** + * 是否为周末，周末指周六或者周日 + * + * @return 是否为周末，周末指周六或者周日 + * @since 4.1.14 + */ + public boolean isWeekend() { + final int dayOfWeek = dayOfWeek(); + return Calendar.SATURDAY == dayOfWeek || Calendar.SUNDAY == dayOfWeek; + } + // -------------------------------------------------------------------- Part of Date end + + /** + * 是否闰年 + * + * @return 是否闰年 + * @see DateUtil#isLeapYear(int) + */ + public boolean isLeapYear() { + return DateUtil.isLeapYear(year()); + } + + /** + * 转换为Calendar, 默认 {@link Locale} + * + * @return {@link Calendar} + */ + public Calendar toCalendar() { + return toCalendar(Locale.getDefault(Locale.Category.FORMAT)); + } + + /** + * 转换为Calendar + * + * @param locale 地域 {@link Locale} + * @return {@link Calendar} + */ + public Calendar toCalendar(Locale locale) { + return toCalendar(this.timeZone, locale); + } + + /** + * 转换为Calendar + * + * @param zone 时区 {@link TimeZone} + * @return {@link Calendar} + */ + public Calendar toCalendar(TimeZone zone) { + return toCalendar(zone, Locale.getDefault(Locale.Category.FORMAT)); + } + + /** + * 转换为Calendar + * + * @param zone 时区 {@link TimeZone} + * @param locale 地域 {@link Locale} + * @return {@link Calendar} + */ + public Calendar toCalendar(TimeZone zone, Locale locale) { + if (null == locale) { + locale = Locale.getDefault(Locale.Category.FORMAT); + } + final Calendar cal = (null != zone) ? Calendar.getInstance(zone, locale) : Calendar.getInstance(locale); + //noinspection MagicConstant + cal.setFirstDayOfWeek(firstDayOfWeek.getValue()); + // issue#1988@Github + if (minimalDaysInFirstWeek > 0) { + cal.setMinimalDaysInFirstWeek(minimalDaysInFirstWeek); + } + cal.setTime(this); + return cal; + } + + /** + * 转换为 {@link Date}
+ * 考虑到很多框架（例如Hibernate）的兼容性，提供此方法返回JDK原生的Date对象 + * + * @return {@link Date} + * @since 3.2.2 + */ + public Date toJdkDate() { + return new Date(this.getTime()); + } + + /** + * 转为{@link Timestamp} + * + * @return {@link Timestamp} + */ + public Timestamp toTimestamp() { + return new Timestamp(this.getTime()); + } + + /** + * 转为 {@link java.sql.Date} + * + * @return {@link java.sql.Date} + */ + public java.sql.Date toSqlDate() { + return new java.sql.Date(getTime()); + } + + /** + * 转换为 {@link LocalDateTime} + * + * @return {@link LocalDateTime} + * @since 5.7.16 + */ + public LocalDateTime toLocalDateTime() { + return LocalDateTimeUtil.of(this); + } + + /** + * 计算相差时长 + * + * @param date 对比的日期 + * @return {@link DateBetween} + */ + public DateBetween between(Date date) { + return new DateBetween(this, date); + } + + /** + * 计算相差时长 + * + * @param date 对比的日期 + * @param unit 单位 {@link DateUnit} + * @return 相差时长 + */ + public long between(Date date, DateUnit unit) { + return new DateBetween(this, date).between(unit); + } + + /** + * 计算相差时长 + * + * @param date 对比的日期 + * @param unit 单位 {@link DateUnit} + * @param formatLevel 格式化级别 + * @return 相差时长 + */ + public String between(Date date, DateUnit unit, BetweenFormatter.Level formatLevel) { + return new DateBetween(this, date).toString(unit, formatLevel); + } + + /** + * 当前日期是否在日期指定范围内
+ * 起始日期和结束日期可以互换 + * + * @param beginDate 起始日期（包含） + * @param endDate 结束日期（包含） + * @return 是否在范围内 + * @since 3.0.8 + */ + public boolean isIn(Date beginDate, Date endDate) { + long beginMills = beginDate.getTime(); + long endMills = endDate.getTime(); + long thisMills = this.getTime(); + + return thisMills >= Math.min(beginMills, endMills) && thisMills <= Math.max(beginMills, endMills); + } + + /** + * 是否在给定日期之前 + * + * @param date 日期 + * @return 是否在给定日期之前 + * @since 4.1.3 + */ + public boolean isBefore(Date date) { + if (null == date) { + throw new NullPointerException("Date to compare is null !"); + } + return compareTo(date) < 0; + } + + /** + * 是否在给定日期之前或与给定日期相等 + * + * @param date 日期 + * @return 是否在给定日期之前或与给定日期相等 + * @since 3.0.9 + */ + public boolean isBeforeOrEquals(Date date) { + if (null == date) { + throw new NullPointerException("Date to compare is null !"); + } + return compareTo(date) <= 0; + } + + /** + * 是否在给定日期之后 + * + * @param date 日期 + * @return 是否在给定日期之后 + * @since 4.1.3 + */ + public boolean isAfter(Date date) { + if (null == date) { + throw new NullPointerException("Date to compare is null !"); + } + return compareTo(date) > 0; + } + + /** + * 是否在给定日期之后或与给定日期相等 + * + * @param date 日期 + * @return 是否在给定日期之后或与给定日期相等 + * @since 3.0.9 + */ + public boolean isAfterOrEquals(Date date) { + if (null == date) { + throw new NullPointerException("Date to compare is null !"); + } + return compareTo(date) >= 0; + } + + /** + * 对象是否可变
+ * 如果为不可变对象，以下方法将返回新方法： + *
    + *
  • {@link DateTime#offset(DateField, int)}
    • + *
  • {@link DateTime#setField(DateField, int)}
    • + *
  • {@link DateTime#setField(int, int)}
    • + *
+ * 如果为不可变对象，{@link DateTime#setTime(long)}将抛出异常 + * + * @return 对象是否可变 + */ + public boolean isMutable() { + return mutable; + } + + /** + * 设置对象是否可变 如果为不可变对象，以下方法将返回新方法： + *
    + *
  • {@link DateTime#offset(DateField, int)}
    • + *
  • {@link DateTime#setField(DateField, int)}
    • + *
  • {@link DateTime#setField(int, int)}
    • + *
+ * 如果为不可变对象，{@link DateTime#setTime(long)}将抛出异常 + * + * @param mutable 是否可变 + * @return this + */ + public DateTime setMutable(boolean mutable) { + this.mutable = mutable; + return this; + } + + /** + * 获得一周的第一天，默认为周一 + * + * @return 一周的第一天 + */ + public Week getFirstDayOfWeek() { + return firstDayOfWeek; + } + + /** + * 设置一周的第一天
+ * JDK的Calendar中默认一周的第一天是周日，Hutool中将此默认值设置为周一
+ * 设置一周的第一天主要影响{@link #weekOfMonth()}和{@link #weekOfYear()} 两个方法 + * + * @param firstDayOfWeek 一周的第一天 + * @return this + * @see #weekOfMonth() + * @see #weekOfYear() + */ + public DateTime setFirstDayOfWeek(Week firstDayOfWeek) { + this.firstDayOfWeek = firstDayOfWeek; + return this; + } + + /** + * 获取时区 + * + * @return 时区 + * @since 5.0.5 + */ + public TimeZone getTimeZone() { + return this.timeZone; + } + + /** + * 获取时区ID + * + * @return 时区ID + * @since 5.0.5 + */ + public ZoneId getZoneId() { + return this.timeZone.toZoneId(); + } + + /** + * 设置时区 + * + * @param timeZone 时区 + * @return this + * @since 4.1.2 + */ + public DateTime setTimeZone(TimeZone timeZone) { + this.timeZone = ObjectUtil.defaultIfNull(timeZone, TimeZone::getDefault); + return this; + } + + /** + * 设置第一周最少天数 + * + * @param minimalDaysInFirstWeek 第一周最少天数 + * @return this + * @since 5.7.17 + */ + public DateTime setMinimalDaysInFirstWeek(int minimalDaysInFirstWeek) { + this.minimalDaysInFirstWeek = minimalDaysInFirstWeek; + return this; + } + + /** + * 是否为本月最后一天 + * @return 是否为本月最后一天 + * @since 5.8.9 + */ + public boolean isLastDayOfMonth(){ + return dayOfMonth() == getLastDayOfMonth(); + } + + /** + * 获得本月的最后一天 + * @return 天 + * @since 5.8.9 + */ + public int getLastDayOfMonth(){ + return monthEnum().getLastDay(isLeapYear()); + } + + // -------------------------------------------------------------------- toString start + + /** + * 转为字符串，如果时区被设置，会转换为其时区对应的时间，否则转换为当前地点对应的时区
+ * 可以调用{@link DateTime#setUseJdkToStringStyle(boolean)} 方法自定义默认的风格
+ * 如果{@link #useJdkToStringStyle}为{@code true}，返回"EEE MMM dd HH:mm:ss zzz yyyy"格式，
+ * 如果为{@code false}，则返回"yyyy-MM-dd HH:mm:ss" + * + * @return 格式字符串 + */ + @Override + public String toString() { + if(useJdkToStringStyle){ + return super.toString(); + } + return toString(this.timeZone); + } + + /** + * 转为"yyyy-MM-dd HH:mm:ss" 格式字符串
+ * 时区使用当前地区的默认时区 + * + * @return "yyyy-MM-dd HH:mm:ss" 格式字符串 + * @since 4.1.14 + */ + public String toStringDefaultTimeZone() { + return toString(TimeZone.getDefault()); + } + + /** + * 转为"yyyy-MM-dd HH:mm:ss" 格式字符串
+ * 如果时区不为{@code null}，会转换为其时区对应的时间，否则转换为当前时间对应的时区 + * + * @param timeZone 时区 + * @return "yyyy-MM-dd HH:mm:ss" 格式字符串 + * @since 4.1.14 + */ + public String toString(TimeZone timeZone) { + if (null != timeZone) { + return toString(DateUtil.newSimpleFormat(DatePattern.NORM_DATETIME_PATTERN, null, timeZone)); + } + return toString(DatePattern.NORM_DATETIME_FORMAT); + } + + /** + * 转为"yyyy-MM-dd" 格式字符串 + * + * @return "yyyy-MM-dd" 格式字符串 + * @since 4.0.0 + */ + public String toDateStr() { + if (null != this.timeZone) { + return toString(DateUtil.newSimpleFormat(DatePattern.NORM_DATE_PATTERN, null, timeZone)); + } + return toString(DatePattern.NORM_DATE_FORMAT); + } + + /** + * 转为"HH:mm:ss" 格式字符串 + * + * @return "HH:mm:ss" 格式字符串 + * @since 4.1.4 + */ + public String toTimeStr() { + if (null != this.timeZone) { + return toString(DateUtil.newSimpleFormat(DatePattern.NORM_TIME_PATTERN, null, timeZone)); + } + return toString(DatePattern.NORM_TIME_FORMAT); + } + + /** + * 转为字符串 + * + * @param format 日期格式，常用格式见： {@link DatePattern} + * @return String + */ + public String toString(String format) { + if (null != this.timeZone) { + return toString(DateUtil.newSimpleFormat(format, null, timeZone)); + } + return toString(FastDateFormat.getInstance(format)); + } + + /** + * 转为字符串 + * + * @param format {@link DatePrinter} 或 {@link FastDateFormat} + * @return String + */ + public String toString(DatePrinter format) { + return format.format(this); + } + + /** + * 转为字符串 + * + * @param format {@link SimpleDateFormat} + * @return String + */ + public String toString(DateFormat format) { + return format.format(this); + } + + /** + * @return 输出精确到毫秒的标准日期形式 + */ + public String toMsStr() { + return toString(DatePattern.NORM_DATETIME_MS_FORMAT); + } + // -------------------------------------------------------------------- toString end + + /** + * 转换字符串为Date + * + * @param dateStr 日期字符串 + * @param dateFormat {@link SimpleDateFormat} + * @return {@link Date} + */ + private static Date parse(CharSequence dateStr, DateFormat dateFormat) { + Assert.notBlank(dateStr, "Date String must be not blank !"); + try { + return dateFormat.parse(dateStr.toString()); + } catch (Exception e) { + String pattern; + if (dateFormat instanceof SimpleDateFormat) { + pattern = ((SimpleDateFormat) dateFormat).toPattern(); + } else { + pattern = dateFormat.toString(); + } + throw new DateException(StrUtil.format("Parse [{}] with format [{}] error!", dateStr, pattern), e); + } + } + + /** + * 转换字符串为Date + * + * @param dateStr 日期字符串 + * @param parser {@link FastDateFormat} + * @param lenient 是否宽容模式 + * @return {@link Calendar} + */ + private static Calendar parse(CharSequence dateStr, DateParser parser, boolean lenient) { + Assert.notNull(parser, "Parser or DateFromat must be not null !"); + Assert.notBlank(dateStr, "Date String must be not blank !"); + + final Calendar calendar = CalendarUtil.parse(dateStr, lenient, parser); + if (null == calendar) { + throw new DateException("Parse [{}] with format [{}] error!", dateStr, parser.getPattern()); + } + + //noinspection MagicConstant + calendar.setFirstDayOfWeek(Week.MONDAY.getValue()); + return calendar; + } + + /** + * 设置日期时间 + * + * @param time 日期时间毫秒 + * @return this + */ + private DateTime setTimeInternal(long time) { + super.setTime(time); + return this; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateUnit.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateUnit.java new file mode 100644 index 0000000..cd8c3a8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateUnit.java @@ -0,0 +1,108 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import java.time.temporal.ChronoUnit; + +/** + * 日期时间单位，每个单位都是以毫秒为基数 + * + * @author Looly + */ +public enum DateUnit { + /** + * 一毫秒 + */ + MS(1), + /** + * 一秒的毫秒数 + */ + SECOND(1000), + /** + * 一分钟的毫秒数 + */ + MINUTE(SECOND.getMillis() * 60), + /** + * 一小时的毫秒数 + */ + HOUR(MINUTE.getMillis() * 60), + /** + * 一天的毫秒数 + */ + DAY(HOUR.getMillis() * 24), + /** + * 一周的毫秒数 + */ + WEEK(DAY.getMillis() * 7); + + private final long millis; + + DateUnit(long millis) { + this.millis = millis; + } + + /** + * @return 单位对应的毫秒数 + */ + public long getMillis() { + return this.millis; + } + + /** + * 单位兼容转换，将DateUnit转换为对应的{@link ChronoUnit} + * + * @return {@link ChronoUnit} + * @since 5.4.5 + */ + public ChronoUnit toChronoUnit() { + return DateUnit.toChronoUnit(this); + } + + /** + * 单位兼容转换，将{@link ChronoUnit}转换为对应的DateUnit + * + * @param unit {@link ChronoUnit} + * @return DateUnit，null表示不支持此单位 + * @since 5.4.5 + */ + public static DateUnit of(ChronoUnit unit) { + switch (unit) { + case MICROS: + return DateUnit.MS; + case SECONDS: + return DateUnit.SECOND; + case MINUTES: + return DateUnit.MINUTE; + case HOURS: + return DateUnit.HOUR; + case DAYS: + return DateUnit.DAY; + case WEEKS: + return DateUnit.WEEK; + } + return null; + } + + /** + * 单位兼容转换，将DateUnit转换为对应的{@link ChronoUnit} + * + * @param unit DateUnit + * @return {@link ChronoUnit} + * @since 5.4.5 + */ + public static ChronoUnit toChronoUnit(DateUnit unit) { + switch (unit) { + case MS: + return ChronoUnit.MICROS; + case SECOND: + return ChronoUnit.SECONDS; + case MINUTE: + return ChronoUnit.MINUTES; + case HOUR: + return ChronoUnit.HOURS; + case DAY: + return ChronoUnit.DAYS; + case WEEK: + return ChronoUnit.WEEKS; + } + return null; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateUtil.java new file mode 100755 index 0000000..c7dfae4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/DateUtil.java @@ -0,0 +1,2374 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.comparator.CompareUtil; +import aiyh.utils.tool.cn.hutool.core.date.format.DateParser; +import aiyh.utils.tool.cn.hutool.core.date.format.DatePrinter; +import aiyh.utils.tool.cn.hutool.core.date.format.FastDateFormat; +import aiyh.utils.tool.cn.hutool.core.date.format.GlobalCustomFormat; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.PatternPool; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.text.DateFormat; +import java.text.SimpleDateFormat; +import java.time.Instant; +import java.time.LocalDateTime; +import java.time.Year; +import java.time.ZoneId; +import java.time.format.DateTimeFormatter; +import java.time.temporal.TemporalAccessor; +import java.util.*; +import java.util.concurrent.TimeUnit; +import java.util.function.Consumer; +import java.util.function.Function; +import java.util.stream.Collectors; + +/** + * 时间工具类 + * + * @author xiaoleilu + * @see LocalDateTimeUtil java8日志工具类 + * @see DatePattern 日期常用格式工具类 + */ +public class DateUtil extends CalendarUtil { + + /** + * java.util.Date EEE MMM zzz 缩写数组 + */ + private final static String[] wtb = { // + "sun", "mon", "tue", "wed", "thu", "fri", "sat", // 星期 + "jan", "feb", "mar", "apr", "may", "jun", "jul", "aug", "sep", "oct", "nov", "dec", // 月份 + "gmt", "ut", "utc", "est", "edt", "cst", "cdt", "mst", "mdt", "pst", "pdt"// 时间标准 + }; + + /** + * 当前时间，转换为{@link DateTime}对象 + * + * @return 当前时间 + */ + public static DateTime date() { + return new DateTime(); + } + + /** + * 当前时间，转换为{@link DateTime}对象，忽略毫秒部分 + * + * @return 当前时间 + * @since 4.6.2 + */ + public static DateTime dateSecond() { + return beginOfSecond(date()); + } + + /** + * {@link Date}类型时间转为{@link DateTime}
+ * 如果date本身为DateTime对象，则返回强转后的对象，否则新建一个DateTime对象 + * + * @param date Long类型Date（Unix时间戳），如果传入{@code null}，返回{@code null} + * @return 时间对象 + * @since 3.0.7 + */ + public static DateTime date(Date date) { + if (date == null) { + return null; + } + if (date instanceof DateTime) { + return (DateTime) date; + } + return dateNew(date); + } + + /** + * 根据已有{@link Date} 产生新的{@link DateTime}对象 + * + * @param date Date对象，如果传入{@code null}，返回{@code null} + * @return {@link DateTime}对象 + * @since 4.3.1 + */ + public static DateTime dateNew(Date date) { + if (date == null) { + return null; + } + return new DateTime(date); + } + + /** + * Long类型时间转为{@link DateTime}
+ * 只支持毫秒级别时间戳，如果需要秒级别时间戳，请自行×1000 + * + * @param date Long类型Date（Unix时间戳） + * @return 时间对象 + */ + public static DateTime date(long date) { + return new DateTime(date); + } + + /** + * {@link Calendar}类型时间转为{@link DateTime}
+ * 始终根据已有{@link Calendar} 产生新的{@link DateTime}对象 + * + * @param calendar {@link Calendar}，如果传入{@code null}，返回{@code null} + * @return 时间对象 + */ + public static DateTime date(Calendar calendar) { + if (calendar == null) { + return null; + } + return new DateTime(calendar); + } + + /** + * {@link TemporalAccessor}类型时间转为{@link DateTime}
+ * 始终根据已有{@link TemporalAccessor} 产生新的{@link DateTime}对象 + * + * @param temporalAccessor {@link TemporalAccessor},常用子类： {@link LocalDateTime}、 LocalDate，如果传入{@code null}，返回{@code null} + * @return 时间对象 + * @since 5.0.0 + */ + public static DateTime date(TemporalAccessor temporalAccessor) { + if (temporalAccessor == null) { + return null; + } + return new DateTime(temporalAccessor); + } + + /** + * 当前时间的时间戳 + * + * @return 时间 + */ + public static long current() { + return System.currentTimeMillis(); + } + + /** + * 当前时间的时间戳（秒） + * + * @return 当前时间秒数 + * @since 4.0.0 + */ + public static long currentSeconds() { + return System.currentTimeMillis() / 1000; + } + + /** + * 当前时间，格式 yyyy-MM-dd HH:mm:ss + * + * @return 当前时间的标准形式字符串 + */ + public static String now() { + return formatDateTime(new DateTime()); + } + + /** + * 当前日期，格式 yyyy-MM-dd + * + * @return 当前日期的标准形式字符串 + */ + public static String today() { + return formatDate(new DateTime()); + } + + // -------------------------------------------------------------- Part of Date start + + /** + * 获得年的部分 + * + * @param date 日期 + * @return 年的部分 + */ + public static int year(Date date) { + return DateTime.of(date).year(); + } + + /** + * 获得指定日期所属季度，从1开始计数 + * + * @param date 日期 + * @return 第几个季度 + * @since 4.1.0 + */ + public static int quarter(Date date) { + return DateTime.of(date).quarter(); + } + + /** + * 获得指定日期所属季度 + * + * @param date 日期 + * @return 第几个季度枚举 + * @since 4.1.0 + */ + public static Quarter quarterEnum(Date date) { + return DateTime.of(date).quarterEnum(); + } + + /** + * 获得月份，从0开始计数 + * + * @param date 日期 + * @return 月份，从0开始计数 + */ + public static int month(Date date) { + return DateTime.of(date).month(); + } + + /** + * 获得月份 + * + * @param date 日期 + * @return {@link Month} + */ + public static Month monthEnum(Date date) { + return DateTime.of(date).monthEnum(); + } + + /** + * 获得指定日期是所在年份的第几周
+ * 此方法返回值与一周的第一天有关，比如：
+ * 2016年1月3日为周日，如果一周的第一天为周日，那这天是第二周（返回2）
+ * 如果一周的第一天为周一，那这天是第一周（返回1）
+ * 跨年的那个星期得到的结果总是1 + * + * @param date 日期 + * @return 周 + * @see DateTime#setFirstDayOfWeek(Week) + */ + public static int weekOfYear(Date date) { + return DateTime.of(date).weekOfYear(); + } + + /** + * 获得指定日期是所在月份的第几周
+ * + * @param date 日期 + * @return 周 + */ + public static int weekOfMonth(Date date) { + return DateTime.of(date).weekOfMonth(); + } + + /** + * 获得指定日期是这个日期所在月份的第几天
+ * + * @param date 日期 + * @return 天 + */ + public static int dayOfMonth(Date date) { + return DateTime.of(date).dayOfMonth(); + } + + /** + * 获得指定日期是这个日期所在年的第几天 + * + * @param date 日期 + * @return 天 + * @since 5.3.6 + */ + public static int dayOfYear(Date date) { + return DateTime.of(date).dayOfYear(); + } + + /** + * 获得指定日期是星期几，1表示周日，2表示周一 + * + * @param date 日期 + * @return 天 + */ + public static int dayOfWeek(Date date) { + return DateTime.of(date).dayOfWeek(); + } + + /** + * 获得指定日期是星期几 + * + * @param date 日期 + * @return {@link Week} + */ + public static Week dayOfWeekEnum(Date date) { + return DateTime.of(date).dayOfWeekEnum(); + } + + /** + * 是否为周末（周六或周日） + * + * @param date 判定的日期{@link Date} + * @return 是否为周末（周六或周日） + * @since 5.7.6 + */ + public static boolean isWeekend(Date date) { + final Week week = dayOfWeekEnum(date); + return Week.SATURDAY == week || Week.SUNDAY == week; + } + + /** + * 获得指定日期的小时数部分
+ * + * @param date 日期 + * @param is24HourClock 是否24小时制 + * @return 小时数 + */ + public static int hour(Date date, boolean is24HourClock) { + return DateTime.of(date).hour(is24HourClock); + } + + /** + * 获得指定日期的分钟数部分
+ * 例如：10:04:15.250 =》 4 + * + * @param date 日期 + * @return 分钟数 + */ + public static int minute(Date date) { + return DateTime.of(date).minute(); + } + + /** + * 获得指定日期的秒数部分
+ * + * @param date 日期 + * @return 秒数 + */ + public static int second(Date date) { + return DateTime.of(date).second(); + } + + /** + * 获得指定日期的毫秒数部分
+ * + * @param date 日期 + * @return 毫秒数 + */ + public static int millisecond(Date date) { + return DateTime.of(date).millisecond(); + } + + /** + * 是否为上午 + * + * @param date 日期 + * @return 是否为上午 + */ + public static boolean isAM(Date date) { + return DateTime.of(date).isAM(); + } + + /** + * 是否为下午 + * + * @param date 日期 + * @return 是否为下午 + */ + public static boolean isPM(Date date) { + return DateTime.of(date).isPM(); + } + + /** + * @return 今年 + */ + public static int thisYear() { + return year(date()); + } + + /** + * @return 当前月份 + */ + public static int thisMonth() { + return month(date()); + } + + /** + * @return 当前月份 {@link Month} + */ + public static Month thisMonthEnum() { + return monthEnum(date()); + } + + /** + * @return 当前日期所在年份的第几周 + */ + public static int thisWeekOfYear() { + return weekOfYear(date()); + } + + /** + * @return 当前日期所在月份的第几周 + */ + public static int thisWeekOfMonth() { + return weekOfMonth(date()); + } + + /** + * @return 当前日期是这个日期所在月份的第几天 + */ + public static int thisDayOfMonth() { + return dayOfMonth(date()); + } + + /** + * @return 当前日期是星期几 + */ + public static int thisDayOfWeek() { + return dayOfWeek(date()); + } + + /** + * @return 当前日期是星期几 {@link Week} + */ + public static Week thisDayOfWeekEnum() { + return dayOfWeekEnum(date()); + } + + /** + * @param is24HourClock 是否24小时制 + * @return 当前日期的小时数部分
+ */ + public static int thisHour(boolean is24HourClock) { + return hour(date(), is24HourClock); + } + + /** + * @return 当前日期的分钟数部分
+ */ + public static int thisMinute() { + return minute(date()); + } + + /** + * @return 当前日期的秒数部分
+ */ + public static int thisSecond() { + return second(date()); + } + + /** + * @return 当前日期的毫秒数部分
+ */ + public static int thisMillisecond() { + return millisecond(date()); + } + // -------------------------------------------------------------- Part of Date end + + /** + * 获得指定日期年份和季节
+ * 格式：[20131]表示2013年第一季度 + * + * @param date 日期 + * @return Quarter ，类似于 20132 + */ + public static String yearAndQuarter(Date date) { + return yearAndQuarter(calendar(date)); + } + + /** + * 获得指定日期区间内的年份和季节
+ * + * @param startDate 起始日期（包含） + * @param endDate 结束日期（包含） + * @return 季度列表 ，元素类似于 20132 + */ + public static LinkedHashSet yearAndQuarter(Date startDate, Date endDate) { + if (startDate == null || endDate == null) { + return new LinkedHashSet<>(0); + } + return yearAndQuarter(startDate.getTime(), endDate.getTime()); + } + // ------------------------------------ Format start ---------------------------------------------- + + /** + * 格式化日期时间
+ * 格式 yyyy-MM-dd HH:mm:ss + * + * @param localDateTime 被格式化的日期 + * @return 格式化后的字符串 + */ + public static String formatLocalDateTime(LocalDateTime localDateTime) { + return LocalDateTimeUtil.formatNormal(localDateTime); + } + + /** + * 根据特定格式格式化日期 + * + * @param localDateTime 被格式化的日期 + * @param format 日期格式，常用格式见： {@link DatePattern} + * @return 格式化后的字符串 + */ + public static String format(LocalDateTime localDateTime, String format) { + return LocalDateTimeUtil.format(localDateTime, format); + } + + /** + * 根据特定格式格式化日期 + * + * @param date 被格式化的日期 + * @param format 日期格式，常用格式见： {@link DatePattern} {@link DatePattern#NORM_DATETIME_PATTERN} + * @return 格式化后的字符串 + */ + public static String format(Date date, String format) { + if (null == date || StrUtil.isBlank(format)) { + return null; + } + + // 检查自定义格式 + if (GlobalCustomFormat.isCustomFormat(format)) { + return GlobalCustomFormat.format(date, format); + } + + TimeZone timeZone = null; + if (date instanceof DateTime) { + timeZone = ((DateTime) date).getTimeZone(); + } + return format(date, newSimpleFormat(format, null, timeZone)); + } + + /** + * 根据特定格式格式化日期 + * + * @param date 被格式化的日期 + * @param format {@link DatePrinter} 或 {@link FastDateFormat} {@link DatePattern#NORM_DATETIME_FORMAT} + * @return 格式化后的字符串 + */ + public static String format(Date date, DatePrinter format) { + if (null == format || null == date) { + return null; + } + return format.format(date); + } + + /** + * 根据特定格式格式化日期 + * + * @param date 被格式化的日期 + * @param format {@link SimpleDateFormat} + * @return 格式化后的字符串 + */ + public static String format(Date date, DateFormat format) { + if (null == format || null == date) { + return null; + } + return format.format(date); + } + + /** + * 根据特定格式格式化日期 + * + * @param date 被格式化的日期 + * @param format {@link SimpleDateFormat} {@link DatePattern#NORM_DATETIME_FORMATTER} + * @return 格式化后的字符串 + * @since 5.0.0 + */ + public static String format(Date date, DateTimeFormatter format) { + if (null == format || null == date) { + return null; + } + // java.time.temporal.UnsupportedTemporalTypeException: Unsupported field: YearOfEra + // 出现以上报错时，表示Instant时间戳没有时区信息，赋予默认时区 + return TemporalAccessorUtil.format(date.toInstant(), format); + } + + /** + * 格式化日期时间
+ * 格式 yyyy-MM-dd HH:mm:ss + * + * @param date 被格式化的日期 + * @return 格式化后的日期 + */ + public static String formatDateTime(Date date) { + if (null == date) { + return null; + } + return DatePattern.NORM_DATETIME_FORMAT.format(date); + } + + /** + * 格式化日期部分（不包括时间）
+ * 格式 yyyy-MM-dd + * + * @param date 被格式化的日期 + * @return 格式化后的字符串 + */ + public static String formatDate(Date date) { + if (null == date) { + return null; + } + return DatePattern.NORM_DATE_FORMAT.format(date); + } + + /** + * 格式化时间
+ * 格式 HH:mm:ss + * + * @param date 被格式化的日期 + * @return 格式化后的字符串 + * @since 3.0.1 + */ + public static String formatTime(Date date) { + if (null == date) { + return null; + } + return DatePattern.NORM_TIME_FORMAT.format(date); + } + + /** + * 格式化为Http的标准日期格式
+ * 标准日期格式遵循RFC 1123规范，格式类似于：Fri, 31 Dec 1999 23:59:59 GMT + * + * @param date 被格式化的日期 + * @return HTTP标准形式日期字符串 + */ + public static String formatHttpDate(Date date) { + if (null == date) { + return null; + } + return DatePattern.HTTP_DATETIME_FORMAT.format(date); + } + + /** + * 格式化为中文日期格式，如果isUppercase为false，则返回类似：2018年10月24日，否则返回二〇一八年十月二十四日 + * + * @param date 被格式化的日期 + * @param isUppercase 是否采用大写形式 + * @param withTime 是否包含时间部分 + * @return 中文日期字符串 + * @since 5.3.9 + */ + public static String formatChineseDate(Date date, boolean isUppercase, boolean withTime) { + if (null == date) { + return null; + } + + if (false == isUppercase) { + return (withTime ? DatePattern.CHINESE_DATE_TIME_FORMAT : DatePattern.CHINESE_DATE_FORMAT).format(date); + } + + return CalendarUtil.formatChineseDate(CalendarUtil.calendar(date), withTime); + } + // ------------------------------------ Format end ---------------------------------------------- + + // ------------------------------------ Parse start ---------------------------------------------- + + /** + * 构建LocalDateTime对象
+ * 格式：yyyy-MM-dd HH:mm:ss + * + * @param dateStr 时间字符串（带格式） + * @return LocalDateTime对象 + */ + public static LocalDateTime parseLocalDateTime(CharSequence dateStr) { + return parseLocalDateTime(dateStr, DatePattern.NORM_DATETIME_PATTERN); + } + + /** + * 构建LocalDateTime对象 + * + * @param dateStr 时间字符串（带格式） + * @param format 使用{@link DatePattern}定义的格式 + * @return LocalDateTime对象 + */ + public static LocalDateTime parseLocalDateTime(CharSequence dateStr, String format) { + return LocalDateTimeUtil.parse(dateStr, format); + } + + /** + * 构建DateTime对象 + * + * @param dateStr Date字符串 + * @param dateFormat 格式化器 {@link SimpleDateFormat} + * @return DateTime对象 + */ + public static DateTime parse(CharSequence dateStr, DateFormat dateFormat) { + return new DateTime(dateStr, dateFormat); + } + + /** + * 构建DateTime对象 + * + * @param dateStr Date字符串 + * @param parser 格式化器,{@link FastDateFormat} + * @return DateTime对象 + */ + public static DateTime parse(CharSequence dateStr, DateParser parser) { + return new DateTime(dateStr, parser); + } + + /** + * 构建DateTime对象 + * + * @param dateStr Date字符串 + * @param parser 格式化器,{@link FastDateFormat} + * @param lenient 是否宽容模式 + * @return DateTime对象 + * @since 5.7.14 + */ + public static DateTime parse(CharSequence dateStr, DateParser parser, boolean lenient) { + return new DateTime(dateStr, parser, lenient); + } + + /** + * 构建DateTime对象 + * + * @param dateStr Date字符串 + * @param formatter 格式化器,{@link DateTimeFormatter} + * @return DateTime对象 + * @since 5.0.0 + */ + public static DateTime parse(CharSequence dateStr, DateTimeFormatter formatter) { + return new DateTime(dateStr, formatter); + } + + /** + * 将特定格式的日期转换为Date对象 + * + * @param dateStr 特定格式的日期 + * @param format 格式，例如yyyy-MM-dd + * @return 日期对象 + */ + public static DateTime parse(CharSequence dateStr, String format) { + return new DateTime(dateStr, format); + } + + /** + * 将特定格式的日期转换为Date对象 + * + * @param dateStr 特定格式的日期 + * @param format 格式，例如yyyy-MM-dd + * @param locale 区域信息 + * @return 日期对象 + * @since 4.5.18 + */ + public static DateTime parse(CharSequence dateStr, String format, Locale locale) { + if (GlobalCustomFormat.isCustomFormat(format)) { + // 自定义格式化器忽略Locale + return new DateTime(GlobalCustomFormat.parse(dateStr, format)); + } + return new DateTime(dateStr, DateUtil.newSimpleFormat(format, locale, null)); + } + + /** + * 通过给定的日期格式解析日期时间字符串。
+ * 传入的日期格式会逐个尝试，直到解析成功，返回{@link DateTime}对象，否则抛出{@link DateException}异常。 + * + * @param str 日期时间字符串，非空 + * @param parsePatterns 需要尝试的日期时间格式数组，非空, 见SimpleDateFormat + * @return 解析后的Date + * @throws IllegalArgumentException if the date string or pattern array is null + * @throws DateException if none of the date patterns were suitable + * @since 5.3.11 + */ + public static DateTime parse(String str, String... parsePatterns) throws DateException { + return new DateTime(CalendarUtil.parseByPatterns(str, parsePatterns)); + } + + /** + * 解析日期时间字符串，格式支持： + * + * 
+	 * yyyy-MM-dd HH:mm:ss
+	 * yyyy/MM/dd HH:mm:ss
+	 * yyyy.MM.dd HH:mm:ss
+	 * yyyy年MM月dd日 HH:mm:ss
+	 *
+ * + * @param dateString 标准形式的时间字符串 + * @return 日期对象 + */ + public static DateTime parseDateTime(CharSequence dateString) { + dateString = normalize(dateString); + return parse(dateString, DatePattern.NORM_DATETIME_FORMAT); + } + + /** + * 解析日期字符串，忽略时分秒，支持的格式包括： + * 
+	 * yyyy-MM-dd
+	 * yyyy/MM/dd
+	 * yyyy.MM.dd
+	 * yyyy年MM月dd日
+	 *
+ * + * @param dateString 标准形式的日期字符串 + * @return 日期对象 + */ + public static DateTime parseDate(CharSequence dateString) { + dateString = normalize(dateString); + return parse(dateString, DatePattern.NORM_DATE_FORMAT); + } + + /** + * 解析时间，格式HH:mm:ss，日期部分默认为1970-01-01 + * + * @param timeString 标准形式的日期字符串 + * @return 日期对象 + */ + public static DateTime parseTime(CharSequence timeString) { + timeString = normalize(timeString); + return parse(timeString, DatePattern.NORM_TIME_FORMAT); + } + + /** + * 解析时间，格式HH:mm 或 HH:mm:ss，日期默认为今天 + * + * @param timeString 标准形式的日期字符串 + * @return 日期对象 + * @since 3.1.1 + */ + public static DateTime parseTimeToday(CharSequence timeString) { + timeString = StrUtil.format("{} {}", today(), timeString); + if (1 == StrUtil.count(timeString, ':')) { + // 时间格式为 HH:mm + return parse(timeString, DatePattern.NORM_DATETIME_MINUTE_PATTERN); + } else { + // 时间格式为 HH:mm:ss + return parse(timeString, DatePattern.NORM_DATETIME_FORMAT); + } + } + + /** + * 解析UTC时间，格式：
+ *
    + *
  1. yyyy-MM-dd'T'HH:mm:ss'Z'
    2. + *
  2. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
    3. + *
  3. yyyy-MM-dd'T'HH:mm:ssZ
    4. + *
  4. yyyy-MM-dd'T'HH:mm:ss.SSSZ
    5. + *
  5. yyyy-MM-dd'T'HH:mm:ss+0800
    6. + *
  6. yyyy-MM-dd'T'HH:mm:ss+08:00
    7. + *
+ * + * @param utcString UTC时间 + * @return 日期对象 + * @since 4.1.14 + */ + public static DateTime parseUTC(String utcString) { + if (utcString == null) { + return null; + } + final int length = utcString.length(); + if (StrUtil.contains(utcString, 'Z')) { + if (length == DatePattern.UTC_PATTERN.length() - 4) { + // 格式类似：2018-09-13T05:34:31Z，-4表示减去4个单引号的长度 + return parse(utcString, DatePattern.UTC_FORMAT); + } + + final int patternLength = DatePattern.UTC_MS_PATTERN.length(); + // 格式类似：2018-09-13T05:34:31.999Z，-4表示减去4个单引号的长度 + // -4 ~ -6范围表示匹配毫秒1~3位的情况 + if (length <= patternLength - 4 && length >= patternLength - 6) { + return parse(utcString, DatePattern.UTC_MS_FORMAT); + } + } else if (StrUtil.contains(utcString, '+')) { + // 去除类似2019-06-01T19:45:43 +08:00加号前的空格 + utcString = utcString.replace(" +", "+"); + final String zoneOffset = StrUtil.subAfter(utcString, '+', true); + if (StrUtil.isBlank(zoneOffset)) { + throw new DateException("Invalid format: [{}]", utcString); + } + if (false == StrUtil.contains(zoneOffset, ':')) { + // +0800转换为+08:00 + final String pre = StrUtil.subBefore(utcString, '+', true); + utcString = pre + "+" + zoneOffset.substring(0, 2) + ":" + "00"; + } + + if (StrUtil.contains(utcString, CharUtil.DOT)) { + // 带毫秒，格式类似：2018-09-13T05:34:31.999+08:00 + utcString = normalizeMillSeconds(utcString, ".", "+"); + return parse(utcString, DatePattern.UTC_MS_WITH_XXX_OFFSET_FORMAT); + } else { + // 格式类似：2018-09-13T05:34:31+08:00 + return parse(utcString, DatePattern.UTC_WITH_XXX_OFFSET_FORMAT); + } + } else if(ReUtil.contains("-\\d{2}:?00", utcString)){ + // Issue#2612，类似 2022-09-14T23:59:00-08:00 或者 2022-09-14T23:59:00-0800 + + // 去除类似2019-06-01T19:45:43 -08:00加号前的空格 + utcString = utcString.replace(" -", "-"); + if(':' != utcString.charAt(utcString.length() - 3)){ + utcString = utcString.substring(0, utcString.length() - 2) + ":00"; + } + + if (StrUtil.contains(utcString, CharUtil.DOT)) { + // 带毫秒，格式类似：2018-09-13T05:34:31.999-08:00 + utcString = normalizeMillSeconds(utcString, ".", "-"); + return new DateTime(utcString, DatePattern.UTC_MS_WITH_XXX_OFFSET_FORMAT); + } else { + // 格式类似：2018-09-13T05:34:31-08:00 + return new DateTime(utcString, DatePattern.UTC_WITH_XXX_OFFSET_FORMAT); + } + } else { + if (length == DatePattern.UTC_SIMPLE_PATTERN.length() - 2) { + // 格式类似：2018-09-13T05:34:31 + return parse(utcString, DatePattern.UTC_SIMPLE_FORMAT); + } else if (length == DatePattern.UTC_SIMPLE_PATTERN.length() - 5) { + // 格式类似：2018-09-13T05:34 + return parse(utcString + ":00", DatePattern.UTC_SIMPLE_FORMAT); + } else if (StrUtil.contains(utcString, CharUtil.DOT)) { + // 可能为： 2021-03-17T06:31:33.99 + utcString = normalizeMillSeconds(utcString, ".", null); + return parse(utcString, DatePattern.UTC_SIMPLE_MS_FORMAT); + } + } + // 没有更多匹配的时间格式 + throw new DateException("No format fit for date String [{}] !", utcString); + } + + /** + * 解析CST时间，格式：
+ *
    + *
  1. EEE MMM dd HH:mm:ss z yyyy（例如：Wed Aug 01 00:00:00 CST 2012）
    2. + *
+ * + * @param cstString UTC时间 + * @return 日期对象 + * @since 4.6.9 + */ + public static DateTime parseCST(CharSequence cstString) { + if (cstString == null) { + return null; + } + + return parse(cstString, DatePattern.JDK_DATETIME_FORMAT); + } + + /** + * 将日期字符串转换为{@link DateTime}对象，格式：
+ *
    + *
  1. yyyy-MM-dd HH:mm:ss
    2. + *
  2. yyyy/MM/dd HH:mm:ss
    3. + *
  3. yyyy.MM.dd HH:mm:ss
    4. + *
  4. yyyy年MM月dd日 HH时mm分ss秒
    5. + *
  5. yyyy-MM-dd
    6. + *
  6. yyyy/MM/dd
    7. + *
  7. yyyy.MM.dd
    8. + *
  8. HH:mm:ss
    9. + *
  9. HH时mm分ss秒
    10. + *
  10. yyyy-MM-dd HH:mm
    11. + *
  11. yyyy-MM-dd HH:mm:ss.SSS
    12. + *
  12. yyyy-MM-dd HH:mm:ss.SSSSSS
    13. + *
  13. yyyyMMddHHmmss
    14. + *
  14. yyyyMMddHHmmssSSS
    15. + *
  15. yyyyMMdd
    16. + *
  16. EEE, dd MMM yyyy HH:mm:ss z
    17. + *
  17. EEE MMM dd HH:mm:ss zzz yyyy
    18. + *
  18. yyyy-MM-dd'T'HH:mm:ss'Z'
    19. + *
  19. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
    20. + *
  20. yyyy-MM-dd'T'HH:mm:ssZ
    21. + *
  21. yyyy-MM-dd'T'HH:mm:ss.SSSZ
    22. + *
+ * + * @param dateCharSequence 日期字符串 + * @return 日期 + */ + public static DateTime parse(CharSequence dateCharSequence) { + if (StrUtil.isBlank(dateCharSequence)) { + return null; + } + String dateStr = dateCharSequence.toString(); + // 去掉两边空格并去掉中文日期中的“日”和“秒”，以规范长度 + dateStr = StrUtil.removeAll(dateStr.trim(), '日', '秒'); + int length = dateStr.length(); + + if (NumberUtil.isNumber(dateStr)) { + // 纯数字形式 + if (length == DatePattern.PURE_DATETIME_PATTERN.length()) { + return parse(dateStr, DatePattern.PURE_DATETIME_FORMAT); + } else if (length == DatePattern.PURE_DATETIME_MS_PATTERN.length()) { + return parse(dateStr, DatePattern.PURE_DATETIME_MS_FORMAT); + } else if (length == DatePattern.PURE_DATE_PATTERN.length()) { + return parse(dateStr, DatePattern.PURE_DATE_FORMAT); + } else if (length == DatePattern.PURE_TIME_PATTERN.length()) { + return parse(dateStr, DatePattern.PURE_TIME_FORMAT); + } + } else if (ReUtil.isMatch(PatternPool.TIME, dateStr)) { + // HH:mm:ss 或者 HH:mm 时间格式匹配单独解析 + return parseTimeToday(dateStr); + } else if (StrUtil.containsAnyIgnoreCase(dateStr, wtb)) { + // JDK的Date对象toString默认格式，类似于： + // Tue Jun 4 16:25:15 +0800 2019 + // Thu May 16 17:57:18 GMT+08:00 2019 + // Wed Aug 01 00:00:00 CST 2012 + return parseCST(dateStr); + } else if (StrUtil.contains(dateStr, 'T')) { + // UTC时间 + return parseUTC(dateStr); + } + + //标准日期格式（包括单个数字的日期时间） + dateStr = normalize(dateStr); + if (ReUtil.isMatch(DatePattern.REGEX_NORM, dateStr)) { + final int colonCount = StrUtil.count(dateStr, CharUtil.COLON); + switch (colonCount) { + case 0: + // yyyy-MM-dd + return parse(dateStr, DatePattern.NORM_DATE_FORMAT); + case 1: + // yyyy-MM-dd HH:mm + return parse(dateStr, DatePattern.NORM_DATETIME_MINUTE_FORMAT); + case 2: + final int indexOfDot = StrUtil.indexOf(dateStr, CharUtil.DOT); + if (indexOfDot > 0) { + final int length1 = dateStr.length(); + // yyyy-MM-dd HH:mm:ss.SSS 或者 yyyy-MM-dd HH:mm:ss.SSSSSS + if (length1 - indexOfDot > 4) { + // 类似yyyy-MM-dd HH:mm:ss.SSSSSS，采取截断操作 + dateStr = StrUtil.subPre(dateStr, indexOfDot + 4); + } + return parse(dateStr, DatePattern.NORM_DATETIME_MS_FORMAT); + } + // yyyy-MM-dd HH:mm:ss + return parse(dateStr, DatePattern.NORM_DATETIME_FORMAT); + } + } + + // 没有更多匹配的时间格式 + throw new DateException("No format fit for date String [{}] !", dateStr); + } + + // ------------------------------------ Parse end ---------------------------------------------- + + // ------------------------------------ Offset start ---------------------------------------------- + + /** + * 修改日期为某个时间字段起始时间 + * + * @param date {@link Date} + * @param dateField 保留到的时间字段，如定义为 {@link DateField#SECOND}，表示这个字段不变，这个字段以下字段全部归0 + * @return {@link DateTime} + * @since 4.5.7 + */ + public static DateTime truncate(Date date, DateField dateField) { + return new DateTime(truncate(calendar(date), dateField)); + } + + /** + * 修改日期为某个时间字段四舍五入时间 + * + * @param date {@link Date} + * @param dateField 时间字段 + * @return {@link DateTime} + * @since 4.5.7 + */ + public static DateTime round(Date date, DateField dateField) { + return new DateTime(round(calendar(date), dateField)); + } + + /** + * 修改日期为某个时间字段结束时间 + * + * @param date {@link Date} + * @param dateField 保留到的时间字段，如定义为 {@link DateField#SECOND}，表示这个字段不变，这个字段以下字段全部取最大值 + * @return {@link DateTime} + * @since 4.5.7 + */ + public static DateTime ceiling(Date date, DateField dateField) { + return new DateTime(ceiling(calendar(date), dateField)); + } + + /** + * 修改日期为某个时间字段结束时间
+ * 可选是否归零毫秒。 + * + *

+ * 有时候由于毫秒部分必须为0（如MySQL数据库中），因此在此加上选项。 + *

+ * + * @param date {@link Date} + * @param dateField 时间字段 + * @param truncateMillisecond 是否毫秒归零 + * @return {@link DateTime} + * @since 4.5.7 + */ + public static DateTime ceiling(Date date, DateField dateField, boolean truncateMillisecond) { + return new DateTime(ceiling(calendar(date), dateField, truncateMillisecond)); + } + + /** + * 获取秒级别的开始时间，即毫秒部分设置为0 + * + * @param date 日期 + * @return {@link DateTime} + * @since 4.6.2 + */ + public static DateTime beginOfSecond(Date date) { + return new DateTime(beginOfSecond(calendar(date))); + } + + /** + * 获取秒级别的结束时间，即毫秒设置为999 + * + * @param date 日期 + * @return {@link DateTime} + * @since 4.6.2 + */ + public static DateTime endOfSecond(Date date) { + return new DateTime(endOfSecond(calendar(date))); + } + + /** + * 获取某小时的开始时间 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime beginOfHour(Date date) { + return new DateTime(beginOfHour(calendar(date))); + } + + /** + * 获取某小时的结束时间 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime endOfHour(Date date) { + return new DateTime(endOfHour(calendar(date))); + } + + /** + * 获取某分钟的开始时间 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime beginOfMinute(Date date) { + return new DateTime(beginOfMinute(calendar(date))); + } + + /** + * 获取某分钟的结束时间 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime endOfMinute(Date date) { + return new DateTime(endOfMinute(calendar(date))); + } + + /** + * 获取某天的开始时间 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime beginOfDay(Date date) { + return new DateTime(beginOfDay(calendar(date))); + } + + /** + * 获取某天的结束时间 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime endOfDay(Date date) { + return new DateTime(endOfDay(calendar(date))); + } + + /** + * 获取某周的开始时间，周一定为一周的开始时间 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime beginOfWeek(Date date) { + return new DateTime(beginOfWeek(calendar(date))); + } + + /** + * 获取某周的开始时间 + * + * @param date 日期 + * @param isMondayAsFirstDay 是否周一做为一周的第一天（false表示周日做为第一天） + * @return {@link DateTime} + * @since 5.4.0 + */ + public static DateTime beginOfWeek(Date date, boolean isMondayAsFirstDay) { + return new DateTime(beginOfWeek(calendar(date), isMondayAsFirstDay)); + } + + /** + * 获取某周的结束时间，周日定为一周的结束 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime endOfWeek(Date date) { + return new DateTime(endOfWeek(calendar(date))); + } + + /** + * 获取某周的结束时间 + * + * @param date 日期 + * @param isSundayAsLastDay 是否周日做为一周的最后一天（false表示周六做为最后一天） + * @return {@link DateTime} + * @since 5.4.0 + */ + public static DateTime endOfWeek(Date date, boolean isSundayAsLastDay) { + return new DateTime(endOfWeek(calendar(date), isSundayAsLastDay)); + } + + /** + * 获取某月的开始时间 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime beginOfMonth(Date date) { + return new DateTime(beginOfMonth(calendar(date))); + } + + /** + * 获取某月的结束时间 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime endOfMonth(Date date) { + return new DateTime(endOfMonth(calendar(date))); + } + + /** + * 获取某季度的开始时间 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime beginOfQuarter(Date date) { + return new DateTime(beginOfQuarter(calendar(date))); + } + + /** + * 获取某季度的结束时间 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime endOfQuarter(Date date) { + return new DateTime(endOfQuarter(calendar(date))); + } + + /** + * 获取某年的开始时间 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime beginOfYear(Date date) { + return new DateTime(beginOfYear(calendar(date))); + } + + /** + * 获取某年的结束时间 + * + * @param date 日期 + * @return {@link DateTime} + */ + public static DateTime endOfYear(Date date) { + return new DateTime(endOfYear(calendar(date))); + } + // --------------------------------------------------- Offset for now + + /** + * 昨天 + * + * @return 昨天 + */ + public static DateTime yesterday() { + return offsetDay(new DateTime(), -1); + } + + /** + * 明天 + * + * @return 明天 + * @since 3.0.1 + */ + public static DateTime tomorrow() { + return offsetDay(new DateTime(), 1); + } + + /** + * 上周 + * + * @return 上周 + */ + public static DateTime lastWeek() { + return offsetWeek(new DateTime(), -1); + } + + /** + * 下周 + * + * @return 下周 + * @since 3.0.1 + */ + public static DateTime nextWeek() { + return offsetWeek(new DateTime(), 1); + } + + /** + * 上个月 + * + * @return 上个月 + */ + public static DateTime lastMonth() { + return offsetMonth(new DateTime(), -1); + } + + /** + * 下个月 + * + * @return 下个月 + * @since 3.0.1 + */ + public static DateTime nextMonth() { + return offsetMonth(new DateTime(), 1); + } + + /** + * 偏移毫秒数 + * + * @param date 日期 + * @param offset 偏移毫秒数，正数向未来偏移，负数向历史偏移 + * @return 偏移后的日期 + */ + public static DateTime offsetMillisecond(Date date, int offset) { + return offset(date, DateField.MILLISECOND, offset); + } + + /** + * 偏移秒数 + * + * @param date 日期 + * @param offset 偏移秒数，正数向未来偏移，负数向历史偏移 + * @return 偏移后的日期 + */ + public static DateTime offsetSecond(Date date, int offset) { + return offset(date, DateField.SECOND, offset); + } + + /** + * 偏移分钟 + * + * @param date 日期 + * @param offset 偏移分钟数，正数向未来偏移，负数向历史偏移 + * @return 偏移后的日期 + */ + public static DateTime offsetMinute(Date date, int offset) { + return offset(date, DateField.MINUTE, offset); + } + + /** + * 偏移小时 + * + * @param date 日期 + * @param offset 偏移小时数，正数向未来偏移，负数向历史偏移 + * @return 偏移后的日期 + */ + public static DateTime offsetHour(Date date, int offset) { + return offset(date, DateField.HOUR_OF_DAY, offset); + } + + /**w + * 偏移天 + * + * @param date 日期 + * @param offset 偏移天数，正数向未来偏移，负数向历史偏移 + * @return 偏移后的日期 + */ + public static DateTime offsetDay(Date date, int offset) { + return offset(date, DateField.DAY_OF_YEAR, offset); + } + + /** + * 偏移周 + * + * @param date 日期 + * @param offset 偏移周数，正数向未来偏移，负数向历史偏移 + * @return 偏移后的日期 + */ + public static DateTime offsetWeek(Date date, int offset) { + return offset(date, DateField.WEEK_OF_YEAR, offset); + } + + /** + * 偏移月 + * + * @param date 日期 + * @param offset 偏移月数，正数向未来偏移，负数向历史偏移 + * @return 偏移后的日期 + */ + public static DateTime offsetMonth(Date date, int offset) { + return offset(date, DateField.MONTH, offset); + } + + /** + * 获取指定日期偏移指定时间后的时间，生成的偏移日期不影响原日期 + * + * @param date 基准日期 + * @param dateField 偏移的粒度大小（小时、天、月等）{@link DateField} + * @param offset 偏移量，正数为向后偏移，负数为向前偏移 + * @return 偏移后的日期 + */ + public static DateTime offset(Date date, DateField dateField, int offset) { + return dateNew(date).offset(dateField, offset); + } + + // ------------------------------------ Offset end ---------------------------------------------- + + /** + * 判断两个日期相差的时长，只保留绝对值 + * + * @param beginDate 起始日期 + * @param endDate 结束日期 + * @param unit 相差的单位：相差 天{@link DateUnit#DAY}、小时{@link DateUnit#HOUR} 等 + * @return 日期差 + */ + public static long between(Date beginDate, Date endDate, DateUnit unit) { + return between(beginDate, endDate, unit, true); + } + + /** + * 判断两个日期相差的时长 + * + * @param beginDate 起始日期 + * @param endDate 结束日期 + * @param unit 相差的单位：相差 天{@link DateUnit#DAY}、小时{@link DateUnit#HOUR} 等 + * @param isAbs 日期间隔是否只保留绝对值正数 + * @return 日期差 + * @since 3.3.1 + */ + public static long between(Date beginDate, Date endDate, DateUnit unit, boolean isAbs) { + return new DateBetween(beginDate, endDate, isAbs).between(unit); + } + + /** + * 判断两个日期相差的毫秒数 + * + * @param beginDate 起始日期 + * @param endDate 结束日期 + * @return 日期差 + * @since 3.0.1 + */ + public static long betweenMs(Date beginDate, Date endDate) { + return new DateBetween(beginDate, endDate).between(DateUnit.MS); + } + + /** + * 判断两个日期相差的天数
+ * + * 
+	 * 有时候我们计算相差天数的时候需要忽略时分秒。
+	 * 比如：2016-02-01 23:59:59和2016-02-02 00:00:00相差一秒
+	 * 如果isReset为{@code false}相差天数为0。
+	 * 如果isReset为{@code true}相差天数将被计算为1
+	 *
+ * + * @param beginDate 起始日期 + * @param endDate 结束日期 + * @param isReset 是否重置时间为起始时间 + * @return 日期差 + * @since 3.0.1 + */ + public static long betweenDay(Date beginDate, Date endDate, boolean isReset) { + if (isReset) { + beginDate = beginOfDay(beginDate); + endDate = beginOfDay(endDate); + } + return between(beginDate, endDate, DateUnit.DAY); + } + + /** + * 计算指定时间区间内的周数 + * + * @param beginDate 开始时间 + * @param endDate 结束时间 + * @param isReset 是否重置时间为起始时间 + * @return 周数 + */ + public static long betweenWeek(Date beginDate, Date endDate, boolean isReset) { + if (isReset) { + beginDate = beginOfDay(beginDate); + endDate = beginOfDay(endDate); + } + return between(beginDate, endDate, DateUnit.WEEK); + } + + /** + * 计算两个日期相差月数
+ * 在非重置情况下，如果起始日期的天大于结束日期的天，月数要少算1（不足1个月） + * + * @param beginDate 起始日期 + * @param endDate 结束日期 + * @param isReset 是否重置时间为起始时间（重置天时分秒） + * @return 相差月数 + * @since 3.0.8 + */ + public static long betweenMonth(Date beginDate, Date endDate, boolean isReset) { + return new DateBetween(beginDate, endDate).betweenMonth(isReset); + } + + /** + * 计算两个日期相差年数
+ * 在非重置情况下，如果起始日期的月大于结束日期的月，年数要少算1（不足1年） + * + * @param beginDate 起始日期 + * @param endDate 结束日期 + * @param isReset 是否重置时间为起始时间（重置月天时分秒） + * @return 相差年数 + * @since 3.0.8 + */ + public static long betweenYear(Date beginDate, Date endDate, boolean isReset) { + return new DateBetween(beginDate, endDate).betweenYear(isReset); + } + + /** + * 格式化日期间隔输出 + * + * @param beginDate 起始日期 + * @param endDate 结束日期 + * @param level 级别，按照天、小时、分、秒、毫秒分为5个等级 + * @return XX天XX小时XX分XX秒 + */ + public static String formatBetween(Date beginDate, Date endDate, BetweenFormatter.Level level) { + return formatBetween(between(beginDate, endDate, DateUnit.MS), level); + } + + /** + * 格式化日期间隔输出，精确到毫秒 + * + * @param beginDate 起始日期 + * @param endDate 结束日期 + * @return XX天XX小时XX分XX秒 + * @since 3.0.1 + */ + public static String formatBetween(Date beginDate, Date endDate) { + return formatBetween(between(beginDate, endDate, DateUnit.MS)); + } + + /** + * 格式化日期间隔输出 + * + * @param betweenMs 日期间隔 + * @param level 级别，按照天、小时、分、秒、毫秒分为5个等级 + * @return XX天XX小时XX分XX秒XX毫秒 + */ + public static String formatBetween(long betweenMs, BetweenFormatter.Level level) { + return new BetweenFormatter(betweenMs, level).format(); + } + + /** + * 格式化日期间隔输出，精确到毫秒 + * + * @param betweenMs 日期间隔 + * @return XX天XX小时XX分XX秒XX毫秒 + * @since 3.0.1 + */ + public static String formatBetween(long betweenMs) { + return new BetweenFormatter(betweenMs, BetweenFormatter.Level.MILLISECOND).format(); + } + + /** + * 当前日期是否在日期指定范围内
+ * 起始日期和结束日期可以互换 + * + * @param date 被检查的日期 + * @param beginDate 起始日期（包含） + * @param endDate 结束日期（包含） + * @return 是否在范围内 + * @since 3.0.8 + */ + public static boolean isIn(Date date, Date beginDate, Date endDate) { + if (date instanceof DateTime) { + return ((DateTime) date).isIn(beginDate, endDate); + } else { + return new DateTime(date).isIn(beginDate, endDate); + } + } + + /** + * 是否为相同时间
+ * 此方法比较两个日期的时间戳是否相同 + * + * @param date1 日期1 + * @param date2 日期2 + * @return 是否为相同时间 + * @since 4.1.13 + */ + public static boolean isSameTime(Date date1, Date date2) { + return date1.compareTo(date2) == 0; + } + + /** + * 比较两个日期是否为同一天 + * + * @param date1 日期1 + * @param date2 日期2 + * @return 是否为同一天 + * @since 4.1.13 + */ + public static boolean isSameDay(final Date date1, final Date date2) { + if (date1 == null || date2 == null) { + throw new IllegalArgumentException("The date must not be null"); + } + return CalendarUtil.isSameDay(calendar(date1), calendar(date2)); + } + + /** + * 比较两个日期是否为同一周 + * + * @param date1 日期1 + * @param date2 日期2 + * @param isMon 是否为周一。国内第一天为星期一，国外第一天为星期日 + * @return 是否为同一周 + */ + public static boolean isSameWeek(final Date date1, final Date date2, boolean isMon) { + if (date1 == null || date2 == null) { + throw new IllegalArgumentException("The date must not be null"); + } + return CalendarUtil.isSameWeek(calendar(date1), calendar(date2), isMon); + } + + /** + * 比较两个日期是否为同一月 + * + * @param date1 日期1 + * @param date2 日期2 + * @return 是否为同一月 + * @since 5.4.1 + */ + public static boolean isSameMonth(final Date date1, final Date date2) { + if (date1 == null || date2 == null) { + throw new IllegalArgumentException("The date must not be null"); + } + return CalendarUtil.isSameMonth(calendar(date1), calendar(date2)); + } + + + /** + * 计时，常用于记录某段代码的执行时间，单位：纳秒 + * + * @param preTime 之前记录的时间 + * @return 时间差，纳秒 + */ + public static long spendNt(long preTime) { + return System.nanoTime() - preTime; + } + + /** + * 计时，常用于记录某段代码的执行时间，单位：毫秒 + * + * @param preTime 之前记录的时间 + * @return 时间差，毫秒 + */ + public static long spendMs(long preTime) { + return System.currentTimeMillis() - preTime; + } + + /** + * 格式化成yyMMddHHmm后转换为int型 + * + * @param date 日期 + * @return int + * @deprecated 2022年后结果溢出，此方法废弃 + */ + @Deprecated + public static int toIntSecond(Date date) { + return Integer.parseInt(DateUtil.format(date, "yyMMddHHmm")); + } + + /** + * 计时器
+ * 计算某个过程花费的时间，精确到毫秒 + * + * @return Timer + */ + public static TimeInterval timer() { + return new TimeInterval(); + + } + + /** + * 计时器
+ * 计算某个过程花费的时间，精确到毫秒 + * + * @param isNano 是否使用纳秒计数，false则使用毫秒 + * @return Timer + * @since 5.2.3 + */ + public static TimeInterval timer(boolean isNano) { + return new TimeInterval(isNano); + } + + /** + * 创建秒表{@link StopWatch}，用于对代码块的执行时间计数 + *

+ * 使用方法如下： + * + * 

+	 * StopWatch stopWatch = DateUtil.createStopWatch();
+	 *
+	 * // 任务1
+	 * stopWatch.start("任务一");
+	 * Thread.sleep(1000);
+	 * stopWatch.stop();
+	 *
+	 * // 任务2
+	 * stopWatch.start("任务二");
+	 * Thread.sleep(2000);
+	 * stopWatch.stop();
+	 *
+	 * // 打印出耗时
+	 * Console.log(stopWatch.prettyPrint());
+	 *
+	 *
+ * + * @return {@link StopWatch} + * @since 5.2.3 + */ + public static StopWatch createStopWatch() { + return new StopWatch(); + } + + /** + * 创建秒表{@link StopWatch}，用于对代码块的执行时间计数 + *

+ * 使用方法如下： + * + * 

+	 * StopWatch stopWatch = DateUtil.createStopWatch("任务名称");
+	 *
+	 * // 任务1
+	 * stopWatch.start("任务一");
+	 * Thread.sleep(1000);
+	 * stopWatch.stop();
+	 *
+	 * // 任务2
+	 * stopWatch.start("任务二");
+	 * Thread.sleep(2000);
+	 * stopWatch.stop();
+	 *
+	 * // 打印出耗时
+	 * Console.log(stopWatch.prettyPrint());
+	 *
+	 *
+ * + * @param id 用于标识秒表的唯一ID + * @return {@link StopWatch} + * @since 5.2.3 + */ + public static StopWatch createStopWatch(String id) { + return new StopWatch(id); + } + + /** + * 生日转为年龄，计算法定年龄 + * + * @param birthDay 生日，标准日期字符串 + * @return 年龄 + */ + public static int ageOfNow(String birthDay) { + return ageOfNow(parse(birthDay)); + } + + /** + * 生日转为年龄，计算法定年龄 + * + * @param birthDay 生日 + * @return 年龄 + */ + public static int ageOfNow(Date birthDay) { + return age(birthDay, date()); + } + + /** + * 是否闰年 + * + * @param year 年 + * @return 是否闰年 + */ + public static boolean isLeapYear(int year) { + return Year.isLeap(year); + } + + /** + * 计算相对于dateToCompare的年龄，长用于计算指定生日在某年的年龄 + * + * @param birthday 生日 + * @param dateToCompare 需要对比的日期 + * @return 年龄 + */ + public static int age(Date birthday, Date dateToCompare) { + Assert.notNull(birthday, "Birthday can not be null !"); + if (null == dateToCompare) { + dateToCompare = date(); + } + return age(birthday.getTime(), dateToCompare.getTime()); + } + + /** + * 判定给定开始时间经过某段时间后是否过期 + * + * @param startDate 开始时间 + * @param dateField 时间单位 + * @param timeLength 实际经过时长 + * @param endDate 被比较的时间，即有效期的截止时间。如果经过时长后的时间晚于截止时间，就表示过期 + * @return 是否过期 + * @since 3.1.1 + * @deprecated 此方法存在一定的歧义，容易产生误导，废弃。 + */ + @Deprecated + public static boolean isExpired(Date startDate, DateField dateField, int timeLength, Date endDate) { + final Date offsetDate = offset(startDate, dateField, timeLength); + return offsetDate.after(endDate); + } + + /** + * 判定在指定检查时间是否过期。 + * + *

+ * 以商品为例，startDate即生产日期，endDate即保质期的截止日期，checkDate表示在何时检查是否过期（一般为当前时间）
+ * endDate和startDate的差值即为保质期（按照毫秒计），checkDate和startDate的差值即为实际经过的时长，实际时长大于保质期表示超时。 + *

+ * + * @param startDate 开始时间 + * @param endDate 被比较的时间，即有效期的截止时间。如果经过时长后的时间晚于被检查的时间，就表示过期 + * @param checkDate 检查时间，可以是当前时间，既 + * @return 是否过期 + * @since 5.1.1 + * @deprecated 使用isIn方法 + */ + @Deprecated + public static boolean isExpired(Date startDate, Date endDate, Date checkDate) { + return betweenMs(startDate, checkDate) > betweenMs(startDate, endDate); + } + + /** + * HH:mm:ss 时间格式字符串转为秒数
+ * 参考：https://github.com/iceroot + * + * @param timeStr 字符串时分秒(HH:mm:ss)格式 + * @return 时分秒转换后的秒数 + * @since 3.1.2 + */ + public static int timeToSecond(String timeStr) { + if (StrUtil.isEmpty(timeStr)) { + return 0; + } + + final List hms = StrUtil.splitTrim(timeStr, StrUtil.C_COLON, 3); + int lastIndex = hms.size() - 1; + + int result = 0; + for (int i = lastIndex; i >= 0; i--) { + result += Integer.parseInt(hms.get(i)) * Math.pow(60, (lastIndex - i)); + } + return result; + } + + /** + * 秒数转为时间格式(HH:mm:ss)
+ * 参考：https://github.com/iceroot + * + * @param seconds 需要转换的秒数 + * @return 转换后的字符串 + * @since 3.1.2 + */ + public static String secondToTime(int seconds) { + if (seconds < 0) { + throw new IllegalArgumentException("Seconds must be a positive number!"); + } + + int hour = seconds / 3600; + int other = seconds % 3600; + int minute = other / 60; + int second = other % 60; + final StringBuilder sb = new StringBuilder(); + if (hour < 10) { + sb.append("0"); + } + sb.append(hour); + sb.append(":"); + if (minute < 10) { + sb.append("0"); + } + sb.append(minute); + sb.append(":"); + if (second < 10) { + sb.append("0"); + } + sb.append(second); + return sb.toString(); + } + + /** + * 创建日期范围生成器 + * + * @param start 起始日期时间（包括） + * @param end 结束日期时间 + * @param unit 步进单位 + * @return {@link DateRange} + */ + public static DateRange range(Date start, Date end, final DateField unit) { + return new DateRange(start, end, unit); + } + + /** + * 俩个时间区间取交集 + * + * @param start 开始区间 + * @param end 结束区间 + * @return true 包含 + * @author handy + * @since 5.7.21 + */ + public static List rangeContains(DateRange start, DateRange end) { + List startDateTimes = CollUtil.newArrayList((Iterable) start); + List endDateTimes = CollUtil.newArrayList((Iterable) end); + return startDateTimes.stream().filter(endDateTimes::contains).collect(Collectors.toList()); + } + + /** + * 俩个时间区间取差集(end - start) + * + * @param start 开始区间 + * @param end 结束区间 + * @return true 包含 + * @author handy + * @since 5.7.21 + */ + public static List rangeNotContains(DateRange start, DateRange end) { + List startDateTimes = CollUtil.newArrayList((Iterable) start); + List endDateTimes = CollUtil.newArrayList((Iterable) end); + return endDateTimes.stream().filter(item -> !startDateTimes.contains(item)).collect(Collectors.toList()); + } + + /** + * 按日期范围遍历，执行 function + * + * @param start 起始日期时间（包括） + * @param end 结束日期时间 + * @param unit 步进单位 + * @param func 每次遍历要执行的 function + * @param Date经过函数处理结果类型 + * @return 结果列表 + * @since 5.7.21 + */ + public static List rangeFunc(Date start, Date end, final DateField unit, Function func) { + if (start == null || end == null || start.after(end)) { + return Collections.emptyList(); + } + ArrayList list = new ArrayList<>(); + for (DateTime date : range(start, end, unit)) { + list.add(func.apply(date)); + } + return list; + } + + /** + * 按日期范围遍历，执行 consumer + * + * @param start 起始日期时间（包括） + * @param end 结束日期时间 + * @param unit 步进单位 + * @param consumer 每次遍历要执行的 consumer + * @since 5.7.21 + */ + public static void rangeConsume(Date start, Date end, final DateField unit, Consumer consumer) { + if (start == null || end == null || start.after(end)) { + return; + } + range(start, end, unit).forEach(consumer); + } + + /** + * 根据步进单位获取起始日期时间和结束日期时间的时间区间集合 + * + * @param start 起始日期时间 + * @param end 结束日期时间 + * @param unit 步进单位 + * @return {@link DateRange} + */ + public static List rangeToList(Date start, Date end, DateField unit) { + return CollUtil.newArrayList((Iterable) range(start, end, unit)); + } + + /** + * 根据步进单位和步进获取起始日期时间和结束日期时间的时间区间集合 + * + * @param start 起始日期时间 + * @param end 结束日期时间 + * @param unit 步进单位 + * @param step 步进 + * @return {@link DateRange} + * @since 5.7.16 + */ + public static List rangeToList(Date start, Date end, final DateField unit, int step) { + return CollUtil.newArrayList((Iterable) new DateRange(start, end, unit, step)); + } + + /** + * 通过生日计算星座 + * + * @param month 月，从0开始计数 + * @param day 天 + * @return 星座名 + * @since 4.4.3 + */ + public static String getZodiac(int month, int day) { + return Zodiac.getZodiac(month, day); + } + + /** + * 计算生肖，只计算1900年后出生的人 + * + * @param year 农历年 + * @return 生肖名 + * @since 4.4.3 + */ + public static String getChineseZodiac(int year) { + return Zodiac.getChineseZodiac(year); + } + + /** + * {@code null}安全的日期比较，{@code null}对象排在末尾 + * + * @param date1 日期1 + * @param date2 日期2 + * @return 比较结果，如果date1 < date2，返回数小于0，date1==date2返回0，date1 > date2 大于0 + * @since 4.6.2 + */ + public static int compare(Date date1, Date date2) { + return CompareUtil.compare(date1, date2); + } + + /** + * {@code null}安全的日期比较，并只比较指定格式； {@code null}对象排在末尾, 并指定日期格式； + * + * @param date1 日期1 + * @param date2 日期2 + * @param format 日期格式，常用格式见： {@link DatePattern}; 允许为空； date1 date2; eg: yyyy-MM-dd + * @return 比较结果，如果date1 < date2，返回数小于0，date1==date2返回0，date1 > date2 大于0 + * @author dazer + * @since 5.6.4 + */ + public static int compare(Date date1, Date date2, String format) { + if (format != null) { + if (date1 != null) { + date1 = parse(format(date1, format), format); + } + if (date2 != null) { + date2 = parse(format(date2, format), format); + } + } + return CompareUtil.compare(date1, date2); + } + + /** + * 纳秒转毫秒 + * + * @param duration 时长 + * @return 时长毫秒 + * @since 4.6.6 + */ + public static long nanosToMillis(long duration) { + return TimeUnit.NANOSECONDS.toMillis(duration); + } + + /** + * 纳秒转秒，保留小数 + * + * @param duration 时长 + * @return 秒 + * @since 4.6.6 + */ + public static double nanosToSeconds(long duration) { + return duration / 1_000_000_000.0; + } + + /** + * Date对象转换为{@link Instant}对象 + * + * @param date Date对象 + * @return {@link Instant}对象 + * @since 5.0.2 + */ + public static Instant toInstant(Date date) { + return null == date ? null : date.toInstant(); + } + + /** + * Date对象转换为{@link Instant}对象 + * + * @param temporalAccessor Date对象 + * @return {@link Instant}对象 + * @since 5.0.2 + */ + public static Instant toInstant(TemporalAccessor temporalAccessor) { + return TemporalAccessorUtil.toInstant(temporalAccessor); + } + + /** + * {@link Instant} 转换为 {@link LocalDateTime}，使用系统默认时区 + * + * @param instant {@link Instant} + * @return {@link LocalDateTime} + * @see LocalDateTimeUtil#of(Instant) + * @since 5.0.5 + */ + public static LocalDateTime toLocalDateTime(Instant instant) { + return LocalDateTimeUtil.of(instant); + } + + /** + * {@link Date} 转换为 {@link LocalDateTime}，使用系统默认时区 + * + * @param date {@link Date} + * @return {@link LocalDateTime} + * @see LocalDateTimeUtil#of(Date) + * @since 5.0.5 + */ + public static LocalDateTime toLocalDateTime(Date date) { + return LocalDateTimeUtil.of(date); + } + + /** + * {@link Date} 转换时区 + * + * @param date {@link Date} + * @param zoneId {@link ZoneId} + * @return {@link DateTime} + * @since 5.8.3 + */ + public static DateTime convertTimeZone(Date date, ZoneId zoneId) { + return new DateTime(date, ZoneUtil.toTimeZone(zoneId)); + } + + /** + * {@link Date} 转换时区 + * + * @param date {@link Date} + * @param timeZone {@link TimeZone} + * @return {@link DateTime} + * @since 5.8.3 + */ + public static DateTime convertTimeZone(Date date, TimeZone timeZone) { + return new DateTime(date, timeZone); + } + + /** + * 获得指定年份的总天数 + * + * @param year 年份 + * @return 天 + * @since 5.3.6 + */ + public static int lengthOfYear(int year) { + return Year.of(year).length(); + } + + /** + * 获得指定月份的总天数 + * + * @param month 月份 + * @param isLeapYear 是否闰年 + * @return 天 + * @since 5.4.2 + */ + public static int lengthOfMonth(int month, boolean isLeapYear) { + return java.time.Month.of(month).length(isLeapYear); + } + + /** + * 创建{@link SimpleDateFormat}，注意此对象非线程安全！
+ * 此对象默认为严格格式模式，即parse时如果格式不正确会报错。 + * + * @param pattern 表达式 + * @return {@link SimpleDateFormat} + * @since 5.5.5 + */ + public static SimpleDateFormat newSimpleFormat(String pattern) { + return newSimpleFormat(pattern, null, null); + } + + /** + * 创建{@link SimpleDateFormat}，注意此对象非线程安全！
+ * 此对象默认为严格格式模式，即parse时如果格式不正确会报错。 + * + * @param pattern 表达式 + * @param locale {@link Locale}，{@code null}表示默认 + * @param timeZone {@link TimeZone}，{@code null}表示默认 + * @return {@link SimpleDateFormat} + * @since 5.5.5 + */ + public static SimpleDateFormat newSimpleFormat(String pattern, Locale locale, TimeZone timeZone) { + if (null == locale) { + locale = Locale.getDefault(Locale.Category.FORMAT); + } + final SimpleDateFormat format = new SimpleDateFormat(pattern, locale); + if (null != timeZone) { + format.setTimeZone(timeZone); + } + format.setLenient(false); + return format; + } + + /** + * 获取时长单位简写 + * + * @param unit 单位 + * @return 单位简写名称 + * @since 5.7.16 + */ + public static String getShotName(TimeUnit unit) { + switch (unit) { + case NANOSECONDS: + return "ns"; + case MICROSECONDS: + return "μs"; + case MILLISECONDS: + return "ms"; + case SECONDS: + return "s"; + case MINUTES: + return "min"; + case HOURS: + return "h"; + default: + return unit.name().toLowerCase(); + } + } + + /** + * 检查两个时间段是否有时间重叠
+ * 重叠指两个时间段是否有交集，注意此方法时间段重合时如： + *
    + *
  • 此方法未纠正开始时间小于结束时间
    • + *
  • 当realStartTime和realEndTime或startTime和endTime相等时,退化为判断区间是否包含点
    • + *
  • 当realStartTime和realEndTime和startTime和endTime相等时,退化为判断点与点是否相等
    • + *
+ * See 准确的区间关系参考:艾伦区间代数 + * @param realStartTime 第一个时间段的开始时间 + * @param realEndTime 第一个时间段的结束时间 + * @param startTime 第二个时间段的开始时间 + * @param endTime 第二个时间段的结束时间 + * @return true 表示时间有重合或包含或相等 + * @since 5.7.22 + */ + public static boolean isOverlap(Date realStartTime, Date realEndTime, + Date startTime, Date endTime) { + + // x>b||a>y 无交集 + // 则有交集的逻辑为 !(x>b||a>y) + // 根据德摩根公式，可化简为 x<=b && a<=y 即 realStartTime<=endTime && startTime<=realEndTime + return realStartTime.compareTo(endTime) <=0 && startTime.compareTo(realEndTime) <= 0; + } + + /** + * 是否为本月最后一天 + * @param date {@link Date} + * @return 是否为本月最后一天 + * @since 5.8.9 + */ + public static boolean isLastDayOfMonth(Date date){ + return date(date).isLastDayOfMonth(); + } + + /** + * 获得本月的最后一天 + * @param date {@link Date} + * @return 天 + * @since 5.8.9 + */ + public static int getLastDayOfMonth(Date date){ + return date(date).getLastDayOfMonth(); + } + + // ------------------------------------------------------------------------ Private method start + + /** + * 标准化日期，默认处理以空格区分的日期时间格式，空格前为日期，空格后为时间：
+ * 将以下字符替换为"-" + * + * 
+	 * "."
+	 * "/"
+	 * "年"
+	 * "月"
+	 *
+ *

+ * 将以下字符去除 + * + * 

+	 * "日"
+	 *
+ *

+ * 将以下字符替换为":" + * + * 

+	 * "时"
+	 * "分"
+	 * "秒"
+	 *
+ *

+ * 当末位是":"时去除之（不存在毫秒时） + * + * @param dateStr 日期时间字符串 + * @return 格式化后的日期字符串 + */ + private static String normalize(CharSequence dateStr) { + if (StrUtil.isBlank(dateStr)) { + return StrUtil.str(dateStr); + } + + // 日期时间分开处理 + final List dateAndTime = StrUtil.splitTrim(dateStr, ' '); + final int size = dateAndTime.size(); + if (size < 1 || size > 2) { + // 非可被标准处理的格式 + return StrUtil.str(dateStr); + } + + final StringBuilder builder = StrUtil.builder(); + + // 日期部分（"\"、"/"、"."、"年"、"月"都替换为"-"） + String datePart = dateAndTime.get(0).replaceAll("[/.年月]", "-"); + datePart = StrUtil.removeSuffix(datePart, "日"); + builder.append(datePart); + + // 时间部分 + if (size == 2) { + builder.append(' '); + String timePart = dateAndTime.get(1).replaceAll("[时分秒]", ":"); + timePart = StrUtil.removeSuffix(timePart, ":"); + //将ISO8601中的逗号替换为. + timePart = timePart.replace(',', '.'); + builder.append(timePart); + } + + return builder.toString(); + } + // ------------------------------------------------------------------------ Private method end + + /** + * 如果日期中的毫秒部分超出3位，会导致秒数增加，因此只保留前三位 + * + * @param dateStr 日期字符串 + * @param before 毫秒部分的前一个字符 + * @param after 毫秒部分的后一个字符 + * @return 规范之后的毫秒部分 + */ + private static String normalizeMillSeconds(String dateStr, CharSequence before, CharSequence after) { + if (StrUtil.isBlank(after)) { + String millOrNaco = StrUtil.subPre(StrUtil.subAfter(dateStr, before, true), 3); + return StrUtil.subBefore(dateStr, before, true) + before + millOrNaco; + } + String millOrNaco = StrUtil.subPre(StrUtil.subBetween(dateStr, before, after), 3); + return StrUtil.subBefore(dateStr, before, true) + + before + + millOrNaco + after + StrUtil.subAfter(dateStr, after, true); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/GroupTimeInterval.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/GroupTimeInterval.java new file mode 100644 index 0000000..a38d1d2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/GroupTimeInterval.java @@ -0,0 +1,177 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.map.SafeConcurrentHashMap; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.io.Serializable; +import java.util.Map; + +/** + * 分组计时器
+ * 计算某几个过程花费的时间，精确到毫秒或纳秒 + * + * @author Looly + * @since 5.5.2 + */ +public class GroupTimeInterval implements Serializable { + private static final long serialVersionUID = 1L; + + private final boolean isNano; + protected final Map groupMap; + + /** + * 构造 + * + * @param isNano 是否使用纳秒计数，false则使用毫秒 + */ + public GroupTimeInterval(boolean isNano) { + this.isNano = isNano; + groupMap = new SafeConcurrentHashMap<>(); + } + + /** + * 清空所有定时记录 + * + * @return this + */ + public GroupTimeInterval clear(){ + this.groupMap.clear(); + return this; + } + + /** + * 开始计时并返回当前时间 + * + * @param id 分组ID + * @return 开始计时并返回当前时间 + */ + public long start(String id) { + final long time = getTime(); + this.groupMap.put(id, time); + return time; + } + + /** + * 重新计时并返回从开始到当前的持续时间秒
+ * 如果此分组下没有记录，则返回0; + * + * @param id 分组ID + * @return 重新计时并返回从开始到当前的持续时间 + */ + public long intervalRestart(String id) { + final long now = getTime(); + return now - ObjectUtil.defaultIfNull(this.groupMap.put(id, now), now); + } + + //----------------------------------------------------------- Interval + + /** + * 从开始到当前的间隔时间（毫秒数）
+ * 如果使用纳秒计时，返回纳秒差，否则返回毫秒差
+ * 如果分组下没有开始时间，返回{@code null} + * + * @param id 分组ID + * @return 从开始到当前的间隔时间（毫秒数） + */ + public long interval(String id) { + final Long lastTime = this.groupMap.get(id); + if (null == lastTime) { + return 0; + } + return getTime() - lastTime; + } + + /** + * 从开始到当前的间隔时间 + * + * @param id 分组ID + * @param dateUnit 时间单位 + * @return 从开始到当前的间隔时间（毫秒数） + */ + public long interval(String id, DateUnit dateUnit) { + final long intervalMs = isNano ? interval(id) / 1000000L : interval(id); + if (DateUnit.MS == dateUnit) { + return intervalMs; + } + return intervalMs / dateUnit.getMillis(); + } + + /** + * 从开始到当前的间隔时间（毫秒数） + * + * @param id 分组ID + * @return 从开始到当前的间隔时间（毫秒数） + */ + public long intervalMs(String id) { + return interval(id, DateUnit.MS); + } + + /** + * 从开始到当前的间隔秒数，取绝对值 + * + * @param id 分组ID + * @return 从开始到当前的间隔秒数，取绝对值 + */ + public long intervalSecond(String id) { + return interval(id, DateUnit.SECOND); + } + + /** + * 从开始到当前的间隔分钟数，取绝对值 + * + * @param id 分组ID + * @return 从开始到当前的间隔分钟数，取绝对值 + */ + public long intervalMinute(String id) { + return interval(id, DateUnit.MINUTE); + } + + /** + * 从开始到当前的间隔小时数，取绝对值 + * + * @param id 分组ID + * @return 从开始到当前的间隔小时数，取绝对值 + */ + public long intervalHour(String id) { + return interval(id, DateUnit.HOUR); + } + + /** + * 从开始到当前的间隔天数，取绝对值 + * + * @param id 分组ID + * @return 从开始到当前的间隔天数，取绝对值 + */ + public long intervalDay(String id) { + return interval(id, DateUnit.DAY); + } + + /** + * 从开始到当前的间隔周数，取绝对值 + * + * @param id 分组ID + * @return 从开始到当前的间隔周数，取绝对值 + */ + public long intervalWeek(String id) { + return interval(id, DateUnit.WEEK); + } + + /** + * 从开始到当前的间隔时间（毫秒数），返回XX天XX小时XX分XX秒XX毫秒 + * + * @param id 分组ID + * @return 从开始到当前的间隔时间（毫秒数） + */ + public String intervalPretty(String id) { + return DateUtil.formatBetween(intervalMs(id)); + } + + /** + * 获取时间的毫秒或纳秒数，纳秒非时间戳 + * + * @return 时间 + */ + private long getTime() { + return this.isNano ? System.nanoTime() : System.currentTimeMillis(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/LocalDateTimeUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/LocalDateTimeUtil.java new file mode 100755 index 0000000..e63dafc --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/LocalDateTimeUtil.java @@ -0,0 +1,639 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.date.format.GlobalCustomFormat; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.time.*; +import java.time.chrono.ChronoLocalDateTime; +import java.time.format.DateTimeFormatter; +import java.time.format.DateTimeFormatterBuilder; +import java.time.temporal.*; +import java.util.Date; +import java.util.TimeZone; + +/** + * JDK8+中的{@link LocalDateTime} 工具类封装 + * + * @author looly + * @see DateUtil java7和以下版本，使用Date工具类 + * @see DatePattern 常用格式工具类 + * @since 5.3.9 + */ +public class LocalDateTimeUtil { + + /** + * 当前时间，默认时区 + * + * @return {@link LocalDateTime} + */ + public static LocalDateTime now() { + return LocalDateTime.now(); + } + + /** + * {@link Instant}转{@link LocalDateTime}，使用默认时区 + * + * @param instant {@link Instant} + * @return {@link LocalDateTime} + */ + public static LocalDateTime of(Instant instant) { + return of(instant, ZoneId.systemDefault()); + } + + /** + * {@link Instant}转{@link LocalDateTime}，使用UTC时区 + * + * @param instant {@link Instant} + * @return {@link LocalDateTime} + */ + public static LocalDateTime ofUTC(Instant instant) { + return of(instant, ZoneId.of("UTC")); + } + + /** + * {@link ZonedDateTime}转{@link LocalDateTime} + * + * @param zonedDateTime {@link ZonedDateTime} + * @return {@link LocalDateTime} + */ + public static LocalDateTime of(ZonedDateTime zonedDateTime) { + if (null == zonedDateTime) { + return null; + } + return zonedDateTime.toLocalDateTime(); + } + + /** + * {@link Instant}转{@link LocalDateTime} + * + * @param instant {@link Instant} + * @param zoneId 时区 + * @return {@link LocalDateTime} + */ + public static LocalDateTime of(Instant instant, ZoneId zoneId) { + if (null == instant) { + return null; + } + + return LocalDateTime.ofInstant(instant, ObjectUtil.defaultIfNull(zoneId, ZoneId::systemDefault)); + } + + /** + * {@link Instant}转{@link LocalDateTime} + * + * @param instant {@link Instant} + * @param timeZone 时区 + * @return {@link LocalDateTime} + */ + public static LocalDateTime of(Instant instant, TimeZone timeZone) { + if (null == instant) { + return null; + } + + return of(instant, ObjectUtil.defaultIfNull(timeZone, TimeZone::getDefault).toZoneId()); + } + + /** + * 毫秒转{@link LocalDateTime}，使用默认时区 + * + *

注意：此方法使用默认时区，如果非UTC，会产生时间偏移

+ * + * @param epochMilli 从1970-01-01T00:00:00Z开始计数的毫秒数 + * @return {@link LocalDateTime} + */ + public static LocalDateTime of(long epochMilli) { + return of(Instant.ofEpochMilli(epochMilli)); + } + + /** + * 毫秒转{@link LocalDateTime}，使用UTC时区 + * + * @param epochMilli 从1970-01-01T00:00:00Z开始计数的毫秒数 + * @return {@link LocalDateTime} + */ + public static LocalDateTime ofUTC(long epochMilli) { + return ofUTC(Instant.ofEpochMilli(epochMilli)); + } + + /** + * 毫秒转{@link LocalDateTime}，根据时区不同，结果会产生时间偏移 + * + * @param epochMilli 从1970-01-01T00:00:00Z开始计数的毫秒数 + * @param zoneId 时区 + * @return {@link LocalDateTime} + */ + public static LocalDateTime of(long epochMilli, ZoneId zoneId) { + return of(Instant.ofEpochMilli(epochMilli), zoneId); + } + + /** + * 毫秒转{@link LocalDateTime}，结果会产生时间偏移 + * + * @param epochMilli 从1970-01-01T00:00:00Z开始计数的毫秒数 + * @param timeZone 时区 + * @return {@link LocalDateTime} + */ + public static LocalDateTime of(long epochMilli, TimeZone timeZone) { + return of(Instant.ofEpochMilli(epochMilli), timeZone); + } + + /** + * {@link Date}转{@link LocalDateTime}，使用默认时区 + * + * @param date Date对象 + * @return {@link LocalDateTime} + */ + public static LocalDateTime of(Date date) { + if (null == date) { + return null; + } + + if (date instanceof DateTime) { + return of(date.toInstant(), ((DateTime) date).getZoneId()); + } + return of(date.toInstant()); + } + + /** + * {@link TemporalAccessor}转{@link LocalDateTime}，使用默认时区 + * + * @param temporalAccessor {@link TemporalAccessor} + * @return {@link LocalDateTime} + */ + public static LocalDateTime of(TemporalAccessor temporalAccessor) { + if (null == temporalAccessor) { + return null; + } + + if (temporalAccessor instanceof LocalDate) { + return ((LocalDate) temporalAccessor).atStartOfDay(); + } else if(temporalAccessor instanceof Instant){ + return LocalDateTime.ofInstant((Instant) temporalAccessor, ZoneId.systemDefault()); + } else if(temporalAccessor instanceof ZonedDateTime){ + return ((ZonedDateTime)temporalAccessor).toLocalDateTime(); + } + + return LocalDateTime.of( + TemporalAccessorUtil.get(temporalAccessor, ChronoField.YEAR), + TemporalAccessorUtil.get(temporalAccessor, ChronoField.MONTH_OF_YEAR), + TemporalAccessorUtil.get(temporalAccessor, ChronoField.DAY_OF_MONTH), + TemporalAccessorUtil.get(temporalAccessor, ChronoField.HOUR_OF_DAY), + TemporalAccessorUtil.get(temporalAccessor, ChronoField.MINUTE_OF_HOUR), + TemporalAccessorUtil.get(temporalAccessor, ChronoField.SECOND_OF_MINUTE), + TemporalAccessorUtil.get(temporalAccessor, ChronoField.NANO_OF_SECOND) + ); + } + + /** + * {@link TemporalAccessor}转{@link LocalDate}，使用默认时区 + * + * @param temporalAccessor {@link TemporalAccessor} + * @return {@link LocalDate} + * @since 5.3.10 + */ + public static LocalDate ofDate(TemporalAccessor temporalAccessor) { + if (null == temporalAccessor) { + return null; + } + + if (temporalAccessor instanceof LocalDateTime) { + return ((LocalDateTime) temporalAccessor).toLocalDate(); + } else if(temporalAccessor instanceof Instant){ + return of(temporalAccessor).toLocalDate(); + } + + return LocalDate.of( + TemporalAccessorUtil.get(temporalAccessor, ChronoField.YEAR), + TemporalAccessorUtil.get(temporalAccessor, ChronoField.MONTH_OF_YEAR), + TemporalAccessorUtil.get(temporalAccessor, ChronoField.DAY_OF_MONTH) + ); + } + + /** + * 解析日期时间字符串为{@link LocalDateTime}，仅支持yyyy-MM-dd'T'HH:mm:ss格式，例如：2007-12-03T10:15:30
+ * 即{@link DateTimeFormatter#ISO_LOCAL_DATE_TIME} + * + * @param text 日期时间字符串 + * @return {@link LocalDateTime} + */ + public static LocalDateTime parse(CharSequence text) { + return parse(text, (DateTimeFormatter) null); + } + + /** + * 解析日期时间字符串为{@link LocalDateTime}，格式支持日期时间、日期、时间
+ * 如果formatter为{code null}，则使用{@link DateTimeFormatter#ISO_LOCAL_DATE_TIME} + * + * @param text 日期时间字符串 + * @param formatter 日期格式化器，预定义的格式见：{@link DateTimeFormatter} + * @return {@link LocalDateTime} + */ + public static LocalDateTime parse(CharSequence text, DateTimeFormatter formatter) { + if (StrUtil.isBlank(text)) { + return null; + } + if (null == formatter) { + return LocalDateTime.parse(text); + } + + return of(formatter.parse(text)); + } + + /** + * 解析日期时间字符串为{@link LocalDateTime} + * + * @param text 日期时间字符串 + * @param format 日期格式，类似于yyyy-MM-dd HH:mm:ss,SSS + * @return {@link LocalDateTime} + */ + public static LocalDateTime parse(CharSequence text, String format) { + if (StrUtil.isBlank(text)) { + return null; + } + + if (GlobalCustomFormat.isCustomFormat(format)) { + return of(GlobalCustomFormat.parse(text, format)); + } + + DateTimeFormatter formatter = null; + if (StrUtil.isNotBlank(format)) { + // 修复yyyyMMddHHmmssSSS格式不能解析的问题 + // fix issue#1082 + //see https://stackoverflow.com/questions/22588051/is-java-time-failing-to-parse-fraction-of-second + // jdk8 bug at: https://bugs.openjdk.java.net/browse/JDK-8031085 + if (StrUtil.startWithIgnoreEquals(format, DatePattern.PURE_DATETIME_PATTERN)) { + final String fraction = StrUtil.removePrefix(format, DatePattern.PURE_DATETIME_PATTERN); + if (ReUtil.isMatch("[S]{1,2}", fraction)) { + //将yyyyMMddHHmmssS、yyyyMMddHHmmssSS的日期统一替换为yyyyMMddHHmmssSSS格式，用0补 + text += StrUtil.repeat('0', 3 - fraction.length()); + } + formatter = new DateTimeFormatterBuilder() + .appendPattern(DatePattern.PURE_DATETIME_PATTERN) + .appendValue(ChronoField.MILLI_OF_SECOND, 3) + .toFormatter(); + } else { + formatter = DateTimeFormatter.ofPattern(format); + } + } + + return parse(text, formatter); + } + + /** + * 解析日期时间字符串为{@link LocalDate}，仅支持yyyy-MM-dd'T'HH:mm:ss格式，例如：2007-12-03T10:15:30 + * + * @param text 日期时间字符串 + * @return {@link LocalDate} + * @since 5.3.10 + */ + public static LocalDate parseDate(CharSequence text) { + return parseDate(text, (DateTimeFormatter) null); + } + + /** + * 解析日期时间字符串为{@link LocalDate}，格式支持日期 + * + * @param text 日期时间字符串 + * @param formatter 日期格式化器，预定义的格式见：{@link DateTimeFormatter} + * @return {@link LocalDate} + * @since 5.3.10 + */ + public static LocalDate parseDate(CharSequence text, DateTimeFormatter formatter) { + if (null == text) { + return null; + } + if (null == formatter) { + return LocalDate.parse(text); + } + + return ofDate(formatter.parse(text)); + } + + /** + * 解析日期字符串为{@link LocalDate} + * + * @param text 日期字符串 + * @param format 日期格式，类似于yyyy-MM-dd + * @return {@link LocalDateTime} + */ + public static LocalDate parseDate(CharSequence text, String format) { + if (null == text) { + return null; + } + return parseDate(text, DateTimeFormatter.ofPattern(format)); + } + + /** + * 格式化日期时间为yyyy-MM-dd HH:mm:ss格式 + * + * @param time {@link LocalDateTime} + * @return 格式化后的字符串 + * @since 5.3.11 + */ + public static String formatNormal(LocalDateTime time) { + return format(time, DatePattern.NORM_DATETIME_FORMATTER); + } + + /** + * 格式化日期时间为指定格式 + * + * @param time {@link LocalDateTime} + * @param formatter 日期格式化器，预定义的格式见：{@link DateTimeFormatter} + * @return 格式化后的字符串 + */ + public static String format(LocalDateTime time, DateTimeFormatter formatter) { + return TemporalAccessorUtil.format(time, formatter); + } + + /** + * 格式化日期时间为指定格式 + * + * @param time {@link LocalDateTime} + * @param format 日期格式，类似于yyyy-MM-dd HH:mm:ss,SSS + * @return 格式化后的字符串 + */ + public static String format(LocalDateTime time, String format) { + return TemporalAccessorUtil.format(time, format); + } + + /** + * 格式化日期时间为yyyy-MM-dd格式 + * + * @param date {@link LocalDate} + * @return 格式化后的字符串 + * @since 5.3.11 + */ + public static String formatNormal(LocalDate date) { + return format(date, DatePattern.NORM_DATE_FORMATTER); + } + + /** + * 格式化日期时间为指定格式 + * + * @param date {@link LocalDate} + * @param formatter 日期格式化器，预定义的格式见：{@link DateTimeFormatter}; 常量如： {@link DatePattern#NORM_DATE_FORMATTER}, {@link DatePattern#NORM_DATETIME_FORMATTER} + * @return 格式化后的字符串 + * @since 5.3.10 + */ + public static String format(LocalDate date, DateTimeFormatter formatter) { + return TemporalAccessorUtil.format(date, formatter); + } + + /** + * 格式化日期时间为指定格式 + * + * @param date {@link LocalDate} + * @param format 日期格式，类似于yyyy-MM-dd, 常量如 {@link DatePattern#NORM_DATE_PATTERN}, {@link DatePattern#NORM_DATETIME_PATTERN} + * @return 格式化后的字符串 + * @since 5.3.10 + */ + public static String format(LocalDate date, String format) { + if (null == date) { + return null; + } + return format(date, DateTimeFormatter.ofPattern(format)); + } + + /** + * 日期偏移,根据field不同加不同值（偏移会修改传入的对象） + * + * @param time {@link LocalDateTime} + * @param number 偏移量，正数为向后偏移，负数为向前偏移 + * @param field 偏移单位，见{@link ChronoUnit}，不能为null + * @return 偏移后的日期时间 + */ + public static LocalDateTime offset(LocalDateTime time, long number, TemporalUnit field) { + return TemporalUtil.offset(time, number, field); + } + + /** + * 获取两个日期的差，如果结束时间早于开始时间，获取结果为负。 + *

+ * 返回结果为{@link Duration}对象，通过调用toXXX方法返回相差单位 + * + * @param startTimeInclude 开始时间（包含） + * @param endTimeExclude 结束时间（不包含） + * @return 时间差 {@link Duration}对象 + * @see TemporalUtil#between(Temporal, Temporal) + */ + public static Duration between(LocalDateTime startTimeInclude, LocalDateTime endTimeExclude) { + return TemporalUtil.between(startTimeInclude, endTimeExclude); + } + + /** + * 获取两个日期的差，如果结束时间早于开始时间，获取结果为负。 + *

+ * 返回结果为时间差的long值 + * + * @param startTimeInclude 开始时间（包括） + * @param endTimeExclude 结束时间（不包括） + * @param unit 时间差单位 + * @return 时间差 + * @since 5.4.5 + */ + public static long between(LocalDateTime startTimeInclude, LocalDateTime endTimeExclude, ChronoUnit unit) { + return TemporalUtil.between(startTimeInclude, endTimeExclude, unit); + } + + /** + * 获取两个日期的表象时间差，如果结束时间早于开始时间，获取结果为负。 + *

+ * 比如2011年2月1日，和2021年8月11日，日相差了10天，月相差6月 + * + * @param startTimeInclude 开始时间（包括） + * @param endTimeExclude 结束时间（不包括） + * @return 时间差 + * @since 5.4.5 + */ + public static Period betweenPeriod(LocalDate startTimeInclude, LocalDate endTimeExclude) { + return Period.between(startTimeInclude, endTimeExclude); + } + + /** + * 修改为一天的开始时间，例如：2020-02-02 00:00:00,000 + * + * @param time 日期时间 + * @return 一天的开始时间 + */ + public static LocalDateTime beginOfDay(LocalDateTime time) { + return time.with(LocalTime.MIN); + } + + /** + * 修改为一天的结束时间，例如：2020-02-02 23:59:59,999 + * + * @param time 日期时间 + * @return 一天的结束时间 + */ + public static LocalDateTime endOfDay(LocalDateTime time) { + return endOfDay(time, false); + } + + /** + * 修改为一天的结束时间，例如： + *

    + *
  • 毫秒不归零：2020-02-02 23:59:59,999
    • + *
  • 毫秒归零：2020-02-02 23:59:59,000
    • + *
+ * + * @param time 日期时间 + * @param truncateMillisecond 是否毫秒归零 + * @return 一天的结束时间 + * @since 5.7.18 + */ + public static LocalDateTime endOfDay(LocalDateTime time, boolean truncateMillisecond) { + if (truncateMillisecond) { + return time.with(LocalTime.of(23, 59, 59)); + } + return time.with(LocalTime.MAX); + } + + /** + * {@link TemporalAccessor}转换为 时间戳（从1970-01-01T00:00:00Z开始的毫秒数） + * + * @param temporalAccessor Date对象 + * @return {@link Instant}对象 + * @see TemporalAccessorUtil#toEpochMilli(TemporalAccessor) + * @since 5.4.1 + */ + public static long toEpochMilli(TemporalAccessor temporalAccessor) { + return TemporalAccessorUtil.toEpochMilli(temporalAccessor); + } + + /** + * 是否为周末（周六或周日） + * + * @param localDateTime 判定的日期{@link LocalDateTime} + * @return 是否为周末（周六或周日） + * @since 5.7.6 + */ + public static boolean isWeekend(LocalDateTime localDateTime) { + return isWeekend(localDateTime.toLocalDate()); + } + + /** + * 是否为周末（周六或周日） + * + * @param localDate 判定的日期{@link LocalDate} + * @return 是否为周末（周六或周日） + * @since 5.7.6 + */ + public static boolean isWeekend(LocalDate localDate) { + final DayOfWeek dayOfWeek = localDate.getDayOfWeek(); + return DayOfWeek.SATURDAY == dayOfWeek || DayOfWeek.SUNDAY == dayOfWeek; + } + + /** + * 获取{@link LocalDate}对应的星期值 + * + * @param localDate 日期{@link LocalDate} + * @return {@link Week} + * @since 5.7.14 + */ + public static Week dayOfWeek(LocalDate localDate) { + return Week.of(localDate.getDayOfWeek()); + } + + /** + * 检查两个时间段是否有时间重叠
+ * 重叠指两个时间段是否有交集，注意此方法时间段重合时如： + *
    + *
  • 此方法未纠正开始时间小于结束时间
    • + *
  • 当realStartTime和realEndTime或startTime和endTime相等时,退化为判断区间是否包含点
    • + *
  • 当realStartTime和realEndTime和startTime和endTime相等时,退化为判断点与点是否相等
    • + *
+ * See 准确的区间关系参考:艾伦区间代数 + * @param realStartTime 第一个时间段的开始时间 + * @param realEndTime 第一个时间段的结束时间 + * @param startTime 第二个时间段的开始时间 + * @param endTime 第二个时间段的结束时间 + * @return true 表示时间有重合或包含或相等 + * @since 5.7.20 + */ + public static boolean isOverlap(ChronoLocalDateTime realStartTime, ChronoLocalDateTime realEndTime, + ChronoLocalDateTime startTime, ChronoLocalDateTime endTime) { + + // x>b||a>y 无交集 + // 则有交集的逻辑为 !(x>b||a>y) + // 根据德摩根公式，可化简为 x<=b && a<=y 即 realStartTime<=endTime && startTime<=realEndTime + return realStartTime.compareTo(endTime) <=0 && startTime.compareTo(realEndTime) <= 0; + } + + /** + * 获得指定日期是所在年份的第几周，如： + *
    + *
  • 如果一年的第一天是星期一，则第一周从第一天开始，没有零周
    • + *
  • 如果一年的第二天是星期一，则第一周从第二天开始，而第一天在零周
    • + *
  • 如果一年中的第4天是星期一，则第1周从第4周开始，第1至第3周在零周开始
    • + *
  • 如果一年中的第5天是星期一，则第二周从第5周开始，第1至第4周在第1周
    • + *
+ * + * + * @param date 日期（{@link LocalDate} 或者 {@link LocalDateTime}等） + * @return 所在年的第几周 + * @since 5.7.21 + */ + public static int weekOfYear(TemporalAccessor date){ + return TemporalAccessorUtil.get(date, WeekFields.ISO.weekOfYear()); + } + + /** + * 比较两个日期是否为同一天 + * + * @param date1 日期1 + * @param date2 日期2 + * @return 是否为同一天 + * @since 5.8.5 + */ + public static boolean isSameDay(final LocalDateTime date1, final LocalDateTime date2) { + return date1 != null && date2 != null && isSameDay(date1.toLocalDate(), date2.toLocalDate()); + } + + /** + * 比较两个日期是否为同一天 + * + * @param date1 日期1 + * @param date2 日期2 + * @return 是否为同一天 + * @since 5.8.5 + */ + public static boolean isSameDay(final LocalDate date1, final LocalDate date2) { + return date1 != null && date2 != null && date1.isEqual(date2); + } + + /** + * 当前日期是否在日期指定范围内
+ * 起始日期和结束日期可以互换 + * + * @param date 被检查的日期 + * @param beginDate 起始日期（包含） + * @param endDate 结束日期（包含） + * @return 是否在范围内 + * @since 5.8.5 + */ + public static boolean isIn(ChronoLocalDateTime date, ChronoLocalDateTime beginDate, ChronoLocalDateTime endDate) { + return TemporalAccessorUtil.isIn(date, beginDate, endDate); + } + + /** + * 判断当前时间（默认时区）是否在指定范围内
+ * 起始时间和结束时间可以互换
+ * 通过includeBegin, includeEnd参数控制时间范围区间是否为开区间，例如：传入参数：includeBegin=true, includeEnd=false， + * 则本方法会判断 date ∈ (beginDate, endDate] 是否成立 + * + * @param date 被判定的日期 + * @param beginDate 起始时间（包含） + * @param endDate 结束时间（包含） + * @param includeBegin 时间范围是否包含起始时间 + * @param includeEnd 时间范围是否包含结束时间 + * @return 是否在范围内 + * @author FengBaoheng + * @since 5.8.6 + */ + public static boolean isIn(ChronoLocalDateTime date, ChronoLocalDateTime beginDate, + ChronoLocalDateTime endDate, boolean includeBegin, boolean includeEnd) { + return TemporalAccessorUtil.isIn(date, beginDate, endDate, includeBegin, includeEnd); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/Month.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/Month.java new file mode 100644 index 0000000..f30bdfa --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/Month.java @@ -0,0 +1,246 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; + +import java.time.format.TextStyle; +import java.util.Calendar; +import java.util.Locale; + +/** + * 月份枚举
+ * 与Calendar中的月份int值对应 + * + * @author Looly + * @see Calendar#JANUARY + * @see Calendar#FEBRUARY + * @see Calendar#MARCH + * @see Calendar#APRIL + * @see Calendar#MAY + * @see Calendar#JUNE + * @see Calendar#JULY + * @see Calendar#AUGUST + * @see Calendar#SEPTEMBER + * @see Calendar#OCTOBER + * @see Calendar#NOVEMBER + * @see Calendar#DECEMBER + * @see Calendar#UNDECIMBER + */ +public enum Month { + /** + * 一月 + */ + JANUARY(Calendar.JANUARY), + /** + * 二月 + */ + FEBRUARY(Calendar.FEBRUARY), + /** + * 三月 + */ + MARCH(Calendar.MARCH), + /** + * 四月 + */ + APRIL(Calendar.APRIL), + /** + * 五月 + */ + MAY(Calendar.MAY), + /** + * 六月 + */ + JUNE(Calendar.JUNE), + /** + * 七月 + */ + JULY(Calendar.JULY), + /** + * 八月 + */ + AUGUST(Calendar.AUGUST), + /** + * 九月 + */ + SEPTEMBER(Calendar.SEPTEMBER), + /** + * 十月 + */ + OCTOBER(Calendar.OCTOBER), + /** + * 十一月 + */ + NOVEMBER(Calendar.NOVEMBER), + /** + * 十二月 + */ + DECEMBER(Calendar.DECEMBER), + /** + * 十三月，仅用于农历 + */ + UNDECIMBER(Calendar.UNDECIMBER); + + // --------------------------------------------------------------- + /** + * Months aliases. + */ + private static final String[] ALIASES = {"jan", "feb", "mar", "apr", "may", "jun", "jul", "aug", "sep", "oct", "nov", "dec"}; + private static final Month[] ENUMS = Month.values(); + + /** + * 对应值，见{@link Calendar} + */ + private final int value; + + /** + * 构造 + * + * @param value 对应值，见{@link Calendar} + */ + Month(int value) { + this.value = value; + } + + /** + * 获取{@link Calendar}中的对应值
+ * 此值从0开始，即0表示一月 + * + * @return {@link Calendar}中的对应月份值，从0开始计数 + */ + public int getValue() { + return this.value; + } + + /** + * 获取月份值，此值与{@link java.time.Month}对应
+ * 此值从1开始，即1表示一月 + * + * @return 月份值，对应{@link java.time.Month}，从1开始计数 + * @since 5.7.21 + */ + public int getValueBaseOne() { + Assert.isFalse(this == UNDECIMBER, "Unsupported UNDECIMBER Field"); + return getValue() + 1; + } + + /** + * 获取此月份最后一天的值，不支持的月份（例如UNDECIMBER）返回-1 + * + * @param isLeapYear 是否闰年 + * @return 此月份最后一天的值 + */ + public int getLastDay(boolean isLeapYear) { + switch (this) { + case FEBRUARY: + return isLeapYear ? 29 : 28; + case APRIL: + case JUNE: + case SEPTEMBER: + case NOVEMBER: + return 30; + default: + return 31; + } + } + + /** + * 将 {@link Calendar}月份相关值转换为Month枚举对象
+ * 未找到返回{@code null} + * + * @param calendarMonthIntValue Calendar中关于Month的int值，从0开始 + * @return Month + * @see Calendar#JANUARY + * @see Calendar#FEBRUARY + * @see Calendar#MARCH + * @see Calendar#APRIL + * @see Calendar#MAY + * @see Calendar#JUNE + * @see Calendar#JULY + * @see Calendar#AUGUST + * @see Calendar#SEPTEMBER + * @see Calendar#OCTOBER + * @see Calendar#NOVEMBER + * @see Calendar#DECEMBER + * @see Calendar#UNDECIMBER + */ + public static Month of(int calendarMonthIntValue) { + if (calendarMonthIntValue >= ENUMS.length || calendarMonthIntValue < 0) { + return null; + } + return ENUMS[calendarMonthIntValue]; + } + + /** + * 解析别名为Month对象，别名如：jan或者JANUARY，不区分大小写 + * + * @param name 别名值 + * @return 月份枚举Month，非空 + * @throws IllegalArgumentException 如果别名无对应的枚举，抛出此异常 + * @since 5.8.0 + */ + public static Month of(String name) throws IllegalArgumentException { + Assert.notBlank(name); + Month of = of(ArrayUtil.indexOfIgnoreCase(ALIASES, name)); + if (null == of) { + of = Month.valueOf(name.toUpperCase()); + } + return of; + } + + /** + * {@link java.time.Month}转换为Month对象 + * @param month {@link java.time.Month} + * @return Month + * @since 5.8.0 + */ + public static Month of(java.time.Month month){ + return of(month.ordinal()); + } + + /** + * 获得指定月的最后一天 + * + * @param month 月份，从0开始 + * @param isLeapYear 是否为闰年，闰年只对二月有影响 + * @return 最后一天，可能为28,29,30,31 + * @since 5.4.7 + */ + public static int getLastDay(int month, boolean isLeapYear) { + final Month of = of(month); + Assert.notNull(of, "Invalid Month base 0: " + month); + return of.getLastDay(isLeapYear); + } + + /** + * 转换为{@link java.time.Month} + * + * @return {@link java.time.Month} + * @since 5.7.21 + */ + public java.time.Month toJdkMonth() { + return java.time.Month.of(getValueBaseOne()); + } + + /** + * 获取显示名称 + * + * @param style 名称风格 + * @return 显示名称 + * @since 5.8.0 + */ + public String getDisplayName(TextStyle style) { + return getDisplayName(style, Locale.getDefault()); + } + + /** + * 获取显示名称 + * + * @param style 名称风格 + * @param locale {@link Locale} + * @return 显示名称 + * @since 5.8.0 + */ + public String getDisplayName(TextStyle style, Locale locale) { + return toJdkMonth().getDisplayName(style, locale); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/Quarter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/Quarter.java new file mode 100644 index 0000000..f1f8231 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/Quarter.java @@ -0,0 +1,61 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +/** + * 季度枚举 + * + * @see #Q1 + * @see #Q2 + * @see #Q3 + * @see #Q4 + * + * @author zhfish(https://github.com/zhfish) + * + */ +public enum Quarter { + + /** 第一季度 */ + Q1(1), + /** 第二季度 */ + Q2(2), + /** 第三季度 */ + Q3(3), + /** 第四季度 */ + Q4(4); + + // --------------------------------------------------------------- + private final int value; + + Quarter(int value) { + this.value = value; + } + + public int getValue() { + return this.value; + } + + /** + * 将 季度int转换为Season枚举对象
+ * + * @see #Q1 + * @see #Q2 + * @see #Q3 + * @see #Q4 + * + * @param intValue 季度int表示 + * @return {@link Quarter} + */ + public static Quarter of(int intValue) { + switch (intValue) { + case 1: + return Q1; + case 2: + return Q2; + case 3: + return Q3; + case 4: + return Q4; + default: + return null; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/StopWatch.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/StopWatch.java new file mode 100755 index 0000000..89cc837 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/StopWatch.java @@ -0,0 +1,485 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.text.NumberFormat; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.TimeUnit; + +/** + * 秒表封装
+ * 此工具用于存储一组任务的耗时时间，并一次性打印对比。
+ * 比如：我们可以记录多段代码耗时时间，然后一次性打印（StopWatch提供了一个prettyString()函数用于按照指定格式打印出耗时） + * + *

+ * 此工具来自：https://github.com/spring-projects/spring-framework/blob/master/spring-core/src/main/java/org/springframework/util/StopWatch.java + * + *

+ * 使用方法如下： + * + * 

+ * StopWatch stopWatch = new StopWatch("任务名称");
+ *
+ * // 任务1
+ * stopWatch.start("任务一");
+ * Thread.sleep(1000);
+ * stopWatch.stop();
+ *
+ * // 任务2
+ * stopWatch.start("任务二");
+ * Thread.sleep(2000);
+ * stopWatch.stop();
+ *
+ * // 打印出耗时
+ * Console.log(stopWatch.prettyPrint());
+ *
+ *
+ * + * @author Spring Framework, Looly + * @since 4.6.6 + */ +public class StopWatch { + + /** + * 创建计时任务（秒表） + * + * @param id 用于标识秒表的唯一ID + * @return StopWatch + * @since 5.5.2 + */ + public static StopWatch create(String id) { + return new StopWatch(id); + } + + /** + * 秒表唯一标识，用于多个秒表对象的区分 + */ + private final String id; + private List taskList; + + /** + * 任务名称 + */ + private String currentTaskName; + /** + * 开始时间 + */ + private long startTimeNanos; + + /** + * 最后一次任务对象 + */ + private TaskInfo lastTaskInfo; + /** + * 总任务数 + */ + private int taskCount; + /** + * 总运行时间 + */ + private long totalTimeNanos; + // ------------------------------------------------------------------------------------------- Constructor start + + /** + * 构造，不启动任何任务 + */ + public StopWatch() { + this(StrUtil.EMPTY); + } + + /** + * 构造，不启动任何任务 + * + * @param id 用于标识秒表的唯一ID + */ + public StopWatch(String id) { + this(id, true); + } + + /** + * 构造，不启动任何任务 + * + * @param id 用于标识秒表的唯一ID + * @param keepTaskList 是否在停止后保留任务，{@code false} 表示停止运行后不保留任务 + */ + public StopWatch(String id, boolean keepTaskList) { + this.id = id; + if (keepTaskList) { + this.taskList = new ArrayList<>(); + } + } + // ------------------------------------------------------------------------------------------- Constructor end + + /** + * 获取StopWatch 的ID，用于多个秒表对象的区分 + * + * @return the ID 默认为空字符串 + * @see #StopWatch(String) + */ + public String getId() { + return this.id; + } + + /** + * 设置是否在停止后保留任务，{@code false} 表示停止运行后不保留任务 + * + * @param keepTaskList 是否在停止后保留任务 + */ + public void setKeepTaskList(boolean keepTaskList) { + if (keepTaskList) { + if (null == this.taskList) { + this.taskList = new ArrayList<>(); + } + } else { + this.taskList = null; + } + } + + /** + * 开始默认的新任务 + * + * @throws IllegalStateException 前一个任务没有结束 + */ + public void start() throws IllegalStateException { + start(StrUtil.EMPTY); + } + + /** + * 开始指定名称的新任务 + * + * @param taskName 新开始的任务名称 + * @throws IllegalStateException 前一个任务没有结束 + */ + public void start(String taskName) throws IllegalStateException { + if (null != this.currentTaskName) { + throw new IllegalStateException("Can't start StopWatch: it's already running"); + } + this.currentTaskName = taskName; + this.startTimeNanos = System.nanoTime(); + } + + /** + * 停止当前任务 + * + * @throws IllegalStateException 任务没有开始 + */ + public void stop() throws IllegalStateException { + if (null == this.currentTaskName) { + throw new IllegalStateException("Can't stop StopWatch: it's not running"); + } + + final long lastTime = System.nanoTime() - this.startTimeNanos; + this.totalTimeNanos += lastTime; + this.lastTaskInfo = new TaskInfo(this.currentTaskName, lastTime); + if (null != this.taskList) { + this.taskList.add(this.lastTaskInfo); + } + ++this.taskCount; + this.currentTaskName = null; + } + + /** + * 检查是否有正在运行的任务 + * + * @return 是否有正在运行的任务 + * @see #currentTaskName() + */ + public boolean isRunning() { + return (this.currentTaskName != null); + } + + /** + * 获取当前任务名，{@code null} 表示无任务 + * + * @return 当前任务名，{@code null} 表示无任务 + * @see #isRunning() + */ + public String currentTaskName() { + return this.currentTaskName; + } + + /** + * 获取最后任务的花费时间（纳秒） + * + * @return 任务的花费时间（纳秒） + * @throws IllegalStateException 无任务 + */ + public long getLastTaskTimeNanos() throws IllegalStateException { + if (this.lastTaskInfo == null) { + throw new IllegalStateException("No tasks run: can't get last task interval"); + } + return this.lastTaskInfo.getTimeNanos(); + } + + /** + * 获取最后任务的花费时间（毫秒） + * + * @return 任务的花费时间（毫秒） + * @throws IllegalStateException 无任务 + */ + public long getLastTaskTimeMillis() throws IllegalStateException { + if (this.lastTaskInfo == null) { + throw new IllegalStateException("No tasks run: can't get last task interval"); + } + return this.lastTaskInfo.getTimeMillis(); + } + + /** + * 获取最后的任务名 + * + * @return 任务名 + * @throws IllegalStateException 无任务 + */ + public String getLastTaskName() throws IllegalStateException { + if (this.lastTaskInfo == null) { + throw new IllegalStateException("No tasks run: can't get last task name"); + } + return this.lastTaskInfo.getTaskName(); + } + + /** + * 获取最后的任务对象 + * + * @return {@link TaskInfo} 任务对象，包括任务名和花费时间 + * @throws IllegalStateException 无任务 + */ + public TaskInfo getLastTaskInfo() throws IllegalStateException { + if (this.lastTaskInfo == null) { + throw new IllegalStateException("No tasks run: can't get last task info"); + } + return this.lastTaskInfo; + } + + /** + * 获取所有任务的总花费时间 + * + * @param unit 时间单位，{@code null}表示默认{@link TimeUnit#NANOSECONDS} + * @return 花费时间 + * @since 5.7.16 + */ + public long getTotal(TimeUnit unit){ + return unit.convert(this.totalTimeNanos, TimeUnit.NANOSECONDS); + } + + /** + * 获取所有任务的总花费时间（纳秒） + * + * @return 所有任务的总花费时间（纳秒） + * @see #getTotalTimeMillis() + * @see #getTotalTimeSeconds() + */ + public long getTotalTimeNanos() { + return this.totalTimeNanos; + } + + /** + * 获取所有任务的总花费时间（毫秒） + * + * @return 所有任务的总花费时间（毫秒） + * @see #getTotalTimeNanos() + * @see #getTotalTimeSeconds() + */ + public long getTotalTimeMillis() { + return getTotal(TimeUnit.MILLISECONDS); + } + + /** + * 获取所有任务的总花费时间（秒） + * + * @return 所有任务的总花费时间（秒） + * @see #getTotalTimeNanos() + * @see #getTotalTimeMillis() + */ + public double getTotalTimeSeconds() { + return DateUtil.nanosToSeconds(this.totalTimeNanos); + } + + /** + * 获取任务数 + * + * @return 任务数 + */ + public int getTaskCount() { + return this.taskCount; + } + + /** + * 获取任务列表 + * + * @return 任务列表 + */ + public TaskInfo[] getTaskInfo() { + if (null == this.taskList) { + throw new UnsupportedOperationException("Task info is not being kept!"); + } + return this.taskList.toArray(new TaskInfo[0]); + } + + /** + * 获取任务信息，类似于： + * 
+	 *     StopWatch '[id]': running time = [total] ns
+	 *
+ * + * @return 任务信息 + */ + public String shortSummary() { + return shortSummary(null); + } + + /** + * 获取任务信息，类似于： + * 
+	 *     StopWatch '[id]': running time = [total] [unit]
+	 *
+ * + * @param unit 时间单位，{@code null}则默认为{@link TimeUnit#NANOSECONDS} + * @return 任务信息 + */ + public String shortSummary(TimeUnit unit) { + if(null == unit){ + unit = TimeUnit.NANOSECONDS; + } + return StrUtil.format("StopWatch '{}': running time = {} {}", + this.id, getTotal(unit), DateUtil.getShotName(unit)); + } + + /** + * 生成所有任务的一个任务花费时间表，单位纳秒 + * + * @return 任务时间表 + */ + public String prettyPrint() { + return prettyPrint(null); + } + + /** + * 生成所有任务的一个任务花费时间表 + * + * @param unit 时间单位，{@code null}则默认{@link TimeUnit#NANOSECONDS} 纳秒 + * @return 任务时间表 + * @since 5.7.16 + */ + public String prettyPrint(TimeUnit unit) { + if (null == unit) { + unit = TimeUnit.NANOSECONDS; + } + + final StringBuilder sb = new StringBuilder(shortSummary(unit)); + sb.append(FileUtil.getLineSeparator()); + if (null == this.taskList) { + sb.append("No task info kept"); + } else { + sb.append("---------------------------------------------").append(FileUtil.getLineSeparator()); + sb.append(DateUtil.getShotName(unit)).append(" % Task name").append(FileUtil.getLineSeparator()); + sb.append("---------------------------------------------").append(FileUtil.getLineSeparator()); + + final NumberFormat nf = NumberFormat.getNumberInstance(); + nf.setMinimumIntegerDigits(9); + nf.setGroupingUsed(false); + + final NumberFormat pf = NumberFormat.getPercentInstance(); + pf.setMinimumIntegerDigits(2); + pf.setGroupingUsed(false); + + for (TaskInfo task : getTaskInfo()) { + sb.append(nf.format(task.getTime(unit))).append(" "); + sb.append(pf.format((double) task.getTimeNanos() / getTotalTimeNanos())).append(" "); + sb.append(task.getTaskName()).append(FileUtil.getLineSeparator()); + } + } + return sb.toString(); + } + + @Override + public String toString() { + final StringBuilder sb = new StringBuilder(shortSummary()); + if (null != this.taskList) { + for (TaskInfo task : this.taskList) { + sb.append("; [").append(task.getTaskName()).append("] took ").append(task.getTimeNanos()).append(" ns"); + long percent = Math.round(100.0 * task.getTimeNanos() / getTotalTimeNanos()); + sb.append(" = ").append(percent).append("%"); + } + } else { + sb.append("; no task info kept"); + } + return sb.toString(); + } + + /** + * 存放任务名称和花费时间对象 + * + * @author Looly + */ + public static final class TaskInfo { + + private final String taskName; + private final long timeNanos; + + /** + * 构造 + * + * @param taskName 任务名称 + * @param timeNanos 花费时间（纳秒） + */ + TaskInfo(String taskName, long timeNanos) { + this.taskName = taskName; + this.timeNanos = timeNanos; + } + + /** + * 获取任务名 + * + * @return 任务名 + */ + public String getTaskName() { + return this.taskName; + } + + /** + * 获取指定单位的任务花费时间 + * + * @param unit 单位 + * @return 任务花费时间 + * @since 5.7.16 + */ + public long getTime(TimeUnit unit) { + return unit.convert(this.timeNanos, TimeUnit.NANOSECONDS); + } + + /** + * 获取任务花费时间（单位：纳秒） + * + * @return 任务花费时间（单位：纳秒） + * @see #getTimeMillis() + * @see #getTimeSeconds() + */ + public long getTimeNanos() { + return this.timeNanos; + } + + /** + * 获取任务花费时间（单位：毫秒） + * + * @return 任务花费时间（单位：毫秒） + * @see #getTimeNanos() + * @see #getTimeSeconds() + */ + public long getTimeMillis() { + return getTime(TimeUnit.MILLISECONDS); + } + + /** + * 获取任务花费时间（单位：秒） + * + * @return 任务花费时间（单位：秒） + * @see #getTimeMillis() + * @see #getTimeNanos() + */ + public double getTimeSeconds() { + return DateUtil.nanosToSeconds(this.timeNanos); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/SystemClock.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/SystemClock.java new file mode 100644 index 0000000..25e87d6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/SystemClock.java @@ -0,0 +1,77 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import java.sql.Timestamp; +import java.util.concurrent.Executors; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; + +/** + * 系统时钟
+ * 高并发场景下System.currentTimeMillis()的性能问题的优化 + * System.currentTimeMillis()的调用比new一个普通对象要耗时的多（具体耗时高出多少我还没测试过，有人说是100倍左右） + * System.currentTimeMillis()之所以慢是因为去跟系统打了一次交道 + * 后台定时更新时钟，JVM退出时，线程自动回收 + * + * see： http://git.oschina.net/yu120/sequence + * @author lry,looly + */ +public class SystemClock { + + /** 时钟更新间隔，单位毫秒 */ + private final long period; + /** 现在时刻的毫秒数 */ + private volatile long now; + + /** + * 构造 + * @param period 时钟更新间隔，单位毫秒 + */ + public SystemClock(long period) { + this.period = period; + this.now = System.currentTimeMillis(); + scheduleClockUpdating(); + } + + /** + * 开启计时器线程 + */ + private void scheduleClockUpdating() { + ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor(runnable -> { + Thread thread = new Thread(runnable, "System Clock"); + thread.setDaemon(true); + return thread; + }); + scheduler.scheduleAtFixedRate(() -> now = System.currentTimeMillis(), period, period, TimeUnit.MILLISECONDS); + } + + /** + * @return 当前时间毫秒数 + */ + private long currentTimeMillis() { + return now; + } + + //------------------------------------------------------------------------ static + /** + * 单例 + * @author Looly + * + */ + private static class InstanceHolder { + public static final SystemClock INSTANCE = new SystemClock(1); + } + + /** + * @return 当前时间 + */ + public static long now() { + return InstanceHolder.INSTANCE.currentTimeMillis(); + } + + /** + * @return 当前时间字符串表现形式 + */ + public static String nowDate() { + return new Timestamp(InstanceHolder.INSTANCE.currentTimeMillis()).toString(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/TemporalAccessorUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/TemporalAccessorUtil.java new file mode 100644 index 0000000..82845f6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/TemporalAccessorUtil.java @@ -0,0 +1,228 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.date.format.GlobalCustomFormat; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.time.DayOfWeek; +import java.time.Instant; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.time.LocalTime; +import java.time.Month; +import java.time.MonthDay; +import java.time.OffsetDateTime; +import java.time.OffsetTime; +import java.time.ZoneId; +import java.time.ZonedDateTime; +import java.time.chrono.Era; +import java.time.format.DateTimeFormatter; +import java.time.temporal.TemporalAccessor; +import java.time.temporal.TemporalField; +import java.time.temporal.UnsupportedTemporalTypeException; + +/** + * {@link TemporalAccessor} 工具类封装 + * + * @author looly + * @since 5.3.9 + */ +public class TemporalAccessorUtil extends TemporalUtil{ + + /** + * 安全获取时间的某个属性，属性不存在返回最小值，一般为0
+ * 注意请谨慎使用此方法，某些{@link TemporalAccessor#isSupported(TemporalField)}为{@code false}的方法返回最小值 + * + * @param temporalAccessor 需要获取的时间对象 + * @param field 需要获取的属性 + * @return 时间的值，如果无法获取则获取最小值，一般为0 + */ + public static int get(TemporalAccessor temporalAccessor, TemporalField field) { + if (temporalAccessor.isSupported(field)) { + return temporalAccessor.get(field); + } + + return (int)field.range().getMinimum(); + } + + /** + * 格式化日期时间为指定格式
+ * 如果为{@link Month}，调用{@link Month#toString()} + * + * @param time {@link TemporalAccessor} + * @param formatter 日期格式化器，预定义的格式见：{@link DateTimeFormatter} + * @return 格式化后的字符串 + * @since 5.3.10 + */ + public static String format(TemporalAccessor time, DateTimeFormatter formatter) { + if (null == time) { + return null; + } + + if(time instanceof Month){ + return time.toString(); + } + + if(null == formatter){ + formatter = DateTimeFormatter.ISO_LOCAL_DATE_TIME; + } + + try { + return formatter.format(time); + } catch (UnsupportedTemporalTypeException e){ + if(time instanceof LocalDate && e.getMessage().contains("HourOfDay")){ + // 用户传入LocalDate，但是要求格式化带有时间部分，转换为LocalDateTime重试 + return formatter.format(((LocalDate) time).atStartOfDay()); + }else if(time instanceof LocalTime && e.getMessage().contains("YearOfEra")){ + // 用户传入LocalTime，但是要求格式化带有日期部分，转换为LocalDateTime重试 + return formatter.format(((LocalTime) time).atDate(LocalDate.now())); + } else if(time instanceof Instant){ + // 时间戳没有时区信息，赋予默认时区 + return formatter.format(((Instant) time).atZone(ZoneId.systemDefault())); + } + throw e; + } + } + + /** + * 格式化日期时间为指定格式
+ * 如果为{@link Month}，调用{@link Month#toString()} + * + * @param time {@link TemporalAccessor} + * @param format 日期格式 + * @return 格式化后的字符串 + * @since 5.3.10 + */ + public static String format(TemporalAccessor time, String format) { + if (null == time) { + return null; + } + + if(time instanceof DayOfWeek || time instanceof java.time.Month || time instanceof Era || time instanceof MonthDay){ + return time.toString(); + } + + // 检查自定义格式 + if(GlobalCustomFormat.isCustomFormat(format)){ + return GlobalCustomFormat.format(time, format); + } + + final DateTimeFormatter formatter = StrUtil.isBlank(format) + ? null : DateTimeFormatter.ofPattern(format); + + return format(time, formatter); + } + + /** + * {@link TemporalAccessor}转换为 时间戳（从1970-01-01T00:00:00Z开始的毫秒数）
+ * 如果为{@link Month}，调用{@link Month#getValue()} + * + * @param temporalAccessor Date对象 + * @return {@link Instant}对象 + * @since 5.4.1 + */ + public static long toEpochMilli(TemporalAccessor temporalAccessor) { + if(temporalAccessor instanceof Month){ + return ((Month) temporalAccessor).getValue(); + } else if(temporalAccessor instanceof DayOfWeek){ + return ((DayOfWeek) temporalAccessor).getValue(); + } else if(temporalAccessor instanceof Era){ + return ((Era) temporalAccessor).getValue(); + } + return toInstant(temporalAccessor).toEpochMilli(); + } + + /** + * {@link TemporalAccessor}转换为 {@link Instant}对象 + * + * @param temporalAccessor Date对象 + * @return {@link Instant}对象 + * @since 5.3.10 + */ + public static Instant toInstant(TemporalAccessor temporalAccessor) { + if (null == temporalAccessor) { + return null; + } + + Instant result; + if (temporalAccessor instanceof Instant) { + result = (Instant) temporalAccessor; + } else if (temporalAccessor instanceof LocalDateTime) { + result = ((LocalDateTime) temporalAccessor).atZone(ZoneId.systemDefault()).toInstant(); + } else if (temporalAccessor instanceof ZonedDateTime) { + result = ((ZonedDateTime) temporalAccessor).toInstant(); + } else if (temporalAccessor instanceof OffsetDateTime) { + result = ((OffsetDateTime) temporalAccessor).toInstant(); + } else if (temporalAccessor instanceof LocalDate) { + result = ((LocalDate) temporalAccessor).atStartOfDay(ZoneId.systemDefault()).toInstant(); + } else if (temporalAccessor instanceof LocalTime) { + // 指定本地时间转换 为Instant，取当天日期 + result = ((LocalTime) temporalAccessor).atDate(LocalDate.now()).atZone(ZoneId.systemDefault()).toInstant(); + } else if (temporalAccessor instanceof OffsetTime) { + // 指定本地时间转换 为Instant，取当天日期 + result = ((OffsetTime) temporalAccessor).atDate(LocalDate.now()).toInstant(); + } else { + // issue#1891@Github + // Instant.from不能完成日期转换 + //result = Instant.from(temporalAccessor); + result = toInstant(LocalDateTimeUtil.of(temporalAccessor)); + } + + return result; + } + + /** + * 当前日期是否在日期指定范围内
+ * 起始日期和结束日期可以互换 + * + * @param date 被检查的日期 + * @param beginDate 起始日期（包含） + * @param endDate 结束日期（包含） + * @return 是否在范围内 + * @since 5.8.5 + */ + public static boolean isIn(TemporalAccessor date, TemporalAccessor beginDate, TemporalAccessor endDate) { + return isIn(date, beginDate, endDate, true, true); + } + + /** + * 当前日期是否在日期指定范围内
+ * 起始日期和结束日期可以互换
+ * 通过includeBegin, includeEnd参数控制日期范围区间是否为开区间，例如：传入参数：includeBegin=true, includeEnd=false， + * 则本方法会判断 date ∈ (beginDate, endDate] 是否成立 + * + * @param date 被检查的日期 + * @param beginDate 起始日期 + * @param endDate 结束日期 + * @param includeBegin 时间范围是否包含起始日期 + * @param includeEnd 时间范围是否包含结束日期 + * @return 是否在范围内 + * @author FengBaoheng + * @since 5.8.6 + */ + public static boolean isIn(TemporalAccessor date, TemporalAccessor beginDate, TemporalAccessor endDate, + boolean includeBegin, boolean includeEnd) { + if (date == null || beginDate == null || endDate == null) { + throw new IllegalArgumentException("参数不可为null"); + } + + final long thisMills = toEpochMilli(date); + final long beginMills = toEpochMilli(beginDate); + final long endMills = toEpochMilli(endDate); + final long rangeMin = Math.min(beginMills, endMills); + final long rangeMax = Math.max(beginMills, endMills); + + // 先判断是否满足 date ∈ (beginDate, endDate) + boolean isIn = rangeMin < thisMills && thisMills < rangeMax; + + // 若不满足，则再判断是否在时间范围的边界上 + if (!isIn && includeBegin) { + isIn = thisMills == rangeMin; + } + + if (!isIn && includeEnd) { + isIn = thisMills == rangeMax; + } + + return isIn; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/TemporalUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/TemporalUtil.java new file mode 100644 index 0000000..fd90301 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/TemporalUtil.java @@ -0,0 +1,141 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import java.time.DayOfWeek; +import java.time.Duration; +import java.time.temporal.ChronoUnit; +import java.time.temporal.Temporal; +import java.time.temporal.TemporalAdjusters; +import java.time.temporal.TemporalUnit; +import java.util.concurrent.TimeUnit; + +/** + * {@link Temporal} 工具类封装 + * + * @author looly + * @since 5.4.5 + */ +public class TemporalUtil { + + /** + * 获取两个日期的差，如果结束时间早于开始时间，获取结果为负。 + *

+ * 返回结果为{@link Duration}对象，通过调用toXXX方法返回相差单位 + * + * @param startTimeInclude 开始时间（包含） + * @param endTimeExclude 结束时间（不包含） + * @return 时间差 {@link Duration}对象 + */ + public static Duration between(Temporal startTimeInclude, Temporal endTimeExclude) { + return Duration.between(startTimeInclude, endTimeExclude); + } + + /** + * 获取两个日期的差，如果结束时间早于开始时间，获取结果为负。 + *

+ * 返回结果为时间差的long值 + * + * @param startTimeInclude 开始时间（包括） + * @param endTimeExclude 结束时间（不包括） + * @param unit 时间差单位 + * @return 时间差 + */ + public static long between(Temporal startTimeInclude, Temporal endTimeExclude, ChronoUnit unit) { + return unit.between(startTimeInclude, endTimeExclude); + } + + /** + * 将 {@link TimeUnit} 转换为 {@link ChronoUnit}. + * + * @param unit 被转换的{@link TimeUnit}单位，如果为{@code null}返回{@code null} + * @return {@link ChronoUnit} + * @since 5.7.16 + */ + public static ChronoUnit toChronoUnit(TimeUnit unit) throws IllegalArgumentException { + if (null == unit) { + return null; + } + switch (unit) { + case NANOSECONDS: + return ChronoUnit.NANOS; + case MICROSECONDS: + return ChronoUnit.MICROS; + case MILLISECONDS: + return ChronoUnit.MILLIS; + case SECONDS: + return ChronoUnit.SECONDS; + case MINUTES: + return ChronoUnit.MINUTES; + case HOURS: + return ChronoUnit.HOURS; + case DAYS: + return ChronoUnit.DAYS; + default: + throw new IllegalArgumentException("Unknown TimeUnit constant"); + } + } + + /** + * 转换 {@link ChronoUnit} 到 {@link TimeUnit}. + * + * @param unit {@link ChronoUnit}，如果为{@code null}返回{@code null} + * @return {@link TimeUnit} + * @throws IllegalArgumentException 如果{@link TimeUnit}没有对应单位抛出 + * @since 5.7.16 + */ + public static TimeUnit toTimeUnit(ChronoUnit unit) throws IllegalArgumentException { + if (null == unit) { + return null; + } + switch (unit) { + case NANOS: + return TimeUnit.NANOSECONDS; + case MICROS: + return TimeUnit.MICROSECONDS; + case MILLIS: + return TimeUnit.MILLISECONDS; + case SECONDS: + return TimeUnit.SECONDS; + case MINUTES: + return TimeUnit.MINUTES; + case HOURS: + return TimeUnit.HOURS; + case DAYS: + return TimeUnit.DAYS; + default: + throw new IllegalArgumentException("ChronoUnit cannot be converted to TimeUnit: " + unit); + } + } + + /** + * 日期偏移,根据field不同加不同值（偏移会修改传入的对象） + * + * @param 日期类型，如LocalDate或LocalDateTime + * @param time {@link Temporal} + * @param number 偏移量，正数为向后偏移，负数为向前偏移 + * @param field 偏移单位，见{@link ChronoUnit}，不能为null + * @return 偏移后的日期时间 + */ + @SuppressWarnings("unchecked") + public static T offset(T time, long number, TemporalUnit field) { + if (null == time) { + return null; + } + + return (T) time.plus(number, field); + } + + /** + * 偏移到指定的周几 + * + * @param temporal 日期或者日期时间 + * @param dayOfWeek 周几 + * @param 日期类型，如LocalDate或LocalDateTime + * @param isPrevious 是否向前偏移，{@code true}向前偏移，{@code false}向后偏移。 + * @return 偏移后的日期 + * @since 5.8.0 + */ + @SuppressWarnings("unchecked") + public T offset(T temporal, DayOfWeek dayOfWeek, boolean isPrevious) { + return (T) temporal.with(isPrevious ? TemporalAdjusters.previous(dayOfWeek) : TemporalAdjusters.next(dayOfWeek)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/TimeInterval.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/TimeInterval.java new file mode 100644 index 0000000..44e6546 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/TimeInterval.java @@ -0,0 +1,133 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 计时器
+ * 计算某个过程花费的时间，精确到毫秒或纳秒 + * + * @author Looly + */ +public class TimeInterval extends GroupTimeInterval { + private static final long serialVersionUID = 1L; + private static final String DEFAULT_ID = StrUtil.EMPTY; + + /** + * 构造，默认使用毫秒计数 + */ + public TimeInterval() { + this(false); + } + + /** + * 构造 + * + * @param isNano 是否使用纳秒计数，false则使用毫秒 + */ + public TimeInterval(boolean isNano) { + super(isNano); + start(); + } + + /** + * @return 开始计时并返回当前时间 + */ + public long start() { + return start(DEFAULT_ID); + } + + /** + * @return 重新计时并返回从开始到当前的持续时间 + */ + public long intervalRestart() { + return intervalRestart(DEFAULT_ID); + } + + /** + * 重新开始计算时间（重置开始时间） + * + * @return this + * @see #start() + * @since 3.0.1 + */ + public TimeInterval restart() { + start(DEFAULT_ID); + return this; + } + + //----------------------------------------------------------- Interval + + /** + * 从开始到当前的间隔时间（毫秒数）
+ * 如果使用纳秒计时，返回纳秒差，否则返回毫秒差 + * + * @return 从开始到当前的间隔时间（毫秒数） + */ + public long interval() { + return interval(DEFAULT_ID); + } + + /** + * 从开始到当前的间隔时间（毫秒数），返回XX天XX小时XX分XX秒XX毫秒 + * + * @return 从开始到当前的间隔时间（毫秒数） + * @since 4.6.7 + */ + public String intervalPretty() { + return intervalPretty(DEFAULT_ID); + } + + /** + * 从开始到当前的间隔时间（毫秒数） + * + * @return 从开始到当前的间隔时间（毫秒数） + */ + public long intervalMs() { + return intervalMs(DEFAULT_ID); + } + + /** + * 从开始到当前的间隔秒数，取绝对值 + * + * @return 从开始到当前的间隔秒数，取绝对值 + */ + public long intervalSecond() { + return intervalSecond(DEFAULT_ID); + } + + /** + * 从开始到当前的间隔分钟数，取绝对值 + * + * @return 从开始到当前的间隔分钟数，取绝对值 + */ + public long intervalMinute() { + return intervalMinute(DEFAULT_ID); + } + + /** + * 从开始到当前的间隔小时数，取绝对值 + * + * @return 从开始到当前的间隔小时数，取绝对值 + */ + public long intervalHour() { + return intervalHour(DEFAULT_ID); + } + + /** + * 从开始到当前的间隔天数，取绝对值 + * + * @return 从开始到当前的间隔天数，取绝对值 + */ + public long intervalDay() { + return intervalDay(DEFAULT_ID); + } + + /** + * 从开始到当前的间隔周数，取绝对值 + * + * @return 从开始到当前的间隔周数，取绝对值 + */ + public long intervalWeek() { + return intervalWeek(DEFAULT_ID); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/Week.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/Week.java new file mode 100755 index 0000000..4f92d1c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/Week.java @@ -0,0 +1,205 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; + +import java.time.DayOfWeek; +import java.util.Calendar; + +/** + * 星期枚举
+ * 与Calendar中的星期int值对应 + * + * @author Looly + * @see #SUNDAY + * @see #MONDAY + * @see #TUESDAY + * @see #WEDNESDAY + * @see #THURSDAY + * @see #FRIDAY + * @see #SATURDAY + */ +public enum Week { + + /** + * 周日 + */ + SUNDAY(Calendar.SUNDAY), + /** + * 周一 + */ + MONDAY(Calendar.MONDAY), + /** + * 周二 + */ + TUESDAY(Calendar.TUESDAY), + /** + * 周三 + */ + WEDNESDAY(Calendar.WEDNESDAY), + /** + * 周四 + */ + THURSDAY(Calendar.THURSDAY), + /** + * 周五 + */ + FRIDAY(Calendar.FRIDAY), + /** + * 周六 + */ + SATURDAY(Calendar.SATURDAY); + + // --------------------------------------------------------------- + /** + * Weeks aliases. + */ + private static final String[] ALIASES = {"sun", "mon", "tue", "wed", "thu", "fri", "sat"}; + private static final Week[] ENUMS = Week.values(); + + /** + * 星期对应{@link Calendar} 中的Week值 + */ + private final int value; + + /** + * 构造 + * + * @param value 星期对应{@link Calendar} 中的Week值 + */ + Week(int value) { + this.value = value; + } + + /** + * 获得星期对应{@link Calendar} 中的Week值 + * + * @return 星期对应 {@link Calendar} 中的Week值 + */ + public int getValue() { + return this.value; + } + + /** + * 获取ISO8601规范的int值，from 1 (Monday) to 7 (Sunday). + * + * @return ISO8601规范的int值 + * @since 5.8.0 + */ + public int getIso8601Value(){ + int iso8601IntValue = getValue() -1; + if(0 == iso8601IntValue){ + iso8601IntValue = 7; + } + return iso8601IntValue; + } + + /** + * 转换为中文名 + * + * @return 星期的中文名 + * @since 3.3.0 + */ + public String toChinese() { + return toChinese("星期"); + } + + /** + * 转换为中文名 + * + * @param weekNamePre 表示星期的前缀，例如前缀为“星期”，则返回结果为“星期一”；前缀为”周“，结果为“周一” + * @return 星期的中文名 + * @since 4.0.11 + */ + public String toChinese(String weekNamePre) { + switch (this) { + case SUNDAY: + return weekNamePre + "日"; + case MONDAY: + return weekNamePre + "一"; + case TUESDAY: + return weekNamePre + "二"; + case WEDNESDAY: + return weekNamePre + "三"; + case THURSDAY: + return weekNamePre + "四"; + case FRIDAY: + return weekNamePre + "五"; + case SATURDAY: + return weekNamePre + "六"; + default: + return null; + } + } + + /** + * 转换为{@link DayOfWeek} + * + * @return {@link DayOfWeek} + * @since 5.8.0 + */ + public DayOfWeek toJdkDayOfWeek() { + return DayOfWeek.of(getIso8601Value()); + } + + /** + * 将 {@link Calendar}星期相关值转换为Week枚举对象
+ * + * @param calendarWeekIntValue Calendar中关于Week的int值，1表示Sunday + * @return Week + * @see #SUNDAY + * @see #MONDAY + * @see #TUESDAY + * @see #WEDNESDAY + * @see #THURSDAY + * @see #FRIDAY + * @see #SATURDAY + */ + public static Week of(int calendarWeekIntValue) { + if (calendarWeekIntValue > ENUMS.length || calendarWeekIntValue < 1) { + return null; + } + return ENUMS[calendarWeekIntValue - 1]; + } + + /** + * 解析别名为Week对象，别名如：sun或者SUNDAY，不区分大小写 + * + * @param name 别名值 + * @return 周枚举Week，非空 + * @throws IllegalArgumentException 如果别名无对应的枚举，抛出此异常 + * @since 5.8.0 + */ + public static Week of(String name) throws IllegalArgumentException { + Assert.notBlank(name); + Week of = of(ArrayUtil.indexOfIgnoreCase(ALIASES, name) + 1); + if (null == of) { + of = Week.valueOf(name.toUpperCase()); + } + return of; + } + + /** + * 将 {@link DayOfWeek}星期相关值转换为Week枚举对象
+ * + * @param dayOfWeek DayOfWeek星期值 + * @return Week + * @see #SUNDAY + * @see #MONDAY + * @see #TUESDAY + * @see #WEDNESDAY + * @see #THURSDAY + * @see #FRIDAY + * @see #SATURDAY + * @since 5.7.14 + */ + public static Week of(DayOfWeek dayOfWeek) { + Assert.notNull(dayOfWeek); + int week = dayOfWeek.getValue() + 1; + if(8 == week){ + // 周日 + week = 1; + } + return of(week); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/Zodiac.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/Zodiac.java new file mode 100644 index 0000000..bf9d7da --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/Zodiac.java @@ -0,0 +1,103 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import java.util.Calendar; +import java.util.Date; + +/** + * 星座 来自：https://blog.csdn.net/u010758605/article/details/48317881 + * + * @author looly + * @since 4.4.3 + */ +public class Zodiac { + + /** 星座分隔时间日 */ + private static final int[] DAY_ARR = new int[] { 20, 19, 21, 20, 21, 22, 23, 23, 23, 24, 23, 22 }; + /** 星座 */ + private static final String[] ZODIACS = new String[] { "摩羯座", "水瓶座", "双鱼座", "白羊座", "金牛座", "双子座", "巨蟹座", "狮子座", "处女座", "天秤座", "天蝎座", "射手座", "摩羯座" }; + private static final String[] CHINESE_ZODIACS = new String[] { "鼠", "牛", "虎", "兔", "龙", "蛇", "马", "羊", "猴", "鸡", "狗", "猪" }; + + /** + * 通过生日计算星座 + * + * @param date 出生日期 + * @return 星座名 + */ + public static String getZodiac(Date date) { + return getZodiac(DateUtil.calendar(date)); + } + + /** + * 通过生日计算星座 + * + * @param calendar 出生日期 + * @return 星座名 + */ + public static String getZodiac(Calendar calendar) { + if (null == calendar) { + return null; + } + return getZodiac(calendar.get(Calendar.MONTH), calendar.get(Calendar.DAY_OF_MONTH)); + } + + /** + * 通过生日计算星座 + * + * @param month 月，从0开始计数 + * @param day 天 + * @return 星座名 + * @since 4.5.0 + */ + public static String getZodiac(Month month, int day) { + return getZodiac(month.getValue(), day); + } + + /** + * 通过生日计算星座 + * + * @param month 月，从0开始计数，见{@link Month#getValue()} + * @param day 天 + * @return 星座名 + */ + public static String getZodiac(int month, int day) { + // 在分隔日前为前一个星座，否则为后一个星座 + return day < DAY_ARR[month] ? ZODIACS[month] : ZODIACS[month + 1]; + } + + // ----------------------------------------------------------------------------------------------------------- 生肖 + /** + * 通过生日计算生肖，只计算1900年后出生的人 + * + * @param date 出生日期（年需农历） + * @return 星座名 + */ + public static String getChineseZodiac(Date date) { + return getChineseZodiac(DateUtil.calendar(date)); + } + + /** + * 通过生日计算生肖，只计算1900年后出生的人 + * + * @param calendar 出生日期（年需农历） + * @return 星座名 + */ + public static String getChineseZodiac(Calendar calendar) { + if (null == calendar) { + return null; + } + return getChineseZodiac(calendar.get(Calendar.YEAR)); + } + + /** + * 计算生肖，只计算1900年后出生的人 + * + * @param year 农历年 + * @return 生肖名 + */ + public static String getChineseZodiac(int year) { + if (year < 1900) { + return null; + } + return CHINESE_ZODIACS[(year - 1900) % CHINESE_ZODIACS.length]; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/ZoneUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/ZoneUtil.java new file mode 100644 index 0000000..11b1e36 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/ZoneUtil.java @@ -0,0 +1,41 @@ +package aiyh.utils.tool.cn.hutool.core.date; + +import java.time.ZoneId; +import java.util.TimeZone; + +/** + * {@link ZoneId}和{@link TimeZone}相关封装 + * + * @author looly + * @since 5.7.15 + */ +public class ZoneUtil { + + /** + * {@link ZoneId}转换为{@link TimeZone}，{@code null}则返回系统默认值 + * + * @param zoneId {@link ZoneId}，{@code null}则返回系统默认值 + * @return {@link TimeZone} + */ + public static TimeZone toTimeZone(ZoneId zoneId) { + if (null == zoneId) { + return TimeZone.getDefault(); + } + + return TimeZone.getTimeZone(zoneId); + } + + /** + * {@link TimeZone}转换为{@link ZoneId}，{@code null}则返回系统默认值 + * + * @param timeZone {@link TimeZone}，{@code null}则返回系统默认值 + * @return {@link ZoneId} + */ + public static ZoneId toZoneId(TimeZone timeZone) { + if (null == timeZone) { + return ZoneId.systemDefault(); + } + + return timeZone.toZoneId(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/ChineseMonth.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/ChineseMonth.java new file mode 100644 index 0000000..41da87e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/ChineseMonth.java @@ -0,0 +1,39 @@ +package aiyh.utils.tool.cn.hutool.core.date.chinese; + +/** + * 农历月份表示 + * + * @author looly + * @since 5.4.1 + */ +public class ChineseMonth { + + private static final String[] MONTH_NAME = {"一", "二", "三", "四", "五", "六", "七", "八", "九", "十", "十一", "十二"}; + private static final String[] MONTH_NAME_TRADITIONAL = {"正", "二", "三", "四", "五", "六", "七", "八", "九", "寒", "冬", "腊"}; + + /** + * 当前农历月份是否为闰月 + * + * @param year 农历年 + * @param month 农历月 + * @return 是否为闰月 + * @since 5.4.2 + */ + public static boolean isLeapMonth(int year, int month) { + return month == LunarInfo.leapMonth(year); + } + + /** + * 获得农历月称呼
+ * 当为传统表示时，表示为二月，腊月，或者润正月等 + * 当为非传统表示时，二月，十二月，或者润一月等 + * + * @param isLeapMonth 是否闰月 + * @param month 月份，从1开始，如果是闰月，应传入需要显示的月份 + * @param isTraditional 是否传统表示，例如一月传统表示为正月 + * @return 返回农历月份称呼 + */ + public static String getChineseMonthName(boolean isLeapMonth, int month, boolean isTraditional) { + return (isLeapMonth ? "闰" : "") + (isTraditional ? MONTH_NAME_TRADITIONAL : MONTH_NAME)[month - 1] + "月"; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/GanZhi.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/GanZhi.java new file mode 100644 index 0000000..41d1b7b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/GanZhi.java @@ -0,0 +1,81 @@ +package aiyh.utils.tool.cn.hutool.core.date.chinese; + +import java.time.LocalDate; + +/** + * 天干地支类 + * 天干地支，简称为干支 + * + * @author looly + * @since 5.4.1 + */ +public class GanZhi { + + /** + * 十天干：甲（jiǎ）、乙（yǐ）、丙（bǐng）、丁（dīng）、戊（wù）、己（jǐ）、庚（gēng）、辛（xīn）、壬（rén）、癸（guǐ） + * 十二地支：子（zǐ）、丑（chǒu）、寅（yín）、卯（mǎo）、辰（chén）、巳（sì）、午（wǔ）、未（wèi）、申（shēn）、酉（yǒu）、戌（xū）、亥（hài） + * 十二地支对应十二生肖:子-鼠，丑-牛，寅-虎，卯-兔，辰-龙，巳-蛇， 午-马，未-羊，申-猴，酉-鸡，戌-狗，亥-猪 + * + * @see 天干地支：简称，干支 + */ + private static final String[] GAN = new String[]{"甲", "乙", "丙", "丁", "戊", "己", "庚", "辛", "壬", "癸"}; + private static final String[] ZHI = new String[]{"子", "丑", "寅", "卯", "辰", "巳", "午", "未", "申", "酉", "戌", "亥"}; + + /** + * 传入 月日的offset 传回干支, 0=甲子 + * + * @param num 月日的offset + * @return 干支 + */ + public static String cyclicalm(int num) { + return (GAN[num % 10] + ZHI[num % 12]); + } + + /** + * 传入年传回干支 + * + * @param year 农历年 + * @return 干支 + * @since 5.4.7 + */ + public static String getGanzhiOfYear(int year) { + // 1864年（1900 - 36）是甲子年，用于计算基准的干支年 + return cyclicalm(year - LunarInfo.BASE_YEAR + 36); + } + + /** + * 获取干支月 + * + * @param year 公历年 + * @param month 公历月，从1开始 + * @param day 公历日 + * @return 干支月 + * @since 5.4.7 + */ + public static String getGanzhiOfMonth(int year, int month, int day) { + //返回当月「节」为几日开始 + int firstNode = SolarTerms.getTerm(year, (month * 2 - 1)); + // 依据12节气修正干支月 + int monthOffset = (year - LunarInfo.BASE_YEAR) * 12 + month + 11; + if (day >= firstNode) { + monthOffset++; + } + return cyclicalm(monthOffset); + } + + /** + * 获取干支日 + * + * @param year 公历年 + * @param month 公历月，从1开始 + * @param day 公历日 + * @return 干支 + * @since 5.4.7 + */ + public static String getGanzhiOfDay(int year, int month, int day) { + // 与1970-01-01相差天数，不包括当天 + final long days = LocalDate.of(year, month, day).toEpochDay() - 1; + //1899-12-21是农历1899年腊月甲子日 41：相差1900-01-31有41天 + return cyclicalm((int) (days - LunarInfo.BASE_DAY + 41)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/LunarFestival.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/LunarFestival.java new file mode 100644 index 0000000..be10dfb --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/LunarFestival.java @@ -0,0 +1,115 @@ +package aiyh.utils.tool.cn.hutool.core.date.chinese; + +import aiyh.utils.tool.cn.hutool.core.lang.Pair; +import aiyh.utils.tool.cn.hutool.core.map.TableMap; + +import java.util.List; + +/** + * 节假日（农历）封装 + * + * @author looly + * @since 5.4.1 + */ +public class LunarFestival { + + //农历节日 *表示放假日 + // 来自：https://baike.baidu.com/item/%E4%B8%AD%E5%9B%BD%E4%BC%A0%E7%BB%9F%E8%8A%82%E6%97%A5/396100 + private static final TableMap, String> L_FTV = new TableMap<>(16); + + static { + // 节日 + L_FTV.put(new Pair<>(1, 1), "春节"); + L_FTV.put(new Pair<>(1, 2), "犬日"); + L_FTV.put(new Pair<>(1, 3), "猪日"); + L_FTV.put(new Pair<>(1, 4), "羊日"); + L_FTV.put(new Pair<>(1, 5), "牛日 破五日"); + L_FTV.put(new Pair<>(1, 6), "马日 送穷日"); + L_FTV.put(new Pair<>(1, 7), "人日 人胜节"); + L_FTV.put(new Pair<>(1, 8), "谷日 八仙日"); + L_FTV.put(new Pair<>(1, 9), "天日 九皇会"); + L_FTV.put(new Pair<>(1, 10), "地日 石头生日"); + L_FTV.put(new Pair<>(1, 12), "火日 老鼠娶媳妇日"); + L_FTV.put(new Pair<>(1, 13), "上（试）灯日 关公升天日"); + L_FTV.put(new Pair<>(1, 15), "元宵节 上元节"); + L_FTV.put(new Pair<>(1, 18), "落灯日"); + + // 二月 + L_FTV.put(new Pair<>(2, 1), "中和节 太阳生日"); + L_FTV.put(new Pair<>(2, 2), "龙抬头"); + L_FTV.put(new Pair<>(2, 12), "花朝节"); + L_FTV.put(new Pair<>(2, 19), "观世音圣诞"); + + // 三月 + L_FTV.put(new Pair<>(3, 3), "上巳节"); + + // 四月 + L_FTV.put(new Pair<>(4, 1), "祭雹神"); + L_FTV.put(new Pair<>(4, 4), "文殊菩萨诞辰"); + L_FTV.put(new Pair<>(4, 8), "佛诞节"); + + // 五月 + L_FTV.put(new Pair<>(5, 5), "端午节 端阳节"); + + // 六月 + L_FTV.put(new Pair<>(6, 6), "晒衣节 姑姑节"); + L_FTV.put(new Pair<>(6, 6), "天贶节"); + L_FTV.put(new Pair<>(6, 24), "彝族火把节"); + + // 七月 + L_FTV.put(new Pair<>(7, 7), "七夕"); + L_FTV.put(new Pair<>(7, 14), "鬼节(南方)"); + L_FTV.put(new Pair<>(7, 15), "中元节"); + L_FTV.put(new Pair<>(7, 15), "盂兰盆节 中元节"); + L_FTV.put(new Pair<>(7, 30), "地藏节"); + + // 八月 + L_FTV.put(new Pair<>(8, 15), "中秋节"); + + // 九月 + L_FTV.put(new Pair<>(9, 9), "重阳节"); + + // 十月 + L_FTV.put(new Pair<>(10, 1), "祭祖节"); + L_FTV.put(new Pair<>(10, 15), "下元节"); + + // 十一月 + L_FTV.put(new Pair<>(11, 17), "阿弥陀佛圣诞"); + + // 腊月 + L_FTV.put(new Pair<>(12, 8), "腊八节"); + L_FTV.put(new Pair<>(12, 16), "尾牙"); + L_FTV.put(new Pair<>(12, 23), "小年"); + L_FTV.put(new Pair<>(12, 30), "除夕"); + } + + /** + * 获得节日列表 + * + * @param year 年 + * @param month 月 + * @param day 日 + * @return 获得农历节日 + * @since 5.4.5 + */ + public static List getFestivals(int year, int month, int day) { + // 春节判断，如果12月是小月，则29为除夕，否则30为除夕 + if (12 == month && 29 == day) { + if (29 == LunarInfo.monthDays(year, month)) { + day++; + } + } + return getFestivals(month, day); + } + + /** + * 获得节日列表，此方法无法判断月是否为大月或小月 + * + * @param month 月 + * @param day 日 + * @return 获得农历节日 + */ + public static List getFestivals(int month, int day) { + return L_FTV.getValues(new Pair<>(month, day)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/LunarInfo.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/LunarInfo.java new file mode 100644 index 0000000..2a5d6db --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/LunarInfo.java @@ -0,0 +1,116 @@ +package aiyh.utils.tool.cn.hutool.core.date.chinese; + +import java.time.LocalDate; + +/** + * 阴历（农历）信息 + * + * @author looly + * @since 5.4.1 + */ +public class LunarInfo { + + /** + * 1900年 + */ + public static final int BASE_YEAR = 1900; + /** + * 1900-01-31，农历正月初一 + */ + public static final long BASE_DAY = LocalDate.of(BASE_YEAR, 1, 31).toEpochDay(); + + /** + * 此表来自：https://github.com/jjonline/calendar.js/blob/master/calendar.js + * 农历表示： + * 1. 表示当年有无闰年，有的话，为闰月的月份，没有的话，为0。 + * 2-4.为除了闰月外的正常月份是大月还是小月，1为30天，0为29天。 + * 5. 表示闰月是大月还是小月，仅当存在闰月的情况下有意义。 + */ + private static final long[] LUNAR_CODE = new long[]{ + 0x04bd8, 0x04ae0, 0x0a570, 0x054d5, 0x0d260, 0x0d950, 0x16554, 0x056a0, 0x09ad0, 0x055d2,//1900-1909 + 0x04ae0, 0x0a5b6, 0x0a4d0, 0x0d250, 0x1d255, 0x0b540, 0x0d6a0, 0x0ada2, 0x095b0, 0x14977,//1910-1919 + 0x04970, 0x0a4b0, 0x0b4b5, 0x06a50, 0x06d40, 0x1ab54, 0x02b60, 0x09570, 0x052f2, 0x04970,//1920-1929 + 0x06566, 0x0d4a0, 0x0ea50, 0x16a95, 0x05ad0, 0x02b60, 0x186e3, 0x092e0, 0x1c8d7, 0x0c950,//1930-1939 + 0x0d4a0, 0x1d8a6, 0x0b550, 0x056a0, 0x1a5b4, 0x025d0, 0x092d0, 0x0d2b2, 0x0a950, 0x0b557,//1940-1949 + 0x06ca0, 0x0b550, 0x15355, 0x04da0, 0x0a5b0, 0x14573, 0x052b0, 0x0a9a8, 0x0e950, 0x06aa0,//1950-1959 + 0x0aea6, 0x0ab50, 0x04b60, 0x0aae4, 0x0a570, 0x05260, 0x0f263, 0x0d950, 0x05b57, 0x056a0,//1960-1969 + 0x096d0, 0x04dd5, 0x04ad0, 0x0a4d0, 0x0d4d4, 0x0d250, 0x0d558, 0x0b540, 0x0b6a0, 0x195a6,//1970-1979 + 0x095b0, 0x049b0, 0x0a974, 0x0a4b0, 0x0b27a, 0x06a50, 0x06d40, 0x0af46, 0x0ab60, 0x09570,//1980-1989 + 0x04af5, 0x04970, 0x064b0, 0x074a3, 0x0ea50, 0x06b58, 0x05ac0, 0x0ab60, 0x096d5, 0x092e0,//1990-1999 + 0x0c960, 0x0d954, 0x0d4a0, 0x0da50, 0x07552, 0x056a0, 0x0abb7, 0x025d0, 0x092d0, 0x0cab5,//2000-2009 + 0x0a950, 0x0b4a0, 0x0baa4, 0x0ad50, 0x055d9, 0x04ba0, 0x0a5b0, 0x15176, 0x052b0, 0x0a930,//2010-2019 + 0x07954, 0x06aa0, 0x0ad50, 0x05b52, 0x04b60, 0x0a6e6, 0x0a4e0, 0x0d260, 0x0ea65, 0x0d530,//2020-2029 + 0x05aa0, 0x076a3, 0x096d0, 0x04afb, 0x04ad0, 0x0a4d0, 0x1d0b6, 0x0d250, 0x0d520, 0x0dd45,//2030-2039 + 0x0b5a0, 0x056d0, 0x055b2, 0x049b0, 0x0a577, 0x0a4b0, 0x0aa50, 0x1b255, 0x06d20, 0x0ada0,//2040-2049 + 0x14b63, 0x09370, 0x049f8, 0x04970, 0x064b0, 0x168a6, 0x0ea50, 0x06b20, 0x1a6c4, 0x0aae0,//2050-2059 + 0x092e0, 0x0d2e3, 0x0c960, 0x0d557, 0x0d4a0, 0x0da50, 0x05d55, 0x056a0, 0x0a6d0, 0x055d4,//2060-2069 + 0x052d0, 0x0a9b8, 0x0a950, 0x0b4a0, 0x0b6a6, 0x0ad50, 0x055a0, 0x0aba4, 0x0a5b0, 0x052b0,//2070-2079 + 0x0b273, 0x06930, 0x07337, 0x06aa0, 0x0ad50, 0x14b55, 0x04b60, 0x0a570, 0x054e4, 0x0d160,//2080-2089 + 0x0e968, 0x0d520, 0x0daa0, 0x16aa6, 0x056d0, 0x04ae0, 0x0a9d4, 0x0a2d0, 0x0d150, 0x0f252,//2090-2099 + }; + + // 支持的最大年限 + public static final int MAX_YEAR = BASE_YEAR + LUNAR_CODE.length - 1; + + /** + * 传回农历 y年的总天数 + * + * @param y 年 + * @return 总天数 + */ + public static int yearDays(int y) { + int i, sum = 348; + for (i = 0x8000; i > 0x8; i >>= 1) { + if ((getCode(y) & i) != 0) { + sum += 1; + } + } + return (sum + leapDays(y)); + } + + /** + * 传回农历 y年闰月的天数，如果本年无闰月，返回0，区分大小月 + * + * @param y 农历年 + * @return 闰月的天数 + */ + public static int leapDays(int y) { + if (leapMonth(y) != 0) { + return (getCode(y) & 0x10000) != 0 ? 30 : 29; + } + + return 0; + } + + /** + * 传回农历 y年m月的总天数，区分大小月 + * + * @param y 年 + * @param m 月 + * @return 总天数 + */ + public static int monthDays(int y, int m) { + return (getCode(y) & (0x10000 >> m)) == 0 ? 29 : 30; + } + + /** + * 传回农历 y年闰哪个月 1-12 , 没闰传回 0
+ * 此方法会返回润N月中的N，如二月、闰二月都返回2 + * + * @param y 年 + * @return 润的月, 没闰传回 0 + */ + public static int leapMonth(int y) { + return (int) (getCode(y) & 0xf); + } + + /** + * 获取对应年的农历信息 + * + * @param year 年 + * @return 农历信息 + */ + private static long getCode(int year) { + return LUNAR_CODE[year - BASE_YEAR]; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/SolarTerms.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/SolarTerms.java new file mode 100644 index 0000000..b315d77 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/SolarTerms.java @@ -0,0 +1,209 @@ +package aiyh.utils.tool.cn.hutool.core.date.chinese; + +import aiyh.utils.tool.cn.hutool.core.date.ChineseDate; +import aiyh.utils.tool.cn.hutool.core.date.DateTime; +import aiyh.utils.tool.cn.hutool.core.date.DateUtil; +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.time.LocalDate; +import java.util.Date; + +/** + * 24节气相关信息 + * + * @author looly, zak + * @since 5.4.1 + */ +public class SolarTerms { + + /** + * 1900-2100各年的24节气日期速查表 + * 此表来自：https://github.com/jjonline/calendar.js/blob/master/calendar.js + */ + private static final String[] S_TERM_INFO = new String[]{ + "9778397bd097c36b0b6fc9274c91aa", "97b6b97bd19801ec9210c965cc920e", "97bcf97c3598082c95f8c965cc920f", + "97bd0b06bdb0722c965ce1cfcc920f", "b027097bd097c36b0b6fc9274c91aa", "97b6b97bd19801ec9210c965cc920e", + "97bcf97c359801ec95f8c965cc920f", "97bd0b06bdb0722c965ce1cfcc920f", "b027097bd097c36b0b6fc9274c91aa", + "97b6b97bd19801ec9210c965cc920e", "97bcf97c359801ec95f8c965cc920f", "97bd0b06bdb0722c965ce1cfcc920f", + "b027097bd097c36b0b6fc9274c91aa", "9778397bd19801ec9210c965cc920e", "97b6b97bd19801ec95f8c965cc920f", + "97bd09801d98082c95f8e1cfcc920f", "97bd097bd097c36b0b6fc9210c8dc2", "9778397bd197c36c9210c9274c91aa", + "97b6b97bd19801ec95f8c965cc920e", "97bd09801d98082c95f8e1cfcc920f", "97bd097bd097c36b0b6fc9210c8dc2", + "9778397bd097c36c9210c9274c91aa", "97b6b97bd19801ec95f8c965cc920e", "97bcf97c3598082c95f8e1cfcc920f", + "97bd097bd097c36b0b6fc9210c8dc2", "9778397bd097c36c9210c9274c91aa", "97b6b97bd19801ec9210c965cc920e", + "97bcf97c3598082c95f8c965cc920f", "97bd097bd097c35b0b6fc920fb0722", "9778397bd097c36b0b6fc9274c91aa", + "97b6b97bd19801ec9210c965cc920e", "97bcf97c3598082c95f8c965cc920f", "97bd097bd097c35b0b6fc920fb0722", + "9778397bd097c36b0b6fc9274c91aa", "97b6b97bd19801ec9210c965cc920e", "97bcf97c359801ec95f8c965cc920f", + "97bd097bd097c35b0b6fc920fb0722", "9778397bd097c36b0b6fc9274c91aa", "97b6b97bd19801ec9210c965cc920e", + "97bcf97c359801ec95f8c965cc920f", "97bd097bd097c35b0b6fc920fb0722", "9778397bd097c36b0b6fc9274c91aa", + "97b6b97bd19801ec9210c965cc920e", "97bcf97c359801ec95f8c965cc920f", "97bd097bd07f595b0b6fc920fb0722", + "9778397bd097c36b0b6fc9210c8dc2", "9778397bd19801ec9210c9274c920e", "97b6b97bd19801ec95f8c965cc920f", + "97bd07f5307f595b0b0bc920fb0722", "7f0e397bd097c36b0b6fc9210c8dc2", "9778397bd097c36c9210c9274c920e", + "97b6b97bd19801ec95f8c965cc920f", "97bd07f5307f595b0b0bc920fb0722", "7f0e397bd097c36b0b6fc9210c8dc2", + "9778397bd097c36c9210c9274c91aa", "97b6b97bd19801ec9210c965cc920e", "97bd07f1487f595b0b0bc920fb0722", + "7f0e397bd097c36b0b6fc9210c8dc2", "9778397bd097c36b0b6fc9274c91aa", "97b6b97bd19801ec9210c965cc920e", + "97bcf7f1487f595b0b0bb0b6fb0722", "7f0e397bd097c35b0b6fc920fb0722", "9778397bd097c36b0b6fc9274c91aa", + "97b6b97bd19801ec9210c965cc920e", "97bcf7f1487f595b0b0bb0b6fb0722", "7f0e397bd097c35b0b6fc920fb0722", + "9778397bd097c36b0b6fc9274c91aa", "97b6b97bd19801ec9210c965cc920e", "97bcf7f1487f531b0b0bb0b6fb0722", + "7f0e397bd097c35b0b6fc920fb0722", "9778397bd097c36b0b6fc9274c91aa", "97b6b97bd19801ec9210c965cc920e", + "97bcf7f1487f531b0b0bb0b6fb0722", "7f0e397bd07f595b0b6fc920fb0722", "9778397bd097c36b0b6fc9274c91aa", + "97b6b97bd19801ec9210c9274c920e", "97bcf7f0e47f531b0b0bb0b6fb0722", "7f0e397bd07f595b0b0bc920fb0722", + "9778397bd097c36b0b6fc9210c91aa", "97b6b97bd197c36c9210c9274c920e", "97bcf7f0e47f531b0b0bb0b6fb0722", + "7f0e397bd07f595b0b0bc920fb0722", "9778397bd097c36b0b6fc9210c8dc2", "9778397bd097c36c9210c9274c920e", + "97b6b7f0e47f531b0723b0b6fb0722", "7f0e37f5307f595b0b0bc920fb0722", "7f0e397bd097c36b0b6fc9210c8dc2", + "9778397bd097c36b0b70c9274c91aa", "97b6b7f0e47f531b0723b0b6fb0721", "7f0e37f1487f595b0b0bb0b6fb0722", + "7f0e397bd097c35b0b6fc9210c8dc2", "9778397bd097c36b0b6fc9274c91aa", "97b6b7f0e47f531b0723b0b6fb0721", + "7f0e27f1487f595b0b0bb0b6fb0722", "7f0e397bd097c35b0b6fc920fb0722", "9778397bd097c36b0b6fc9274c91aa", + "97b6b7f0e47f531b0723b0b6fb0721", "7f0e27f1487f531b0b0bb0b6fb0722", "7f0e397bd097c35b0b6fc920fb0722", + "9778397bd097c36b0b6fc9274c91aa", "97b6b7f0e47f531b0723b0b6fb0721", "7f0e27f1487f531b0b0bb0b6fb0722", + "7f0e397bd097c35b0b6fc920fb0722", "9778397bd097c36b0b6fc9274c91aa", "97b6b7f0e47f531b0723b0b6fb0721", + "7f0e27f1487f531b0b0bb0b6fb0722", "7f0e397bd07f595b0b0bc920fb0722", "9778397bd097c36b0b6fc9274c91aa", + "97b6b7f0e47f531b0723b0787b0721", "7f0e27f0e47f531b0b0bb0b6fb0722", "7f0e397bd07f595b0b0bc920fb0722", + "9778397bd097c36b0b6fc9210c91aa", "97b6b7f0e47f149b0723b0787b0721", "7f0e27f0e47f531b0723b0b6fb0722", + "7f0e397bd07f595b0b0bc920fb0722", "9778397bd097c36b0b6fc9210c8dc2", "977837f0e37f149b0723b0787b0721", + "7f07e7f0e47f531b0723b0b6fb0722", "7f0e37f5307f595b0b0bc920fb0722", "7f0e397bd097c35b0b6fc9210c8dc2", + "977837f0e37f14998082b0787b0721", "7f07e7f0e47f531b0723b0b6fb0721", "7f0e37f1487f595b0b0bb0b6fb0722", + "7f0e397bd097c35b0b6fc9210c8dc2", "977837f0e37f14998082b0787b06bd", "7f07e7f0e47f531b0723b0b6fb0721", + "7f0e27f1487f531b0b0bb0b6fb0722", "7f0e397bd097c35b0b6fc920fb0722", "977837f0e37f14998082b0787b06bd", + "7f07e7f0e47f531b0723b0b6fb0721", "7f0e27f1487f531b0b0bb0b6fb0722", "7f0e397bd097c35b0b6fc920fb0722", + "977837f0e37f14998082b0787b06bd", "7f07e7f0e47f531b0723b0b6fb0721", "7f0e27f1487f531b0b0bb0b6fb0722", + "7f0e397bd07f595b0b0bc920fb0722", "977837f0e37f14998082b0787b06bd", "7f07e7f0e47f531b0723b0b6fb0721", + "7f0e27f1487f531b0b0bb0b6fb0722", "7f0e397bd07f595b0b0bc920fb0722", "977837f0e37f14998082b0787b06bd", + "7f07e7f0e47f149b0723b0787b0721", "7f0e27f0e47f531b0b0bb0b6fb0722", "7f0e397bd07f595b0b0bc920fb0722", + "977837f0e37f14998082b0723b06bd", "7f07e7f0e37f149b0723b0787b0721", "7f0e27f0e47f531b0723b0b6fb0722", + "7f0e397bd07f595b0b0bc920fb0722", "977837f0e37f14898082b0723b02d5", "7ec967f0e37f14998082b0787b0721", + "7f07e7f0e47f531b0723b0b6fb0722", "7f0e37f1487f595b0b0bb0b6fb0722", "7f0e37f0e37f14898082b0723b02d5", + "7ec967f0e37f14998082b0787b0721", "7f07e7f0e47f531b0723b0b6fb0722", "7f0e37f1487f531b0b0bb0b6fb0722", + "7f0e37f0e37f14898082b0723b02d5", "7ec967f0e37f14998082b0787b06bd", "7f07e7f0e47f531b0723b0b6fb0721", + "7f0e37f1487f531b0b0bb0b6fb0722", "7f0e37f0e37f14898082b072297c35", "7ec967f0e37f14998082b0787b06bd", + "7f07e7f0e47f531b0723b0b6fb0721", "7f0e27f1487f531b0b0bb0b6fb0722", "7f0e37f0e37f14898082b072297c35", + "7ec967f0e37f14998082b0787b06bd", "7f07e7f0e47f531b0723b0b6fb0721", "7f0e27f1487f531b0b0bb0b6fb0722", + "7f0e37f0e366aa89801eb072297c35", "7ec967f0e37f14998082b0787b06bd", "7f07e7f0e47f149b0723b0787b0721", + "7f0e27f1487f531b0b0bb0b6fb0722", "7f0e37f0e366aa89801eb072297c35", "7ec967f0e37f14998082b0723b06bd", + "7f07e7f0e47f149b0723b0787b0721", "7f0e27f0e47f531b0723b0b6fb0722", "7f0e37f0e366aa89801eb072297c35", + "7ec967f0e37f14998082b0723b06bd", "7f07e7f0e37f14998083b0787b0721", "7f0e27f0e47f531b0723b0b6fb0722", + "7f0e37f0e366aa89801eb072297c35", "7ec967f0e37f14898082b0723b02d5", "7f07e7f0e37f14998082b0787b0721", + "7f07e7f0e47f531b0723b0b6fb0722", "7f0e36665b66aa89801e9808297c35", "665f67f0e37f14898082b0723b02d5", + "7ec967f0e37f14998082b0787b0721", "7f07e7f0e47f531b0723b0b6fb0722", "7f0e36665b66a449801e9808297c35", + "665f67f0e37f14898082b0723b02d5", "7ec967f0e37f14998082b0787b06bd", "7f07e7f0e47f531b0723b0b6fb0721", + "7f0e36665b66a449801e9808297c35", "665f67f0e37f14898082b072297c35", "7ec967f0e37f14998082b0787b06bd", + "7f07e7f0e47f531b0723b0b6fb0721", "7f0e26665b66a449801e9808297c35", "665f67f0e37f1489801eb072297c35", + "7ec967f0e37f14998082b0787b06bd", "7f07e7f0e47f531b0723b0b6fb0721", "7f0e27f1487f531b0b0bb0b6fb0722"}; + + /** + * 24节气 + */ + private static final String[] TERMS = { + "小寒", "大寒", "立春", "雨水", "惊蛰", "春分", + "清明", "谷雨", "立夏", "小满", "芒种", "夏至", + "小暑", "大暑", "立秋", "处暑", "白露", "秋分", + "寒露", "霜降", "立冬", "小雪", "大雪", "冬至" + }; + + /** + * 传入公历y年获得该年第n个节气的公历日期 + * + * @param y 公历年(1900-2100) + * @param n 二十四节气中的第几个节气(1~24)；从n=1(小寒)算起 + * @return getTerm(1987,3) -》4;意即1987年2月4日立春 + */ + public static int getTerm(int y, int n) { + if (y < 1900 || y > 2100) { + return -1; + } + if (n < 1 || n > 24) { + return -1; + } + + final String _table = S_TERM_INFO[y - 1900]; + Integer[] _info = new Integer[6]; + for (int i = 0; i < 6; i++) { + _info[i] = Integer.parseInt(_table.substring(i * 5, 5 * (i + 1)), 16); + } + String[] _calday = new String[24]; + for (int i = 0; i < 6; i++) { + _calday[4 * i] = _info[i].toString().substring(0, 1); + _calday[4 * i + 1] = _info[i].toString().substring(1, 3); + _calday[4 * i + 2] = _info[i].toString().substring(3, 4); + _calday[4 * i + 3] = _info[i].toString().substring(4, 6); + } + return NumberUtil.parseInt(_calday[n - 1]); + } + + /** + * 根据日期获取节气 + * @param date 日期 + * @return 返回指定日期所处的节气，若不是一个节气则返回空字符串 + */ + public static String getTerm(Date date) { + final DateTime dt = DateUtil.date(date); + return getTermInternal(dt.year(), dt.month() + 1, dt.dayOfMonth()); + } + + + /** + * 根据农历日期获取节气 + * @param chineseDate 农历日期 + * @return 返回指定农历日期所处的节气，若不是一个节气则返回空字符串 + */ + public static String getTerm(ChineseDate chineseDate) { + return chineseDate.getTerm(); + } + + /** + * 根据日期获取节气 + * @param date 日期 + * @return 返回指定日期所处的节气，若不是一个节气则返回空字符串 + */ + public static String getTerm(LocalDate date) { + return getTermInternal(date.getYear(), date.getMonthValue(), date.getDayOfMonth()); + } + + /** + * 根据年月日获取节气 + * @param year 公历年 + * @param mouth 公历月，从1开始 + * @param day 公历日，从1开始 + * @return 返回指定年月日所处的节气，若不是一个节气则返回空字符串 + */ + public static String getTerm(int year, int mouth, int day) { + return getTerm(LocalDate.of(year, mouth, day)); + } + + /** + * 根据年月日获取节气, 内部方法，不对月和日做有效校验 + * @param year 公历年 + * @param mouth 公历月，从1开始 + * @param day 公历日，从1开始 + * @return 返回指定年月日所处的节气，若不是一个节气则返回空字符串 + */ + private static String getTermInternal(int year, int mouth, int day) { + if (year < 1900 || year > 2100) { + throw new IllegalArgumentException("只支持1900-2100之间的日期获取节气"); + } + + final String termTable = S_TERM_INFO[year - 1900]; + + // 节气速查表中每5个字符含有4个节气，通过月份直接计算偏移 + final int segment = (mouth + 1) / 2 - 1; + final int termInfo = Integer.parseInt(termTable.substring(segment * 5, (segment + 1) * 5), 16); + final String termInfoStr = String.valueOf(termInfo); + + final String[] segmentTable = new String[4]; + segmentTable[0] = termInfoStr.substring(0, 1); + segmentTable[1] = termInfoStr.substring(1, 3); + segmentTable[2] = termInfoStr.substring(3, 4); + segmentTable[3] = termInfoStr.substring(4, 6); + + // 奇数月份的节气在前2个，偶数月份的节气在后两个 + final int segmentOffset = (mouth & 1) == 1 ? 0 : 2; + + if (day == Integer.parseInt(segmentTable[segmentOffset])) { + return TERMS[segment * 4 + segmentOffset]; + } + if (day == Integer.parseInt(segmentTable[segmentOffset + 1])) { + return TERMS[segment * 4 + segmentOffset + 1]; + } + return StrUtil.EMPTY; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/package-info.java new file mode 100644 index 0000000..3145c47 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/chinese/package-info.java @@ -0,0 +1,7 @@ +/** + * 农历相关类汇总，包括农历月、天干地支、农历节日、24节气等 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.date.chinese; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/AbstractDateBasic.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/AbstractDateBasic.java new file mode 100644 index 0000000..2f2d79d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/AbstractDateBasic.java @@ -0,0 +1,64 @@ +package aiyh.utils.tool.cn.hutool.core.date.format; + +import java.io.Serializable; +import java.util.Locale; +import java.util.TimeZone; + +public abstract class AbstractDateBasic implements DateBasic, Serializable { + private static final long serialVersionUID = 6333136319870641818L; + + /** The pattern */ + protected final String pattern; + /** The time zone. */ + protected final TimeZone timeZone; + /** The locale. */ + protected final Locale locale; + + /** + * 构造，内部使用 + * @param pattern 使用{@link java.text.SimpleDateFormat} 相同的日期格式 + * @param timeZone 非空时区{@link TimeZone} + * @param locale 非空{@link Locale} 日期地理位置 + */ + protected AbstractDateBasic(final String pattern, final TimeZone timeZone, final Locale locale) { + this.pattern = pattern; + this.timeZone = timeZone; + this.locale = locale; + } + + // ----------------------------------------------------------------------- Accessors + @Override + public String getPattern() { + return pattern; + } + + @Override + public TimeZone getTimeZone() { + return timeZone; + } + + @Override + public Locale getLocale() { + return locale; + } + + // ----------------------------------------------------------------------- Basics + @Override + public boolean equals(final Object obj) { + if (obj instanceof FastDatePrinter == false) { + return false; + } + final AbstractDateBasic other = (AbstractDateBasic) obj; + return pattern.equals(other.pattern) && timeZone.equals(other.timeZone) && locale.equals(other.locale); + } + + @Override + public int hashCode() { + return pattern.hashCode() + 13 * (timeZone.hashCode() + 13 * locale.hashCode()); + } + + @Override + public String toString() { + return "FastDatePrinter[" + pattern + "," + locale + "," + timeZone.getID() + "]"; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/DateBasic.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/DateBasic.java new file mode 100644 index 0000000..f95c213 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/DateBasic.java @@ -0,0 +1,34 @@ +package aiyh.utils.tool.cn.hutool.core.date.format; + +import java.util.Locale; +import java.util.TimeZone; + +/** + * 日期基本信息获取接口 + * + * @author Looly + * @since 2.16.2 + */ +public interface DateBasic { + + /** + * 获得日期格式化或者转换的格式 + * + * @return {@link java.text.SimpleDateFormat}兼容的格式 + */ + String getPattern(); + + /** + * 获得时区 + * + * @return {@link TimeZone} + */ + TimeZone getTimeZone(); + + /** + * 获得 日期地理位置 + * + * @return {@link Locale} + */ + Locale getLocale(); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/DateParser.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/DateParser.java new file mode 100644 index 0000000..9780938 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/DateParser.java @@ -0,0 +1,72 @@ +package aiyh.utils.tool.cn.hutool.core.date.format; + +import java.text.ParseException; +import java.text.ParsePosition; +import java.util.Calendar; +import java.util.Date; + +/** + * 日期解析接口，用于解析日期字符串为 {@link Date} 对象
+ * Thanks to Apache Commons Lang 3.5 + * @since 2.16.2 + */ +public interface DateParser extends DateBasic{ + + /** + * 将日期字符串解析并转换为 {@link Date} 对象
+ * 等价于 {@link java.text.DateFormat#parse(String)} + * + * @param source 日期字符串 + * @return {@link Date} + * @throws ParseException 转换异常，被转换的字符串格式错误。 + */ + Date parse(String source) throws ParseException; + + /** + * 将日期字符串解析并转换为 {@link Date} 对象
+ * 等价于 {@link java.text.DateFormat#parse(String, ParsePosition)} + * + * @param source 日期字符串 + * @param pos {@link ParsePosition} + * @return {@link Date} + */ + Date parse(String source, ParsePosition pos); + + /** + * 根据给定格式更新{@link Calendar} + * Upon success, the ParsePosition index is updated to indicate how much of the source text was consumed. + * Not all source text needs to be consumed. + * Upon parse failure, ParsePosition error index is updated to the offset of the source text which does not match the supplied format. + * + * @param source 被转换的日期字符串 + * @param pos 定义开始转换的位置，转换结束后更新转换到的位置 + * @param calendar The calendar into which to set parsed fields. + * @return true, if source has been parsed (pos parsePosition is updated); otherwise false (and pos errorIndex is updated) + * @throws IllegalArgumentException when Calendar has been set to be not lenient, and a parsed field is out of range. + */ + boolean parse(String source, ParsePosition pos, Calendar calendar); + + /** + * 将日期字符串解析并转换为 {@link Date} 对象
+ * + * @param source A {@code String} whose beginning should be parsed. + * @return a {@code java.util.Date} object + * @throws ParseException if the beginning of the specified string cannot be parsed. + * @see java.text.DateFormat#parseObject(String) + */ + default Object parseObject(String source) throws ParseException{ + return parse(source); + } + + /** + * 根据 {@link ParsePosition} 给定将日期字符串解析并转换为 {@link Date} 对象
+ * + * @param source A {@code String} whose beginning should be parsed. + * @param pos the parse position + * @return a {@code java.util.Date} object + * @see java.text.DateFormat#parseObject(String, ParsePosition) + */ + default Object parseObject(String source, ParsePosition pos){ + return parse(source, pos); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/DatePrinter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/DatePrinter.java new file mode 100644 index 0000000..e883a5b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/DatePrinter.java @@ -0,0 +1,78 @@ +package aiyh.utils.tool.cn.hutool.core.date.format; + +import java.util.Calendar; +import java.util.Date; + +/** + * 日期格式化输出接口
+ * Thanks to Apache Commons Lang 3.5 + * @author Looly + * @since 2.16.2 + */ +public interface DatePrinter extends DateBasic { + + /** + * 格式化日期表示的毫秒数 + * + * @param millis 日期毫秒数 + * @return the formatted string + * @since 2.1 + */ + String format(long millis); + + /** + * 使用 {@code GregorianCalendar} 格式化 {@code Date} + * + * @param date 日期 {@link Date} + * @return 格式化后的字符串 + */ + String format(Date date); + + /** + *

+ * Formats a {@code Calendar} object. + *

+ * 格式化 {@link Calendar} + * + * @param calendar {@link Calendar} + * @return 格式化后的字符串 + */ + String format(Calendar calendar); + + /** + *

+ * Formats a millisecond {@code long} value into the supplied {@code Appendable}. + *

+ * + * @param millis the millisecond value to format + * @param buf the buffer to format into + * @param the Appendable class type, usually StringBuilder or StringBuffer. + * @return the specified string buffer + */ + B format(long millis, B buf); + + /** + *

+ * Formats a {@code Date} object into the supplied {@code Appendable} using a {@code GregorianCalendar}. + *

+ * + * @param date the date to format + * @param buf the buffer to format into + * @param the Appendable class type, usually StringBuilder or StringBuffer. + * @return the specified string buffer + */ + B format(Date date, B buf); + + /** + *

+ * Formats a {@code Calendar} object into the supplied {@code Appendable}. + *

+ * The TimeZone set on the Calendar is only used to adjust the time offset. The TimeZone specified during the construction of the Parser will determine the TimeZone used in the formatted string. + * + * @param calendar the calendar to format + * @param buf the buffer to format into + * @param the Appendable class type, usually StringBuilder or StringBuffer. + * @return the specified string buffer + */ + B format(Calendar calendar, B buf); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/FastDateFormat.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/FastDateFormat.java new file mode 100644 index 0000000..461ba39 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/FastDateFormat.java @@ -0,0 +1,420 @@ +package aiyh.utils.tool.cn.hutool.core.date.format; + +import aiyh.utils.tool.cn.hutool.core.date.DatePattern; + +import java.text.DateFormat; +import java.text.FieldPosition; +import java.text.Format; +import java.text.ParseException; +import java.text.ParsePosition; +import java.time.format.DateTimeFormatter; +import java.util.Calendar; +import java.util.Date; +import java.util.Locale; +import java.util.TimeZone; + +/** + *

+ * FastDateFormat 是一个线程安全的 {@link java.text.SimpleDateFormat} 实现。 + *

+ * + *

+ * 通过以下静态方法获得此对象:
+ * {@link #getInstance(String, TimeZone, Locale)}
+ * {@link #getDateInstance(int, TimeZone, Locale)}
+ * {@link #getTimeInstance(int, TimeZone, Locale)}
+ * {@link #getDateTimeInstance(int, int, TimeZone, Locale)} + *

+ * + * Thanks to Apache Commons Lang 3.5 + * @since 2.16.2 + */ +public class FastDateFormat extends Format implements DateParser, DatePrinter { + private static final long serialVersionUID = 8097890768636183236L; + + /** FULL locale dependent date or time style. */ + public static final int FULL = DateFormat.FULL; + /** LONG locale dependent date or time style. */ + public static final int LONG = DateFormat.LONG; + /** MEDIUM locale dependent date or time style. */ + public static final int MEDIUM = DateFormat.MEDIUM; + /** SHORT locale dependent date or time style. */ + public static final int SHORT = DateFormat.SHORT; + + private static final FormatCache CACHE = new FormatCache(){ + @Override + protected FastDateFormat createInstance(final String pattern, final TimeZone timeZone, final Locale locale) { + return new FastDateFormat(pattern, timeZone, locale); + } + }; + + private final FastDatePrinter printer; + private final FastDateParser parser; + + // ----------------------------------------------------------------------- + /** + * 获得 FastDateFormat实例，使用默认格式和地区 + * + * @return FastDateFormat + */ + public static FastDateFormat getInstance() { + return CACHE.getInstance(); + } + + /** + * 获得 FastDateFormat 实例，使用默认地区
+ * 支持缓存 + * + * @param pattern 使用{@link java.text.SimpleDateFormat} 相同的日期格式 + * @return FastDateFormat + * @throws IllegalArgumentException 日期格式问题 + */ + public static FastDateFormat getInstance(final String pattern) { + return CACHE.getInstance(pattern, null, null); + } + + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param pattern 使用{@link java.text.SimpleDateFormat} 相同的日期格式 + * @param timeZone 时区{@link TimeZone} + * @return FastDateFormat + * @throws IllegalArgumentException 日期格式问题 + */ + public static FastDateFormat getInstance(final String pattern, final TimeZone timeZone) { + return CACHE.getInstance(pattern, timeZone, null); + } + + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param pattern 使用{@link java.text.SimpleDateFormat} 相同的日期格式 + * @param locale {@link Locale} 日期地理位置 + * @return FastDateFormat + * @throws IllegalArgumentException 日期格式问题 + */ + public static FastDateFormat getInstance(final String pattern, final Locale locale) { + return CACHE.getInstance(pattern, null, locale); + } + + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param pattern 使用{@link java.text.SimpleDateFormat} 相同的日期格式 + * @param timeZone 时区{@link TimeZone} + * @param locale {@link Locale} 日期地理位置 + * @return FastDateFormat + * @throws IllegalArgumentException 日期格式问题 + */ + public static FastDateFormat getInstance(final String pattern, final TimeZone timeZone, final Locale locale) { + return CACHE.getInstance(pattern, timeZone, locale); + } + + // ----------------------------------------------------------------------- + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param style date style: FULL, LONG, MEDIUM, or SHORT + * @return 本地化 FastDateFormat + */ + public static FastDateFormat getDateInstance(final int style) { + return CACHE.getDateInstance(style, null, null); + } + + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param style date style: FULL, LONG, MEDIUM, or SHORT + * @param locale {@link Locale} 日期地理位置 + * @return 本地化 FastDateFormat + */ + public static FastDateFormat getDateInstance(final int style, final Locale locale) { + return CACHE.getDateInstance(style, null, locale); + } + + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param style date style: FULL, LONG, MEDIUM, or SHORT + * @param timeZone 时区{@link TimeZone} + * @return 本地化 FastDateFormat + */ + public static FastDateFormat getDateInstance(final int style, final TimeZone timeZone) { + return CACHE.getDateInstance(style, timeZone, null); + } + + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param style date style: FULL, LONG, MEDIUM, or SHORT + * @param timeZone 时区{@link TimeZone} + * @param locale {@link Locale} 日期地理位置 + * @return 本地化 FastDateFormat + */ + public static FastDateFormat getDateInstance(final int style, final TimeZone timeZone, final Locale locale) { + return CACHE.getDateInstance(style, timeZone, locale); + } + + // ----------------------------------------------------------------------- + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param style time style: FULL, LONG, MEDIUM, or SHORT + * @return 本地化 FastDateFormat + */ + public static FastDateFormat getTimeInstance(final int style) { + return CACHE.getTimeInstance(style, null, null); + } + + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param style time style: FULL, LONG, MEDIUM, or SHORT + * @param locale {@link Locale} 日期地理位置 + * @return 本地化 FastDateFormat + */ + public static FastDateFormat getTimeInstance(final int style, final Locale locale) { + return CACHE.getTimeInstance(style, null, locale); + } + + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param style time style: FULL, LONG, MEDIUM, or SHORT + * @param timeZone optional time zone, overrides time zone of formatted time + * @return 本地化 FastDateFormat + */ + public static FastDateFormat getTimeInstance(final int style, final TimeZone timeZone) { + return CACHE.getTimeInstance(style, timeZone, null); + } + + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param style time style: FULL, LONG, MEDIUM, or SHORT + * @param timeZone optional time zone, overrides time zone of formatted time + * @param locale {@link Locale} 日期地理位置 + * @return 本地化 FastDateFormat + */ + public static FastDateFormat getTimeInstance(final int style, final TimeZone timeZone, final Locale locale) { + return CACHE.getTimeInstance(style, timeZone, locale); + } + + // ----------------------------------------------------------------------- + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param dateStyle date style: FULL, LONG, MEDIUM, or SHORT + * @param timeStyle time style: FULL, LONG, MEDIUM, or SHORT + * @return 本地化 FastDateFormat + */ + public static FastDateFormat getDateTimeInstance(final int dateStyle, final int timeStyle) { + return CACHE.getDateTimeInstance(dateStyle, timeStyle, null, null); + } + + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param dateStyle date style: FULL, LONG, MEDIUM, or SHORT + * @param timeStyle time style: FULL, LONG, MEDIUM, or SHORT + * @param locale {@link Locale} 日期地理位置 + * @return 本地化 FastDateFormat + */ + public static FastDateFormat getDateTimeInstance(final int dateStyle, final int timeStyle, final Locale locale) { + return CACHE.getDateTimeInstance(dateStyle, timeStyle, null, locale); + } + + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param dateStyle date style: FULL, LONG, MEDIUM, or SHORT + * @param timeStyle time style: FULL, LONG, MEDIUM, or SHORT + * @param timeZone 时区{@link TimeZone} + * @return 本地化 FastDateFormat + */ + public static FastDateFormat getDateTimeInstance(final int dateStyle, final int timeStyle, final TimeZone timeZone) { + return getDateTimeInstance(dateStyle, timeStyle, timeZone, null); + } + + /** + * 获得 FastDateFormat 实例
+ * 支持缓存 + * + * @param dateStyle date style: FULL, LONG, MEDIUM, or SHORT + * @param timeStyle time style: FULL, LONG, MEDIUM, or SHORT + * @param timeZone 时区{@link TimeZone} + * @param locale {@link Locale} 日期地理位置 + * @return 本地化 FastDateFormat + */ + public static FastDateFormat getDateTimeInstance(final int dateStyle, final int timeStyle, final TimeZone timeZone, final Locale locale) { + return CACHE.getDateTimeInstance(dateStyle, timeStyle, timeZone, locale); + } + + // ----------------------------------------------------------------------- Constructor start + /** + * 构造 + * + * @param pattern 使用{@link java.text.SimpleDateFormat} 相同的日期格式 + * @param timeZone 非空时区 {@link TimeZone} + * @param locale {@link Locale} 日期地理位置 + * @throws NullPointerException if pattern, timeZone, or locale is null. + */ + protected FastDateFormat(final String pattern, final TimeZone timeZone, final Locale locale) { + this(pattern, timeZone, locale, null); + } + + /** + * 构造 + * + * @param pattern 使用{@link java.text.SimpleDateFormat} 相同的日期格式 + * @param timeZone 非空时区 {@link TimeZone} + * @param locale {@link Locale} 日期地理位置 + * @param centuryStart The start of the 100 year period to use as the "default century" for 2 digit year parsing. If centuryStart is null, defaults to now - 80 years + * @throws NullPointerException if pattern, timeZone, or locale is null. + */ + protected FastDateFormat(final String pattern, final TimeZone timeZone, final Locale locale, final Date centuryStart) { + printer = new FastDatePrinter(pattern, timeZone, locale); + parser = new FastDateParser(pattern, timeZone, locale, centuryStart); + } + // ----------------------------------------------------------------------- Constructor end + + // ----------------------------------------------------------------------- Format methods + @Override + public StringBuffer format(final Object obj, final StringBuffer toAppendTo, final FieldPosition pos) { + return toAppendTo.append(printer.format(obj)); + } + + @Override + public String format(final long millis) { + return printer.format(millis); + } + + @Override + public String format(final Date date) { + return printer.format(date); + } + + @Override + public String format(final Calendar calendar) { + return printer.format(calendar); + } + + @Override + public B format(final long millis, final B buf) { + return printer.format(millis, buf); + } + + @Override + public B format(final Date date, final B buf) { + return printer.format(date, buf); + } + + @Override + public B format(final Calendar calendar, final B buf) { + return printer.format(calendar, buf); + } + + // ----------------------------------------------------------------------- Parsing + @Override + public Date parse(final String source) throws ParseException { + return parser.parse(source); + } + + @Override + public Date parse(final String source, final ParsePosition pos) { + return parser.parse(source, pos); + } + + @Override + public boolean parse(final String source, final ParsePosition pos, final Calendar calendar) { + return parser.parse(source, pos, calendar); + } + + @Override + public Object parseObject(final String source, final ParsePosition pos) { + return parser.parseObject(source, pos); + } + + // ----------------------------------------------------------------------- Accessors + @Override + public String getPattern() { + return printer.getPattern(); + } + + @Override + public TimeZone getTimeZone() { + return printer.getTimeZone(); + } + + @Override + public Locale getLocale() { + return printer.getLocale(); + } + + /** + *估算生成的日期字符串长度
+ * 实际生成的字符串长度小于或等于此值 + * + * @return 日期字符串长度 + */ + public int getMaxLengthEstimate() { + return printer.getMaxLengthEstimate(); + } + + // convert DateTimeFormatter + // ----------------------------------------------------------------------- + + /** + * 便捷获取 DateTimeFormatter + * 由于 {@link DatePattern} 很大一部分的格式没有提供 {@link DateTimeFormatter},因此这里提供快捷获取方式 + * @return DateTimeFormatter + * @author dazer neusoft + * @since 5.6.4 + */ + public DateTimeFormatter getDateTimeFormatter() { + DateTimeFormatter formatter = DateTimeFormatter.ofPattern(this.getPattern()); + if (this.getLocale() != null) { + formatter = formatter.withLocale(this.getLocale()); + } + if (this.getTimeZone() != null) { + formatter = formatter.withZone(this.getTimeZone().toZoneId()); + } + return formatter; + } + + // Basics + // ----------------------------------------------------------------------- + @Override + public boolean equals(final Object obj) { + if (obj instanceof FastDateFormat == false) { + return false; + } + final FastDateFormat other = (FastDateFormat) obj; + // no need to check parser, as it has same invariants as printer + return printer.equals(other.printer); + } + + @Override + public int hashCode() { + return printer.hashCode(); + } + + @Override + public String toString() { + return "FastDateFormat[" + printer.getPattern() + "," + printer.getLocale() + "," + printer.getTimeZone().getID() + "]"; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/FastDateParser.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/FastDateParser.java new file mode 100644 index 0000000..7f0c0b4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/FastDateParser.java @@ -0,0 +1,810 @@ +package aiyh.utils.tool.cn.hutool.core.date.format; + +import aiyh.utils.tool.cn.hutool.core.map.SafeConcurrentHashMap; + +import java.io.IOException; +import java.io.ObjectInputStream; +import java.text.DateFormatSymbols; +import java.text.ParseException; +import java.text.ParsePosition; +import java.util.ArrayList; +import java.util.Calendar; +import java.util.Comparator; +import java.util.Date; +import java.util.HashMap; +import java.util.List; +import java.util.ListIterator; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.TimeZone; +import java.util.TreeSet; +import java.util.concurrent.ConcurrentMap; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * {@link java.text.SimpleDateFormat} 的线程安全版本，用于解析日期字符串并转换为 {@link Date} 对象
+ * Thanks to Apache Commons Lang 3.5 + * + * @see FastDatePrinter + * @since 2.16.2 + */ +public class FastDateParser extends AbstractDateBasic implements DateParser { + private static final long serialVersionUID = -3199383897950947498L; + + static final Locale JAPANESE_IMPERIAL = new Locale("ja", "JP", "JP"); + + /** + * 世纪：2000年前为19， 之后为20 + */ + private final int century; + private final int startYear; + + // derived fields + private transient List patterns; + + // comparator used to sort regex alternatives + // alternatives should be ordered longer first, and shorter last. ('february' before 'feb') + // all entries must be lowercase by locale. + private static final Comparator LONGER_FIRST_LOWERCASE = Comparator.reverseOrder(); + + /** + *

+ * Constructs a new FastDateParser. + *

+ *

+ * Use {@link FastDateFormat#getInstance(String, TimeZone, Locale)} or another variation of the factory methods of {@link FastDateFormat} to get a cached FastDateParser instance. + * + * @param pattern non-null {@link java.text.SimpleDateFormat} compatible pattern + * @param timeZone non-null time zone to use + * @param locale non-null locale + */ + public FastDateParser(String pattern, TimeZone timeZone, Locale locale) { + this(pattern, timeZone, locale, null); + } + + /** + *

+ * Constructs a new FastDateParser. + *

+ * + * @param pattern non-null {@link java.text.SimpleDateFormat} compatible pattern + * @param timeZone non-null time zone to use + * @param locale non-null locale + * @param centuryStart The start of the century for 2 digit year parsing + */ + public FastDateParser(final String pattern, final TimeZone timeZone, final Locale locale, final Date centuryStart) { + super(pattern, timeZone, locale); + final Calendar definingCalendar = Calendar.getInstance(timeZone, locale); + + int centuryStartYear; + if (centuryStart != null) { + definingCalendar.setTime(centuryStart); + centuryStartYear = definingCalendar.get(Calendar.YEAR); + } else if (locale.equals(JAPANESE_IMPERIAL)) { + centuryStartYear = 0; + } else { + // from 80 years ago to 20 years from now + definingCalendar.setTime(new Date()); + centuryStartYear = definingCalendar.get(Calendar.YEAR) - 80; + } + century = centuryStartYear / 100 * 100; + startYear = centuryStartYear - century; + + init(definingCalendar); + } + + /** + * Initialize derived fields from defining fields. This is called from constructor and from readObject (de-serialization) + * + * @param definingCalendar the {@link java.util.Calendar} instance used to initialize this FastDateParser + */ + private void init(final Calendar definingCalendar) { + patterns = new ArrayList<>(); + + final StrategyParser fm = new StrategyParser(definingCalendar); + for (; ; ) { + final StrategyAndWidth field = fm.getNextStrategy(); + if (field == null) { + break; + } + patterns.add(field); + } + } + + // helper classes to parse the format string + // ----------------------------------------------------------------------- + + /** + * Holds strategy and field width + */ + private static class StrategyAndWidth { + final Strategy strategy; + final int width; + + StrategyAndWidth(final Strategy strategy, final int width) { + this.strategy = strategy; + this.width = width; + } + + int getMaxWidth(final ListIterator lt) { + if (!strategy.isNumber() || !lt.hasNext()) { + return 0; + } + final Strategy nextStrategy = lt.next().strategy; + lt.previous(); + return nextStrategy.isNumber() ? width : 0; + } + } + + /** + * Parse format into Strategies + */ + private class StrategyParser { + final private Calendar definingCalendar; + private int currentIdx; + + StrategyParser(final Calendar definingCalendar) { + this.definingCalendar = definingCalendar; + } + + StrategyAndWidth getNextStrategy() { + if (currentIdx >= pattern.length()) { + return null; + } + + final char c = pattern.charAt(currentIdx); + if (isFormatLetter(c)) { + return letterPattern(c); + } + return literal(); + } + + private StrategyAndWidth letterPattern(final char c) { + final int begin = currentIdx; + while (++currentIdx < pattern.length()) { + if (pattern.charAt(currentIdx) != c) { + break; + } + } + + final int width = currentIdx - begin; + return new StrategyAndWidth(getStrategy(c, width, definingCalendar), width); + } + + private StrategyAndWidth literal() { + boolean activeQuote = false; + + final StringBuilder sb = new StringBuilder(); + while (currentIdx < pattern.length()) { + final char c = pattern.charAt(currentIdx); + if (!activeQuote && isFormatLetter(c)) { + break; + } else if (c == '\'' && (++currentIdx == pattern.length() || pattern.charAt(currentIdx) != '\'')) { + activeQuote = !activeQuote; + continue; + } + ++currentIdx; + sb.append(c); + } + + if (activeQuote) { + throw new IllegalArgumentException("Unterminated quote"); + } + + final String formatField = sb.toString(); + return new StrategyAndWidth(new CopyQuotedStrategy(formatField), formatField.length()); + } + } + + private static boolean isFormatLetter(final char c) { + return c >= 'A' && c <= 'Z' || c >= 'a' && c <= 'z'; + } + + // Serializing + // ----------------------------------------------------------------------- + + /** + * Create the object after serialization. This implementation reinitializes the transient properties. + * + * @param in ObjectInputStream from which the object is being deserialized. + * @throws IOException if there is an IO issue. + * @throws ClassNotFoundException if a class cannot be found. + */ + private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException { + in.defaultReadObject(); + + final Calendar definingCalendar = Calendar.getInstance(timeZone, locale); + init(definingCalendar); + } + + @Override + public Date parse(String source) throws ParseException { + final ParsePosition pp = new ParsePosition(0); + final Date date = parse(source, pp); + if (date == null) { + // Add a note re supported date range + if (locale.equals(JAPANESE_IMPERIAL)) { + throw new ParseException("(The " + locale + " locale does not support dates before 1868 AD)\n" + + "Unparseable date: \"" + source, pp.getErrorIndex()); + } + throw new ParseException("Unparseable date: " + source, pp.getErrorIndex()); + } + return date; + } + + @Override + public Date parse(String source, ParsePosition pos) { + // timing tests indicate getting new instance is 19% faster than cloning + final Calendar cal = Calendar.getInstance(timeZone, locale); + cal.clear(); + + return parse(source, pos, cal) ? cal.getTime() : null; + } + + @Override + public boolean parse(String source, ParsePosition pos, Calendar calendar) { + final ListIterator lt = patterns.listIterator(); + while (lt.hasNext()) { + final StrategyAndWidth strategyAndWidth = lt.next(); + final int maxWidth = strategyAndWidth.getMaxWidth(lt); + if (false == strategyAndWidth.strategy.parse(this, calendar, source, pos, maxWidth)) { + return false; + } + } + return true; + } + + // Support for strategies + // ----------------------------------------------------------------------- + + private static StringBuilder simpleQuote(final StringBuilder sb, final String value) { + for (int i = 0; i < value.length(); ++i) { + final char c = value.charAt(i); + switch (c) { + case '\\': + case '^': + case '$': + case '.': + case '|': + case '?': + case '*': + case '+': + case '(': + case ')': + case '[': + case '{': + sb.append('\\'); + default: + sb.append(c); + } + } + return sb; + } + + /** + * Get the short and long values displayed for a field + * + * @param cal The calendar to obtain the short and long values + * @param locale The locale of display names + * @param field The field of interest + * @param regex The regular expression to build + * @return The map of string display names to field values + */ + private static Map appendDisplayNames(final Calendar cal, final Locale locale, final int field, final StringBuilder regex) { + final Map values = new HashMap<>(); + + final Map displayNames = cal.getDisplayNames(field, Calendar.ALL_STYLES, locale); + final TreeSet sorted = new TreeSet<>(LONGER_FIRST_LOWERCASE); + for (final Map.Entry displayName : displayNames.entrySet()) { + final String key = displayName.getKey().toLowerCase(locale); + if (sorted.add(key)) { + values.put(key, displayName.getValue()); + } + } + for (final String symbol : sorted) { + simpleQuote(regex, symbol).append('|'); + } + return values; + } + + /** + * 使用当前的世纪调整两位数年份为四位数年份 + * + * @param twoDigitYear 两位数年份 + * @return A value between centuryStart(inclusive) to centuryStart+100(exclusive) + */ + private int adjustYear(final int twoDigitYear) { + final int trial = century + twoDigitYear; + return twoDigitYear >= startYear ? trial : trial + 100; + } + + /** + * 单个日期字段的分析策略 + */ + private static abstract class Strategy { + /** + * Is this field a number? The default implementation returns false. + * + * @return true, if field is a number + */ + boolean isNumber() { + return false; + } + + abstract boolean parse(FastDateParser parser, Calendar calendar, String source, ParsePosition pos, int maxWidth); + } + + /** + * A strategy to parse a single field from the parsing pattern + */ + private static abstract class PatternStrategy extends Strategy { + + private Pattern pattern; + + void createPattern(final StringBuilder regex) { + createPattern(regex.toString()); + } + + void createPattern(final String regex) { + this.pattern = Pattern.compile(regex); + } + + /** + * Is this field a number? The default implementation returns false. + * + * @return true, if field is a number + */ + @Override + boolean isNumber() { + return false; + } + + @Override + boolean parse(final FastDateParser parser, final Calendar calendar, final String source, final ParsePosition pos, final int maxWidth) { + final Matcher matcher = pattern.matcher(source.substring(pos.getIndex())); + if (!matcher.lookingAt()) { + pos.setErrorIndex(pos.getIndex()); + return false; + } + pos.setIndex(pos.getIndex() + matcher.end(1)); + setCalendar(parser, calendar, matcher.group(1)); + return true; + } + + abstract void setCalendar(FastDateParser parser, Calendar cal, String value); + } + + /** + * Obtain a Strategy given a field from a SimpleDateFormat pattern + * + * @param f 格式 + * @param width 长度 + * @param definingCalendar The calendar to obtain the short and long values + * @return The Strategy that will handle parsing for the field + */ + private Strategy getStrategy(final char f, final int width, final Calendar definingCalendar) { + switch (f) { + default: + throw new IllegalArgumentException("Format '" + f + "' not supported"); + case 'D': + return DAY_OF_YEAR_STRATEGY; + case 'E': + return getLocaleSpecificStrategy(Calendar.DAY_OF_WEEK, definingCalendar); + case 'F': + return DAY_OF_WEEK_IN_MONTH_STRATEGY; + case 'G': + return getLocaleSpecificStrategy(Calendar.ERA, definingCalendar); + case 'H': // Hour in day (0-23) + return HOUR_OF_DAY_STRATEGY; + case 'K': // Hour in am/pm (0-11) + return HOUR_STRATEGY; + case 'M': + return width >= 3 ? getLocaleSpecificStrategy(Calendar.MONTH, definingCalendar) : NUMBER_MONTH_STRATEGY; + case 'S': + return MILLISECOND_STRATEGY; + case 'W': + return WEEK_OF_MONTH_STRATEGY; + case 'a': + return getLocaleSpecificStrategy(Calendar.AM_PM, definingCalendar); + case 'd': + return DAY_OF_MONTH_STRATEGY; + case 'h': // Hour in am/pm (1-12), i.e. midday/midnight is 12, not 0 + return HOUR12_STRATEGY; + case 'k': // Hour in day (1-24), i.e. midnight is 24, not 0 + return HOUR24_OF_DAY_STRATEGY; + case 'm': + return MINUTE_STRATEGY; + case 's': + return SECOND_STRATEGY; + case 'u': + return DAY_OF_WEEK_STRATEGY; + case 'w': + return WEEK_OF_YEAR_STRATEGY; + case 'y': + case 'Y': + return width > 2 ? LITERAL_YEAR_STRATEGY : ABBREVIATED_YEAR_STRATEGY; + case 'X': + return ISO8601TimeZoneStrategy.getStrategy(width); + case 'Z': + if (width == 2) { + return ISO8601TimeZoneStrategy.ISO_8601_3_STRATEGY; + } + //$FALL-THROUGH$ + case 'z': + return getLocaleSpecificStrategy(Calendar.ZONE_OFFSET, definingCalendar); + } + } + + @SuppressWarnings("unchecked") // OK because we are creating an array with no entries + private static final ConcurrentMap[] CACHES = new ConcurrentMap[Calendar.FIELD_COUNT]; + + /** + * Get a cache of Strategies for a particular field + * + * @param field The Calendar field + * @return a cache of Locale to Strategy + */ + private static ConcurrentMap getCache(final int field) { + synchronized (CACHES) { + if (CACHES[field] == null) { + CACHES[field] = new SafeConcurrentHashMap<>(3); + } + return CACHES[field]; + } + } + + /** + * Construct a Strategy that parses a Text field + * + * @param field The Calendar field + * @param definingCalendar The calendar to obtain the short and long values + * @return a TextStrategy for the field and Locale + */ + private Strategy getLocaleSpecificStrategy(final int field, final Calendar definingCalendar) { + final ConcurrentMap cache = getCache(field); + Strategy strategy = cache.get(locale); + if (strategy == null) { + strategy = field == Calendar.ZONE_OFFSET ? new TimeZoneStrategy(locale) : new CaseInsensitiveTextStrategy(field, definingCalendar, locale); + final Strategy inCache = cache.putIfAbsent(locale, strategy); + if (inCache != null) { + return inCache; + } + } + return strategy; + } + + /** + * A strategy that copies the static or quoted field in the parsing pattern + */ + private static class CopyQuotedStrategy extends Strategy { + + final private String formatField; + + /** + * Construct a Strategy that ensures the formatField has literal text + * + * @param formatField The literal text to match + */ + CopyQuotedStrategy(final String formatField) { + this.formatField = formatField; + } + + @Override + boolean isNumber() { + return false; + } + + @Override + boolean parse(final FastDateParser parser, final Calendar calendar, final String source, final ParsePosition pos, final int maxWidth) { + for (int idx = 0; idx < formatField.length(); ++idx) { + final int sIdx = idx + pos.getIndex(); + if (sIdx == source.length()) { + pos.setErrorIndex(sIdx); + return false; + } + if (formatField.charAt(idx) != source.charAt(sIdx)) { + pos.setErrorIndex(sIdx); + return false; + } + } + pos.setIndex(formatField.length() + pos.getIndex()); + return true; + } + } + + /** + * A strategy that handles a text field in the parsing pattern + */ + private static class CaseInsensitiveTextStrategy extends PatternStrategy { + private final int field; + final Locale locale; + private final Map lKeyValues; + + /** + * Construct a Strategy that parses a Text field + * + * @param field The Calendar field + * @param definingCalendar The Calendar to use + * @param locale The Locale to use + */ + CaseInsensitiveTextStrategy(final int field, final Calendar definingCalendar, final Locale locale) { + this.field = field; + this.locale = locale; + + final StringBuilder regex = new StringBuilder(); + regex.append("((?iu)"); + lKeyValues = appendDisplayNames(definingCalendar, locale, field, regex); + regex.setLength(regex.length() - 1); + regex.append(")"); + createPattern(regex); + } + + @Override + void setCalendar(final FastDateParser parser, final Calendar cal, final String value) { + final Integer iVal = lKeyValues.get(value.toLowerCase(locale)); + cal.set(field, iVal); + } + } + + /** + * A strategy that handles a number field in the parsing pattern + */ + private static class NumberStrategy extends Strategy { + private final int field; + + /** + * Construct a Strategy that parses a Number field + * + * @param field The Calendar field + */ + NumberStrategy(final int field) { + this.field = field; + } + + @Override + boolean isNumber() { + return true; + } + + @Override + boolean parse(final FastDateParser parser, final Calendar calendar, final String source, final ParsePosition pos, final int maxWidth) { + int idx = pos.getIndex(); + int last = source.length(); + + if (maxWidth == 0) { + // if no maxWidth, strip leading white space + for (; idx < last; ++idx) { + final char c = source.charAt(idx); + if (!Character.isWhitespace(c)) { + break; + } + } + pos.setIndex(idx); + } else { + final int end = idx + maxWidth; + if (last > end) { + last = end; + } + } + + for (; idx < last; ++idx) { + final char c = source.charAt(idx); + if (!Character.isDigit(c)) { + break; + } + } + + if (pos.getIndex() == idx) { + pos.setErrorIndex(idx); + return false; + } + + final int value = Integer.parseInt(source.substring(pos.getIndex(), idx)); + pos.setIndex(idx); + + calendar.set(field, modify(parser, value)); + return true; + } + + /** + * Make any modifications to parsed integer + * + * @param parser The parser + * @param iValue The parsed integer + * @return The modified value + */ + int modify(final FastDateParser parser, final int iValue) { + return iValue; + } + + } + + private static final Strategy ABBREVIATED_YEAR_STRATEGY = new NumberStrategy(Calendar.YEAR) { + @Override + int modify(final FastDateParser parser, final int iValue) { + return iValue < 100 ? parser.adjustYear(iValue) : iValue; + } + }; + + /** + * A strategy that handles a timezone field in the parsing pattern + */ + static class TimeZoneStrategy extends PatternStrategy { + private static final String RFC_822_TIME_ZONE = "[+-]\\d{4}"; + private static final String UTC_TIME_ZONE_WITH_OFFSET = "[+-]\\d{2}:\\d{2}"; + private static final String GMT_OPTION = "GMT[+-]\\d{1,2}:\\d{2}"; + + private final Locale locale; + private final Map tzNames = new HashMap<>(); + + private static class TzInfo { + TimeZone zone; + int dstOffset; + + TzInfo(final TimeZone tz, final boolean useDst) { + zone = tz; + dstOffset = useDst ? tz.getDSTSavings() : 0; + } + } + + /** + * Index of zone id + */ + private static final int ID = 0; + + /** + * Construct a Strategy that parses a TimeZone + * + * @param locale The Locale + */ + TimeZoneStrategy(final Locale locale) { + this.locale = locale; + + final StringBuilder sb = new StringBuilder(); + sb.append("((?iu)" + RFC_822_TIME_ZONE + "|" + UTC_TIME_ZONE_WITH_OFFSET + "|" + GMT_OPTION); + + final Set sorted = new TreeSet<>(LONGER_FIRST_LOWERCASE); + + final String[][] zones = DateFormatSymbols.getInstance(locale).getZoneStrings(); + for (final String[] zoneNames : zones) { + // offset 0 is the time zone ID and is not localized + final String tzId = zoneNames[ID]; + if ("GMT".equalsIgnoreCase(tzId)) { + continue; + } + final TimeZone tz = TimeZone.getTimeZone(tzId); + // offset 1 is long standard name + // offset 2 is short standard name + final TzInfo standard = new TzInfo(tz, false); + TzInfo tzInfo = standard; + for (int i = 1; i < zoneNames.length; ++i) { + switch (i) { + case 3: // offset 3 is long daylight savings (or summertime) name + // offset 4 is the short summertime name + tzInfo = new TzInfo(tz, true); + break; + case 5: // offset 5 starts additional names, probably standard time + tzInfo = standard; + break; + } + if (zoneNames[i] != null) { + final String key = zoneNames[i].toLowerCase(locale); + // ignore the data associated with duplicates supplied in + // the additional names + if (sorted.add(key)) { + tzNames.put(key, tzInfo); + } + } + } + } + // order the regex alternatives with longer strings first, greedy + // match will ensure longest string will be consumed + for (final String zoneName : sorted) { + simpleQuote(sb.append('|'), zoneName); + } + sb.append(")"); + createPattern(sb); + } + + @Override + void setCalendar(final FastDateParser parser, final Calendar cal, final String value) { + if (value.charAt(0) == '+' || value.charAt(0) == '-') { + final TimeZone tz = TimeZone.getTimeZone("GMT" + value); + cal.setTimeZone(tz); + } else if (value.regionMatches(true, 0, "GMT", 0, 3)) { + final TimeZone tz = TimeZone.getTimeZone(value.toUpperCase()); + cal.setTimeZone(tz); + } else { + final TzInfo tzInfo = tzNames.get(value.toLowerCase(locale)); + cal.set(Calendar.DST_OFFSET, tzInfo.dstOffset); + //issue#I1AXIN@Gitee +// cal.set(Calendar.ZONE_OFFSET, tzInfo.zone.getRawOffset()); + cal.set(Calendar.ZONE_OFFSET, parser.getTimeZone().getRawOffset()); + } + } + } + + private static class ISO8601TimeZoneStrategy extends PatternStrategy { + // Z, +hh, -hh, +hhmm, -hhmm, +hh:mm or -hh:mm + + /** + * Construct a Strategy that parses a TimeZone + * + * @param pattern The Pattern + */ + ISO8601TimeZoneStrategy(final String pattern) { + createPattern(pattern); + } + + @Override + void setCalendar(final FastDateParser parser, final Calendar cal, final String value) { + if (Objects.equals(value, "Z")) { + cal.setTimeZone(TimeZone.getTimeZone("UTC")); + } else { + cal.setTimeZone(TimeZone.getTimeZone("GMT" + value)); + } + } + + private static final Strategy ISO_8601_1_STRATEGY = new ISO8601TimeZoneStrategy("(Z|(?:[+-]\\d{2}))"); + private static final Strategy ISO_8601_2_STRATEGY = new ISO8601TimeZoneStrategy("(Z|(?:[+-]\\d{2}\\d{2}))"); + private static final Strategy ISO_8601_3_STRATEGY = new ISO8601TimeZoneStrategy("(Z|(?:[+-]\\d{2}(?::)\\d{2}))"); + + /** + * Factory method for ISO8601TimeZoneStrategies. + * + * @param tokenLen a token indicating the length of the TimeZone String to be formatted. + * @return a ISO8601TimeZoneStrategy that can format TimeZone String of length {@code tokenLen}. If no such strategy exists, an IllegalArgumentException will be thrown. + */ + static Strategy getStrategy(final int tokenLen) { + switch (tokenLen) { + case 1: + return ISO_8601_1_STRATEGY; + case 2: + return ISO_8601_2_STRATEGY; + case 3: + return ISO_8601_3_STRATEGY; + default: + throw new IllegalArgumentException("invalid number of X"); + } + } + } + + private static final Strategy NUMBER_MONTH_STRATEGY = new NumberStrategy(Calendar.MONTH) { + @Override + int modify(final FastDateParser parser, final int iValue) { + return iValue - 1; + } + }; + private static final Strategy LITERAL_YEAR_STRATEGY = new NumberStrategy(Calendar.YEAR); + private static final Strategy WEEK_OF_YEAR_STRATEGY = new NumberStrategy(Calendar.WEEK_OF_YEAR); + private static final Strategy WEEK_OF_MONTH_STRATEGY = new NumberStrategy(Calendar.WEEK_OF_MONTH); + private static final Strategy DAY_OF_YEAR_STRATEGY = new NumberStrategy(Calendar.DAY_OF_YEAR); + private static final Strategy DAY_OF_MONTH_STRATEGY = new NumberStrategy(Calendar.DAY_OF_MONTH); + private static final Strategy DAY_OF_WEEK_STRATEGY = new NumberStrategy(Calendar.DAY_OF_WEEK) { + @Override + int modify(final FastDateParser parser, final int iValue) { + return iValue != 7 ? iValue + 1 : Calendar.SUNDAY; + } + }; + private static final Strategy DAY_OF_WEEK_IN_MONTH_STRATEGY = new NumberStrategy(Calendar.DAY_OF_WEEK_IN_MONTH); + private static final Strategy HOUR_OF_DAY_STRATEGY = new NumberStrategy(Calendar.HOUR_OF_DAY); + private static final Strategy HOUR24_OF_DAY_STRATEGY = new NumberStrategy(Calendar.HOUR_OF_DAY) { + @Override + int modify(final FastDateParser parser, final int iValue) { + return iValue == 24 ? 0 : iValue; + } + }; + private static final Strategy HOUR12_STRATEGY = new NumberStrategy(Calendar.HOUR) { + @Override + int modify(final FastDateParser parser, final int iValue) { + return iValue == 12 ? 0 : iValue; + } + }; + private static final Strategy HOUR_STRATEGY = new NumberStrategy(Calendar.HOUR); + private static final Strategy MINUTE_STRATEGY = new NumberStrategy(Calendar.MINUTE); + private static final Strategy SECOND_STRATEGY = new NumberStrategy(Calendar.SECOND); + private static final Strategy MILLISECOND_STRATEGY = new NumberStrategy(Calendar.MILLISECOND); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/FastDatePrinter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/FastDatePrinter.java new file mode 100644 index 0000000..6b12a7f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/FastDatePrinter.java @@ -0,0 +1,1323 @@ +package aiyh.utils.tool.cn.hutool.core.date.format; + +import aiyh.utils.tool.cn.hutool.core.date.DateException; +import aiyh.utils.tool.cn.hutool.core.map.SafeConcurrentHashMap; + +import java.io.IOException; +import java.io.ObjectInputStream; +import java.text.DateFormatSymbols; +import java.util.ArrayList; +import java.util.Calendar; +import java.util.Date; +import java.util.List; +import java.util.Locale; +import java.util.TimeZone; +import java.util.concurrent.ConcurrentMap; + +/** + * {@link java.text.SimpleDateFormat} 的线程安全版本，用于将 {@link Date} 格式化输出
+ * Thanks to Apache Commons Lang 3.5 + * + * @see FastDateParser + */ +public class FastDatePrinter extends AbstractDateBasic implements DatePrinter { + private static final long serialVersionUID = -6305750172255764887L; + + /** 规则列表. */ + private transient Rule[] rules; + /** 估算最大长度. */ + private transient int mMaxLengthEstimate; + + // Constructor + // ----------------------------------------------------------------------- + /** + * 构造，内部使用
+ * + * @param pattern 使用{@link java.text.SimpleDateFormat} 相同的日期格式 + * @param timeZone 非空时区{@link TimeZone} + * @param locale 非空{@link Locale} 日期地理位置 + */ + public FastDatePrinter(String pattern, TimeZone timeZone, Locale locale) { + super(pattern, timeZone, locale); + init(); + } + + /** + * 初始化 + */ + private void init() { + final List rulesList = parsePattern(); + rules = rulesList.toArray(new Rule[0]); + + int len = 0; + for (int i = rules.length; --i >= 0;) { + len += rules[i].estimateLength(); + } + + mMaxLengthEstimate = len; + } + + // Parse the pattern + // ----------------------------------------------------------------------- + /** + *

+ * Returns a list of Rules given a pattern. + *

+ * + * @return a {@code List} of Rule objects + * @throws IllegalArgumentException if pattern is invalid + */ + protected List parsePattern() { + final DateFormatSymbols symbols = new DateFormatSymbols(locale); + final List rules = new ArrayList<>(); + + final String[] ERAs = symbols.getEras(); + final String[] months = symbols.getMonths(); + final String[] shortMonths = symbols.getShortMonths(); + final String[] weekdays = symbols.getWeekdays(); + final String[] shortWeekdays = symbols.getShortWeekdays(); + final String[] AmPmStrings = symbols.getAmPmStrings(); + + final int length = pattern.length(); + final int[] indexRef = new int[1]; + + for (int i = 0; i < length; i++) { + indexRef[0] = i; + final String token = parseToken(pattern, indexRef); + i = indexRef[0]; + + final int tokenLen = token.length(); + if (tokenLen == 0) { + break; + } + + Rule rule; + final char c = token.charAt(0); + + switch (c) { + case 'G': // era designator (text) + rule = new TextField(Calendar.ERA, ERAs); + break; + case 'y': // year (number) + case 'Y': // week year + if (tokenLen == 2) { + rule = TwoDigitYearField.INSTANCE; + } else { + rule = selectNumberRule(Calendar.YEAR, Math.max(tokenLen, 4)); + } + if (c == 'Y') { + rule = new WeekYear((NumberRule) rule); + } + break; + case 'M': // month in year (text and number) + if (tokenLen >= 4) { + rule = new TextField(Calendar.MONTH, months); + } else if (tokenLen == 3) { + rule = new TextField(Calendar.MONTH, shortMonths); + } else if (tokenLen == 2) { + rule = TwoDigitMonthField.INSTANCE; + } else { + rule = UnpaddedMonthField.INSTANCE; + } + break; + case 'd': // day in month (number) + rule = selectNumberRule(Calendar.DAY_OF_MONTH, tokenLen); + break; + case 'h': // hour in am/pm (number, 1..12) + rule = new TwelveHourField(selectNumberRule(Calendar.HOUR, tokenLen)); + break; + case 'H': // hour in day (number, 0..23) + rule = selectNumberRule(Calendar.HOUR_OF_DAY, tokenLen); + break; + case 'm': // minute in hour (number) + rule = selectNumberRule(Calendar.MINUTE, tokenLen); + break; + case 's': // second in minute (number) + rule = selectNumberRule(Calendar.SECOND, tokenLen); + break; + case 'S': // millisecond (number) + rule = selectNumberRule(Calendar.MILLISECOND, tokenLen); + break; + case 'E': // day in week (text) + rule = new TextField(Calendar.DAY_OF_WEEK, tokenLen < 4 ? shortWeekdays : weekdays); + break; + case 'u': // day in week (number) + rule = new DayInWeekField(selectNumberRule(Calendar.DAY_OF_WEEK, tokenLen)); + break; + case 'D': // day in year (number) + rule = selectNumberRule(Calendar.DAY_OF_YEAR, tokenLen); + break; + case 'F': // day of week in month (number) + rule = selectNumberRule(Calendar.DAY_OF_WEEK_IN_MONTH, tokenLen); + break; + case 'w': // week in year (number) + rule = selectNumberRule(Calendar.WEEK_OF_YEAR, tokenLen); + break; + case 'W': // week in month (number) + rule = selectNumberRule(Calendar.WEEK_OF_MONTH, tokenLen); + break; + case 'a': // am/pm marker (text) + rule = new TextField(Calendar.AM_PM, AmPmStrings); + break; + case 'k': // hour in day (1..24) + rule = new TwentyFourHourField(selectNumberRule(Calendar.HOUR_OF_DAY, tokenLen)); + break; + case 'K': // hour in am/pm (0..11) + rule = selectNumberRule(Calendar.HOUR, tokenLen); + break; + case 'X': // ISO 8601 + rule = Iso8601_Rule.getRule(tokenLen); + break; + case 'z': // time zone (text) + if (tokenLen >= 4) { + rule = new TimeZoneNameRule(timeZone, locale, TimeZone.LONG); + } else { + rule = new TimeZoneNameRule(timeZone, locale, TimeZone.SHORT); + } + break; + case 'Z': // time zone (value) + if (tokenLen == 1) { + rule = TimeZoneNumberRule.INSTANCE_NO_COLON; + } else if (tokenLen == 2) { + rule = Iso8601_Rule.ISO8601_HOURS_COLON_MINUTES; + } else { + rule = TimeZoneNumberRule.INSTANCE_COLON; + } + break; + case '\'': // literal text + final String sub = token.substring(1); + if (sub.length() == 1) { + rule = new CharacterLiteral(sub.charAt(0)); + } else { + rule = new StringLiteral(sub); + } + break; + default: + throw new IllegalArgumentException("Illegal pattern component: " + token); + } + + rules.add(rule); + } + + return rules; + } + + /** + *

+ * Performs the parsing of tokens. + *

+ * + * @param pattern the pattern + * @param indexRef index references + * @return parsed token + */ + protected String parseToken(String pattern, int[] indexRef) { + final StringBuilder buf = new StringBuilder(); + + int i = indexRef[0]; + final int length = pattern.length(); + + char c = pattern.charAt(i); + if (c >= 'A' && c <= 'Z' || c >= 'a' && c <= 'z') { + // Scan a run of the same character, which indicates a time + // pattern. + buf.append(c); + + while (i + 1 < length) { + final char peek = pattern.charAt(i + 1); + if (peek == c) { + buf.append(c); + i++; + } else { + break; + } + } + } else { + // This will identify token as text. + buf.append('\''); + + boolean inLiteral = false; + + for (; i < length; i++) { + c = pattern.charAt(i); + + if (c == '\'') { + if (i + 1 < length && pattern.charAt(i + 1) == '\'') { + // '' is treated as escaped ' + i++; + buf.append(c); + } else { + inLiteral = !inLiteral; + } + } else if (!inLiteral && (c >= 'A' && c <= 'Z' || c >= 'a' && c <= 'z')) { + i--; + break; + } else { + buf.append(c); + } + } + } + + indexRef[0] = i; + return buf.toString(); + } + + /** + *

+ * Gets an appropriate rule for the padding required. + *

+ * + * @param field the field to get a rule for + * @param padding the padding required + * @return a new rule with the correct padding + */ + protected NumberRule selectNumberRule(int field, int padding) { + switch (padding) { + case 1: + return new UnpaddedNumberField(field); + case 2: + return new TwoDigitNumberField(field); + default: + return new PaddedNumberField(field, padding); + } + } + + // Format methods + // ----------------------------------------------------------------------- + + /** + *

+ * Formats a {@code Date}, {@code Calendar} or {@code Long} (milliseconds) object. + *

+ * + * @param obj the object to format + * @return The formatted value. + */ + String format(Object obj) { + if (obj instanceof Date) { + return format((Date) obj); + } else if (obj instanceof Calendar) { + return format((Calendar) obj); + } else if (obj instanceof Long) { + return format(((Long) obj).longValue()); + } else { + throw new IllegalArgumentException("Unknown class: " + (obj == null ? "" : obj.getClass().getName())); + } + } + + @Override + public String format(long millis) { + final Calendar c = Calendar.getInstance(timeZone, locale); + c.setTimeInMillis(millis); + return applyRulesToString(c); + } + + @Override + public String format(Date date) { + final Calendar c = Calendar.getInstance(timeZone, locale); + c.setTime(date); + return applyRulesToString(c); + } + + @Override + public String format(Calendar calendar) { + return format(calendar, new StringBuilder(mMaxLengthEstimate)).toString(); + } + + @Override + public B format(long millis, B buf) { + final Calendar c = Calendar.getInstance(timeZone, locale); + c.setTimeInMillis(millis); + return applyRules(c, buf); + } + + @Override + public B format(Date date, B buf) { + final Calendar c = Calendar.getInstance(timeZone, locale); + c.setTime(date); + return applyRules(c, buf); + } + + @Override + public B format(Calendar calendar, B buf) { + // do not pass in calendar directly, this will cause TimeZone of FastDatePrinter to be ignored + if (!calendar.getTimeZone().equals(timeZone)) { + calendar = (Calendar) calendar.clone(); + calendar.setTimeZone(timeZone); + } + return applyRules(calendar, buf); + } + + /** + * Creates a String representation of the given Calendar by applying the rules of this printer to it. + * + * @param c the Calender to apply the rules to. + * @return a String representation of the given Calendar. + */ + private String applyRulesToString(Calendar c) { + return applyRules(c, new StringBuilder(mMaxLengthEstimate)).toString(); + } + + /** + *

+ * Performs the formatting by applying the rules to the specified calendar. + *

+ * + * @param calendar the calendar to format + * @param buf the buffer to format into + * @param the Appendable class type, usually StringBuilder or StringBuffer. + * @return the specified string buffer + */ + private B applyRules(Calendar calendar, B buf) { + try { + for (final Rule rule : this.rules) { + rule.appendTo(buf, calendar); + } + } catch (final IOException e) { + throw new DateException(e); + } + return buf; + } + + /** + *估算生成的日期字符串长度
+ * 实际生成的字符串长度小于或等于此值 + * + * @return 日期字符串长度 + */ + public int getMaxLengthEstimate() { + return mMaxLengthEstimate; + } + + // Serializing + // ----------------------------------------------------------------------- + /** + * Create the object after serialization. This implementation reinitializes the transient properties. + * + * @param in ObjectInputStream from which the object is being deserialized. + * @throws IOException if there is an IO issue. + * @throws ClassNotFoundException if a class cannot be found. + */ + private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException { + in.defaultReadObject(); + init(); + } + + /** + * Appends two digits to the given buffer. + * + * @param buffer the buffer to append to. + * @param value the value to append digits from. + */ + private static void appendDigits(Appendable buffer, int value) throws IOException { + buffer.append((char) (value / 10 + '0')); + buffer.append((char) (value % 10 + '0')); + } + + private static final int MAX_DIGITS = 10; // log10(Integer.MAX_VALUE) ~= 9.3 + + /** + * Appends all digits to the given buffer. + * + * @param buffer the buffer to append to. + * @param value the value to append digits from. + */ + private static void appendFullDigits(Appendable buffer, int value, int minFieldWidth) throws IOException { + // specialized paths for 1 to 4 digits -> avoid the memory allocation from the temporary work array + // see LANG-1248 + if (value < 10000) { + // less memory allocation path works for four digits or less + + int nDigits = 4; + if (value < 1000) { + --nDigits; + if (value < 100) { + --nDigits; + if (value < 10) { + --nDigits; + } + } + } + // left zero pad + for (int i = minFieldWidth - nDigits; i > 0; --i) { + buffer.append('0'); + } + + switch (nDigits) { + case 4: + buffer.append((char) (value / 1000 + '0')); + value %= 1000; + case 3: + if (value >= 100) { + buffer.append((char) (value / 100 + '0')); + value %= 100; + } else { + buffer.append('0'); + } + case 2: + if (value >= 10) { + buffer.append((char) (value / 10 + '0')); + value %= 10; + } else { + buffer.append('0'); + } + case 1: + buffer.append((char) (value + '0')); + } + } else { + // more memory allocation path works for any digits + + // build up decimal representation in reverse + final char[] work = new char[MAX_DIGITS]; + int digit = 0; + while (value != 0) { + work[digit++] = (char) (value % 10 + '0'); + value = value / 10; + } + + // pad with zeros + while (digit < minFieldWidth) { + buffer.append('0'); + --minFieldWidth; + } + + // reverse + while (--digit >= 0) { + buffer.append(work[digit]); + } + } + } + + // Rules + // ----------------------------------------------------------------------- + /** + * 规则 + */ + private interface Rule { + /** + * Returns the estimated length of the result. + * + * @return the estimated length + */ + int estimateLength(); + + /** + * Appends the value of the specified calendar to the output buffer based on the rule implementation. + * + * @param buf the output buffer + * @param calendar calendar to be appended + * @throws IOException if an I/O error occurs + */ + void appendTo(Appendable buf, Calendar calendar) throws IOException; + } + + /** + *

+ * Inner class defining a numeric rule. + *

+ */ + private interface NumberRule extends Rule { + /** + * Appends the specified value to the output buffer based on the rule implementation. + * + * @param buffer the output buffer + * @param value the value to be appended + * @throws IOException if an I/O error occurs + */ + void appendTo(Appendable buffer, int value) throws IOException; + } + + /** + *

+ * Inner class to output a constant single character. + *

+ */ + private static class CharacterLiteral implements Rule { + private final char mValue; + + /** + * Constructs a new instance of {@code CharacterLiteral} to hold the specified value. + * + * @param value the character literal + */ + CharacterLiteral(final char value) { + mValue = value; + } + + @Override + public int estimateLength() { + return 1; + } + + @Override + public void appendTo(final Appendable buffer, final Calendar calendar) throws IOException { + buffer.append(mValue); + } + } + + /** + *

+ * Inner class to output a constant string. + *

+ */ + private static class StringLiteral implements Rule { + private final String mValue; + + /** + * Constructs a new instance of {@code StringLiteral} to hold the specified value. + * + * @param value the string literal + */ + StringLiteral(String value) { + mValue = value; + } + + /** + * {@inheritDoc} + */ + @Override + public int estimateLength() { + return mValue.length(); + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + buffer.append(mValue); + } + } + + /** + *

+ * Inner class to output one of a set of values. + *

+ */ + private static class TextField implements Rule { + private final int mField; + private final String[] mValues; + + /** + * Constructs an instance of {@code TextField} with the specified field and values. + * + * @param field the field + * @param values the field values + */ + TextField(int field, String[] values) { + mField = field; + mValues = values; + } + + /** + * {@inheritDoc} + */ + @Override + public int estimateLength() { + int max = 0; + for (int i = mValues.length; --i >= 0;) { + final int len = mValues[i].length(); + if (len > max) { + max = len; + } + } + return max; + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + buffer.append(mValues[calendar.get(mField)]); + } + } + + /** + *

+ * Inner class to output an unpadded number. + *

+ */ + private static class UnpaddedNumberField implements NumberRule { + private final int mField; + + /** + * Constructs an instance of {@code UnpadedNumberField} with the specified field. + * + * @param field the field + */ + UnpaddedNumberField(int field) { + mField = field; + } + + /** + * {@inheritDoc} + */ + @Override + public int estimateLength() { + return 4; + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + appendTo(buffer, calendar.get(mField)); + } + + /** + * {@inheritDoc} + */ + @Override + public final void appendTo(Appendable buffer, int value) throws IOException { + if (value < 10) { + buffer.append((char) (value + '0')); + } else if (value < 100) { + appendDigits(buffer, value); + } else { + appendFullDigits(buffer, value, 1); + } + } + } + + /** + *

+ * Inner class to output an unpadded month. + *

+ */ + private static class UnpaddedMonthField implements NumberRule { + static final UnpaddedMonthField INSTANCE = new UnpaddedMonthField(); + + /** + * Constructs an instance of {@code UnpaddedMonthField}. + * + */ + UnpaddedMonthField() { + } + + /** + * {@inheritDoc} + */ + @Override + public int estimateLength() { + return 2; + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + appendTo(buffer, calendar.get(Calendar.MONTH) + 1); + } + + /** + * {@inheritDoc} + */ + @Override + public final void appendTo(Appendable buffer, int value) throws IOException { + if (value < 10) { + buffer.append((char) (value + '0')); + } else { + appendDigits(buffer, value); + } + } + } + + /** + *

+ * Inner class to output a padded number. + *

+ */ + private static class PaddedNumberField implements NumberRule { + private final int mField; + private final int mSize; + + /** + * Constructs an instance of {@code PaddedNumberField}. + * + * @param field the field + * @param size size of the output field + */ + PaddedNumberField(int field, int size) { + if (size < 3) { + // Should use UnpaddedNumberField or TwoDigitNumberField. + throw new IllegalArgumentException(); + } + mField = field; + mSize = size; + } + + /** + * {@inheritDoc} + */ + @Override + public int estimateLength() { + return mSize; + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + appendTo(buffer, calendar.get(mField)); + } + + /** + * {@inheritDoc} + */ + @Override + public final void appendTo(Appendable buffer, int value) throws IOException { + appendFullDigits(buffer, value, mSize); + } + } + + /** + *

+ * Inner class to output a two digit number. + *

+ */ + private static class TwoDigitNumberField implements NumberRule { + private final int mField; + + /** + * Constructs an instance of {@code TwoDigitNumberField} with the specified field. + * + * @param field the field + */ + TwoDigitNumberField(int field) { + mField = field; + } + + /** + * {@inheritDoc} + */ + @Override + public int estimateLength() { + return 2; + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + appendTo(buffer, calendar.get(mField)); + } + + /** + * {@inheritDoc} + */ + @Override + public final void appendTo(Appendable buffer, int value) throws IOException { + if (value < 100) { + appendDigits(buffer, value); + } else { + appendFullDigits(buffer, value, 2); + } + } + } + + /** + *

+ * Inner class to output a two digit year. + *

+ */ + private static class TwoDigitYearField implements NumberRule { + static final TwoDigitYearField INSTANCE = new TwoDigitYearField(); + + /** + * Constructs an instance of {@code TwoDigitYearField}. + */ + TwoDigitYearField() { + } + + /** + * {@inheritDoc} + */ + @Override + public int estimateLength() { + return 2; + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + appendTo(buffer, calendar.get(Calendar.YEAR) % 100); + } + + /** + * {@inheritDoc} + */ + @Override + public final void appendTo(Appendable buffer, int value) throws IOException { + appendDigits(buffer, value); + } + } + + /** + *

+ * Inner class to output a two digit month. + *

+ */ + private static class TwoDigitMonthField implements NumberRule { + static final TwoDigitMonthField INSTANCE = new TwoDigitMonthField(); + + /** + * Constructs an instance of {@code TwoDigitMonthField}. + */ + TwoDigitMonthField() { + } + + /** + * {@inheritDoc} + */ + @Override + public int estimateLength() { + return 2; + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + appendTo(buffer, calendar.get(Calendar.MONTH) + 1); + } + + /** + * {@inheritDoc} + */ + @Override + public final void appendTo(Appendable buffer, int value) throws IOException { + appendDigits(buffer, value); + } + } + + /** + *

+ * Inner class to output the twelve hour field. + *

+ */ + private static class TwelveHourField implements NumberRule { + private final NumberRule mRule; + + /** + * Constructs an instance of {@code TwelveHourField} with the specified {@code NumberRule}. + * + * @param rule the rule + */ + TwelveHourField(final NumberRule rule) { + mRule = rule; + } + + /** + * {@inheritDoc} + */ + @Override + public int estimateLength() { + return mRule.estimateLength(); + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + int value = calendar.get(Calendar.HOUR); + if (value == 0) { + value = calendar.getLeastMaximum(Calendar.HOUR) + 1; + } + mRule.appendTo(buffer, value); + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, int value) throws IOException { + mRule.appendTo(buffer, value); + } + } + + /** + *

+ * Inner class to output the twenty four hour field. + *

+ */ + private static class TwentyFourHourField implements NumberRule { + private final NumberRule mRule; + + /** + * Constructs an instance of {@code TwentyFourHourField} with the specified {@code NumberRule}. + * + * @param rule the rule + */ + TwentyFourHourField(NumberRule rule) { + mRule = rule; + } + + /** + * {@inheritDoc} + */ + @Override + public int estimateLength() { + return mRule.estimateLength(); + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + int value = calendar.get(Calendar.HOUR_OF_DAY); + if (value == 0) { + value = calendar.getMaximum(Calendar.HOUR_OF_DAY) + 1; + } + mRule.appendTo(buffer, value); + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, int value) throws IOException { + mRule.appendTo(buffer, value); + } + } + + /** + *

+ * Inner class to output the numeric day in week. + *

+ */ + private static class DayInWeekField implements NumberRule { + private final NumberRule mRule; + + DayInWeekField(NumberRule rule) { + mRule = rule; + } + + @Override + public int estimateLength() { + return mRule.estimateLength(); + } + + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + final int value = calendar.get(Calendar.DAY_OF_WEEK); + mRule.appendTo(buffer, value != Calendar.SUNDAY ? value - 1 : 7); + } + + @Override + public void appendTo(Appendable buffer, int value) throws IOException { + mRule.appendTo(buffer, value); + } + } + + /** + *

+ * Inner class to output the numeric day in week. + *

+ */ + private static class WeekYear implements NumberRule { + private final NumberRule mRule; + + WeekYear(final NumberRule rule) { + mRule = rule; + } + + @Override + public int estimateLength() { + return mRule.estimateLength(); + } + + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + mRule.appendTo(buffer, calendar.getWeekYear()); + } + + @Override + public void appendTo(Appendable buffer, int value) throws IOException { + mRule.appendTo(buffer, value); + } + } + + // ----------------------------------------------------------------------- + + private static final ConcurrentMap C_TIME_ZONE_DISPLAY_CACHE = new SafeConcurrentHashMap<>(7); + + /** + *

+ * Gets the time zone display name, using a cache for performance. + *

+ * + * @param tz the zone to query + * @param daylight true if daylight savings + * @param style the style to use {@code TimeZone.LONG} or {@code TimeZone.SHORT} + * @param locale the locale to use + * @return the textual name of the time zone + */ + static String getTimeZoneDisplay(TimeZone tz, boolean daylight, int style, Locale locale) { + final TimeZoneDisplayKey key = new TimeZoneDisplayKey(tz, daylight, style, locale); + String value = C_TIME_ZONE_DISPLAY_CACHE.get(key); + if (value == null) { + // This is a very slow call, so cache the results. + value = tz.getDisplayName(daylight, style, locale); + final String prior = C_TIME_ZONE_DISPLAY_CACHE.putIfAbsent(key, value); + if (prior != null) { + value = prior; + } + } + return value; + } + + /** + *

+ * Inner class to output a time zone name. + *

+ */ + private static class TimeZoneNameRule implements Rule { + private final Locale mLocale; + private final int mStyle; + private final String mStandard; + private final String mDaylight; + + /** + * Constructs an instance of {@code TimeZoneNameRule} with the specified properties. + * + * @param timeZone the time zone + * @param locale the locale + * @param style the style + */ + TimeZoneNameRule(TimeZone timeZone, Locale locale, int style) { + mLocale = locale; + mStyle = style; + + mStandard = getTimeZoneDisplay(timeZone, false, style, locale); + mDaylight = getTimeZoneDisplay(timeZone, true, style, locale); + } + + /** + * {@inheritDoc} + */ + @Override + public int estimateLength() { + // We have no access to the Calendar object that will be passed to + // appendTo so base estimate on the TimeZone passed to the + // constructor + return Math.max(mStandard.length(), mDaylight.length()); + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + final TimeZone zone = calendar.getTimeZone(); + if (calendar.get(Calendar.DST_OFFSET) != 0) { + buffer.append(getTimeZoneDisplay(zone, true, mStyle, mLocale)); + } else { + buffer.append(getTimeZoneDisplay(zone, false, mStyle, mLocale)); + } + } + } + + /** + *

+ * Inner class to output a time zone as a number {@code +/-HHMM} or {@code +/-HH:MM}. + *

+ */ + private static class TimeZoneNumberRule implements Rule { + static final TimeZoneNumberRule INSTANCE_COLON = new TimeZoneNumberRule(true); + static final TimeZoneNumberRule INSTANCE_NO_COLON = new TimeZoneNumberRule(false); + + final boolean mColon; + + /** + * Constructs an instance of {@code TimeZoneNumberRule} with the specified properties. + * + * @param colon add colon between HH and MM in the output if {@code true} + */ + TimeZoneNumberRule(boolean colon) { + mColon = colon; + } + + /** + * {@inheritDoc} + */ + @Override + public int estimateLength() { + return 5; + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(Appendable buffer, Calendar calendar) throws IOException { + + int offset = calendar.get(Calendar.ZONE_OFFSET) + calendar.get(Calendar.DST_OFFSET); + + if (offset < 0) { + buffer.append('-'); + offset = -offset; + } else { + buffer.append('+'); + } + + final int hours = offset / (60 * 60 * 1000); + appendDigits(buffer, hours); + + if (mColon) { + buffer.append(':'); + } + + final int minutes = offset / (60 * 1000) - 60 * hours; + appendDigits(buffer, minutes); + } + } + + /** + *

+ * Inner class to output a time zone as a number {@code +/-HHMM} or {@code +/-HH:MM}. + *

+ */ + private static class Iso8601_Rule implements Rule { + + // Sign TwoDigitHours or Z + static final Iso8601_Rule ISO8601_HOURS = new Iso8601_Rule(3); + // Sign TwoDigitHours Minutes or Z + static final Iso8601_Rule ISO8601_HOURS_MINUTES = new Iso8601_Rule(5); + // Sign TwoDigitHours : Minutes or Z + static final Iso8601_Rule ISO8601_HOURS_COLON_MINUTES = new Iso8601_Rule(6); + + /** + * Factory method for Iso8601_Rules. + * + * @param tokenLen a token indicating the length of the TimeZone String to be formatted. + * @return a Iso8601_Rule that can format TimeZone String of length {@code tokenLen}. If no such rule exists, an IllegalArgumentException will be thrown. + */ + static Iso8601_Rule getRule(int tokenLen) { + switch (tokenLen) { + case 1: + return Iso8601_Rule.ISO8601_HOURS; + case 2: + return Iso8601_Rule.ISO8601_HOURS_MINUTES; + case 3: + return Iso8601_Rule.ISO8601_HOURS_COLON_MINUTES; + default: + throw new IllegalArgumentException("invalid number of X"); + } + } + + final int length; + + /** + * Constructs an instance of {@code Iso8601_Rule} with the specified properties. + * + * @param length The number of characters in output (unless Z is output) + */ + Iso8601_Rule(int length) { + this.length = length; + } + + /** + * {@inheritDoc} + */ + @Override + public int estimateLength() { + return length; + } + + /** + * {@inheritDoc} + */ + @Override + public void appendTo(final Appendable buffer, final Calendar calendar) throws IOException { + int offset = calendar.get(Calendar.ZONE_OFFSET) + calendar.get(Calendar.DST_OFFSET); + if (offset == 0) { + buffer.append("Z"); + return; + } + + if (offset < 0) { + buffer.append('-'); + offset = -offset; + } else { + buffer.append('+'); + } + + final int hours = offset / (60 * 60 * 1000); + appendDigits(buffer, hours); + + if (length < 5) { + return; + } + + if (length == 6) { + buffer.append(':'); + } + + final int minutes = offset / (60 * 1000) - 60 * hours; + appendDigits(buffer, minutes); + } + } + + // ---------------------------------------------------------------------- + /** + *

+ * Inner class that acts as a compound key for time zone names. + *

+ */ + private static class TimeZoneDisplayKey { + private final TimeZone mTimeZone; + private final int mStyle; + private final Locale mLocale; + + /** + * Constructs an instance of {@code TimeZoneDisplayKey} with the specified properties. + * + * @param timeZone the time zone + * @param daylight adjust the style for daylight saving time if {@code true} + * @param style the timezone style + * @param locale the timezone locale + */ + TimeZoneDisplayKey(final TimeZone timeZone, final boolean daylight, final int style, final Locale locale) { + mTimeZone = timeZone; + if (daylight) { + mStyle = style | 0x80000000; + } else { + mStyle = style; + } + mLocale = locale; + } + + /** + * {@inheritDoc} + */ + @Override + public int hashCode() { + return (mStyle * 31 + mLocale.hashCode()) * 31 + mTimeZone.hashCode(); + } + + /** + * {@inheritDoc} + */ + @Override + public boolean equals(final Object obj) { + if (this == obj) { + return true; + } + if (obj instanceof TimeZoneDisplayKey) { + final TimeZoneDisplayKey other = (TimeZoneDisplayKey) obj; + return mTimeZone.equals(other.mTimeZone) && mStyle == other.mStyle && mLocale.equals(other.mLocale); + } + return false; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/FormatCache.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/FormatCache.java new file mode 100644 index 0000000..0dad5cd --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/FormatCache.java @@ -0,0 +1,175 @@ +package aiyh.utils.tool.cn.hutool.core.date.format; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Tuple; +import aiyh.utils.tool.cn.hutool.core.map.SafeConcurrentHashMap; + +import java.text.DateFormat; +import java.text.Format; +import java.text.SimpleDateFormat; +import java.util.Locale; +import java.util.TimeZone; +import java.util.concurrent.ConcurrentMap; + +/** + * 日期格式化器缓存
+ * Thanks to Apache Commons Lang 3.5 + * + * @since 2.16.2 + */ +abstract class FormatCache { + + /** + * No date or no time. Used in same parameters as DateFormat.SHORT or DateFormat.LONG + */ + static final int NONE = -1; + + private final ConcurrentMap cInstanceCache = new SafeConcurrentHashMap<>(7); + + private static final ConcurrentMap C_DATE_TIME_INSTANCE_CACHE = new SafeConcurrentHashMap<>(7); + + /** + * 使用默认的pattern、timezone和locale获得缓存中的实例 + * + * @return a date/time formatter + */ + public F getInstance() { + return getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT, null, null); + } + + /** + * 使用 pattern, time zone and locale 获得对应的 格式化器 + * + * @param pattern 非空日期格式，使用与 {@link java.text.SimpleDateFormat}相同格式 + * @param timeZone 时区，默认当前时区 + * @param locale 地区，默认使用当前地区 + * @return 格式化器 + * @throws IllegalArgumentException pattern 无效或{@code null} + */ + public F getInstance(final String pattern, TimeZone timeZone, Locale locale) { + Assert.notBlank(pattern, "pattern must not be blank"); + if (timeZone == null) { + timeZone = TimeZone.getDefault(); + } + if (locale == null) { + locale = Locale.getDefault(); + } + final Tuple key = new Tuple(pattern, timeZone, locale); + F format = cInstanceCache.get(key); + if (format == null) { + format = createInstance(pattern, timeZone, locale); + final F previousValue = cInstanceCache.putIfAbsent(key, format); + if (previousValue != null) { + // another thread snuck in and did the same work + // we should return the instance that is in ConcurrentMap + format = previousValue; + } + } + return format; + } + + /** + * 创建格式化器 + * + * @param pattern 非空日期格式，使用与 {@link java.text.SimpleDateFormat}相同格式 + * @param timeZone 时区，默认当前时区 + * @param locale 地区，默认使用当前地区 + * @return 格式化器 + * @throws IllegalArgumentException pattern 无效或{@code null} + */ + abstract protected F createInstance(String pattern, TimeZone timeZone, Locale locale); + + /** + *

+ * Gets a date/time formatter instance using the specified style, time zone and locale. + *

+ * + * @param dateStyle date style: FULL, LONG, MEDIUM, or SHORT, null indicates no date in format + * @param timeStyle time style: FULL, LONG, MEDIUM, or SHORT, null indicates no time in format + * @param timeZone optional time zone, overrides time zone of formatted date, null means use default Locale + * @param locale optional locale, overrides system locale + * @return a localized standard date/time formatter + * @throws IllegalArgumentException if the Locale has no date/time pattern defined + */ + // This must remain private, see LANG-884 + F getDateTimeInstance(final Integer dateStyle, final Integer timeStyle, final TimeZone timeZone, Locale locale) { + if (locale == null) { + locale = Locale.getDefault(); + } + final String pattern = getPatternForStyle(dateStyle, timeStyle, locale); + return getInstance(pattern, timeZone, locale); + } + + /** + *

+ * Gets a date formatter instance using the specified style, time zone and locale. + *

+ * + * @param dateStyle date style: FULL, LONG, MEDIUM, or SHORT + * @param timeZone optional time zone, overrides time zone of formatted date, null means use default Locale + * @param locale optional locale, overrides system locale + * @return a localized standard date/time formatter + * @throws IllegalArgumentException if the Locale has no date/time pattern defined + */ + // package protected, for access from FastDateFormat; do not make public or protected + F getDateInstance(final int dateStyle, final TimeZone timeZone, final Locale locale) { + return getDateTimeInstance(dateStyle, null, timeZone, locale); + } + + /** + *

+ * Gets a time formatter instance using the specified style, time zone and locale. + *

+ * + * @param timeStyle time style: FULL, LONG, MEDIUM, or SHORT + * @param timeZone optional time zone, overrides time zone of formatted date, null means use default Locale + * @param locale optional locale, overrides system locale + * @return a localized standard date/time formatter + * @throws IllegalArgumentException if the Locale has no date/time pattern defined + */ + // package protected, for access from FastDateFormat; do not make public or protected + F getTimeInstance(final int timeStyle, final TimeZone timeZone, final Locale locale) { + return getDateTimeInstance(null, timeStyle, timeZone, locale); + } + + /** + *

+ * Gets a date/time format for the specified styles and locale. + *

+ * + * @param dateStyle date style: FULL, LONG, MEDIUM, or SHORT, null indicates no date in format + * @param timeStyle time style: FULL, LONG, MEDIUM, or SHORT, null indicates no time in format + * @param locale The non-null locale of the desired format + * @return a localized standard date/time format + * @throws IllegalArgumentException if the Locale has no date/time pattern defined + */ + // package protected, for access from test code; do not make public or protected + static String getPatternForStyle(final Integer dateStyle, final Integer timeStyle, final Locale locale) { + final Tuple key = new Tuple(dateStyle, timeStyle, locale); + + String pattern = C_DATE_TIME_INSTANCE_CACHE.get(key); + if (pattern == null) { + try { + DateFormat formatter; + if (dateStyle == null) { + formatter = DateFormat.getTimeInstance(timeStyle, locale); + } else if (timeStyle == null) { + formatter = DateFormat.getDateInstance(dateStyle, locale); + } else { + formatter = DateFormat.getDateTimeInstance(dateStyle, timeStyle, locale); + } + pattern = ((SimpleDateFormat) formatter).toPattern(); + final String previous = C_DATE_TIME_INSTANCE_CACHE.putIfAbsent(key, pattern); + if (previous != null) { + // even though it doesn't matter if another thread put the pattern + // it's still good practice to return the String instance that is + // actually in the ConcurrentMap + pattern = previous; + } + } catch (final ClassCastException ex) { + throw new IllegalArgumentException("No date time pattern for locale: " + locale); + } + } + return pattern; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/GlobalCustomFormat.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/GlobalCustomFormat.java new file mode 100755 index 0000000..e768b44 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/GlobalCustomFormat.java @@ -0,0 +1,119 @@ +package aiyh.utils.tool.cn.hutool.core.date.format; + +import aiyh.utils.tool.cn.hutool.core.date.DateUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.map.SafeConcurrentHashMap; + +import java.time.temporal.TemporalAccessor; +import java.util.Date; +import java.util.Map; +import java.util.function.Function; + +/** + * 全局自定义格式
+ * 用于定义用户指定的日期格式和输出日期的关系 + * + * @author looly + * @since 5.7.2 + */ +public class GlobalCustomFormat { + + public static final String FORMAT_SECONDS = "#sss"; + public static final String FORMAT_MILLISECONDS = "#SSS"; + + private static final Map> formatterMap; + private static final Map> parserMap; + + static { + formatterMap = new SafeConcurrentHashMap<>(); + parserMap = new SafeConcurrentHashMap<>(); + + // Hutool预设的几种自定义格式 + putFormatter(FORMAT_SECONDS, (date) -> String.valueOf(Math.floorDiv(date.getTime(), 1000))); + putParser(FORMAT_SECONDS, (dateStr) -> DateUtil.date(Math.multiplyExact(Long.parseLong(dateStr.toString()), 1000))); + + putFormatter(FORMAT_MILLISECONDS, (date) -> String.valueOf(date.getTime())); + putParser(FORMAT_MILLISECONDS, (dateStr) -> DateUtil.date(Long.parseLong(dateStr.toString()))); + } + + /** + * 加入日期格式化规则 + * + * @param format 格式 + * @param func 格式化函数 + */ + public static void putFormatter(String format, Function func) { + Assert.notNull(format, "Format must be not null !"); + Assert.notNull(func, "Function must be not null !"); + formatterMap.put(format, func); + } + + /** + * 加入日期解析规则 + * + * @param format 格式 + * @param func 解析函数 + */ + public static void putParser(String format, Function func) { + Assert.notNull(format, "Format must be not null !"); + Assert.notNull(func, "Function must be not null !"); + parserMap.put(format, func); + } + + /** + * 检查指定格式是否为自定义格式 + * + * @param format 格式 + * @return 是否为自定义格式 + */ + public static boolean isCustomFormat(String format) { + return formatterMap.containsKey(format); + } + + /** + * 使用自定义格式格式化日期 + * + * @param date 日期 + * @param format 自定义格式 + * @return 格式化后的日期 + */ + public static String format(Date date, CharSequence format) { + if (null != formatterMap) { + final Function func = formatterMap.get(format); + if (null != func) { + return func.apply(date); + } + } + + return null; + } + + /** + * 使用自定义格式格式化日期 + * + * @param temporalAccessor 日期 + * @param format 自定义格式 + * @return 格式化后的日期 + */ + public static String format(TemporalAccessor temporalAccessor, CharSequence format) { + return format(DateUtil.date(temporalAccessor), format); + } + + /** + * 使用自定义格式解析日期 + * + * @param dateStr 日期字符串 + * @param format 自定义格式 + * @return 格式化后的日期 + */ + public static Date parse(CharSequence dateStr, String format) { + if (null != parserMap) { + final Function func = parserMap.get(format); + if (null != func) { + return func.apply(dateStr); + } + } + + return null; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/package-info.java new file mode 100644 index 0000000..381604e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/format/package-info.java @@ -0,0 +1,7 @@ +/** + * 提供线程安全的日期格式的格式化和解析实现 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.date.format; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/date/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/package-info.java new file mode 100644 index 0000000..55eb5c3 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/date/package-info.java @@ -0,0 +1,7 @@ +/** + * 日期封装，日期的核心为DateTime类，DateUtil提供日期操作的入口 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.date; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/CheckedUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/CheckedUtil.java new file mode 100755 index 0000000..3119f84 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/CheckedUtil.java @@ -0,0 +1,325 @@ +package aiyh.utils.tool.cn.hutool.core.exceptions; + +import aiyh.utils.tool.cn.hutool.core.lang.func.*; + +import java.util.Objects; + +/** + * 方便的执行会抛出受检查类型异常的方法调用或者代码段 + *

+ * 该工具通过函数式的方式将那些需要抛出受检查异常的表达式或者代码段转化成一个 aiyh.utils.tool.cn.hutool.core.lang.func.Func* 对象 + *

+ *

+ * {@code + * 

+ *      //代码中如果遇到一个方法调用声明了受检查异常那么我们的代码就必须这样写
+ *         Map describedObject = null;
+ *         try {
+ *             describe = BeanUtils.describe(new Object());
+ *         } catch (IllegalAccessException e) {
+ *             throw new RuntimeException(e);
+ *         } catch (InvocationTargetException e) {
+ *             throw new RuntimeException(e);
+ *         } catch (NoSuchMethodException e) {
+ *             throw new RuntimeException(e);
+ *         }
+ *         // use describedObject ...
+ *
+ *       //上面的代码增加了异常块使得代码不那么流畅，现在可以这样写：
+ *       Map describedObject = CheckedUtil.uncheck(BeanUtils::describe).call(new Object());
+ *       // use describedObject ...
+ *
+ *       CheckedUtil.uncheck 方法接受任意可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.Func* 函数式接口的 Lambda 表达式。返回对应的函数式对象。
+ *       上述代码可以理解为：
+ *        Func0> aFunc = CheckedUtil.uncheck(BeanUtils::describe);
+ *        Map describedObject = aFunc.call(传入参数);
+ *        该aFunc对象代表的就是BeanUtils::describe这个表达式，且在内部转化了检查类型异常，不需要代码里面显示处理。
+ *
+ *
+ *
+ * } + * + * @author conder + * @since 5.7.19 + */ +public class CheckedUtil { + + /** + * 接收一个可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.Func 的Lambda表达式，当执行表达式抛出任何异常的时候，都会转化成运行时异常 + * 如此一来，代码中就不用显示的try-catch转化成运行时异常 + * + * @param expression Lambda表达式 + * @param

运行时传入的参数类型 + * @param 最终返回的数据类型 + * @return {@link FuncRt} + */ + public static FuncRt uncheck(Func expression) { + return uncheck(expression, RuntimeException::new); + } + + /** + * 接收一个可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.Func0 的Lambda表达式，当执行表达式抛出任何异常的时候，都会转化成运行时异常 + * 如此一来，代码中就不用显示的try-catch转化成运行时异常 + * + * @param expression 运行时传入的参数类型 + * @param 最终返回的数据类型 + * @return {@link Func0Rt} + */ + public static Func0Rt uncheck(Func0 expression) { + return uncheck(expression, RuntimeException::new); + } + + /** + * 接收一个可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.Func1 的Lambda表达式，当执行表达式抛出任何异常的时候，都会转化成运行时异常 + * 如此一来，代码中就不用显示的try-catch转化成运行时异常 + * + * @param expression 运行时传入的参数类型 + * @param

运行时传入的参数类型 + * @param 最终返回的数据类型 + * @return {@link Func1Rt} + */ + public static Func1Rt uncheck(Func1 expression) { + return uncheck(expression, RuntimeException::new); + } + + + /** + * 接收一个可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.VoidFunc 的Lambda表达式，当执行表达式抛出任何异常的时候，都会转化成运行时异常 + * 如此一来，代码中就不用显示的try-catch转化成运行时异常 + * + * @param expression 运行时传入的参数类型 + * @param

运行时传入的参数类型 + * @return {@link VoidFuncRt} + */ + public static

VoidFuncRt

uncheck(VoidFunc

expression) { + return uncheck(expression, RuntimeException::new); + } + + /** + * 接收一个可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.VoidFunc0 的Lambda表达式，当执行表达式抛出任何异常的时候，都会转化成运行时异常 + * 如此一来，代码中就不用显示的try-catch转化成运行时异常 + * + * @param expression 运行时传入的参数类型 + * @return {@link VoidFunc0Rt} + */ + public static VoidFunc0Rt uncheck(VoidFunc0 expression) { + return uncheck(expression, RuntimeException::new); + } + + /** + * 接收一个可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.VoidFunc1 的Lambda表达式，当执行表达式抛出任何异常的时候，都会转化成运行时异常 + * 如此一来，代码中就不用显示的try-catch转化成运行时异常 + * + * @param expression 运行时传入的参数类型 + * @param

运行时传入的参数类型 + * @return {@link VoidFunc1Rt} + */ + public static

VoidFunc1Rt

uncheck(VoidFunc1

expression) { + return uncheck(expression, RuntimeException::new); + } + + + /** + * 接收一个可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.Func的Lambda表达式，和一个可以把Exception转化成RuntimeExceptionde的表达式，当执行表达式抛出任何异常的时候，都会转化成运行时异常 + * 如此一来，代码中就不用显示的try-catch转化成运行时异常 + * + * @param expression Lambda表达式 + * @param rteSupplier 转化运行时异常的表达式 + * @param

运行时传入的参数类型 + * @param 最终返回的数据类型 + * @return {@link FuncRt} + */ + public static FuncRt uncheck(Func expression, Supplier1 rteSupplier) { + Objects.requireNonNull(expression, "expression can not be null"); + return t -> { + try { + return expression.call(t); + } catch (Exception e) { + if (rteSupplier == null) { + throw new RuntimeException(e); + } else { + throw rteSupplier.get(e); + } + } + }; + } + + /** + * 接收一个可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.Func0的Lambda表达式，和一个可以把Exception转化成RuntimeExceptionde的表达式，当执行表达式抛出任何异常的时候，都会转化成运行时异常 + * 如此一来，代码中就不用显示的try-catch转化成运行时异常 + * + * @param expression Lambda表达式 + * @param rteSupplier 转化运行时异常的表达式 + * @param 最终返回的数据类型 + * @return {@link Func0Rt} + */ + public static Func0Rt uncheck(Func0 expression, Supplier1 rteSupplier) { + Objects.requireNonNull(expression, "expression can not be null"); + return () -> { + try { + return expression.call(); + } catch (Exception e) { + if (rteSupplier == null) { + throw new RuntimeException(e); + } else { + throw rteSupplier.get(e); + } + } + }; + } + + /** + * 接收一个可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.Func1的Lambda表达式，和一个可以把Exception转化成RuntimeExceptionde的表达式，当执行表达式抛出任何异常的时候，都会转化成运行时异常 + * 如此一来，代码中就不用显示的try-catch转化成运行时异常 + * + * @param expression Lambda表达式 + * @param rteSupplier 转化运行时异常的表达式 + * @param

运行时传入的参数类型 + * @param 最终返回的数据类型 + * @return {@link Func1Rt} + */ + public static Func1Rt uncheck(Func1 expression, Supplier1 rteSupplier) { + Objects.requireNonNull(expression, "expression can not be null"); + return t -> { + try { + return expression.call(t); + } catch (Exception e) { + if (rteSupplier == null) { + throw new RuntimeException(e); + } else { + throw rteSupplier.get(e); + } + } + }; + } + + /** + * 接收一个可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.VoidFunc的Lambda表达式，和一个可以把Exception转化成RuntimeExceptionde的表达式，当执行表达式抛出任何异常的时候，都会转化成运行时异常 + * 如此一来，代码中就不用显示的try-catch转化成运行时异常 + * + * @param expression Lambda表达式 + * @param rteSupplier 转化运行时异常的表达式 + * @param

运行时传入的参数类型 + * @return {@link VoidFuncRt} + */ + public static

VoidFuncRt

uncheck(VoidFunc

expression, Supplier1 rteSupplier) { + Objects.requireNonNull(expression, "expression can not be null"); + return t -> { + try { + expression.call(t); + } catch (Exception e) { + if (rteSupplier == null) { + throw new RuntimeException(e); + } else { + throw rteSupplier.get(e); + } + } + }; + } + + + /** + * 接收一个可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.VoidFunc0的Lambda表达式，和一个RuntimeException，当执行表达式抛出任何异常的时候，都会转化成运行时异常 + * 如此一来，代码中就不用显示的try-catch转化成运行时异常 + * + * @param expression Lambda表达式 + * @param rte 期望抛出的运行时异常 + * @return {@link VoidFunc0Rt} + */ + public static VoidFunc0Rt uncheck(VoidFunc0 expression, RuntimeException rte) { + Objects.requireNonNull(expression, "expression can not be null"); + return () -> { + try { + expression.call(); + } catch (Exception e) { + if (rte == null) { + throw new RuntimeException(e); + } else { + rte.initCause(e); + throw rte; + } + } + }; + } + + /** + * 接收一个可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.VoidFunc0的Lambda表达式，和一个可以把Exception转化成RuntimeExceptionde的表达式，当执行表达式抛出任何异常的时候，都会转化成运行时异常 + * 如此一来，代码中就不用显示的try-catch转化成运行时异常 + * + * @param expression Lambda表达式 + * @param rteSupplier 转化运行时异常的表达式 + * @return {@link VoidFunc0Rt} + */ + public static VoidFunc0Rt uncheck(VoidFunc0 expression, Supplier1 rteSupplier) { + Objects.requireNonNull(expression, "expression can not be null"); + return () -> { + try { + expression.call(); + } catch (Exception e) { + if (rteSupplier == null) { + throw new RuntimeException(e); + } else { + throw rteSupplier.get(e); + } + } + }; + } + + /** + * 接收一个可以转化成 aiyh.utils.tool.cn.hutool.core.lang.func.VoidFunc1的Lambda表达式，和一个RuntimeException，当执行表达式抛出任何异常的时候，都会转化成运行时异常 + * 如此一来，代码中就不用显示的try-catch转化成运行时异常 + * + * @param expression Lambda表达式 + * @param rteSupplier 转化运行时异常的表达式 + * @param

运行时传入的参数类型 + * @return {@link VoidFunc1Rt} + */ + public static

VoidFunc1Rt

uncheck(VoidFunc1

expression, Supplier1 rteSupplier) { + Objects.requireNonNull(expression, "expression can not be null"); + return t -> { + try { + expression.call(t); + } catch (Exception e) { + if (rteSupplier == null) { + throw new RuntimeException(e); + } else { + throw rteSupplier.get(e); + } + } + }; + } + + public interface FuncRt extends Func { + @SuppressWarnings("unchecked") + @Override + R call(P... parameters) throws RuntimeException; + } + + public interface Func0Rt extends Func0 { + @Override + R call() throws RuntimeException; + } + + public interface Func1Rt extends Func1 { + @Override + R call(P parameter) throws RuntimeException; + } + + public interface VoidFuncRt

extends VoidFunc

{ + @SuppressWarnings("unchecked") + @Override + void call(P... parameters) throws RuntimeException; + } + + public interface VoidFunc0Rt extends VoidFunc0 { + @Override + void call() throws RuntimeException; + } + + public interface VoidFunc1Rt

extends VoidFunc1

{ + @Override + void call(P parameter) throws RuntimeException; + } + + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/DependencyException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/DependencyException.java new file mode 100644 index 0000000..0fb9ec7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/DependencyException.java @@ -0,0 +1,37 @@ +package aiyh.utils.tool.cn.hutool.core.exceptions; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 依赖异常 + * + * @author xiaoleilu + * @since 4.0.10 + */ +public class DependencyException extends RuntimeException { + private static final long serialVersionUID = 8247610319171014183L; + + public DependencyException(Throwable e) { + super(ExceptionUtil.getMessage(e), e); + } + + public DependencyException(String message) { + super(message); + } + + public DependencyException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public DependencyException(String message, Throwable throwable) { + super(message, throwable); + } + + public DependencyException(String message, Throwable throwable, boolean enableSuppression, boolean writableStackTrace) { + super(message, throwable, enableSuppression, writableStackTrace); + } + + public DependencyException(Throwable throwable, String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params), throwable); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/ExceptionUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/ExceptionUtil.java new file mode 100644 index 0000000..cb7bbc1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/ExceptionUtil.java @@ -0,0 +1,428 @@ +package aiyh.utils.tool.cn.hutool.core.exceptions; + +import aiyh.utils.tool.cn.hutool.core.io.FastByteArrayOutputStream; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.PrintStream; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.UndeclaredThrowableException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * 异常工具类 + * + * @author Looly + */ +public class ExceptionUtil { + + /** + * 获得完整消息，包括异常名，消息格式为：{SimpleClassName}: {ThrowableMessage} + * + * @param e 异常 + * @return 完整消息 + */ + public static String getMessage(Throwable e) { + if (null == e) { + return StrUtil.NULL; + } + return StrUtil.format("{}: {}", e.getClass().getSimpleName(), e.getMessage()); + } + + /** + * 获得消息，调用异常类的getMessage方法 + * + * @param e 异常 + * @return 消息 + */ + public static String getSimpleMessage(Throwable e) { + return (null == e) ? StrUtil.NULL : e.getMessage(); + } + + /** + * 使用运行时异常包装编译异常
+ *

+ * 如果传入参数已经是运行时异常，则直接返回，不再额外包装 + * + * @param throwable 异常 + * @return 运行时异常 + */ + public static RuntimeException wrapRuntime(Throwable throwable) { + if (throwable instanceof RuntimeException) { + return (RuntimeException) throwable; + } + return new RuntimeException(throwable); + } + + /** + * 将指定的消息包装为运行时异常 + * + * @param message 异常消息 + * @return 运行时异常 + * @since 5.5.2 + */ + public static RuntimeException wrapRuntime(String message) { + return new RuntimeException(message); + } + + /** + * 包装一个异常 + * + * @param 被包装的异常类型 + * @param throwable 异常 + * @param wrapThrowable 包装后的异常类 + * @return 包装后的异常 + * @since 3.3.0 + */ + @SuppressWarnings("unchecked") + public static T wrap(Throwable throwable, Class wrapThrowable) { + if (wrapThrowable.isInstance(throwable)) { + return (T) throwable; + } + return ReflectUtil.newInstance(wrapThrowable, throwable); + } + + /** + * 包装异常并重新抛出此异常
+ * {@link RuntimeException} 和{@link Error} 直接抛出，其它检查异常包装为{@link UndeclaredThrowableException} 后抛出 + * + * @param throwable 异常 + */ + public static void wrapAndThrow(Throwable throwable) { + if (throwable instanceof RuntimeException) { + throw (RuntimeException) throwable; + } + if (throwable instanceof Error) { + throw (Error) throwable; + } + throw new UndeclaredThrowableException(throwable); + } + + /** + * 将消息包装为运行时异常并抛出 + * + * @param message 异常消息 + * @since 5.5.2 + */ + public static void wrapRuntimeAndThrow(String message) { + throw new RuntimeException(message); + } + + /** + * 剥离反射引发的InvocationTargetException、UndeclaredThrowableException中间异常，返回业务本身的异常 + * + * @param wrapped 包装的异常 + * @return 剥离后的异常 + */ + public static Throwable unwrap(Throwable wrapped) { + Throwable unwrapped = wrapped; + while (true) { + if (unwrapped instanceof InvocationTargetException) { + unwrapped = ((InvocationTargetException) unwrapped).getTargetException(); + } else if (unwrapped instanceof UndeclaredThrowableException) { + unwrapped = ((UndeclaredThrowableException) unwrapped).getUndeclaredThrowable(); + } else { + return unwrapped; + } + } + } + + /** + * 获取当前栈信息 + * + * @return 当前栈信息 + */ + public static StackTraceElement[] getStackElements() { + // return (new Throwable()).getStackTrace(); + return Thread.currentThread().getStackTrace(); + } + + /** + * 获取指定层的堆栈信息 + * + * @param i 层数 + * @return 指定层的堆栈信息 + * @since 4.1.4 + */ + public static StackTraceElement getStackElement(int i) { + return Thread.currentThread().getStackTrace()[i]; + } + + /** + * 获取指定层的堆栈信息 + * + * @param fqcn 指定类名为基础 + * @param i 指定类名的类堆栈相对层数 + * @return 指定层的堆栈信息 + * @since 5.6.6 + */ + public static StackTraceElement getStackElement(String fqcn, int i) { + final StackTraceElement[] stackTraceArray = Thread.currentThread().getStackTrace(); + final int index = ArrayUtil.matchIndex((ele) -> StrUtil.equals(fqcn, ele.getClassName()), stackTraceArray); + if(index > 0){ + return stackTraceArray[index + i]; + } + + return null; + } + + /** + * 获取入口堆栈信息 + * + * @return 入口堆栈信息 + * @since 4.1.4 + */ + public static StackTraceElement getRootStackElement() { + final StackTraceElement[] stackElements = Thread.currentThread().getStackTrace(); + return Thread.currentThread().getStackTrace()[stackElements.length - 1]; + } + + /** + * 堆栈转为单行完整字符串 + * + * @param throwable 异常对象 + * @return 堆栈转为的字符串 + */ + public static String stacktraceToOneLineString(Throwable throwable) { + return stacktraceToOneLineString(throwable, 3000); + } + + /** + * 堆栈转为单行完整字符串 + * + * @param throwable 异常对象 + * @param limit 限制最大长度 + * @return 堆栈转为的字符串 + */ + public static String stacktraceToOneLineString(Throwable throwable, int limit) { + Map replaceCharToStrMap = new HashMap<>(); + replaceCharToStrMap.put(StrUtil.C_CR, StrUtil.SPACE); + replaceCharToStrMap.put(StrUtil.C_LF, StrUtil.SPACE); + replaceCharToStrMap.put(StrUtil.C_TAB, StrUtil.SPACE); + + return stacktraceToString(throwable, limit, replaceCharToStrMap); + } + + /** + * 堆栈转为完整字符串 + * + * @param throwable 异常对象 + * @return 堆栈转为的字符串 + */ + public static String stacktraceToString(Throwable throwable) { + return stacktraceToString(throwable, 3000); + } + + /** + * 堆栈转为完整字符串 + * + * @param throwable 异常对象 + * @param limit 限制最大长度 + * @return 堆栈转为的字符串 + */ + public static String stacktraceToString(Throwable throwable, int limit) { + return stacktraceToString(throwable, limit, null); + } + + /** + * 堆栈转为完整字符串 + * + * @param throwable 异常对象 + * @param limit 限制最大长度，<0表示不限制长度 + * @param replaceCharToStrMap 替换字符为指定字符串 + * @return 堆栈转为的字符串 + */ + public static String stacktraceToString(Throwable throwable, int limit, Map replaceCharToStrMap) { + final FastByteArrayOutputStream baos = new FastByteArrayOutputStream(); + throwable.printStackTrace(new PrintStream(baos)); + + final String exceptionStr = baos.toString(); + final int length = exceptionStr.length(); + if (limit < 0 || limit > length) { + limit = length; + } + + if (MapUtil.isNotEmpty(replaceCharToStrMap)) { + final StringBuilder sb = StrUtil.builder(); + char c; + String value; + for (int i = 0; i < limit; i++) { + c = exceptionStr.charAt(i); + value = replaceCharToStrMap.get(c); + if (null != value) { + sb.append(value); + } else { + sb.append(c); + } + } + return sb.toString(); + } else { + if(limit == length){ + return exceptionStr; + } + return StrUtil.subPre(exceptionStr, limit); + } + } + + /** + * 判断是否由指定异常类引起 + * + * @param throwable 异常 + * @param causeClasses 定义的引起异常的类 + * @return 是否由指定异常类引起 + * @since 4.1.13 + */ + @SuppressWarnings("unchecked") + public static boolean isCausedBy(Throwable throwable, Class... causeClasses) { + return null != getCausedBy(throwable, causeClasses); + } + + /** + * 获取由指定异常类引起的异常 + * + * @param throwable 异常 + * @param causeClasses 定义的引起异常的类 + * @return 是否由指定异常类引起 + * @since 4.1.13 + */ + @SuppressWarnings("unchecked") + public static Throwable getCausedBy(Throwable throwable, Class... causeClasses) { + Throwable cause = throwable; + while (cause != null) { + for (Class causeClass : causeClasses) { + if (causeClass.isInstance(cause)) { + return cause; + } + } + cause = cause.getCause(); + } + return null; + } + + /** + * 判断指定异常是否来自或者包含指定异常 + * + * @param throwable 异常 + * @param exceptionClass 定义的引起异常的类 + * @return true 来自或者包含 + * @since 4.3.2 + */ + public static boolean isFromOrSuppressedThrowable(Throwable throwable, Class exceptionClass) { + return convertFromOrSuppressedThrowable(throwable, exceptionClass, true) != null; + } + + /** + * 判断指定异常是否来自或者包含指定异常 + * + * @param throwable 异常 + * @param exceptionClass 定义的引起异常的类 + * @param checkCause 判断cause + * @return true 来自或者包含 + * @since 4.4.1 + */ + public static boolean isFromOrSuppressedThrowable(Throwable throwable, Class exceptionClass, boolean checkCause) { + return convertFromOrSuppressedThrowable(throwable, exceptionClass, checkCause) != null; + } + + /** + * 转化指定异常为来自或者包含指定异常 + * + * @param 异常类型 + * @param throwable 异常 + * @param exceptionClass 定义的引起异常的类 + * @return 结果为null 不是来自或者包含 + * @since 4.3.2 + */ + public static T convertFromOrSuppressedThrowable(Throwable throwable, Class exceptionClass) { + return convertFromOrSuppressedThrowable(throwable, exceptionClass, true); + } + + /** + * 转化指定异常为来自或者包含指定异常 + * + * @param 异常类型 + * @param throwable 异常 + * @param exceptionClass 定义的引起异常的类 + * @param checkCause 判断cause + * @return 结果为null 不是来自或者包含 + * @since 4.4.1 + */ + @SuppressWarnings("unchecked") + public static T convertFromOrSuppressedThrowable(Throwable throwable, Class exceptionClass, boolean checkCause) { + if (throwable == null || exceptionClass == null) { + return null; + } + if (exceptionClass.isAssignableFrom(throwable.getClass())) { + return (T) throwable; + } + if (checkCause) { + Throwable cause = throwable.getCause(); + if (cause != null && exceptionClass.isAssignableFrom(cause.getClass())) { + return (T) cause; + } + } + Throwable[] throwables = throwable.getSuppressed(); + if (ArrayUtil.isNotEmpty(throwables)) { + for (Throwable throwable1 : throwables) { + if (exceptionClass.isAssignableFrom(throwable1.getClass())) { + return (T) throwable1; + } + } + } + return null; + } + + /** + * 获取异常链上所有异常的集合，如果{@link Throwable} 对象没有cause，返回只有一个节点的List
+ * 如果传入null，返回空集合 + * + *

+ * 此方法来自Apache-Commons-Lang3 + *

+ * + * @param throwable 异常对象，可以为null + * @return 异常链中所有异常集合 + * @since 4.6.2 + */ + public static List getThrowableList(Throwable throwable) { + final List list = new ArrayList<>(); + while (throwable != null && false == list.contains(throwable)) { + list.add(throwable); + throwable = throwable.getCause(); + } + return list; + } + + /** + * 获取异常链中最尾端的异常，即异常最早发生的异常对象。
+ * 此方法通过调用{@link Throwable#getCause()} 直到没有cause为止，如果异常本身没有cause，返回异常本身
+ * 传入null返回也为null + * + *

+ * 此方法来自Apache-Commons-Lang3 + *

+ * + * @param throwable 异常对象，可能为null + * @return 最尾端异常，传入null参数返回也为null + */ + public static Throwable getRootCause(final Throwable throwable) { + final List list = getThrowableList(throwable); + return list.size() < 1 ? null : list.get(list.size() - 1); + } + + /** + * 获取异常链中最尾端的异常的消息，消息格式为：{SimpleClassName}: {ThrowableMessage} + * + * @param th 异常 + * @return 消息 + * @since 4.6.2 + */ + public static String getRootCauseMessage(final Throwable th) { + return getMessage(getRootCause(th)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/InvocationTargetRuntimeException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/InvocationTargetRuntimeException.java new file mode 100644 index 0000000..602620d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/InvocationTargetRuntimeException.java @@ -0,0 +1,34 @@ +package aiyh.utils.tool.cn.hutool.core.exceptions; + +/** + * InvocationTargetException的运行时异常 + * + * @author looly + * @since 5.8.1 + */ +public class InvocationTargetRuntimeException extends UtilException { + + public InvocationTargetRuntimeException(Throwable e) { + super(e); + } + + public InvocationTargetRuntimeException(String message) { + super(message); + } + + public InvocationTargetRuntimeException(String messageTemplate, Object... params) { + super(messageTemplate, params); + } + + public InvocationTargetRuntimeException(String message, Throwable throwable) { + super(message, throwable); + } + + public InvocationTargetRuntimeException(String message, Throwable throwable, boolean enableSuppression, boolean writableStackTrace) { + super(message, throwable, enableSuppression, writableStackTrace); + } + + public InvocationTargetRuntimeException(Throwable throwable, String messageTemplate, Object... params) { + super(throwable, messageTemplate, params); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/NotInitedException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/NotInitedException.java new file mode 100644 index 0000000..2603483 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/NotInitedException.java @@ -0,0 +1,36 @@ +package aiyh.utils.tool.cn.hutool.core.exceptions; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 未初始化异常 + * + * @author xiaoleilu + */ +public class NotInitedException extends RuntimeException { + private static final long serialVersionUID = 8247610319171014183L; + + public NotInitedException(Throwable e) { + super(e); + } + + public NotInitedException(String message) { + super(message); + } + + public NotInitedException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public NotInitedException(String message, Throwable throwable) { + super(message, throwable); + } + + public NotInitedException(String message, Throwable throwable, boolean enableSuppression, boolean writableStackTrace) { + super(message, throwable, enableSuppression, writableStackTrace); + } + + public NotInitedException(Throwable throwable, String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params), throwable); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/StatefulException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/StatefulException.java new file mode 100644 index 0000000..76c0dd6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/StatefulException.java @@ -0,0 +1,60 @@ +package aiyh.utils.tool.cn.hutool.core.exceptions; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 带有状态码的异常 + * + * @author xiaoleilu + */ +public class StatefulException extends RuntimeException { + private static final long serialVersionUID = 6057602589533840889L; + + // 异常状态码 + private int status; + + public StatefulException() { + } + + public StatefulException(String msg) { + super(msg); + } + + public StatefulException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public StatefulException(Throwable throwable) { + super(throwable); + } + + public StatefulException(String msg, Throwable throwable) { + super(msg, throwable); + } + + public StatefulException(String message, Throwable throwable, boolean enableSuppression, boolean writableStackTrace) { + super(message, throwable, enableSuppression, writableStackTrace); + } + + public StatefulException(int status, String msg) { + super(msg); + this.status = status; + } + + public StatefulException(int status, Throwable throwable) { + super(throwable); + this.status = status; + } + + public StatefulException(int status, String msg, Throwable throwable) { + super(msg, throwable); + this.status = status; + } + + /** + * @return 获得异常状态码 + */ + public int getStatus() { + return status; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/UtilException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/UtilException.java new file mode 100644 index 0000000..613eae0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/UtilException.java @@ -0,0 +1,36 @@ +package aiyh.utils.tool.cn.hutool.core.exceptions; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 工具类异常 + * + * @author xiaoleilu + */ +public class UtilException extends RuntimeException { + private static final long serialVersionUID = 8247610319171014183L; + + public UtilException(Throwable e) { + super(ExceptionUtil.getMessage(e), e); + } + + public UtilException(String message) { + super(message); + } + + public UtilException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public UtilException(String message, Throwable throwable) { + super(message, throwable); + } + + public UtilException(String message, Throwable throwable, boolean enableSuppression, boolean writableStackTrace) { + super(message, throwable, enableSuppression, writableStackTrace); + } + + public UtilException(Throwable throwable, String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params), throwable); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/ValidateException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/ValidateException.java new file mode 100644 index 0000000..6cd2159 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/ValidateException.java @@ -0,0 +1,47 @@ +package aiyh.utils.tool.cn.hutool.core.exceptions; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 验证异常 + * + * @author xiaoleilu + */ +public class ValidateException extends StatefulException { + private static final long serialVersionUID = 6057602589533840889L; + + public ValidateException() { + } + + public ValidateException(String msg) { + super(msg); + } + + public ValidateException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public ValidateException(Throwable throwable) { + super(throwable); + } + + public ValidateException(String msg, Throwable throwable) { + super(msg, throwable); + } + + public ValidateException(int status, String msg) { + super(status, msg); + } + + public ValidateException(int status, Throwable throwable) { + super(status, throwable); + } + + public ValidateException(String message, Throwable throwable, boolean enableSuppression, boolean writableStackTrace) { + super(message, throwable, enableSuppression, writableStackTrace); + } + + public ValidateException(int status, String msg, Throwable throwable) { + super(status, msg, throwable); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/package-info.java new file mode 100644 index 0000000..79eb28c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/exceptions/package-info.java @@ -0,0 +1,7 @@ +/** + * 特殊异常封装，同时提供异常工具ExceptionUtil + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.exceptions; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/ArrayTypeGetter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/ArrayTypeGetter.java new file mode 100644 index 0000000..c355169 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/ArrayTypeGetter.java @@ -0,0 +1,102 @@ +package aiyh.utils.tool.cn.hutool.core.getter; + +import java.math.BigDecimal; +import java.math.BigInteger; + +/** + * 数组类型的Get接口 + * @author Looly + * + */ +public interface ArrayTypeGetter { + /*-------------------------- 数组类型 start -------------------------------*/ + + /** + * 获取Object型属性值数组 + * + * @param key 属性名 + * @return 属性值列表 + */ + String[] getObjs(String key); + + /** + * 获取String型属性值数组 + * + * @param key 属性名 + * @return 属性值列表 + */ + String[] getStrs(String key); + + /** + * 获取Integer型属性值数组 + * + * @param key 属性名 + * @return 属性值列表 + */ + Integer[] getInts(String key); + + /** + * 获取Short型属性值数组 + * + * @param key 属性名 + * @return 属性值列表 + */ + Short[] getShorts(String key); + + /** + * 获取Boolean型属性值数组 + * + * @param key 属性名 + * @return 属性值列表 + */ + Boolean[] getBools(String key); + + /** + * 获取Long型属性值数组 + * + * @param key 属性名 + * @return 属性值列表 + */ + Long[] getLongs(String key); + + /** + * 获取Character型属性值数组 + * + * @param key 属性名 + * @return 属性值列表 + */ + Character[] getChars(String key); + + /** + * 获取Double型属性值数组 + * + * @param key 属性名 + * @return 属性值列表 + */ + Double[] getDoubles(String key); + + /** + * 获取Byte型属性值数组 + * + * @param key 属性名 + * @return 属性值列表 + */ + Byte[] getBytes(String key); + + /** + * 获取BigInteger型属性值数组 + * + * @param key 属性名 + * @return 属性值列表 + */ + BigInteger[] getBigIntegers(String key); + + /** + * 获取BigDecimal型属性值数组 + * + * @param key 属性名 + * @return 属性值列表 + */ + BigDecimal[] getBigDecimals(String key); + /*-------------------------- 数组类型 end -------------------------------*/ +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/BasicTypeGetter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/BasicTypeGetter.java new file mode 100644 index 0000000..992e50f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/BasicTypeGetter.java @@ -0,0 +1,131 @@ +package aiyh.utils.tool.cn.hutool.core.getter; + +import java.math.BigDecimal; +import java.math.BigInteger; +import java.util.Date; + +/** + * 基本类型的getter接口
+ * 提供一个统一的接口定义返回不同类型的值（基本类型）
+ * + * @author Looly + * @param key类型 + */ +public interface BasicTypeGetter { + /*-------------------------- 基本类型 start -------------------------------*/ + + /** + * 获取Object属性值 + * + * @param key 属性名 + * @return 属性值 + */ + Object getObj(K key); + + /** + * 获取字符串型属性值 + * + * @param key 属性名 + * @return 属性值 + */ + String getStr(K key); + + /** + * 获取int型属性值 + * + * @param key 属性名 + * @return 属性值 + */ + Integer getInt(K key); + + /** + * 获取short型属性值 + * + * @param key 属性名 + * @return 属性值 + */ + Short getShort(K key); + + /** + * 获取boolean型属性值 + * + * @param key 属性名 + * @return 属性值 + */ + Boolean getBool(K key); + + /** + * 获取long型属性值 + * + * @param key 属性名 + * @return 属性值 + */ + Long getLong(K key); + + /** + * 获取char型属性值 + * + * @param key 属性名 + * @return 属性值 + */ + Character getChar(K key); + + /** + * 获取float型属性值
+ * + * @param key 属性名 + * @return 属性值 + */ + Float getFloat(K key); + + /** + * 获取double型属性值 + * + * @param key 属性名 + * @return 属性值 + */ + Double getDouble(K key); + + /** + * 获取byte型属性值 + * + * @param key 属性名 + * @return 属性值 + */ + Byte getByte(K key); + + /** + * 获取BigDecimal型属性值 + * + * @param key 属性名 + * @return 属性值 + */ + BigDecimal getBigDecimal(K key); + + /** + * 获取BigInteger型属性值 + * + * @param key 属性名 + * @return 属性值 + */ + BigInteger getBigInteger(K key); + + /** + * 获得Enum类型的值 + * + * @param 枚举类型 + * @param clazz Enum的Class + * @param key KEY + * @return Enum类型的值，无则返回Null + */ + > E getEnum(Class clazz, K key); + + /** + * 获取Date类型值 + * + * @param key 属性名 + * @return Date类型属性值 + */ + Date getDate(K key); + /*-------------------------- 基本类型 end -------------------------------*/ +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/GroupedTypeGetter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/GroupedTypeGetter.java new file mode 100644 index 0000000..fdad6f9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/GroupedTypeGetter.java @@ -0,0 +1,103 @@ +package aiyh.utils.tool.cn.hutool.core.getter; + +import java.math.BigDecimal; +import java.math.BigInteger; + +/** + * 基于分组的Get接口 + * @author Looly + * + */ +public interface GroupedTypeGetter { + /*-------------------------- 基本类型 start -------------------------------*/ + /** + * 获取字符串型属性值
+ * + * @param key 属性名 + * @param group 分组 + * @return 属性值 + */ + String getStrByGroup(String key, String group); + + /** + * 获取int型属性值
+ * + * @param key 属性名 + * @param group 分组 + * @return 属性值 + */ + Integer getIntByGroup(String key, String group); + + /** + * 获取short型属性值
+ * + * @param key 属性名 + * @param group 分组 + * @return 属性值 + */ + Short getShortByGroup(String key, String group); + + /** + * 获取boolean型属性值
+ * + * @param key 属性名 + * @param group 分组 + * @return 属性值 + */ + Boolean getBoolByGroup(String key, String group); + + /** + * 获取Long型属性值
+ * + * @param key 属性名 + * @param group 分组 + * @return 属性值 + */ + Long getLongByGroup(String key, String group); + + /** + * 获取char型属性值
+ * + * @param key 属性名 + * @param group 分组 + * @return 属性值 + */ + Character getCharByGroup(String key, String group); + + /** + * 获取double型属性值
+ * + * @param key 属性名 + * @param group 分组 + * @return 属性值 + */ + Double getDoubleByGroup(String key, String group); + + /** + * 获取byte型属性值
+ * + * @param key 属性名 + * @param group 分组 + * @return 属性值 + */ + Byte getByteByGroup(String key, String group); + + /** + * 获取BigDecimal型属性值
+ * + * @param key 属性名 + * @param group 分组 + * @return 属性值 + */ + BigDecimal getBigDecimalByGroup(String key, String group); + + /** + * 获取BigInteger型属性值
+ * + * @param key 属性名 + * @param group 分组 + * @return 属性值 + */ + BigInteger getBigIntegerByGroup(String key, String group); + /*-------------------------- 基本类型 end -------------------------------*/ +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/ListTypeGetter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/ListTypeGetter.java new file mode 100644 index 0000000..623dfc7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/ListTypeGetter.java @@ -0,0 +1,102 @@ +package aiyh.utils.tool.cn.hutool.core.getter; + +import java.math.BigDecimal; +import java.math.BigInteger; +import java.util.List; + +/** + * 列表类型的Get接口 + * @author Looly + * + */ +public interface ListTypeGetter { + /*-------------------------- List类型 start -------------------------------*/ + /** + * 获取Object型属性值列表 + * + * @param key 属性名 + * @return 属性值列表 + */ + List getObjList(String key); + + /** + * 获取String型属性值列表 + * + * @param key 属性名 + * @return 属性值列表 + */ + List getStrList(String key); + + /** + * 获取Integer型属性值列表 + * + * @param key 属性名 + * @return 属性值列表 + */ + List getIntList(String key); + + /** + * 获取Short型属性值列表 + * + * @param key 属性名 + * @return 属性值列表 + */ + List getShortList(String key); + + /** + * 获取Boolean型属性值列表 + * + * @param key 属性名 + * @return 属性值列表 + */ + List getBoolList(String key); + + /** + * 获取Long型属性值列表 + * + * @param key 属性名 + * @return 属性值列表 + */ + List getLongList(String key); + + /** + * 获取Character型属性值列表 + * + * @param key 属性名 + * @return 属性值列表 + */ + List getCharList(String key); + + /** + * 获取Double型属性值列表 + * + * @param key 属性名 + * @return 属性值列表 + */ + List getDoubleList(String key); + + /** + * 获取Byte型属性值列表 + * + * @param key 属性名 + * @return 属性值列表 + */ + List getByteList(String key); + + /** + * 获取BigDecimal型属性值列表 + * + * @param key 属性名 + * @return 属性值列表 + */ + List getBigDecimalList(String key); + + /** + * 获取BigInteger型属性值列表 + * + * @param key 属性名 + * @return 属性值列表 + */ + List getBigIntegerList(String key); + /*-------------------------- List类型 end -------------------------------*/ +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptArrayTypeGetter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptArrayTypeGetter.java new file mode 100644 index 0000000..66be648 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptArrayTypeGetter.java @@ -0,0 +1,117 @@ +package aiyh.utils.tool.cn.hutool.core.getter; + +import java.math.BigDecimal; +import java.math.BigInteger; + +/** + * 可选默认值的数组类型的Get接口 + * 提供一个统一的接口定义返回不同类型的值（基本类型）
+ * 如果值不存在或获取错误，返回默认值 + * + * @author Looly + * @since 4.0.2 + * + */ +public interface OptArrayTypeGetter { + /*-------------------------- 数组类型 start -------------------------------*/ + + /** + * 获取Object型属性值数组 + * + * @param key 属性名 + * @param defaultValue 默认数组值 + * @return 属性值列表 + */ + Object[] getObjs(String key, Object[] defaultValue); + + /** + * 获取String型属性值数组 + * + * @param key 属性名 + * @param defaultValue 默认数组值 + * @return 属性值列表 + */ + String[] getStrs(String key, String[] defaultValue); + + /** + * 获取Integer型属性值数组 + * + * @param key 属性名 + * @param defaultValue 默认数组值 + * @return 属性值列表 + */ + Integer[] getInts(String key, Integer[] defaultValue); + + /** + * 获取Short型属性值数组 + * + * @param key 属性名 + * @param defaultValue 默认数组值 + * @return 属性值列表 + */ + Short[] getShorts(String key, Short[] defaultValue); + + /** + * 获取Boolean型属性值数组 + * + * @param key 属性名 + * @param defaultValue 默认数组值 + * @return 属性值列表 + */ + Boolean[] getBools(String key, Boolean[] defaultValue); + + /** + * 获取Long型属性值数组 + * + * @param key 属性名 + * @param defaultValue 默认数组值 + * @return 属性值列表 + */ + Long[] getLongs(String key, Long[] defaultValue); + + /** + * 获取Character型属性值数组 + * + * @param key 属性名 + * @param defaultValue 默认数组值 + * @return 属性值列表 + */ + Character[] getChars(String key, Character[] defaultValue); + + /** + * 获取Double型属性值数组 + * + * @param key 属性名 + * @param defaultValue 默认数组值 + * @return 属性值列表 + */ + Double[] getDoubles(String key, Double[] defaultValue); + + /** + * 获取Byte型属性值数组 + * + * @param key 属性名 + * @param defaultValue 默认数组值 + * @return 属性值列表 + */ + Byte[] getBytes(String key, Byte[] defaultValue); + + /** + * 获取BigInteger型属性值数组 + * + * @param key 属性名 + * @param defaultValue 默认数组值 + * @return 属性值列表 + */ + BigInteger[] getBigIntegers(String key, BigInteger[] defaultValue); + + /** + * 获取BigDecimal型属性值数组 + * + * @param key 属性名 + * @param defaultValue 默认数组值 + * @return 属性值列表 + */ + BigDecimal[] getBigDecimals(String key, BigDecimal[] defaultValue); + /*-------------------------- 数组类型 end -------------------------------*/ +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptBasicTypeGetter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptBasicTypeGetter.java new file mode 100644 index 0000000..c6e1a14 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptBasicTypeGetter.java @@ -0,0 +1,153 @@ +package aiyh.utils.tool.cn.hutool.core.getter; + +import java.math.BigDecimal; +import java.math.BigInteger; +import java.util.Date; + +/** + * 可选默认值的基本类型的getter接口
+ * 提供一个统一的接口定义返回不同类型的值（基本类型）
+ * 如果值不存在或获取错误，返回默认值 + * @author Looly + */ +public interface OptBasicTypeGetter { + /*-------------------------- 基本类型 start -------------------------------*/ + + /** + * 获取Object属性值 + * @param key 属性名 + * @param defaultValue 默认值 + * @return 属性值，无对应值返回defaultValue + */ + Object getObj(K key, Object defaultValue); + + /** + * 获取字符串型属性值
+ * 若获得的值为不可见字符，使用默认值 + * + * @param key 属性名 + * @param defaultValue 默认值 + * @return 属性值，无对应值返回defaultValue + */ + String getStr(K key, String defaultValue); + + /** + * 获取int型属性值
+ * 若获得的值为不可见字符，使用默认值 + * + * @param key 属性名 + * @param defaultValue 默认值 + * @return 属性值，无对应值返回defaultValue + */ + Integer getInt(K key, Integer defaultValue); + + /** + * 获取short型属性值
+ * 若获得的值为不可见字符，使用默认值 + * + * @param key 属性名 + * @param defaultValue 默认值 + * @return 属性值，无对应值返回defaultValue + */ + Short getShort(K key, Short defaultValue); + + /** + * 获取boolean型属性值
+ * 若获得的值为不可见字符，使用默认值 + * + * @param key 属性名 + * @param defaultValue 默认值 + * @return 属性值，无对应值返回defaultValue + */ + Boolean getBool(K key, Boolean defaultValue); + + /** + * 获取Long型属性值
+ * 若获得的值为不可见字符，使用默认值 + * + * @param key 属性名 + * @param defaultValue 默认值 + * @return 属性值，无对应值返回defaultValue + */ + Long getLong(K key, Long defaultValue); + + /** + * 获取char型属性值
+ * 若获得的值为不可见字符，使用默认值 + * + * @param key 属性名 + * @param defaultValue 默认值 + * @return 属性值，无对应值返回defaultValue + */ + Character getChar(K key, Character defaultValue); + + /** + * 获取float型属性值
+ * 若获得的值为不可见字符，使用默认值 + * + * @param key 属性名 + * @param defaultValue 默认值 + * @return 属性值，无对应值返回defaultValue + */ + Float getFloat(K key, Float defaultValue); + + /** + * 获取double型属性值
+ * 若获得的值为不可见字符，使用默认值 + * + * @param key 属性名 + * @param defaultValue 默认值 + * @return 属性值，无对应值返回defaultValue + */ + Double getDouble(K key, Double defaultValue); + + /** + * 获取byte型属性值
+ * 若获得的值为不可见字符，使用默认值 + * + * @param key 属性名 + * @param defaultValue 默认值 + * @return 属性值，无对应值返回defaultValue + */ + Byte getByte(K key, Byte defaultValue); + + /** + * 获取BigDecimal型属性值
+ * 若获得的值为不可见字符，使用默认值 + * + * @param key 属性名 + * @param defaultValue 默认值 + * @return 属性值，无对应值返回defaultValue + */ + BigDecimal getBigDecimal(K key, BigDecimal defaultValue); + + /** + * 获取BigInteger型属性值
+ * 若获得的值为不可见字符，使用默认值 + * + * @param key 属性名 + * @param defaultValue 默认值 + * @return 属性值，无对应值返回defaultValue + */ + BigInteger getBigInteger(K key, BigInteger defaultValue); + + /** + * 获得Enum类型的值 + * + * @param 枚举类型 + * @param clazz Enum的Class + * @param key KEY + * @param defaultValue 默认值 + * @return Enum类型的值，无则返回Null + */ + > E getEnum(Class clazz, K key, E defaultValue); + + /** + * 获取Date类型值 + * @param key 属性名 + * @param defaultValue 默认值 + * @return Date类型属性值 + */ + Date getDate(K key, Date defaultValue); + /*-------------------------- 基本类型 end -------------------------------*/ +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptNullBasicTypeFromObjectGetter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptNullBasicTypeFromObjectGetter.java new file mode 100644 index 0000000..86b103c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptNullBasicTypeFromObjectGetter.java @@ -0,0 +1,133 @@ +package aiyh.utils.tool.cn.hutool.core.getter; + +import aiyh.utils.tool.cn.hutool.core.convert.Convert; + +import java.math.BigDecimal; +import java.math.BigInteger; +import java.util.Date; + +/** + * 基本类型的getter接口抽象实现，所有类型的值获取都是通过将getObj获得的值转换而来
+ * 用户只需实现getObj方法即可，其他类型将会从Object结果中转换 + * 在不提供默认值的情况下， 如果值不存在或获取错误，返回null
+ * + * @author Looly + */ +public interface OptNullBasicTypeFromObjectGetter extends OptNullBasicTypeGetter { + @Override + default String getStr(K key, String defaultValue) { + final Object obj = getObj(key); + if (null == obj) { + return defaultValue; + } + return Convert.toStr(obj, defaultValue); + } + + @Override + default Integer getInt(K key, Integer defaultValue) { + final Object obj = getObj(key); + if (null == obj) { + return defaultValue; + } + return Convert.toInt(obj, defaultValue); + } + + @Override + default Short getShort(K key, Short defaultValue) { + final Object obj = getObj(key); + if (null == obj) { + return defaultValue; + } + return Convert.toShort(obj, defaultValue); + } + + @Override + default Boolean getBool(K key, Boolean defaultValue) { + final Object obj = getObj(key); + if (null == obj) { + return defaultValue; + } + return Convert.toBool(obj, defaultValue); + } + + @Override + default Long getLong(K key, Long defaultValue) { + final Object obj = getObj(key); + if (null == obj) { + return defaultValue; + } + return Convert.toLong(obj, defaultValue); + } + + @Override + default Character getChar(K key, Character defaultValue) { + final Object obj = getObj(key); + if (null == obj) { + return defaultValue; + } + return Convert.toChar(obj, defaultValue); + } + + @Override + default Float getFloat(K key, Float defaultValue) { + final Object obj = getObj(key); + if (null == obj) { + return defaultValue; + } + return Convert.toFloat(obj, defaultValue); + } + + @Override + default Double getDouble(K key, Double defaultValue) { + final Object obj = getObj(key); + if (null == obj) { + return defaultValue; + } + return Convert.toDouble(obj, defaultValue); + } + + @Override + default Byte getByte(K key, Byte defaultValue) { + final Object obj = getObj(key); + if (null == obj) { + return defaultValue; + } + return Convert.toByte(obj, defaultValue); + } + + @Override + default BigDecimal getBigDecimal(K key, BigDecimal defaultValue) { + final Object obj = getObj(key); + if (null == obj) { + return defaultValue; + } + return Convert.toBigDecimal(obj, defaultValue); + } + + @Override + default BigInteger getBigInteger(K key, BigInteger defaultValue) { + final Object obj = getObj(key); + if (null == obj) { + return defaultValue; + } + return Convert.toBigInteger(obj, defaultValue); + } + + @Override + default > E getEnum(Class clazz, K key, E defaultValue) { + final Object obj = getObj(key); + if (null == obj) { + return defaultValue; + } + return Convert.toEnum(clazz, obj, defaultValue); + } + + @Override + default Date getDate(K key, Date defaultValue) { + final Object obj = getObj(key); + if (null == obj) { + return defaultValue; + } + return Convert.toDate(obj, defaultValue); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptNullBasicTypeFromStringGetter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptNullBasicTypeFromStringGetter.java new file mode 100644 index 0000000..f5fc5c6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptNullBasicTypeFromStringGetter.java @@ -0,0 +1,80 @@ +package aiyh.utils.tool.cn.hutool.core.getter; + +import java.math.BigDecimal; +import java.math.BigInteger; +import java.util.Date; + +import aiyh.utils.tool.cn.hutool.core.convert.Convert; + +/** + * 基本类型的getter接口抽象实现，所有类型的值获取都是通过将String转换而来
+ * 用户只需实现getStr方法即可，其他类型将会从String结果中转换 在不提供默认值的情况下， 如果值不存在或获取错误，返回null
+ * + * @author Looly + */ +public interface OptNullBasicTypeFromStringGetter extends OptNullBasicTypeGetter { + @Override + default Object getObj(K key, Object defaultValue) { + return getStr(key, null == defaultValue ? null : defaultValue.toString()); + } + + @Override + default Integer getInt(K key, Integer defaultValue) { + return Convert.toInt(getStr(key), defaultValue); + } + + @Override + default Short getShort(K key, Short defaultValue) { + return Convert.toShort(getStr(key), defaultValue); + } + + @Override + default Boolean getBool(K key, Boolean defaultValue) { + return Convert.toBool(getStr(key), defaultValue); + } + + @Override + default Long getLong(K key, Long defaultValue) { + return Convert.toLong(getStr(key), defaultValue); + } + + @Override + default Character getChar(K key, Character defaultValue) { + return Convert.toChar(getStr(key), defaultValue); + } + + @Override + default Float getFloat(K key, Float defaultValue) { + return Convert.toFloat(getStr(key), defaultValue); + } + + @Override + default Double getDouble(K key, Double defaultValue) { + return Convert.toDouble(getStr(key), defaultValue); + } + + @Override + default Byte getByte(K key, Byte defaultValue) { + return Convert.toByte(getStr(key), defaultValue); + } + + @Override + default BigDecimal getBigDecimal(K key, BigDecimal defaultValue) { + return Convert.toBigDecimal(getStr(key), defaultValue); + } + + @Override + default BigInteger getBigInteger(K key, BigInteger defaultValue) { + return Convert.toBigInteger(getStr(key), defaultValue); + } + + @Override + default > E getEnum(Class clazz, K key, E defaultValue) { + return Convert.toEnum(clazz, getStr(key), defaultValue); + } + + @Override + default Date getDate(K key, Date defaultValue) { + return Convert.toDate(getStr(key), defaultValue); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptNullBasicTypeGetter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptNullBasicTypeGetter.java new file mode 100644 index 0000000..b66e6cc --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/OptNullBasicTypeGetter.java @@ -0,0 +1,176 @@ +package aiyh.utils.tool.cn.hutool.core.getter; + +import java.math.BigDecimal; +import java.math.BigInteger; +import java.util.Date; + +/** + * 基本类型的getter接口抽象实现
+ * 提供一个统一的接口定义返回不同类型的值（基本类型）
+ * 在不提供默认值的情况下， 如果值不存在或获取错误，返回null
+ * 用户只需实现{@link OptBasicTypeGetter}接口即可 + * @author Looly + */ +public interface OptNullBasicTypeGetter extends BasicTypeGetter, OptBasicTypeGetter{ + @Override + default Object getObj(K key) { + return getObj(key, null); + } + + /** + * 获取字符串型属性值
+ * 无值或获取错误返回null + * + * @param key 属性名 + * @return 属性值 + */ + @Override + default String getStr(K key){ + return this.getStr(key, null); + } + + /** + * 获取int型属性值
+ * 无值或获取错误返回null + * + * @param key 属性名 + * @return 属性值 + */ + @Override + default Integer getInt(K key) { + return this.getInt(key, null); + } + + /** + * 获取short型属性值
+ * 无值或获取错误返回null + * + * @param key 属性名 + * @return 属性值 + */ + @Override + default Short getShort(K key){ + return this.getShort(key, null); + } + + /** + * 获取boolean型属性值
+ * 无值或获取错误返回null + * + * @param key 属性名 + * @return 属性值 + */ + @Override + default Boolean getBool(K key){ + return this.getBool(key, null); + } + + /** + * 获取long型属性值
+ * 无值或获取错误返回null + * + * @param key 属性名 + * @return 属性值 + */ + @Override + default Long getLong(K key){ + return this.getLong(key, null); + } + + /** + * 获取char型属性值
+ * 无值或获取错误返回null + * + * @param key 属性名 + * @return 属性值 + */ + @Override + default Character getChar(K key){ + return this.getChar(key, null); + } + + /** + * 获取float型属性值
+ * 无值或获取错误返回null + * + * @param key 属性名 + * @return 属性值 + */ + @Override + default Float getFloat(K key){ + return this.getFloat(key, null); + } + + /** + * 获取double型属性值
+ * 无值或获取错误返回null + * + * @param key 属性名 + * @return 属性值 + */ + @Override + default Double getDouble(K key){ + return this.getDouble(key, null); + } + + /** + * 获取byte型属性值
+ * 无值或获取错误返回null + * + * @param key 属性名 + * @return 属性值 + */ + @Override + default Byte getByte(K key){ + return this.getByte(key, null); + } + + /** + * 获取BigDecimal型属性值
+ * 无值或获取错误返回null + * + * @param key 属性名 + * @return 属性值 + */ + @Override + default BigDecimal getBigDecimal(K key){ + return this.getBigDecimal(key, null); + } + + /** + * 获取BigInteger型属性值
+ * 无值或获取错误返回null + * + * @param key 属性名 + * @return 属性值 + */ + @Override + default BigInteger getBigInteger(K key){ + return this.getBigInteger(key, null); + } + + /** + * 获取Enum型属性值
+ * 无值或获取错误返回null + * + * @param clazz Enum 的 Class + * @param key 属性名 + * @return 属性值 + */ + @Override + default > E getEnum(Class clazz, K key) { + return this.getEnum(clazz, key, null); + } + + /** + * 获取Date型属性值
+ * 无值或获取错误返回null + * + * @param key 属性名 + * @return 属性值 + */ + @Override + default Date getDate(K key) { + return this.getDate(key, null); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/package-info.java new file mode 100644 index 0000000..201aa8c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/getter/package-info.java @@ -0,0 +1,7 @@ +/** + * getXXX方法的接口和抽象实现 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.getter; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/BackgroundRemoval.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/BackgroundRemoval.java new file mode 100755 index 0000000..9a8880d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/BackgroundRemoval.java @@ -0,0 +1,354 @@ +package aiyh.utils.tool.cn.hutool.core.img; + +import aiyh.utils.tool.cn.hutool.core.io.FileTypeUtil; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import javax.imageio.ImageIO; +import javax.swing.ImageIcon; +import java.awt.Color; +import java.awt.Graphics; +import java.awt.image.BufferedImage; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.IOException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + *

图片背景识别处理、背景替换、背景设置为矢量图

+ *

根据一定规则算出图片背景色的RGB值，进行替换

+ *

2020-05-21 16:36

+ * + * @author Dai Yuanchuan + **/ +public class BackgroundRemoval { + + /** + * 目前暂时支持的图片类型数组 + * 其他格式的不保证结果 + */ + public static String[] IMAGES_TYPE = {"jpg", "png"}; + + /** + * 背景移除 + * 图片去底工具 + * 将 "纯色背景的图片" 还原成 "透明背景的图片" + * 将纯色背景的图片转成矢量图 + * 取图片边缘的像素点和获取到的图片主题色作为要替换的背景色 + * 再加入一定的容差值,然后将所有像素点与该颜色进行比较 + * 发现相同则将颜色不透明度设置为0,使颜色完全透明. + * + * @param inputPath 要处理图片的路径 + * @param outputPath 输出图片的路径 + * @param tolerance 容差值[根据图片的主题色,加入容差值,值的范围在0~255之间] + * @return 返回处理结果 true:图片处理完成 false:图片处理失败 + */ + public static boolean backgroundRemoval(String inputPath, String outputPath, int tolerance) { + return backgroundRemoval(new File(inputPath), new File(outputPath), tolerance); + } + + /** + * 背景移除 + * 图片去底工具 + * 将 "纯色背景的图片" 还原成 "透明背景的图片" + * 将纯色背景的图片转成矢量图 + * 取图片边缘的像素点和获取到的图片主题色作为要替换的背景色 + * 再加入一定的容差值,然后将所有像素点与该颜色进行比较 + * 发现相同则将颜色不透明度设置为0,使颜色完全透明. + * + * @param input 需要进行操作的图片 + * @param output 最后输出的文件 + * @param tolerance 容差值[根据图片的主题色,加入容差值,值的取值范围在0~255之间] + * @return 返回处理结果 true:图片处理完成 false:图片处理失败 + */ + public static boolean backgroundRemoval(File input, File output, int tolerance) { + return backgroundRemoval(input, output, null, tolerance); + } + + /** + * 背景移除 + * 图片去底工具 + * 将 "纯色背景的图片" 还原成 "透明背景的图片" + * 将纯色背景的图片转成矢量图 + * 取图片边缘的像素点和获取到的图片主题色作为要替换的背景色 + * 再加入一定的容差值,然后将所有像素点与该颜色进行比较 + * 发现相同则将颜色不透明度设置为0,使颜色完全透明. + * + * @param input 需要进行操作的图片 + * @param output 最后输出的文件 + * @param override 指定替换成的背景颜色 为null时背景为透明 + * @param tolerance 容差值[根据图片的主题色,加入容差值,值的取值范围在0~255之间] + * @return 返回处理结果 true:图片处理完成 false:图片处理失败 + */ + public static boolean backgroundRemoval(File input, File output, Color override, int tolerance) { + if (fileTypeValidation(input, IMAGES_TYPE)) { + return false; + } + try { + // 获取图片左上、中上、右上、右中、右下、下中、左下、左中、8个像素点rgb的16进制值 + BufferedImage bufferedImage = ImageIO.read(input); + // 图片输出的格式为 png + return ImageIO.write(backgroundRemoval(bufferedImage, override, tolerance), "png", output); + } catch (IOException e) { + e.printStackTrace(); + return false; + } + } + + /** + * 背景移除 + * 图片去底工具 + * 将 "纯色背景的图片" 还原成 "透明背景的图片" + * 将纯色背景的图片转成矢量图 + * 取图片边缘的像素点和获取到的图片主题色作为要替换的背景色 + * 再加入一定的容差值,然后将所有像素点与该颜色进行比较 + * 发现相同则将颜色不透明度设置为0,使颜色完全透明. + * + * @param bufferedImage 需要进行处理的图片流 + * @param override 指定替换成的背景颜色 为null时背景为透明 + * @param tolerance 容差值[根据图片的主题色,加入容差值,值的取值范围在0~255之间] + * @return 返回处理好的图片流 + */ + public static BufferedImage backgroundRemoval(BufferedImage bufferedImage, Color override, int tolerance) { + // 容差值 最大255 最小0 + tolerance = Math.min(255, Math.max(tolerance, 0)); + // 绘制icon + ImageIcon imageIcon = new ImageIcon(bufferedImage); + BufferedImage image = new BufferedImage(imageIcon.getIconWidth(), imageIcon.getIconHeight(), + BufferedImage.TYPE_4BYTE_ABGR); + // 绘图工具 + Graphics graphics = image.getGraphics(); + graphics.drawImage(imageIcon.getImage(), 0, 0, imageIcon.getImageObserver()); + // 需要删除的RGB元素 + String[] removeRgb = getRemoveRgb(bufferedImage); + // 获取图片的大概主色调 + String mainColor = getMainColor(bufferedImage); + int alpha = 0; + for (int y = image.getMinY(); y < image.getHeight(); y++) { + for (int x = image.getMinX(); x < image.getWidth(); x++) { + // 获取像素的16进制 + int rgb = image.getRGB(x, y); + String hex = ImgUtil.toHex((rgb & 0xff0000) >> 16, (rgb & 0xff00) >> 8, (rgb & 0xff)); + boolean isTrue = ArrayUtil.contains(removeRgb, hex) || + areColorsWithinTolerance(hexToRgb(mainColor), new Color(Integer.parseInt(hex.substring(1), 16)), tolerance); + if (isTrue) { + rgb = override == null ? ((alpha + 1) << 24) | (rgb & 0x00ffffff) : override.getRGB(); + } + image.setRGB(x, y, rgb); + } + } + graphics.drawImage(image, 0, 0, imageIcon.getImageObserver()); + return image; + } + + /** + * 背景移除 + * 图片去底工具 + * 将 "纯色背景的图片" 还原成 "透明背景的图片" + * 将纯色背景的图片转成矢量图 + * 取图片边缘的像素点和获取到的图片主题色作为要替换的背景色 + * 再加入一定的容差值,然后将所有像素点与该颜色进行比较 + * 发现相同则将颜色不透明度设置为0,使颜色完全透明. + * + * @param outputStream 需要进行处理的图片字节数组流 + * @param override 指定替换成的背景颜色 为null时背景为透明 + * @param tolerance 容差值[根据图片的主题色,加入容差值,值的取值范围在0~255之间] + * @return 返回处理好的图片流 + */ + public static BufferedImage backgroundRemoval(ByteArrayOutputStream outputStream, Color override, int tolerance) { + try { + return backgroundRemoval(ImageIO.read(new ByteArrayInputStream(outputStream.toByteArray())), override, tolerance); + } catch (IOException e) { + e.printStackTrace(); + return null; + } + } + + /** + * 获取要删除的 RGB 元素 + * 分别获取图片左上、中上、右上、右中、右下、下中、左下、左中、8个像素点rgb的16进制值 + * + * @param image 图片流 + * @return String数组 包含 各个位置的rgb数值 + */ + private static String[] getRemoveRgb(BufferedImage image) { + // 获取图片流的宽和高 + int width = image.getWidth() - 1; + int height = image.getHeight() - 1; + // 左上 + int leftUpPixel = image.getRGB(1, 1); + String leftUp = ImgUtil.toHex((leftUpPixel & 0xff0000) >> 16, (leftUpPixel & 0xff00) >> 8, (leftUpPixel & 0xff)); + // 上中 + int upMiddlePixel = image.getRGB(width / 2, 1); + String upMiddle = ImgUtil.toHex((upMiddlePixel & 0xff0000) >> 16, (upMiddlePixel & 0xff00) >> 8, (upMiddlePixel & 0xff)); + // 右上 + int rightUpPixel = image.getRGB(width, 1); + String rightUp = ImgUtil.toHex((rightUpPixel & 0xff0000) >> 16, (rightUpPixel & 0xff00) >> 8, (rightUpPixel & 0xff)); + // 右中 + int rightMiddlePixel = image.getRGB(width, height / 2); + String rightMiddle = ImgUtil.toHex((rightMiddlePixel & 0xff0000) >> 16, (rightMiddlePixel & 0xff00) >> 8, (rightMiddlePixel & 0xff)); + // 右下 + int lowerRightPixel = image.getRGB(width, height); + String lowerRight = ImgUtil.toHex((lowerRightPixel & 0xff0000) >> 16, (lowerRightPixel & 0xff00) >> 8, (lowerRightPixel & 0xff)); + // 下中 + int lowerMiddlePixel = image.getRGB(width / 2, height); + String lowerMiddle = ImgUtil.toHex((lowerMiddlePixel & 0xff0000) >> 16, (lowerMiddlePixel & 0xff00) >> 8, (lowerMiddlePixel & 0xff)); + // 左下 + int leftLowerPixel = image.getRGB(1, height); + String leftLower = ImgUtil.toHex((leftLowerPixel & 0xff0000) >> 16, (leftLowerPixel & 0xff00) >> 8, (leftLowerPixel & 0xff)); + // 左中 + int leftMiddlePixel = image.getRGB(1, height / 2); + String leftMiddle = ImgUtil.toHex((leftMiddlePixel & 0xff0000) >> 16, (leftMiddlePixel & 0xff00) >> 8, (leftMiddlePixel & 0xff)); + // 需要删除的RGB元素 + return new String[]{leftUp, upMiddle, rightUp, rightMiddle, lowerRight, lowerMiddle, leftLower, leftMiddle}; + } + + /** + * 十六进制颜色码转RGB颜色值 + * + * @param hex 十六进制颜色码 + * @return 返回 RGB颜色值 + */ + public static Color hexToRgb(String hex) { + return new Color(Integer.parseInt(hex.substring(1), 16)); + } + + + /** + * 判断颜色是否在容差范围内 + * 对比两个颜色的相似度，判断这个相似度是否小于 tolerance 容差值 + * + * @param color1 颜色1 + * @param color2 颜色2 + * @param tolerance 容差值 + * @return 返回true:两个颜色在容差值之内 false: 不在 + */ + public static boolean areColorsWithinTolerance(Color color1, Color color2, int tolerance) { + return areColorsWithinTolerance(color1, color2, new Color(tolerance, tolerance, tolerance)); + } + + /** + * 判断颜色是否在容差范围内 + * 对比两个颜色的相似度，判断这个相似度是否小于 tolerance 容差值 + * + * @param color1 颜色1 + * @param color2 颜色2 + * @param tolerance 容差色值 + * @return 返回true:两个颜色在容差值之内 false: 不在 + */ + public static boolean areColorsWithinTolerance(Color color1, Color color2, Color tolerance) { + return (color1.getRed() - color2.getRed() < tolerance.getRed() && color1 + .getRed() - color2.getRed() > -tolerance.getRed()) + && (color1.getBlue() - color2.getBlue() < tolerance + .getBlue() && color1.getBlue() - color2.getBlue() > -tolerance + .getBlue()) + && (color1.getGreen() - color2.getGreen() < tolerance + .getGreen() && color1.getGreen() + - color2.getGreen() > -tolerance.getGreen()); + } + + /** + * 获取图片大概的主题色 + * 循环所有的像素点,取出出现次数最多的一个像素点的RGB值 + * + * @param input 图片文件路径 + * @return 返回一个图片的大概的色值 一个16进制的颜色码 + */ + public static String getMainColor(String input) { + return getMainColor(new File(input)); + } + + /** + * 获取图片大概的主题色 + * 循环所有的像素点,取出出现次数最多的一个像素点的RGB值 + * + * @param input 图片文件 + * @return 返回一个图片的大概的色值 一个16进制的颜色码 + */ + public static String getMainColor(File input) { + try { + return getMainColor(ImageIO.read(input)); + } catch (IOException e) { + e.printStackTrace(); + } + return ""; + } + + /** + * 获取图片大概的主题色 + * 循环所有的像素点,取出出现次数最多的一个像素点的RGB值 + * + * @param bufferedImage 图片流 + * @return 返回一个图片的大概的色值 一个16进制的颜色码 + */ + public static String getMainColor(BufferedImage bufferedImage) { + if (bufferedImage == null) { + throw new IllegalArgumentException("图片流是空的"); + } + + // 存储图片的所有RGB元素 + List list = new ArrayList<>(); + for (int y = bufferedImage.getMinY(); y < bufferedImage.getHeight(); y++) { + for (int x = bufferedImage.getMinX(); x < bufferedImage.getWidth(); x++) { + int pixel = bufferedImage.getRGB(x, y); + list.add(((pixel & 0xff0000) >> 16) + "-" + ((pixel & 0xff00) >> 8) + "-" + (pixel & 0xff)); + } + } + + final Map map = new HashMap<>(list.size(), 1); + for (String string : list) { + Integer integer = map.get(string); + if (integer == null) { + integer = 1; + } else { + integer++; + } + map.put(string, integer); + } + String max = StrUtil.EMPTY; + long num = 0; + for (Map.Entry entry : map.entrySet()) { + String key = entry.getKey(); + Integer temp = entry.getValue(); + if (StrUtil.isBlank(max) || temp > num) { + max = key; + num = temp; + } + } + String[] strings = max.split("-"); + // rgb 的数量只有3个 + int rgbLength = 3; + if (strings.length == rgbLength) { + return ImgUtil.toHex(Integer.parseInt(strings[0]), Integer.parseInt(strings[1]), + Integer.parseInt(strings[2])); + } + return StrUtil.EMPTY; + } + + // -------------------------------------------------------------------------- private + + /** + * 文件类型验证 + * 根据给定文件类型数据，验证给定文件类型. + * + * @param input 需要进行验证的文件 + * @param imagesType 文件包含的类型数组 + * @return 返回布尔值 false:给定文件的文件类型在文件数组中 true:给定文件的文件类型 不在给定数组中。 + */ + private static boolean fileTypeValidation(File input, String[] imagesType) { + if (!input.exists()) { + throw new IllegalArgumentException("给定文件为空"); + } + // 获取图片类型 + String type = FileTypeUtil.getType(input); + // 类型对比 + if (!ArrayUtil.contains(imagesType, type)) { + throw new IllegalArgumentException(StrUtil.format("文件类型{}不支持", type)); + } + return false; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/ColorUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/ColorUtil.java new file mode 100644 index 0000000..00d36a8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/ColorUtil.java @@ -0,0 +1,262 @@ +package aiyh.utils.tool.cn.hutool.core.img; + +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.RandomUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.awt.Color; +import java.awt.image.BufferedImage; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Random; + +/** + * 颜色工具类 + * + * @since 5.8.7 + */ +public class ColorUtil { + + /** + * RGB颜色范围上限 + */ + private static final int RGB_COLOR_BOUND = 256; + + /** + * Color对象转16进制表示，例如#fcf6d6 + * + * @param color {@link Color} + * @return 16进制的颜色值，例如#fcf6d6 + * @since 4.1.14 + */ + public static String toHex(Color color) { + return toHex(color.getRed(), color.getGreen(), color.getBlue()); + } + + /** + * RGB颜色值转换成十六进制颜色码 + * + * @param r 红(R) + * @param g 绿(G) + * @param b 蓝(B) + * @return 返回字符串形式的 十六进制颜色码 如 + */ + public static String toHex(int r, int g, int b) { + // rgb 小于 255 + if (r < 0 || r > 255 || g < 0 || g > 255 || b < 0 || b > 255) { + throw new IllegalArgumentException("RGB must be 0~255!"); + } + return String.format("#%02X%02X%02X", r, g, b); + } + + /** + * 将颜色值转换成具体的颜色类型 汇集了常用的颜色集，支持以下几种形式： + * + * 
+	 * 1. 颜色的英文名（大小写皆可）
+	 * 2. 16进制表示，例如：#fcf6d6或者$fcf6d6
+	 * 3. RGB形式，例如：13,148,252
+	 *
+ *

+ * 方法来自：com.lnwazg.kit + * + * @param colorName 颜色的英文名，16进制表示或RGB表示 + * @return {@link Color} + * @since 4.1.14 + */ + public static Color getColor(String colorName) { + if (StrUtil.isBlank(colorName)) { + return null; + } + colorName = colorName.toUpperCase(); + + if ("BLACK".equals(colorName)) { + return Color.BLACK; + } else if ("WHITE".equals(colorName)) { + return Color.WHITE; + } else if ("LIGHTGRAY".equals(colorName) || "LIGHT_GRAY".equals(colorName)) { + return Color.LIGHT_GRAY; + } else if ("GRAY".equals(colorName)) { + return Color.GRAY; + } else if ("DARKGRAY".equals(colorName) || "DARK_GRAY".equals(colorName)) { + return Color.DARK_GRAY; + } else if ("RED".equals(colorName)) { + return Color.RED; + } else if ("PINK".equals(colorName)) { + return Color.PINK; + } else if ("ORANGE".equals(colorName)) { + return Color.ORANGE; + } else if ("YELLOW".equals(colorName)) { + return Color.YELLOW; + } else if ("GREEN".equals(colorName)) { + return Color.GREEN; + } else if ("MAGENTA".equals(colorName)) { + return Color.MAGENTA; + } else if ("CYAN".equals(colorName)) { + return Color.CYAN; + } else if ("BLUE".equals(colorName)) { + return Color.BLUE; + } else if ("DARKGOLD".equals(colorName)) { + // 暗金色 + return hexToColor("#9e7e67"); + } else if ("LIGHTGOLD".equals(colorName)) { + // 亮金色 + return hexToColor("#ac9c85"); + } else if (StrUtil.startWith(colorName, '#')) { + return hexToColor(colorName); + } else if (StrUtil.startWith(colorName, '$')) { + // 由于#在URL传输中无法传输，因此用$代替# + return hexToColor("#" + colorName.substring(1)); + } else { + // rgb值 + final List rgb = StrUtil.split(colorName, ','); + if (3 == rgb.size()) { + final Integer r = Convert.toInt(rgb.get(0)); + final Integer g = Convert.toInt(rgb.get(1)); + final Integer b = Convert.toInt(rgb.get(2)); + if (false == ArrayUtil.hasNull(r, g, b)) { + return new Color(r, g, b); + } + } else { + return null; + } + } + return null; + } + + /** + * 获取一个RGB值对应的颜色 + * + * @param rgb RGB值 + * @return {@link Color} + * @since 4.1.14 + */ + public static Color getColor(int rgb) { + return new Color(rgb); + } + + /** + * 16进制的颜色值转换为Color对象，例如#fcf6d6 + * + * @param hex 16进制的颜色值，例如#fcf6d6 + * @return {@link Color} + * @since 4.1.14 + */ + public static Color hexToColor(String hex) { + return getColor(Integer.parseInt(StrUtil.removePrefix(hex, "#"), 16)); + } + + /** + * 叠加颜色 + * @param color1 颜色1 + * @param color2 颜色2 + * @return 叠加后的颜色 + */ + public static Color add(Color color1, Color color2) { + double r1 = color1.getRed(); + double g1 = color1.getGreen(); + double b1 = color1.getBlue(); + double a1 = color1.getAlpha(); + double r2 = color2.getRed(); + double g2 = color2.getGreen(); + double b2 = color2.getBlue(); + double a2 = color2.getAlpha(); + int r = (int) ((r1 * a1 / 255 + r2 * a2 / 255) / (a1 / 255 + a2 / 255)); + int g = (int) ((g1 * a1 / 255 + g2 * a2 / 255) / (a1 / 255 + a2 / 255)); + int b = (int) ((b1 * a1 / 255 + b2 * a2 / 255) / (a1 / 255 + a2 / 255)); + return new Color(r, g, b); + } + + /** + * 生成随机颜色 + * + * @return 随机颜色 + * @since 3.1.2 + */ + public static Color randomColor() { + return randomColor(null); + } + + /** + * 生成随机颜色 + * + * @param random 随机对象 {@link Random} + * @return 随机颜色 + * @since 3.1.2 + */ + public static Color randomColor(Random random) { + if (null == random) { + random = RandomUtil.getRandom(); + } + return new Color(random.nextInt(RGB_COLOR_BOUND), random.nextInt(RGB_COLOR_BOUND), random.nextInt(RGB_COLOR_BOUND)); + } + + /** + * 获取给定图片的主色调，背景填充用 + * + * @param image {@link BufferedImage} + * @param rgbFilters 过滤多种颜色 + * @return {@link String} #ffffff + * @since 5.6.7 + */ + public static String getMainColor(BufferedImage image, int[]... rgbFilters) { + int r, g, b; + Map countMap = new HashMap<>(); + int width = image.getWidth(); + int height = image.getHeight(); + int minx = image.getMinX(); + int miny = image.getMinY(); + for (int i = minx; i < width; i++) { + for (int j = miny; j < height; j++) { + int pixel = image.getRGB(i, j); + r = (pixel & 0xff0000) >> 16; + g = (pixel & 0xff00) >> 8; + b = (pixel & 0xff); + if (matchFilters(r, g, b, rgbFilters)) { + continue; + } + countMap.merge(r + "-" + g + "-" + b, 1L, Long::sum); + } + } + String maxColor = null; + long maxCount = 0; + for (Map.Entry entry : countMap.entrySet()) { + String key = entry.getKey(); + Long count = entry.getValue(); + if (count > maxCount) { + maxColor = key; + maxCount = count; + } + } + final String[] splitRgbStr = StrUtil.splitToArray(maxColor, '-'); + String rHex = Integer.toHexString(Integer.parseInt(splitRgbStr[0])); + String gHex = Integer.toHexString(Integer.parseInt(splitRgbStr[1])); + String bHex = Integer.toHexString(Integer.parseInt(splitRgbStr[2])); + rHex = rHex.length() == 1 ? "0" + rHex : rHex; + gHex = gHex.length() == 1 ? "0" + gHex : gHex; + bHex = bHex.length() == 1 ? "0" + bHex : bHex; + return "#" + rHex + gHex + bHex; + } + + /** + * 给定RGB是否匹配过滤器中任何一个RGB颜色 + * + * @param r R + * @param g G + * @param b B + * @param rgbFilters 颜色过滤器 + * @return 是否匹配 + */ + private static boolean matchFilters(int r, int g, int b, int[]... rgbFilters) { + if (rgbFilters != null && rgbFilters.length > 0) { + for (int[] rgbFilter : rgbFilters) { + if (r == rgbFilter[0] && g == rgbFilter[1] && b == rgbFilter[2]) { + return true; + } + } + } + return false; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/FontUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/FontUtil.java new file mode 100755 index 0000000..1e55aef --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/FontUtil.java @@ -0,0 +1,110 @@ +package aiyh.utils.tool.cn.hutool.core.img; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; + +import java.awt.Dimension; +import java.awt.Font; +import java.awt.FontFormatException; +import java.awt.FontMetrics; +import java.io.File; +import java.io.IOException; +import java.io.InputStream; + +/** + * AWT中字体相关工具类 + * + * @author looly + * @since 5.3.6 + */ +public class FontUtil { + + /** + * 创建默认字体 + * + * @return 默认字体 + */ + public static Font createFont() { + return new Font(null); + } + + /** + * 创建SansSerif字体 + * + * @param size 字体大小 + * @return 字体 + */ + public static Font createSansSerifFont(int size) { + return createFont(Font.SANS_SERIF, size); + } + + /** + * 创建指定名称的字体 + * + * @param name 字体名称 + * @param size 字体大小 + * @return 字体 + */ + public static Font createFont(String name, int size) { + return new Font(name, Font.PLAIN, size); + } + + /** + * 根据文件创建字体
+ * 首先尝试创建{@link Font#TRUETYPE_FONT}字体，此类字体无效则创建{@link Font#TYPE1_FONT} + * + * @param fontFile 字体文件 + * @return {@link Font} + */ + public static Font createFont(File fontFile) { + try { + return Font.createFont(Font.TRUETYPE_FONT, fontFile); + } catch (FontFormatException e) { + // True Type字体无效时使用Type1字体 + try { + return Font.createFont(Font.TYPE1_FONT, fontFile); + } catch (Exception e1) { + throw new UtilException(e); + } + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 根据文件创建字体
+ * 首先尝试创建{@link Font#TRUETYPE_FONT}字体，此类字体无效则创建{@link Font#TYPE1_FONT} + * + * @param fontStream 字体流 + * @return {@link Font} + */ + public static Font createFont(InputStream fontStream) { + try { + return Font.createFont(Font.TRUETYPE_FONT, fontStream); + } catch (FontFormatException e) { + // True Type字体无效时使用Type1字体 + try { + return Font.createFont(Font.TYPE1_FONT, fontStream); + } catch (Exception e1) { + throw new UtilException(e1); + } + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 获得字体对应字符串的长宽信息 + * + * @param metrics {@link FontMetrics} + * @param str 字符串 + * @return 长宽信息 + */ + public static Dimension getDimension(FontMetrics metrics, String str) { + final int width = metrics.stringWidth(str); + final int height = metrics.getAscent() - metrics.getLeading() - metrics.getDescent(); + + return new Dimension(width, height); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/GraphicsUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/GraphicsUtil.java new file mode 100755 index 0000000..c2e0861 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/GraphicsUtil.java @@ -0,0 +1,218 @@ +package aiyh.utils.tool.cn.hutool.core.img; + +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.awt.AlphaComposite; +import java.awt.Color; +import java.awt.Dimension; +import java.awt.Font; +import java.awt.FontMetrics; +import java.awt.Graphics; +import java.awt.Graphics2D; +import java.awt.Image; +import java.awt.Point; +import java.awt.Rectangle; +import java.awt.RenderingHints; +import java.awt.image.BufferedImage; + +/** + * {@link Graphics}相关工具类 + * + * @author looly + * @since 4.5.2 + */ +public class GraphicsUtil { + + /** + * 创建{@link Graphics2D} + * + * @param image {@link BufferedImage} + * @param color {@link Color}背景颜色以及当前画笔颜色，{@code null}表示不设置背景色 + * @return {@link Graphics2D} + * @since 4.5.2 + */ + public static Graphics2D createGraphics(BufferedImage image, Color color) { + final Graphics2D g = image.createGraphics(); + + if (null != color) { + // 填充背景 + g.setColor(color); + g.fillRect(0, 0, image.getWidth(), image.getHeight()); + } + + return g; + } + + /** + * 获取文字居中高度的Y坐标（距离上边距距离）
+ * 此方法依赖FontMetrics，如果获取失败，默认为背景高度的1/3 + * + * @param g {@link Graphics2D}画笔 + * @param backgroundHeight 背景高度 + * @return 最小高度，-1表示无法获取 + * @since 4.5.17 + */ + public static int getCenterY(Graphics g, int backgroundHeight) { + // 获取允许文字最小高度 + FontMetrics metrics = null; + try { + metrics = g.getFontMetrics(); + } catch (Exception e) { + // 此处报告bug某些情况下会抛出IndexOutOfBoundsException，在此做容错处理 + } + int y; + if (null != metrics) { + y = (backgroundHeight - metrics.getHeight()) / 2 + metrics.getAscent(); + } else { + y = backgroundHeight / 3; + } + return y; + } + + /** + * 绘制字符串，使用随机颜色，默认抗锯齿 + * + * @param g {@link Graphics}画笔 + * @param str 字符串 + * @param font 字体 + * @param width 字符串总宽度 + * @param height 字符串背景高度 + * @return 画笔对象 + * @since 4.5.10 + */ + public static Graphics drawStringColourful(Graphics g, String str, Font font, int width, int height) { + return drawString(g, str, font, null, width, height); + } + + /** + * 绘制字符串，默认抗锯齿 + * + * @param g {@link Graphics}画笔 + * @param str 字符串 + * @param font 字体 + * @param color 字体颜色，{@code null} 表示使用随机颜色（每个字符单独随机） + * @param width 字符串背景的宽度 + * @param height 字符串背景的高度 + * @return 画笔对象 + * @since 4.5.10 + */ + public static Graphics drawString(Graphics g, String str, Font font, Color color, int width, int height) { + // 抗锯齿 + if (g instanceof Graphics2D) { + ((Graphics2D) g).setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON); + } + // 创建字体 + g.setFont(font); + + // 文字高度（必须在设置字体后调用） + int midY = getCenterY(g, height); + if (null != color) { + g.setColor(color); + } + + final int len = str.length(); + int charWidth = width / len; + for (int i = 0; i < len; i++) { + if (null == color) { + // 产生随机的颜色值，让输出的每个字符的颜色值都将不同。 + g.setColor(ImgUtil.randomColor()); + } + g.drawString(String.valueOf(str.charAt(i)), i * charWidth, midY); + } + return g; + } + + /** + * 绘制字符串，默认抗锯齿。
+ * 此方法定义一个矩形区域和坐标，文字基于这个区域中间偏移x,y绘制。 + * + * @param g {@link Graphics}画笔 + * @param str 字符串 + * @param font 字体，字体大小决定了在背景中绘制的大小 + * @param color 字体颜色，{@code null} 表示使用黑色 + * @param rectangle 字符串绘制坐标和大小，此对象定义了绘制字符串的区域大小和偏移位置 + * @return 画笔对象 + * @since 4.5.10 + */ + public static Graphics drawString(Graphics g, String str, Font font, Color color, Rectangle rectangle) { + // 背景长宽 + final int backgroundWidth = rectangle.width; + final int backgroundHeight = rectangle.height; + + //获取字符串本身的长宽 + Dimension dimension; + try { + dimension = FontUtil.getDimension(g.getFontMetrics(font), str); + } catch (Exception e) { + // 此处报告bug某些情况下会抛出IndexOutOfBoundsException，在此做容错处理 + dimension = new Dimension(backgroundWidth / 3, backgroundHeight / 3); + } + + rectangle.setSize(dimension.width, dimension.height); + final Point point = ImgUtil.getPointBaseCentre(rectangle, backgroundWidth, backgroundHeight); + + return drawString(g, str, font, color, point); + } + + /** + * 绘制字符串，默认抗锯齿 + * + * @param g {@link Graphics}画笔 + * @param str 字符串 + * @param font 字体，字体大小决定了在背景中绘制的大小 + * @param color 字体颜色，{@code null} 表示使用黑色 + * @param point 绘制字符串的位置坐标 + * @return 画笔对象 + * @since 5.3.6 + */ + public static Graphics drawString(Graphics g, String str, Font font, Color color, Point point) { + // 抗锯齿 + if (g instanceof Graphics2D) { + ((Graphics2D) g).setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON); + } + + g.setFont(font); + g.setColor(ObjectUtil.defaultIfNull(color, Color.BLACK)); + g.drawString(str, point.x, point.y); + + return g; + } + + /** + * 绘制图片 + * + * @param g 画笔 + * @param img 要绘制的图片 + * @param point 绘制的位置，基于左上角 + * @return 画笔对象 + */ + public static Graphics drawImg(Graphics g, Image img, Point point) { + return drawImg(g, img, + new Rectangle(point.x, point.y, img.getWidth(null), img.getHeight(null))); + } + + /** + * 绘制图片 + * + * @param g 画笔 + * @param img 要绘制的图片 + * @param rectangle 矩形对象，表示矩形区域的x，y，width，height,，基于左上角 + * @return 画笔对象 + */ + public static Graphics drawImg(Graphics g, Image img, Rectangle rectangle) { + g.drawImage(img, rectangle.x, rectangle.y, rectangle.width, rectangle.height, null); // 绘制切割后的图 + return g; + } + + /** + * 设置画笔透明度 + * + * @param g 画笔 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @return 画笔 + */ + public static Graphics2D setAlpha(Graphics2D g, float alpha){ + g.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); + return g; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/Img.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/Img.java new file mode 100755 index 0000000..32673b9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/Img.java @@ -0,0 +1,870 @@ +package aiyh.utils.tool.cn.hutool.core.img; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.io.resource.Resource; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import javax.imageio.ImageIO; +import javax.imageio.stream.ImageInputStream; +import javax.imageio.stream.ImageOutputStream; +import java.awt.AlphaComposite; +import java.awt.BasicStroke; +import java.awt.Color; +import java.awt.Dimension; +import java.awt.Font; +import java.awt.Graphics2D; +import java.awt.Image; +import java.awt.Point; +import java.awt.Rectangle; +import java.awt.RenderingHints; +import java.awt.Stroke; +import java.awt.color.ColorSpace; +import java.awt.geom.AffineTransform; +import java.awt.geom.Ellipse2D; +import java.awt.geom.RoundRectangle2D; +import java.awt.image.BufferedImage; +import java.awt.image.CropImageFilter; +import java.awt.image.ImageFilter; +import java.io.File; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.Serializable; +import java.net.URL; +import java.nio.file.Path; + +/** + * 图像编辑器 + * + * @author looly + * @since 4.1.5 + */ +public class Img implements Serializable { + private static final long serialVersionUID = 1L; + + private final BufferedImage srcImage; + private Image targetImage; + /** + * 目标图片文件格式，用于写出 + */ + private String targetImageType; + /** + * 计算x,y坐标的时候是否从中心做为原始坐标开始计算 + */ + private boolean positionBaseCentre = true; + /** + * 图片输出质量，用于压缩 + */ + private float quality = -1; + /** + * 图片背景色 + */ + private Color backgroundColor; + + /** + * 从Path读取图片并开始处理 + * + * @param imagePath 图片文件路径 + * @return Img + */ + public static Img from(Path imagePath) { + return from(imagePath.toFile()); + } + + /** + * 从文件读取图片并开始处理 + * + * @param imageFile 图片文件 + * @return Img + */ + public static Img from(File imageFile) { + return new Img(ImgUtil.read(imageFile)); + } + + /** + * 从资源对象中读取图片并开始处理 + * + * @param resource 图片资源对象 + * @return Img + * @since 4.4.1 + */ + public static Img from(Resource resource) { + return from(resource.getStream()); + } + + /** + * 从流读取图片并开始处理 + * + * @param in 图片流 + * @return Img + */ + public static Img from(InputStream in) { + return new Img(ImgUtil.read(in)); + } + + /** + * 从ImageInputStream取图片并开始处理 + * + * @param imageStream 图片流 + * @return Img + */ + public static Img from(ImageInputStream imageStream) { + return new Img(ImgUtil.read(imageStream)); + } + + /** + * 从URL取图片并开始处理 + * + * @param imageUrl 图片URL + * @return Img + */ + public static Img from(URL imageUrl) { + return new Img(ImgUtil.read(imageUrl)); + } + + /** + * 从Image取图片并开始处理 + * + * @param image 图片 + * @return Img + */ + public static Img from(Image image) { + return new Img(ImgUtil.toBufferedImage(image)); + } + + /** + * 构造，目标图片类型取决于来源图片类型 + * + * @param srcImage 来源图片 + */ + public Img(BufferedImage srcImage) { + this(srcImage, null); + } + + /** + * 构造 + * + * @param srcImage 来源图片 + * @param targetImageType 目标图片类型，null则读取来源图片类型 + * @since 5.0.7 + */ + public Img(BufferedImage srcImage, String targetImageType) { + this.srcImage = srcImage; + if (null == targetImageType) { + if (srcImage.getType() == BufferedImage.TYPE_INT_ARGB + || srcImage.getType() == BufferedImage.TYPE_INT_ARGB_PRE + || srcImage.getType() == BufferedImage.TYPE_4BYTE_ABGR + || srcImage.getType() == BufferedImage.TYPE_4BYTE_ABGR_PRE + ) { + targetImageType = ImgUtil.IMAGE_TYPE_PNG; + } else { + targetImageType = ImgUtil.IMAGE_TYPE_JPG; + } + } + this.targetImageType = targetImageType; + } + + /** + * 设置目标图片文件格式，用于写出 + * + * @param imgType 图片格式 + * @return this + * @see ImgUtil#IMAGE_TYPE_JPG + * @see ImgUtil#IMAGE_TYPE_PNG + */ + public Img setTargetImageType(String imgType) { + this.targetImageType = imgType; + return this; + } + + /** + * 计算x,y坐标的时候是否从中心做为原始坐标开始计算 + * + * @param positionBaseCentre 是否从中心做为原始坐标开始计算 + * @return this + * @since 4.1.15 + */ + public Img setPositionBaseCentre(boolean positionBaseCentre) { + this.positionBaseCentre = positionBaseCentre; + return this; + } + + /** + * 设置图片输出质量，数字为0~1（不包括0和1）表示质量压缩比，除此数字外设置表示不压缩 + * + * @param quality 质量，数字为0~1（不包括0和1）表示质量压缩比，除此数字外设置表示不压缩 + * @return this + * @since 4.3.2 + */ + public Img setQuality(double quality) { + return setQuality((float) quality); + } + + /** + * 设置图片输出质量，数字为0~1（不包括0和1）表示质量压缩比，除此数字外设置表示不压缩 + * + * @param quality 质量，数字为0~1（不包括0和1）表示质量压缩比，除此数字外设置表示不压缩 + * @return this + * @since 4.3.2 + */ + public Img setQuality(float quality) { + if (quality > 0 && quality < 1) { + this.quality = quality; + } else { + this.quality = 1; + } + return this; + } + + /** + * 设置图片的背景色 + * + * @param backgroundColor{@link Color} 背景色 + * @return this + */ + public Img setBackgroundColor(Color backgroundColor) { + this.backgroundColor = backgroundColor; + return this; + } + + /** + * 缩放图像（按比例缩放） + * + * @param scale 缩放比例。比例大于1时为放大，小于1大于0为缩小 + * @return this + */ + public Img scale(float scale) { + if (scale < 0) { + // 自动修正负数 + scale = -scale; + } + final Image srcImg = getValidSrcImg(); + + // PNG图片特殊处理 + if (ImgUtil.IMAGE_TYPE_PNG.equals(this.targetImageType)) { + // 修正float转double导致的精度丢失 + final double scaleDouble = NumberUtil.toDouble(scale); + this.targetImage = ImgUtil.transform(AffineTransform.getScaleInstance(scaleDouble, scaleDouble), + ImgUtil.toBufferedImage(srcImg, this.targetImageType)); + } else { + // 缩放后的图片宽 + final int width = NumberUtil.mul((Number) srcImg.getWidth(null), scale).intValue(); + // 缩放后的图片高 + final int height = NumberUtil.mul((Number) srcImg.getHeight(null), scale).intValue(); + scale(width, height); + } + return this; + } + + /** + * 缩放图像（按长宽缩放）
+ * 注意：目标长宽与原图不成比例会变形 + * + * @param width 目标宽度 + * @param height 目标高度 + * @return this + */ + public Img scale(int width, int height) { + return scale(width, height, Image.SCALE_SMOOTH); + } + + /** + * 缩放图像（按长宽缩放）
+ * 注意：目标长宽与原图不成比例会变形 + * + * @param width 目标宽度 + * @param height 目标高度 + * @param scaleType 缩放类型，可选{@link Image#SCALE_SMOOTH}平滑模式或{@link Image#SCALE_DEFAULT}默认模式 + * @return this + * @since 5.7.18 + */ + public Img scale(int width, int height, int scaleType) { + final Image srcImg = getValidSrcImg(); + + final int srcHeight = srcImg.getHeight(null); + final int srcWidth = srcImg.getWidth(null); + if (srcHeight == height && srcWidth == width) { + // 源与目标长宽一致返回原图 + this.targetImage = srcImg; + return this; + } + + if (ImgUtil.IMAGE_TYPE_PNG.equals(this.targetImageType)) { + // png特殊处理，借助AffineTransform可以实现透明度保留 + final double sx = NumberUtil.div(width, srcWidth);// 宽度缩放比 + final double sy = NumberUtil.div(height, srcHeight); // 高度缩放比 + this.targetImage = ImgUtil.transform(AffineTransform.getScaleInstance(sx, sy), + ImgUtil.toBufferedImage(srcImg, this.targetImageType)); + } else { + this.targetImage = srcImg.getScaledInstance(width, height, scaleType); + } + + return this; + } + + /** + * 等比缩放图像，此方法按照按照给定的长宽等比缩放图片，按照长宽缩放比最多的一边等比缩放，空白部分填充背景色
+ * 缩放后默认为jpeg格式 + * + * @param width 缩放后的宽度 + * @param height 缩放后的高度 + * @param fixedColor 比例不对时补充的颜色，不补充为{@code null} + * @return this + */ + public Img scale(int width, int height, Color fixedColor) { + Image srcImage = getValidSrcImg(); + int srcHeight = srcImage.getHeight(null); + int srcWidth = srcImage.getWidth(null); + double heightRatio = NumberUtil.div(height, srcHeight); + double widthRatio = NumberUtil.div(width, srcWidth); + + // 浮点数之间的等值判断,基本数据类型不能用==比较,包装数据类型不能用equals来判断。 + if (NumberUtil.equals(heightRatio, widthRatio)) { + // 长宽都按照相同比例缩放时，返回缩放后的图片 + scale(width, height); + } else if (widthRatio < heightRatio) { + // 宽缩放比例多就按照宽缩放 + scale(width, (int) (srcHeight * widthRatio)); + } else { + // 否则按照高缩放 + scale((int) (srcWidth * heightRatio), height); + } + + // 获取缩放后的新的宽和高 + srcImage = getValidSrcImg(); + srcHeight = srcImage.getHeight(null); + srcWidth = srcImage.getWidth(null); + + final BufferedImage image = new BufferedImage(width, height, getTypeInt()); + Graphics2D g = image.createGraphics(); + + // 设置背景 + if (null != fixedColor) { + g.setBackground(fixedColor); + g.clearRect(0, 0, width, height); + } + + // 在中间贴图 + g.drawImage(srcImage, (width - srcWidth) / 2, (height - srcHeight) / 2, srcWidth, srcHeight, fixedColor, null); + + g.dispose(); + this.targetImage = image; + return this; + } + + /** + * 图像切割(按指定起点坐标和宽高切割) + * + * @param rectangle 矩形对象，表示矩形区域的x，y，width，height + * @return this + */ + public Img cut(Rectangle rectangle) { + final Image srcImage = getValidSrcImg(); + fixRectangle(rectangle, srcImage.getWidth(null), srcImage.getHeight(null)); + + final ImageFilter cropFilter = new CropImageFilter(rectangle.x, rectangle.y, rectangle.width, rectangle.height); + this.targetImage = ImgUtil.filter(cropFilter, srcImage); + return this; + } + + /** + * 图像切割为圆形(按指定起点坐标和半径切割)，填充满整个图片（直径取长宽最小值） + * + * @param x 原图的x坐标起始位置 + * @param y 原图的y坐标起始位置 + * @return this + * @since 4.1.15 + */ + public Img cut(int x, int y) { + return cut(x, y, -1); + } + + /** + * 图像切割为圆形(按指定起点坐标和半径切割) + * + * @param x 原图的x坐标起始位置 + * @param y 原图的y坐标起始位置 + * @param radius 半径，小于0表示填充满整个图片（直径取长宽最小值） + * @return this + * @since 4.1.15 + */ + public Img cut(int x, int y, int radius) { + final Image srcImage = getValidSrcImg(); + final int width = srcImage.getWidth(null); + final int height = srcImage.getHeight(null); + + // 计算直径 + final int diameter = radius > 0 ? radius * 2 : Math.min(width, height); + final BufferedImage targetImage = new BufferedImage(diameter, diameter, BufferedImage.TYPE_INT_ARGB); + final Graphics2D g = targetImage.createGraphics(); + g.setClip(new Ellipse2D.Double(0, 0, diameter, diameter)); + + if (this.positionBaseCentre) { + x = x - width / 2 + diameter / 2; + y = y - height / 2 + diameter / 2; + } + g.drawImage(srcImage, x, y, null); + g.dispose(); + this.targetImage = targetImage; + return this; + } + + /** + * 图片圆角处理 + * + * @param arc 圆角弧度，0~1，为长宽占比 + * @return this + * @since 4.5.3 + */ + public Img round(double arc) { + final Image srcImage = getValidSrcImg(); + final int width = srcImage.getWidth(null); + final int height = srcImage.getHeight(null); + + // 通过弧度占比计算弧度 + arc = NumberUtil.mul(arc, Math.min(width, height)); + + final BufferedImage targetImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_ARGB); + final Graphics2D g2 = targetImage.createGraphics(); + g2.setComposite(AlphaComposite.Src); + // 抗锯齿 + g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON); + g2.fill(new RoundRectangle2D.Double(0, 0, width, height, arc, arc)); + g2.setComposite(AlphaComposite.SrcAtop); + g2.drawImage(srcImage, 0, 0, null); + g2.dispose(); + this.targetImage = targetImage; + return this; + } + + /** + * 彩色转为灰度 + * + * @return this + */ + public Img gray() { + this.targetImage = ImgUtil.colorConvert(ColorSpace.getInstance(ColorSpace.CS_GRAY), getValidSrcBufferedImg()); + return this; + } + + /** + * 彩色转为黑白二值化图片 + * + * @return this + */ + public Img binary() { + this.targetImage = ImgUtil.copyImage(getValidSrcImg(), BufferedImage.TYPE_BYTE_BINARY); + return this; + } + + /** + * 给图片添加文字水印
+ * 此方法只在给定位置写出一个水印字符串 + * + * @param pressText 水印文字 + * @param color 水印的字体颜色 + * @param font {@link Font} 字体相关信息 + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @return 处理后的图像 + */ + public Img pressText(String pressText, Color color, Font font, int x, int y, float alpha) { + return pressText(pressText, color, font, new Point(x, y), alpha); + } + + /** + * 给图片添加文字水印
+ * 此方法只在给定位置写出一个水印字符串 + * + * @param pressText 水印文字 + * @param color 水印的字体颜色 + * @param font {@link Font} 字体相关信息 + * @param point 绘制字符串的位置坐标 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @return 处理后的图像 + */ + public Img pressText(String pressText, Color color, Font font, Point point, float alpha) { + final BufferedImage targetImage = ImgUtil.toBufferedImage(getValidSrcImg(), this.targetImageType); + + if (null == font) { + // 默认字体 + font = FontUtil.createSansSerifFont((int) (targetImage.getHeight() * 0.75)); + } + + final Graphics2D g = targetImage.createGraphics(); + // 透明度 + g.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); + + // 绘制 + if (positionBaseCentre) { + // 基于中心绘制 + GraphicsUtil.drawString(g, pressText, font, color, + new Rectangle(point.x, point.y, targetImage.getWidth(), targetImage.getHeight())); + } else { + // 基于左上角绘制 + GraphicsUtil.drawString(g, pressText, font, color, point); + } + + // 收笔 + g.dispose(); + this.targetImage = targetImage; + + return this; + } + + + /** + * 给图片添加全屏文字水印 + * + * @param pressText 水印文字，文件间的间隔使用尾部添加空格方式实现 + * @param color 水印的字体颜色 + * @param font {@link Font} 字体相关信息 + * @param lineHeight 行高 + * @param degree 旋转角度，（单位：弧度），以圆点（0,0）为圆心，正代表顺时针，负代表逆时针 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @return 处理后的图像 + * @since 5.8.0 + */ + public Img pressTextFull(String pressText, Color color, Font font, int lineHeight, int degree, float alpha) { + final BufferedImage targetImage = ImgUtil.toBufferedImage(getValidSrcImg(), this.targetImageType); + + if (null == font) { + // 默认字体 + font = FontUtil.createSansSerifFont((int) (targetImage.getHeight() * 0.75)); + } + final int targetHeight = targetImage.getHeight(); + final int targetWidth = targetImage.getWidth(); + + // 创建画笔，并设置透明度和角度 + final Graphics2D g = targetImage.createGraphics(); + g.setColor(color); + // 基于图片中心旋转 + g.rotate(Math.toRadians(degree), targetWidth >> 1, targetHeight >> 1); + g.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_ATOP, alpha)); + + //获取字符串本身的长宽 + Dimension dimension; + try { + dimension = FontUtil.getDimension(g.getFontMetrics(font), pressText); + } catch (Exception e) { + // 此处报告bug某些情况下会抛出IndexOutOfBoundsException，在此做容错处理 + dimension = new Dimension(targetWidth / 3, targetHeight / 3); + } + final int intervalHeight = dimension.height * lineHeight; + // 在画笔按照画布中心旋转后，达到45度时，上下左右会出现空白区，此处各延申长款的1.5倍实现全覆盖 + int y = -targetHeight >> 1; + while (y < targetHeight * 1.5) { + int x = -targetWidth >> 1; + while (x < targetWidth * 1.5) { + GraphicsUtil.drawString(g, pressText, font, color, new Point(x, y)); + x += dimension.width; + } + y += intervalHeight; + } + g.dispose(); + + this.targetImage = targetImage; + return this; + } + + /** + * 给图片添加图片水印 + * + * @param pressImg 水印图片，可以使用{@link ImageIO#read(File)}方法读取文件 + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @return this + */ + public Img pressImage(Image pressImg, int x, int y, float alpha) { + final int pressImgWidth = pressImg.getWidth(null); + final int pressImgHeight = pressImg.getHeight(null); + return pressImage(pressImg, new Rectangle(x, y, pressImgWidth, pressImgHeight), alpha); + } + + /** + * 给图片添加图片水印 + * + * @param pressImg 水印图片，可以使用{@link ImageIO#read(File)}方法读取文件 + * @param rectangle 矩形对象，表示矩形区域的x，y，width，height，x,y从背景图片中心计算 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @return this + * @since 4.1.14 + */ + public Img pressImage(Image pressImg, Rectangle rectangle, float alpha) { + final Image targetImg = getValidSrcImg(); + + this.targetImage = draw(ImgUtil.toBufferedImage(targetImg, this.targetImageType), pressImg, rectangle, alpha); + return this; + } + + /** + * 旋转图片为指定角度
+ * 来自：http://blog.51cto.com/cping1982/130066 + * + * @param degree 旋转角度 + * @return 旋转后的图片 + * @since 3.2.2 + */ + public Img rotate(int degree) { + final Image image = getValidSrcImg(); + int width = image.getWidth(null); + int height = image.getHeight(null); + final Rectangle rectangle = calcRotatedSize(width, height, degree); + final BufferedImage targetImg = new BufferedImage(rectangle.width, rectangle.height, getTypeInt()); + Graphics2D graphics2d = targetImg.createGraphics(); + // 抗锯齿 + graphics2d.setRenderingHint(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BILINEAR); + // 从中心旋转 + graphics2d.translate((rectangle.width - width) / 2D, (rectangle.height - height) / 2D); + graphics2d.rotate(Math.toRadians(degree), width / 2D, height / 2D); + graphics2d.drawImage(image, 0, 0, null); + graphics2d.dispose(); + this.targetImage = targetImg; + return this; + } + + /** + * 水平翻转图像 + * + * @return this + */ + public Img flip() { + final Image image = getValidSrcImg(); + int width = image.getWidth(null); + int height = image.getHeight(null); + final BufferedImage targetImg = new BufferedImage(width, height, getTypeInt()); + Graphics2D graphics2d = targetImg.createGraphics(); + graphics2d.drawImage(image, 0, 0, width, height, width, 0, 0, height, null); + graphics2d.dispose(); + + this.targetImage = targetImg; + return this; + } + + /** + * 描边，此方法为向内描边，会覆盖图片相应的位置 + * + * @param color 描边颜色，默认黑色 + * @param width 边框粗细 + * @return this + * @since 5.4.1 + */ + public Img stroke(Color color, float width) { + return stroke(color, new BasicStroke(width)); + } + + /** + * 描边，此方法为向内描边，会覆盖图片相应的位置 + * + * @param color 描边颜色，默认黑色 + * @param stroke 描边属性，包括粗细、线条类型等，见{@link BasicStroke} + * @return this + * @since 5.4.1 + */ + public Img stroke(Color color, Stroke stroke) { + final BufferedImage image = ImgUtil.toBufferedImage(getValidSrcImg(), this.targetImageType); + int width = image.getWidth(null); + int height = image.getHeight(null); + Graphics2D g = image.createGraphics(); + + g.setColor(ObjectUtil.defaultIfNull(color, Color.BLACK)); + if (null != stroke) { + g.setStroke(stroke); + } + + g.drawRect(0, 0, width - 1, height - 1); + + g.dispose(); + this.targetImage = image; + + return this; + } + + // ----------------------------------------------------------------------------------------------------------------- Write + + /** + * 获取处理过的图片 + * + * @return 处理过的图片 + */ + public Image getImg() { + return getValidSrcImg(); + } + + /** + * 写出图像为结果设置格式
+ * 结果类型设定见{@link #setTargetImageType(String)} + * + * @param out 写出到的目标流 + * @return 是否成功写出，如果返回false表示未找到合适的Writer + * @throws IORuntimeException IO异常 + */ + public boolean write(OutputStream out) throws IORuntimeException { + return write(ImgUtil.getImageOutputStream(out)); + } + + /** + * 写出图像为结果设置格式
+ * 结果类型设定见{@link #setTargetImageType(String)} + * + * @param targetImageStream 写出到的目标流 + * @return 是否成功写出，如果返回false表示未找到合适的Writer + * @throws IORuntimeException IO异常 + */ + public boolean write(ImageOutputStream targetImageStream) throws IORuntimeException { + Assert.notBlank(this.targetImageType, "Target image type is blank !"); + Assert.notNull(targetImageStream, "Target output stream is null !"); + + final Image targetImage = (null == this.targetImage) ? this.srcImage : this.targetImage; + Assert.notNull(targetImage, "Target image is null !"); + + return ImgUtil.write(targetImage, this.targetImageType, targetImageStream, this.quality, this.backgroundColor); + } + + /** + * 写出图像为目标文件扩展名对应的格式 + * + * @param targetFile 目标文件 + * @return 是否成功写出，如果返回false表示未找到合适的Writer + * @throws IORuntimeException IO异常 + */ + public boolean write(File targetFile) throws IORuntimeException { + final String formatName = FileUtil.extName(targetFile); + if (StrUtil.isNotBlank(formatName)) { + this.targetImageType = formatName; + } + + if (targetFile.exists()) { + //noinspection ResultOfMethodCallIgnored + targetFile.delete(); + } + + ImageOutputStream out = null; + try { + out = ImgUtil.getImageOutputStream(targetFile); + return write(out); + } finally { + IoUtil.close(out); + } + } + + // ---------------------------------------------------------------------------------------------------------------- Private method start + + /** + * 将图片绘制在背景上 + * + * @param backgroundImg 背景图片 + * @param img 要绘制的图片 + * @param rectangle 矩形对象，表示矩形区域的x，y，width，height，x,y从背景图片中心计算（如果positionBaseCentre为true） + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @return 绘制后的背景 + */ + private BufferedImage draw(BufferedImage backgroundImg, Image img, Rectangle rectangle, float alpha) { + final Graphics2D g = backgroundImg.createGraphics(); + GraphicsUtil.setAlpha(g, alpha); + + fixRectangle(rectangle, backgroundImg.getWidth(), backgroundImg.getHeight()); + GraphicsUtil.drawImg(g, img, rectangle); + + g.dispose(); + return backgroundImg; + } + + /** + * 获取int类型的图片类型 + * + * @return 图片类型 + * @see BufferedImage#TYPE_INT_ARGB + * @see BufferedImage#TYPE_INT_RGB + */ + private int getTypeInt() { + //noinspection SwitchStatementWithTooFewBranches + switch (this.targetImageType) { + case ImgUtil.IMAGE_TYPE_PNG: + return BufferedImage.TYPE_INT_ARGB; + default: + return BufferedImage.TYPE_INT_RGB; + } + } + + /** + * 获取有效的源图片，首先检查上一次处理的结果图片，如无则使用用户传入的源图片 + * + * @return 有效的源图片 + */ + private Image getValidSrcImg() { + return ObjectUtil.defaultIfNull(this.targetImage, this.srcImage); + } + + /** + * 获取有效的源{@link BufferedImage}图片，首先检查上一次处理的结果图片，如无则使用用户传入的源图片 + * + * @return 有效的源图片 + * @since 5.7.8 + */ + private BufferedImage getValidSrcBufferedImg() { + return ImgUtil.toBufferedImage(getValidSrcImg(), this.targetImageType); + } + + /** + * 修正矩形框位置，如果{@link Img#setPositionBaseCentre(boolean)} 设为{@code true}，
+ * 则坐标修正为基于图形中心，否则基于左上角 + * + * @param rectangle 矩形 + * @param baseWidth 参考宽 + * @param baseHeight 参考高 + * @return 修正后的{@link Rectangle} + * @since 4.1.15 + */ + private Rectangle fixRectangle(Rectangle rectangle, int baseWidth, int baseHeight) { + if (this.positionBaseCentre) { + final Point pointBaseCentre = ImgUtil.getPointBaseCentre(rectangle, baseWidth, baseHeight); + // 修正图片位置从背景的中心计算 + rectangle.setLocation(pointBaseCentre.x, pointBaseCentre.y); + } + return rectangle; + } + + /** + * 计算旋转后的图片尺寸 + * + * @param width 宽度 + * @param height 高度 + * @param degree 旋转角度 + * @return 计算后目标尺寸 + * @since 4.1.20 + */ + private static Rectangle calcRotatedSize(int width, int height, int degree) { + if (degree < 0) { + // 负数角度转换为正数角度 + degree += 360; + } + if (degree >= 90) { + if (degree / 90 % 2 == 1) { + int temp = height; + //noinspection SuspiciousNameCombination + height = width; + width = temp; + } + degree = degree % 90; + } + double r = Math.sqrt(height * height + width * width) / 2; + double len = 2 * Math.sin(Math.toRadians(degree) / 2) * r; + double angel_alpha = (Math.PI - Math.toRadians(degree)) / 2; + double angel_dalta_width = Math.atan((double) height / width); + double angel_dalta_height = Math.atan((double) width / height); + int len_dalta_width = (int) (len * Math.cos(Math.PI - angel_alpha - angel_dalta_width)); + int len_dalta_height = (int) (len * Math.cos(Math.PI - angel_alpha - angel_dalta_height)); + int des_width = width + len_dalta_width * 2; + int des_height = height + len_dalta_height * 2; + + return new Rectangle(des_width, des_height); + } + // ---------------------------------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/ImgUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/ImgUtil.java new file mode 100755 index 0000000..3357b49 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/ImgUtil.java @@ -0,0 +1,2222 @@ +package aiyh.utils.tool.cn.hutool.core.img; + +import aiyh.utils.tool.cn.hutool.core.codec.Base64; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.io.resource.Resource; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; + +import javax.imageio.IIOImage; +import javax.imageio.ImageIO; +import javax.imageio.ImageReader; +import javax.imageio.ImageTypeSpecifier; +import javax.imageio.ImageWriteParam; +import javax.imageio.ImageWriter; +import javax.imageio.stream.ImageInputStream; +import javax.imageio.stream.ImageOutputStream; +import javax.swing.ImageIcon; +import java.awt.Color; +import java.awt.Font; +import java.awt.Graphics; +import java.awt.Graphics2D; +import java.awt.GraphicsConfiguration; +import java.awt.GraphicsDevice; +import java.awt.GraphicsEnvironment; +import java.awt.HeadlessException; +import java.awt.Image; +import java.awt.Point; +import java.awt.Rectangle; +import java.awt.Toolkit; +import java.awt.color.ColorSpace; +import java.awt.font.FontRenderContext; +import java.awt.geom.AffineTransform; +import java.awt.geom.Rectangle2D; +import java.awt.image.AffineTransformOp; +import java.awt.image.BufferedImage; +import java.awt.image.BufferedImageOp; +import java.awt.image.ColorConvertOp; +import java.awt.image.ColorModel; +import java.awt.image.FilteredImageSource; +import java.awt.image.ImageFilter; +import java.awt.image.RenderedImage; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.net.URL; +import java.util.Iterator; +import java.util.Random; + +/** + * 图片处理工具类：
+ * 功能：缩放图像、切割图像、旋转、图像类型转换、彩色转黑白、文字水印、图片水印等
+ * 参考：http://blog.csdn.net/zhangzhikaixinya/article/details/8459400 + * + * @author Looly + */ +public class ImgUtil { + + public static final String IMAGE_TYPE_GIF = "gif";// 图形交换格式 + public static final String IMAGE_TYPE_JPG = "jpg";// 联合照片专家组 + public static final String IMAGE_TYPE_JPEG = "jpeg";// 联合照片专家组 + public static final String IMAGE_TYPE_BMP = "bmp";// 英文Bitmap（位图）的简写，它是Windows操作系统中的标准图像文件格式 + public static final String IMAGE_TYPE_PNG = "png";// 可移植网络图形 + public static final String IMAGE_TYPE_PSD = "psd";// Photoshop的专用格式Photoshop + + // ---------------------------------------------------------------------------------------------------------------------- scale + + /** + * 缩放图像（按比例缩放），目标文件的扩展名决定目标文件类型 + * + * @param srcImageFile 源图像文件 + * @param destImageFile 缩放后的图像文件，扩展名决定目标类型 + * @param scale 缩放比例。比例大于1时为放大，小于1大于0为缩小 + */ + public static void scale(File srcImageFile, File destImageFile, float scale) { + scale(read(srcImageFile), destImageFile, scale); + } + + /** + * 缩放图像（按比例缩放）
+ * 缩放后默认为jpeg格式，此方法并不关闭流 + * + * @param srcStream 源图像来源流 + * @param destStream 缩放后的图像写出到的流 + * @param scale 缩放比例。比例大于1时为放大，小于1大于0为缩小 + * @since 3.0.9 + */ + public static void scale(InputStream srcStream, OutputStream destStream, float scale) { + scale(read(srcStream), destStream, scale); + } + + /** + * 缩放图像（按比例缩放）
+ * 缩放后默认为jpeg格式，此方法并不关闭流 + * + * @param srcStream 源图像来源流 + * @param destStream 缩放后的图像写出到的流 + * @param scale 缩放比例。比例大于1时为放大，小于1大于0为缩小 + * @since 3.1.0 + */ + public static void scale(ImageInputStream srcStream, ImageOutputStream destStream, float scale) { + scale(read(srcStream), destStream, scale); + } + + /** + * 缩放图像（按比例缩放）
+ * 缩放后默认为jpeg格式，此方法并不关闭流 + * + * @param srcImg 源图像来源流 + * @param destFile 缩放后的图像写出到的流 + * @param scale 缩放比例。比例大于1时为放大，小于1大于0为缩小 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void scale(Image srcImg, File destFile, float scale) throws IORuntimeException { + Img.from(srcImg).setTargetImageType(FileUtil.extName(destFile)).scale(scale).write(destFile); + } + + /** + * 缩放图像（按比例缩放）
+ * 缩放后默认为jpeg格式，此方法并不关闭流 + * + * @param srcImg 源图像来源流 + * @param out 缩放后的图像写出到的流 + * @param scale 缩放比例。比例大于1时为放大，小于1大于0为缩小 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void scale(Image srcImg, OutputStream out, float scale) throws IORuntimeException { + scale(srcImg, getImageOutputStream(out), scale); + } + + /** + * 缩放图像（按比例缩放）
+ * 缩放后默认为jpeg格式，此方法并不关闭流 + * + * @param srcImg 源图像来源流 + * @param destImageStream 缩放后的图像写出到的流 + * @param scale 缩放比例。比例大于1时为放大，小于1大于0为缩小 + * @throws IORuntimeException IO异常 + * @since 3.1.0 + */ + public static void scale(Image srcImg, ImageOutputStream destImageStream, float scale) throws IORuntimeException { + writeJpg(scale(srcImg, scale), destImageStream); + } + + /** + * 缩放图像（按比例缩放） + * + * @param srcImg 源图像来源流 + * @param scale 缩放比例。比例大于1时为放大，小于1大于0为缩小 + * @return {@link Image} + * @since 3.1.0 + */ + public static Image scale(Image srcImg, float scale) { + return Img.from(srcImg).scale(scale).getImg(); + } + + /** + * 缩放图像（按长宽缩放）
+ * 注意：目标长宽与原图不成比例会变形 + * + * @param srcImg 源图像来源流 + * @param width 目标宽度 + * @param height 目标高度 + * @return {@link Image} + * @since 3.1.0 + */ + public static Image scale(Image srcImg, int width, int height) { + return Img.from(srcImg).scale(width, height).getImg(); + } + + /** + * 缩放图像（按高度和宽度缩放）
+ * 缩放后默认格式与源图片相同，无法识别原图片默认JPG + * + * @param srcImageFile 源图像文件地址 + * @param destImageFile 缩放后的图像地址 + * @param width 缩放后的宽度 + * @param height 缩放后的高度 + * @param fixedColor 补充的颜色，不补充为{@code null} + * @throws IORuntimeException IO异常 + */ + public static void scale(File srcImageFile, File destImageFile, int width, int height, Color fixedColor) throws IORuntimeException { + Img.from(srcImageFile)// + .setTargetImageType(FileUtil.extName(destImageFile))// + .scale(width, height, fixedColor)// + .write(destImageFile); + } + + /** + * 缩放图像（按高度和宽度缩放）
+ * 缩放后默认为jpeg格式，此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param destStream 缩放后的图像目标流 + * @param width 缩放后的宽度 + * @param height 缩放后的高度 + * @param fixedColor 比例不对时补充的颜色，不补充为{@code null} + * @throws IORuntimeException IO异常 + */ + public static void scale(InputStream srcStream, OutputStream destStream, int width, int height, Color fixedColor) throws IORuntimeException { + scale(read(srcStream), getImageOutputStream(destStream), width, height, fixedColor); + } + + /** + * 缩放图像（按高度和宽度缩放）
+ * 缩放后默认为jpeg格式，此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param destStream 缩放后的图像目标流 + * @param width 缩放后的宽度 + * @param height 缩放后的高度 + * @param fixedColor 比例不对时补充的颜色，不补充为{@code null} + * @throws IORuntimeException IO异常 + */ + public static void scale(ImageInputStream srcStream, ImageOutputStream destStream, int width, int height, Color fixedColor) throws IORuntimeException { + scale(read(srcStream), destStream, width, height, fixedColor); + } + + /** + * 缩放图像（按高度和宽度缩放）
+ * 缩放后默认为jpeg格式，此方法并不关闭流 + * + * @param srcImage 源图像 + * @param destImageStream 缩放后的图像目标流 + * @param width 缩放后的宽度 + * @param height 缩放后的高度 + * @param fixedColor 比例不对时补充的颜色，不补充为{@code null} + * @throws IORuntimeException IO异常 + */ + public static void scale(Image srcImage, ImageOutputStream destImageStream, int width, int height, Color fixedColor) throws IORuntimeException { + writeJpg(scale(srcImage, width, height, fixedColor), destImageStream); + } + + /** + * 缩放图像（按高度和宽度缩放）
+ * 缩放后默认为jpeg格式 + * + * @param srcImage 源图像 + * @param width 缩放后的宽度 + * @param height 缩放后的高度 + * @param fixedColor 比例不对时补充的颜色，不补充为{@code null} + * @return {@link Image} + */ + public static Image scale(Image srcImage, int width, int height, Color fixedColor) { + return Img.from(srcImage).scale(width, height, fixedColor).getImg(); + } + + // ---------------------------------------------------------------------------------------------------------------------- cut + + /** + * 图像切割(按指定起点坐标和宽高切割) + * + * @param srcImgFile 源图像文件 + * @param destImgFile 切片后的图像文件 + * @param rectangle 矩形对象，表示矩形区域的x，y，width，height + * @since 3.1.0 + */ + public static void cut(File srcImgFile, File destImgFile, Rectangle rectangle) { + cut(read(srcImgFile), destImgFile, rectangle); + } + + /** + * 图像切割(按指定起点坐标和宽高切割)，此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param destStream 切片后的图像输出流 + * @param rectangle 矩形对象，表示矩形区域的x，y，width，height + * @since 3.1.0 + */ + public static void cut(InputStream srcStream, OutputStream destStream, Rectangle rectangle) { + cut(read(srcStream), destStream, rectangle); + } + + /** + * 图像切割(按指定起点坐标和宽高切割)，此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param destStream 切片后的图像输出流 + * @param rectangle 矩形对象，表示矩形区域的x，y，width，height + * @since 3.1.0 + */ + public static void cut(ImageInputStream srcStream, ImageOutputStream destStream, Rectangle rectangle) { + cut(read(srcStream), destStream, rectangle); + } + + /** + * 图像切割(按指定起点坐标和宽高切割)，此方法并不关闭流 + * + * @param srcImage 源图像 + * @param destFile 输出的文件 + * @param rectangle 矩形对象，表示矩形区域的x，y，width，height + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void cut(Image srcImage, File destFile, Rectangle rectangle) throws IORuntimeException { + write(cut(srcImage, rectangle), destFile); + } + + /** + * 图像切割(按指定起点坐标和宽高切割)，此方法并不关闭流 + * + * @param srcImage 源图像 + * @param out 切片后的图像输出流 + * @param rectangle 矩形对象，表示矩形区域的x，y，width，height + * @throws IORuntimeException IO异常 + * @since 3.1.0 + */ + public static void cut(Image srcImage, OutputStream out, Rectangle rectangle) throws IORuntimeException { + cut(srcImage, getImageOutputStream(out), rectangle); + } + + /** + * 图像切割(按指定起点坐标和宽高切割)，此方法并不关闭流 + * + * @param srcImage 源图像 + * @param destImageStream 切片后的图像输出流 + * @param rectangle 矩形对象，表示矩形区域的x，y，width，height + * @throws IORuntimeException IO异常 + * @since 3.1.0 + */ + public static void cut(Image srcImage, ImageOutputStream destImageStream, Rectangle rectangle) throws IORuntimeException { + writeJpg(cut(srcImage, rectangle), destImageStream); + } + + /** + * 图像切割(按指定起点坐标和宽高切割) + * + * @param srcImage 源图像 + * @param rectangle 矩形对象，表示矩形区域的x，y，width，height + * @return {@link BufferedImage} + * @since 3.1.0 + */ + public static Image cut(Image srcImage, Rectangle rectangle) { + return Img.from(srcImage).setPositionBaseCentre(false).cut(rectangle).getImg(); + } + + /** + * 图像切割(按指定起点坐标和宽高切割)，填充满整个图片（直径取长宽最小值） + * + * @param srcImage 源图像 + * @param x 原图的x坐标起始位置 + * @param y 原图的y坐标起始位置 + * @return {@link Image} + * @since 4.1.15 + */ + public static Image cut(Image srcImage, int x, int y) { + return cut(srcImage, x, y, -1); + } + + /** + * 图像切割(按指定起点坐标和宽高切割) + * + * @param srcImage 源图像 + * @param x 原图的x坐标起始位置 + * @param y 原图的y坐标起始位置 + * @param radius 半径，小于0表示填充满整个图片（直径取长宽最小值） + * @return {@link Image} + * @since 4.1.15 + */ + public static Image cut(Image srcImage, int x, int y, int radius) { + return Img.from(srcImage).cut(x, y, radius).getImg(); + } + + /** + * 图像切片（指定切片的宽度和高度） + * + * @param srcImageFile 源图像 + * @param descDir 切片目标文件夹 + * @param destWidth 目标切片宽度。默认200 + * @param destHeight 目标切片高度。默认150 + */ + public static void slice(File srcImageFile, File descDir, int destWidth, int destHeight) { + slice(read(srcImageFile), descDir, destWidth, destHeight); + } + + /** + * 图像切片（指定切片的宽度和高度） + * + * @param srcImage 源图像 + * @param descDir 切片目标文件夹 + * @param destWidth 目标切片宽度。默认200 + * @param destHeight 目标切片高度。默认150 + */ + public static void slice(Image srcImage, File descDir, int destWidth, int destHeight) { + if (destWidth <= 0) { + destWidth = 200; // 切片宽度 + } + if (destHeight <= 0) { + destHeight = 150; // 切片高度 + } + int srcWidth = srcImage.getWidth(null); // 源图宽度 + int srcHeight = srcImage.getHeight(null); // 源图高度 + + if (srcWidth < destWidth) { + destWidth = srcWidth; + } + if (srcHeight < destHeight) { + destHeight = srcHeight; + } + + int cols; // 切片横向数量 + int rows; // 切片纵向数量 + // 计算切片的横向和纵向数量 + if (srcWidth % destWidth == 0) { + cols = srcWidth / destWidth; + } else { + cols = (int) Math.floor((double) srcWidth / destWidth) + 1; + } + if (srcHeight % destHeight == 0) { + rows = srcHeight / destHeight; + } else { + rows = (int) Math.floor((double) srcHeight / destHeight) + 1; + } + // 循环建立切片 + Image tag; + for (int i = 0; i < rows; i++) { + for (int j = 0; j < cols; j++) { + // 四个参数分别为图像起点坐标和宽高 + // 即: CropImageFilter(int x,int y,int width,int height) + tag = cut(srcImage, new Rectangle(j * destWidth, i * destHeight, destWidth, destHeight)); + // 输出为文件 + write(tag, FileUtil.file(descDir, "_r" + i + "_c" + j + ".jpg")); + } + } + } + + /** + * 图像切割（指定切片的行数和列数） + * + * @param srcImageFile 源图像文件 + * @param destDir 切片目标文件夹 + * @param rows 目标切片行数。默认2，必须是范围 [1, 20] 之内 + * @param cols 目标切片列数。默认2，必须是范围 [1, 20] 之内 + */ + public static void sliceByRowsAndCols(File srcImageFile, File destDir, int rows, int cols) { + sliceByRowsAndCols(srcImageFile, destDir, IMAGE_TYPE_JPEG, rows, cols); + } + + /** + * 图像切割（指定切片的行数和列数） + * + * @param srcImageFile 源图像文件 + * @param destDir 切片目标文件夹 + * @param format 目标文件格式 + * @param rows 目标切片行数。默认2，必须是范围 [1, 20] 之内 + * @param cols 目标切片列数。默认2，必须是范围 [1, 20] 之内 + */ + public static void sliceByRowsAndCols(File srcImageFile, File destDir, String format, int rows, int cols) { + try { + sliceByRowsAndCols(ImageIO.read(srcImageFile), destDir, format, rows, cols); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 图像切割（指定切片的行数和列数），默认RGB模式 + * + * @param srcImage 源图像，如果非{@link BufferedImage}，则默认使用RGB模式 + * @param destDir 切片目标文件夹 + * @param rows 目标切片行数。默认2，必须是范围 [1, 20] 之内 + * @param cols 目标切片列数。默认2，必须是范围 [1, 20] 之内 + */ + public static void sliceByRowsAndCols(Image srcImage, File destDir, int rows, int cols) { + sliceByRowsAndCols(srcImage, destDir, IMAGE_TYPE_JPEG, rows, cols); + } + + /** + * 图像切割（指定切片的行数和列数），默认RGB模式 + * + * @param srcImage 源图像，如果非{@link BufferedImage}，则默认使用RGB模式 + * @param destDir 切片目标文件夹 + * @param format 目标文件格式 + * @param rows 目标切片行数。默认2，必须是范围 [1, 20] 之内 + * @param cols 目标切片列数。默认2，必须是范围 [1, 20] 之内 + * @since 5.8.6 + */ + public static void sliceByRowsAndCols(Image srcImage, File destDir, String format, int rows, int cols) { + if (false == destDir.exists()) { + FileUtil.mkdir(destDir); + } else if (false == destDir.isDirectory()) { + throw new IllegalArgumentException("Destination Dir must be a Directory !"); + } + + try { + if (rows <= 0 || rows > 20) { + rows = 2; // 切片行数 + } + if (cols <= 0 || cols > 20) { + cols = 2; // 切片列数 + } + // 读取源图像 + final BufferedImage bi = toBufferedImage(srcImage); + int srcWidth = bi.getWidth(); // 源图宽度 + int srcHeight = bi.getHeight(); // 源图高度 + + int destWidth = NumberUtil.partValue(srcWidth, cols); // 每张切片的宽度 + int destHeight = NumberUtil.partValue(srcHeight, rows); // 每张切片的高度 + + // 循环建立切片 + Image tag; + for (int i = 0; i < rows; i++) { + for (int j = 0; j < cols; j++) { + tag = cut(bi, new Rectangle(j * destWidth, i * destHeight, destWidth, destHeight)); + // 输出为文件 + ImageIO.write(toRenderedImage(tag), format, new File(destDir, "_r" + i + "_c" + j + "." + format)); + } + } + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + // ---------------------------------------------------------------------------------------------------------------------- convert + + /** + * 图像类型转换：GIF=》JPG、GIF=》PNG、PNG=》JPG、PNG=》GIF(X)、BMP=》PNG + * + * @param srcImageFile 源图像文件 + * @param destImageFile 目标图像文件 + */ + public static void convert(File srcImageFile, File destImageFile) { + Assert.notNull(srcImageFile); + Assert.notNull(destImageFile); + Assert.isFalse(srcImageFile.equals(destImageFile), "Src file is equals to dest file!"); + + final String srcExtName = FileUtil.extName(srcImageFile); + final String destExtName = FileUtil.extName(destImageFile); + if (StrUtil.equalsIgnoreCase(srcExtName, destExtName)) { + // 扩展名相同直接复制文件 + FileUtil.copy(srcImageFile, destImageFile, true); + } + + ImageOutputStream imageOutputStream = null; + try { + imageOutputStream = getImageOutputStream(destImageFile); + convert(read(srcImageFile), destExtName, imageOutputStream, StrUtil.equalsIgnoreCase(IMAGE_TYPE_PNG, srcExtName)); + } finally { + IoUtil.close(imageOutputStream); + } + } + + /** + * 图像类型转换：GIF=》JPG、GIF=》PNG、PNG=》JPG、PNG=》GIF(X)、BMP=》PNG
+ * 此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param formatName 包含格式非正式名称的 String：如JPG、JPEG、GIF等 + * @param destStream 目标图像输出流 + * @since 3.0.9 + */ + public static void convert(InputStream srcStream, String formatName, OutputStream destStream) { + write(read(srcStream), formatName, getImageOutputStream(destStream)); + } + + /** + * 图像类型转换：GIF=》JPG、GIF=》PNG、PNG=》JPG、PNG=》GIF(X)、BMP=》PNG
+ * 此方法并不关闭流 + * + * @param srcImage 源图像流 + * @param formatName 包含格式非正式名称的 String：如JPG、JPEG、GIF等 + * @param destImageStream 目标图像输出流 + * @param isSrcPng 源图片是否为PNG格式 + * @since 4.1.14 + */ + public static void convert(Image srcImage, String formatName, ImageOutputStream destImageStream, boolean isSrcPng) { + try { + ImageIO.write(isSrcPng ? copyImage(srcImage, BufferedImage.TYPE_INT_RGB) : toBufferedImage(srcImage), formatName, destImageStream); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + // ---------------------------------------------------------------------------------------------------------------------- grey + + /** + * 彩色转为黑白 + * + * @param srcImageFile 源图像地址 + * @param destImageFile 目标图像地址 + */ + public static void gray(File srcImageFile, File destImageFile) { + gray(read(srcImageFile), destImageFile); + } + + /** + * 彩色转为黑白
+ * 此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param destStream 目标图像流 + * @since 3.0.9 + */ + public static void gray(InputStream srcStream, OutputStream destStream) { + gray(read(srcStream), getImageOutputStream(destStream)); + } + + /** + * 彩色转为黑白
+ * 此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param destStream 目标图像流 + * @since 3.0.9 + */ + public static void gray(ImageInputStream srcStream, ImageOutputStream destStream) { + gray(read(srcStream), destStream); + } + + /** + * 彩色转为黑白 + * + * @param srcImage 源图像流 + * @param outFile 目标文件 + * @since 3.2.2 + */ + public static void gray(Image srcImage, File outFile) { + write(gray(srcImage), outFile); + } + + /** + * 彩色转为黑白
+ * 此方法并不关闭流 + * + * @param srcImage 源图像流 + * @param out 目标图像流 + * @since 3.2.2 + */ + public static void gray(Image srcImage, OutputStream out) { + gray(srcImage, getImageOutputStream(out)); + } + + /** + * 彩色转为黑白
+ * 此方法并不关闭流 + * + * @param srcImage 源图像流 + * @param destImageStream 目标图像流 + * @throws IORuntimeException IO异常 + * @since 3.0.9 + */ + public static void gray(Image srcImage, ImageOutputStream destImageStream) throws IORuntimeException { + writeJpg(gray(srcImage), destImageStream); + } + + /** + * 彩色转为黑白 + * + * @param srcImage 源图像流 + * @return {@link Image}灰度后的图片 + * @since 3.1.0 + */ + public static Image gray(Image srcImage) { + return Img.from(srcImage).gray().getImg(); + } + + // ---------------------------------------------------------------------------------------------------------------------- binary + + /** + * 彩色转为黑白二值化图片，根据目标文件扩展名确定转换后的格式 + * + * @param srcImageFile 源图像地址 + * @param destImageFile 目标图像地址 + */ + public static void binary(File srcImageFile, File destImageFile) { + binary(read(srcImageFile), destImageFile); + } + + /** + * 彩色转为黑白二值化图片
+ * 此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param destStream 目标图像流 + * @param imageType 图片格式(扩展名) + * @since 4.0.5 + */ + public static void binary(InputStream srcStream, OutputStream destStream, String imageType) { + binary(read(srcStream), getImageOutputStream(destStream), imageType); + } + + /** + * 彩色转为黑白黑白二值化图片
+ * 此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param destStream 目标图像流 + * @param imageType 图片格式(扩展名) + * @since 4.0.5 + */ + public static void binary(ImageInputStream srcStream, ImageOutputStream destStream, String imageType) { + binary(read(srcStream), destStream, imageType); + } + + /** + * 彩色转为黑白二值化图片，根据目标文件扩展名确定转换后的格式 + * + * @param srcImage 源图像流 + * @param outFile 目标文件 + * @since 4.0.5 + */ + public static void binary(Image srcImage, File outFile) { + write(binary(srcImage), outFile); + } + + /** + * 彩色转为黑白二值化图片
+ * 此方法并不关闭流，输出JPG格式 + * + * @param srcImage 源图像流 + * @param out 目标图像流 + * @param imageType 图片格式(扩展名) + * @since 4.0.5 + */ + public static void binary(Image srcImage, OutputStream out, String imageType) { + binary(srcImage, getImageOutputStream(out), imageType); + } + + /** + * 彩色转为黑白二值化图片
+ * 此方法并不关闭流，输出JPG格式 + * + * @param srcImage 源图像流 + * @param destImageStream 目标图像流 + * @param imageType 图片格式(扩展名) + * @throws IORuntimeException IO异常 + * @since 4.0.5 + */ + public static void binary(Image srcImage, ImageOutputStream destImageStream, String imageType) throws IORuntimeException { + write(binary(srcImage), imageType, destImageStream); + } + + /** + * 彩色转为黑白二值化图片 + * + * @param srcImage 源图像流 + * @return {@link Image}二值化后的图片 + * @since 4.0.5 + */ + public static Image binary(Image srcImage) { + return Img.from(srcImage).binary().getImg(); + } + + // ---------------------------------------------------------------------------------------------------------------------- press + + /** + * 给图片添加文字水印 + * + * @param imageFile 源图像文件 + * @param destFile 目标图像文件 + * @param pressText 水印文字 + * @param color 水印的字体颜色 + * @param font {@link Font} 字体相关信息，如果默认则为{@code null} + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + */ + public static void pressText(File imageFile, File destFile, String pressText, Color color, Font font, int x, int y, float alpha) { + pressText(read(imageFile), destFile, pressText, color, font, x, y, alpha); + } + + /** + * 给图片添加文字水印
+ * 此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param destStream 目标图像流 + * @param pressText 水印文字 + * @param color 水印的字体颜色 + * @param font {@link Font} 字体相关信息，如果默认则为{@code null} + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + */ + public static void pressText(InputStream srcStream, OutputStream destStream, String pressText, Color color, Font font, int x, int y, float alpha) { + pressText(read(srcStream), getImageOutputStream(destStream), pressText, color, font, x, y, alpha); + } + + /** + * 给图片添加文字水印
+ * 此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param destStream 目标图像流 + * @param pressText 水印文字 + * @param color 水印的字体颜色 + * @param font {@link Font} 字体相关信息，如果默认则为{@code null} + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + */ + public static void pressText(ImageInputStream srcStream, ImageOutputStream destStream, String pressText, Color color, Font font, int x, int y, float alpha) { + pressText(read(srcStream), destStream, pressText, color, font, x, y, alpha); + } + + /** + * 给图片添加文字水印
+ * 此方法并不关闭流 + * + * @param srcImage 源图像 + * @param destFile 目标流 + * @param pressText 水印文字 + * @param color 水印的字体颜色 + * @param font {@link Font} 字体相关信息，如果默认则为{@code null} + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void pressText(Image srcImage, File destFile, String pressText, Color color, Font font, int x, int y, float alpha) throws IORuntimeException { + write(pressText(srcImage, pressText, color, font, x, y, alpha), destFile); + } + + /** + * 给图片添加文字水印
+ * 此方法并不关闭流 + * + * @param srcImage 源图像 + * @param to 目标流 + * @param pressText 水印文字 + * @param color 水印的字体颜色 + * @param font {@link Font} 字体相关信息，如果默认则为{@code null} + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void pressText(Image srcImage, OutputStream to, String pressText, Color color, Font font, int x, int y, float alpha) throws IORuntimeException { + pressText(srcImage, getImageOutputStream(to), pressText, color, font, x, y, alpha); + } + + /** + * 给图片添加文字水印
+ * 此方法并不关闭流 + * + * @param srcImage 源图像 + * @param destImageStream 目标图像流 + * @param pressText 水印文字 + * @param color 水印的字体颜色 + * @param font {@link Font} 字体相关信息，如果默认则为{@code null} + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @throws IORuntimeException IO异常 + */ + public static void pressText(Image srcImage, ImageOutputStream destImageStream, String pressText, Color color, Font font, int x, int y, float alpha) throws IORuntimeException { + writeJpg(pressText(srcImage, pressText, color, font, x, y, alpha), destImageStream); + } + + /** + * 给图片添加文字水印
+ * 此方法并不关闭流 + * + * @param srcImage 源图像 + * @param pressText 水印文字 + * @param color 水印的字体颜色 + * @param font {@link Font} 字体相关信息，如果默认则为{@code null} + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @return 处理后的图像 + * @since 3.2.2 + */ + public static Image pressText(Image srcImage, String pressText, Color color, Font font, int x, int y, float alpha) { + return Img.from(srcImage).pressText(pressText, color, font, x, y, alpha).getImg(); + } + + /** + * 给图片添加图片水印 + * + * @param srcImageFile 源图像文件 + * @param destImageFile 目标图像文件 + * @param pressImg 水印图片 + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + */ + public static void pressImage(File srcImageFile, File destImageFile, Image pressImg, int x, int y, float alpha) { + pressImage(read(srcImageFile), destImageFile, pressImg, x, y, alpha); + } + + /** + * 给图片添加图片水印
+ * 此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param destStream 目标图像流 + * @param pressImg 水印图片，可以使用{@link ImageIO#read(File)}方法读取文件 + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + */ + public static void pressImage(InputStream srcStream, OutputStream destStream, Image pressImg, int x, int y, float alpha) { + pressImage(read(srcStream), getImageOutputStream(destStream), pressImg, x, y, alpha); + } + + /** + * 给图片添加图片水印
+ * 此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param destStream 目标图像流 + * @param pressImg 水印图片，可以使用{@link ImageIO#read(File)}方法读取文件 + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @throws IORuntimeException IO异常 + */ + public static void pressImage(ImageInputStream srcStream, ImageOutputStream destStream, Image pressImg, int x, int y, float alpha) throws IORuntimeException { + pressImage(read(srcStream), destStream, pressImg, x, y, alpha); + } + + /** + * 给图片添加图片水印
+ * 此方法并不关闭流 + * + * @param srcImage 源图像流 + * @param outFile 写出文件 + * @param pressImg 水印图片，可以使用{@link ImageIO#read(File)}方法读取文件 + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void pressImage(Image srcImage, File outFile, Image pressImg, int x, int y, float alpha) throws IORuntimeException { + write(pressImage(srcImage, pressImg, x, y, alpha), outFile); + } + + /** + * 给图片添加图片水印
+ * 此方法并不关闭流 + * + * @param srcImage 源图像流 + * @param out 目标图像流 + * @param pressImg 水印图片，可以使用{@link ImageIO#read(File)}方法读取文件 + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void pressImage(Image srcImage, OutputStream out, Image pressImg, int x, int y, float alpha) throws IORuntimeException { + pressImage(srcImage, getImageOutputStream(out), pressImg, x, y, alpha); + } + + /** + * 给图片添加图片水印
+ * 此方法并不关闭流 + * + * @param srcImage 源图像流 + * @param destImageStream 目标图像流 + * @param pressImg 水印图片，可以使用{@link ImageIO#read(File)}方法读取文件 + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @throws IORuntimeException IO异常 + */ + public static void pressImage(Image srcImage, ImageOutputStream destImageStream, Image pressImg, int x, int y, float alpha) throws IORuntimeException { + writeJpg(pressImage(srcImage, pressImg, x, y, alpha), destImageStream); + } + + /** + * 给图片添加图片水印
+ * 此方法并不关闭流 + * + * @param srcImage 源图像流 + * @param pressImg 水印图片，可以使用{@link ImageIO#read(File)}方法读取文件 + * @param x 修正值。 默认在中间，偏移量相对于中间偏移 + * @param y 修正值。 默认在中间，偏移量相对于中间偏移 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @return 结果图片 + */ + public static Image pressImage(Image srcImage, Image pressImg, int x, int y, float alpha) { + return Img.from(srcImage).pressImage(pressImg, x, y, alpha).getImg(); + } + + /** + * 给图片添加图片水印
+ * 此方法并不关闭流 + * + * @param srcImage 源图像流 + * @param pressImg 水印图片，可以使用{@link ImageIO#read(File)}方法读取文件 + * @param rectangle 矩形对象，表示矩形区域的x，y，width，height，x,y从背景图片中心计算 + * @param alpha 透明度：alpha 必须是范围 [0.0, 1.0] 之内（包含边界值）的一个浮点数字 + * @return 结果图片 + * @since 4.1.14 + */ + public static Image pressImage(Image srcImage, Image pressImg, Rectangle rectangle, float alpha) { + return Img.from(srcImage).pressImage(pressImg, rectangle, alpha).getImg(); + } + + // ---------------------------------------------------------------------------------------------------------------------- rotate + + /** + * 旋转图片为指定角度
+ * 此方法不会关闭输出流 + * + * @param imageFile 被旋转图像文件 + * @param degree 旋转角度 + * @param outFile 输出文件 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void rotate(File imageFile, int degree, File outFile) throws IORuntimeException { + rotate(read(imageFile), degree, outFile); + } + + /** + * 旋转图片为指定角度
+ * 此方法不会关闭输出流 + * + * @param image 目标图像 + * @param degree 旋转角度 + * @param outFile 输出文件 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void rotate(Image image, int degree, File outFile) throws IORuntimeException { + write(rotate(image, degree), outFile); + } + + /** + * 旋转图片为指定角度
+ * 此方法不会关闭输出流 + * + * @param image 目标图像 + * @param degree 旋转角度 + * @param out 输出流 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void rotate(Image image, int degree, OutputStream out) throws IORuntimeException { + writeJpg(rotate(image, degree), getImageOutputStream(out)); + } + + /** + * 旋转图片为指定角度
+ * 此方法不会关闭输出流，输出格式为JPG + * + * @param image 目标图像 + * @param degree 旋转角度 + * @param out 输出图像流 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void rotate(Image image, int degree, ImageOutputStream out) throws IORuntimeException { + writeJpg(rotate(image, degree), out); + } + + /** + * 旋转图片为指定角度
+ * 来自：http://blog.51cto.com/cping1982/130066 + * + * @param image 目标图像 + * @param degree 旋转角度 + * @return 旋转后的图片 + * @since 3.2.2 + */ + public static Image rotate(Image image, int degree) { + return Img.from(image).rotate(degree).getImg(); + } + + // ---------------------------------------------------------------------------------------------------------------------- flip + + /** + * 水平翻转图像 + * + * @param imageFile 图像文件 + * @param outFile 输出文件 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void flip(File imageFile, File outFile) throws IORuntimeException { + flip(read(imageFile), outFile); + } + + /** + * 水平翻转图像 + * + * @param image 图像 + * @param outFile 输出文件 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void flip(Image image, File outFile) throws IORuntimeException { + write(flip(image), outFile); + } + + /** + * 水平翻转图像 + * + * @param image 图像 + * @param out 输出 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void flip(Image image, OutputStream out) throws IORuntimeException { + flip(image, getImageOutputStream(out)); + } + + /** + * 水平翻转图像，写出格式为JPG + * + * @param image 图像 + * @param out 输出 + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static void flip(Image image, ImageOutputStream out) throws IORuntimeException { + writeJpg(flip(image), out); + } + + /** + * 水平翻转图像 + * + * @param image 图像 + * @return 翻转后的图片 + * @since 3.2.2 + */ + public static Image flip(Image image) { + return Img.from(image).flip().getImg(); + } + + // ---------------------------------------------------------------------------------------------------------------------- compress + + /** + * 压缩图像，输出图像只支持jpg文件 + * + * @param imageFile 图像文件 + * @param outFile 输出文件，只支持jpg文件 + * @param quality 压缩比例，必须为0~1 + * @throws IORuntimeException IO异常 + * @since 4.3.2 + */ + public static void compress(File imageFile, File outFile, float quality) throws IORuntimeException { + Img.from(imageFile).setQuality(quality).write(outFile); + } + + // ---------------------------------------------------------------------------------------------------------------------- other + + /** + * {@link Image} 转 {@link RenderedImage}
+ * 首先尝试强转，否则新建一个{@link BufferedImage}后重新绘制，使用 {@link BufferedImage#TYPE_INT_RGB} 模式。 + * + * @param img {@link Image} + * @return {@link BufferedImage} + * @since 4.3.2 + */ + public static RenderedImage toRenderedImage(Image img) { + if (img instanceof RenderedImage) { + return (RenderedImage) img; + } + + return copyImage(img, BufferedImage.TYPE_INT_RGB); + } + + /** + * {@link Image} 转 {@link BufferedImage}
+ * 首先尝试强转，否则新建一个{@link BufferedImage}后重新绘制，使用 {@link BufferedImage#TYPE_INT_RGB} 模式 + * + * @param img {@link Image} + * @return {@link BufferedImage} + */ + public static BufferedImage toBufferedImage(Image img) { + if (img instanceof BufferedImage) { + return (BufferedImage) img; + } + + return copyImage(img, BufferedImage.TYPE_INT_RGB); + } + + /** + * {@link Image} 转 {@link BufferedImage}
+ * 如果源图片的RGB模式与目标模式一致，则直接转换，否则重新绘制
+ * 默认的，png图片使用 {@link BufferedImage#TYPE_INT_ARGB}模式，其它使用 {@link BufferedImage#TYPE_INT_RGB} 模式 + * + * @param image {@link Image} + * @param imageType 目标图片类型，例如jpg或png等 + * @return {@link BufferedImage} + * @since 4.3.2 + */ + public static BufferedImage toBufferedImage(Image image, String imageType) { + return toBufferedImage(image, imageType, null); + } + + /** + * {@link Image} 转 {@link BufferedImage}
+ * 如果源图片的RGB模式与目标模式一致，则直接转换，否则重新绘制
+ * 默认的，png图片使用 {@link BufferedImage#TYPE_INT_ARGB}模式，其它使用 {@link BufferedImage#TYPE_INT_RGB} 模式 + * + * @param image {@link Image} + * @param imageType 目标图片类型，例如jpg或png等 + * @param backgroundColor 背景色{@link Color} + * @return {@link BufferedImage} + * @since 4.3.2 + */ + public static BufferedImage toBufferedImage(Image image, String imageType, Color backgroundColor) { + final int type = IMAGE_TYPE_PNG.equalsIgnoreCase(imageType) + ? BufferedImage.TYPE_INT_ARGB + : BufferedImage.TYPE_INT_RGB; + return toBufferedImage(image, type, backgroundColor); + } + + /** + * {@link Image} 转 {@link BufferedImage}
+ * 如果源图片的RGB模式与目标模式一致，则直接转换，否则重新绘制 + * + * @param image {@link Image} + * @param imageType 目标图片类型，{@link BufferedImage}中的常量，例如黑白等 + * @return {@link BufferedImage} + * @since 5.4.7 + */ + public static BufferedImage toBufferedImage(Image image, int imageType) { + BufferedImage bufferedImage; + if (image instanceof BufferedImage) { + bufferedImage = (BufferedImage) image; + if (imageType != bufferedImage.getType()) { + bufferedImage = copyImage(image, imageType); + } + return bufferedImage; + } + + bufferedImage = copyImage(image, imageType); + return bufferedImage; + } + + /** + * {@link Image} 转 {@link BufferedImage}
+ * 如果源图片的RGB模式与目标模式一致，则直接转换，否则重新绘制 + * + * @param image {@link Image} + * @param imageType 目标图片类型，{@link BufferedImage}中的常量，例如黑白等 + * @param backgroundColor 背景色{@link Color} + * @return {@link BufferedImage} + * @since 5.4.7 + */ + public static BufferedImage toBufferedImage(Image image, int imageType, Color backgroundColor) { + BufferedImage bufferedImage; + if (image instanceof BufferedImage) { + bufferedImage = (BufferedImage) image; + if (imageType != bufferedImage.getType()) { + bufferedImage = copyImage(image, imageType, backgroundColor); + } + return bufferedImage; + } + + bufferedImage = copyImage(image, imageType, backgroundColor); + return bufferedImage; + } + + /** + * 将已有Image复制新的一份出来 + * + * @param img {@link Image} + * @param imageType 目标图片类型，{@link BufferedImage}中的常量，例如黑白等 + * @return {@link BufferedImage} + * @see BufferedImage#TYPE_INT_RGB + * @see BufferedImage#TYPE_INT_ARGB + * @see BufferedImage#TYPE_INT_ARGB_PRE + * @see BufferedImage#TYPE_INT_BGR + * @see BufferedImage#TYPE_3BYTE_BGR + * @see BufferedImage#TYPE_4BYTE_ABGR + * @see BufferedImage#TYPE_4BYTE_ABGR_PRE + * @see BufferedImage#TYPE_BYTE_GRAY + * @see BufferedImage#TYPE_USHORT_GRAY + * @see BufferedImage#TYPE_BYTE_BINARY + * @see BufferedImage#TYPE_BYTE_INDEXED + * @see BufferedImage#TYPE_USHORT_565_RGB + * @see BufferedImage#TYPE_USHORT_555_RGB + */ + public static BufferedImage copyImage(Image img, int imageType) { + return copyImage(img, imageType, null); + } + + /** + * 将已有Image复制新的一份出来 + * + * @param img {@link Image} + * @param imageType 目标图片类型，{@link BufferedImage}中的常量，例如黑白等 + * @param backgroundColor 背景色，{@code null} 表示默认背景色（黑色或者透明） + * @return {@link BufferedImage} + * @see BufferedImage#TYPE_INT_RGB + * @see BufferedImage#TYPE_INT_ARGB + * @see BufferedImage#TYPE_INT_ARGB_PRE + * @see BufferedImage#TYPE_INT_BGR + * @see BufferedImage#TYPE_3BYTE_BGR + * @see BufferedImage#TYPE_4BYTE_ABGR + * @see BufferedImage#TYPE_4BYTE_ABGR_PRE + * @see BufferedImage#TYPE_BYTE_GRAY + * @see BufferedImage#TYPE_USHORT_GRAY + * @see BufferedImage#TYPE_BYTE_BINARY + * @see BufferedImage#TYPE_BYTE_INDEXED + * @see BufferedImage#TYPE_USHORT_565_RGB + * @see BufferedImage#TYPE_USHORT_555_RGB + * @since 4.5.17 + */ + public static BufferedImage copyImage(Image img, int imageType, Color backgroundColor) { + // ensures that all the pixels loaded + // issue#1821@Github + img = new ImageIcon(img).getImage(); + + final BufferedImage bimage = new BufferedImage( + img.getWidth(null), img.getHeight(null), imageType); + final Graphics2D bGr = GraphicsUtil.createGraphics(bimage, backgroundColor); + bGr.drawImage(img, 0, 0, null); + bGr.dispose(); + + return bimage; + } + + /** + * 创建与当前设备颜色模式兼容的 {@link BufferedImage} + * + * @param width 宽度 + * @param height 高度 + * @param transparency 透明模式，见 {@link java.awt.Transparency} + * @return {@link BufferedImage} + * @since 5.7.13 + */ + public static BufferedImage createCompatibleImage(int width, int height, int transparency) throws HeadlessException { + GraphicsEnvironment ge = GraphicsEnvironment.getLocalGraphicsEnvironment(); + GraphicsDevice gs = ge.getDefaultScreenDevice(); + GraphicsConfiguration gc = gs.getDefaultConfiguration(); + return gc.createCompatibleImage(width, height, transparency); + } + + /** + * 将Base64编码的图像信息转为 {@link BufferedImage} + * + * @param base64 图像的Base64表示 + * @return {@link BufferedImage} + * @throws IORuntimeException IO异常 + */ + public static BufferedImage toImage(String base64) throws IORuntimeException { + return toImage(Base64.decode(base64)); + } + + /** + * 将的图像bytes转为 {@link BufferedImage} + * + * @param imageBytes 图像bytes + * @return {@link BufferedImage} + * @throws IORuntimeException IO异常 + */ + public static BufferedImage toImage(byte[] imageBytes) throws IORuntimeException { + return read(new ByteArrayInputStream(imageBytes)); + } + + /** + * 将图片对象转换为InputStream形式 + * + * @param image 图片对象 + * @param imageType 图片类型 + * @return Base64的字符串表现形式 + * @since 4.2.4 + */ + public static ByteArrayInputStream toStream(Image image, String imageType) { + return IoUtil.toStream(toBytes(image, imageType)); + } + + /** + * 将图片对象转换为Base64的Data URI形式，格式为：data:image/[imageType];base64,[data] + * + * @param image 图片对象 + * @param imageType 图片类型 + * @return Base64的字符串表现形式 + * @since 5.3.6 + */ + public static String toBase64DataUri(Image image, String imageType) { + return URLUtil.getDataUri( + "image/" + imageType, "base64", + toBase64(image, imageType)); + } + + /** + * 将图片对象转换为Base64形式 + * + * @param image 图片对象 + * @param imageType 图片类型 + * @return Base64的字符串表现形式 + * @since 4.1.8 + */ + public static String toBase64(Image image, String imageType) { + return Base64.encode(toBytes(image, imageType)); + } + + /** + * 将图片对象转换为bytes形式 + * + * @param image 图片对象 + * @param imageType 图片类型 + * @return Base64的字符串表现形式 + * @since 5.2.4 + */ + public static byte[] toBytes(Image image, String imageType) { + final ByteArrayOutputStream out = new ByteArrayOutputStream(); + write(image, imageType, out); + return out.toByteArray(); + } + + /** + * 根据文字创建PNG图片 + * + * @param str 文字 + * @param font 字体{@link Font} + * @param backgroundColor 背景颜色，默认透明 + * @param fontColor 字体颜色，默认黑色 + * @param out 图片输出地 + * @throws IORuntimeException IO异常 + */ + public static void createImage(String str, Font font, Color backgroundColor, Color fontColor, ImageOutputStream out) throws IORuntimeException { + writePng(createImage(str, font, backgroundColor, fontColor, BufferedImage.TYPE_INT_ARGB), out); + } + + /** + * 根据文字创建透明背景的PNG图片 + * + * @param str 文字 + * @param font 字体{@link Font} + * @param fontColor 字体颜色，默认黑色 + * @param out 图片输出地 + * @throws IORuntimeException IO异常 + */ + public static void createTransparentImage(String str, Font font, Color fontColor, ImageOutputStream out) throws IORuntimeException { + writePng(createImage(str, font, null, fontColor, BufferedImage.TYPE_INT_ARGB), out); + } + + /** + * 根据文字创建图片 + * + * @param str 文字 + * @param font 字体{@link Font} + * @param backgroundColor 背景颜色，默认透明 + * @param fontColor 字体颜色，默认黑色 + * @param imageType 图片类型，见：{@link BufferedImage} + * @return 图片 + * @throws IORuntimeException IO异常 + */ + public static BufferedImage createImage(String str, Font font, Color backgroundColor, Color fontColor, int imageType) throws IORuntimeException { + // 获取font的样式应用在str上的整个矩形 + final Rectangle2D r = getRectangle(str, font); + // 获取单个字符的高度 + int unitHeight = (int) Math.floor(r.getHeight()); + // 获取整个str用了font样式的宽度这里用四舍五入后+1保证宽度绝对能容纳这个字符串作为图片的宽度 + int width = (int) Math.round(r.getWidth()) + 1; + // 把单个字符的高度+3保证高度绝对能容纳字符串作为图片的高度 + int height = unitHeight + 3; + + // 创建图片 + BufferedImage image = new BufferedImage(width, height, imageType); + Graphics g = image.getGraphics(); + if (null != backgroundColor) { + // 先用背景色填充整张图片,也就是背景 + g.setColor(backgroundColor); + g.fillRect(0, 0, width, height); + } + + g.setColor(ObjectUtil.defaultIfNull(fontColor, Color.BLACK)); + g.setFont(font);// 设置画笔字体 + g.drawString(str, 0, font.getSize());// 画出字符串 + g.dispose(); + + return image; + } + + /** + * 获取font的样式应用在str上的整个矩形 + * + * @param str 字符串，必须非空 + * @param font 字体，必须非空 + * @return {@link Rectangle2D} + * @since 5.3.3 + */ + public static Rectangle2D getRectangle(String str, Font font) { + return font.getStringBounds(str, + new FontRenderContext(AffineTransform.getScaleInstance(1, 1), + false, + false)); + } + + /** + * 根据文件创建字体
+ * 首先尝试创建{@link Font#TRUETYPE_FONT}字体，此类字体无效则创建{@link Font#TYPE1_FONT} + * + * @param fontFile 字体文件 + * @return {@link Font} + * @since 3.0.9 + */ + public static Font createFont(File fontFile) { + return FontUtil.createFont(fontFile); + } + + /** + * 根据文件创建字体
+ * 首先尝试创建{@link Font#TRUETYPE_FONT}字体，此类字体无效则创建{@link Font#TYPE1_FONT} + * + * @param fontStream 字体流 + * @return {@link Font} + * @since 3.0.9 + */ + public static Font createFont(InputStream fontStream) { + return FontUtil.createFont(fontStream); + } + + /** + * 创建{@link Graphics2D} + * + * @param image {@link BufferedImage} + * @param color {@link Color}背景颜色以及当前画笔颜色 + * @return {@link Graphics2D} + * @see GraphicsUtil#createGraphics(BufferedImage, Color) + * @since 3.2.3 + */ + public static Graphics2D createGraphics(BufferedImage image, Color color) { + return GraphicsUtil.createGraphics(image, color); + } + + /** + * 写出图像为JPG格式 + * + * @param image {@link Image} + * @param destImageStream 写出到的目标流 + * @throws IORuntimeException IO异常 + */ + public static void writeJpg(Image image, ImageOutputStream destImageStream) throws IORuntimeException { + write(image, IMAGE_TYPE_JPG, destImageStream); + } + + /** + * 写出图像为PNG格式 + * + * @param image {@link Image} + * @param destImageStream 写出到的目标流 + * @throws IORuntimeException IO异常 + */ + public static void writePng(Image image, ImageOutputStream destImageStream) throws IORuntimeException { + write(image, IMAGE_TYPE_PNG, destImageStream); + } + + /** + * 写出图像为JPG格式 + * + * @param image {@link Image} + * @param out 写出到的目标流 + * @throws IORuntimeException IO异常 + * @since 4.0.10 + */ + public static void writeJpg(Image image, OutputStream out) throws IORuntimeException { + write(image, IMAGE_TYPE_JPG, out); + } + + /** + * 写出图像为PNG格式 + * + * @param image {@link Image} + * @param out 写出到的目标流 + * @throws IORuntimeException IO异常 + * @since 4.0.10 + */ + public static void writePng(Image image, OutputStream out) throws IORuntimeException { + write(image, IMAGE_TYPE_PNG, out); + } + + /** + * 按照目标格式写出图像：GIF=》JPG、GIF=》PNG、PNG=》JPG、PNG=》GIF(X)、BMP=》PNG
+ * 此方法并不关闭流 + * + * @param srcStream 源图像流 + * @param formatName 包含格式非正式名称的 String：如JPG、JPEG、GIF等 + * @param destStream 目标图像输出流 + * @since 5.0.0 + */ + public static void write(ImageInputStream srcStream, String formatName, ImageOutputStream destStream) { + write(read(srcStream), formatName, destStream); + } + + /** + * 写出图像：GIF=》JPG、GIF=》PNG、PNG=》JPG、PNG=》GIF(X)、BMP=》PNG
+ * 此方法并不关闭流 + * + * @param image {@link Image} + * @param imageType 图片类型（图片扩展名） + * @param out 写出到的目标流 + * @throws IORuntimeException IO异常 + * @since 3.1.2 + */ + public static void write(Image image, String imageType, OutputStream out) throws IORuntimeException { + write(image, imageType, getImageOutputStream(out)); + } + + /** + * 写出图像为指定格式：GIF=》JPG、GIF=》PNG、PNG=》JPG、PNG=》GIF(X)、BMP=》PNG
+ * 此方法并不关闭流 + * + * @param image {@link Image} + * @param imageType 图片类型（图片扩展名） + * @param destImageStream 写出到的目标流 + * @return 是否成功写出，如果返回false表示未找到合适的Writer + * @throws IORuntimeException IO异常 + * @since 3.1.2 + */ + public static boolean write(Image image, String imageType, ImageOutputStream destImageStream) throws IORuntimeException { + return write(image, imageType, destImageStream, 1); + } + + /** + * 写出图像为指定格式 + * + * @param image {@link Image} + * @param imageType 图片类型（图片扩展名） + * @param destImageStream 写出到的目标流 + * @param quality 质量，数字为0~1（不包括0和1）表示质量压缩比，除此数字外设置表示不压缩 + * @return 是否成功写出，如果返回false表示未找到合适的Writer + * @throws IORuntimeException IO异常 + * @since 4.3.2 + */ + public static boolean write(Image image, String imageType, ImageOutputStream destImageStream, float quality) throws IORuntimeException { + return write(image, imageType, destImageStream, quality, null); + } + + /** + * 写出图像为指定格式 + * + * @param image {@link Image} + * @param imageType 图片类型（图片扩展名） + * @param destImageStream 写出到的目标流 + * @param quality 质量，数字为0~1（不包括0和1）表示质量压缩比，除此数字外设置表示不压缩 + * @param backgroundColor 背景色{@link Color} + * @return 是否成功写出，如果返回false表示未找到合适的Writer + * @throws IORuntimeException IO异常 + * @since 4.3.2 + */ + public static boolean write(Image image, String imageType, ImageOutputStream destImageStream, float quality, Color backgroundColor) throws IORuntimeException { + if (StrUtil.isBlank(imageType)) { + imageType = IMAGE_TYPE_JPG; + } + + final BufferedImage bufferedImage = toBufferedImage(image, imageType, backgroundColor); + final ImageWriter writer = getWriter(bufferedImage, imageType); + return write(bufferedImage, writer, destImageStream, quality); + } + + /** + * 写出图像为目标文件扩展名对应的格式 + * + * @param image {@link Image} + * @param targetFile 目标文件 + * @throws IORuntimeException IO异常 + * @since 3.1.0 + */ + public static void write(Image image, File targetFile) throws IORuntimeException { + FileUtil.touch(targetFile); + ImageOutputStream out = null; + try { + out = getImageOutputStream(targetFile); + write(image, FileUtil.extName(targetFile), out); + } finally { + IoUtil.close(out); + } + } + + /** + * 通过{@link ImageWriter}写出图片到输出流 + * + * @param image 图片 + * @param writer {@link ImageWriter} + * @param output 输出的Image流{@link ImageOutputStream} + * @param quality 质量，数字为0~1（不包括0和1）表示质量压缩比，除此数字外设置表示不压缩 + * @return 是否成功写出 + * @since 4.3.2 + */ + public static boolean write(Image image, ImageWriter writer, ImageOutputStream output, float quality) { + if (writer == null) { + return false; + } + + writer.setOutput(output); + final RenderedImage renderedImage = toRenderedImage(image); + // 设置质量 + ImageWriteParam imgWriteParams = null; + if (quality > 0 && quality < 1) { + imgWriteParams = writer.getDefaultWriteParam(); + if (imgWriteParams.canWriteCompressed()) { + imgWriteParams.setCompressionMode(ImageWriteParam.MODE_EXPLICIT); + imgWriteParams.setCompressionQuality(quality); + final ColorModel colorModel = renderedImage.getColorModel();// ColorModel.getRGBdefault(); + imgWriteParams.setDestinationType(new ImageTypeSpecifier(colorModel, colorModel.createCompatibleSampleModel(16, 16))); + } + } + + try { + if (null != imgWriteParams) { + writer.write(null, new IIOImage(renderedImage, null, null), imgWriteParams); + } else { + writer.write(renderedImage); + } + output.flush(); + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + writer.dispose(); + } + return true; + } + + /** + * 获得{@link ImageReader} + * + * @param type 图片文件类型，例如 "jpeg" 或 "tiff" + * @return {@link ImageReader} + */ + public static ImageReader getReader(String type) { + final Iterator iterator = ImageIO.getImageReadersByFormatName(type); + if (iterator.hasNext()) { + return iterator.next(); + } + return null; + } + + /** + * 从文件中读取图片，请使用绝对路径，使用相对路径会相对于ClassPath + * + * @param imageFilePath 图片文件路径 + * @return 图片 + * @since 4.1.15 + */ + public static BufferedImage read(String imageFilePath) { + return read(FileUtil.file(imageFilePath)); + } + + /** + * 从文件中读取图片 + * + * @param imageFile 图片文件 + * @return 图片 + * @since 3.2.2 + */ + public static BufferedImage read(File imageFile) { + BufferedImage result; + try { + result = ImageIO.read(imageFile); + } catch (IOException e) { + throw new IORuntimeException(e); + } + + if (null == result) { + throw new IllegalArgumentException("Image type of file [" + imageFile.getName() + "] is not supported!"); + } + + return result; + } + + /** + * 从URL中获取或读取图片对象 + * + * @param url URL + * @return {@link Image} + * @since 5.5.8 + */ + public static Image getImage(URL url) { + return Toolkit.getDefaultToolkit().getImage(url); + } + + /** + * 从{@link Resource}中读取图片 + * + * @param resource 图片资源 + * @return 图片 + * @since 4.4.1 + */ + public static BufferedImage read(Resource resource) { + return read(resource.getStream()); + } + + /** + * 从流中读取图片 + * + * @param imageStream 图片文件 + * @return 图片 + * @since 3.2.2 + */ + public static BufferedImage read(InputStream imageStream) { + BufferedImage result; + try { + result = ImageIO.read(imageStream); + } catch (IOException e) { + throw new IORuntimeException(e); + } + + if (null == result) { + throw new IllegalArgumentException("Image type is not supported!"); + } + + return result; + } + + /** + * 从图片流中读取图片 + * + * @param imageStream 图片文件 + * @return 图片 + * @since 3.2.2 + */ + public static BufferedImage read(ImageInputStream imageStream) { + BufferedImage result; + try { + result = ImageIO.read(imageStream); + } catch (IOException e) { + throw new IORuntimeException(e); + } + + if (null == result) { + throw new IllegalArgumentException("Image type is not supported!"); + } + + return result; + } + + /** + * 从URL中读取图片 + * + * @param imageUrl 图片文件 + * @return 图片 + * @since 3.2.2 + */ + public static BufferedImage read(URL imageUrl) { + BufferedImage result; + try { + result = ImageIO.read(imageUrl); + } catch (IOException e) { + throw new IORuntimeException(e); + } + + if (null == result) { + throw new IllegalArgumentException("Image type of [" + imageUrl + "] is not supported!"); + } + + return result; + } + + /** + * 获取{@link ImageOutputStream} + * + * @param out {@link OutputStream} + * @return {@link ImageOutputStream} + * @throws IORuntimeException IO异常 + * @since 3.1.2 + */ + public static ImageOutputStream getImageOutputStream(OutputStream out) throws IORuntimeException { + ImageOutputStream result; + try { + result = ImageIO.createImageOutputStream(out); + } catch (IOException e) { + throw new IORuntimeException(e); + } + + if (null == result) { + throw new IllegalArgumentException("Image type is not supported!"); + } + + return result; + } + + /** + * 获取{@link ImageOutputStream} + * + * @param outFile {@link File} + * @return {@link ImageOutputStream} + * @throws IORuntimeException IO异常 + * @since 3.2.2 + */ + public static ImageOutputStream getImageOutputStream(File outFile) throws IORuntimeException { + ImageOutputStream result; + try { + result = ImageIO.createImageOutputStream(outFile); + } catch (IOException e) { + throw new IORuntimeException(e); + } + + if (null == result) { + throw new IllegalArgumentException("Image type of file [" + outFile.getName() + "] is not supported!"); + } + + return result; + } + + /** + * 获取{@link ImageInputStream} + * + * @param in {@link InputStream} + * @return {@link ImageInputStream} + * @throws IORuntimeException IO异常 + * @since 3.1.2 + */ + public static ImageInputStream getImageInputStream(InputStream in) throws IORuntimeException { + ImageOutputStream result; + try { + result = ImageIO.createImageOutputStream(in); + } catch (IOException e) { + throw new IORuntimeException(e); + } + + if (null == result) { + throw new IllegalArgumentException("Image type is not supported!"); + } + + return result; + } + + /** + * 根据给定的Image对象和格式获取对应的{@link ImageWriter}，如果未找到合适的Writer，返回null + * + * @param img {@link Image} + * @param formatName 图片格式，例如"jpg"、"png" + * @return {@link ImageWriter} + * @since 4.3.2 + */ + public static ImageWriter getWriter(Image img, String formatName) { + final ImageTypeSpecifier type = ImageTypeSpecifier.createFromRenderedImage(toBufferedImage(img, formatName)); + final Iterator iter = ImageIO.getImageWriters(type, formatName); + return iter.hasNext() ? iter.next() : null; + } + + /** + * 根据给定的图片格式或者扩展名获取{@link ImageWriter}，如果未找到合适的Writer，返回null + * + * @param formatName 图片格式或扩展名，例如"jpg"、"png" + * @return {@link ImageWriter} + * @since 4.3.2 + */ + public static ImageWriter getWriter(String formatName) { + ImageWriter writer = null; + Iterator iter = ImageIO.getImageWritersByFormatName(formatName); + if (iter.hasNext()) { + writer = iter.next(); + } + if (null == writer) { + // 尝试扩展名获取 + iter = ImageIO.getImageWritersBySuffix(formatName); + if (iter.hasNext()) { + writer = iter.next(); + } + } + return writer; + } + + // -------------------------------------------------------------------------------------------------------------------- Color + + /** + * Color对象转16进制表示，例如#fcf6d6 + * + * @param color {@link Color} + * @return 16进制的颜色值，例如#fcf6d6 + * @see ColorUtil#toHex(Color) + * @since 4.1.14 + */ + public static String toHex(Color color) { + return ColorUtil.toHex(color); + } + + /** + * RGB颜色值转换成十六进制颜色码 + * + * @param r 红(R) + * @param g 绿(G) + * @param b 蓝(B) + * @return 返回字符串形式的 十六进制颜色码 + * @see ColorUtil#toHex(int, int, int) + */ + public static String toHex(int r, int g, int b) { + return ColorUtil.toHex(r, g, b); + } + + /** + * 16进制的颜色值转换为Color对象，例如#fcf6d6 + * + * @param hex 16进制的颜色值，例如#fcf6d6 + * @return {@link Color} + * @since 4.1.14 + */ + public static Color hexToColor(String hex) { + return ColorUtil.hexToColor(hex); + } + + /** + * 获取一个RGB值对应的颜色 + * + * @param rgb RGB值 + * @return {@link Color} + * @see ColorUtil#getColor(int) + * @since 4.1.14 + */ + public static Color getColor(int rgb) { + return ColorUtil.getColor(rgb); + } + + /** + * 将颜色值转换成具体的颜色类型 汇集了常用的颜色集，支持以下几种形式： + * + * 

+	 * 1. 颜色的英文名（大小写皆可）
+	 * 2. 16进制表示，例如：#fcf6d6或者$fcf6d6
+	 * 3. RGB形式，例如：13,148,252
+	 *
+ *

+ * 方法来自：com.lnwazg.kit + * + * @param colorName 颜色的英文名，16进制表示或RGB表示 + * @return {@link Color} + * @see ColorUtil#getColor(String) + * @since 4.1.14 + */ + public static Color getColor(String colorName) { + return ColorUtil.getColor(colorName); + } + + /** + * 生成随机颜色 + * + * @return 随机颜色 + * @see ColorUtil#randomColor() + * @since 3.1.2 + */ + public static Color randomColor() { + return ColorUtil.randomColor(); + } + + /** + * 生成随机颜色 + * + * @param random 随机对象 {@link Random} + * @return 随机颜色 + * @see ColorUtil#randomColor(Random) + * @since 3.1.2 + */ + public static Color randomColor(Random random) { + return ColorUtil.randomColor(random); + } + + /** + * 获得修正后的矩形坐标位置，变为以背景中心为基准坐标（即x,y == 0,0时，处于背景正中） + * + * @param rectangle 矩形 + * @param backgroundWidth 参考宽（背景宽） + * @param backgroundHeight 参考高（背景高） + * @return 修正后的{@link Point} + * @since 5.3.6 + */ + public static Point getPointBaseCentre(Rectangle rectangle, int backgroundWidth, int backgroundHeight) { + return new Point( + rectangle.x + (Math.abs(backgroundWidth - rectangle.width) / 2), // + rectangle.y + (Math.abs(backgroundHeight - rectangle.height) / 2)// + ); + } + + /** + * 获取给定图片的主色调，背景填充用 + * + * @param image {@link BufferedImage} + * @param rgbFilters 过滤多种颜色 + * @return {@link String} #ffffff + * @since 5.6.7 + */ + public static String getMainColor(BufferedImage image, int[]... rgbFilters) { + return ColorUtil.getMainColor(image, rgbFilters); + } + // ------------------------------------------------------------------------------------------------------ 背景图换算 + + /** + * 背景移除 + * 图片去底工具 + * 将 "纯色背景的图片" 还原成 "透明背景的图片" + * 将纯色背景的图片转成矢量图 + * 取图片边缘的像素点和获取到的图片主题色作为要替换的背景色 + * 再加入一定的容差值,然后将所有像素点与该颜色进行比较 + * 发现相同则将颜色不透明度设置为0,使颜色完全透明. + * + * @param inputPath 要处理图片的路径 + * @param outputPath 输出图片的路径 + * @param tolerance 容差值[根据图片的主题色,加入容差值,值的范围在0~255之间] + * @return 返回处理结果 true:图片处理完成 false:图片处理失败 + */ + public static boolean backgroundRemoval(String inputPath, String outputPath, int tolerance) { + return BackgroundRemoval.backgroundRemoval(inputPath, outputPath, tolerance); + } + + /** + * 背景移除 + * 图片去底工具 + * 将 "纯色背景的图片" 还原成 "透明背景的图片" + * 将纯色背景的图片转成矢量图 + * 取图片边缘的像素点和获取到的图片主题色作为要替换的背景色 + * 再加入一定的容差值,然后将所有像素点与该颜色进行比较 + * 发现相同则将颜色不透明度设置为0,使颜色完全透明. + * + * @param input 需要进行操作的图片 + * @param output 最后输出的文件 + * @param tolerance 容差值[根据图片的主题色,加入容差值,值的取值范围在0~255之间] + * @return 返回处理结果 true:图片处理完成 false:图片处理失败 + */ + public static boolean backgroundRemoval(File input, File output, int tolerance) { + return BackgroundRemoval.backgroundRemoval(input, output, tolerance); + } + + /** + * 背景移除 + * 图片去底工具 + * 将 "纯色背景的图片" 还原成 "透明背景的图片" + * 将纯色背景的图片转成矢量图 + * 取图片边缘的像素点和获取到的图片主题色作为要替换的背景色 + * 再加入一定的容差值,然后将所有像素点与该颜色进行比较 + * 发现相同则将颜色不透明度设置为0,使颜色完全透明. + * + * @param input 需要进行操作的图片 + * @param output 最后输出的文件 + * @param override 指定替换成的背景颜色 为null时背景为透明 + * @param tolerance 容差值[根据图片的主题色,加入容差值,值的取值范围在0~255之间] + * @return 返回处理结果 true:图片处理完成 false:图片处理失败 + */ + public static boolean backgroundRemoval(File input, File output, Color override, int tolerance) { + return BackgroundRemoval.backgroundRemoval(input, output, override, tolerance); + } + + /** + * 背景移除 + * 图片去底工具 + * 将 "纯色背景的图片" 还原成 "透明背景的图片" + * 将纯色背景的图片转成矢量图 + * 取图片边缘的像素点和获取到的图片主题色作为要替换的背景色 + * 再加入一定的容差值,然后将所有像素点与该颜色进行比较 + * 发现相同则将颜色不透明度设置为0,使颜色完全透明. + * + * @param bufferedImage 需要进行处理的图片流 + * @param override 指定替换成的背景颜色 为null时背景为透明 + * @param tolerance 容差值[根据图片的主题色,加入容差值,值的取值范围在0~255之间] + * @return 返回处理好的图片流 + */ + public static BufferedImage backgroundRemoval(BufferedImage bufferedImage, Color override, int tolerance) { + return BackgroundRemoval.backgroundRemoval(bufferedImage, override, tolerance); + } + + /** + * 背景移除 + * 图片去底工具 + * 将 "纯色背景的图片" 还原成 "透明背景的图片" + * 将纯色背景的图片转成矢量图 + * 取图片边缘的像素点和获取到的图片主题色作为要替换的背景色 + * 再加入一定的容差值,然后将所有像素点与该颜色进行比较 + * 发现相同则将颜色不透明度设置为0,使颜色完全透明. + * + * @param outputStream 需要进行处理的图片字节数组流 + * @param override 指定替换成的背景颜色 为null时背景为透明 + * @param tolerance 容差值[根据图片的主题色,加入容差值,值的取值范围在0~255之间] + * @return 返回处理好的图片流 + */ + public static BufferedImage backgroundRemoval(ByteArrayOutputStream outputStream, Color override, int tolerance) { + return BackgroundRemoval.backgroundRemoval(outputStream, override, tolerance); + } + + /** + * 图片颜色转换
+ * 可以使用灰度 (gray)等 + * + * @param colorSpace 颜色模式，如灰度等 + * @param image 被转换的图片 + * @return 转换后的图片 + * @since 5.7.8 + */ + public static BufferedImage colorConvert(ColorSpace colorSpace, BufferedImage image) { + return filter(new ColorConvertOp(colorSpace, null), image); + } + + /** + * 转换图片
+ * 可以使用一系列平移 (translation)、缩放 (scale)、翻转 (flip)、旋转 (rotation) 和错切 (shear) 来构造仿射变换。 + * + * @param xform 2D仿射变换，它执行从 2D 坐标到其他 2D 坐标的线性映射，保留了线的“直线性”和“平行性”。 + * @param image 被转换的图片 + * @return 转换后的图片 + * @since 5.7.8 + */ + public static BufferedImage transform(AffineTransform xform, BufferedImage image) { + return filter(new AffineTransformOp(xform, null), image); + } + + /** + * 图片过滤转换 + * + * @param op 过滤操作实现，如二维转换可传入{@link AffineTransformOp} + * @param image 原始图片 + * @return 过滤后的图片 + * @since 5.7.8 + */ + public static BufferedImage filter(BufferedImageOp op, BufferedImage image) { + return op.filter(image, null); + } + + /** + * 图片滤镜，借助 {@link ImageFilter}实现，实现不同的图片滤镜 + * + * @param filter 滤镜实现 + * @param image 图片 + * @return 滤镜后的图片 + * @since 5.7.8 + */ + public static Image filter(ImageFilter filter, Image image) { + return Toolkit.getDefaultToolkit().createImage( + new FilteredImageSource(image.getSource(), filter)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/LabColor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/LabColor.java new file mode 100644 index 0000000..fc710a6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/LabColor.java @@ -0,0 +1,90 @@ +package aiyh.utils.tool.cn.hutool.core.img; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.awt.Color; +import java.awt.color.ColorSpace; + +/** + * 表示以 LAB 形式存储的颜色。
+ *

    + *
  • L: 亮度
    • + *
  • a: 正数代表红色，负端代表绿色
    • + *
  • b: 正数代表黄色，负端代表蓝色
    • + *
+ * + * @author Tom Xin + * @since 5.8.7 + */ +public class LabColor { + + private static final ColorSpace XYZ_COLOR_SPACE = ColorSpace.getInstance(ColorSpace.CS_CIEXYZ); + + /** + * L: 亮度 + */ + private final double l; + /** + * A: 正数代表红色，负端代表绿色 + */ + private final double a; + /** + * B: 正数代表黄色，负端代表蓝色 + */ + private final double b; + + public LabColor(Integer rgb) { + this((rgb != null) ? new Color(rgb) : null); + } + + public LabColor(Color color) { + Assert.notNull(color, "Color must not be null"); + final float[] lab = fromXyz(color.getColorComponents(XYZ_COLOR_SPACE, null)); + this.l = lab[0]; + this.a = lab[1]; + this.b = lab[2]; + } + + /** + * 获取颜色差 + * @param other 其他Lab颜色 + * @return 颜色差 + */ + // See https://en.wikipedia.org/wiki/Color_difference#CIE94 + public double getDistance(LabColor other) { + double c1 = Math.sqrt(this.a * this.a + this.b * this.b); + double deltaC = c1 - Math.sqrt(other.a * other.a + other.b * other.b); + double deltaA = this.a - other.a; + double deltaB = this.b - other.b; + double deltaH = Math.sqrt(Math.max(0.0, deltaA * deltaA + deltaB * deltaB - deltaC * deltaC)); + return Math.sqrt(Math.max(0.0, Math.pow((this.l - other.l), 2) + + Math.pow(deltaC / (1 + 0.045 * c1), 2) + Math.pow(deltaH / (1 + 0.015 * c1), 2.0))); + } + + private float[] fromXyz(float[] xyz) { + return fromXyz(xyz[0], xyz[1], xyz[2]); + } + + /** + * 从xyz换算
+ * L=116f(y)-16
+ * a=500[f(x/0.982)-f(y)]
+ * b=200[f(y)-f(z/1.183 )]
+ * 其中： f(x)=7.787x+0.138, x<0.008856; f(x)=(x)1/3,x>0.008856 + * + * @param x X + * @param y Y + * @param z Z + * @return Lab + */ + private static float[] fromXyz(float x, float y, float z) { + final double l = (f(y) - 16.0) * 116.0; + final double a = (f(x) - f(y)) * 500.0; + final double b = (f(y) - f(z)) * 200.0; + return new float[]{(float) l, (float) a, (float) b}; + } + + private static double f(double t) { + return (t > (216.0 / 24389.0)) ? Math.cbrt(t) : (1.0 / 3.0) * Math.pow(29.0 / 6.0, 2) * t + (4.0 / 29.0); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/ScaleType.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/ScaleType.java new file mode 100755 index 0000000..be77ca8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/ScaleType.java @@ -0,0 +1,43 @@ +package aiyh.utils.tool.cn.hutool.core.img; + +import java.awt.Image; + +/** + * 图片缩略算法类型 + * + * @author looly + * @since 4.5.8 + */ +public enum ScaleType { + + /** 默认 */ + DEFAULT(Image.SCALE_DEFAULT), + /** 快速 */ + FAST(Image.SCALE_FAST), + /** 平滑 */ + SMOOTH(Image.SCALE_SMOOTH), + /** 使用 ReplicateScaleFilter 类中包含的图像缩放算法 */ + REPLICATE(Image.SCALE_REPLICATE), + /** Area Averaging算法 */ + AREA_AVERAGING(Image.SCALE_AREA_AVERAGING); + + /** + * 构造 + * + * @param value 缩放方式 + * @see Image#SCALE_DEFAULT + * @see Image#SCALE_FAST + * @see Image#SCALE_SMOOTH + * @see Image#SCALE_REPLICATE + * @see Image#SCALE_AREA_AVERAGING + */ + ScaleType(int value) { + this.value = value; + } + + private final int value; + + public int getValue() { + return this.value; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/AnimatedGifEncoder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/AnimatedGifEncoder.java new file mode 100755 index 0000000..ffb2358 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/AnimatedGifEncoder.java @@ -0,0 +1,578 @@ +package aiyh.utils.tool.cn.hutool.core.img.gif; + +import java.awt.Color; +import java.awt.Graphics2D; +import java.awt.image.BufferedImage; +import java.awt.image.DataBufferByte; +import java.io.BufferedOutputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.OutputStream; + +/** + * 动态GIF动画生成器，可生成一个或多个帧的GIF。 + * + * 
+ * Example:
+ *    AnimatedGifEncoder e = new AnimatedGifEncoder();
+ *    e.start(outputFileName);
+ *    e.setDelay(1000);   // 1 frame per sec
+ *    e.addFrame(image1);
+ *    e.addFrame(image2);
+ *    e.finish();
+ *
+ *

+ * 来自：https://github.com/rtyley/animated-gif-lib-for-java + * + * @author Kevin Weiner, FM Software + * @version 1.03 November 2003 + * @since 5.3.8 + */ +public class AnimatedGifEncoder { + + protected int width; // image size + protected int height; + protected Color transparent = null; // transparent color if given + protected boolean transparentExactMatch = false; // transparent color will be found by looking for the closest color + // or for the exact color if transparentExactMatch == true + protected Color background = null; // background color if given + protected int transIndex; // transparent index in color table + protected int repeat = -1; // no repeat + protected int delay = 0; // frame delay (hundredths) + protected boolean started = false; // ready to output frames + protected OutputStream out; + protected BufferedImage image; // current frame + protected byte[] pixels; // BGR byte array from frame + protected byte[] indexedPixels; // converted frame indexed to palette + protected int colorDepth; // number of bit planes + protected byte[] colorTab; // RGB palette + protected boolean[] usedEntry = new boolean[256]; // active palette entries + protected int palSize = 7; // color table size (bits-1) + protected int dispose = -1; // disposal code (-1 = use default) + protected boolean closeStream = false; // close stream when finished + protected boolean firstFrame = true; + protected boolean sizeSet = false; // if false, get size from first frame + protected int sample = 10; // default sample interval for quantizer + + /** + * 设置每一帧的间隔时间 + * Sets the delay time between each frame, or changes it + * for subsequent frames (applies to last frame added). + * + * @param ms 间隔时间，单位毫秒 + */ + public void setDelay(int ms) { + delay = Math.round(ms / 10.0f); + } + + /** + * Sets the GIF frame disposal code for the last added frame + * and any subsequent frames. Default is 0 if no transparent + * color has been set, otherwise 2. + * + * @param code int disposal code. + */ + public void setDispose(int code) { + if (code >= 0) { + dispose = code; + } + } + + /** + * Sets the number of times the set of GIF frames + * should be played. Default is 1; 0 means play + * indefinitely. Must be invoked before the first + * image is added. + * + * @param iter int number of iterations. + */ + public void setRepeat(int iter) { + if (iter >= 0) { + repeat = iter; + } + } + + /** + * Sets the transparent color for the last added frame + * and any subsequent frames. + * Since all colors are subject to modification + * in the quantization process, the color in the final + * palette for each frame closest to the given color + * becomes the transparent color for that frame. + * May be set to null to indicate no transparent color. + * + * @param c Color to be treated as transparent on display. + */ + public void setTransparent(Color c) { + setTransparent(c, false); + } + + /** + * Sets the transparent color for the last added frame + * and any subsequent frames. + * Since all colors are subject to modification + * in the quantization process, the color in the final + * palette for each frame closest to the given color + * becomes the transparent color for that frame. + * If exactMatch is set to true, transparent color index + * is search with exact match, and not looking for the + * closest one. + * May be set to null to indicate no transparent color. + * + * @param c Color to be treated as transparent on display. + * @param exactMatch If exactMatch is set to true, transparent color index is search with exact match + */ + public void setTransparent(Color c, boolean exactMatch) { + transparent = c; + transparentExactMatch = exactMatch; + } + + + /** + * Sets the background color for the last added frame + * and any subsequent frames. + * Since all colors are subject to modification + * in the quantization process, the color in the final + * palette for each frame closest to the given color + * becomes the background color for that frame. + * May be set to null to indicate no background color + * which will default to black. + * + * @param c Color to be treated as background on display. + */ + public void setBackground(Color c) { + background = c; + } + + /** + * Adds next GIF frame. The frame is not written immediately, but is + * actually deferred until the next frame is received so that timing + * data can be inserted. Invoking {@code finish()} flushes all + * frames. If {@code setSize} was not invoked, the size of the + * first image is used for all subsequent frames. + * + * @param im BufferedImage containing frame to write. + * @return true if successful. + */ + public boolean addFrame(BufferedImage im) { + if ((im == null) || !started) { + return false; + } + boolean ok = true; + try { + if (!sizeSet) { + // use first frame's size + setSize(im.getWidth(), im.getHeight()); + } + image = im; + getImagePixels(); // convert to correct format if necessary + analyzePixels(); // build color table & map pixels + if (firstFrame) { + writeLSD(); // logical screen descriptior + writePalette(); // global color table + if (repeat >= 0) { + // use NS app extension to indicate reps + writeNetscapeExt(); + } + } + writeGraphicCtrlExt(); // write graphic control extension + writeImageDesc(); // image descriptor + if (!firstFrame) { + writePalette(); // local color table + } + writePixels(); // encode and write pixel data + firstFrame = false; + } catch (IOException e) { + ok = false; + } + + return ok; + } + + /** + * Flushes any pending data and closes output file. + * If writing to an OutputStream, the stream is not + * closed. + * + * @return is ok + */ + public boolean finish() { + if (!started) return false; + boolean ok = true; + started = false; + try { + out.write(0x3b); // gif trailer + out.flush(); + if (closeStream) { + out.close(); + } + } catch (IOException e) { + ok = false; + } + + // reset for subsequent use + transIndex = 0; + out = null; + image = null; + pixels = null; + indexedPixels = null; + colorTab = null; + closeStream = false; + firstFrame = true; + + return ok; + } + + /** + * Sets frame rate in frames per second. Equivalent to + * {@code setDelay(1000/fps)}. + * + * @param fps float frame rate (frames per second) + */ + public void setFrameRate(float fps) { + if (fps != 0f) { + delay = Math.round(100f / fps); + } + } + + /** + * Sets quality of color quantization (conversion of images + * to the maximum 256 colors allowed by the GIF specification). + * Lower values (minimum = 1) produce better colors, but slow + * processing significantly. 10 is the default, and produces + * good color mapping at reasonable speeds. Values greater + * than 20 do not yield significant improvements in speed. + * + * @param quality int greater than 0. + */ + public void setQuality(int quality) { + if (quality < 1) quality = 1; + sample = quality; + } + + /** + * Sets the GIF frame size. The default size is the + * size of the first frame added if this method is + * not invoked. + * + * @param w int frame width. + * @param h int frame width. + */ + public void setSize(int w, int h) { + if (started && !firstFrame) return; + width = w; + height = h; + if (width < 1) width = 320; + if (height < 1) height = 240; + sizeSet = true; + } + + /** + * Initiates GIF file creation on the given stream. The stream + * is not closed automatically. + * + * @param os OutputStream on which GIF images are written. + * @return false if initial write failed. + */ + public boolean start(OutputStream os) { + if (os == null) return false; + boolean ok = true; + closeStream = false; + out = os; + try { + writeString("GIF89a"); // header + } catch (IOException e) { + ok = false; + } + return started = ok; + } + + /** + * Initiates writing of a GIF file with the specified name. + * + * @param file String containing output file name. + * @return false if open or initial write failed. + */ + public boolean start(String file) { + boolean ok; + try { + out = new BufferedOutputStream(new FileOutputStream(file)); + ok = start(out); + closeStream = true; + } catch (IOException e) { + ok = false; + } + return started = ok; + } + + public boolean isStarted() { + return started; + } + + /** + * Analyzes image colors and creates color map. + */ + protected void analyzePixels() { + int len = pixels.length; + int nPix = len / 3; + indexedPixels = new byte[nPix]; + NeuQuant nq = new NeuQuant(pixels, len, sample); + // initialize quantizer + colorTab = nq.process(); // create reduced palette + // convert map from BGR to RGB + for (int i = 0; i < colorTab.length; i += 3) { + byte temp = colorTab[i]; + colorTab[i] = colorTab[i + 2]; + colorTab[i + 2] = temp; + usedEntry[i / 3] = false; + } + // map image pixels to new palette + int k = 0; + for (int i = 0; i < nPix; i++) { + int index = + nq.map(pixels[k++] & 0xff, + pixels[k++] & 0xff, + pixels[k++] & 0xff); + usedEntry[index] = true; + indexedPixels[i] = (byte) index; + } + pixels = null; + colorDepth = 8; + palSize = 7; + // get closest match to transparent color if specified + if (transparent != null) { + transIndex = transparentExactMatch ? findExact(transparent) : findClosest(transparent); + } + } + + /** + * Returns index of palette color closest to c + * + * @param c Color + * @return index + */ + protected int findClosest(Color c) { + if (colorTab == null) return -1; + int r = c.getRed(); + int g = c.getGreen(); + int b = c.getBlue(); + int minpos = 0; + int dmin = 256 * 256 * 256; + int len = colorTab.length; + for (int i = 0; i < len; ) { + int dr = r - (colorTab[i++] & 0xff); + int dg = g - (colorTab[i++] & 0xff); + int db = b - (colorTab[i] & 0xff); + int d = dr * dr + dg * dg + db * db; + int index = i / 3; + if (usedEntry[index] && (d < dmin)) { + dmin = d; + minpos = index; + } + i++; + } + return minpos; + } + + /** + * Returns true if the exact matching color is existing, and used in the color palette, otherwise, return false. + * This method has to be called before finishing the image, + * because after finished the palette is destroyed and it will always return false. + * + * @param c 颜色 + * @return 颜色是否存在 + */ + boolean isColorUsed(Color c) { + return findExact(c) != -1; + } + + /** + * Returns index of palette exactly matching to color c or -1 if there is no exact matching. + * + * @param c Color + * @return index + */ + protected int findExact(Color c) { + if (colorTab == null) { + return -1; + } + + int r = c.getRed(); + int g = c.getGreen(); + int b = c.getBlue(); + int len = colorTab.length / 3; + for (int index = 0; index < len; ++index) { + int i = index * 3; + // If the entry is used in colorTab, then check if it is the same exact color we're looking for + if (usedEntry[index] && r == (colorTab[i] & 0xff) && g == (colorTab[i + 1] & 0xff) && b == (colorTab[i + 2] & 0xff)) { + return index; + } + } + return -1; + } + + /** + * Extracts image pixels into byte array "pixels" + */ + protected void getImagePixels() { + int w = image.getWidth(); + int h = image.getHeight(); + int type = image.getType(); + if ((w != width) + || (h != height) + || (type != BufferedImage.TYPE_3BYTE_BGR)) { + // create new image with right size/format + BufferedImage temp = + new BufferedImage(width, height, BufferedImage.TYPE_3BYTE_BGR); + Graphics2D g = temp.createGraphics(); + g.setColor(background); + g.fillRect(0, 0, width, height); + g.drawImage(image, 0, 0, null); + image = temp; + } + pixels = ((DataBufferByte) image.getRaster().getDataBuffer()).getData(); + } + + /** + * Writes Graphic Control Extension + * + * @throws IOException IO异常 + */ + protected void writeGraphicCtrlExt() throws IOException { + out.write(0x21); // extension introducer + out.write(0xf9); // GCE label + out.write(4); // data block size + int transp, disp; + if (transparent == null) { + transp = 0; + disp = 0; // dispose = no action + } else { + transp = 1; + disp = 2; // force clear if using transparent color + } + if (dispose >= 0) { + disp = dispose & 7; // user override + } + disp <<= 2; + + // packed fields + //noinspection PointlessBitwiseExpression + out.write(0 | // 1:3 reserved + disp | // 4:6 disposal + 0 | // 7 user input - 0 = none + transp); // 8 transparency flag + + writeShort(delay); // delay x 1/100 sec + out.write(transIndex); // transparent color index + out.write(0); // block terminator + } + + /** + * Writes Image Descriptor + * + * @throws IOException IO异常 + */ + protected void writeImageDesc() throws IOException { + out.write(0x2c); // image separator + writeShort(0); // image position x,y = 0,0 + writeShort(0); + writeShort(width); // image size + writeShort(height); + // packed fields + if (firstFrame) { + // no LCT - GCT is used for first (or only) frame + out.write(0); + } else { + // specify normal LCT + //noinspection PointlessBitwiseExpression + out.write(0x80 | // 1 local color table 1=yes + 0 | // 2 interlace - 0=no + 0 | // 3 sorted - 0=no + 0 | // 4-5 reserved + palSize); // 6-8 size of color table + } + } + + /** + * Writes Logical Screen Descriptor + * + * @throws IOException IO异常 + */ + protected void writeLSD() throws IOException { + // logical screen size + writeShort(width); + writeShort(height); + // packed fields + //noinspection PointlessBitwiseExpression + out.write((0x80 | // 1 : global color table flag = 1 (gct used) + 0x70 | // 2-4 : color resolution = 7 + 0x00 | // 5 : gct sort flag = 0 + palSize)); // 6-8 : gct size + + out.write(0); // background color index + out.write(0); // pixel aspect ratio - assume 1:1 + } + + /** + * Writes Netscape application extension to define + * repeat count. + * + * @throws IOException IO异常 + */ + protected void writeNetscapeExt() throws IOException { + out.write(0x21); // extension introducer + out.write(0xff); // app extension label + out.write(11); // block size + writeString("NETSCAPE" + "2.0"); // app id + auth code + out.write(3); // sub-block size + out.write(1); // loop sub-block id + writeShort(repeat); // loop count (extra iterations, 0=repeat forever) + out.write(0); // block terminator + } + + /** + * Writes color table + * + * @throws IOException IO异常 + */ + protected void writePalette() throws IOException { + out.write(colorTab, 0, colorTab.length); + int n = (3 * 256) - colorTab.length; + for (int i = 0; i < n; i++) { + out.write(0); + } + } + + /** + * Encodes and writes pixel data + * + * @throws IOException IO异常 + */ + protected void writePixels() throws IOException { + LZWEncoder encoder = new LZWEncoder(width, height, indexedPixels, colorDepth); + encoder.encode(out); + } + + /** + * Write 16-bit value to output stream, LSB first + * + * @param value 16-bit value + * @throws IOException IO异常 + */ + protected void writeShort(int value) throws IOException { + out.write(value & 0xff); + out.write((value >> 8) & 0xff); + } + + /** + * Writes string to output stream + * + * @param s String + * @throws IOException IO异常 + */ + protected void writeString(String s) throws IOException { + for (int i = 0; i < s.length(); i++) { + out.write((byte) s.charAt(i)); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/GifDecoder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/GifDecoder.java new file mode 100755 index 0000000..19a64b3 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/GifDecoder.java @@ -0,0 +1,792 @@ +package aiyh.utils.tool.cn.hutool.core.img.gif; + +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; + +import java.awt.AlphaComposite; +import java.awt.Color; +import java.awt.Dimension; +import java.awt.Graphics2D; +import java.awt.Rectangle; +import java.awt.image.BufferedImage; +import java.awt.image.DataBufferInt; +import java.io.BufferedInputStream; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.net.URL; +import java.util.ArrayList; + +/** + * GIF文件解析 + * Class GifDecoder - Decodes a GIF file into one or more frames. + *

+ * Example: + * + * 

+ * {@code
+ *    GifDecoder d = new GifDecoder();
+ *    d.read("sample.gif");
+ *    int n = d.getFrameCount();
+ *    for (int i = 0; i < n; i++) {
+ *       BufferedImage frame = d.getFrame(i);  // frame i
+ *       int t = d.getDelay(i);  // display duration of frame in milliseconds
+ *       // do something with frame
+ *    }
+ * }
+ *
+ *

+ * 来自：https://github.com/rtyley/animated-gif-lib-for-java + * + * @author Kevin Weiner, FM Software; LZW decoder adapted from John Cristy's ImageMagick. + */ +public class GifDecoder { + + /** + * File read status: No errors. + */ + public static final int STATUS_OK = 0; + + /** + * File read status: Error decoding file (may be partially decoded) + */ + public static final int STATUS_FORMAT_ERROR = 1; + + /** + * File read status: Unable to open source. + */ + public static final int STATUS_OPEN_ERROR = 2; + + protected BufferedInputStream in; + protected int status; + + protected int width; // full image width + protected int height; // full image height + protected boolean gctFlag; // global color table used + protected int gctSize; // size of global color table + protected int loopCount = 1; // iterations; 0 = repeat forever + + protected int[] gct; // global color table + protected int[] lct; // local color table + protected int[] act; // active color table + + protected int bgIndex; // background color index + protected int bgColor; // background color + protected int lastBgColor; // previous bg color + protected int pixelAspect; // pixel aspect ratio + + protected boolean lctFlag; // local color table flag + protected boolean interlace; // interlace flag + protected int lctSize; // local color table size + + protected int ix, iy, iw, ih; // current image rectangle + protected Rectangle lastRect; // last image rect + protected BufferedImage image; // current frame + protected BufferedImage lastImage; // previous frame + + protected byte[] block = new byte[256]; // current data block + protected int blockSize = 0; // block size + + // last graphic control extension info + protected int dispose = 0; + // 0=no action; 1=leave in place; 2=restore to bg; 3=restore to prev + protected int lastDispose = 0; + protected boolean transparency = false; // use transparent color + protected int delay = 0; // delay in milliseconds + protected int transIndex; // transparent color index + + protected static final int MAX_STACK_SIZE = 4096; + // max decoder pixel stack size + + // LZW decoder working arrays + protected short[] prefix; + protected byte[] suffix; + protected byte[] pixelStack; + protected byte[] pixels; + + protected ArrayList frames; // frames read from current file + protected int frameCount; + + static class GifFrame { + public GifFrame(BufferedImage im, int del) { + image = im; + delay = del; + } + + public BufferedImage image; + public int delay; + } + + /** + * Gets display duration for specified frame. + * + * @param n int index of frame + * @return delay in milliseconds + */ + public int getDelay(int n) { + // + delay = -1; + if ((n >= 0) && (n < frameCount)) { + delay = frames.get(n).delay; + } + return delay; + } + + /** + * Gets the number of frames read from file. + * + * @return frame count + */ + public int getFrameCount() { + return frameCount; + } + + /** + * Gets the first (or only) image read. + * + * @return BufferedImage containing first frame, or null if none. + */ + public BufferedImage getImage() { + return getFrame(0); + } + + /** + * Gets the "Netscape" iteration count, if any. + * A count of 0 means repeat indefinitiely. + * + * @return iteration count if one was specified, else 1. + */ + public int getLoopCount() { + return loopCount; + } + + /** + * Creates new frame image from current data (and previous + * frames as specified by their disposition codes). + */ + protected void setPixels() { + // expose destination image's pixels as int array + int[] dest = + ((DataBufferInt) image.getRaster().getDataBuffer()).getData(); + + // fill in starting image contents based on last image's dispose code + if (lastDispose > 0) { + if (lastDispose == 3) { + // use image before last + int n = frameCount - 2; + if (n > 0) { + lastImage = getFrame(n - 1); + } else { + lastImage = null; + } + } + + if (lastImage != null) { + int[] prev = + ((DataBufferInt) lastImage.getRaster().getDataBuffer()).getData(); + System.arraycopy(prev, 0, dest, 0, width * height); + // copy pixels + + if (lastDispose == 2) { + // fill last image rect area with background color + Graphics2D g = image.createGraphics(); + Color c; + if (transparency) { + c = new Color(0, 0, 0, 0); // assume background is transparent + } else { + c = new Color(lastBgColor); // use given background color + } + g.setColor(c); + g.setComposite(AlphaComposite.Src); // replace area + g.fill(lastRect); + g.dispose(); + } + } + } + + // copy each source line to the appropriate place in the destination + int pass = 1; + int inc = 8; + int iline = 0; + for (int i = 0; i < ih; i++) { + int line = i; + if (interlace) { + if (iline >= ih) { + pass++; + switch (pass) { + case 2: + iline = 4; + break; + case 3: + iline = 2; + inc = 4; + break; + case 4: + iline = 1; + inc = 2; + } + } + line = iline; + iline += inc; + } + line += iy; + if (line < height) { + int k = line * width; + int dx = k + ix; // start of line in dest + int dlim = dx + iw; // end of dest line + if ((k + width) < dlim) { + dlim = k + width; // past dest edge + } + int sx = i * iw; // start of line in source + while (dx < dlim) { + // map color and insert in destination + int index = ((int) pixels[sx++]) & 0xff; + int c = act[index]; + if (c != 0) { + dest[dx] = c; + } + dx++; + } + } + } + } + + /** + * Gets the image contents of frame n. + * + * @param n frame + * @return BufferedImage + */ + public BufferedImage getFrame(int n) { + BufferedImage im = null; + if ((n >= 0) && (n < frameCount)) { + im = frames.get(n).image; + } + return im; + } + + /** + * Gets image size. + * + * @return GIF image dimensions + */ + public Dimension getFrameSize() { + return new Dimension(width, height); + } + + /** + * Reads GIF image from stream + * + * @param is BufferedInputStream containing GIF file. + * @return read status code (0 = no errors) + */ + public int read(BufferedInputStream is) { + init(); + if (is != null) { + in = is; + readHeader(); + if (false == err()) { + readContents(); + if (frameCount < 0) { + status = STATUS_FORMAT_ERROR; + } + } + } else { + status = STATUS_OPEN_ERROR; + } + IoUtil.close(is); + return status; + } + + /** + * Reads GIF image from stream + * + * @param is InputStream containing GIF file. + * @return read status code (0 = no errors) + */ + public int read(InputStream is) { + init(); + if (is != null) { + if (!(is instanceof BufferedInputStream)) + is = new BufferedInputStream(is); + in = (BufferedInputStream) is; + readHeader(); + if (!err()) { + readContents(); + if (frameCount < 0) { + status = STATUS_FORMAT_ERROR; + } + } + } else { + status = STATUS_OPEN_ERROR; + } + IoUtil.close(is); + return status; + } + + /** + * Reads GIF file from specified file/URL source + * (URL assumed if name contains ":/" or "file:") + * + * @param name String containing source + * @return read status code (0 = no errors) + */ + public int read(String name) { + status = STATUS_OK; + try { + name = name.trim().toLowerCase(); + if ((name.contains("file:")) || + (name.indexOf(":/") > 0)) { + URL url = new URL(name); + in = new BufferedInputStream(url.openStream()); + } else { + in = new BufferedInputStream(new FileInputStream(name)); + } + status = read(in); + } catch (IOException e) { + status = STATUS_OPEN_ERROR; + } + + return status; + } + + /** + * Decodes LZW image data into pixel array. + * Adapted from John Cristy's ImageMagick. + */ + protected void decodeImageData() { + int NullCode = -1; + int npix = iw * ih; + int available, + clear, + code_mask, + code_size, + end_of_information, + in_code, + old_code, + bits, + code, + count, + i, + datum, + data_size, + first, + top, + bi, + pi; + + if ((pixels == null) || (pixels.length < npix)) { + pixels = new byte[npix]; // allocate new pixel array + } + if (prefix == null) prefix = new short[MAX_STACK_SIZE]; + if (suffix == null) suffix = new byte[MAX_STACK_SIZE]; + if (pixelStack == null) pixelStack = new byte[MAX_STACK_SIZE + 1]; + + // Initialize GIF data stream decoder. + + data_size = read(); + clear = 1 << data_size; + end_of_information = clear + 1; + available = clear + 2; + old_code = NullCode; + code_size = data_size + 1; + code_mask = (1 << code_size) - 1; + for (code = 0; code < clear; code++) { + prefix[code] = 0; + suffix[code] = (byte) code; + } + + // Decode GIF pixel stream. + + datum = bits = count = first = top = pi = bi = 0; + + for (i = 0; i < npix; ) { + if (top == 0) { + if (bits < code_size) { + // Load bytes until there are enough bits for a code. + if (count == 0) { + // Read a new data block. + count = readBlock(); + if (count <= 0) + break; + bi = 0; + } + datum += (((int) block[bi]) & 0xff) << bits; + bits += 8; + bi++; + count--; + continue; + } + + // Get the next code. + + code = datum & code_mask; + datum >>= code_size; + bits -= code_size; + + // Interpret the code + + if ((code > available) || (code == end_of_information)) + break; + if (code == clear) { + // Reset decoder. + code_size = data_size + 1; + code_mask = (1 << code_size) - 1; + available = clear + 2; + old_code = NullCode; + continue; + } + if (old_code == NullCode) { + pixelStack[top++] = suffix[code]; + old_code = code; + first = code; + continue; + } + in_code = code; + if (code == available) { + pixelStack[top++] = (byte) first; + code = old_code; + } + while (code > clear) { + pixelStack[top++] = suffix[code]; + code = prefix[code]; + } + first = ((int) suffix[code]) & 0xff; + + // Add a new string to the string table, + + if (available >= MAX_STACK_SIZE) { + pixelStack[top++] = (byte) first; + continue; + } + pixelStack[top++] = (byte) first; + prefix[available] = (short) old_code; + suffix[available] = (byte) first; + available++; + if (((available & code_mask) == 0) + && (available < MAX_STACK_SIZE)) { + code_size++; + code_mask += available; + } + old_code = in_code; + } + + // Pop a pixel off the pixel stack. + + top--; + pixels[pi++] = pixelStack[top]; + i++; + } + + for (i = pi; i < npix; i++) { + pixels[i] = 0; // clear missing pixels + } + + } + + /** + * Returns true if an error was encountered during reading/decoding + * + * @return true if an error was encountered during reading/decoding + */ + protected boolean err() { + return status != STATUS_OK; + } + + /** + * Initializes or re-initializes reader + */ + protected void init() { + status = STATUS_OK; + frameCount = 0; + frames = new ArrayList<>(); + gct = null; + lct = null; + } + + /** + * Reads a single byte from the input stream. + * + * @return single byte + */ + protected int read() { + int curByte = 0; + try { + curByte = in.read(); + } catch (IOException e) { + status = STATUS_FORMAT_ERROR; + } + return curByte; + } + + /** + * Reads next variable length block from input. + * + * @return number of bytes stored in "buffer" + */ + protected int readBlock() { + blockSize = read(); + int n = 0; + if (blockSize > 0) { + try { + int count; + while (n < blockSize) { + count = in.read(block, n, blockSize - n); + if (count == -1) + break; + n += count; + } + } catch (IOException e) { + //ignore + } + + if (n < blockSize) { + status = STATUS_FORMAT_ERROR; + } + } + return n; + } + + /** + * Reads color table as 256 RGB integer values + * + * @param ncolors int number of colors to read + * @return int array containing 256 colors (packed ARGB with full alpha) + */ + protected int[] readColorTable(int ncolors) { + int nbytes = 3 * ncolors; + int[] tab = null; + byte[] c = new byte[nbytes]; + int n = 0; + try { + n = in.read(c); + } catch (IOException e) { + //ignore + } + if (n < nbytes) { + status = STATUS_FORMAT_ERROR; + } else { + tab = new int[256]; // max size to avoid bounds checks + int i = 0; + int j = 0; + while (i < ncolors) { + int r = ((int) c[j++]) & 0xff; + int g = ((int) c[j++]) & 0xff; + int b = ((int) c[j++]) & 0xff; + tab[i++] = 0xff000000 | (r << 16) | (g << 8) | b; + } + } + return tab; + } + + /** + * Main file parser. Reads GIF content blocks. + */ + protected void readContents() { + // read GIF file content blocks + boolean done = false; + while (!(done || err())) { + int code = read(); + switch (code) { + + case 0x2C: // image separator + readImage(); + break; + + case 0x21: // extension + code = read(); + switch (code) { + case 0xf9: // graphics control extension + readGraphicControlExt(); + break; + + case 0xff: // application extension + readBlock(); + final StringBuilder app = new StringBuilder(); + for (int i = 0; i < 11; i++) { + app.append((char) block[i]); + } + if ("NETSCAPE2.0".equals(app.toString())) { + readNetscapeExt(); + } else { + skip(); // don't care + } + break; + + default: // uninteresting extension + skip(); + } + break; + + case 0x3b: // terminator + done = true; + break; + + case 0x00: // bad byte, but keep going and see what happens + break; + + default: + status = STATUS_FORMAT_ERROR; + } + } + } + + /** + * Reads Graphics Control Extension values + */ + protected void readGraphicControlExt() { + read(); // block size + int packed = read(); // packed fields + dispose = (packed & 0x1c) >> 2; // disposal method + if (dispose == 0) { + dispose = 1; // elect to keep old image if discretionary + } + transparency = (packed & 1) != 0; + delay = readShort() * 10; // delay in milliseconds + transIndex = read(); // transparent color index + read(); // block terminator + } + + /** + * Reads GIF file header information. + */ + protected void readHeader() { + final StringBuilder id = new StringBuilder(); + for (int i = 0; i < 6; i++) { + id.append((char) read()); + } + if (false == id.toString().startsWith("GIF")) { + status = STATUS_FORMAT_ERROR; + return; + } + + readLSD(); + if (gctFlag && !err()) { + gct = readColorTable(gctSize); + bgColor = gct[bgIndex]; + } + } + + /** + * Reads next frame image + */ + protected void readImage() { + ix = readShort(); // (sub)image position & size + iy = readShort(); + iw = readShort(); + ih = readShort(); + + int packed = read(); + lctFlag = (packed & 0x80) != 0; // 1 - local color table flag + interlace = (packed & 0x40) != 0; // 2 - interlace flag + // 3 - sort flag + // 4-5 - reserved + lctSize = 2 << (packed & 7); // 6-8 - local color table size + + if (lctFlag) { + lct = readColorTable(lctSize); // read table + act = lct; // make local table active + } else { + act = gct; // make global table active + if (bgIndex == transIndex) + bgColor = 0; + } + int save = 0; + if (transparency) { + save = act[transIndex]; + act[transIndex] = 0; // set transparent color if specified + } + + if (act == null) { + status = STATUS_FORMAT_ERROR; // no color table defined + } + + if (err()) return; + + decodeImageData(); // decode pixel data + skip(); + + if (err()) return; + + frameCount++; + + // create new image to receive frame data + image = + new BufferedImage(width, height, BufferedImage.TYPE_INT_ARGB_PRE); + + setPixels(); // transfer pixel data to image + + frames.add(new GifFrame(image, delay)); // add image to frame list + + if (transparency) { + act[transIndex] = save; + } + resetFrame(); + + } + + /** + * Reads Logical Screen Descriptor + */ + protected void readLSD() { + + // logical screen size + width = readShort(); + height = readShort(); + + // packed fields + int packed = read(); + gctFlag = (packed & 0x80) != 0; // 1 : global color table flag + // 2-4 : color resolution + // 5 : gct sort flag + gctSize = 2 << (packed & 7); // 6-8 : gct size + + bgIndex = read(); // background color index + pixelAspect = read(); // pixel aspect ratio + } + + /** + * Reads Netscape extenstion to obtain iteration count + */ + protected void readNetscapeExt() { + do { + readBlock(); + if (block[0] == 1) { + // loop count sub-block + int b1 = ((int) block[1]) & 0xff; + int b2 = ((int) block[2]) & 0xff; + loopCount = (b2 << 8) | b1; + } + } while ((blockSize > 0) && !err()); + } + + /** + * Reads next 16-bit value, LSB first + * + * @return next 16-bit value + */ + protected int readShort() { + // read 16-bit value, LSB first + return read() | (read() << 8); + } + + /** + * Resets frame state for reading next image. + */ + protected void resetFrame() { + lastDispose = dispose; + lastRect = new Rectangle(ix, iy, iw, ih); + lastImage = image; + lastBgColor = bgColor; + lct = null; + } + + /** + * Skips variable length blocks up to and including + * next zero length block. + */ + protected void skip() { + do { + readBlock(); + } while ((blockSize > 0) && !err()); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/LZWEncoder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/LZWEncoder.java new file mode 100755 index 0000000..bb7bc98 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/LZWEncoder.java @@ -0,0 +1,305 @@ +package aiyh.utils.tool.cn.hutool.core.img.gif; + +import java.io.IOException; +import java.io.OutputStream; + +//============================================================================== +// Adapted from Jef Poskanzer's Java port by way of J. M. G. Elliott. +// K Weiner 12/00 + +class LZWEncoder { + + private static final int EOF = -1; + + private final int imgW; + private final int imgH; + private final byte[] pixAry; + private final int initCodeSize; + + private int remaining; + private int curPixel; + + // GIFCOMPR.C - GIF Image compression routines + // + // Lempel-Ziv compression based on 'compress'. GIF modifications by + // David Rowley (mgardi@watdcsu.waterloo.edu) + + // General DEFINEs + + static final int BITS = 12; + + static final int HSIZE = 5003; // 80% occupancy + + // GIF Image compression - modified 'compress' + // + // Based on: compress.c - File compression ala IEEE Computer, June 1984. + // + // By Authors: Spencer W. Thomas (decvax!harpo!utah-cs!utah-gr!thomas) + // Jim McKie (decvax!mcvax!jim) + // Steve Davies (decvax!vax135!petsd!peora!srd) + // Ken Turkowski (decvax!decwrl!turtlevax!ken) + // James A. Woods (decvax!ihnp4!ames!jaw) + // Joe Orost (decvax!vax135!petsd!joe) + + int n_bits; // number of bits/code + int maxbits = BITS; // user settable max # bits/code + int maxcode; // maximum code, given n_bits + int maxmaxcode = 1 << BITS; // should NEVER generate this code + + int[] htab = new int[HSIZE]; + int[] codetab = new int[HSIZE]; + + int hsize = HSIZE; // for dynamic table sizing + + int free_ent = 0; // first unused entry + + // block compression parameters -- after all codes are used up, + // and compression rate changes, start over. + boolean clear_flg = false; + + // Algorithm: use open addressing double hashing (no chaining) on the + // prefix code / next character combination. We do a variant of Knuth's + // algorithm D (vol. 3, sec. 6.4) along with G. Knott's relatively-prime + // secondary probe. Here, the modular division first probe is gives way + // to a faster exclusive-or manipulation. Also do block compression with + // an adaptive reset, whereby the code table is cleared when the compression + // ratio decreases, but after the table fills. The variable-length output + // codes are re-sized at this point, and a special CLEAR code is generated + // for the decompressor. Late addition: construct the table according to + // file size for noticeable speed improvement on small files. Please direct + // questions about this implementation to ames!jaw. + + int g_init_bits; + + int ClearCode; + int EOFCode; + + // output + // + // Output the given code. + // Inputs: + // code: A n_bits-bit integer. If == -1, then EOF. This assumes + // that n_bits =< wordsize - 1. + // Outputs: + // Outputs code to the file. + // Assumptions: + // Chars are 8 bits long. + // Algorithm: + // Maintain a BITS character long buffer (so that 8 codes will + // fit in it exactly). Use the VAX insv instruction to insert each + // code in turn. When the buffer fills up empty it and start over. + + int cur_accum = 0; + int cur_bits = 0; + + final int[] masks = + { + 0x0000, + 0x0001, + 0x0003, + 0x0007, + 0x000F, + 0x001F, + 0x003F, + 0x007F, + 0x00FF, + 0x01FF, + 0x03FF, + 0x07FF, + 0x0FFF, + 0x1FFF, + 0x3FFF, + 0x7FFF, + 0xFFFF }; + + // Number of characters so far in this 'packet' + int a_count; + + // Define the storage for the packet accumulator + byte[] accum = new byte[256]; + + //---------------------------------------------------------------------------- + LZWEncoder(int width, int height, byte[] pixels, int color_depth) { + imgW = width; + imgH = height; + pixAry = pixels; + initCodeSize = Math.max(2, color_depth); + } + + // Add a character to the end of the current packet, and if it is 254 + // characters, flush the packet to disk. + void char_out(byte c, OutputStream outs) throws IOException { + accum[a_count++] = c; + if (a_count >= 254) + flush_char(outs); + } + + // Clear out the hash table + + // table clear for block compress + void cl_block(OutputStream outs) throws IOException { + cl_hash(hsize); + free_ent = ClearCode + 2; + clear_flg = true; + + output(ClearCode, outs); + } + + // reset code table + void cl_hash(int hsize) { + for (int i = 0; i < hsize; ++i) + htab[i] = -1; + } + + void compress(int init_bits, OutputStream outs) throws IOException { + int fcode; + int i /* = 0 */; + int c; + int ent; + int disp; + int hsize_reg; + int hshift; + + // Set up the globals: g_init_bits - initial number of bits + g_init_bits = init_bits; + + // Set up the necessary values + clear_flg = false; + n_bits = g_init_bits; + maxcode = MAXCODE(n_bits); + + ClearCode = 1 << (init_bits - 1); + EOFCode = ClearCode + 1; + free_ent = ClearCode + 2; + + a_count = 0; // clear packet + + ent = nextPixel(); + + hshift = 0; + for (fcode = hsize; fcode < 65536; fcode *= 2) + ++hshift; + hshift = 8 - hshift; // set hash code range bound + + hsize_reg = hsize; + cl_hash(hsize_reg); // clear hash table + + output(ClearCode, outs); + + outer_loop : while ((c = nextPixel()) != EOF) { + fcode = (c << maxbits) + ent; + i = (c << hshift) ^ ent; // xor hashing + + if (htab[i] == fcode) { + ent = codetab[i]; + continue; + } else if (htab[i] >= 0) // non-empty slot + { + disp = hsize_reg - i; // secondary hash (after G. Knott) + if (i == 0) + disp = 1; + do { + if ((i -= disp) < 0) + i += hsize_reg; + + if (htab[i] == fcode) { + ent = codetab[i]; + continue outer_loop; + } + } while (htab[i] >= 0); + } + output(ent, outs); + ent = c; + if (free_ent < maxmaxcode) { + codetab[i] = free_ent++; // code -> hashtable + htab[i] = fcode; + } else + cl_block(outs); + } + // Put out the final code. + output(ent, outs); + output(EOFCode, outs); + } + + //---------------------------------------------------------------------------- + void encode(OutputStream os) throws IOException { + os.write(initCodeSize); // write "initial code size" byte + + remaining = imgW * imgH; // reset navigation variables + curPixel = 0; + + compress(initCodeSize + 1, os); // compress and write the pixel data + + os.write(0); // write block terminator + } + + // Flush the packet to disk, and reset the accumulator + void flush_char(OutputStream outs) throws IOException { + if (a_count > 0) { + outs.write(a_count); + outs.write(accum, 0, a_count); + a_count = 0; + } + } + + final int MAXCODE(int n_bits) { + return (1 << n_bits) - 1; + } + + //---------------------------------------------------------------------------- + // Return the next pixel from the image + //---------------------------------------------------------------------------- + private int nextPixel() { + if (remaining == 0) + return EOF; + + --remaining; + + byte pix = pixAry[curPixel++]; + + return pix & 0xff; + } + + void output(int code, OutputStream outs) throws IOException { + cur_accum &= masks[cur_bits]; + + if (cur_bits > 0) + cur_accum |= (code << cur_bits); + else + cur_accum = code; + + cur_bits += n_bits; + + while (cur_bits >= 8) { + char_out((byte) (cur_accum & 0xff), outs); + cur_accum >>= 8; + cur_bits -= 8; + } + + // If the next entry is going to be too big for the code size, + // then increase it, if possible. + if (free_ent > maxcode || clear_flg) { + if (clear_flg) { + maxcode = MAXCODE(n_bits = g_init_bits); + clear_flg = false; + } else { + ++n_bits; + if (n_bits == maxbits) + maxcode = maxmaxcode; + else + maxcode = MAXCODE(n_bits); + } + } + + if (code == EOFCode) { + // At EOF, write the rest of the buffer. + while (cur_bits > 0) { + char_out((byte) (cur_accum & 0xff), outs); + cur_accum >>= 8; + cur_bits -= 8; + } + + flush_char(outs); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/NeuQuant.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/NeuQuant.java new file mode 100755 index 0000000..2ad6ed1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/NeuQuant.java @@ -0,0 +1,460 @@ +package aiyh.utils.tool.cn.hutool.core.img.gif; + +/* NeuQuant Neural-Net Quantization Algorithm + * ------------------------------------------ + * + * Copyright (c) 1994 Anthony Dekker + * + * NEUQUANT Neural-Net quantization algorithm by Anthony Dekker, 1994. + * See "Kohonen neural networks for optimal colour quantization" + * in "Network: Computation in Neural Systems" Vol. 5 (1994) pp 351-367. + * for a discussion of the algorithm. + * + * Any party obtaining a copy of these files from the author, directly or + * indirectly, is granted, free of charge, a full and unrestricted irrevocable, + * world-wide, paid up, royalty-free, nonexclusive right and license to deal + * in this software and documentation files (the "Software"), including without + * limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons who receive + * copies from any such party to do so, with the only requirement being + * that this copyright notice remain intact. + */ + +// Ported to Java 12/00 K Weiner + +/** + * NeuQuant Neural-Net Quantization Algorithm + * + * @author Dekker + */ +public class NeuQuant { + + protected static final int NETSIZE = 256; /* number of colours used */ + + /* four primes near 500 - assume no image has a length so large */ + /* that it is divisible by all four primes */ + protected static final int PRIME1 = 499; + protected static final int PRIME2 = 491; + protected static final int PRIME3 = 487; + protected static final int PRIME4 = 503; + + protected static final int MINPICTUREBYTES = (3 * PRIME4); + /* minimum size for input image */ + + /* Program Skeleton + ---------------- + [select samplefac in range 1..30] + [read image from input file] + pic = (unsigned char*) malloc(3*width*height); + initnet(pic,3*width*height,samplefac); + learn(); + unbiasnet(); + [write output image header, using writecolourmap(f)] + inxbuild(); + write output image using inxsearch(b,g,r) */ + + /* Network Definitions + ------------------- */ + + protected static final int MAXNETPOS = (NETSIZE - 1); + protected static final int NETBIASSHIFT = 4; /* bias for colour values */ + protected static final int NCYCLES = 100; /* no. of learning cycles */ + + /* defs for freq and bias */ + protected static final int INTBIASSHIFT = 16; /* bias for fractions */ + protected static final int INTBIAS = (1 << INTBIASSHIFT); + protected static final int GAMMASHIFT = 10; /* gamma = 1024 */ + protected static final int GAMMA = (1 << GAMMASHIFT); + protected static final int BETASHIFT = 10; + protected static final int BETA = (INTBIAS >> BETASHIFT); /* beta = 1/1024 */ + protected static final int BETAGAMMA = + (INTBIAS << (GAMMASHIFT - BETASHIFT)); + + /* defs for decreasing radius factor */ + protected static final int INITRAD = (NETSIZE >> 3); /* for 256 cols, radius starts */ + protected static final int RADIUSBIASSHIFT = 6; /* at 32.0 biased by 6 bits */ + protected static final int RADIUSBIAS = (1 << RADIUSBIASSHIFT); + protected static final int INITRADIUS = (INITRAD * RADIUSBIAS); /* and decreases by a */ + protected static final int RADIUSDEC = 30; /* factor of 1/30 each cycle */ + + /* defs for decreasing alpha factor */ + protected static final int ALPHABIASSHIFT = 10; /* alpha starts at 1.0 */ + protected static final int INITALPHA = (1 << ALPHABIASSHIFT); + + protected int alphadec; /* biased by 10 bits */ + + /* radbias and alpharadbias used for radpower calculation */ + protected static final int RADBIASSHIFT = 8; + protected static final int RADBIAS = (1 << RADBIASSHIFT); + protected static final int ALPHARADBSHIFT = (ALPHABIASSHIFT + RADBIASSHIFT); + protected static final int ALPHARADBIAS = (1 << ALPHARADBSHIFT); + + /* Types and Global Variables + -------------------------- */ + + protected byte[] thepicture; /* the input image itself */ + protected int lengthcount; /* lengthcount = H*W*3 */ + + protected int samplefac; /* sampling factor 1..30 */ + + // typedef int pixel[4]; /* BGRc */ + protected int[][] network; /* the network itself - [netsize][4] */ + + protected int[] netindex = new int[256]; + /* for network lookup - really 256 */ + + protected int[] bias = new int[NETSIZE]; + /* bias and freq arrays for learning */ + protected int[] freq = new int[NETSIZE]; + protected int[] radpower = new int[INITRAD]; + /* radpower for precomputation */ + + /* Initialise network in range (0,0,0) to (255,255,255) and set parameters + ----------------------------------------------------------------------- */ + public NeuQuant(byte[] thepic, int len, int sample) { + + int i; + int[] p; + + thepicture = thepic; + lengthcount = len; + samplefac = sample; + + network = new int[NETSIZE][]; + for (i = 0; i < NETSIZE; i++) { + network[i] = new int[4]; + p = network[i]; + p[0] = p[1] = p[2] = (i << (NETBIASSHIFT + 8)) / NETSIZE; + freq[i] = INTBIAS / NETSIZE; /* 1/netsize */ + bias[i] = 0; + } + } + + public byte[] colorMap() { + byte[] map = new byte[3 * NETSIZE]; + int[] index = new int[NETSIZE]; + for (int i = 0; i < NETSIZE; i++) + index[network[i][3]] = i; + int k = 0; + for (int i = 0; i < NETSIZE; i++) { + int j = index[i]; + map[k++] = (byte) (network[j][0]); + map[k++] = (byte) (network[j][1]); + map[k++] = (byte) (network[j][2]); + } + return map; + } + + /* Insertion sort of network and building of netindex[0..255] (to do after unbias) + ------------------------------------------------------------------------------- */ + public void inxbuild() { + + int i, j, smallpos, smallval; + int[] p; + int[] q; + int previouscol, startpos; + + previouscol = 0; + startpos = 0; + for (i = 0; i < NETSIZE; i++) { + p = network[i]; + smallpos = i; + smallval = p[1]; /* index on g */ + /* find smallest in i..netsize-1 */ + for (j = i + 1; j < NETSIZE; j++) { + q = network[j]; + if (q[1] < smallval) { /* index on g */ + smallpos = j; + smallval = q[1]; /* index on g */ + } + } + q = network[smallpos]; + /* swap p (i) and q (smallpos) entries */ + if (i != smallpos) { + j = q[0]; + q[0] = p[0]; + p[0] = j; + j = q[1]; + q[1] = p[1]; + p[1] = j; + j = q[2]; + q[2] = p[2]; + p[2] = j; + j = q[3]; + q[3] = p[3]; + p[3] = j; + } + /* smallval entry is now in position i */ + if (smallval != previouscol) { + netindex[previouscol] = (startpos + i) >> 1; + for (j = previouscol + 1; j < smallval; j++) + netindex[j] = i; + previouscol = smallval; + startpos = i; + } + } + netindex[previouscol] = (startpos + MAXNETPOS) >> 1; + for (j = previouscol + 1; j < 256; j++) + netindex[j] = MAXNETPOS; /* really 256 */ + } + + /* Main Learning Loop + ------------------ */ + public void learn() { + + int i, j, b, g, r; + int radius, rad, alpha, step, delta, samplepixels; + byte[] p; + int pix, lim; + + if (lengthcount < MINPICTUREBYTES) + samplefac = 1; + alphadec = 30 + ((samplefac - 1) / 3); + p = thepicture; + pix = 0; + lim = lengthcount; + samplepixels = lengthcount / (3 * samplefac); + delta = samplepixels / NCYCLES; + alpha = INITALPHA; + radius = INITRADIUS; + + rad = radius >> RADIUSBIASSHIFT; + for (i = 0; i < rad; i++) + radpower[i] = + alpha * (((rad * rad - i * i) * RADBIAS) / (rad * rad)); + + //fprintf(stderr,"beginning 1D learning: initial radius=%d\n", rad); + + if (lengthcount < MINPICTUREBYTES) + step = 3; + else if ((lengthcount % PRIME1) != 0) + step = 3 * PRIME1; + else { + if ((lengthcount % PRIME2) != 0) + step = 3 * PRIME2; + else { + if ((lengthcount % PRIME3) != 0) + step = 3 * PRIME3; + else + step = 3 * PRIME4; + } + } + + i = 0; + while (i < samplepixels) { + b = (p[pix] & 0xff) << NETBIASSHIFT; + g = (p[pix + 1] & 0xff) << NETBIASSHIFT; + r = (p[pix + 2] & 0xff) << NETBIASSHIFT; + j = contest(b, g, r); + + altersingle(alpha, j, b, g, r); + if (rad != 0) + alterneigh(rad, j, b, g, r); /* alter neighbours */ + + pix += step; + if (pix >= lim) + pix -= lengthcount; + + i++; + if (delta == 0) + delta = 1; + if (i % delta == 0) { + alpha -= alpha / alphadec; + radius -= radius / RADIUSDEC; + rad = radius >> RADIUSBIASSHIFT; + if (rad <= 1) + rad = 0; + for (j = 0; j < rad; j++) + radpower[j] = + alpha * (((rad * rad - j * j) * RADBIAS) / (rad * rad)); + } + } + //fprintf(stderr,"finished 1D learning: final alpha=%f !\n",((float)alpha)/initalpha); + } + + /* Search for BGR values 0..255 (after net is unbiased) and return colour index + ---------------------------------------------------------------------------- */ + public int map(int b, int g, int r) { + + int i, j, dist, a, bestd; + int[] p; + int best; + + bestd = 1000; /* biggest possible dist is 256*3 */ + best = -1; + i = netindex[g]; /* index on g */ + j = i - 1; /* start at netindex[g] and work outwards */ + + while ((i < NETSIZE) || (j >= 0)) { + if (i < NETSIZE) { + p = network[i]; + dist = p[1] - g; /* inx key */ + if (dist >= bestd) + i = NETSIZE; /* stop iter */ + else { + i++; + if (dist < 0) + dist = -dist; + a = p[0] - b; + if (a < 0) + a = -a; + dist += a; + if (dist < bestd) { + a = p[2] - r; + if (a < 0) + a = -a; + dist += a; + if (dist < bestd) { + bestd = dist; + best = p[3]; + } + } + } + } + if (j >= 0) { + p = network[j]; + dist = g - p[1]; /* inx key - reverse dif */ + if (dist >= bestd) + j = -1; /* stop iter */ + else { + j--; + if (dist < 0) + dist = -dist; + a = p[0] - b; + if (a < 0) + a = -a; + dist += a; + if (dist < bestd) { + a = p[2] - r; + if (a < 0) + a = -a; + dist += a; + if (dist < bestd) { + bestd = dist; + best = p[3]; + } + } + } + } + } + return (best); + } + + public byte[] process() { + learn(); + unbiasnet(); + inxbuild(); + return colorMap(); + } + + /* Unbias network to give byte values 0..255 and record position i to prepare for sort + ----------------------------------------------------------------------------------- */ + public void unbiasnet() { + for (int i = 0; i < NETSIZE; i++) { + network[i][0] >>= NETBIASSHIFT; + network[i][1] >>= NETBIASSHIFT; + network[i][2] >>= NETBIASSHIFT; + network[i][3] = i; /* record colour no */ + } + } + + /* Move adjacent neurons by precomputed alpha*(1-((i-j)^2/[r]^2)) in radpower[|i-j|] + --------------------------------------------------------------------------------- */ + protected void alterneigh(int rad, int i, int b, int g, int r) { + + int j, k, lo, hi, a, m; + int[] p; + + lo = i - rad; + if (lo < -1) + lo = -1; + hi = i + rad; + if (hi > NETSIZE) + hi = NETSIZE; + + j = i + 1; + k = i - 1; + m = 1; + while ((j < hi) || (k > lo)) { + a = radpower[m++]; + if (j < hi) { + p = network[j++]; + try { + p[0] -= (a * (p[0] - b)) / ALPHARADBIAS; + p[1] -= (a * (p[1] - g)) / ALPHARADBIAS; + p[2] -= (a * (p[2] - r)) / ALPHARADBIAS; + } catch (Exception ignored) { + } // prevents 1.3 miscompilation + } + if (k > lo) { + p = network[k--]; + try { + p[0] -= (a * (p[0] - b)) / ALPHARADBIAS; + p[1] -= (a * (p[1] - g)) / ALPHARADBIAS; + p[2] -= (a * (p[2] - r)) / ALPHARADBIAS; + } catch (Exception ignored) { + } + } + } + } + + /* Move neuron i towards biased (b,g,r) by factor alpha + ---------------------------------------------------- */ + protected void altersingle(int alpha, int i, int b, int g, int r) { + + /* alter hit neuron */ + int[] n = network[i]; + n[0] -= (alpha * (n[0] - b)) / INITALPHA; + n[1] -= (alpha * (n[1] - g)) / INITALPHA; + n[2] -= (alpha * (n[2] - r)) / INITALPHA; + } + + /* Search for biased BGR values + ---------------------------- */ + protected int contest(int b, int g, int r) { + + /* finds closest neuron (min dist) and updates freq */ + /* finds best neuron (min dist-bias) and returns position */ + /* for frequently chosen neurons, freq[i] is high and bias[i] is negative */ + /* bias[i] = gamma*((1/netsize)-freq[i]) */ + + int i, dist, a, biasdist, betafreq; + int bestpos, bestbiaspos, bestd, bestbiasd; + int[] n; + + bestd = ~(1 << 31); + bestbiasd = bestd; + bestpos = -1; + bestbiaspos = bestpos; + + for (i = 0; i < NETSIZE; i++) { + n = network[i]; + dist = n[0] - b; + if (dist < 0) + dist = -dist; + a = n[1] - g; + if (a < 0) + a = -a; + dist += a; + a = n[2] - r; + if (a < 0) + a = -a; + dist += a; + if (dist < bestd) { + bestd = dist; + bestpos = i; + } + biasdist = dist - ((bias[i]) >> (INTBIASSHIFT - NETBIASSHIFT)); + if (biasdist < bestbiasd) { + bestbiasd = biasdist; + bestbiaspos = i; + } + betafreq = (freq[i] >> BETASHIFT); + freq[i] -= betafreq; + bias[i] += (betafreq << GAMMASHIFT); + } + freq[bestpos] += BETA; + bias[bestpos] -= BETAGAMMA; + return (bestbiaspos); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/package-info.java new file mode 100755 index 0000000..c0c3689 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/gif/package-info.java @@ -0,0 +1,7 @@ +/** + * GIF处理，来自：https://github.com/rtyley/animated-gif-lib-for-java + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.img.gif; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/img/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/package-info.java new file mode 100755 index 0000000..c150a37 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/img/package-info.java @@ -0,0 +1,7 @@ +/** + * 图像处理相关工具类封装 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.img; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/AppendableWriter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/AppendableWriter.java new file mode 100644 index 0000000..6bc1078 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/AppendableWriter.java @@ -0,0 +1,106 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import java.io.Closeable; +import java.io.Flushable; +import java.io.IOException; +import java.io.Writer; +import java.nio.CharBuffer; + +/** + * 同时继承{@link Writer}和实现{@link Appendable}的聚合类，用于适配两种接口操作 + * 实现来自：jodd + * + * @author looly，jodd + * @since 5.7.0 + */ +public class AppendableWriter extends Writer implements Appendable { + + private final Appendable appendable; + private final boolean flushable; + private boolean closed; + + public AppendableWriter(final Appendable appendable) { + this.appendable = appendable; + this.flushable = appendable instanceof Flushable; + this.closed = false; + } + + @Override + public void write(final char[] cbuf, final int off, final int len) throws IOException { + checkNotClosed(); + appendable.append(CharBuffer.wrap(cbuf), off, off + len); + } + + @Override + public void write(final int c) throws IOException { + checkNotClosed(); + appendable.append((char) c); + } + + @Override + public Writer append(final char c) throws IOException { + checkNotClosed(); + appendable.append(c); + return this; + } + + @Override + public Writer append(final CharSequence csq, final int start, final int end) throws IOException { + checkNotClosed(); + appendable.append(csq, start, end); + return this; + } + + @Override + public Writer append(final CharSequence csq) throws IOException { + checkNotClosed(); + appendable.append(csq); + return this; + } + + @Override + public void write(final String str, final int off, final int len) throws IOException { + checkNotClosed(); + appendable.append(str, off, off + len); + } + + @Override + public void write(final String str) throws IOException { + appendable.append(str); + } + + @Override + public void write(final char[] cbuf) throws IOException { + appendable.append(CharBuffer.wrap(cbuf)); + } + + @Override + public void flush() throws IOException { + checkNotClosed(); + if (flushable) { + ((Flushable) appendable).flush(); + } + } + + /** + * 检查Writer是否已经被关闭 + * + * @throws IOException IO异常 + */ + private void checkNotClosed() throws IOException { + if (closed) { + throw new IOException("Writer is closed!" + this); + } + } + + @Override + public void close() throws IOException { + if (false == closed) { + flush(); + if (appendable instanceof Closeable) { + ((Closeable) appendable).close(); + } + closed = true; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/BOMInputStream.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/BOMInputStream.java new file mode 100644 index 0000000..12ee409 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/BOMInputStream.java @@ -0,0 +1,140 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; + +import java.io.IOException; +import java.io.InputStream; +import java.io.PushbackInputStream; + +/** + * 读取带BOM头的流内容，{@code getCharset()}方法调用后会得到BOM头的编码，且会去除BOM头
+ * BOM定义：http://www.unicode.org/unicode/faq/utf_bom.html
+ *

    + *
  • 00 00 FE FF = UTF-32, big-endian
    • + *
  • FF FE 00 00 = UTF-32, little-endian
    • + *
  • EF BB BF = UTF-8
    • + *
  • FE FF = UTF-16, big-endian
    • + *
  • FF FE = UTF-16, little-endian
    • + *
+ * 使用：
+ * + * String enc = "UTF-8"; // or NULL to use systemdefault
+ * FileInputStream fis = new FileInputStream(file);
+ * BOMInputStream uin = new BOMInputStream(fis, enc);
+ * enc = uin.getCharset(); // check and skip possible BOM bytes + * + *

+ * 参考： http://akini.mbnet.fi/java/unicodereader/UnicodeInputStream.java.txt + * + * @author looly + */ +public class BOMInputStream extends InputStream { + + private final PushbackInputStream in; + private boolean isInited = false; + private final String defaultCharset; + private String charset; + + private static final int BOM_SIZE = 4; + + // ----------------------------------------------------------------- Constructor start + + /** + * 构造 + * @param in 流 + */ + public BOMInputStream(InputStream in) { + this(in, CharsetUtil.UTF_8); + } + + /** + * 构造 + * + * @param in 流 + * @param defaultCharset 默认编码 + */ + public BOMInputStream(InputStream in, String defaultCharset) { + this.in = new PushbackInputStream(in, BOM_SIZE); + this.defaultCharset = defaultCharset; + } + // ----------------------------------------------------------------- Constructor end + + /** + * 获取默认编码 + * + * @return 默认编码 + */ + public String getDefaultCharset() { + return defaultCharset; + } + + /** + * 获取BOM头中的编码 + * + * @return 编码 + */ + public String getCharset() { + if (false == isInited) { + try { + init(); + } catch (IOException ex) { + throw new IORuntimeException(ex); + } + } + return charset; + } + + @Override + public void close() throws IOException { + isInited = true; + in.close(); + } + + @Override + public int read() throws IOException { + isInited = true; + return in.read(); + } + + /** + * Read-ahead four bytes and check for BOM marks.
+ * Extra bytes are unread back to the stream, only BOM bytes are skipped. + * @throws IOException 读取引起的异常 + */ + protected void init() throws IOException { + if (isInited) { + return; + } + + byte[] bom = new byte[BOM_SIZE]; + int n, unread; + n = in.read(bom, 0, bom.length); + + if ((bom[0] == (byte) 0x00) && (bom[1] == (byte) 0x00) && (bom[2] == (byte) 0xFE) && (bom[3] == (byte) 0xFF)) { + charset = "UTF-32BE"; + unread = n - 4; + } else if ((bom[0] == (byte) 0xFF) && (bom[1] == (byte) 0xFE) && (bom[2] == (byte) 0x00) && (bom[3] == (byte) 0x00)) { + charset = "UTF-32LE"; + unread = n - 4; + } else if ((bom[0] == (byte) 0xEF) && (bom[1] == (byte) 0xBB) && (bom[2] == (byte) 0xBF)) { + charset = "UTF-8"; + unread = n - 3; + } else if ((bom[0] == (byte) 0xFE) && (bom[1] == (byte) 0xFF)) { + charset = "UTF-16BE"; + unread = n - 2; + } else if ((bom[0] == (byte) 0xFF) && (bom[1] == (byte) 0xFE)) { + charset = "UTF-16LE"; + unread = n - 2; + } else { + // Unicode BOM mark not found, unread all bytes + charset = defaultCharset; + unread = n; + } + + if (unread > 0) { + in.unread(bom, (n - unread), unread); + } + + isInited = true; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/BomReader.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/BomReader.java new file mode 100644 index 0000000..a2cdf13 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/BomReader.java @@ -0,0 +1,58 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.Reader; +import java.io.UnsupportedEncodingException; + +/** + * 读取带BOM头的流内容的Reader，如果非bom的流或无法识别的编码，则默认UTF-8
+ * BOM定义：http://www.unicode.org/unicode/faq/utf_bom.html + * + *
    + *
  • 00 00 FE FF = UTF-32, big-endian
    • + *
  • FF FE 00 00 = UTF-32, little-endian
    • + *
  • EF BB BF = UTF-8
    • + *
  • FE FF = UTF-16, big-endian
    • + *
  • FF FE = UTF-16, little-endian
    • + *
+ * 使用：
+ * + * FileInputStream fis = new FileInputStream(file);
+ * BomReader uin = new BomReader(fis);
+ * + * + * @author looly + * @since 5.7.14 + */ +public class BomReader extends Reader { + + private InputStreamReader reader; + + /** + * 构造 + * + * @param in 流 + */ + public BomReader(InputStream in) { + Assert.notNull(in, "InputStream must be not null!"); + final BOMInputStream bin = (in instanceof BOMInputStream) ? (BOMInputStream) in : new BOMInputStream(in); + try { + this.reader = new InputStreamReader(bin, bin.getCharset()); + } catch (UnsupportedEncodingException ignore) { + } + } + + @Override + public int read(char[] cbuf, int off, int len) throws IOException { + return reader.read(cbuf, off, len); + } + + @Override + public void close() throws IOException { + reader.close(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/BufferUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/BufferUtil.java new file mode 100644 index 0000000..39fc428 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/BufferUtil.java @@ -0,0 +1,262 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.nio.ByteBuffer; +import java.nio.CharBuffer; +import java.nio.charset.Charset; + +/** + * {@link ByteBuffer} 工具类
+ * 此工具来自于 t-io 项目以及其它项目的相关部分收集
+ * ByteBuffer的相关介绍见：https://www.cnblogs.com/ruber/p/6857159.html + * + * @author tanyaowu, looly + * @since 4.0.0 + */ +public class BufferUtil { + + /** + * 拷贝到一个新的ByteBuffer + * + * @param src 源ByteBuffer + * @param start 起始位置（包括） + * @param end 结束位置（不包括） + * @return 新的ByteBuffer + */ + public static ByteBuffer copy(ByteBuffer src, int start, int end) { + return copy(src, ByteBuffer.allocate(end - start)); + } + + /** + * 拷贝ByteBuffer + * + * @param src 源ByteBuffer + * @param dest 目标ByteBuffer + * @return 目标ByteBuffer + */ + public static ByteBuffer copy(ByteBuffer src, ByteBuffer dest) { + return copy(src, dest, Math.min(src.limit(), dest.remaining())); + } + + /** + * 拷贝ByteBuffer + * + * @param src 源ByteBuffer + * @param dest 目标ByteBuffer + * @param length 长度 + * @return 目标ByteBuffer + */ + public static ByteBuffer copy(ByteBuffer src, ByteBuffer dest, int length) { + return copy(src, src.position(), dest, dest.position(), length); + } + + /** + * 拷贝ByteBuffer + * + * @param src 源ByteBuffer + * @param srcStart 源开始的位置 + * @param dest 目标ByteBuffer + * @param destStart 目标开始的位置 + * @param length 长度 + * @return 目标ByteBuffer + */ + public static ByteBuffer copy(ByteBuffer src, int srcStart, ByteBuffer dest, int destStart, int length) { + System.arraycopy(src.array(), srcStart, dest.array(), destStart, length); + return dest; + } + + /** + * 读取剩余部分并转为UTF-8编码字符串 + * + * @param buffer ByteBuffer + * @return 字符串 + * @since 4.5.0 + */ + public static String readUtf8Str(ByteBuffer buffer) { + return readStr(buffer, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 读取剩余部分并转为字符串 + * + * @param buffer ByteBuffer + * @param charset 编码 + * @return 字符串 + * @since 4.5.0 + */ + public static String readStr(ByteBuffer buffer, Charset charset) { + return StrUtil.str(readBytes(buffer), charset); + } + + /** + * 读取剩余部分bytes
+ * + * @param buffer ByteBuffer + * @return bytes + */ + public static byte[] readBytes(ByteBuffer buffer) { + final int remaining = buffer.remaining(); + byte[] ab = new byte[remaining]; + buffer.get(ab); + return ab; + } + + /** + * 读取指定长度的bytes
+ * 如果长度不足，则读取剩余部分，此时buffer必须为读模式 + * + * @param buffer ByteBuffer + * @param maxLength 最大长度 + * @return bytes + */ + public static byte[] readBytes(ByteBuffer buffer, int maxLength) { + final int remaining = buffer.remaining(); + if (maxLength > remaining) { + maxLength = remaining; + } + byte[] ab = new byte[maxLength]; + buffer.get(ab); + return ab; + } + + /** + * 读取指定区间的数据 + * + * @param buffer {@link ByteBuffer} + * @param start 开始位置 + * @param end 结束位置 + * @return bytes + */ + public static byte[] readBytes(ByteBuffer buffer, int start, int end) { + byte[] bs = new byte[end - start]; + System.arraycopy(buffer.array(), start, bs, 0, bs.length); + return bs; + } + + /** + * 一行的末尾位置，查找位置时位移ByteBuffer到结束位置 + * + * @param buffer {@link ByteBuffer} + * @return 末尾位置，未找到或达到最大长度返回-1 + */ + public static int lineEnd(ByteBuffer buffer) { + return lineEnd(buffer, buffer.remaining()); + } + + /** + * 一行的末尾位置，查找位置时位移ByteBuffer到结束位置
+ * 支持的换行符如下： + * + * 
+	 * 1. \r\n
+	 * 2. \n
+	 *
+ * + * @param buffer {@link ByteBuffer} + * @param maxLength 读取最大长度 + * @return 末尾位置，未找到或达到最大长度返回-1 + */ + public static int lineEnd(ByteBuffer buffer, int maxLength) { + int primitivePosition = buffer.position(); + boolean canEnd = false; + int charIndex = primitivePosition; + byte b; + while (buffer.hasRemaining()) { + b = buffer.get(); + charIndex++; + if (b == StrUtil.C_CR) { + canEnd = true; + } else if (b == StrUtil.C_LF) { + return canEnd ? charIndex - 2 : charIndex - 1; + } else { + // 只有\r无法确认换行 + canEnd = false; + } + + if (charIndex - primitivePosition > maxLength) { + // 查找到尽头，未找到，还原位置 + buffer.position(primitivePosition); + throw new IndexOutOfBoundsException(StrUtil.format("Position is out of maxLength: {}", maxLength)); + } + } + + // 查找到buffer尽头，未找到，还原位置 + buffer.position(primitivePosition); + // 读到结束位置 + return -1; + } + + /** + * 读取一行，如果buffer中最后一部分并非完整一行，则返回null
+ * 支持的换行符如下： + * + * 
+	 * 1. \r\n
+	 * 2. \n
+	 *
+ * + * @param buffer ByteBuffer + * @param charset 编码 + * @return 一行 + */ + public static String readLine(ByteBuffer buffer, Charset charset) { + final int startPosition = buffer.position(); + final int endPosition = lineEnd(buffer); + + if (endPosition > startPosition) { + byte[] bs = readBytes(buffer, startPosition, endPosition); + return StrUtil.str(bs, charset); + } else if (endPosition == startPosition) { + return StrUtil.EMPTY; + } + + return null; + } + + /** + * 创建新Buffer + * + * @param data 数据 + * @return {@link ByteBuffer} + * @since 4.5.0 + */ + public static ByteBuffer create(byte[] data) { + return ByteBuffer.wrap(data); + } + + /** + * 从字符串创建新Buffer + * + * @param data 数据 + * @param charset 编码 + * @return {@link ByteBuffer} + * @since 4.5.0 + */ + public static ByteBuffer create(CharSequence data, Charset charset) { + return create(StrUtil.bytes(data, charset)); + } + + /** + * 从字符串创建新Buffer，使用UTF-8编码 + * + * @param data 数据 + * @return {@link ByteBuffer} + * @since 4.5.0 + */ + public static ByteBuffer createUtf8(CharSequence data) { + return create(StrUtil.utf8Bytes(data)); + } + + /** + * 创建{@link CharBuffer} + * + * @param capacity 容量 + * @return {@link CharBuffer} + * @since 5.5.7 + */ + public static CharBuffer createCharBuffer(int capacity) { + return CharBuffer.allocate(capacity); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/CharsetDetector.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/CharsetDetector.java new file mode 100644 index 0000000..6e792ca --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/CharsetDetector.java @@ -0,0 +1,114 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.nio.ByteBuffer; +import java.nio.charset.CharacterCodingException; +import java.nio.charset.Charset; +import java.nio.charset.CharsetDecoder; + +/** + * 编码探测器 + * + * @author looly + * @since 5.4.7 + */ +public class CharsetDetector { + + /** + * 默认的参与测试的编码 + */ + private static final Charset[] DEFAULT_CHARSETS; + + static { + String[] names = { + "UTF-8", + "GBK", + "GB2312", + "GB18030", + "UTF-16BE", + "UTF-16LE", + "UTF-16", + "BIG5", + "UNICODE", + "US-ASCII"}; + DEFAULT_CHARSETS = Convert.convert(Charset[].class, names); + } + + /** + * 探测文件编码 + * + * @param file 文件 + * @param charsets 需要测试用的编码，null或空使用默认的编码数组 + * @return 编码 + * @since 5.6.7 + */ + public static Charset detect(File file, Charset... charsets) { + return detect(FileUtil.getInputStream(file), charsets); + } + + /** + * 探测编码
+ * 注意：此方法会读取流的一部分，然后关闭流，如重复使用流，请使用支持reset方法的流 + * + * @param in 流，使用后关闭此流 + * @param charsets 需要测试用的编码，null或空使用默认的编码数组 + * @return 编码 + */ + public static Charset detect(InputStream in, Charset... charsets) { + return detect(IoUtil.DEFAULT_LARGE_BUFFER_SIZE, in, charsets); + } + + /** + * 探测编码
+ * 注意：此方法会读取流的一部分，然后关闭流，如重复使用流，请使用支持reset方法的流 + * + * @param bufferSize 自定义缓存大小，即每次检查的长度 + * @param in 流，使用后关闭此流 + * @param charsets 需要测试用的编码，null或空使用默认的编码数组 + * @return 编码 + * @since 5.7.10 + */ + public static Charset detect(int bufferSize, InputStream in, Charset... charsets) { + if (ArrayUtil.isEmpty(charsets)) { + charsets = DEFAULT_CHARSETS; + } + + final byte[] buffer = new byte[bufferSize]; + try { + while (in.read(buffer) > -1) { + for (Charset charset : charsets) { + final CharsetDecoder decoder = charset.newDecoder(); + if (identify(buffer, decoder)) { + return charset; + } + } + } + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + IoUtil.close(in); + } + return null; + } + + /** + * 通过try的方式测试指定bytes是否可以被解码，从而判断是否为指定编码 + * + * @param bytes 测试的bytes + * @param decoder 解码器 + * @return 是否是指定编码 + */ + private static boolean identify(byte[] bytes, CharsetDecoder decoder) { + try { + decoder.decode(ByteBuffer.wrap(bytes)); + } catch (CharacterCodingException e) { + return false; + } + return true; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FastByteArrayOutputStream.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FastByteArrayOutputStream.java new file mode 100644 index 0000000..5bdc08b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FastByteArrayOutputStream.java @@ -0,0 +1,123 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.io.IOException; +import java.io.OutputStream; +import java.nio.charset.Charset; + +/** + * 基于快速缓冲FastByteBuffer的OutputStream，随着数据的增长自动扩充缓冲区 + *

+ * 可以通过{@link #toByteArray()}和 {@link #toString()}来获取数据 + *

+ * {@link #close()}方法无任何效果，当流被关闭后不会抛出IOException + *

+ * 这种设计避免重新分配内存块而是分配新增的缓冲区，缓冲区不会被GC，数据也不会被拷贝到其他缓冲区。 + * + * @author biezhi + */ +public class FastByteArrayOutputStream extends OutputStream { + + private final FastByteBuffer buffer; + + /** + * 构造 + */ + public FastByteArrayOutputStream() { + this(1024); + } + + /** + * 构造 + * + * @param size 预估大小 + */ + public FastByteArrayOutputStream(int size) { + buffer = new FastByteBuffer(size); + } + + @Override + public void write(byte[] b, int off, int len) { + buffer.append(b, off, len); + } + + @Override + public void write(int b) { + buffer.append((byte) b); + } + + public int size() { + return buffer.size(); + } + + /** + * 此方法无任何效果，当流被关闭后不会抛出IOException + */ + @Override + public void close() { + // nop + } + + public void reset() { + buffer.reset(); + } + + /** + * 写出 + * @param out 输出流 + * @throws IORuntimeException IO异常 + */ + public void writeTo(OutputStream out) throws IORuntimeException { + final int index = buffer.index(); + if(index < 0){ + // 无数据写出 + return; + } + byte[] buf; + try { + for (int i = 0; i < index; i++) { + buf = buffer.array(i); + out.write(buf); + } + out.write(buffer.array(index), 0, buffer.offset()); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + + /** + * 转为Byte数组 + * @return Byte数组 + */ + public byte[] toByteArray() { + return buffer.toArray(); + } + + @Override + public String toString() { + return toString(CharsetUtil.defaultCharset()); + } + + /** + * 转为字符串 + * @param charsetName 编码 + * @return 字符串 + */ + public String toString(String charsetName) { + return toString(CharsetUtil.charset(charsetName)); + } + + /** + * 转为字符串 + * @param charset 编码,null表示默认编码 + * @return 字符串 + */ + public String toString(Charset charset) { + return new String(toByteArray(), + ObjectUtil.defaultIfNull(charset, CharsetUtil.defaultCharset())); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FastByteBuffer.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FastByteBuffer.java new file mode 100644 index 0000000..8f13502 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FastByteBuffer.java @@ -0,0 +1,288 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +/** + * 代码移植自blade
+ * 快速缓冲，将数据存放在缓冲集中，取代以往的单一数组 + * + * @author biezhi, looly + * @since 1.0 + */ +public class FastByteBuffer { + + /** + * 缓冲集 + */ + private byte[][] buffers = new byte[16][]; + /** + * 缓冲数 + */ + private int buffersCount; + /** + * 当前缓冲索引 + */ + private int currentBufferIndex = -1; + /** + * 当前缓冲 + */ + private byte[] currentBuffer; + /** + * 当前缓冲偏移量 + */ + private int offset; + /** + * 缓冲字节数 + */ + private int size; + + /** + * 一个缓冲区的最小字节数 + */ + private final int minChunkLen; + + public FastByteBuffer() { + this(1024); + } + + public FastByteBuffer(int size) { + if(size <= 0){ + size = 1024; + } + this.minChunkLen = Math.abs(size); + } + + /** + * 分配下一个缓冲区，不会小于1024 + * + * @param newSize 理想缓冲区字节数 + */ + private void needNewBuffer(int newSize) { + int delta = newSize - size; + int newBufferSize = Math.max(minChunkLen, delta); + + currentBufferIndex++; + currentBuffer = new byte[newBufferSize]; + offset = 0; + + // add buffer + if (currentBufferIndex >= buffers.length) { + int newLen = buffers.length << 1; + byte[][] newBuffers = new byte[newLen][]; + System.arraycopy(buffers, 0, newBuffers, 0, buffers.length); + buffers = newBuffers; + } + buffers[currentBufferIndex] = currentBuffer; + buffersCount++; + } + + /** + * 向快速缓冲加入数据 + * + * @param array 数据 + * @param off 偏移量 + * @param len 字节数 + * @return 快速缓冲自身 @see FastByteBuffer + */ + public FastByteBuffer append(byte[] array, int off, int len) { + int end = off + len; + if ((off < 0) || (len < 0) || (end > array.length)) { + throw new IndexOutOfBoundsException(); + } + if (len == 0) { + return this; + } + int newSize = size + len; + int remaining = len; + + if (currentBuffer != null) { + // first try to fill current buffer + int part = Math.min(remaining, currentBuffer.length - offset); + System.arraycopy(array, end - remaining, currentBuffer, offset, part); + remaining -= part; + offset += part; + size += part; + } + + if (remaining > 0) { + // still some data left + // ask for new buffer + needNewBuffer(newSize); + + // then copy remaining + // but this time we are sure that it will fit + int part = Math.min(remaining, currentBuffer.length - offset); + System.arraycopy(array, end - remaining, currentBuffer, offset, part); + offset += part; + size += part; + } + + return this; + } + + /** + * 向快速缓冲加入数据 + * + * @param array 数据 + * + * @return 快速缓冲自身 @see FastByteBuffer + */ + public FastByteBuffer append(byte[] array) { + return append(array, 0, array.length); + } + + /** + * 向快速缓冲加入一个字节 + * + * @param element 一个字节的数据 + * @return 快速缓冲自身 @see FastByteBuffer + */ + public FastByteBuffer append(byte element) { + if ((currentBuffer == null) || (offset == currentBuffer.length)) { + needNewBuffer(size + 1); + } + + currentBuffer[offset] = element; + offset++; + size++; + + return this; + } + + /** + * 将另一个快速缓冲加入到自身 + * + * @param buff 快速缓冲 + * @return 快速缓冲自身 @see FastByteBuffer + */ + public FastByteBuffer append(FastByteBuffer buff) { + if (buff.size == 0) { + return this; + } + for (int i = 0; i < buff.currentBufferIndex; i++) { + append(buff.buffers[i]); + } + append(buff.currentBuffer, 0, buff.offset); + return this; + } + + public int size() { + return size; + } + + public boolean isEmpty() { + return size == 0; + } + + /** + * 当前缓冲位于缓冲区的索引位 + * + * @return {@link #currentBufferIndex} + */ + public int index() { + return currentBufferIndex; + } + + public int offset() { + return offset; + } + + /** + * 根据索引位返回缓冲集中的缓冲 + * + * @param index 索引位 + * @return 缓冲 + */ + public byte[] array(int index) { + return buffers[index]; + } + + public void reset() { + size = 0; + offset = 0; + currentBufferIndex = -1; + currentBuffer = null; + buffersCount = 0; + } + + /** + * 返回快速缓冲中的数据 + * + * @return 快速缓冲中的数据 + */ + public byte[] toArray() { + int pos = 0; + byte[] array = new byte[size]; + + if (currentBufferIndex == -1) { + return array; + } + + for (int i = 0; i < currentBufferIndex; i++) { + int len = buffers[i].length; + System.arraycopy(buffers[i], 0, array, pos, len); + pos += len; + } + + System.arraycopy(buffers[currentBufferIndex], 0, array, pos, offset); + + return array; + } + + /** + * 返回快速缓冲中的数据 + * + * @param start 逻辑起始位置 + * @param len 逻辑字节长 + * @return 快速缓冲中的数据 + */ + public byte[] toArray(int start, int len) { + int remaining = len; + int pos = 0; + byte[] array = new byte[len]; + + if (len == 0) { + return array; + } + + int i = 0; + while (start >= buffers[i].length) { + start -= buffers[i].length; + i++; + } + + while (i < buffersCount) { + byte[] buf = buffers[i]; + int c = Math.min(buf.length - start, remaining); + System.arraycopy(buf, start, array, pos, c); + pos += c; + remaining -= c; + if (remaining == 0) { + break; + } + start = 0; + i++; + } + return array; + } + + /** + * 根据索引位返回一个字节 + * + * @param index 索引位 + * @return 一个字节 + */ + public byte get(int index) { + if ((index >= size) || (index < 0)) { + throw new IndexOutOfBoundsException(); + } + int ndx = 0; + while (true) { + byte[] b = buffers[ndx]; + if (index < b.length) { + return b[index]; + } + ndx++; + index -= b.length; + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FastStringWriter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FastStringWriter.java new file mode 100644 index 0000000..7368f9c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FastStringWriter.java @@ -0,0 +1,90 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.text.StrBuilder; + +import java.io.Writer; + +/** + * 借助{@link StrBuilder} 提供快读的字符串写出，相比jdk的StringWriter非线程安全，速度更快。 + * + * @author looly + * @since 5.3.3 + */ +public final class FastStringWriter extends Writer { + + private final StrBuilder builder; + + /** + * 构造 + */ + public FastStringWriter() { + this(StrBuilder.DEFAULT_CAPACITY); + } + + /** + * 构造 + * + * @param initialSize 初始容量 + */ + public FastStringWriter(int initialSize) { + if (initialSize < 0) { + initialSize = StrBuilder.DEFAULT_CAPACITY; + } + this.builder = new StrBuilder(initialSize); + } + + + @Override + public void write(final int c) { + this.builder.append((char) c); + } + + + @Override + public void write(final String str) { + this.builder.append(str); + } + + + @Override + public void write(final String str, final int off, final int len) { + this.builder.append(str, off, off + len); + } + + + @Override + public void write(final char[] cbuf) { + this.builder.append(cbuf, 0, cbuf.length); + } + + + @Override + public void write(final char[] cbuf, final int off, final int len) { + if ((off < 0) || (off > cbuf.length) || (len < 0) || + ((off + len) > cbuf.length) || ((off + len) < 0)) { + throw new IndexOutOfBoundsException(); + } else if (len == 0) { + return; + } + this.builder.append(cbuf, off, len); + } + + + @Override + public void flush() { + // Nothing to be flushed + } + + + @Override + public void close() { + // Nothing to be closed + } + + + @Override + public String toString() { + return this.builder.toString(); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FileMagicNumber.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FileMagicNumber.java new file mode 100644 index 0000000..62a969e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FileMagicNumber.java @@ -0,0 +1,1243 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; + +import java.math.BigInteger; +import java.util.Arrays; +import java.util.Objects; + +/** + * 文件类型魔数封装 + * + * @author CherryRum + * @since 5.8.12 + */ +public enum FileMagicNumber { + UNKNOWN(null, null) { + @Override + public boolean match(final byte[] bytes) { + return false; + } + }, + //image start--------------------------------------------- + JPEG("image/jpeg", "jpg") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 2 + && Objects.equals(bytes[0], (byte) 0xff) + && Objects.equals(bytes[1], (byte) 0xd8) + && Objects.equals(bytes[2], (byte) 0xff); + } + }, + JXR("image/vnd.ms-photo", "jxr") { + @Override + public boolean match(final byte[] bytes) { + //file magic number https://www.iana.org/assignments/media-types/image/jxr + return bytes.length > 2 + && Objects.equals(bytes[0], (byte) 0x49) + && Objects.equals(bytes[1], (byte) 0x49) + && Objects.equals(bytes[2], (byte) 0xbc); + } + }, + APNG("image/apng", "apng") { + @Override + public boolean match(final byte[] bytes) { + final boolean b = bytes.length > 8 + && Objects.equals(bytes[0], (byte) 0x89) + && Objects.equals(bytes[1], (byte) 0x50) + && Objects.equals(bytes[2], (byte) 0x4e) + && Objects.equals(bytes[3], (byte) 0x47) + && Objects.equals(bytes[4], (byte) 0x0d) + && Objects.equals(bytes[5], (byte) 0x0a) + && Objects.equals(bytes[6], (byte) 0x1a) + && Objects.equals(bytes[7], (byte) 0x0a); + + if (b) { + int i = 8; + while (i < bytes.length) { + try { + final int dataLength = new BigInteger(1, Arrays.copyOfRange(bytes, i, i + 4)).intValue(); + i += 4; + final byte[] bytes1 = Arrays.copyOfRange(bytes, i, i + 4); + final String chunkType = new String(bytes1); + i += 4; + if (Objects.equals(chunkType, "IDAT") || Objects.equals(chunkType, "IEND")) { + return false; + } else if (Objects.equals(chunkType, "acTL")) { + return true; + } + i += dataLength + 4; + } catch (final Exception e) { + return false; + } + } + } + return false; + } + }, + PNG("image/png", "png") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 3 + && Objects.equals(bytes[0], (byte) 0x89) + && Objects.equals(bytes[1], (byte) 0x50) + && Objects.equals(bytes[2], (byte) 0x4e) + && Objects.equals(bytes[3], (byte) 0x47); + } + }, + GIF("image/gif", "gif") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 2 + && Objects.equals(bytes[0], (byte) 0x47) + && Objects.equals(bytes[1], (byte) 0x49) + && Objects.equals(bytes[2], (byte) 0x46); + } + }, + BMP("image/bmp", "bmp") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 1 + && Objects.equals(bytes[0], (byte) 0x42) + && Objects.equals(bytes[1], (byte) 0x4d); + } + }, + TIFF("image/tiff", "tiff") { + @Override + public boolean match(final byte[] bytes) { + if (bytes.length < 4) { + return false; + } + final boolean flag1 = Objects.equals(bytes[0], (byte) 0x49) + && Objects.equals(bytes[1], (byte) 0x49) + && Objects.equals(bytes[2], (byte) 0x2a) + && Objects.equals(bytes[3], (byte) 0x00); + final boolean flag2 = (Objects.equals(bytes[0], (byte) 0x4d) + && Objects.equals(bytes[1], (byte) 0x4d) + && Objects.equals(bytes[2], (byte) 0x00) + && Objects.equals(bytes[3], (byte) 0x2a)); + return flag1 || flag2; + + } + }, + + DWG("image/vnd.dwg", "dwg") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 10 + && Objects.equals(bytes[0], (byte) 0x41) + && Objects.equals(bytes[1], (byte) 0x43) + && Objects.equals(bytes[2], (byte) 0x31) + && Objects.equals(bytes[3], (byte) 0x30); + } + }, + + WEBP("image/webp", "webp") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 11 + && Objects.equals(bytes[8], (byte) 0x57) + && Objects.equals(bytes[9], (byte) 0x45) + && Objects.equals(bytes[10], (byte) 0x42) + && Objects.equals(bytes[11], (byte) 0x50); + } + }, + PSD("image/vnd.adobe.photoshop", "psd") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 3 + && Objects.equals(bytes[0], (byte) 0x38) + && Objects.equals(bytes[1], (byte) 0x42) + && Objects.equals(bytes[2], (byte) 0x50) + && Objects.equals(bytes[3], (byte) 0x53); + } + }, + ICO("image/x-icon", "ico") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 3 + && Objects.equals(bytes[0], (byte) 0x00) + && Objects.equals(bytes[1], (byte) 0x00) + && Objects.equals(bytes[2], (byte) 0x01) + && Objects.equals(bytes[3], (byte) 0x00); + } + }, + XCF("image/x-xcf", "xcf") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 9 + && Objects.equals(bytes[0], (byte) 0x67) + && Objects.equals(bytes[1], (byte) 0x69) + && Objects.equals(bytes[2], (byte) 0x6d) + && Objects.equals(bytes[3], (byte) 0x70) + && Objects.equals(bytes[4], (byte) 0x20) + && Objects.equals(bytes[5], (byte) 0x78) + && Objects.equals(bytes[6], (byte) 0x63) + && Objects.equals(bytes[7], (byte) 0x66) + && Objects.equals(bytes[8], (byte) 0x20) + && Objects.equals(bytes[9], (byte) 0x76); + } + }, + //image end----------------------------------------------- + + //audio start--------------------------------------------- + + WAV("audio/x-wav", "wav") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 11 + && Objects.equals(bytes[0], (byte) 0x52) + && Objects.equals(bytes[1], (byte) 0x49) + && Objects.equals(bytes[2], (byte) 0x46) + && Objects.equals(bytes[3], (byte) 0x46) + && Objects.equals(bytes[8], (byte) 0x57) + && Objects.equals(bytes[9], (byte) 0x41) + && Objects.equals(bytes[10], (byte) 0x56) + && Objects.equals(bytes[11], (byte) 0x45); + } + }, + MIDI("audio/midi", "midi") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 3 + && Objects.equals(bytes[0], (byte) 0x4d) + && Objects.equals(bytes[1], (byte) 0x54) + && Objects.equals(bytes[2], (byte) 0x68) + && Objects.equals(bytes[3], (byte) 0x64); + } + }, + MP3("audio/mpeg", "mp3") { + @Override + public boolean match(final byte[] bytes) { + if (bytes.length < 2) { + return false; + } + final boolean flag1 = Objects.equals(bytes[0], (byte) 0x49) && Objects.equals(bytes[1], (byte) 0x44) && Objects.equals(bytes[2], (byte) 0x33); + final boolean flag2 = Objects.equals(bytes[0], (byte) 0xFF) && Objects.equals(bytes[1], (byte) 0xFB); + final boolean flag3 = Objects.equals(bytes[0], (byte) 0xFF) && Objects.equals(bytes[1], (byte) 0xF3); + final boolean flag4 = Objects.equals(bytes[0], (byte) 0xFF) && Objects.equals(bytes[1], (byte) 0xF2); + return flag1 || flag2 || flag3 || flag4; + } + }, + OGG("audio/ogg", "ogg") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 3 + && Objects.equals(bytes[0], (byte) 0x4f) + && Objects.equals(bytes[1], (byte) 0x67) + && Objects.equals(bytes[2], (byte) 0x67) + && Objects.equals(bytes[3], (byte) 0x53); + } + }, + FLAC("audio/x-flac", "flac") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 3 + && Objects.equals(bytes[0], (byte) 0x66) + && Objects.equals(bytes[1], (byte) 0x4c) + && Objects.equals(bytes[2], (byte) 0x61) + && Objects.equals(bytes[3], (byte) 0x43); + } + }, + M4A("audio/mp4", "m4a") { + @Override + public boolean match(final byte[] bytes) { + return (bytes.length > 10 + && Objects.equals(bytes[4], (byte) 0x66) + && Objects.equals(bytes[5], (byte) 0x74) + && Objects.equals(bytes[6], (byte) 0x79) + && Objects.equals(bytes[7], (byte) 0x70) + && Objects.equals(bytes[8], (byte) 0x4d) + && Objects.equals(bytes[9], (byte) 0x34) + && Objects.equals(bytes[10], (byte) 0x41)) + || (Objects.equals(bytes[0], (byte) 0x4d) + && Objects.equals(bytes[1], (byte) 0x34) + && Objects.equals(bytes[2], (byte) 0x41) + && Objects.equals(bytes[3], (byte) 0x20)); + } + }, + AAC("audio/aac", "aac") { + @Override + public boolean match(final byte[] bytes) { + if (bytes.length < 1) { + return false; + } + final boolean flag1 = Objects.equals(bytes[0], (byte) 0xFF) && Objects.equals(bytes[1], (byte) 0xF1); + final boolean flag2 = Objects.equals(bytes[0], (byte) 0xFF) && Objects.equals(bytes[1], (byte) 0xF9); + return flag1 || flag2; + } + }, + AMR("audio/amr", "amr") { + @Override + public boolean match(final byte[] bytes) { + //single-channel + if (bytes.length < 11) { + return false; + } + final boolean flag1 = Objects.equals(bytes[0], (byte) 0x23) + && Objects.equals(bytes[1], (byte) 0x21) + && Objects.equals(bytes[2], (byte) 0x41) + && Objects.equals(bytes[3], (byte) 0x4d) + && Objects.equals(bytes[4], (byte) 0x52) + && Objects.equals(bytes[5], (byte) 0x0A); + //multi-channel: + final boolean flag2 = Objects.equals(bytes[0], (byte) 0x23) + && Objects.equals(bytes[1], (byte) 0x21) + && Objects.equals(bytes[2], (byte) 0x41) + && Objects.equals(bytes[3], (byte) 0x4d) + && Objects.equals(bytes[4], (byte) 0x52) + && Objects.equals(bytes[5], (byte) 0x5F) + && Objects.equals(bytes[6], (byte) 0x4d) + && Objects.equals(bytes[7], (byte) 0x43) + && Objects.equals(bytes[8], (byte) 0x31) + && Objects.equals(bytes[9], (byte) 0x2e) + && Objects.equals(bytes[10], (byte) 0x30) + && Objects.equals(bytes[11], (byte) 0x0a); + return flag1 || flag2; + } + }, + AC3("audio/ac3", "ac3") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 2 + && Objects.equals(bytes[0], (byte) 0x0b) + && Objects.equals(bytes[1], (byte) 0x77); + } + }, + AIFF("audio/x-aiff", "aiff") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 11 + && Objects.equals(bytes[0], (byte) 0x46) + && Objects.equals(bytes[1], (byte) 0x4f) + && Objects.equals(bytes[2], (byte) 0x52) + && Objects.equals(bytes[3], (byte) 0x4d) + && Objects.equals(bytes[8], (byte) 0x41) + && Objects.equals(bytes[9], (byte) 0x49) + && Objects.equals(bytes[10], (byte) 0x46) + && Objects.equals(bytes[11], (byte) 0x46); + } + }, + //audio end----------------------------------------------- + + //font start--------------------------------------------- + // The existing registration "application/font-woff" is deprecated in favor of "font/woff". + WOFF("font/woff", "woff") { + @Override + public boolean match(final byte[] bytes) { + final boolean flag1 = Objects.equals(bytes[0], (byte) 0x77) + && Objects.equals(bytes[1], (byte) 0x4f) + && Objects.equals(bytes[2], (byte) 0x46) + && Objects.equals(bytes[3], (byte) 0x46); + final boolean flag2 = Objects.equals(bytes[4], (byte) 0x00) + && Objects.equals(bytes[5], (byte) 0x01) + && Objects.equals(bytes[6], (byte) 0x00) + && Objects.equals(bytes[7], (byte) 0x00); + final boolean flag3 = Objects.equals(bytes[4], (byte) 0x4f) + && Objects.equals(bytes[5], (byte) 0x54) + && Objects.equals(bytes[6], (byte) 0x54) + && Objects.equals(bytes[7], (byte) 0x4f); + final boolean flag4 = Objects.equals(bytes[4], (byte) 0x74) + && Objects.equals(bytes[5], (byte) 0x72) + && Objects.equals(bytes[6], (byte) 0x75) + && Objects.equals(bytes[7], (byte) 0x65); + return bytes.length > 7 + && (flag1 && (flag2 || flag3 || flag4)); + } + }, + WOFF2("font/woff2", "woff2") { + @Override + public boolean match(final byte[] bytes) { + final boolean flag1 = Objects.equals(bytes[0], (byte) 0x77) + && Objects.equals(bytes[1], (byte) 0x4f) + && Objects.equals(bytes[2], (byte) 0x46) + && Objects.equals(bytes[3], (byte) 0x32); + final boolean flag2 = Objects.equals(bytes[4], (byte) 0x00) + && Objects.equals(bytes[5], (byte) 0x01) + && Objects.equals(bytes[6], (byte) 0x00) + && Objects.equals(bytes[7], (byte) 0x00); + final boolean flag3 = Objects.equals(bytes[4], (byte) 0x4f) + && Objects.equals(bytes[5], (byte) 0x54) + && Objects.equals(bytes[6], (byte) 0x54) + && Objects.equals(bytes[7], (byte) 0x4f); + final boolean flag4 = Objects.equals(bytes[4], (byte) 0x74) + && Objects.equals(bytes[5], (byte) 0x72) + && Objects.equals(bytes[6], (byte) 0x75) + && Objects.equals(bytes[7], (byte) 0x65); + return bytes.length > 7 + && (flag1 && (flag2 || flag3 || flag4)); + } + }, + TTF("font/ttf", "ttf") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 4 + && Objects.equals(bytes[0], (byte) 0x00) + && Objects.equals(bytes[1], (byte) 0x01) + && Objects.equals(bytes[2], (byte) 0x00) + && Objects.equals(bytes[3], (byte) 0x00) + && Objects.equals(bytes[4], (byte) 0x00); + } + }, + OTF("font/otf", "otf") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 4 + && Objects.equals(bytes[0], (byte) 0x4f) + && Objects.equals(bytes[1], (byte) 0x54) + && Objects.equals(bytes[2], (byte) 0x54) + && Objects.equals(bytes[3], (byte) 0x4f) + && Objects.equals(bytes[4], (byte) 0x00); + } + }, + + //font end----------------------------------------------- + + //archive start----------------------------------------- + EPUB("application/epub+zip", "epub") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 58 + && Objects.equals(bytes[0], (byte) 0x50) && Objects.equals(bytes[1], (byte) 0x4b) + && Objects.equals(bytes[2], (byte) 0x03) && Objects.equals(bytes[3], (byte) 0x04) + && Objects.equals(bytes[30], (byte) 0x6d) && Objects.equals(bytes[31], (byte) 0x69) + && Objects.equals(bytes[32], (byte) 0x6d) && Objects.equals(bytes[33], (byte) 0x65) + && Objects.equals(bytes[34], (byte) 0x74) && Objects.equals(bytes[35], (byte) 0x79) + && Objects.equals(bytes[36], (byte) 0x70) && Objects.equals(bytes[37], (byte) 0x65) + && Objects.equals(bytes[38], (byte) 0x61) && Objects.equals(bytes[39], (byte) 0x70) + && Objects.equals(bytes[40], (byte) 0x70) && Objects.equals(bytes[41], (byte) 0x6c) + && Objects.equals(bytes[42], (byte) 0x69) && Objects.equals(bytes[43], (byte) 0x63) + && Objects.equals(bytes[44], (byte) 0x61) && Objects.equals(bytes[45], (byte) 0x74) + && Objects.equals(bytes[46], (byte) 0x69) && Objects.equals(bytes[47], (byte) 0x6f) + && Objects.equals(bytes[48], (byte) 0x6e) && Objects.equals(bytes[49], (byte) 0x2f) + && Objects.equals(bytes[50], (byte) 0x65) && Objects.equals(bytes[51], (byte) 0x70) + && Objects.equals(bytes[52], (byte) 0x75) && Objects.equals(bytes[53], (byte) 0x62) + && Objects.equals(bytes[54], (byte) 0x2b) && Objects.equals(bytes[55], (byte) 0x7a) + && Objects.equals(bytes[56], (byte) 0x69) && Objects.equals(bytes[57], (byte) 0x70); + } + }, + ZIP("application/zip", "zip") { + @Override + public boolean match(final byte[] bytes) { + if (bytes.length < 4) { + return false; + } + final boolean flag1 = Objects.equals(bytes[0], (byte) 0x50) && Objects.equals(bytes[1], (byte) 0x4b); + final boolean flag2 = Objects.equals(bytes[2], (byte) 0x03) || Objects.equals(bytes[2], (byte) 0x05) || Objects.equals(bytes[2], (byte) 0x07); + final boolean flag3 = Objects.equals(bytes[3], (byte) 0x04) || Objects.equals(bytes[3], (byte) 0x06) || Objects.equals(bytes[3], (byte) 0x08); + return flag1 && flag2 && flag3; + } + }, + TAR("application/x-tar", "tar") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 261 + && Objects.equals(bytes[257], (byte) 0x75) + && Objects.equals(bytes[258], (byte) 0x73) + && Objects.equals(bytes[259], (byte) 0x74) + && Objects.equals(bytes[260], (byte) 0x61) + && Objects.equals(bytes[261], (byte) 0x72); + } + }, + RAR("application/x-rar-compressed", "rar") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 6 + && Objects.equals(bytes[0], (byte) 0x52) + && Objects.equals(bytes[1], (byte) 0x61) + && Objects.equals(bytes[2], (byte) 0x72) + && Objects.equals(bytes[3], (byte) 0x21) + && Objects.equals(bytes[4], (byte) 0x1a) + && Objects.equals(bytes[5], (byte) 0x07) + && (Objects.equals(bytes[6], (byte) 0x00) || Objects.equals(bytes[6], (byte) 0x01)); + } + }, + GZ("application/gzip", "gz") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 2 + && Objects.equals(bytes[0], (byte) 0x1f) + && Objects.equals(bytes[1], (byte) 0x8b) + && Objects.equals(bytes[2], (byte) 0x08); + } + }, + BZ2("application/x-bzip2", "bz2") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 2 + && Objects.equals(bytes[0], (byte) 0x42) + && Objects.equals(bytes[1], (byte) 0x5a) + && Objects.equals(bytes[2], (byte) 0x68); + } + }, + SevenZ("application/x-7z-compressed", "7z") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 6 + && Objects.equals(bytes[0], (byte) 0x37) + && Objects.equals(bytes[1], (byte) 0x7a) + && Objects.equals(bytes[2], (byte) 0xbc) + && Objects.equals(bytes[3], (byte) 0xaf) + && Objects.equals(bytes[4], (byte) 0x27) + && Objects.equals(bytes[5], (byte) 0x1c) + && Objects.equals(bytes[6], (byte) 0x00); + } + }, + PDF("application/pdf", "pdf") { + @Override + public boolean match(byte[] bytes) { + //去除bom头并且跳过三个字节 + if (bytes.length > 3 && Objects.equals(bytes[0], (byte) 0xEF) + && Objects.equals(bytes[1], (byte) 0xBB) && Objects.equals(bytes[2], (byte) 0xBF)) { + bytes = Arrays.copyOfRange(bytes, 3, bytes.length); + } + return bytes.length > 3 + && Objects.equals(bytes[0], (byte) 0x25) + && Objects.equals(bytes[1], (byte) 0x50) + && Objects.equals(bytes[2], (byte) 0x44) + && Objects.equals(bytes[3], (byte) 0x46); + } + }, + EXE("application/x-msdownload", "exe") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 1 + && Objects.equals(bytes[0], (byte) 0x4d) + && Objects.equals(bytes[1], (byte) 0x5a); + } + }, + SWF("application/x-shockwave-flash", "swf") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 2 + && (Objects.equals(bytes[0], 0x43) || Objects.equals(bytes[0], (byte) 0x46)) + && Objects.equals(bytes[1], (byte) 0x57) + && Objects.equals(bytes[2], (byte) 0x53); + } + }, + RTF("application/rtf", "rtf") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 4 + && Objects.equals(bytes[0], (byte) 0x7b) + && Objects.equals(bytes[1], (byte) 0x5c) + && Objects.equals(bytes[2], (byte) 0x72) + && Objects.equals(bytes[3], (byte) 0x74) + && Objects.equals(bytes[4], (byte) 0x66); + } + }, + NES("application/x-nintendo-nes-rom", "nes") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 3 + && Objects.equals(bytes[0], (byte) 0x4e) + && Objects.equals(bytes[1], (byte) 0x45) + && Objects.equals(bytes[2], (byte) 0x53) + && Objects.equals(bytes[3], (byte) 0x1a); + } + }, + CRX("application/x-google-chrome-extension", "crx") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 3 + && Objects.equals(bytes[0], (byte) 0x43) + && Objects.equals(bytes[1], (byte) 0x72) + && Objects.equals(bytes[2], (byte) 0x32) + && Objects.equals(bytes[3], (byte) 0x34); + } + }, + CAB("application/vnd.ms-cab-compressed", "cab") { + @Override + public boolean match(final byte[] bytes) { + if (bytes.length < 4) { + return false; + } + final boolean flag1 = Objects.equals(bytes[0], (byte) 0x4d) && Objects.equals(bytes[1], (byte) 0x53) + && Objects.equals(bytes[2], (byte) 0x43) && Objects.equals(bytes[3], (byte) 0x46); + final boolean flag2 = Objects.equals(bytes[0], (byte) 0x49) && Objects.equals(bytes[1], (byte) 0x53) + && Objects.equals(bytes[2], (byte) 0x63) && Objects.equals(bytes[3], (byte) 0x28); + return flag1 || flag2; + } + }, + PS("application/postscript", "ps") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 1 + && Objects.equals(bytes[0], (byte) 0x25) + && Objects.equals(bytes[1], (byte) 0x21); + } + }, + XZ("application/x-xz", "xz") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 5 + && Objects.equals(bytes[0], (byte) 0xFD) + && Objects.equals(bytes[1], (byte) 0x37) + && Objects.equals(bytes[2], (byte) 0x7A) + && Objects.equals(bytes[3], (byte) 0x58) + && Objects.equals(bytes[4], (byte) 0x5A) + && Objects.equals(bytes[5], (byte) 0x00); + } + }, + SQLITE("application/x-sqlite3", "sqlite") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 15 + && Objects.equals(bytes[0], (byte) 0x53) && Objects.equals(bytes[1], (byte) 0x51) + && Objects.equals(bytes[2], (byte) 0x4c) && Objects.equals(bytes[3], (byte) 0x69) + && Objects.equals(bytes[4], (byte) 0x74) && Objects.equals(bytes[5], (byte) 0x65) + && Objects.equals(bytes[6], (byte) 0x20) && Objects.equals(bytes[7], (byte) 0x66) + && Objects.equals(bytes[8], (byte) 0x6f) && Objects.equals(bytes[9], (byte) 0x72) + && Objects.equals(bytes[10], (byte) 0x6d) && Objects.equals(bytes[11], (byte) 0x61) + && Objects.equals(bytes[12], (byte) 0x74) && Objects.equals(bytes[13], (byte) 0x20) + && Objects.equals(bytes[14], (byte) 0x33) && Objects.equals(bytes[15], (byte) 0x00); + } + }, + DEB("application/x-deb", "deb") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 20 + && Objects.equals(bytes[0], (byte) 0x21) && Objects.equals(bytes[1], (byte) 0x3c) + && Objects.equals(bytes[2], (byte) 0x61) && Objects.equals(bytes[3], (byte) 0x72) + && Objects.equals(bytes[4], (byte) 0x63) && Objects.equals(bytes[5], (byte) 0x68) + && Objects.equals(bytes[6], (byte) 0x3e) && Objects.equals(bytes[7], (byte) 0x0a) + && Objects.equals(bytes[8], (byte) 0x64) && Objects.equals(bytes[9], (byte) 0x65) + && Objects.equals(bytes[10], (byte) 0x62) && Objects.equals(bytes[11], (byte) 0x69) + && Objects.equals(bytes[12], (byte) 0x61) && Objects.equals(bytes[13], (byte) 0x6e) + && Objects.equals(bytes[14], (byte) 0x2d) && Objects.equals(bytes[15], (byte) 0x62) + && Objects.equals(bytes[16], (byte) 0x69) && Objects.equals(bytes[17], (byte) 0x6e) + && Objects.equals(bytes[18], (byte) 0x61) && Objects.equals(bytes[19], (byte) 0x72) + && Objects.equals(bytes[20], (byte) 0x79); + } + }, + AR("application/x-unix-archive", "ar") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 6 + && Objects.equals(bytes[0], (byte) 0x21) + && Objects.equals(bytes[1], (byte) 0x3c) + && Objects.equals(bytes[2], (byte) 0x61) + && Objects.equals(bytes[3], (byte) 0x72) + && Objects.equals(bytes[4], (byte) 0x63) + && Objects.equals(bytes[5], (byte) 0x68) + && Objects.equals(bytes[6], (byte) 0x3e); + } + }, + LZOP("application/x-lzop", "lzo") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 7 + && Objects.equals(bytes[0], (byte) 0x89) + && Objects.equals(bytes[1], (byte) 0x4c) + && Objects.equals(bytes[2], (byte) 0x5a) + && Objects.equals(bytes[3], (byte) 0x4f) + && Objects.equals(bytes[4], (byte) 0x00) + && Objects.equals(bytes[5], (byte) 0x0d) + && Objects.equals(bytes[6], (byte) 0x0a) + && Objects.equals(bytes[7], (byte) 0x1a); + } + }, + LZ("application/x-lzip", "lz") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 3 + && Objects.equals(bytes[0], (byte) 0x4c) + && Objects.equals(bytes[1], (byte) 0x5a) + && Objects.equals(bytes[2], (byte) 0x49) + && Objects.equals(bytes[3], (byte) 0x50); + } + }, + ELF("application/x-executable", "elf") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 52 + && Objects.equals(bytes[0], (byte) 0x7f) + && Objects.equals(bytes[1], (byte) 0x45) + && Objects.equals(bytes[2], (byte) 0x4c) + && Objects.equals(bytes[3], (byte) 0x46); + } + }, + LZ4("application/x-lz4", "lz4") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 4 + && Objects.equals(bytes[0], (byte) 0x04) + && Objects.equals(bytes[1], (byte) 0x22) + && Objects.equals(bytes[2], (byte) 0x4d) + && Objects.equals(bytes[3], (byte) 0x18); + } + }, + //https://github.com/madler/brotli/blob/master/br-format-v3.txt,brotli 没有固定的file magic number,所以此处只是参考 + BR("application/x-brotli", "br") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 3 + && Objects.equals(bytes[0], (byte) 0xce) + && Objects.equals(bytes[1], (byte) 0xb2) + && Objects.equals(bytes[2], (byte) 0xcf) + && Objects.equals(bytes[3], (byte) 0x81); + } + }, + DCM("application/x-dicom", "dcm") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 128 + && Objects.equals(bytes[128], (byte) 0x44) + && Objects.equals(bytes[129], (byte) 0x49) + && Objects.equals(bytes[130], (byte) 0x43) + && Objects.equals(bytes[131], (byte) 0x4d); + } + }, + RPM("application/x-rpm", "rpm") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 4 + && Objects.equals(bytes[0], (byte) 0xed) + && Objects.equals(bytes[1], (byte) 0xab) + && Objects.equals(bytes[2], (byte) 0xee) + && Objects.equals(bytes[3], (byte) 0xdb); + } + }, + ZSTD("application/x-zstd", "zst") { + @Override + public boolean match(final byte[] bytes) { + final int length = bytes.length; + if (length < 5) { + return false; + } + final byte[] buf1 = new byte[]{(byte) 0x22, (byte) 0x23, (byte) 0x24, (byte) 0x25, (byte) 0x26, (byte) 0x27, (byte) 0x28}; + final boolean flag1 = ArrayUtil.contains(buf1, bytes[0]) + && Objects.equals(bytes[1], (byte) 0xb5) + && Objects.equals(bytes[2], (byte) 0x2f) + && Objects.equals(bytes[3], (byte) 0xfd); + if (flag1) { + return true; + } + if ((bytes[0] & 0xF0) == 0x50) { + return bytes[1] == 0x2A && bytes[2] == 0x4D && bytes[3] == 0x18; + } + return false; + } + }, + //archive end------------------------------------------------------------ + //video start------------------------------------------------------------ + MP4("video/mp4", "mp4") { + @Override + public boolean match(final byte[] bytes) { + if (bytes.length < 13) { + return false; + } + final boolean flag1 = Objects.equals(bytes[4], (byte) 0x66) + && Objects.equals(bytes[5], (byte) 0x74) + && Objects.equals(bytes[6], (byte) 0x79) + && Objects.equals(bytes[7], (byte) 0x70) + && Objects.equals(bytes[8], (byte) 0x4d) + && Objects.equals(bytes[9], (byte) 0x53) + && Objects.equals(bytes[10], (byte) 0x4e) + && Objects.equals(bytes[11], (byte) 0x56); + final boolean flag2 = Objects.equals(bytes[4], (byte) 0x66) + && Objects.equals(bytes[5], (byte) 0x74) + && Objects.equals(bytes[6], (byte) 0x79) + && Objects.equals(bytes[7], (byte) 0x70) + && Objects.equals(bytes[8], (byte) 0x69) + && Objects.equals(bytes[9], (byte) 0x73) + && Objects.equals(bytes[10], (byte) 0x6f) + && Objects.equals(bytes[11], (byte) 0x6d); + return flag1 || flag2; + } + }, + AVI("video/x-msvideo", "avi") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 11 + && Objects.equals(bytes[0], (byte) 0x52) + && Objects.equals(bytes[1], (byte) 0x49) + && Objects.equals(bytes[2], (byte) 0x46) + && Objects.equals(bytes[3], (byte) 0x46) + && Objects.equals(bytes[8], (byte) 0x41) + && Objects.equals(bytes[9], (byte) 0x56) + && Objects.equals(bytes[10], (byte) 0x49) + && Objects.equals(bytes[11], (byte) 0x20); + } + }, + WMV("video/x-ms-wmv", "wmv") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 9 + && Objects.equals(bytes[0], (byte) 0x30) + && Objects.equals(bytes[1], (byte) 0x26) + && Objects.equals(bytes[2], (byte) 0xb2) + && Objects.equals(bytes[3], (byte) 0x75) + && Objects.equals(bytes[4], (byte) 0x8e) + && Objects.equals(bytes[5], (byte) 0x66) + && Objects.equals(bytes[6], (byte) 0xcf) + && Objects.equals(bytes[7], (byte) 0x11) + && Objects.equals(bytes[8], (byte) 0xa6) + && Objects.equals(bytes[9], (byte) 0xd9); + } + }, + M4V("video/x-m4v", "m4v") { + @Override + public boolean match(final byte[] bytes) { + if (bytes.length < 12) { + return false; + } + final boolean flag1 = Objects.equals(bytes[4], (byte) 0x66) + && Objects.equals(bytes[5], (byte) 0x74) + && Objects.equals(bytes[6], (byte) 0x79) + && Objects.equals(bytes[7], (byte) 0x70) + && Objects.equals(bytes[8], (byte) 0x4d) + && Objects.equals(bytes[9], (byte) 0x34) + && Objects.equals(bytes[10], (byte) 0x56) + && Objects.equals(bytes[11], (byte) 0x20); + final boolean flag2 = Objects.equals(bytes[4], (byte) 0x66) + && Objects.equals(bytes[5], (byte) 0x74) + && Objects.equals(bytes[6], (byte) 0x79) + && Objects.equals(bytes[7], (byte) 0x70) + && Objects.equals(bytes[8], (byte) 0x6d) + && Objects.equals(bytes[9], (byte) 0x70) + && Objects.equals(bytes[10], (byte) 0x34) + && Objects.equals(bytes[11], (byte) 0x32); + return flag1 || flag2; + } + }, + FLV("video/x-flv", "flv") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 3 + && Objects.equals(bytes[0], (byte) 0x46) + && Objects.equals(bytes[1], (byte) 0x4c) + && Objects.equals(bytes[2], (byte) 0x56) + && Objects.equals(bytes[3], (byte) 0x01); + } + }, + MKV("video/x-matroska", "mkv") { + @Override + public boolean match(final byte[] bytes) { + //0x42 0x82 0x88 0x6d 0x61 0x74 0x72 0x6f 0x73 0x6b 0x61 + final boolean flag1 = bytes.length > 11 + && Objects.equals(bytes[0], (byte) 0x1a) + && Objects.equals(bytes[1], (byte) 0x45) + && Objects.equals(bytes[2], (byte) 0xdf) + && Objects.equals(bytes[3], (byte) 0xa3); + + if (flag1) { + //此处需要判断是否是'\x42\x82\x88matroska'，算法类似kmp判断 + final byte[] bytes1 = {(byte) 0x42, (byte) 0x82, (byte) 0x88, (byte) 0x6d, (byte) 0x61, (byte) 0x74, (byte) 0x72, (byte) 0x6f, (byte) 0x73, (byte) 0x6b, (byte) 0x61}; + final int index = FileMagicNumber.indexOf(bytes, bytes1); + return index > 0; + } + return false; + } + }, + + WEBM("video/webm", "webm") { + @Override + public boolean match(final byte[] bytes) { + final boolean flag1 = bytes.length > 8 + && Objects.equals(bytes[0], (byte) 0x1a) + && Objects.equals(bytes[1], (byte) 0x45) + && Objects.equals(bytes[2], (byte) 0xdf) + && Objects.equals(bytes[3], (byte) 0xa3); + if (flag1) { + //此处需要判断是否是'\x42\x82\x88webm'，算法类似kmp判断 + final byte[] bytes1 = {(byte) 0x42, (byte) 0x82, (byte) 0x88, (byte) 0x77, (byte) 0x65, (byte) 0x62, (byte) 0x6d}; + final int index = FileMagicNumber.indexOf(bytes, bytes1); + return index > 0; + } + return false; + } + }, + //此文件签名非常复杂，只判断常见的几种 + MOV("video/quicktime", "mov") { + @Override + public boolean match(final byte[] bytes) { + if (bytes.length < 12) { + return false; + } + final boolean flag1 = Objects.equals(bytes[4], (byte) 0x66) + && Objects.equals(bytes[5], (byte) 0x74) + && Objects.equals(bytes[6], (byte) 0x79) + && Objects.equals(bytes[7], (byte) 0x70) + && Objects.equals(bytes[8], (byte) 0x71) + && Objects.equals(bytes[9], (byte) 0x74) + && Objects.equals(bytes[10], (byte) 0x20) + && Objects.equals(bytes[11], (byte) 0x20); + final boolean flag2 = Objects.equals(bytes[4], (byte) 0x6D) + && Objects.equals(bytes[5], (byte) 0x6F) + && Objects.equals(bytes[6], (byte) 0x6F) + && Objects.equals(bytes[7], (byte) 0x76); + final boolean flag3 = Objects.equals(bytes[4], (byte) 0x66) + && Objects.equals(bytes[5], (byte) 0x72) + && Objects.equals(bytes[6], (byte) 0x65) + && Objects.equals(bytes[7], (byte) 0x65); + final boolean flag4 = Objects.equals(bytes[4], (byte) 0x6D) + && Objects.equals(bytes[5], (byte) 0x64) + && Objects.equals(bytes[6], (byte) 0x61) + && Objects.equals(bytes[7], (byte) 0x74); + final boolean flag5 = Objects.equals(bytes[4], (byte) 0x77) + && Objects.equals(bytes[5], (byte) 0x69) + && Objects.equals(bytes[6], (byte) 0x64) + && Objects.equals(bytes[7], (byte) 0x65); + final boolean flag6 = Objects.equals(bytes[4], (byte) 0x70) + && Objects.equals(bytes[5], (byte) 0x6E) + && Objects.equals(bytes[6], (byte) 0x6F) + && Objects.equals(bytes[7], (byte) 0x74); + final boolean flag7 = Objects.equals(bytes[4], (byte) 0x73) + && Objects.equals(bytes[5], (byte) 0x6B) + && Objects.equals(bytes[6], (byte) 0x69) + && Objects.equals(bytes[7], (byte) 0x70); + return flag1 || flag2 || flag3 || flag4 || flag5 || flag6 || flag7; + } + }, + MPEG("video/mpeg", "mpg") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 3 + && Objects.equals(bytes[0], (byte) 0x00) + && Objects.equals(bytes[1], (byte) 0x00) + && Objects.equals(bytes[2], (byte) 0x01) + && (bytes[3] >= (byte) 0xb0 && bytes[3] <= (byte) 0xbf); + } + }, + RMVB("video/vnd.rn-realvideo", "rmvb") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 4 + && Objects.equals(bytes[0], (byte) 0x2E) + && Objects.equals(bytes[1], (byte) 0x52) + && Objects.equals(bytes[2], (byte) 0x4D) + && Objects.equals(bytes[3], (byte) 0x46); + } + }, + M3GP("video/3gpp", "3gp") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 10 + && Objects.equals(bytes[4], (byte) 0x66) + && Objects.equals(bytes[5], (byte) 0x74) + && Objects.equals(bytes[6], (byte) 0x79) + && Objects.equals(bytes[7], (byte) 0x70) + && Objects.equals(bytes[8], (byte) 0x33) + && Objects.equals(bytes[9], (byte) 0x67) + && Objects.equals(bytes[10], (byte) 0x70); + } + }, + //video end --------------------------------------------------------------- + //document start ---------------------------------------------------------- + DOC("application/msword", "doc") { + @Override + public boolean match(final byte[] bytes) { + final byte[] byte1 = new byte[]{(byte) 0xd0, (byte) 0xcf, (byte) 0x11, (byte) 0xe0, (byte) 0xa1, (byte) 0xb1, (byte) 0x1a, (byte) 0xe1}; + final boolean flag1 = bytes.length > 515 && Arrays.equals(Arrays.copyOfRange(bytes, 0, 8), byte1); + if (flag1) { + final byte[] byte2 = new byte[]{(byte) 0xec, (byte) 0xa5, (byte) 0xc1, (byte) 0x00}; + final boolean flag2 = Arrays.equals(Arrays.copyOfRange(bytes, 512, 516), byte2); + final byte[] byte3 = new byte[]{(byte) 0x00, (byte) 0x0a, (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x4d, (byte) 0x53, (byte) 0x57, (byte) 0x6f, (byte) 0x72, (byte) 0x64 + , (byte) 0x44, (byte) 0x6f, (byte) 0x63, (byte) 0x00, (byte) 0x10, (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x57, (byte) 0x6f, (byte) 0x72, (byte) 0x64, + (byte) 0x2e, (byte) 0x44, (byte) 0x6f, (byte) 0x63, (byte) 0x75, (byte) 0x6d, (byte) 0x65, (byte) 0x6e, (byte) 0x74, (byte) 0x2e, (byte) 0x38, (byte) 0x00, + (byte) 0xf4, (byte) 0x39, (byte) 0xb2, (byte) 0x71}; + final byte[] range = Arrays.copyOfRange(bytes, 2075, 2142); + final boolean flag3 = bytes.length > 2142 && FileMagicNumber.indexOf(range, byte3) > 0; + return flag2 || flag3; + } + return false; + } + }, + + XLS("application/vnd.ms-excel", "xls") { + @Override + public boolean match(final byte[] bytes) { + final byte[] byte1 = new byte[]{(byte) 0xd0, (byte) 0xcf, (byte) 0x11, (byte) 0xe0, (byte) 0xa1, (byte) 0xb1, (byte) 0x1a, (byte) 0xe1}; + final boolean flag1 = bytes.length > 520 && Arrays.equals(Arrays.copyOfRange(bytes, 0, 8), byte1); + if (flag1) { + final byte[] byte2 = new byte[]{(byte) 0xfd, (byte) 0xff, (byte) 0xff, (byte) 0xff}; + final boolean flag2 = Arrays.equals(Arrays.copyOfRange(bytes, 512, 516), byte2) && (bytes[518] == 0x00 || bytes[518] == 0x02); + final byte[] byte3 = new byte[]{(byte) 0x09, (byte) 0x08, (byte) 0x10, (byte) 0x00, (byte) 0x00, (byte) 0x06, (byte) 0x05, (byte) 0x00}; + final boolean flag3 = Arrays.equals(Arrays.copyOfRange(bytes, 512, 520), byte3); + final byte[] byte4 = new byte[]{(byte) 0xe2, (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x5c, (byte) 0x00, (byte) 0x70, (byte) 0x00, (byte) 0x04, (byte) 0x00, (byte) 0x00, (byte) 0x43, (byte) 0x61, (byte) 0x6c, (byte) 0x63}; + final boolean flag4 = bytes.length > 2095 && Arrays.equals(Arrays.copyOfRange(bytes, 1568, 2095), byte4); + return flag2 || flag3 || flag4; + } + return false; + } + + }, + PPT("application/vnd.ms-powerpoint", "ppt") { + @Override + public boolean match(final byte[] bytes) { + final byte[] byte1 = new byte[]{(byte) 0xd0, (byte) 0xcf, (byte) 0x11, (byte) 0xe0, (byte) 0xa1, (byte) 0xb1, (byte) 0x1a, (byte) 0xe1}; + final boolean flag1 = bytes.length > 524 && Arrays.equals(Arrays.copyOfRange(bytes, 0, 8), byte1); + if (flag1) { + final byte[] byte2 = new byte[]{(byte) 0xa0, (byte) 0x46, (byte) 0x1d, (byte) 0xf0}; + final byte[] byteRange = Arrays.copyOfRange(bytes, 512, 516); + final boolean flag2 = Arrays.equals(byteRange, byte2); + final byte[] byte3 = new byte[]{(byte) 0x00, (byte) 0x6e, (byte) 0x1e, (byte) 0xf0}; + final boolean flag3 = Arrays.equals(byteRange, byte3); + final byte[] byte4 = new byte[]{(byte) 0x0f, (byte) 0x00, (byte) 0xe8, (byte) 0x03}; + final boolean flag4 = Arrays.equals(byteRange, byte4); + final byte[] byte5 = new byte[]{(byte) 0xfd, (byte) 0xff, (byte) 0xff, (byte) 0xff}; + final boolean flag5 = Arrays.equals(byteRange, byte5) && bytes[522] == 0x00 && bytes[523] == 0x00; + final byte[] byte6 = new byte[]{(byte) 0x00, (byte) 0xb9, (byte) 0x29, (byte) 0xe8, (byte) 0x11, (byte) 0x00, (byte) 0x00, (byte) 0x00, + (byte) 0x4d, (byte) 0x53, (byte) 0x20, (byte) 0x50, (byte) 0x6f, (byte) 0x77, (byte) 0x65, (byte) 0x72, (byte) 0x50, (byte) + 0x6f, (byte) 0x69, (byte) 0x6e, (byte) 0x74, (byte) 0x20, (byte) 0x39, (byte) 0x37}; + final boolean flag6 = bytes.length > 2096 && Arrays.equals(Arrays.copyOfRange(bytes, 2072, 2096), byte6); + return flag2 || flag3 || flag4 || flag5 || flag6; + } + return false; + } + }, + DOCX("application/vnd.openxmlformats-officedocument.wordprocessingml.document", "docx") { + @Override + public boolean match(final byte[] bytes) { + return Objects.equals(FileMagicNumber.matchDocument(bytes), DOCX); + } + }, + PPTX("application/vnd.openxmlformats-officedocument.presentationml.presentation", "pptx") { + @Override + public boolean match(final byte[] bytes) { + return Objects.equals(FileMagicNumber.matchDocument(bytes), PPTX); + } + }, + XLSX("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "xlsx") { + @Override + public boolean match(final byte[] bytes) { + return Objects.equals(FileMagicNumber.matchDocument(bytes), XLSX); + } + }, + + //document end ------------------------------------------------------------ + //other start ------------------------------------------------------------- + WASM("application/wasm", "wasm") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 7 + && Objects.equals(bytes[0], (byte) 0x00) + && Objects.equals(bytes[1], (byte) 0x61) + && Objects.equals(bytes[2], (byte) 0x73) + && Objects.equals(bytes[3], (byte) 0x6D) + && Objects.equals(bytes[4], (byte) 0x01) + && Objects.equals(bytes[5], (byte) 0x00) + && Objects.equals(bytes[6], (byte) 0x00) + && Objects.equals(bytes[7], (byte) 0x00); + } + }, + // https://source.android.com/devices/tech/dalvik/dex-format#dex-file-magic + DEX("application/vnd.android.dex", "dex") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 36 + && Objects.equals(bytes[0], (byte) 0x64) + && Objects.equals(bytes[1], (byte) 0x65) + && Objects.equals(bytes[2], (byte) 0x78) + && Objects.equals(bytes[3], (byte) 0x0A) + && Objects.equals(bytes[36], (byte) 0x70); + } + }, + DEY("application/vnd.android.dey", "dey") { + @Override + public boolean match(final byte[] bytes) { + return bytes.length > 100 + && Objects.equals(bytes[0], (byte) 0x64) + && Objects.equals(bytes[1], (byte) 0x65) + && Objects.equals(bytes[2], (byte) 0x79) + && Objects.equals(bytes[3], (byte) 0x0A) && + DEX.match(Arrays.copyOfRange(bytes, 40, 100)); + } + }, + EML("message/rfc822", "eml") { + @Override + public boolean match(final byte[] bytes) { + if (bytes.length < 8) { + return false; + } + final byte[] byte1 = new byte[]{(byte) 0x46, (byte) 0x72, (byte) 0x6F, (byte) 0x6D, (byte) 0x20, (byte) 0x20, (byte) 0x20}; + final byte[] byte2 = new byte[]{(byte) 0x46, (byte) 0x72, (byte) 0x6F, (byte) 0x6D, (byte) 0x20, (byte) 0x3F, (byte) 0x3F, (byte) 0x3F}; + final byte[] byte3 = new byte[]{(byte) 0x46, (byte) 0x72, (byte) 0x6F, (byte) 0x6D, (byte) 0x3A, (byte) 0x20}; + final byte[] byte4 = new byte[]{(byte) 0x52, (byte) 0x65, (byte) 0x74, (byte) 0x75, (byte) 0x72, (byte) 0x6E, (byte) 0x2D, (byte) 0x50, (byte) 0x61, (byte) 0x74, (byte) 0x68, (byte) 0x3A, (byte) 0x20}; + return Arrays.equals(Arrays.copyOfRange(bytes, 0, 7), byte1) + || Arrays.equals(Arrays.copyOfRange(bytes, 0, 8), byte2) + || Arrays.equals(Arrays.copyOfRange(bytes, 0, 6), byte3) + || bytes.length > 13 && Arrays.equals(Arrays.copyOfRange(bytes, 0, 13), byte4); + } + }, + MDB("application/vnd.ms-access", "mdb") { + @Override + public boolean match(final byte[] bytes) { + final byte[] byte1 = new byte[]{(byte) 0x00, (byte) 0x01, (byte) 0x00, (byte) 0x00, (byte) 0x53, (byte) 0x74, (byte) 0x61, (byte) 0x6E, (byte) 0x64, + (byte) 0x61, (byte) 0x72, (byte) 0x64, (byte) 0x20, (byte) 0x4A, (byte) 0x65, (byte) 0x74, (byte) 0x20, (byte) 0x44, (byte) 0x42}; + return bytes.length > 18 && Arrays.equals(Arrays.copyOfRange(bytes, 0, 18), byte1); + } + }, + //CHM 49 54 53 46 + CHM("application/vnd.ms-htmlhelp", "chm") { + @Override + public boolean match(final byte[] bytes) { + final byte[] byte1 = new byte[]{(byte) 0x49, (byte) 0x54, (byte) 0x53, (byte) 0x46}; + return bytes.length > 4 && Arrays.equals(Arrays.copyOfRange(bytes, 0, 4), byte1); + } + }, + //class CA FE BA BE + CLASS("application/java-vm", "class") { + @Override + public boolean match(final byte[] bytes) { + final byte[] byte1 = new byte[]{(byte) 0xCA, (byte) 0xFE, (byte) 0xBA, (byte) 0xBE}; + return bytes.length > 4 && Arrays.equals(Arrays.copyOfRange(bytes, 0, 4), byte1); + } + }, + //torrent 64 38 3A 61 6E 6E 6F 75 6E 63 65 + TORRENT("application/x-bittorrent", "torrent") { + @Override + public boolean match(final byte[] bytes) { + final byte[] byte1 = new byte[]{(byte) 0x64, (byte) 0x38, (byte) 0x3A, (byte) 0x61, (byte) 0x6E, (byte) 0x6E, (byte) 0x6F, (byte) 0x75, (byte) 0x6E, (byte) 0x63, (byte) 0x65}; + return bytes.length > 11 && Arrays.equals(Arrays.copyOfRange(bytes, 0, 11), byte1); + } + }, + WPD("application/vnd.wordperfect", "wpd") { + @Override + public boolean match(final byte[] bytes) { + final byte[] byte1 = new byte[]{(byte) 0xFF, (byte) 0x57, (byte) 0x50, (byte) 0x43}; + return bytes.length > 4 && Arrays.equals(Arrays.copyOfRange(bytes, 0, 4), byte1); + } + }, + DBX("", "dbx") { + @Override + public boolean match(final byte[] bytes) { + final byte[] byte1 = new byte[]{(byte) 0xCF, (byte) 0xAD, (byte) 0x12, (byte) 0xFE}; + return bytes.length > 4 && Arrays.equals(Arrays.copyOfRange(bytes, 0, 4), byte1); + } + }, + PST("application/vnd.ms-outlook-pst", "pst") { + @Override + public boolean match(final byte[] bytes) { + final byte[] byte1 = new byte[]{(byte) 0x21, (byte) 0x42, (byte) 0x44, (byte) 0x4E}; + return bytes.length > 4 && Arrays.equals(Arrays.copyOfRange(bytes, 0, 4), byte1); + } + }, + RAM("audio/x-pn-realaudio", "ram") { + @Override + public boolean match(final byte[] bytes) { + final byte[] byte1 = new byte[]{(byte) 0x2E, (byte) 0x72, (byte) 0x61, (byte) 0xFD, (byte) 0x00}; + return bytes.length > 5 && Arrays.equals(Arrays.copyOfRange(bytes, 0, 5), byte1); + } + } + //other end --------------------------------------------------------------- + ; + private final String mimeType; + private final String extension; + + FileMagicNumber(final String mimeType, final String extension) { + this.mimeType = mimeType; + this.extension = extension; + } + + public static FileMagicNumber getMagicNumber(final byte[] bytes) { + final FileMagicNumber number = Arrays.stream(values()) + .filter(fileMagicNumber -> fileMagicNumber.match(bytes)) + .findFirst() + .orElse(UNKNOWN); + if (number.equals(FileMagicNumber.ZIP)) { + final FileMagicNumber fn = FileMagicNumber.matchDocument(bytes); + return fn == UNKNOWN ? ZIP : fn; + } + return number; + } + + public String getMimeType() { + return mimeType; + } + + public String getExtension() { + return extension; + } + + private static int indexOf(final byte[] array, final byte[] target) { + if (array == null || target == null || array.length < target.length) { + return -1; + } + if (target.length == 0) { + return 0; + } else { + label1: + for (int i = 0; i < array.length - target.length + 1; ++i) { + for (int j = 0; j < target.length; ++j) { + if (array[i + j] != target[j]) { + continue label1; + } + } + return i; + } + return -1; + } + } + + //处理 Open XML 类型的文件 + private static boolean compareBytes(final byte[] buf, final byte[] slice, final int startOffset) { + final int sl = slice.length; + if (startOffset + sl > buf.length) { + return false; + } + final byte[] sub = Arrays.copyOfRange(buf, startOffset, startOffset + sl); + return Arrays.equals(sub, slice); + } + + private static FileMagicNumber matchOpenXmlMime(final byte[] bytes, final int offset) { + final byte[] word = new byte[]{'w', 'o', 'r', 'd', '/'}; + final byte[] ppt = new byte[]{'p', 'p', 't', '/'}; + final byte[] xl = new byte[]{'x', 'l', '/'}; + if (FileMagicNumber.compareBytes(bytes, word, offset)) { + return FileMagicNumber.DOCX; + } + if (FileMagicNumber.compareBytes(bytes, ppt, offset)) { + return FileMagicNumber.PPTX; + } + if (FileMagicNumber.compareBytes(bytes, xl, offset)) { + return FileMagicNumber.XLSX; + } + return FileMagicNumber.UNKNOWN; + } + + private static FileMagicNumber matchDocument(final byte[] bytes) { + final FileMagicNumber fileMagicNumber = FileMagicNumber.matchOpenXmlMime(bytes, (byte) 0x1e); + if (false == fileMagicNumber.equals(UNKNOWN)) { + return fileMagicNumber; + } + final byte[] bytes1 = new byte[]{0x5B, 0x43, 0x6F, 0x6E, 0x74, 0x65, 0x6E, 0x74, 0x5F, 0x54, 0x79, 0x70, 0x65, 0x73, 0x5D, 0x2E, 0x78, 0x6D, 0x6C}; + final byte[] bytes2 = new byte[]{0x5F, 0x72, 0x65, 0x6C, 0x73, 0x2F, 0x2E, 0x72, 0x65, 0x6C, 0x73}; + final byte[] bytes3 = new byte[]{0x64, 0x6F, 0x63, 0x50, 0x72, 0x6F, 0x70, 0x73}; + final boolean flag1 = FileMagicNumber.compareBytes(bytes, bytes1, (byte) 0x1e); + final boolean flag2 = FileMagicNumber.compareBytes(bytes, bytes2, (byte) 0x1e); + final boolean flag3 = FileMagicNumber.compareBytes(bytes, bytes3, (byte) 0x1e); + if (false == (flag1 || flag2 || flag3)) { + return UNKNOWN; + } + int index = 0; + for (int i = 0; i < 4; i++) { + index = searchSignature(bytes, index + 4, 6000); + if (index == -1) { + continue; + } + final FileMagicNumber fn = FileMagicNumber.matchOpenXmlMime(bytes, index + 30); + if (false == fn.equals(UNKNOWN)) { + return fn; + } + } + return UNKNOWN; + } + + private static int searchSignature(final byte[] bytes, final int start, final int rangeNum) { + final byte[] signature = new byte[]{0x50, 0x4B, 0x03, 0x04}; + final int length = bytes.length; + int end = start + rangeNum; + if (end > length) { + end = length; + } + final int index = FileMagicNumber.indexOf(Arrays.copyOfRange(bytes, start, end), signature); + return (index == -1) + ? -1 + : (start + index); + } + + public abstract boolean match(byte[] bytes); + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FileTypeUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FileTypeUtil.java new file mode 100644 index 0000000..28479cf --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FileTypeUtil.java @@ -0,0 +1,244 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.util.HexUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.*; +import java.util.Map; +import java.util.Map.Entry; +import java.util.concurrent.ConcurrentSkipListMap; + +/** + * 文件类型判断工具类 + * + *

此工具根据文件的前几位bytes猜测文件类型，对于文本、zip判断不准确，对于视频、图片类型判断准确

+ * + *

需要注意的是，xlsx、docx等Office2007格式，全部识别为zip，因为新版采用了OpenXML格式，这些格式本质上是XML文件打包为zip

+ * + * @author Looly + */ +public class FileTypeUtil { + + private static final Map FILE_TYPE_MAP = new ConcurrentSkipListMap<>(); + + /** + * 增加文件类型映射
+ * 如果已经存在将覆盖之前的映射 + * + * @param fileStreamHexHead 文件流头部Hex信息 + * @param extName 文件扩展名 + * @return 之前已经存在的文件扩展名 + */ + public static String putFileType(String fileStreamHexHead, String extName) { + return FILE_TYPE_MAP.put(fileStreamHexHead, extName); + } + + /** + * 移除文件类型映射 + * + * @param fileStreamHexHead 文件流头部Hex信息 + * @return 移除的文件扩展名 + */ + public static String removeFileType(String fileStreamHexHead) { + return FILE_TYPE_MAP.remove(fileStreamHexHead); + } + + /** + * 根据文件流的头部信息获得文件类型 + * + * @param fileStreamHexHead 文件流头部16进制字符串 + * @return 文件类型，未找到为{@code null} + */ + public static String getType(String fileStreamHexHead) { + for (Entry fileTypeEntry : FILE_TYPE_MAP.entrySet()) { + if (StrUtil.startWithIgnoreCase(fileStreamHexHead, fileTypeEntry.getKey())) { + return fileTypeEntry.getValue(); + } + } + byte[] bytes = (HexUtil.decodeHex(fileStreamHexHead)); + return FileMagicNumber.getMagicNumber(bytes).getExtension(); + } + + /** + * 根据文件流的头部信息获得文件类型 + * + * @param in 文件流 + * @param fileHeadSize 自定义读取文件头部的大小 + * @return 文件类型，未找到为{@code null} + */ + public static String getType(InputStream in,int fileHeadSize) throws IORuntimeException { + return getType((IoUtil.readHex(in, fileHeadSize,false))); + } + + /** + * 根据文件流的头部信息获得文件类型
+ * 注意此方法会读取头部一些bytes，造成此流接下来读取时缺少部分bytes
+ * 因此如果想服用此流，流需支持{@link InputStream#reset()}方法。 + * @param in {@link InputStream} + * @param isExact 是否精确匹配，如果为false，使用前64个bytes匹配，如果为true，使用前8192bytes匹配 + * @return 类型，文件的扩展名，未找到为{@code null} + * @throws IORuntimeException 读取流引起的异常 + */ + public static String getType(InputStream in,boolean isExact) throws IORuntimeException { + return isExact + ?getType(IoUtil.readHex8192Upper(in)) + :getType(IoUtil.readHex64Upper(in)); + } + + /** + * 根据文件流的头部信息获得文件类型
+ * 注意此方法会读取头部64个bytes，造成此流接下来读取时缺少部分bytes
+ * 因此如果想服用此流，流需支持{@link InputStream#reset()}方法。 + * @param in {@link InputStream} + * @return 类型，文件的扩展名，未找到为{@code null} + * @throws IORuntimeException 读取流引起的异常 + */ + public static String getType(InputStream in) throws IORuntimeException { + return getType(in,false); + } + + /** + * 根据文件流的头部信息获得文件类型 + * 注意此方法会读取头部64个bytes，造成此流接下来读取时缺少部分bytes
+ * 因此如果想服用此流，流需支持{@link InputStream#reset()}方法。 + * + * 
+	 *     1、无法识别类型默认按照扩展名识别
+	 *     2、xls、doc、msi头信息无法区分，按照扩展名区分
+	 *     3、zip可能为docx、xlsx、pptx、jar、war、ofd头信息无法区分，按照扩展名区分
+	 *
+ * + * @param in {@link InputStream} + * @param filename 文件名 + * @return 类型，文件的扩展名，未找到为{@code null} + * @throws IORuntimeException 读取流引起的异常 + */ + public static String getType(InputStream in, String filename) throws IORuntimeException { + return getType(in,filename,false); + } + + /** + * 根据文件流的头部信息获得文件类型 + * 注意此方法会读取头部一些bytes，造成此流接下来读取时缺少部分bytes
+ * 因此如果想服用此流，流需支持{@link InputStream#reset()}方法。 + * + * 
+	 *     1、无法识别类型默认按照扩展名识别
+	 *     2、xls、doc、msi头信息无法区分，按照扩展名区分
+	 *     3、zip可能为docx、xlsx、pptx、jar、war、ofd头信息无法区分，按照扩展名区分
+	 *
+ * @param in {@link InputStream} + * @param filename 文件名 + * @param isExact 是否精确匹配，如果为false，使用前64个bytes匹配，如果为true，使用前8192bytes匹配 + * @return 类型，文件的扩展名，未找到为{@code null} + * @throws IORuntimeException 读取流引起的异常 + */ + public static String getType(InputStream in, String filename,boolean isExact) throws IORuntimeException { + String typeName = getType(in,isExact); + if (null == typeName) { + // 未成功识别类型，扩展名辅助识别 + typeName = FileUtil.extName(filename); + } else if ("zip".equals(typeName)) { + // zip可能为docx、xlsx、pptx、jar、war、ofd等格式，扩展名辅助判断 + final String extName = FileUtil.extName(filename); + if ("docx".equalsIgnoreCase(extName)) { + typeName = "docx"; + } else if ("xlsx".equalsIgnoreCase(extName)) { + typeName = "xlsx"; + } else if ("pptx".equalsIgnoreCase(extName)) { + typeName = "pptx"; + } else if ("jar".equalsIgnoreCase(extName)) { + typeName = "jar"; + } else if ("war".equalsIgnoreCase(extName)) { + typeName = "war"; + } else if ("ofd".equalsIgnoreCase(extName)) { + typeName = "ofd"; + } else if ("apk".equalsIgnoreCase(extName)) { + typeName = "apk"; + } + } else if ("jar".equals(typeName)) { + // wps编辑过的.xlsx文件与.jar的开头相同,通过扩展名判断 + final String extName = FileUtil.extName(filename); + if ("xlsx".equalsIgnoreCase(extName)) { + typeName = "xlsx"; + } else if ("docx".equalsIgnoreCase(extName)) { + // issue#I47JGH + typeName = "docx"; + } else if ("pptx".equalsIgnoreCase(extName)) { + // issue#I5A0GO + typeName = "pptx"; + } else if ("zip".equalsIgnoreCase(extName)) { + typeName = "zip"; + } else if ("apk".equalsIgnoreCase(extName)) { + typeName = "apk"; + } + } + return typeName; + } + + /** + * 根据文件流的头部信息获得文件类型 + * + * 
+	 *     1、无法识别类型默认按照扩展名识别
+	 *     2、xls、doc、msi头信息无法区分，按照扩展名区分
+	 *     3、zip可能为jar、war头信息无法区分，按照扩展名区分
+	 *
+ * + * @param file 文件 {@link File} + * @param isExact 是否精确匹配，如果为false，使用前64个bytes匹配，如果为true，使用前8192bytes匹配 + * @return 类型，文件的扩展名，未找到为{@code null} + * @throws IORuntimeException 读取文件引起的异常 + */ + public static String getType(File file,boolean isExact) throws IORuntimeException { + FileInputStream in = null; + try { + in = IoUtil.toStream(file); + return getType(in, file.getName(),isExact); + } finally { + IoUtil.close(in); + } + } + + /** + * 根据文件流的头部信息获得文件类型 + * + * 
+	 *     1、无法识别类型默认按照扩展名识别
+	 *     2、xls、doc、msi头信息无法区分，按照扩展名区分
+	 *     3、zip可能为jar、war头信息无法区分，按照扩展名区分
+	 *
+ * + * @param file 文件 {@link File} + * @return 类型，文件的扩展名，未找到为{@code null} + * @throws IORuntimeException 读取文件引起的异常 + */ + public static String getType(File file) throws IORuntimeException { + return getType(file,false); + } + + /** + * 通过路径获得文件类型 + * + * @param path 路径，绝对路径或相对ClassPath的路径 + * @param isExact 是否精确匹配，如果为false，使用前64个bytes匹配，如果为true，使用前8192bytes匹配 + * @return 类型 + * @throws IORuntimeException 读取文件引起的异常 + */ + public static String getTypeByPath(String path,boolean isExact) throws IORuntimeException { + return getType(FileUtil.file(path),isExact); + } + + /** + * 通过路径获得文件类型 + * + * @param path 路径，绝对路径或相对ClassPath的路径 + * @return 类型 + * @throws IORuntimeException 读取文件引起的异常 + */ + public static String getTypeByPath(String path) throws IORuntimeException { + return getTypeByPath(path,false); + } + + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FileUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FileUtil.java new file mode 100755 index 0000000..60f19c3 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/FileUtil.java @@ -0,0 +1,3595 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.io.file.FileCopier; +import aiyh.utils.tool.cn.hutool.core.io.file.FileMode; +import aiyh.utils.tool.cn.hutool.core.io.file.FileNameUtil; +import aiyh.utils.tool.cn.hutool.core.io.file.FileReader; +import aiyh.utils.tool.cn.hutool.core.io.file.FileReader.ReaderHandler; +import aiyh.utils.tool.cn.hutool.core.io.file.FileWriter; +import aiyh.utils.tool.cn.hutool.core.io.file.LineSeparator; +import aiyh.utils.tool.cn.hutool.core.io.file.PathUtil; +import aiyh.utils.tool.cn.hutool.core.io.file.Tailer; +import aiyh.utils.tool.cn.hutool.core.io.resource.ResourceUtil; +import aiyh.utils.tool.cn.hutool.core.io.unit.DataSizeUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.thread.ThreadUtil; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; +import aiyh.utils.tool.cn.hutool.core.util.ZipUtil; + +import java.io.BufferedInputStream; +import java.io.BufferedOutputStream; +import java.io.BufferedReader; +import java.io.BufferedWriter; +import java.io.File; +import java.io.FileFilter; +import java.io.FileInputStream; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.LineNumberReader; +import java.io.OutputStream; +import java.io.PrintWriter; +import java.io.RandomAccessFile; +import java.io.Reader; +import java.net.URI; +import java.net.URL; +import java.net.URLConnection; +import java.nio.charset.Charset; +import java.nio.file.DirectoryNotEmptyException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.nio.file.StandardCopyOption; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Date; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.function.Consumer; +import java.util.jar.JarFile; +import java.util.regex.Pattern; +import java.util.zip.CRC32; +import java.util.zip.Checksum; + +/** + * 文件工具类 + * + * @author looly + */ +public class FileUtil extends PathUtil { + + /** + * Class文件扩展名 + */ + public static final String CLASS_EXT = FileNameUtil.EXT_CLASS; + /** + * Jar文件扩展名 + */ + public static final String JAR_FILE_EXT = FileNameUtil.EXT_JAR; + /** + * 在Jar中的路径jar的扩展名形式 + */ + public static final String JAR_PATH_EXT = ".jar!"; + /** + * 当Path为文件形式时, path会加入一个表示文件的前缀 + */ + public static final String PATH_FILE_PRE = URLUtil.FILE_URL_PREFIX; + /** + * 文件路径分隔符
+ * 在Unix和Linux下 是{@code '/'}; 在Windows下是 {@code '\'} + */ + public static final String FILE_SEPARATOR = File.separator; + /** + * 多个PATH之间的分隔符
+ * 在Unix和Linux下 是{@code ':'}; 在Windows下是 {@code ';'} + */ + public static final String PATH_SEPARATOR = File.pathSeparator; + /** + * 绝对路径判断正则 + */ + private static final Pattern PATTERN_PATH_ABSOLUTE = Pattern.compile("^[a-zA-Z]:([/\\\\].*)?"); + + + /** + * 是否为Windows环境 + * + * @return 是否为Windows环境 + * @since 3.0.9 + */ + public static boolean isWindows() { + return FileNameUtil.WINDOWS_SEPARATOR == File.separatorChar; + } + + /** + * 列出指定路径下的目录和文件
+ * 给定的绝对路径不能是压缩包中的路径 + * + * @param path 目录绝对路径或者相对路径 + * @return 文件列表（包含目录） + */ + public static File[] ls(String path) { + if (path == null) { + return null; + } + + File file = file(path); + if (file.isDirectory()) { + return file.listFiles(); + } + throw new IORuntimeException(StrUtil.format("Path [{}] is not directory!", path)); + } + + /** + * 文件是否为空
+ * 目录：里面没有文件时为空 文件：文件大小为0时为空 + * + * @param file 文件 + * @return 是否为空，当提供非目录时，返回false + */ + public static boolean isEmpty(File file) { + if (null == file || false == file.exists()) { + return true; + } + + if (file.isDirectory()) { + String[] subFiles = file.list(); + return ArrayUtil.isEmpty(subFiles); + } else if (file.isFile()) { + return file.length() <= 0; + } + + return false; + } + + /** + * 目录是否为空 + * + * @param file 目录 + * @return 是否为空，当提供非目录时，返回false + */ + public static boolean isNotEmpty(File file) { + return false == isEmpty(file); + } + + /** + * 目录是否为空 + * + * @param dir 目录 + * @return 是否为空 + */ + public static boolean isDirEmpty(File dir) { + return isDirEmpty(dir.toPath()); + } + + /** + * 递归遍历目录以及子目录中的所有文件
+ * 如果提供file为文件，直接返回过滤结果 + * + * @param path 当前遍历文件或目录的路径 + * @param fileFilter 文件过滤规则对象，选择要保留的文件，只对文件有效，不过滤目录 + * @return 文件列表 + * @since 3.2.0 + */ + public static List loopFiles(String path, FileFilter fileFilter) { + return loopFiles(file(path), fileFilter); + } + + /** + * 递归遍历目录以及子目录中的所有文件
+ * 如果提供file为文件，直接返回过滤结果 + * + * @param file 当前遍历文件或目录 + * @param fileFilter 文件过滤规则对象，选择要保留的文件，只对文件有效，不过滤目录 + * @return 文件列表 + */ + public static List loopFiles(File file, FileFilter fileFilter) { + return loopFiles(file, -1, fileFilter); + } + + /** + * 递归遍历目录并处理目录下的文件，可以处理目录或文件： + *
    + *
  • 非目录则直接调用{@link Consumer}处理
    • + *
  • 目录则递归调用此方法处理
    • + *
+ * + * @param file 文件或目录，文件直接处理 + * @param consumer 文件处理器，只会处理文件 + * @since 5.5.2 + */ + public static void walkFiles(File file, Consumer consumer) { + if (file.isDirectory()) { + final File[] subFiles = file.listFiles(); + if (ArrayUtil.isNotEmpty(subFiles)) { + for (File tmp : subFiles) { + walkFiles(tmp, consumer); + } + } + } else { + consumer.accept(file); + } + } + + /** + * 递归遍历目录以及子目录中的所有文件
+ * 如果提供file为文件，直接返回过滤结果 + * + * @param file 当前遍历文件或目录 + * @param maxDepth 遍历最大深度，-1表示遍历到没有目录为止 + * @param fileFilter 文件过滤规则对象，选择要保留的文件，只对文件有效，不过滤目录，null表示接收全部文件 + * @return 文件列表 + * @since 4.6.3 + */ + public static List loopFiles(File file, int maxDepth, FileFilter fileFilter) { + return loopFiles(file.toPath(), maxDepth, fileFilter); + } + + /** + * 递归遍历目录以及子目录中的所有文件
+ * 如果用户传入相对路径，则是相对classpath的路径
+ * 如："test/aaa"表示"${classpath}/test/aaa" + * + * @param path 相对ClassPath的目录或者绝对路径目录 + * @return 文件列表 + * @since 3.2.0 + */ + public static List loopFiles(String path) { + return loopFiles(file(path)); + } + + /** + * 递归遍历目录以及子目录中的所有文件 + * + * @param file 当前遍历文件 + * @return 文件列表 + */ + public static List loopFiles(File file) { + return loopFiles(file, null); + } + + /** + * 获得指定目录下所有文件
+ * 不会扫描子目录
+ * 如果用户传入相对路径，则是相对classpath的路径
+ * 如："test/aaa"表示"${classpath}/test/aaa" + * + * @param path 相对ClassPath的目录或者绝对路径目录 + * @return 文件路径列表（如果是jar中的文件，则给定类似.jar!/xxx/xxx的路径） + * @throws IORuntimeException IO异常 + */ + public static List listFileNames(String path) throws IORuntimeException { + if (path == null) { + return new ArrayList<>(0); + } + int index = path.lastIndexOf(FileUtil.JAR_PATH_EXT); + if (index < 0) { + // 普通目录 + final List paths = new ArrayList<>(); + final File[] files = ls(path); + for (File file : files) { + if (file.isFile()) { + paths.add(file.getName()); + } + } + return paths; + } + + // jar文件 + path = getAbsolutePath(path); + // jar文件中的路径 + index = index + FileUtil.JAR_FILE_EXT.length(); + JarFile jarFile = null; + try { + jarFile = new JarFile(path.substring(0, index)); + // 防止出现jar!/cn/hutool/这类路径导致文件找不到 + return ZipUtil.listFileNames(jarFile, StrUtil.removePrefix(path.substring(index + 1), "/")); + } catch (IOException e) { + throw new IORuntimeException(StrUtil.format("Can not read file path of [{}]", path), e); + } finally { + IoUtil.close(jarFile); + } + } + + /** + * 创建File对象，相当于调用new File()，不做任何处理 + * + * @param path 文件路径，相对路径表示相对项目路径 + * @return File + * @since 4.1.4 + */ + public static File newFile(String path) { + return new File(path); + } + + /** + * 创建File对象，自动识别相对或绝对路径，相对路径将自动从ClassPath下寻找 + * + * @param path 相对ClassPath的目录或者绝对路径目录 + * @return File + */ + public static File file(String path) { + if (null == path) { + return null; + } + return new File(getAbsolutePath(path)); + } + + /** + * 创建File对象
+ * 此方法会检查slip漏洞，漏洞说明见http://blog.nsfocus.net/zip-slip-2/ + * + * @param parent 父目录 + * @param path 文件路径 + * @return File + */ + public static File file(String parent, String path) { + return file(new File(parent), path); + } + + /** + * 创建File对象
+ * 根据的路径构建文件，在Win下直接构建，在Linux下拆分路径单独构建 + * 此方法会检查slip漏洞，漏洞说明见http://blog.nsfocus.net/zip-slip-2/ + * + * @param parent 父文件对象 + * @param path 文件路径 + * @return File + */ + public static File file(File parent, String path) { + if (StrUtil.isBlank(path)) { + throw new NullPointerException("File path is blank!"); + } + return checkSlip(parent, buildFile(parent, path)); + } + + /** + * 通过多层目录参数创建文件
+ * 此方法会检查slip漏洞，漏洞说明见http://blog.nsfocus.net/zip-slip-2/ + * + * @param directory 父目录 + * @param names 元素名（多层目录名），由外到内依次传入 + * @return the file 文件 + * @since 4.0.6 + */ + public static File file(File directory, String... names) { + Assert.notNull(directory, "directory must not be null"); + if (ArrayUtil.isEmpty(names)) { + return directory; + } + + File file = directory; + for (String name : names) { + if (null != name) { + file = file(file, name); + } + } + return file; + } + + /** + * 通过多层目录创建文件 + *

+ * 元素名（多层目录名） + * + * @param names 多层文件的文件名，由外到内依次传入 + * @return the file 文件 + * @since 4.0.6 + */ + public static File file(String... names) { + if (ArrayUtil.isEmpty(names)) { + return null; + } + + File file = null; + for (String name : names) { + if (file == null) { + file = file(name); + } else { + file = file(file, name); + } + } + return file; + } + + /** + * 创建File对象 + * + * @param uri 文件URI + * @return File + */ + public static File file(URI uri) { + if (uri == null) { + throw new NullPointerException("File uri is null!"); + } + return new File(uri); + } + + /** + * 创建File对象 + * + * @param url 文件URL + * @return File + */ + public static File file(URL url) { + return new File(URLUtil.toURI(url)); + } + + /** + * 获取临时文件路径（绝对路径） + * + * @return 临时文件路径 + * @since 4.0.6 + */ + public static String getTmpDirPath() { + return System.getProperty("java.io.tmpdir"); + } + + /** + * 获取临时文件目录 + * + * @return 临时文件目录 + * @since 4.0.6 + */ + public static File getTmpDir() { + return file(getTmpDirPath()); + } + + /** + * 获取用户路径（绝对路径） + * + * @return 用户路径 + * @since 4.0.6 + */ + public static String getUserHomePath() { + return System.getProperty("user.home"); + } + + /** + * 获取用户目录 + * + * @return 用户目录 + * @since 4.0.6 + */ + public static File getUserHomeDir() { + return file(getUserHomePath()); + } + + /** + * 判断文件是否存在，如果path为null，则返回false + * + * @param path 文件路径 + * @return 如果存在返回true + */ + public static boolean exist(String path) { + return (null != path) && file(path).exists(); + } + + /** + * 判断文件是否存在，如果file为null，则返回false + * + * @param file 文件 + * @return 如果存在返回true + */ + public static boolean exist(File file) { + return (null != file) && file.exists(); + } + + /** + * 是否存在匹配文件 + * + * @param directory 文件夹路径 + * @param regexp 文件夹中所包含文件名的正则表达式 + * @return 如果存在匹配文件返回true + */ + public static boolean exist(String directory, String regexp) { + final File file = new File(directory); + if (false == file.exists()) { + return false; + } + + final String[] fileList = file.list(); + if (fileList == null) { + return false; + } + + for (String fileName : fileList) { + if (fileName.matches(regexp)) { + return true; + } + + } + return false; + } + + /** + * 指定文件最后修改时间 + * + * @param file 文件 + * @return 最后修改时间 + */ + public static Date lastModifiedTime(File file) { + if (false == exist(file)) { + return null; + } + + return new Date(file.lastModified()); + } + + /** + * 指定路径文件最后修改时间 + * + * @param path 绝对路径 + * @return 最后修改时间 + */ + public static Date lastModifiedTime(String path) { + return lastModifiedTime(new File(path)); + } + + /** + * 计算目录或文件的总大小
+ * 当给定对象为文件时，直接调用 {@link File#length()}
+ * 当给定对象为目录时，遍历目录下的所有文件和目录，递归计算其大小，求和返回
+ * 此方法不包括目录本身的占用空间大小。 + * + * @param file 目录或文件,null或者文件不存在返回0 + * @return 总大小，bytes长度 + */ + public static long size(File file) { + return size(file, false); + } + + /** + * 计算目录或文件的总大小
+ * 当给定对象为文件时，直接调用 {@link File#length()}
+ * 当给定对象为目录时，遍历目录下的所有文件和目录，递归计算其大小，求和返回 + * + * @param file 目录或文件,null或者文件不存在返回0 + * @param includeDirSize 是否包括每层目录本身的大小 + * @return 总大小，bytes长度 + * @since 5.7.21 + */ + public static long size(File file, boolean includeDirSize) { + if (null == file || false == file.exists() || isSymlink(file)) { + return 0; + } + + if (file.isDirectory()) { + long size = includeDirSize ? file.length() : 0; + File[] subFiles = file.listFiles(); + if (ArrayUtil.isEmpty(subFiles)) { + return 0L;// empty directory + } + for (File subFile : subFiles) { + size += size(subFile, includeDirSize); + } + return size; + } else { + return file.length(); + } + } + + /** + * 计算文件的总行数
+ * 读取文件采用系统默认编码，一般乱码不会造成行数错误。 + * + * @param file 文件 + * @return 该文件总行数 + * @since 5.7.22 + */ + public static int getTotalLines(File file) { + if (false == isFile(file)) { + throw new IORuntimeException("Input must be a File"); + } + try (final LineNumberReader lineNumberReader = new LineNumberReader(new java.io.FileReader(file))) { + // 设置起始为1 + lineNumberReader.setLineNumber(1); + // 跳过文件中内容 + //noinspection ResultOfMethodCallIgnored + lineNumberReader.skip(Long.MAX_VALUE); + // 获取当前行号 + return lineNumberReader.getLineNumber(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 给定文件或目录的最后修改时间是否晚于给定时间 + * + * @param file 文件或目录 + * @param reference 参照文件 + * @return 是否晚于给定时间 + */ + public static boolean newerThan(File file, File reference) { + if (null == reference || false == reference.exists()) { + return true;// 文件一定比一个不存在的文件新 + } + return newerThan(file, reference.lastModified()); + } + + /** + * 给定文件或目录的最后修改时间是否晚于给定时间 + * + * @param file 文件或目录 + * @param timeMillis 做为对比的时间 + * @return 是否晚于给定时间 + */ + public static boolean newerThan(File file, long timeMillis) { + if (null == file || false == file.exists()) { + return false;// 不存在的文件一定比任何时间旧 + } + return file.lastModified() > timeMillis; + } + + /** + * 创建文件及其父目录，如果这个文件存在，直接返回这个文件
+ * 此方法不对File对象类型做判断，如果File不存在，无法判断其类型 + * + * @param path 相对ClassPath的目录或者绝对路径目录，使用POSIX风格 + * @return 文件，若路径为null，返回null + * @throws IORuntimeException IO异常 + */ + public static File touch(String path) throws IORuntimeException { + if (path == null) { + return null; + } + return touch(file(path)); + } + + /** + * 创建文件及其父目录，如果这个文件存在，直接返回这个文件
+ * 此方法不对File对象类型做判断，如果File不存在，无法判断其类型 + * + * @param file 文件对象 + * @return 文件，若路径为null，返回null + * @throws IORuntimeException IO异常 + */ + public static File touch(File file) throws IORuntimeException { + if (null == file) { + return null; + } + if (false == file.exists()) { + mkParentDirs(file); + try { + //noinspection ResultOfMethodCallIgnored + file.createNewFile(); + } catch (Exception e) { + throw new IORuntimeException(e); + } + } + return file; + } + + /** + * 创建文件及其父目录，如果这个文件存在，直接返回这个文件
+ * 此方法不对File对象类型做判断，如果File不存在，无法判断其类型 + * + * @param parent 父文件对象 + * @param path 文件路径 + * @return File + * @throws IORuntimeException IO异常 + */ + public static File touch(File parent, String path) throws IORuntimeException { + return touch(file(parent, path)); + } + + /** + * 创建文件及其父目录，如果这个文件存在，直接返回这个文件
+ * 此方法不对File对象类型做判断，如果File不存在，无法判断其类型 + * + * @param parent 父文件对象 + * @param path 文件路径 + * @return File + * @throws IORuntimeException IO异常 + */ + public static File touch(String parent, String path) throws IORuntimeException { + return touch(file(parent, path)); + } + + /** + * 创建所给文件或目录的父目录 + * + * @param file 文件或目录 + * @return 父目录 + */ + public static File mkParentDirs(File file) { + if (null == file) { + return null; + } + return mkdir(getParent(file, 1)); + } + + /** + * 创建父文件夹，如果存在直接返回此文件夹 + * + * @param path 文件夹路径，使用POSIX格式，无论哪个平台 + * @return 创建的目录 + */ + public static File mkParentDirs(String path) { + if (path == null) { + return null; + } + return mkParentDirs(file(path)); + } + + /** + * 删除文件或者文件夹
+ * 路径如果为相对路径，会转换为ClassPath路径！ 注意：删除文件夹时不会判断文件夹是否为空，如果不空则递归删除子文件或文件夹
+ * 某个文件删除失败会终止删除操作 + * + * @param fullFileOrDirPath 文件或者目录的路径 + * @return 成功与否 + * @throws IORuntimeException IO异常 + */ + public static boolean del(String fullFileOrDirPath) throws IORuntimeException { + return del(file(fullFileOrDirPath)); + } + + /** + * 删除文件或者文件夹
+ * 注意：删除文件夹时不会判断文件夹是否为空，如果不空则递归删除子文件或文件夹
+ * 某个文件删除失败会终止删除操作 + * + *

+ * 从5.7.6开始，删除文件使用{@link Files#delete(Path)}代替 {@link File#delete()}
+ * 因为前者遇到文件被占用等原因时，抛出异常，而非返回false，异常会指明具体的失败原因。 + *

+ * + * @param file 文件对象 + * @return 成功与否 + * @throws IORuntimeException IO异常 + * @see Files#delete(Path) + */ + public static boolean del(File file) throws IORuntimeException { + if (file == null || false == file.exists()) { + // 如果文件不存在或已被删除，此处返回true表示删除成功 + return true; + } + + if (file.isDirectory()) { + // 清空目录下所有文件和目录 + boolean isOk = clean(file); + if (false == isOk) { + return false; + } + } + + // 删除文件或清空后的目录 + final Path path = file.toPath(); + try { + delFile(path); + } catch (DirectoryNotEmptyException e) { + // 遍历清空目录没有成功，此时补充删除一次（可能存在部分软链） + del(path); + } catch (IOException e) { + throw new IORuntimeException(e); + } + + return true; + } + + /** + * 清空文件夹
+ * 注意：清空文件夹时不会判断文件夹是否为空，如果不空则递归删除子文件或文件夹
+ * 某个文件删除失败会终止删除操作 + * + * @param dirPath 文件夹路径 + * @return 成功与否 + * @throws IORuntimeException IO异常 + * @since 4.0.8 + */ + public static boolean clean(String dirPath) throws IORuntimeException { + return clean(file(dirPath)); + } + + /** + * 清空文件夹
+ * 注意：清空文件夹时不会判断文件夹是否为空，如果不空则递归删除子文件或文件夹
+ * 某个文件删除失败会终止删除操作 + * + * @param directory 文件夹 + * @return 成功与否 + * @throws IORuntimeException IO异常 + * @since 3.0.6 + */ + public static boolean clean(File directory) throws IORuntimeException { + if (directory == null || directory.exists() == false || false == directory.isDirectory()) { + return true; + } + + final File[] files = directory.listFiles(); + if (null != files) { + for (File childFile : files) { + if (false == del(childFile)) { + // 删除一个出错则本次删除任务失败 + return false; + } + } + } + return true; + } + + /** + * 清理空文件夹
+ * 此方法用于递归删除空的文件夹，不删除文件
+ * 如果传入的文件夹本身就是空的，删除这个文件夹 + * + * @param directory 文件夹 + * @return 成功与否 + * @throws IORuntimeException IO异常 + * @since 4.5.5 + */ + public static boolean cleanEmpty(File directory) throws IORuntimeException { + if (directory == null || false == directory.exists() || false == directory.isDirectory()) { + return true; + } + + final File[] files = directory.listFiles(); + if (ArrayUtil.isEmpty(files)) { + // 空文件夹则删除之 + return directory.delete(); + } + + for (File childFile : files) { + cleanEmpty(childFile); + } + return true; + } + + /** + * 创建文件夹，如果存在直接返回此文件夹
+ * 此方法不对File对象类型做判断，如果File不存在，无法判断其类型 + * + * @param dirPath 文件夹路径，使用POSIX格式，无论哪个平台 + * @return 创建的目录 + */ + public static File mkdir(String dirPath) { + if (dirPath == null) { + return null; + } + final File dir = file(dirPath); + return mkdir(dir); + } + + /** + * 创建文件夹，会递归自动创建其不存在的父文件夹，如果存在直接返回此文件夹
+ * 此方法不对File对象类型做判断，如果File不存在，无法判断其类型
+ * + * @param dir 目录 + * @return 创建的目录 + */ + public static File mkdir(File dir) { + if (dir == null) { + return null; + } + if (false == dir.exists()) { + mkdirsSafely(dir, 5, 1); + } + return dir; + } + + /** + * 安全地级联创建目录 (确保并发环境下能创建成功) + * + * 
+	 *     并发环境下，假设 test 目录不存在，如果线程A mkdirs "test/A" 目录，线程B mkdirs "test/B"目录，
+	 *     其中一个线程可能会失败，进而导致以下代码抛出 FileNotFoundException 异常
+	 *
+	 *     file.getParentFile().mkdirs(); // 父目录正在被另一个线程创建中，返回 false
+	 *     file.createNewFile(); // 抛出 IO 异常，因为该线程无法感知到父目录已被创建
+	 *
+ * + * @param dir 待创建的目录 + * @param tryCount 最大尝试次数 + * @param sleepMillis 线程等待的毫秒数 + * @return true表示创建成功，false表示创建失败 + * @author z8g + * @since 5.7.21 + */ + public static boolean mkdirsSafely(File dir, int tryCount, long sleepMillis) { + if (dir == null) { + return false; + } + if (dir.isDirectory()) { + return true; + } + for (int i = 1; i <= tryCount; i++) { // 高并发场景下，可以看到 i 处于 1 ~ 3 之间 + // 如果文件已存在，也会返回 false，所以该值不能作为是否能创建的依据，因此不对其进行处理 + //noinspection ResultOfMethodCallIgnored + dir.mkdirs(); + if (dir.exists()) { + return true; + } + ThreadUtil.sleep(sleepMillis); + } + return dir.exists(); + } + + /** + * 创建临时文件
+ * 创建后的文件名为 prefix[Randon].tmp + * + * @param dir 临时文件创建的所在目录 + * @return 临时文件 + * @throws IORuntimeException IO异常 + */ + public static File createTempFile(File dir) throws IORuntimeException { + return createTempFile("hutool", null, dir, true); + } + + /** + * 在默认临时文件目录下创建临时文件，创建后的文件名为 prefix[Randon].tmp。 + * 默认临时文件目录由系统属性 {@code java.io.tmpdir} 指定。 + * 在 UNIX 系统上，此属性的默认值通常是 {@code "tmp"} 或 {@code "vartmp"}； + * 在 Microsoft Windows 系统上，它通常是 {@code "C:\\WINNT\\TEMP"}。 + * 调用 Java 虚拟机时，可以为该系统属性赋予不同的值，但不保证对该属性的编程更改对该方法使用的临时目录有任何影响。 + * + * @return 临时文件 + * @throws IORuntimeException IO异常 + * @since 5.7.22 + */ + public static File createTempFile() throws IORuntimeException { + return createTempFile("hutool", null, null, true); + } + + /** + * 在默认临时文件目录下创建临时文件，创建后的文件名为 prefix[Randon].suffix。 + * 默认临时文件目录由系统属性 {@code java.io.tmpdir} 指定。 + * 在 UNIX 系统上，此属性的默认值通常是 {@code "tmp"} 或 {@code "vartmp"}； + * 在 Microsoft Windows 系统上，它通常是 {@code "C:\\WINNT\\TEMP"}。 + * 调用 Java 虚拟机时，可以为该系统属性赋予不同的值，但不保证对该属性的编程更改对该方法使用的临时目录有任何影响。 + * + * @param suffix 后缀，如果null则使用默认.tmp + * @param isReCreat 是否重新创建文件（删掉原来的，创建新的） + * @return 临时文件 + * @throws IORuntimeException IO异常 + * @since 5.7.22 + */ + public static File createTempFile(String suffix, boolean isReCreat) throws IORuntimeException { + return createTempFile("hutool", suffix, null, isReCreat); + } + + /** + * 在默认临时文件目录下创建临时文件，创建后的文件名为 prefix[Randon].suffix。 + * 默认临时文件目录由系统属性 {@code java.io.tmpdir} 指定。 + * 在 UNIX 系统上，此属性的默认值通常是 {@code "tmp"} 或 {@code "vartmp"}； + * 在 Microsoft Windows 系统上，它通常是 {@code "C:\\WINNT\\TEMP"}。 + * 调用 Java 虚拟机时，可以为该系统属性赋予不同的值，但不保证对该属性的编程更改对该方法使用的临时目录有任何影响。 + * + * @param prefix 前缀，至少3个字符 + * @param suffix 后缀，如果null则使用默认.tmp + * @param isReCreat 是否重新创建文件（删掉原来的，创建新的） + * @return 临时文件 + * @throws IORuntimeException IO异常 + * @since 5.7.22 + */ + public static File createTempFile(String prefix, String suffix, boolean isReCreat) throws IORuntimeException { + return createTempFile(prefix, suffix, null, isReCreat); + } + + /** + * 创建临时文件
+ * 创建后的文件名为 prefix[Randon].tmp + * + * @param dir 临时文件创建的所在目录 + * @param isReCreat 是否重新创建文件（删掉原来的，创建新的） + * @return 临时文件 + * @throws IORuntimeException IO异常 + */ + public static File createTempFile(File dir, boolean isReCreat) throws IORuntimeException { + return createTempFile("hutool", null, dir, isReCreat); + } + + /** + * 创建临时文件
+ * 创建后的文件名为 prefix[Randon].suffix From com.jodd.io.FileUtil + * + * @param prefix 前缀，至少3个字符 + * @param suffix 后缀，如果null则使用默认.tmp + * @param dir 临时文件创建的所在目录 + * @param isReCreat 是否重新创建文件（删掉原来的，创建新的） + * @return 临时文件 + * @throws IORuntimeException IO异常 + */ + public static File createTempFile(String prefix, String suffix, File dir, boolean isReCreat) throws IORuntimeException { + int exceptionsCount = 0; + while (true) { + try { + File file = File.createTempFile(prefix, suffix, mkdir(dir)).getCanonicalFile(); + if (isReCreat) { + //noinspection ResultOfMethodCallIgnored + file.delete(); + //noinspection ResultOfMethodCallIgnored + file.createNewFile(); + } + return file; + } catch (IOException ioex) { // fixes java.io.WinNTFileSystem.createFileExclusively access denied + if (++exceptionsCount >= 50) { + throw new IORuntimeException(ioex); + } + } + } + } + + /** + * 通过JDK7+的 Files#copy(Path, Path, CopyOption...) 方法拷贝文件 + * + * @param src 源文件路径 + * @param dest 目标文件或目录路径，如果为目录使用与源文件相同的文件名 + * @param options {@link StandardCopyOption} + * @return File + * @throws IORuntimeException IO异常 + */ + public static File copyFile(String src, String dest, StandardCopyOption... options) throws IORuntimeException { + Assert.notBlank(src, "Source File path is blank !"); + Assert.notBlank(dest, "Destination File path is blank !"); + return copyFile(Paths.get(src), Paths.get(dest), options).toFile(); + } + + /** + * 通过JDK7+的 Files#copy(Path, Path, CopyOption...) 方法拷贝文件 + * + * @param src 源文件 + * @param dest 目标文件或目录，如果为目录使用与源文件相同的文件名 + * @param options {@link StandardCopyOption} + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public static File copyFile(File src, File dest, StandardCopyOption... options) throws IORuntimeException { + // check + Assert.notNull(src, "Source File is null !"); + if (false == src.exists()) { + throw new IORuntimeException("File not exist: " + src); + } + Assert.notNull(dest, "Destination File or directiory is null !"); + if (equals(src, dest)) { + throw new IORuntimeException("Files '{}' and '{}' are equal", src, dest); + } + return copyFile(src.toPath(), dest.toPath(), options).toFile(); + } + + /** + * 复制文件或目录
+ * 如果目标文件为目录，则将源文件以相同文件名拷贝到目标目录 + * + * @param srcPath 源文件或目录 + * @param destPath 目标文件或目录，目标不存在会自动创建（目录、文件都创建） + * @param isOverride 是否覆盖目标文件 + * @return 目标目录或文件 + * @throws IORuntimeException IO异常 + */ + public static File copy(String srcPath, String destPath, boolean isOverride) throws IORuntimeException { + return copy(file(srcPath), file(destPath), isOverride); + } + + /** + * 复制文件或目录
+ * 情况如下： + * + * 
+	 * 1、src和dest都为目录，则将src目录及其目录下所有文件目录拷贝到dest下
+	 * 2、src和dest都为文件，直接复制，名字为dest
+	 * 3、src为文件，dest为目录，将src拷贝到dest目录下
+	 *
+ * + * @param src 源文件 + * @param dest 目标文件或目录，目标不存在会自动创建（目录、文件都创建） + * @param isOverride 是否覆盖目标文件 + * @return 目标目录或文件 + * @throws IORuntimeException IO异常 + */ + public static File copy(File src, File dest, boolean isOverride) throws IORuntimeException { + return FileCopier.create(src, dest).setOverride(isOverride).copy(); + } + + /** + * 复制文件或目录
+ * 情况如下： + * + * 
+	 * 1、src和dest都为目录，则将src下所有文件目录拷贝到dest下
+	 * 2、src和dest都为文件，直接复制，名字为dest
+	 * 3、src为文件，dest为目录，将src拷贝到dest目录下
+	 *
+ * + * @param src 源文件 + * @param dest 目标文件或目录，目标不存在会自动创建（目录、文件都创建） + * @param isOverride 是否覆盖目标文件 + * @return 目标目录或文件 + * @throws IORuntimeException IO异常 + */ + public static File copyContent(File src, File dest, boolean isOverride) throws IORuntimeException { + return FileCopier.create(src, dest).setCopyContentIfDir(true).setOverride(isOverride).copy(); + } + + /** + * 复制文件或目录
+ * 情况如下： + * + * 
+	 * 1、src和dest都为目录，则将src下所有文件（包括子目录）拷贝到dest下
+	 * 2、src和dest都为文件，直接复制，名字为dest
+	 * 3、src为文件，dest为目录，将src拷贝到dest目录下
+	 *
+ * + * @param src 源文件 + * @param dest 目标文件或目录，目标不存在会自动创建（目录、文件都创建） + * @param isOverride 是否覆盖目标文件 + * @return 目标目录或文件 + * @throws IORuntimeException IO异常 + * @since 4.1.5 + */ + public static File copyFilesFromDir(File src, File dest, boolean isOverride) throws IORuntimeException { + return FileCopier.create(src, dest).setCopyContentIfDir(true).setOnlyCopyFile(true).setOverride(isOverride).copy(); + } + + /** + * 移动文件或者目录 + * + * @param src 源文件或者目录 + * @param target 目标文件或者目录 + * @param isOverride 是否覆盖目标，只有目标为文件才覆盖 + * @throws IORuntimeException IO异常 + * @see PathUtil#move(Path, Path, boolean) + */ + public static void move(File src, File target, boolean isOverride) throws IORuntimeException { + Assert.notNull(src, "Src file must be not null!"); + Assert.notNull(target, "target file must be not null!"); + move(src.toPath(), target.toPath(), isOverride); + } + + /** + * 移动文件或者目录 + * + * @param src 源文件或者目录 + * @param target 目标文件或者目录 + * @param isOverride 是否覆盖目标，只有目标为文件才覆盖 + * @throws IORuntimeException IO异常 + * @see PathUtil#moveContent(Path, Path, boolean) + * @since 5.7.9 + */ + public static void moveContent(File src, File target, boolean isOverride) throws IORuntimeException { + Assert.notNull(src, "Src file must be not null!"); + Assert.notNull(target, "target file must be not null!"); + moveContent(src.toPath(), target.toPath(), isOverride); + } + + /** + * 修改文件或目录的文件名，不变更路径，只是简单修改文件名，不保留扩展名。
+ * + * 
+	 * FileUtil.rename(file, "aaa.png", true) xx/xx.png =》xx/aaa.png
+	 *
+ * + * @param file 被修改的文件 + * @param newName 新的文件名，如需扩展名，需自行在此参数加上，原文件名的扩展名不会被保留 + * @param isOverride 是否覆盖目标文件 + * @return 目标文件 + * @since 5.3.6 + */ + public static File rename(File file, String newName, boolean isOverride) { + return rename(file, newName, false, isOverride); + } + + /** + * 修改文件或目录的文件名，不变更路径，只是简单修改文件名
+ * 重命名有两种模式：
+ * 1、isRetainExt为true时，保留原扩展名： + * + * 
+	 * FileUtil.rename(file, "aaa", true) xx/xx.png =》xx/aaa.png
+	 *
+ * + *

+ * 2、isRetainExt为false时，不保留原扩展名，需要在newName中 + * + * 

+	 * FileUtil.rename(file, "aaa.jpg", false) xx/xx.png =》xx/aaa.jpg
+	 *
+ * + * @param file 被修改的文件 + * @param newName 新的文件名，可选是否包括扩展名 + * @param isRetainExt 是否保留原文件的扩展名，如果保留，则newName不需要加扩展名 + * @param isOverride 是否覆盖目标文件 + * @return 目标文件 + * @see PathUtil#rename(Path, String, boolean) + * @since 3.0.9 + */ + public static File rename(File file, String newName, boolean isRetainExt, boolean isOverride) { + if (isRetainExt) { + final String extName = FileUtil.extName(file); + if (StrUtil.isNotBlank(extName)) { + newName = newName.concat(".").concat(extName); + } + } + return rename(file.toPath(), newName, isOverride).toFile(); + } + + /** + * 获取规范的绝对路径 + * + * @param file 文件 + * @return 规范绝对路径，如果传入file为null，返回null + * @since 4.1.4 + */ + public static String getCanonicalPath(File file) { + if (null == file) { + return null; + } + try { + return file.getCanonicalPath(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 获取绝对路径
+ * 此方法不会判定给定路径是否有效（文件或目录存在） + * + * @param path 相对路径 + * @param baseClass 相对路径所相对的类 + * @return 绝对路径 + */ + public static String getAbsolutePath(String path, Class baseClass) { + String normalPath; + if (path == null) { + normalPath = StrUtil.EMPTY; + } else { + normalPath = normalize(path); + if (isAbsolutePath(normalPath)) { + // 给定的路径已经是绝对路径了 + return normalPath; + } + } + + // 相对于ClassPath路径 + final URL url = ResourceUtil.getResource(normalPath, baseClass); + if (null != url) { + // 对于jar中文件包含file:前缀，需要去掉此类前缀，在此做标准化，since 3.0.8 解决中文或空格路径被编码的问题 + return FileUtil.normalize(URLUtil.getDecodedPath(url)); + } + + // 如果资源不存在，则返回一个拼接的资源绝对路径 + final String classPath = ClassUtil.getClassPath(); + if (null == classPath) { + // throw new NullPointerException("ClassPath is null !"); + // 在jar运行模式中，ClassPath有可能获取不到，此时返回原始相对路径（此时获取的文件为相对工作目录） + return path; + } + + // 资源不存在的情况下使用标准化路径有问题，使用原始路径拼接后标准化路径 + return normalize(classPath.concat(Objects.requireNonNull(path))); + } + + /** + * 获取绝对路径，相对于ClassPath的目录
+ * 如果给定就是绝对路径，则返回原路径，原路径把所有\替换为/
+ * 兼容Spring风格的路径表示，例如：classpath:config/example.setting也会被识别后转换 + * + * @param path 相对路径 + * @return 绝对路径 + */ + public static String getAbsolutePath(String path) { + return getAbsolutePath(path, null); + } + + /** + * 获取标准的绝对路径 + * + * @param file 文件 + * @return 绝对路径 + */ + public static String getAbsolutePath(File file) { + if (file == null) { + return null; + } + + try { + return file.getCanonicalPath(); + } catch (IOException e) { + return file.getAbsolutePath(); + } + } + + /** + * 给定路径已经是绝对路径
+ * 此方法并没有针对路径做标准化，建议先执行{@link #normalize(String)}方法标准化路径后判断
+ * 绝对路径判断条件是： + *
    + *
  • 以/开头的路径
    • + *
  • 满足类似于 c:/xxxxx，其中祖母随意，不区分大小写
    • + *
  • 满足类似于 d:\xxxxx，其中祖母随意，不区分大小写
    • + *
+ * + * @param path 需要检查的Path + * @return 是否已经是绝对路径 + */ + public static boolean isAbsolutePath(String path) { + if (StrUtil.isEmpty(path)) { + return false; + } + + // 给定的路径已经是绝对路径了 + return StrUtil.C_SLASH == path.charAt(0) || ReUtil.isMatch(PATTERN_PATH_ABSOLUTE, path); + } + + /** + * 判断是否为目录，如果path为null，则返回false + * + * @param path 文件路径 + * @return 如果为目录true + */ + public static boolean isDirectory(String path) { + return (null != path) && file(path).isDirectory(); + } + + /** + * 判断是否为目录，如果file为null，则返回false + * + * @param file 文件 + * @return 如果为目录true + */ + public static boolean isDirectory(File file) { + return (null != file) && file.isDirectory(); + } + + /** + * 判断是否为文件，如果path为null，则返回false + * + * @param path 文件路径 + * @return 如果为文件true + */ + public static boolean isFile(String path) { + return (null != path) && file(path).isFile(); + } + + /** + * 判断是否为文件，如果file为null，则返回false + * + * @param file 文件 + * @return 如果为文件true + */ + public static boolean isFile(File file) { + return (null != file) && file.isFile(); + } + + /** + * 检查两个文件是否是同一个文件
+ * 所谓文件相同，是指File对象是否指向同一个文件或文件夹 + * + * @param file1 文件1 + * @param file2 文件2 + * @return 是否相同 + * @throws IORuntimeException IO异常 + */ + public static boolean equals(File file1, File file2) throws IORuntimeException { + Assert.notNull(file1); + Assert.notNull(file2); + if (false == file1.exists() || false == file2.exists()) { + // 两个文件都不存在判断其路径是否相同， 对于一个存在一个不存在的情况，一定不相同 + return false == file1.exists()// + && false == file2.exists()// + && pathEquals(file1, file2); + } + return equals(file1.toPath(), file2.toPath()); + } + + /** + * 比较两个文件内容是否相同
+ * 首先比较长度，长度一致再比较内容
+ * 此方法来自Apache Commons io + * + * @param file1 文件1 + * @param file2 文件2 + * @return 两个文件内容一致返回true，否则false + * @throws IORuntimeException IO异常 + * @since 4.0.6 + */ + public static boolean contentEquals(File file1, File file2) throws IORuntimeException { + boolean file1Exists = file1.exists(); + if (file1Exists != file2.exists()) { + return false; + } + + if (false == file1Exists) { + // 两个文件都不存在，返回true + return true; + } + + if (file1.isDirectory() || file2.isDirectory()) { + // 不比较目录 + throw new IORuntimeException("Can't compare directories, only files"); + } + + if (file1.length() != file2.length()) { + // 文件长度不同 + return false; + } + + if (equals(file1, file2)) { + // 同一个文件 + return true; + } + + InputStream input1 = null; + InputStream input2 = null; + try { + input1 = getInputStream(file1); + input2 = getInputStream(file2); + return IoUtil.contentEquals(input1, input2); + + } finally { + IoUtil.close(input1); + IoUtil.close(input2); + } + } + + // ----------------------------------------------------------------------- + + /** + * 比较两个文件内容是否相同
+ * 首先比较长度，长度一致再比较内容，比较内容采用按行读取，每行比较
+ * 此方法来自Apache Commons io + * + * @param file1 文件1 + * @param file2 文件2 + * @param charset 编码，null表示使用平台默认编码 两个文件内容一致返回true，否则false + * @return 是否相同 + * @throws IORuntimeException IO异常 + * @since 4.0.6 + */ + public static boolean contentEqualsIgnoreEOL(File file1, File file2, Charset charset) throws IORuntimeException { + boolean file1Exists = file1.exists(); + if (file1Exists != file2.exists()) { + return false; + } + + if (!file1Exists) { + // 两个文件都不存在，返回true + return true; + } + + if (file1.isDirectory() || file2.isDirectory()) { + // 不比较目录 + throw new IORuntimeException("Can't compare directories, only files"); + } + + if (equals(file1, file2)) { + // 同一个文件 + return true; + } + + Reader input1 = null; + Reader input2 = null; + try { + input1 = getReader(file1, charset); + input2 = getReader(file2, charset); + return IoUtil.contentEqualsIgnoreEOL(input1, input2); + } finally { + IoUtil.close(input1); + IoUtil.close(input2); + } + } + + /** + * 文件路径是否相同
+ * 取两个文件的绝对路径比较，在Windows下忽略大小写，在Linux下不忽略。 + * + * @param file1 文件1 + * @param file2 文件2 + * @return 文件路径是否相同 + * @since 3.0.9 + */ + public static boolean pathEquals(File file1, File file2) { + if (isWindows()) { + // Windows环境 + try { + if (StrUtil.equalsIgnoreCase(file1.getCanonicalPath(), file2.getCanonicalPath())) { + return true; + } + } catch (Exception e) { + if (StrUtil.equalsIgnoreCase(file1.getAbsolutePath(), file2.getAbsolutePath())) { + return true; + } + } + } else { + // 类Unix环境 + try { + if (StrUtil.equals(file1.getCanonicalPath(), file2.getCanonicalPath())) { + return true; + } + } catch (Exception e) { + if (StrUtil.equals(file1.getAbsolutePath(), file2.getAbsolutePath())) { + return true; + } + } + } + return false; + } + + /** + * 获得最后一个文件路径分隔符的位置 + * + * @param filePath 文件路径 + * @return 最后一个文件路径分隔符的位置 + */ + public static int lastIndexOfSeparator(String filePath) { + if (StrUtil.isNotEmpty(filePath)) { + int i = filePath.length(); + char c; + while (--i >= 0) { + c = filePath.charAt(i); + if (CharUtil.isFileSeparator(c)) { + return i; + } + } + } + return -1; + } + + /** + * 判断文件是否被改动
+ * 如果文件对象为 null 或者文件不存在，被视为改动 + * + * @param file 文件对象 + * @param lastModifyTime 上次的改动时间 + * @return 是否被改动 + * @deprecated 拼写错误，请使用{@link #isModified(File, long)} + */ + @Deprecated + public static boolean isModifed(File file, long lastModifyTime) { + return isModified(file, lastModifyTime); + } + + + /** + * 判断文件是否被改动
+ * 如果文件对象为 null 或者文件不存在，被视为改动 + * + * @param file 文件对象 + * @param lastModifyTime 上次的改动时间 + * @return 是否被改动 + */ + public static boolean isModified(File file, long lastModifyTime) { + if (null == file || false == file.exists()) { + return true; + } + return file.lastModified() != lastModifyTime; + } + + /** + * 修复路径
+ * 如果原路径尾部有分隔符，则保留为标准分隔符（/），否则不保留 + *
    + *
  1. 1. 统一用 /
    2. + *
  2. 2. 多个 / 转换为一个 /
    3. + *
  3. 3. 去除左边空格
    4. + *
  4. 4. .. 和 . 转换为绝对路径，当..多于已有路径时，直接返回根路径
    5. + *
+ *

+ * 栗子： + * + * 

+	 * "/foo//" =》 "/foo/"
+	 * "/foo/./" =》 "/foo/"
+	 * "/foo/../bar" =》 "/bar"
+	 * "/foo/../bar/" =》 "/bar/"
+	 * "/foo/../bar/../baz" =》 "/baz"
+	 * "/../" =》 "/"
+	 * "foo/bar/.." =》 "foo"
+	 * "foo/../bar" =》 "bar"
+	 * "foo/../../bar" =》 "bar"
+	 * "//server/foo/../bar" =》 "/server/bar"
+	 * "//server/../bar" =》 "/bar"
+	 * "C:\\foo\\..\\bar" =》 "C:/bar"
+	 * "C:\\..\\bar" =》 "C:/bar"
+	 * "~/foo/../bar/" =》 "~/bar/"
+	 * "~/../bar" =》 普通用户运行是'bar的home目录'，ROOT用户运行是'/bar'
+	 *
+ * + * @param path 原路径 + * @return 修复后的路径 + */ + public static String normalize(String path) { + if (path == null) { + return null; + } + + // 兼容Spring风格的ClassPath路径，去除前缀，不区分大小写 + String pathToUse = StrUtil.removePrefixIgnoreCase(path, URLUtil.CLASSPATH_URL_PREFIX); + // 去除file:前缀 + pathToUse = StrUtil.removePrefixIgnoreCase(pathToUse, URLUtil.FILE_URL_PREFIX); + + // 识别home目录形式，并转换为绝对路径 + if (StrUtil.startWith(pathToUse, '~')) { + pathToUse = getUserHomePath() + pathToUse.substring(1); + } + + // 统一使用斜杠 + pathToUse = pathToUse.replaceAll("[/\\\\]+", StrUtil.SLASH); + // 去除开头空白符，末尾空白符合法，不去除 + pathToUse = StrUtil.trimStart(pathToUse); + //兼容Windows下的共享目录路径（原始路径如果以\\开头，则保留这种路径） + if (path.startsWith("\\\\")) { + pathToUse = "\\" + pathToUse; + } + + String prefix = StrUtil.EMPTY; + int prefixIndex = pathToUse.indexOf(StrUtil.COLON); + if (prefixIndex > -1) { + // 可能Windows风格路径 + prefix = pathToUse.substring(0, prefixIndex + 1); + if (StrUtil.startWith(prefix, StrUtil.C_SLASH)) { + // 去除类似于/C:这类路径开头的斜杠 + prefix = prefix.substring(1); + } + if (false == prefix.contains(StrUtil.SLASH)) { + pathToUse = pathToUse.substring(prefixIndex + 1); + } else { + // 如果前缀中包含/,说明非Windows风格path + prefix = StrUtil.EMPTY; + } + } + if (pathToUse.startsWith(StrUtil.SLASH)) { + prefix += StrUtil.SLASH; + pathToUse = pathToUse.substring(1); + } + + List pathList = StrUtil.split(pathToUse, StrUtil.C_SLASH); + + List pathElements = new LinkedList<>(); + int tops = 0; + String element; + for (int i = pathList.size() - 1; i >= 0; i--) { + element = pathList.get(i); + // 只处理非.的目录，即只处理非当前目录 + if (false == StrUtil.DOT.equals(element)) { + if (StrUtil.DOUBLE_DOT.equals(element)) { + tops++; + } else { + if (tops > 0) { + // 有上级目录标记时按照个数依次跳过 + tops--; + } else { + // Normal path element found. + pathElements.add(0, element); + } + } + } + } + + // issue#1703@Github + if (tops > 0 && StrUtil.isEmpty(prefix)) { + // 只有相对路径补充开头的..，绝对路径直接忽略之 + while (tops-- > 0) { + //遍历完节点发现还有上级标注（即开头有一个或多个..），补充之 + // Normal path element found. + pathElements.add(0, StrUtil.DOUBLE_DOT); + } + } + + return prefix + CollUtil.join(pathElements, StrUtil.SLASH); + } + + /** + * 获得相对子路径 + *

+ * 栗子： + * + * 

+	 * dirPath: d:/aaa/bbb    filePath: d:/aaa/bbb/ccc     =》    ccc
+	 * dirPath: d:/Aaa/bbb    filePath: d:/aaa/bbb/ccc.txt     =》    ccc.txt
+	 *
+ * + * @param rootDir 绝对父路径 + * @param file 文件 + * @return 相对子路径 + */ + public static String subPath(String rootDir, File file) { + try { + return subPath(rootDir, file.getCanonicalPath()); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 获得相对子路径，忽略大小写 + *

+ * 栗子： + * + * 

+	 * dirPath: d:/aaa/bbb    filePath: d:/aaa/bbb/ccc     =》    ccc
+	 * dirPath: d:/Aaa/bbb    filePath: d:/aaa/bbb/ccc.txt     =》    ccc.txt
+	 * dirPath: d:/Aaa/bbb    filePath: d:/aaa/bbb/     =》    ""
+	 *
+ * + * @param dirPath 父路径 + * @param filePath 文件路径 + * @return 相对子路径 + */ + public static String subPath(String dirPath, String filePath) { + if (StrUtil.isNotEmpty(dirPath) && StrUtil.isNotEmpty(filePath)) { + + dirPath = StrUtil.removeSuffix(normalize(dirPath), "/"); + filePath = normalize(filePath); + + final String result = StrUtil.removePrefixIgnoreCase(filePath, dirPath); + return StrUtil.removePrefix(result, "/"); + } + return filePath; + } + + // -------------------------------------------------------------------------------------------- name start + + /** + * 返回文件名 + * + * @param file 文件 + * @return 文件名 + * @see FileNameUtil#getName(File) + * @since 4.1.13 + */ + public static String getName(File file) { + return FileNameUtil.getName(file); + } + + /** + * 返回文件名
+ * 
+	 * "d:/test/aaa" 返回 "aaa"
+	 * "/test/aaa.jpg" 返回 "aaa.jpg"
+	 *
+ * + * @param filePath 文件 + * @return 文件名 + * @see FileNameUtil#getName(String) + * @since 4.1.13 + */ + public static String getName(String filePath) { + return FileNameUtil.getName(filePath); + } + + /** + * 获取文件后缀名，扩展名不带“.” + * + * @param file 文件 + * @return 扩展名 + * @see FileNameUtil#getSuffix(File) + * @since 5.3.8 + */ + public static String getSuffix(File file) { + return FileNameUtil.getSuffix(file); + } + + /** + * 获得文件后缀名，扩展名不带“.” + * + * @param fileName 文件名 + * @return 扩展名 + * @see FileNameUtil#getSuffix(String) + * @since 5.3.8 + */ + public static String getSuffix(String fileName) { + return FileNameUtil.getSuffix(fileName); + } + + /** + * 返回主文件名 + * + * @param file 文件 + * @return 主文件名 + * @see FileNameUtil#getPrefix(File) + * @since 5.3.8 + */ + public static String getPrefix(File file) { + return FileNameUtil.getPrefix(file); + } + + /** + * 返回主文件名 + * + * @param fileName 完整文件名 + * @return 主文件名 + * @see FileNameUtil#getPrefix(String) + * @since 5.3.8 + */ + public static String getPrefix(String fileName) { + return FileNameUtil.getPrefix(fileName); + } + + /** + * 返回主文件名 + * + * @param file 文件 + * @return 主文件名 + * @see FileNameUtil#mainName(File) + */ + public static String mainName(File file) { + return FileNameUtil.mainName(file); + } + + /** + * 返回主文件名 + * + * @param fileName 完整文件名 + * @return 主文件名 + * @see FileNameUtil#mainName(String) + */ + public static String mainName(String fileName) { + return FileNameUtil.mainName(fileName); + } + + /** + * 获取文件扩展名（后缀名），扩展名不带“.” + * + * @param file 文件 + * @return 扩展名 + * @see FileNameUtil#extName(File) + */ + public static String extName(File file) { + return FileNameUtil.extName(file); + } + + /** + * 获得文件的扩展名（后缀名），扩展名不带“.” + * + * @param fileName 文件名 + * @return 扩展名 + * @see FileNameUtil#extName(String) + */ + public static String extName(String fileName) { + return FileNameUtil.extName(fileName); + } + // -------------------------------------------------------------------------------------------- name end + + /** + * 判断文件路径是否有指定后缀，忽略大小写
+ * 常用语判断扩展名 + * + * @param file 文件或目录 + * @param suffix 后缀 + * @return 是否有指定后缀 + */ + public static boolean pathEndsWith(File file, String suffix) { + return file.getPath().toLowerCase().endsWith(suffix); + } + + /** + * 根据文件流的头部信息获得文件类型 + * + * 
+	 *      1、无法识别类型默认按照扩展名识别
+	 *      2、xls、doc、msi头信息无法区分，按照扩展名区分
+	 *      3、zip可能为docx、xlsx、pptx、jar、war头信息无法区分，按照扩展名区分
+	 *
+ * + * @param file 文件 {@link File} + * @return 类型，文件的扩展名，未找到为{@code null} + * @throws IORuntimeException IO异常 + * @see FileTypeUtil#getType(File) + */ + public static String getType(File file) throws IORuntimeException { + return FileTypeUtil.getType(file); + } + + // -------------------------------------------------------------------------------------------- in start + + /** + * 获得输入流 + * + * @param file 文件 + * @return 输入流 + * @throws IORuntimeException 文件未找到 + */ + public static BufferedInputStream getInputStream(File file) throws IORuntimeException { + return IoUtil.toBuffered(IoUtil.toStream(file)); + } + + /** + * 获得输入流 + * + * @param path 文件路径 + * @return 输入流 + * @throws IORuntimeException 文件未找到 + */ + public static BufferedInputStream getInputStream(String path) throws IORuntimeException { + return getInputStream(file(path)); + } + + /** + * 获得BOM输入流，用于处理带BOM头的文件 + * + * @param file 文件 + * @return 输入流 + * @throws IORuntimeException 文件未找到 + */ + public static BOMInputStream getBOMInputStream(File file) throws IORuntimeException { + try { + return new BOMInputStream(new FileInputStream(file)); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 读取带BOM头的文件为Reader + * + * @param file 文件 + * @return BufferedReader对象 + * @since 5.5.8 + */ + public static BufferedReader getBOMReader(File file) { + return IoUtil.getReader(getBOMInputStream(file)); + } + + /** + * 获得一个文件读取器 + * + * @param file 文件 + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + */ + public static BufferedReader getUtf8Reader(File file) throws IORuntimeException { + return getReader(file, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 获得一个文件读取器 + * + * @param path 文件路径 + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + */ + public static BufferedReader getUtf8Reader(String path) throws IORuntimeException { + return getReader(path, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 获得一个文件读取器 + * + * @param file 文件 + * @param charsetName 字符集 + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + * @deprecated 请使用 {@link #getReader(File, Charset)} + */ + @Deprecated + public static BufferedReader getReader(File file, String charsetName) throws IORuntimeException { + return IoUtil.getReader(getInputStream(file), CharsetUtil.charset(charsetName)); + } + + /** + * 获得一个文件读取器 + * + * @param file 文件 + * @param charset 字符集 + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + */ + public static BufferedReader getReader(File file, Charset charset) throws IORuntimeException { + return IoUtil.getReader(getInputStream(file), charset); + } + + /** + * 获得一个文件读取器 + * + * @param path 绝对路径 + * @param charsetName 字符集 + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + * @deprecated 请使用 {@link #getReader(String, Charset)} + */ + @Deprecated + public static BufferedReader getReader(String path, String charsetName) throws IORuntimeException { + return getReader(path, CharsetUtil.charset(charsetName)); + } + + /** + * 获得一个文件读取器 + * + * @param path 绝对路径 + * @param charset 字符集 + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + */ + public static BufferedReader getReader(String path, Charset charset) throws IORuntimeException { + return getReader(file(path), charset); + } + + // -------------------------------------------------------------------------------------------- in end + + /** + * 读取文件所有数据
+ * 文件的长度不能超过Integer.MAX_VALUE + * + * @param file 文件 + * @return 字节码 + * @throws IORuntimeException IO异常 + */ + public static byte[] readBytes(File file) throws IORuntimeException { + return FileReader.create(file).readBytes(); + } + + /** + * 读取文件所有数据
+ * 文件的长度不能超过Integer.MAX_VALUE + * + * @param filePath 文件路径 + * @return 字节码 + * @throws IORuntimeException IO异常 + * @since 3.2.0 + */ + public static byte[] readBytes(String filePath) throws IORuntimeException { + return readBytes(file(filePath)); + } + + /** + * 读取文件内容 + * + * @param file 文件 + * @return 内容 + * @throws IORuntimeException IO异常 + */ + public static String readUtf8String(File file) throws IORuntimeException { + return readString(file, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 读取文件内容 + * + * @param path 文件路径 + * @return 内容 + * @throws IORuntimeException IO异常 + */ + public static String readUtf8String(String path) throws IORuntimeException { + return readString(path, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 读取文件内容 + * + * @param file 文件 + * @param charsetName 字符集 + * @return 内容 + * @throws IORuntimeException IO异常 + * @deprecated 请使用 {@link #readString(File, Charset)} + */ + @Deprecated + public static String readString(File file, String charsetName) throws IORuntimeException { + return readString(file, CharsetUtil.charset(charsetName)); + } + + /** + * 读取文件内容 + * + * @param file 文件 + * @param charset 字符集 + * @return 内容 + * @throws IORuntimeException IO异常 + */ + public static String readString(File file, Charset charset) throws IORuntimeException { + return FileReader.create(file, charset).readString(); + } + + /** + * 读取文件内容 + * + * @param path 文件路径 + * @param charsetName 字符集 + * @return 内容 + * @throws IORuntimeException IO异常 + * @deprecated 请使用 {@link #readString(String, Charset)} + */ + @Deprecated + public static String readString(String path, String charsetName) throws IORuntimeException { + return readString(path, CharsetUtil.charset(charsetName)); + } + + /** + * 读取文件内容 + * + * @param path 文件路径 + * @param charset 字符集 + * @return 内容 + * @throws IORuntimeException IO异常 + */ + public static String readString(String path, Charset charset) throws IORuntimeException { + return readString(file(path), charset); + } + + /** + * 读取文件内容 + * + * @param url 文件URL + * @param charsetName 字符集 + * @return 内容 + * @throws IORuntimeException IO异常 + * @deprecated 请使用 {@link #readString(URL, Charset)} + */ + @Deprecated + public static String readString(URL url, String charsetName) throws IORuntimeException { + return readString(url, CharsetUtil.charset(charsetName)); + } + + /** + * 读取文件内容 + * + * @param url 文件URL + * @param charset 字符集 + * @return 内容 + * @throws IORuntimeException IO异常 + * @since 5.7.10 + */ + public static String readString(URL url, Charset charset) throws IORuntimeException { + if (url == null) { + throw new NullPointerException("Empty url provided!"); + } + + InputStream in = null; + try { + in = url.openStream(); + return IoUtil.read(in, charset); + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + IoUtil.close(in); + } + } + + /** + * 从文件中读取每一行的UTF-8编码数据 + * + * @param 集合类型 + * @param path 文件路径 + * @param collection 集合 + * @return 文件中的每行内容的集合 + * @throws IORuntimeException IO异常 + * @since 3.1.1 + */ + public static > T readUtf8Lines(String path, T collection) throws IORuntimeException { + return readLines(path, CharsetUtil.CHARSET_UTF_8, collection); + } + + /** + * 从文件中读取每一行数据 + * + * @param 集合类型 + * @param path 文件路径 + * @param charset 字符集 + * @param collection 集合 + * @return 文件中的每行内容的集合 + * @throws IORuntimeException IO异常 + */ + public static > T readLines(String path, String charset, T collection) throws IORuntimeException { + return readLines(file(path), charset, collection); + } + + /** + * 从文件中读取每一行数据 + * + * @param 集合类型 + * @param path 文件路径 + * @param charset 字符集 + * @param collection 集合 + * @return 文件中的每行内容的集合 + * @throws IORuntimeException IO异常 + */ + public static > T readLines(String path, Charset charset, T collection) throws IORuntimeException { + return readLines(file(path), charset, collection); + } + + /** + * 从文件中读取每一行数据，数据编码为UTF-8 + * + * @param 集合类型 + * @param file 文件路径 + * @param collection 集合 + * @return 文件中的每行内容的集合 + * @throws IORuntimeException IO异常 + * @since 3.1.1 + */ + public static > T readUtf8Lines(File file, T collection) throws IORuntimeException { + return readLines(file, CharsetUtil.CHARSET_UTF_8, collection); + } + + /** + * 从文件中读取每一行数据 + * + * @param 集合类型 + * @param file 文件路径 + * @param charset 字符集 + * @param collection 集合 + * @return 文件中的每行内容的集合 + * @throws IORuntimeException IO异常 + */ + public static > T readLines(File file, String charset, T collection) throws IORuntimeException { + return FileReader.create(file, CharsetUtil.charset(charset)).readLines(collection); + } + + /** + * 从文件中读取每一行数据 + * + * @param 集合类型 + * @param file 文件路径 + * @param charset 字符集 + * @param collection 集合 + * @return 文件中的每行内容的集合 + * @throws IORuntimeException IO异常 + */ + public static > T readLines(File file, Charset charset, T collection) throws IORuntimeException { + return FileReader.create(file, charset).readLines(collection); + } + + /** + * 从文件中读取每一行数据，编码为UTF-8 + * + * @param 集合类型 + * @param url 文件的URL + * @param collection 集合 + * @return 文件中的每行内容的集合 + * @throws IORuntimeException IO异常 + */ + public static > T readUtf8Lines(URL url, T collection) throws IORuntimeException { + return readLines(url, CharsetUtil.CHARSET_UTF_8, collection); + } + + /** + * 从文件中读取每一行数据 + * + * @param 集合类型 + * @param url 文件的URL + * @param charsetName 字符集 + * @param collection 集合 + * @return 文件中的每行内容的集合 + * @throws IORuntimeException IO异常 + * @deprecated 请使用 {@link #readLines(URL, Charset, Collection)} + */ + @Deprecated + public static > T readLines(URL url, String charsetName, T collection) throws IORuntimeException { + return readLines(url, CharsetUtil.charset(charsetName), collection); + } + + /** + * 从文件中读取每一行数据 + * + * @param 集合类型 + * @param url 文件的URL + * @param charset 字符集 + * @param collection 集合 + * @return 文件中的每行内容的集合 + * @throws IORuntimeException IO异常 + * @since 3.1.1 + */ + public static > T readLines(URL url, Charset charset, T collection) throws IORuntimeException { + InputStream in = null; + try { + in = url.openStream(); + return IoUtil.readLines(in, charset, collection); + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + IoUtil.close(in); + } + } + + /** + * 从文件中读取每一行数据 + * + * @param url 文件的URL + * @return 文件中的每行内容的集合List + * @throws IORuntimeException IO异常 + */ + public static List readUtf8Lines(URL url) throws IORuntimeException { + return readLines(url, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 从文件中读取每一行数据 + * + * @param url 文件的URL + * @param charsetName 字符集 + * @return 文件中的每行内容的集合List + * @throws IORuntimeException IO异常 + * @deprecated 请使用 {@link #readLines(URL, Charset)} + */ + @Deprecated + public static List readLines(URL url, String charsetName) throws IORuntimeException { + return readLines(url, CharsetUtil.charset(charsetName)); + } + + /** + * 从文件中读取每一行数据 + * + * @param url 文件的URL + * @param charset 字符集 + * @return 文件中的每行内容的集合List + * @throws IORuntimeException IO异常 + */ + public static List readLines(URL url, Charset charset) throws IORuntimeException { + return readLines(url, charset, new ArrayList<>()); + } + + /** + * 从文件中读取每一行数据，编码为UTF-8 + * + * @param path 文件路径 + * @return 文件中的每行内容的集合List + * @throws IORuntimeException IO异常 + * @since 3.1.1 + */ + public static List readUtf8Lines(String path) throws IORuntimeException { + return readLines(path, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 从文件中读取每一行数据 + * + * @param path 文件路径 + * @param charset 字符集 + * @return 文件中的每行内容的集合List + * @throws IORuntimeException IO异常 + */ + public static List readLines(String path, String charset) throws IORuntimeException { + return readLines(path, charset, new ArrayList<>()); + } + + /** + * 从文件中读取每一行数据 + * + * @param path 文件路径 + * @param charset 字符集 + * @return 文件中的每行内容的集合List + * @throws IORuntimeException IO异常 + * @since 3.1.1 + */ + public static List readLines(String path, Charset charset) throws IORuntimeException { + return readLines(path, charset, new ArrayList<>()); + } + + /** + * 从文件中读取每一行数据 + * + * @param file 文件 + * @return 文件中的每行内容的集合List + * @throws IORuntimeException IO异常 + * @since 3.1.1 + */ + public static List readUtf8Lines(File file) throws IORuntimeException { + return readLines(file, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 从文件中读取每一行数据 + * + * @param file 文件 + * @param charset 字符集 + * @return 文件中的每行内容的集合List + * @throws IORuntimeException IO异常 + */ + public static List readLines(File file, String charset) throws IORuntimeException { + return readLines(file, charset, new ArrayList<>()); + } + + /** + * 从文件中读取每一行数据 + * + * @param file 文件 + * @param charset 字符集 + * @return 文件中的每行内容的集合List + * @throws IORuntimeException IO异常 + */ + public static List readLines(File file, Charset charset) throws IORuntimeException { + return readLines(file, charset, new ArrayList<>()); + } + + /** + * 按行处理文件内容，编码为UTF-8 + * + * @param file 文件 + * @param lineHandler {@link LineHandler}行处理器 + * @throws IORuntimeException IO异常 + */ + public static void readUtf8Lines(File file, LineHandler lineHandler) throws IORuntimeException { + readLines(file, CharsetUtil.CHARSET_UTF_8, lineHandler); + } + + /** + * 按行处理文件内容 + * + * @param file 文件 + * @param charset 编码 + * @param lineHandler {@link LineHandler}行处理器 + * @throws IORuntimeException IO异常 + */ + public static void readLines(File file, Charset charset, LineHandler lineHandler) throws IORuntimeException { + FileReader.create(file, charset).readLines(lineHandler); + } + + /** + * 按行处理文件内容 + * + * @param file {@link RandomAccessFile}文件 + * @param charset 编码 + * @param lineHandler {@link LineHandler}行处理器 + * @throws IORuntimeException IO异常 + * @since 4.5.2 + */ + public static void readLines(RandomAccessFile file, Charset charset, LineHandler lineHandler) { + String line; + try { + while ((line = file.readLine()) != null) { + lineHandler.handle(CharsetUtil.convert(line, CharsetUtil.CHARSET_ISO_8859_1, charset)); + } + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 单行处理文件内容 + * + * @param file {@link RandomAccessFile}文件 + * @param charset 编码 + * @param lineHandler {@link LineHandler}行处理器 + * @throws IORuntimeException IO异常 + * @since 4.5.2 + */ + public static void readLine(RandomAccessFile file, Charset charset, LineHandler lineHandler) { + final String line = readLine(file, charset); + if (null != line) { + lineHandler.handle(line); + } + } + + /** + * 单行处理文件内容 + * + * @param file {@link RandomAccessFile}文件 + * @param charset 编码 + * @return 行内容 + * @throws IORuntimeException IO异常 + * @since 4.5.18 + */ + public static String readLine(RandomAccessFile file, Charset charset) { + String line; + try { + line = file.readLine(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + if (null != line) { + return CharsetUtil.convert(line, CharsetUtil.CHARSET_ISO_8859_1, charset); + } + + return null; + } + + /** + * 按照给定的readerHandler读取文件中的数据 + * + * @param 集合类型 + * @param readerHandler Reader处理类 + * @param path 文件的绝对路径 + * @return 从文件中load出的数据 + * @throws IORuntimeException IO异常 + * @since 3.1.1 + */ + public static T loadUtf8(String path, ReaderHandler readerHandler) throws IORuntimeException { + return load(path, CharsetUtil.CHARSET_UTF_8, readerHandler); + } + + /** + * 按照给定的readerHandler读取文件中的数据 + * + * @param 集合类型 + * @param readerHandler Reader处理类 + * @param path 文件的绝对路径 + * @param charset 字符集 + * @return 从文件中load出的数据 + * @throws IORuntimeException IO异常 + * @since 3.1.1 + */ + public static T load(String path, String charset, ReaderHandler readerHandler) throws IORuntimeException { + return FileReader.create(file(path), CharsetUtil.charset(charset)).read(readerHandler); + } + + /** + * 按照给定的readerHandler读取文件中的数据 + * + * @param 集合类型 + * @param readerHandler Reader处理类 + * @param path 文件的绝对路径 + * @param charset 字符集 + * @return 从文件中load出的数据 + * @throws IORuntimeException IO异常 + * @since 3.1.1 + */ + public static T load(String path, Charset charset, ReaderHandler readerHandler) throws IORuntimeException { + return FileReader.create(file(path), charset).read(readerHandler); + } + + /** + * 按照给定的readerHandler读取文件中的数据 + * + * @param 集合类型 + * @param readerHandler Reader处理类 + * @param file 文件 + * @return 从文件中load出的数据 + * @throws IORuntimeException IO异常 + * @since 3.1.1 + */ + public static T loadUtf8(File file, ReaderHandler readerHandler) throws IORuntimeException { + return load(file, CharsetUtil.CHARSET_UTF_8, readerHandler); + } + + /** + * 按照给定的readerHandler读取文件中的数据 + * + * @param 集合类型 + * @param readerHandler Reader处理类 + * @param file 文件 + * @param charset 字符集 + * @return 从文件中load出的数据 + * @throws IORuntimeException IO异常 + * @since 3.1.1 + */ + public static T load(File file, Charset charset, ReaderHandler readerHandler) throws IORuntimeException { + return FileReader.create(file, charset).read(readerHandler); + } + + // -------------------------------------------------------------------------------------------- out start + + /** + * 获得一个输出流对象 + * + * @param file 文件 + * @return 输出流对象 + * @throws IORuntimeException IO异常 + */ + public static BufferedOutputStream getOutputStream(File file) throws IORuntimeException { + final OutputStream out; + try { + out = new FileOutputStream(touch(file)); + } catch (IOException e) { + throw new IORuntimeException(e); + } + return IoUtil.toBuffered(out); + } + + /** + * 获得一个输出流对象 + * + * @param path 输出到的文件路径，绝对路径 + * @return 输出流对象 + * @throws IORuntimeException IO异常 + */ + public static BufferedOutputStream getOutputStream(String path) throws IORuntimeException { + return getOutputStream(touch(path)); + } + + /** + * 获得一个带缓存的写入对象 + * + * @param path 输出路径，绝对路径 + * @param charsetName 字符集 + * @param isAppend 是否追加 + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + * @deprecated 请使用 {@link #getWriter(String, Charset, boolean)} + */ + @Deprecated + public static BufferedWriter getWriter(String path, String charsetName, boolean isAppend) throws IORuntimeException { + return getWriter(path, Charset.forName(charsetName), isAppend); + } + + /** + * 获得一个带缓存的写入对象 + * + * @param path 输出路径，绝对路径 + * @param charset 字符集 + * @param isAppend 是否追加 + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + */ + public static BufferedWriter getWriter(String path, Charset charset, boolean isAppend) throws IORuntimeException { + return getWriter(touch(path), charset, isAppend); + } + + /** + * 获得一个带缓存的写入对象 + * + * @param file 输出文件 + * @param charsetName 字符集 + * @param isAppend 是否追加 + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + * @deprecated 请使用 {@link #getWriter(File, Charset, boolean)} + */ + @Deprecated + public static BufferedWriter getWriter(File file, String charsetName, boolean isAppend) throws IORuntimeException { + return getWriter(file, Charset.forName(charsetName), isAppend); + } + + /** + * 获得一个带缓存的写入对象 + * + * @param file 输出文件 + * @param charset 字符集 + * @param isAppend 是否追加 + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + */ + public static BufferedWriter getWriter(File file, Charset charset, boolean isAppend) throws IORuntimeException { + return FileWriter.create(file, charset).getWriter(isAppend); + } + + /** + * 获得一个打印写入对象，可以有print + * + * @param path 输出路径，绝对路径 + * @param charset 字符集 + * @param isAppend 是否追加 + * @return 打印对象 + * @throws IORuntimeException IO异常 + */ + public static PrintWriter getPrintWriter(String path, String charset, boolean isAppend) throws IORuntimeException { + return new PrintWriter(getWriter(path, charset, isAppend)); + } + + /** + * 获得一个打印写入对象，可以有print + * + * @param path 输出路径，绝对路径 + * @param charset 字符集 + * @param isAppend 是否追加 + * @return 打印对象 + * @throws IORuntimeException IO异常 + * @since 4.1.1 + */ + public static PrintWriter getPrintWriter(String path, Charset charset, boolean isAppend) throws IORuntimeException { + return new PrintWriter(getWriter(path, charset, isAppend)); + } + + /** + * 获得一个打印写入对象，可以有print + * + * @param file 文件 + * @param charset 字符集 + * @param isAppend 是否追加 + * @return 打印对象 + * @throws IORuntimeException IO异常 + */ + public static PrintWriter getPrintWriter(File file, String charset, boolean isAppend) throws IORuntimeException { + return new PrintWriter(getWriter(file, charset, isAppend)); + } + + /** + * 获得一个打印写入对象，可以有print + * + * @param file 文件 + * @param charset 字符集 + * @param isAppend 是否追加 + * @return 打印对象 + * @throws IORuntimeException IO异常 + * @since 5.4.3 + */ + public static PrintWriter getPrintWriter(File file, Charset charset, boolean isAppend) throws IORuntimeException { + return new PrintWriter(getWriter(file, charset, isAppend)); + } + + /** + * 获取当前系统的换行分隔符 + * + * 
+	 * Windows: \r\n
+	 * Mac: \r
+	 * Linux: \n
+	 *
+ * + * @return 换行符 + * @since 4.0.5 + */ + public static String getLineSeparator() { + return System.lineSeparator(); + // return System.getProperty("line.separator"); + } + + // -------------------------------------------------------------------------------------------- out end + + /** + * 将String写入文件，覆盖模式，字符集为UTF-8 + * + * @param content 写入的内容 + * @param path 文件路径 + * @return 写入的文件 + * @throws IORuntimeException IO异常 + */ + public static File writeUtf8String(String content, String path) throws IORuntimeException { + return writeString(content, path, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 将String写入文件，覆盖模式，字符集为UTF-8 + * + * @param content 写入的内容 + * @param file 文件 + * @return 写入的文件 + * @throws IORuntimeException IO异常 + */ + public static File writeUtf8String(String content, File file) throws IORuntimeException { + return writeString(content, file, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 将String写入文件，覆盖模式 + * + * @param content 写入的内容 + * @param path 文件路径 + * @param charset 字符集 + * @return 写入的文件 + * @throws IORuntimeException IO异常 + */ + public static File writeString(String content, String path, String charset) throws IORuntimeException { + return writeString(content, touch(path), charset); + } + + /** + * 将String写入文件，覆盖模式 + * + * @param content 写入的内容 + * @param path 文件路径 + * @param charset 字符集 + * @return 写入的文件 + * @throws IORuntimeException IO异常 + */ + public static File writeString(String content, String path, Charset charset) throws IORuntimeException { + return writeString(content, touch(path), charset); + } + + /** + * 将String写入文件，覆盖模式 + * + * @param content 写入的内容 + * @param file 文件 + * @param charset 字符集 + * @return 被写入的文件 + * @throws IORuntimeException IO异常 + */ + public static File writeString(String content, File file, String charset) throws IORuntimeException { + return FileWriter.create(file, CharsetUtil.charset(charset)).write(content); + } + + /** + * 将String写入文件，覆盖模式 + * + * @param content 写入的内容 + * @param file 文件 + * @param charset 字符集 + * @return 被写入的文件 + * @throws IORuntimeException IO异常 + */ + public static File writeString(String content, File file, Charset charset) throws IORuntimeException { + return FileWriter.create(file, charset).write(content); + } + + /** + * 将String写入文件，UTF-8编码追加模式 + * + * @param content 写入的内容 + * @param path 文件路径 + * @return 写入的文件 + * @throws IORuntimeException IO异常 + * @since 3.1.2 + */ + public static File appendUtf8String(String content, String path) throws IORuntimeException { + return appendString(content, path, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 将String写入文件，追加模式 + * + * @param content 写入的内容 + * @param path 文件路径 + * @param charset 字符集 + * @return 写入的文件 + * @throws IORuntimeException IO异常 + */ + public static File appendString(String content, String path, String charset) throws IORuntimeException { + return appendString(content, touch(path), charset); + } + + /** + * 将String写入文件，追加模式 + * + * @param content 写入的内容 + * @param path 文件路径 + * @param charset 字符集 + * @return 写入的文件 + * @throws IORuntimeException IO异常 + */ + public static File appendString(String content, String path, Charset charset) throws IORuntimeException { + return appendString(content, touch(path), charset); + } + + /** + * 将String写入文件，UTF-8编码追加模式 + * + * @param content 写入的内容 + * @param file 文件 + * @return 写入的文件 + * @throws IORuntimeException IO异常 + * @since 3.1.2 + */ + public static File appendUtf8String(String content, File file) throws IORuntimeException { + return appendString(content, file, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 将String写入文件，追加模式 + * + * @param content 写入的内容 + * @param file 文件 + * @param charset 字符集 + * @return 写入的文件 + * @throws IORuntimeException IO异常 + */ + public static File appendString(String content, File file, String charset) throws IORuntimeException { + return FileWriter.create(file, CharsetUtil.charset(charset)).append(content); + } + + /** + * 将String写入文件，追加模式 + * + * @param content 写入的内容 + * @param file 文件 + * @param charset 字符集 + * @return 写入的文件 + * @throws IORuntimeException IO异常 + */ + public static File appendString(String content, File file, Charset charset) throws IORuntimeException { + return FileWriter.create(file, charset).append(content); + } + + /** + * 将列表写入文件，覆盖模式，编码为UTF-8 + * + * @param 集合元素类型 + * @param list 列表 + * @param path 绝对路径 + * @return 目标文件 + * @throws IORuntimeException IO异常 + * @since 3.2.0 + */ + public static File writeUtf8Lines(Collection list, String path) throws IORuntimeException { + return writeLines(list, path, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 将列表写入文件，覆盖模式，编码为UTF-8 + * + * @param 集合元素类型 + * @param list 列表 + * @param file 绝对路径 + * @return 目标文件 + * @throws IORuntimeException IO异常 + * @since 3.2.0 + */ + public static File writeUtf8Lines(Collection list, File file) throws IORuntimeException { + return writeLines(list, file, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 将列表写入文件，覆盖模式 + * + * @param 集合元素类型 + * @param list 列表 + * @param path 绝对路径 + * @param charset 字符集 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public static File writeLines(Collection list, String path, String charset) throws IORuntimeException { + return writeLines(list, path, charset, false); + } + + /** + * 将列表写入文件，覆盖模式 + * + * @param 集合元素类型 + * @param list 列表 + * @param path 绝对路径 + * @param charset 字符集 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public static File writeLines(Collection list, String path, Charset charset) throws IORuntimeException { + return writeLines(list, path, charset, false); + } + + /** + * 将列表写入文件，覆盖模式 + * + * @param 集合元素类型 + * @param list 列表 + * @param file 文件 + * @param charset 字符集 + * @return 目标文件 + * @throws IORuntimeException IO异常 + * @since 4.2.0 + */ + public static File writeLines(Collection list, File file, String charset) throws IORuntimeException { + return writeLines(list, file, charset, false); + } + + /** + * 将列表写入文件，覆盖模式 + * + * @param 集合元素类型 + * @param list 列表 + * @param file 文件 + * @param charset 字符集 + * @return 目标文件 + * @throws IORuntimeException IO异常 + * @since 4.2.0 + */ + public static File writeLines(Collection list, File file, Charset charset) throws IORuntimeException { + return writeLines(list, file, charset, false); + } + + /** + * 将列表写入文件，追加模式 + * + * @param 集合元素类型 + * @param list 列表 + * @param file 文件 + * @return 目标文件 + * @throws IORuntimeException IO异常 + * @since 3.1.2 + */ + public static File appendUtf8Lines(Collection list, File file) throws IORuntimeException { + return appendLines(list, file, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 将列表写入文件，追加模式 + * + * @param 集合元素类型 + * @param list 列表 + * @param path 文件路径 + * @return 目标文件 + * @throws IORuntimeException IO异常 + * @since 3.1.2 + */ + public static File appendUtf8Lines(Collection list, String path) throws IORuntimeException { + return appendLines(list, path, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 将列表写入文件，追加模式 + * + * @param 集合元素类型 + * @param list 列表 + * @param path 绝对路径 + * @param charset 字符集 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public static File appendLines(Collection list, String path, String charset) throws IORuntimeException { + return writeLines(list, path, charset, true); + } + + /** + * 将列表写入文件，追加模式 + * + * @param 集合元素类型 + * @param list 列表 + * @param file 文件 + * @param charset 字符集 + * @return 目标文件 + * @throws IORuntimeException IO异常 + * @since 3.1.2 + */ + public static File appendLines(Collection list, File file, String charset) throws IORuntimeException { + return writeLines(list, file, charset, true); + } + + /** + * 将列表写入文件，追加模式 + * + * @param 集合元素类型 + * @param list 列表 + * @param path 绝对路径 + * @param charset 字符集 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public static File appendLines(Collection list, String path, Charset charset) throws IORuntimeException { + return writeLines(list, path, charset, true); + } + + /** + * 将列表写入文件，追加模式，策略为： + *
    + *
  • 当文件为空，从开头追加，尾部不加空行
    • + *
  • 当有内容，换行追加，尾部不加空行
    • + *
  • 当有内容，并末尾有空行，依旧换行追加
    • + *
+ * + * @param 集合元素类型 + * @param list 列表 + * @param file 文件 + * @param charset 字符集 + * @return 目标文件 + * @throws IORuntimeException IO异常 + * @since 3.1.2 + */ + public static File appendLines(Collection list, File file, Charset charset) throws IORuntimeException { + return writeLines(list, file, charset, true); + } + + /** + * 将列表写入文件 + * + * @param 集合元素类型 + * @param list 列表 + * @param path 文件路径 + * @param charset 字符集 + * @param isAppend 是否追加 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public static File writeLines(Collection list, String path, String charset, boolean isAppend) throws IORuntimeException { + return writeLines(list, file(path), charset, isAppend); + } + + /** + * 将列表写入文件 + * + * @param 集合元素类型 + * @param list 列表 + * @param path 文件路径 + * @param charset 字符集 + * @param isAppend 是否追加 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public static File writeLines(Collection list, String path, Charset charset, boolean isAppend) throws IORuntimeException { + return writeLines(list, file(path), charset, isAppend); + } + + /** + * 将列表写入文件 + * + * @param 集合元素类型 + * @param list 列表 + * @param file 文件 + * @param charset 字符集 + * @param isAppend 是否追加 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public static File writeLines(Collection list, File file, String charset, boolean isAppend) throws IORuntimeException { + return FileWriter.create(file, CharsetUtil.charset(charset)).writeLines(list, isAppend); + } + + /** + * 将列表写入文件 + * + * @param 集合元素类型 + * @param list 列表 + * @param file 文件 + * @param charset 字符集 + * @param isAppend 是否追加 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public static File writeLines(Collection list, File file, Charset charset, boolean isAppend) throws IORuntimeException { + return FileWriter.create(file, charset).writeLines(list, isAppend); + } + + /** + * 将Map写入文件，每个键值对为一行，一行中键与值之间使用kvSeparator分隔 + * + * @param map Map + * @param file 文件 + * @param kvSeparator 键和值之间的分隔符，如果传入null使用默认分隔符" = " + * @param isAppend 是否追加 + * @return 目标文件 + * @throws IORuntimeException IO异常 + * @since 4.0.5 + */ + public static File writeUtf8Map(Map map, File file, String kvSeparator, boolean isAppend) throws IORuntimeException { + return FileWriter.create(file, CharsetUtil.CHARSET_UTF_8).writeMap(map, kvSeparator, isAppend); + } + + /** + * 将Map写入文件，每个键值对为一行，一行中键与值之间使用kvSeparator分隔 + * + * @param map Map + * @param file 文件 + * @param charset 字符集编码 + * @param kvSeparator 键和值之间的分隔符，如果传入null使用默认分隔符" = " + * @param isAppend 是否追加 + * @return 目标文件 + * @throws IORuntimeException IO异常 + * @since 4.0.5 + */ + public static File writeMap(Map map, File file, Charset charset, String kvSeparator, boolean isAppend) throws IORuntimeException { + return FileWriter.create(file, charset).writeMap(map, kvSeparator, isAppend); + } + + /** + * 写数据到文件中
+ * 文件路径如果是相对路径，则相对ClassPath + * + * @param data 数据 + * @param path 相对ClassPath的目录或者绝对路径目录 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public static File writeBytes(byte[] data, String path) throws IORuntimeException { + return writeBytes(data, touch(path)); + } + + /** + * 写数据到文件中 + * + * @param dest 目标文件 + * @param data 数据 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public static File writeBytes(byte[] data, File dest) throws IORuntimeException { + return writeBytes(data, dest, 0, data.length, false); + } + + /** + * 写入数据到文件 + * + * @param data 数据 + * @param dest 目标文件 + * @param off 数据开始位置 + * @param len 数据长度 + * @param isAppend 是否追加模式 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public static File writeBytes(byte[] data, File dest, int off, int len, boolean isAppend) throws IORuntimeException { + return FileWriter.create(dest).write(data, off, len, isAppend); + } + + /** + * 将流的内容写入文件
+ * 此方法会自动关闭输入流 + * + * @param dest 目标文件 + * @param in 输入流 + * @return dest + * @throws IORuntimeException IO异常 + */ + public static File writeFromStream(InputStream in, File dest) throws IORuntimeException { + return writeFromStream(in, dest, true); + } + + /** + * 将流的内容写入文件 + * + * @param dest 目标文件 + * @param in 输入流 + * @param isCloseIn 是否关闭输入流 + * @return dest + * @throws IORuntimeException IO异常 + * @since 5.5.6 + */ + public static File writeFromStream(InputStream in, File dest, boolean isCloseIn) throws IORuntimeException { + return FileWriter.create(dest).writeFromStream(in, isCloseIn); + } + + /** + * 将流的内容写入文件
+ * 此方法会自动关闭输入流 + * + * @param in 输入流 + * @param fullFilePath 文件绝对路径 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public static File writeFromStream(InputStream in, String fullFilePath) throws IORuntimeException { + return writeFromStream(in, touch(fullFilePath)); + } + + /** + * 将文件写入流中，此方法不会关闭输出流 + * + * @param file 文件 + * @param out 流 + * @return 写出的流byte数 + * @throws IORuntimeException IO异常 + */ + public static long writeToStream(File file, OutputStream out) throws IORuntimeException { + return FileReader.create(file).writeToStream(out); + } + + /** + * 将路径对应文件写入流中，此方法不会关闭输出流 + * + * @param fullFilePath 文件绝对路径 + * @param out 输出流 + * @return 写出的流byte数 + * @throws IORuntimeException IO异常 + */ + public static long writeToStream(String fullFilePath, OutputStream out) throws IORuntimeException { + return writeToStream(touch(fullFilePath), out); + } + + /** + * 可读的文件大小 + * + * @param file 文件 + * @return 大小 + */ + public static String readableFileSize(File file) { + return readableFileSize(file.length()); + } + + /** + * 可读的文件大小
+ * 参考 http://stackoverflow.com/questions/3263892/format-file-size-as-mb-gb-etc + * + * @param size Long类型大小 + * @return 大小 + * @see DataSizeUtil#format(long) + */ + public static String readableFileSize(long size) { + return DataSizeUtil.format(size); + } + + /** + * 转换文件编码
+ * 此方法用于转换文件编码，读取的文件实际编码必须与指定的srcCharset编码一致，否则导致乱码 + * + * @param file 文件 + * @param srcCharset 原文件的编码，必须与文件内容的编码保持一致 + * @param destCharset 转码后的编码 + * @return 被转换编码的文件 + * @see CharsetUtil#convert(File, Charset, Charset) + * @since 3.1.0 + */ + public static File convertCharset(File file, Charset srcCharset, Charset destCharset) { + return CharsetUtil.convert(file, srcCharset, destCharset); + } + + /** + * 转换换行符
+ * 将给定文件的换行符转换为指定换行符 + * + * @param file 文件 + * @param charset 编码 + * @param lineSeparator 换行符枚举{@link LineSeparator} + * @return 被修改的文件 + * @since 3.1.0 + */ + public static File convertLineSeparator(File file, Charset charset, LineSeparator lineSeparator) { + final List lines = readLines(file, charset); + return FileWriter.create(file, charset).writeLines(lines, lineSeparator, false); + } + + /** + * 清除文件名中的在Windows下不支持的非法字符，包括： \ / : * ? " < > | + * + * @param fileName 文件名（必须不包括路径，否则路径符将被替换） + * @return 清理后的文件名 + * @see FileNameUtil#cleanInvalid(String) + * @since 3.3.1 + */ + public static String cleanInvalid(String fileName) { + return FileNameUtil.cleanInvalid(fileName); + } + + /** + * 文件名中是否包含在Windows下不支持的非法字符，包括： \ / : * ? " < > | + * + * @param fileName 文件名（必须不包括路径，否则路径符将被替换） + * @return 是否包含非法字符 + * @see FileNameUtil#containsInvalid(String) + * @since 3.3.1 + */ + public static boolean containsInvalid(String fileName) { + return FileNameUtil.containsInvalid(fileName); + } + + /** + * 计算文件CRC32校验码 + * + * @param file 文件，不能为目录 + * @return CRC32值 + * @throws IORuntimeException IO异常 + * @since 4.0.6 + */ + public static long checksumCRC32(File file) throws IORuntimeException { + return checksum(file, new CRC32()).getValue(); + } + + /** + * 计算文件校验码 + * + * @param file 文件，不能为目录 + * @param checksum {@link Checksum} + * @return Checksum + * @throws IORuntimeException IO异常 + * @since 4.0.6 + */ + public static Checksum checksum(File file, Checksum checksum) throws IORuntimeException { + Assert.notNull(file, "File is null !"); + if (file.isDirectory()) { + throw new IllegalArgumentException("Checksums can't be computed on directories"); + } + try { + return IoUtil.checksum(new FileInputStream(file), checksum); + } catch (FileNotFoundException e) { + throw new IORuntimeException(e); + } + } + + /** + * 获取Web项目下的web root路径
+ * 原理是首先获取ClassPath路径，由于在web项目中ClassPath位于 WEB-INF/classes/下，故向上获取两级目录即可。 + * + * @return web root路径 + * @since 4.0.13 + */ + public static File getWebRoot() { + final String classPath = ClassUtil.getClassPath(); + if (StrUtil.isNotBlank(classPath)) { + return getParent(file(classPath), 2); + } + return null; + } + + /** + * 获取指定层级的父路径 + * + * 
+	 * getParent("d:/aaa/bbb/cc/ddd", 0) -》 "d:/aaa/bbb/cc/ddd"
+	 * getParent("d:/aaa/bbb/cc/ddd", 2) -》 "d:/aaa/bbb"
+	 * getParent("d:/aaa/bbb/cc/ddd", 4) -》 "d:/"
+	 * getParent("d:/aaa/bbb/cc/ddd", 5) -》 null
+	 *
+ * + * @param filePath 目录或文件路径 + * @param level 层级 + * @return 路径File，如果不存在返回null + * @since 4.1.2 + */ + public static String getParent(String filePath, int level) { + final File parent = getParent(file(filePath), level); + try { + return null == parent ? null : parent.getCanonicalPath(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 获取指定层级的父路径 + * + * 
+	 * getParent(file("d:/aaa/bbb/cc/ddd", 0)) -》 "d:/aaa/bbb/cc/ddd"
+	 * getParent(file("d:/aaa/bbb/cc/ddd", 2)) -》 "d:/aaa/bbb"
+	 * getParent(file("d:/aaa/bbb/cc/ddd", 4)) -》 "d:/"
+	 * getParent(file("d:/aaa/bbb/cc/ddd", 5)) -》 null
+	 *
+ * + * @param file 目录或文件 + * @param level 层级 + * @return 路径File，如果不存在返回null + * @since 4.1.2 + */ + public static File getParent(File file, int level) { + if (level < 1 || null == file) { + return file; + } + + File parentFile; + try { + parentFile = file.getCanonicalFile().getParentFile(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + if (1 == level) { + return parentFile; + } + return getParent(parentFile, level - 1); + } + + /** + * 检查父完整路径是否为自路径的前半部分，如果不是说明不是子路径，可能存在slip注入。 + *

+ * 见http://blog.nsfocus.net/zip-slip-2/ + * + * @param parentFile 父文件或目录 + * @param file 子文件或目录 + * @return 子文件或目录 + * @throws IllegalArgumentException 检查创建的子文件不在父目录中抛出此异常 + */ + public static File checkSlip(File parentFile, File file) throws IllegalArgumentException { + if (null != parentFile && null != file) { + String parentCanonicalPath; + String canonicalPath; + try { + parentCanonicalPath = parentFile.getCanonicalPath(); + canonicalPath = file.getCanonicalPath(); + } catch (IOException e) { + // issue#I4CWMO@Gitee + // getCanonicalPath有时会抛出奇怪的IO异常，此时忽略异常，使用AbsolutePath判断。 + parentCanonicalPath = parentFile.getAbsolutePath(); + canonicalPath = file.getAbsolutePath(); + } + if (false == canonicalPath.startsWith(parentCanonicalPath)) { + throw new IllegalArgumentException("New file is outside of the parent dir: " + file.getName()); + } + } + return file; + } + + /** + * 根据文件扩展名获得MimeType + * + * @param filePath 文件路径或文件名 + * @return MimeType + * @since 4.1.15 + */ + public static String getMimeType(String filePath) { + String contentType = URLConnection.getFileNameMap().getContentTypeFor(filePath); + if (null == contentType) { + // 补充一些常用的mimeType + if (StrUtil.endWithIgnoreCase(filePath, ".css")) { + contentType = "text/css"; + } else if (StrUtil.endWithIgnoreCase(filePath, ".js")) { + contentType = "application/x-javascript"; + } else if (StrUtil.endWithIgnoreCase(filePath, ".rar")) { + contentType = "application/x-rar-compressed"; + } else if (StrUtil.endWithIgnoreCase(filePath, ".7z")) { + contentType = "application/x-7z-compressed"; + } else if (StrUtil.endWithIgnoreCase(filePath, ".wgt")) { + contentType = "application/widget"; + } + } + + // 补充 + if (null == contentType) { + contentType = getMimeType(Paths.get(filePath)); + } + + return contentType; + } + + /** + * 判断是否为符号链接文件 + * + * @param file 被检查的文件 + * @return 是否为符号链接文件 + * @since 4.4.2 + */ + public static boolean isSymlink(File file) { + return isSymlink(file.toPath()); + } + + /** + * 判断给定的目录是否为给定文件或文件夹的子目录 + * + * @param parent 父目录 + * @param sub 子目录 + * @return 子目录是否为父目录的子目录 + * @since 4.5.4 + */ + public static boolean isSub(File parent, File sub) { + Assert.notNull(parent); + Assert.notNull(sub); + return isSub(parent.toPath(), sub.toPath()); + } + + /** + * 创建{@link RandomAccessFile} + * + * @param path 文件Path + * @param mode 模式，见{@link FileMode} + * @return {@link RandomAccessFile} + * @since 4.5.2 + */ + public static RandomAccessFile createRandomAccessFile(Path path, FileMode mode) { + return createRandomAccessFile(path.toFile(), mode); + } + + /** + * 创建{@link RandomAccessFile} + * + * @param file 文件 + * @param mode 模式，见{@link FileMode} + * @return {@link RandomAccessFile} + * @since 4.5.2 + */ + public static RandomAccessFile createRandomAccessFile(File file, FileMode mode) { + try { + return new RandomAccessFile(file, mode.name()); + } catch (FileNotFoundException e) { + throw new IORuntimeException(e); + } + } + + /** + * 文件内容跟随器，实现类似Linux下"tail -f"命令功能
+ * 此方法会阻塞当前线程 + * + * @param file 文件 + * @param handler 行处理器 + */ + public static void tail(File file, LineHandler handler) { + tail(file, CharsetUtil.CHARSET_UTF_8, handler); + } + + /** + * 文件内容跟随器，实现类似Linux下"tail -f"命令功能
+ * 此方法会阻塞当前线程 + * + * @param file 文件 + * @param charset 编码 + * @param handler 行处理器 + */ + public static void tail(File file, Charset charset, LineHandler handler) { + new Tailer(file, charset, handler).start(); + } + + /** + * 文件内容跟随器，实现类似Linux下"tail -f"命令功能
+ * 此方法会阻塞当前线程 + * + * @param file 文件 + * @param charset 编码 + */ + public static void tail(File file, Charset charset) { + tail(file, charset, Tailer.CONSOLE_HANDLER); + } + + /** + * 根据压缩包中的路径构建目录结构，在Win下直接构建，在Linux下拆分路径单独构建 + * + * @param outFile 最外部路径 + * @param fileName 文件名，可以包含路径 + * @return 文件或目录 + * @since 5.0.5 + */ + private static File buildFile(File outFile, String fileName) { + // 替换Windows路径分隔符为Linux路径分隔符，便于统一处理 + fileName = fileName.replace('\\', '/'); + if (false == isWindows() + // 检查文件名中是否包含"/"，不考虑以"/"结尾的情况 + && fileName.lastIndexOf(CharUtil.SLASH, fileName.length() - 2) > 0) { + // 在Linux下多层目录创建存在问题，/会被当成文件名的一部分，此处做处理 + // 使用/拆分路径（zip中无\），级联创建父目录 + final List pathParts = StrUtil.split(fileName, '/', false, true); + final int lastPartIndex = pathParts.size() - 1;//目录个数 + for (int i = 0; i < lastPartIndex; i++) { + //由于路径拆分，slip不检查，在最后一步检查 + outFile = new File(outFile, pathParts.get(i)); + } + //noinspection ResultOfMethodCallIgnored + outFile.mkdirs(); + // 最后一个部分如果非空，作为文件名 + fileName = pathParts.get(lastPartIndex); + } + return new File(outFile, fileName); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/IORuntimeException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/IORuntimeException.java new file mode 100644 index 0000000..ba5752a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/IORuntimeException.java @@ -0,0 +1,44 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.exceptions.ExceptionUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * IO运行时异常，常用于对IOException的包装 + * + * @author xiaoleilu + */ +public class IORuntimeException extends RuntimeException { + private static final long serialVersionUID = 8247610319171014183L; + + public IORuntimeException(Throwable e) { + super(ExceptionUtil.getMessage(e), e); + } + + public IORuntimeException(String message) { + super(message); + } + + public IORuntimeException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public IORuntimeException(String message, Throwable throwable) { + super(message, throwable); + } + + public IORuntimeException(Throwable throwable, String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params), throwable); + } + + /** + * 导致这个异常的异常是否是指定类型的异常 + * + * @param clazz 异常类 + * @return 是否为指定类型异常 + */ + public boolean causeInstanceOf(Class clazz) { + final Throwable cause = this.getCause(); + return null != clazz && clazz.isInstance(cause); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/IoUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/IoUtil.java new file mode 100755 index 0000000..90092e6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/IoUtil.java @@ -0,0 +1,1337 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.collection.LineIter; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.io.copy.ReaderWriterCopier; +import aiyh.utils.tool.cn.hutool.core.io.copy.StreamCopier; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.HexUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.BufferedInputStream; +import java.io.BufferedOutputStream; +import java.io.BufferedReader; +import java.io.BufferedWriter; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.Closeable; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.Flushable; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.ObjectOutputStream; +import java.io.OutputStream; +import java.io.OutputStreamWriter; +import java.io.PushbackInputStream; +import java.io.PushbackReader; +import java.io.Reader; +import java.io.Serializable; +import java.io.UnsupportedEncodingException; +import java.io.Writer; +import java.nio.CharBuffer; +import java.nio.channels.FileChannel; +import java.nio.charset.Charset; +import java.util.Collection; +import java.util.Objects; +import java.util.zip.CRC32; +import java.util.zip.CheckedInputStream; +import java.util.zip.Checksum; + +/** + * IO工具类
+ * IO工具类只是辅助流的读写，并不负责关闭流。原因是流可能被多次读写，读写关闭后容易造成问题。 + * + * @author xiaoleilu + */ +public class IoUtil extends NioUtil { + + // -------------------------------------------------------------------------------------- Copy start + + /** + * 将Reader中的内容复制到Writer中 使用默认缓存大小，拷贝后不关闭Reader + * + * @param reader Reader + * @param writer Writer + * @return 拷贝的字节数 + * @throws IORuntimeException IO异常 + */ + public static long copy(Reader reader, Writer writer) throws IORuntimeException { + return copy(reader, writer, DEFAULT_BUFFER_SIZE); + } + + /** + * 将Reader中的内容复制到Writer中，拷贝后不关闭Reader + * + * @param reader Reader + * @param writer Writer + * @param bufferSize 缓存大小 + * @return 传输的byte数 + * @throws IORuntimeException IO异常 + */ + public static long copy(Reader reader, Writer writer, int bufferSize) throws IORuntimeException { + return copy(reader, writer, bufferSize, null); + } + + /** + * 将Reader中的内容复制到Writer中，拷贝后不关闭Reader + * + * @param reader Reader + * @param writer Writer + * @param bufferSize 缓存大小 + * @param streamProgress 进度处理器 + * @return 传输的byte数 + * @throws IORuntimeException IO异常 + */ + public static long copy(Reader reader, Writer writer, int bufferSize, StreamProgress streamProgress) throws IORuntimeException { + return copy(reader, writer, bufferSize, -1, streamProgress); + } + + /** + * 将Reader中的内容复制到Writer中，拷贝后不关闭Reader + * + * @param reader Reader + * @param writer Writer + * @param bufferSize 缓存大小 + * @param count 最大长度 + * @param streamProgress 进度处理器 + * @return 传输的byte数 + * @throws IORuntimeException IO异常 + */ + public static long copy(Reader reader, Writer writer, int bufferSize, long count, StreamProgress streamProgress) throws IORuntimeException { + return new ReaderWriterCopier(bufferSize, count, streamProgress).copy(reader, writer); + } + + /** + * 拷贝流，使用默认Buffer大小，拷贝后不关闭流 + * + * @param in 输入流 + * @param out 输出流 + * @return 传输的byte数 + * @throws IORuntimeException IO异常 + */ + public static long copy(InputStream in, OutputStream out) throws IORuntimeException { + return copy(in, out, DEFAULT_BUFFER_SIZE); + } + + /** + * 拷贝流，拷贝后不关闭流 + * + * @param in 输入流 + * @param out 输出流 + * @param bufferSize 缓存大小 + * @return 传输的byte数 + * @throws IORuntimeException IO异常 + */ + public static long copy(InputStream in, OutputStream out, int bufferSize) throws IORuntimeException { + return copy(in, out, bufferSize, null); + } + + /** + * 拷贝流，拷贝后不关闭流 + * + * @param in 输入流 + * @param out 输出流 + * @param bufferSize 缓存大小 + * @param streamProgress 进度条 + * @return 传输的byte数 + * @throws IORuntimeException IO异常 + */ + public static long copy(InputStream in, OutputStream out, int bufferSize, StreamProgress streamProgress) throws IORuntimeException { + return copy(in, out, bufferSize, -1, streamProgress); + } + + /** + * 拷贝流，拷贝后不关闭流 + * + * @param in 输入流 + * @param out 输出流 + * @param bufferSize 缓存大小 + * @param count 总拷贝长度 + * @param streamProgress 进度条 + * @return 传输的byte数 + * @throws IORuntimeException IO异常 + * @since 5.7.8 + */ + public static long copy(InputStream in, OutputStream out, int bufferSize, long count, StreamProgress streamProgress) throws IORuntimeException { + return new StreamCopier(bufferSize, count, streamProgress).copy(in, out); + } + + /** + * 拷贝文件流，使用NIO + * + * @param in 输入 + * @param out 输出 + * @return 拷贝的字节数 + * @throws IORuntimeException IO异常 + */ + public static long copy(FileInputStream in, FileOutputStream out) throws IORuntimeException { + Assert.notNull(in, "FileInputStream is null!"); + Assert.notNull(out, "FileOutputStream is null!"); + + FileChannel inChannel = null; + FileChannel outChannel = null; + try { + inChannel = in.getChannel(); + outChannel = out.getChannel(); + return copy(inChannel, outChannel); + } finally { + close(outChannel); + close(inChannel); + } + } + + // -------------------------------------------------------------------------------------- Copy end + + // -------------------------------------------------------------------------------------- getReader and getWriter start + + /** + * 获得一个文件读取器，默认使用UTF-8编码 + * + * @param in 输入流 + * @return BufferedReader对象 + * @since 5.1.6 + */ + public static BufferedReader getUtf8Reader(InputStream in) { + return getReader(in, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 获得一个文件读取器 + * + * @param in 输入流 + * @param charsetName 字符集名称 + * @return BufferedReader对象 + * @deprecated 请使用 {@link #getReader(InputStream, Charset)} + */ + @Deprecated + public static BufferedReader getReader(InputStream in, String charsetName) { + return getReader(in, Charset.forName(charsetName)); + } + + /** + * 从{@link BOMInputStream}中获取Reader + * + * @param in {@link BOMInputStream} + * @return {@link BufferedReader} + * @since 5.5.8 + */ + public static BufferedReader getReader(BOMInputStream in) { + return getReader(in, in.getCharset()); + } + + /** + * 从{@link InputStream}中获取{@link BomReader} + * + * @param in {@link InputStream} + * @return {@link BomReader} + * @since 5.7.14 + */ + public static BomReader getBomReader(InputStream in) { + return new BomReader(in); + } + + /** + * 获得一个Reader + * + * @param in 输入流 + * @param charset 字符集 + * @return BufferedReader对象 + */ + public static BufferedReader getReader(InputStream in, Charset charset) { + if (null == in) { + return null; + } + + InputStreamReader reader; + if (null == charset) { + reader = new InputStreamReader(in); + } else { + reader = new InputStreamReader(in, charset); + } + + return new BufferedReader(reader); + } + + /** + * 获得{@link BufferedReader}
+ * 如果是{@link BufferedReader}强转返回，否则新建。如果提供的Reader为null返回null + * + * @param reader 普通Reader，如果为null返回null + * @return {@link BufferedReader} or null + * @since 3.0.9 + */ + public static BufferedReader getReader(Reader reader) { + if (null == reader) { + return null; + } + + return (reader instanceof BufferedReader) ? (BufferedReader) reader : new BufferedReader(reader); + } + + /** + * 获得{@link PushbackReader}
+ * 如果是{@link PushbackReader}强转返回，否则新建 + * + * @param reader 普通Reader + * @param pushBackSize 推后的byte数 + * @return {@link PushbackReader} + * @since 3.1.0 + */ + public static PushbackReader getPushBackReader(Reader reader, int pushBackSize) { + return (reader instanceof PushbackReader) ? (PushbackReader) reader : new PushbackReader(reader, pushBackSize); + } + + /** + * 获得一个Writer，默认编码UTF-8 + * + * @param out 输入流 + * @return OutputStreamWriter对象 + * @since 5.1.6 + */ + public static OutputStreamWriter getUtf8Writer(OutputStream out) { + return getWriter(out, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 获得一个Writer + * + * @param out 输入流 + * @param charsetName 字符集 + * @return OutputStreamWriter对象 + * @deprecated 请使用 {@link #getWriter(OutputStream, Charset)} + */ + @Deprecated + public static OutputStreamWriter getWriter(OutputStream out, String charsetName) { + return getWriter(out, Charset.forName(charsetName)); + } + + /** + * 获得一个Writer + * + * @param out 输入流 + * @param charset 字符集 + * @return OutputStreamWriter对象 + */ + public static OutputStreamWriter getWriter(OutputStream out, Charset charset) { + if (null == out) { + return null; + } + + if (null == charset) { + return new OutputStreamWriter(out); + } else { + return new OutputStreamWriter(out, charset); + } + } + // -------------------------------------------------------------------------------------- getReader and getWriter end + + // -------------------------------------------------------------------------------------- read start + + /** + * 从流中读取UTF8编码的内容 + * + * @param in 输入流 + * @return 内容 + * @throws IORuntimeException IO异常 + * @since 5.4.4 + */ + public static String readUtf8(InputStream in) throws IORuntimeException { + return read(in, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 从流中读取内容，读取完成后关闭流 + * + * @param in 输入流 + * @param charsetName 字符集 + * @return 内容 + * @throws IORuntimeException IO异常 + * @deprecated 请使用 {@link #read(InputStream, Charset)} + */ + @Deprecated + public static String read(InputStream in, String charsetName) throws IORuntimeException { + final FastByteArrayOutputStream out = read(in); + return StrUtil.isBlank(charsetName) ? out.toString() : out.toString(charsetName); + } + + /** + * 从流中读取内容，读取完毕后关闭流 + * + * @param in 输入流，读取完毕后关闭流 + * @param charset 字符集 + * @return 内容 + * @throws IORuntimeException IO异常 + */ + public static String read(InputStream in, Charset charset) throws IORuntimeException { + return StrUtil.str(readBytes(in), charset); + } + + /** + * 从流中读取内容，读到输出流中，读取完毕后关闭流 + * + * @param in 输入流 + * @return 输出流 + * @throws IORuntimeException IO异常 + */ + public static FastByteArrayOutputStream read(InputStream in) throws IORuntimeException { + return read(in, true); + } + + /** + * 从流中读取内容，读到输出流中，读取完毕后可选是否关闭流 + * + * @param in 输入流 + * @param isClose 读取完毕后是否关闭流 + * @return 输出流 + * @throws IORuntimeException IO异常 + * @since 5.5.3 + */ + public static FastByteArrayOutputStream read(InputStream in, boolean isClose) throws IORuntimeException { + final FastByteArrayOutputStream out; + if (in instanceof FileInputStream) { + // 文件流的长度是可预见的，此时直接读取效率更高 + try { + out = new FastByteArrayOutputStream(in.available()); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } else { + out = new FastByteArrayOutputStream(); + } + try { + copy(in, out); + } finally { + if (isClose) { + close(in); + } + } + return out; + } + + /** + * 从Reader中读取String，读取完毕后关闭Reader + * + * @param reader Reader + * @return String + * @throws IORuntimeException IO异常 + */ + public static String read(Reader reader) throws IORuntimeException { + return read(reader, true); + } + + /** + * 从{@link Reader}中读取String + * + * @param reader {@link Reader} + * @param isClose 是否关闭{@link Reader} + * @return String + * @throws IORuntimeException IO异常 + */ + public static String read(Reader reader, boolean isClose) throws IORuntimeException { + final StringBuilder builder = StrUtil.builder(); + final CharBuffer buffer = CharBuffer.allocate(DEFAULT_BUFFER_SIZE); + try { + while (-1 != reader.read(buffer)) { + builder.append(buffer.flip()); + } + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + if (isClose) { + IoUtil.close(reader); + } + } + return builder.toString(); + } + + /** + * 从流中读取bytes，读取完毕后关闭流 + * + * @param in {@link InputStream} + * @return bytes + * @throws IORuntimeException IO异常 + */ + public static byte[] readBytes(InputStream in) throws IORuntimeException { + return readBytes(in, true); + } + + /** + * 从流中读取bytes + * + * @param in {@link InputStream} + * @param isClose 是否关闭输入流 + * @return bytes + * @throws IORuntimeException IO异常 + * @since 5.0.4 + */ + public static byte[] readBytes(InputStream in, boolean isClose) throws IORuntimeException { + return read(in, isClose).toByteArray(); + } + + /** + * 读取指定长度的byte数组，不关闭流 + * + * @param in {@link InputStream}，为{@code null}返回{@code null} + * @param length 长度，小于等于0返回空byte数组 + * @return bytes + * @throws IORuntimeException IO异常 + */ + public static byte[] readBytes(InputStream in, int length) throws IORuntimeException { + if (null == in) { + return null; + } + if (length <= 0) { + return new byte[0]; + } + + final FastByteArrayOutputStream out = new FastByteArrayOutputStream(length); + copy(in, out, DEFAULT_BUFFER_SIZE, length, null); + return out.toByteArray(); + } + + /** + * 读取16进制字符串 + * + * @param in {@link InputStream} + * @param length 长度 + * @param toLowerCase true 传换成小写格式 ， false 传换成大写格式 + * @return 16进制字符串 + * @throws IORuntimeException IO异常 + */ + public static String readHex(InputStream in, int length, boolean toLowerCase) throws IORuntimeException { + return HexUtil.encodeHexStr(readBytes(in, length), toLowerCase); + } + + /** + * 从流中读取前64个byte并转换为16进制，字母部分使用大写 + * + * @param in {@link InputStream} + * @return 16进制字符串 + * @throws IORuntimeException IO异常 + */ + public static String readHex64Upper(InputStream in) throws IORuntimeException { + return readHex(in, 64, false); + } + + /** + * 从流中读取前8192个byte并转换为16进制，字母部分使用大写 + * + * @param in {@link InputStream} + * @return 16进制字符串 + * @throws IORuntimeException IO异常 + */ + public static String readHex8192Upper(InputStream in) throws IORuntimeException { + try { + int i = in.available(); + return readHex(in, Math.min(8192, in.available()), false); + } catch (IOException e) { + throw new RuntimeException(e); + } + } + + /** + * 从流中读取前64个byte并转换为16进制，字母部分使用小写 + * + * @param in {@link InputStream} + * @return 16进制字符串 + * @throws IORuntimeException IO异常 + */ + public static String readHex64Lower(InputStream in) throws IORuntimeException { + return readHex(in, 64, true); + } + + /** + * 从流中读取对象，即对象的反序列化 + * + *

+ * 注意！！！ 此方法不会检查反序列化安全，可能存在反序列化漏洞风险！！！ + *

+ * + * @param 读取对象的类型 + * @param in 输入流 + * @return 输出流 + * @throws IORuntimeException IO异常 + * @throws UtilException ClassNotFoundException包装 + */ + public static T readObj(InputStream in) throws IORuntimeException, UtilException { + return readObj(in, null); + } + + /** + * 从流中读取对象，即对象的反序列化，读取后不关闭流 + * + *

+ * 注意！！！ 此方法不会检查反序列化安全，可能存在反序列化漏洞风险！！！ + *

+ * + * @param 读取对象的类型 + * @param in 输入流 + * @param clazz 读取对象类型 + * @return 输出流 + * @throws IORuntimeException IO异常 + * @throws UtilException ClassNotFoundException包装 + */ + public static T readObj(InputStream in, Class clazz) throws IORuntimeException, UtilException { + try { + return readObj((in instanceof ValidateObjectInputStream) ? + (ValidateObjectInputStream) in : new ValidateObjectInputStream(in), + clazz); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 从流中读取对象，即对象的反序列化，读取后不关闭流 + * + *

+ * 此方法使用了{@link ValidateObjectInputStream}中的黑白名单方式过滤类，用于避免反序列化漏洞
+ * 通过构造{@link ValidateObjectInputStream}，调用{@link ValidateObjectInputStream#accept(Class[])} + * 或者{@link ValidateObjectInputStream#refuse(Class[])}方法添加可以被序列化的类或者禁止序列化的类。 + *

+ * + * @param 读取对象的类型 + * @param in 输入流，使用{@link ValidateObjectInputStream}中的黑白名单方式过滤类，用于避免反序列化漏洞 + * @param clazz 读取对象类型 + * @return 输出流 + * @throws IORuntimeException IO异常 + * @throws UtilException ClassNotFoundException包装 + */ + public static T readObj(ValidateObjectInputStream in, Class clazz) throws IORuntimeException, UtilException { + if (in == null) { + throw new IllegalArgumentException("The InputStream must not be null"); + } + if(null != clazz){ + in.accept(clazz); + } + try { + //noinspection unchecked + return (T) in.readObject(); + } catch (IOException e) { + throw new IORuntimeException(e); + } catch (ClassNotFoundException e) { + throw new UtilException(e); + } + } + + /** + * 从流中读取内容，使用UTF-8编码 + * + * @param 集合类型 + * @param in 输入流 + * @param collection 返回集合 + * @return 内容 + * @throws IORuntimeException IO异常 + */ + public static > T readUtf8Lines(InputStream in, T collection) throws IORuntimeException { + return readLines(in, CharsetUtil.CHARSET_UTF_8, collection); + } + + /** + * 从流中读取内容 + * + * @param 集合类型 + * @param in 输入流 + * @param charsetName 字符集 + * @param collection 返回集合 + * @return 内容 + * @throws IORuntimeException IO异常 + * @deprecated 请使用 {@link #readLines(InputStream, Charset, Collection)} + */ + @Deprecated + public static > T readLines(InputStream in, String charsetName, T collection) throws IORuntimeException { + return readLines(in, CharsetUtil.charset(charsetName), collection); + } + + /** + * 从流中读取内容 + * + * @param 集合类型 + * @param in 输入流 + * @param charset 字符集 + * @param collection 返回集合 + * @return 内容 + * @throws IORuntimeException IO异常 + */ + public static > T readLines(InputStream in, Charset charset, T collection) throws IORuntimeException { + return readLines(getReader(in, charset), collection); + } + + /** + * 从Reader中读取内容 + * + * @param 集合类型 + * @param reader {@link Reader} + * @param collection 返回集合 + * @return 内容 + * @throws IORuntimeException IO异常 + */ + public static > T readLines(Reader reader, T collection) throws IORuntimeException { + readLines(reader, (LineHandler) collection::add); + return collection; + } + + /** + * 按行读取UTF-8编码数据，针对每行的数据做处理 + * + * @param in {@link InputStream} + * @param lineHandler 行处理接口，实现handle方法用于编辑一行的数据后入到指定地方 + * @throws IORuntimeException IO异常 + * @since 3.1.1 + */ + public static void readUtf8Lines(InputStream in, LineHandler lineHandler) throws IORuntimeException { + readLines(in, CharsetUtil.CHARSET_UTF_8, lineHandler); + } + + /** + * 按行读取数据，针对每行的数据做处理 + * + * @param in {@link InputStream} + * @param charset {@link Charset}编码 + * @param lineHandler 行处理接口，实现handle方法用于编辑一行的数据后入到指定地方 + * @throws IORuntimeException IO异常 + * @since 3.0.9 + */ + public static void readLines(InputStream in, Charset charset, LineHandler lineHandler) throws IORuntimeException { + readLines(getReader(in, charset), lineHandler); + } + + /** + * 按行读取数据，针对每行的数据做处理
+ * {@link Reader}自带编码定义，因此读取数据的编码跟随其编码。
+ * 此方法不会关闭流，除非抛出异常 + * + * @param reader {@link Reader} + * @param lineHandler 行处理接口，实现handle方法用于编辑一行的数据后入到指定地方 + * @throws IORuntimeException IO异常 + */ + public static void readLines(Reader reader, LineHandler lineHandler) throws IORuntimeException { + Assert.notNull(reader); + Assert.notNull(lineHandler); + + for (String line : lineIter(reader)) { + lineHandler.handle(line); + } + } + + // -------------------------------------------------------------------------------------- read end + + /** + * String 转为流 + * + * @param content 内容 + * @param charsetName 编码 + * @return 字节流 + * @deprecated 请使用 {@link #toStream(String, Charset)} + */ + @Deprecated + public static ByteArrayInputStream toStream(String content, String charsetName) { + return toStream(content, CharsetUtil.charset(charsetName)); + } + + /** + * String 转为流 + * + * @param content 内容 + * @param charset 编码 + * @return 字节流 + */ + public static ByteArrayInputStream toStream(String content, Charset charset) { + if (content == null) { + return null; + } + return toStream(StrUtil.bytes(content, charset)); + } + + /** + * String 转为UTF-8编码的字节流流 + * + * @param content 内容 + * @return 字节流 + * @since 4.5.1 + */ + public static ByteArrayInputStream toUtf8Stream(String content) { + return toStream(content, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 文件转为{@link FileInputStream} + * + * @param file 文件 + * @return {@link FileInputStream} + */ + public static FileInputStream toStream(File file) { + try { + return new FileInputStream(file); + } catch (FileNotFoundException e) { + throw new IORuntimeException(e); + } + } + + /** + * byte[] 转为{@link ByteArrayInputStream} + * + * @param content 内容bytes + * @return 字节流 + * @since 4.1.8 + */ + public static ByteArrayInputStream toStream(byte[] content) { + if (content == null) { + return null; + } + return new ByteArrayInputStream(content); + } + + /** + * {@link ByteArrayOutputStream}转为{@link ByteArrayInputStream} + * + * @param out {@link ByteArrayOutputStream} + * @return 字节流 + * @since 5.3.6 + */ + public static ByteArrayInputStream toStream(ByteArrayOutputStream out) { + if (out == null) { + return null; + } + return new ByteArrayInputStream(out.toByteArray()); + } + + /** + * 转换为{@link BufferedInputStream} + * + * @param in {@link InputStream} + * @return {@link BufferedInputStream} + * @since 4.0.10 + */ + public static BufferedInputStream toBuffered(InputStream in) { + Assert.notNull(in, "InputStream must be not null!"); + return (in instanceof BufferedInputStream) ? (BufferedInputStream) in : new BufferedInputStream(in); + } + + /** + * 转换为{@link BufferedInputStream} + * + * @param in {@link InputStream} + * @param bufferSize buffer size + * @return {@link BufferedInputStream} + * @since 5.6.1 + */ + public static BufferedInputStream toBuffered(InputStream in, int bufferSize) { + Assert.notNull(in, "InputStream must be not null!"); + return (in instanceof BufferedInputStream) ? (BufferedInputStream) in : new BufferedInputStream(in, bufferSize); + } + + /** + * 转换为{@link BufferedOutputStream} + * + * @param out {@link OutputStream} + * @return {@link BufferedOutputStream} + * @since 4.0.10 + */ + public static BufferedOutputStream toBuffered(OutputStream out) { + Assert.notNull(out, "OutputStream must be not null!"); + return (out instanceof BufferedOutputStream) ? (BufferedOutputStream) out : new BufferedOutputStream(out); + } + + /** + * 转换为{@link BufferedOutputStream} + * + * @param out {@link OutputStream} + * @param bufferSize buffer size + * @return {@link BufferedOutputStream} + * @since 5.6.1 + */ + public static BufferedOutputStream toBuffered(OutputStream out, int bufferSize) { + Assert.notNull(out, "OutputStream must be not null!"); + return (out instanceof BufferedOutputStream) ? (BufferedOutputStream) out : new BufferedOutputStream(out, bufferSize); + } + + /** + * 转换为{@link BufferedReader} + * + * @param reader {@link Reader} + * @return {@link BufferedReader} + * @since 5.6.1 + */ + public static BufferedReader toBuffered(Reader reader) { + Assert.notNull(reader, "Reader must be not null!"); + return (reader instanceof BufferedReader) ? (BufferedReader) reader : new BufferedReader(reader); + } + + /** + * 转换为{@link BufferedReader} + * + * @param reader {@link Reader} + * @param bufferSize buffer size + * @return {@link BufferedReader} + * @since 5.6.1 + */ + public static BufferedReader toBuffered(Reader reader, int bufferSize) { + Assert.notNull(reader, "Reader must be not null!"); + return (reader instanceof BufferedReader) ? (BufferedReader) reader : new BufferedReader(reader, bufferSize); + } + + /** + * 转换为{@link BufferedWriter} + * + * @param writer {@link Writer} + * @return {@link BufferedWriter} + * @since 5.6.1 + */ + public static BufferedWriter toBuffered(Writer writer) { + Assert.notNull(writer, "Writer must be not null!"); + return (writer instanceof BufferedWriter) ? (BufferedWriter) writer : new BufferedWriter(writer); + } + + /** + * 转换为{@link BufferedWriter} + * + * @param writer {@link Writer} + * @param bufferSize buffer size + * @return {@link BufferedWriter} + * @since 5.6.1 + */ + public static BufferedWriter toBuffered(Writer writer, int bufferSize) { + Assert.notNull(writer, "Writer must be not null!"); + return (writer instanceof BufferedWriter) ? (BufferedWriter) writer : new BufferedWriter(writer, bufferSize); + } + + /** + * 将{@link InputStream}转换为支持mark标记的流
+ * 若原流支持mark标记，则返回原流，否则使用{@link BufferedInputStream} 包装之 + * + * @param in 流 + * @return {@link InputStream} + * @since 4.0.9 + */ + public static InputStream toMarkSupportStream(InputStream in) { + if (null == in) { + return null; + } + if (false == in.markSupported()) { + return new BufferedInputStream(in); + } + return in; + } + + /** + * 转换为{@link PushbackInputStream}
+ * 如果传入的输入流已经是{@link PushbackInputStream}，强转返回，否则新建一个 + * + * @param in {@link InputStream} + * @param pushBackSize 推后的byte数 + * @return {@link PushbackInputStream} + * @since 3.1.0 + */ + public static PushbackInputStream toPushbackStream(InputStream in, int pushBackSize) { + return (in instanceof PushbackInputStream) ? (PushbackInputStream) in : new PushbackInputStream(in, pushBackSize); + } + + /** + * 将指定{@link InputStream} 转换为{@link InputStream#available()}方法可用的流。
+ * 在Socket通信流中，服务端未返回数据情况下{@link InputStream#available()}方法始终为{@code 0}
+ * 因此，在读取前需要调用{@link InputStream#read()}读取一个字节（未返回会阻塞），一旦读取到了，{@link InputStream#available()}方法就正常了。
+ * 需要注意的是，在网络流中，是按照块来传输的，所以 {@link InputStream#available()} 读取到的并非最终长度，而是此次块的长度。
+ * 此方法返回对象的规则为： + * + *
    + *
  • FileInputStream 返回原对象，因为文件流的available方法本身可用
    • + *
  • 其它InputStream 返回PushbackInputStream
    • + *
+ * + * @param in 被转换的流 + * @return 转换后的流，可能为{@link PushbackInputStream} + * @since 5.5.3 + */ + public static InputStream toAvailableStream(InputStream in) { + if (in instanceof FileInputStream) { + // FileInputStream本身支持available方法。 + return in; + } + + final PushbackInputStream pushbackInputStream = toPushbackStream(in, 1); + try { + final int available = pushbackInputStream.available(); + if (available <= 0) { + //此操作会阻塞，直到有数据被读到 + int b = pushbackInputStream.read(); + pushbackInputStream.unread(b); + } + } catch (IOException e) { + throw new IORuntimeException(e); + } + + return pushbackInputStream; + } + + /** + * 将byte[]写到流中 + * + * @param out 输出流 + * @param isCloseOut 写入完毕是否关闭输出流 + * @param content 写入的内容 + * @throws IORuntimeException IO异常 + */ + public static void write(OutputStream out, boolean isCloseOut, byte[] content) throws IORuntimeException { + try { + out.write(content); + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + if (isCloseOut) { + close(out); + } + } + } + + /** + * 将多部分内容写到流中，自动转换为UTF-8字符串 + * + * @param out 输出流 + * @param isCloseOut 写入完毕是否关闭输出流 + * @param contents 写入的内容，调用toString()方法，不包括不会自动换行 + * @throws IORuntimeException IO异常 + * @since 3.1.1 + */ + public static void writeUtf8(OutputStream out, boolean isCloseOut, Object... contents) throws IORuntimeException { + write(out, CharsetUtil.CHARSET_UTF_8, isCloseOut, contents); + } + + /** + * 将多部分内容写到流中，自动转换为字符串 + * + * @param out 输出流 + * @param charsetName 写出的内容的字符集 + * @param isCloseOut 写入完毕是否关闭输出流 + * @param contents 写入的内容，调用toString()方法，不包括不会自动换行 + * @throws IORuntimeException IO异常 + * @deprecated 请使用 {@link #write(OutputStream, Charset, boolean, Object...)} + */ + @Deprecated + public static void write(OutputStream out, String charsetName, boolean isCloseOut, Object... contents) throws IORuntimeException { + write(out, CharsetUtil.charset(charsetName), isCloseOut, contents); + } + + /** + * 将多部分内容写到流中，自动转换为字符串 + * + * @param out 输出流 + * @param charset 写出的内容的字符集 + * @param isCloseOut 写入完毕是否关闭输出流 + * @param contents 写入的内容，调用toString()方法，不包括不会自动换行 + * @throws IORuntimeException IO异常 + * @since 3.0.9 + */ + public static void write(OutputStream out, Charset charset, boolean isCloseOut, Object... contents) throws IORuntimeException { + OutputStreamWriter osw = null; + try { + osw = getWriter(out, charset); + for (Object content : contents) { + if (content != null) { + osw.write(Convert.toStr(content, StrUtil.EMPTY)); + } + } + osw.flush(); + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + if (isCloseOut) { + close(osw); + } + } + } + + /** + * 将多部分内容写到流中 + * + * @param out 输出流 + * @param isCloseOut 写入完毕是否关闭输出流 + * @param obj 写入的对象内容 + * @throws IORuntimeException IO异常 + * @since 5.3.3 + */ + public static void writeObj(OutputStream out, boolean isCloseOut, Serializable obj) throws IORuntimeException { + writeObjects(out, isCloseOut, obj); + } + + /** + * 将多部分内容写到流中 + * + * @param out 输出流 + * @param isCloseOut 写入完毕是否关闭输出流 + * @param contents 写入的内容 + * @throws IORuntimeException IO异常 + */ + public static void writeObjects(OutputStream out, boolean isCloseOut, Serializable... contents) throws IORuntimeException { + ObjectOutputStream osw = null; + try { + osw = out instanceof ObjectOutputStream ? (ObjectOutputStream) out : new ObjectOutputStream(out); + for (Object content : contents) { + if (content != null) { + osw.writeObject(content); + } + } + osw.flush(); + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + if (isCloseOut) { + close(osw); + } + } + } + + /** + * 从缓存中刷出数据 + * + * @param flushable {@link Flushable} + * @since 4.2.2 + */ + public static void flush(Flushable flushable) { + if (null != flushable) { + try { + flushable.flush(); + } catch (Exception e) { + // 静默刷出 + } + } + } + + /** + * 关闭
+ * 关闭失败不会抛出异常 + * + * @param closeable 被关闭的对象 + */ + public static void close(Closeable closeable) { + if (null != closeable) { + try { + closeable.close(); + } catch (Exception e) { + // 静默关闭 + } + } + } + + /** + * 尝试关闭指定对象
+ * 判断对象如果实现了{@link AutoCloseable}，则调用之 + * + * @param obj 可关闭对象 + * @since 4.3.2 + */ + public static void closeIfPosible(Object obj) { + if (obj instanceof AutoCloseable) { + close((AutoCloseable) obj); + } + } + + /** + * 对比两个流内容是否相同
+ * 内部会转换流为 {@link BufferedInputStream} + * + * @param input1 第一个流 + * @param input2 第二个流 + * @return 两个流的内容一致返回true，否则false + * @throws IORuntimeException IO异常 + * @since 4.0.6 + */ + public static boolean contentEquals(InputStream input1, InputStream input2) throws IORuntimeException { + if (false == (input1 instanceof BufferedInputStream)) { + input1 = new BufferedInputStream(input1); + } + if (false == (input2 instanceof BufferedInputStream)) { + input2 = new BufferedInputStream(input2); + } + + try { + int ch = input1.read(); + while (EOF != ch) { + int ch2 = input2.read(); + if (ch != ch2) { + return false; + } + ch = input1.read(); + } + + int ch2 = input2.read(); + return ch2 == EOF; + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 对比两个Reader的内容是否一致
+ * 内部会转换流为 {@link BufferedInputStream} + * + * @param input1 第一个reader + * @param input2 第二个reader + * @return 两个流的内容一致返回true，否则false + * @throws IORuntimeException IO异常 + * @since 4.0.6 + */ + public static boolean contentEquals(Reader input1, Reader input2) throws IORuntimeException { + input1 = getReader(input1); + input2 = getReader(input2); + + try { + int ch = input1.read(); + while (EOF != ch) { + int ch2 = input2.read(); + if (ch != ch2) { + return false; + } + ch = input1.read(); + } + + int ch2 = input2.read(); + return ch2 == EOF; + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 对比两个流内容是否相同，忽略EOL字符
+ * 内部会转换流为 {@link BufferedInputStream} + * + * @param input1 第一个流 + * @param input2 第二个流 + * @return 两个流的内容一致返回true，否则false + * @throws IORuntimeException IO异常 + * @since 4.0.6 + */ + public static boolean contentEqualsIgnoreEOL(Reader input1, Reader input2) throws IORuntimeException { + final BufferedReader br1 = getReader(input1); + final BufferedReader br2 = getReader(input2); + + try { + String line1 = br1.readLine(); + String line2 = br2.readLine(); + while (line1 != null && line1.equals(line2)) { + line1 = br1.readLine(); + line2 = br2.readLine(); + } + return Objects.equals(line1, line2); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 计算流CRC32校验码，计算后关闭流 + * + * @param in 文件，不能为目录 + * @return CRC32值 + * @throws IORuntimeException IO异常 + * @since 4.0.6 + */ + public static long checksumCRC32(InputStream in) throws IORuntimeException { + return checksum(in, new CRC32()).getValue(); + } + + /** + * 计算流的校验码，计算后关闭流 + * + * @param in 流 + * @param checksum {@link Checksum} + * @return Checksum + * @throws IORuntimeException IO异常 + * @since 4.0.10 + */ + public static Checksum checksum(InputStream in, Checksum checksum) throws IORuntimeException { + Assert.notNull(in, "InputStream is null !"); + if (null == checksum) { + checksum = new CRC32(); + } + try { + in = new CheckedInputStream(in, checksum); + IoUtil.copy(in, new NullOutputStream()); + } finally { + IoUtil.close(in); + } + return checksum; + } + + /** + * 计算流的校验码，计算后关闭流 + * + * @param in 流 + * @param checksum {@link Checksum} + * @return Checksum + * @throws IORuntimeException IO异常 + * @since 5.4.0 + */ + public static long checksumValue(InputStream in, Checksum checksum) { + return checksum(in, checksum).getValue(); + } + + /** + * 返回行遍历器 + * 
+	 * LineIterator it = null;
+	 * try {
+	 * 	it = IoUtil.lineIter(reader);
+	 * 	while (it.hasNext()) {
+	 * 		String line = it.nextLine();
+	 * 		// do something with line
+	 *    }
+	 * } finally {
+	 * 		it.close();
+	 * }
+	 *
+ * + * @param reader {@link Reader} + * @return {@link LineIter} + * @since 5.6.1 + */ + public static LineIter lineIter(Reader reader) { + return new LineIter(reader); + } + + /** + * 返回行遍历器 + * 
+	 * LineIterator it = null;
+	 * try {
+	 * 	it = IoUtil.lineIter(in, CharsetUtil.CHARSET_UTF_8);
+	 * 	while (it.hasNext()) {
+	 * 		String line = it.nextLine();
+	 * 		// do something with line
+	 *    }
+	 * } finally {
+	 * 		it.close();
+	 * }
+	 *
+ * + * @param in {@link InputStream} + * @param charset 编码 + * @return {@link LineIter} + * @since 5.6.1 + */ + public static LineIter lineIter(InputStream in, Charset charset) { + return new LineIter(in, charset); + } + + /** + * {@link ByteArrayOutputStream} 转换为String + * @param out {@link ByteArrayOutputStream} + * @param charset 编码 + * @return 字符串 + * @since 5.7.17 + */ + public static String toStr(ByteArrayOutputStream out, Charset charset){ + try { + return out.toString(charset.name()); + } catch (UnsupportedEncodingException e) { + throw new IORuntimeException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/LimitedInputStream.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/LimitedInputStream.java new file mode 100755 index 0000000..c5217a6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/LimitedInputStream.java @@ -0,0 +1,63 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import java.io.FilterInputStream; +import java.io.IOException; +import java.io.InputStream; + +/** + * 限制读取最大长度的{@link FilterInputStream} 实现
+ * 来自：https://github.com/skylot/jadx/blob/master/jadx-plugins/jadx-plugins-api/src/main/java/jadx/api/plugins/utils/LimitedInputStream.java + * + * @author jadx + */ +public class LimitedInputStream extends FilterInputStream { + + private final long maxSize; + private long currentPos; + + /** + * 构造 + * @param in {@link InputStream} + * @param maxSize 限制最大读取量，单位byte + */ + public LimitedInputStream(InputStream in, long maxSize) { + super(in); + this.maxSize = maxSize; + } + + @Override + public int read() throws IOException { + final int data = super.read(); + if (data != -1) { + currentPos++; + checkPos(); + } + return data; + } + + @Override + public int read(byte[] b, int off, int len) throws IOException { + final int count = super.read(b, off, len); + if (count > 0) { + currentPos += count; + checkPos(); + } + return count; + } + + @Override + public long skip(long n) throws IOException { + final long skipped = super.skip(n); + if (skipped != 0) { + currentPos += skipped; + checkPos(); + } + return skipped; + } + + private void checkPos() { + if (currentPos > maxSize) { + throw new IllegalStateException("Read limit exceeded"); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/LineHandler.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/LineHandler.java new file mode 100644 index 0000000..865b647 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/LineHandler.java @@ -0,0 +1,15 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +/** + * 行处理器 + * @author Looly + * + */ +@FunctionalInterface +public interface LineHandler { + /** + * 处理一行数据，可以编辑后存入指定地方 + * @param line 行 + */ + void handle(String line); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/ManifestUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/ManifestUtil.java new file mode 100644 index 0000000..a192ea4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/ManifestUtil.java @@ -0,0 +1,120 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.io.resource.ResourceUtil; + +import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; +import java.net.JarURLConnection; +import java.net.URL; +import java.net.URLConnection; +import java.util.jar.JarFile; +import java.util.jar.Manifest; + +/** + * Jar包中manifest.mf文件获取和解析工具类 + * 来自Jodd + * + * @author looly, jodd + * @since 5.7.0 + */ +public class ManifestUtil { + private static final String[] MANIFEST_NAMES = {"Manifest.mf", "manifest.mf", "MANIFEST.MF"}; + + /** + * 根据 class 获取 所在 jar 包文件的 Manifest
+ * 此方法主要利用class定位jar包，如引入hutool-all，则传入hutool中任意一个类即可获取这个jar的Manifest信息
+ * 如果这个类不在jar包中，返回{@code null} + * + * @param cls 类 + * @return Manifest + * @throws IORuntimeException IO异常 + */ + public static Manifest getManifest(Class cls) throws IORuntimeException { + URL url = ResourceUtil.getResource(null, cls); + URLConnection connection; + try { + connection = url.openConnection(); + }catch (final IOException e) { + throw new IORuntimeException(e); + } + + if (connection instanceof JarURLConnection) { + JarURLConnection conn = (JarURLConnection) connection; + return getManifest(conn); + } + return null; + } + + /** + * 获取 jar 包文件或项目目录下的 Manifest + * + * @param classpathItem 文件路径 + * @return Manifest + * @throws IORuntimeException IO异常 + */ + public static Manifest getManifest(File classpathItem) throws IORuntimeException{ + Manifest manifest = null; + + if (classpathItem.isFile()) { + try (JarFile jarFile = new JarFile(classpathItem)){ + manifest = getManifest(jarFile); + } catch (final IOException e) { + throw new IORuntimeException(e); + } + } else { + final File metaDir = new File(classpathItem, "META-INF"); + File manifestFile = null; + if (metaDir.isDirectory()) { + for (final String name : MANIFEST_NAMES) { + final File mFile = new File(metaDir, name); + if (mFile.isFile()) { + manifestFile = mFile; + break; + } + } + } + if (null != manifestFile) { + try(FileInputStream fis = new FileInputStream(manifestFile)){ + manifest = new Manifest(fis); + } catch (final IOException e) { + throw new IORuntimeException(e); + } + } + } + + return manifest; + } + + /** + * 根据 {@link JarURLConnection} 获取 jar 包文件的 Manifest + * + * @param connection {@link JarURLConnection} + * @return Manifest + * @throws IORuntimeException IO异常 + */ + public static Manifest getManifest(JarURLConnection connection) throws IORuntimeException{ + final JarFile jarFile; + try { + jarFile = connection.getJarFile(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + return getManifest(jarFile); + } + + /** + * 根据 {@link JarURLConnection} 获取 jar 包文件的 Manifest + * + * @param jarFile {@link JarURLConnection} + * @return Manifest + * @throws IORuntimeException IO异常 + */ + public static Manifest getManifest(JarFile jarFile) throws IORuntimeException { + try { + return jarFile.getManifest(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/NioUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/NioUtil.java new file mode 100644 index 0000000..034bf57 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/NioUtil.java @@ -0,0 +1,275 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.io.copy.ChannelCopier; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.MappedByteBuffer; +import java.nio.channels.Channels; +import java.nio.channels.FileChannel; +import java.nio.channels.ReadableByteChannel; +import java.nio.channels.WritableByteChannel; +import java.nio.charset.Charset; + +/** + * NIO相关工具封装，主要针对Channel读写、拷贝等封装 + * + * @author looly + * @since 5.5.3 + */ +public class NioUtil { + + /** + * 默认缓存大小 8192 + */ + public static final int DEFAULT_BUFFER_SIZE = 2 << 12; + /** + * 默认中等缓存大小 16384 + */ + public static final int DEFAULT_MIDDLE_BUFFER_SIZE = 2 << 13; + /** + * 默认大缓存大小 32768 + */ + public static final int DEFAULT_LARGE_BUFFER_SIZE = 2 << 14; + + /** + * 数据流末尾 + */ + public static final int EOF = -1; + + /** + * 拷贝流 thanks to: https://github.com/venusdrogon/feilong-io/blob/master/src/main/java/com/feilong/io/IOWriteUtil.java
+ * 本方法不会关闭流 + * + * @param in 输入流 + * @param out 输出流 + * @param bufferSize 缓存大小 + * @param streamProgress 进度条 + * @return 传输的byte数 + * @throws IORuntimeException IO异常 + */ + public static long copyByNIO(InputStream in, OutputStream out, int bufferSize, StreamProgress streamProgress) throws IORuntimeException { + return copyByNIO(in, out, bufferSize, -1, streamProgress); + } + + /** + * 拷贝流
+ * 本方法不会关闭流 + * + * @param in 输入流 + * @param out 输出流 + * @param bufferSize 缓存大小 + * @param count 最大长度 + * @param streamProgress 进度条 + * @return 传输的byte数 + * @throws IORuntimeException IO异常 + * @since 5.7.8 + */ + public static long copyByNIO(InputStream in, OutputStream out, int bufferSize, long count, StreamProgress streamProgress) throws IORuntimeException { + final long copySize = copy(Channels.newChannel(in), Channels.newChannel(out), bufferSize, count, streamProgress); + IoUtil.flush(out); + return copySize; + } + + /** + * 拷贝文件Channel，使用NIO，拷贝后不会关闭channel + * + * @param inChannel {@link FileChannel} + * @param outChannel {@link FileChannel} + * @return 拷贝的字节数 + * @throws IORuntimeException IO异常 + * @since 5.5.3 + */ + public static long copy(FileChannel inChannel, FileChannel outChannel) throws IORuntimeException { + Assert.notNull(inChannel, "In channel is null!"); + Assert.notNull(outChannel, "Out channel is null!"); + + try { + return copySafely(inChannel, outChannel); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 文件拷贝实现 + * + * 
+	 * FileChannel#transferTo 或 FileChannel#transferFrom 的实现是平台相关的，需要确保低版本平台的兼容性
+	 * 例如 android 7以下平台在使用 ZipInputStream 解压文件的过程中，
+	 * 通过 FileChannel#transferFrom 传输到文件时，其返回值可能小于 totalBytes，不处理将导致文件内容缺失
+	 *
+	 * // 错误写法，dstChannel.transferFrom 返回值小于 zipEntry.getSize()，导致解压后文件内容缺失
+	 * try (InputStream srcStream = zipFile.getInputStream(zipEntry);
+	 * 		ReadableByteChannel srcChannel = Channels.newChannel(srcStream);
+	 * 		FileOutputStream fos = new FileOutputStream(saveFile);
+	 * 		FileChannel dstChannel = fos.getChannel()) {
+	 * 		dstChannel.transferFrom(srcChannel, 0, zipEntry.getSize());
+	 *  }
+	 *
+ * + * @param inChannel 输入通道 + * @param outChannel 输出通道 + * @return 输入通道的字节数 + * @throws IOException 发生IO错误 + * @link http://androidxref.com/6.0.1_r10/xref/libcore/luni/src/main/java/java/nio/FileChannelImpl.java + * @link http://androidxref.com/7.0.0_r1/xref/libcore/ojluni/src/main/java/sun/nio/ch/FileChannelImpl.java + * @link http://androidxref.com/7.0.0_r1/xref/libcore/ojluni/src/main/native/FileChannelImpl.c + * @author z8g + * @since 5.7.21 + */ + private static long copySafely(FileChannel inChannel, FileChannel outChannel) throws IOException { + final long totalBytes = inChannel.size(); + for (long pos = 0, remaining = totalBytes; remaining > 0; ) { // 确保文件内容不会缺失 + final long writeBytes = inChannel.transferTo(pos, remaining, outChannel); // 实际传输的字节数 + pos += writeBytes; + remaining -= writeBytes; + } + return totalBytes; + } + + /** + * 拷贝流，使用NIO，不会关闭channel + * + * @param in {@link ReadableByteChannel} + * @param out {@link WritableByteChannel} + * @return 拷贝的字节数 + * @throws IORuntimeException IO异常 + * @since 4.5.0 + */ + public static long copy(ReadableByteChannel in, WritableByteChannel out) throws IORuntimeException { + return copy(in, out, DEFAULT_BUFFER_SIZE); + } + + /** + * 拷贝流，使用NIO，不会关闭channel + * + * @param in {@link ReadableByteChannel} + * @param out {@link WritableByteChannel} + * @param bufferSize 缓冲大小，如果小于等于0，使用默认 + * @return 拷贝的字节数 + * @throws IORuntimeException IO异常 + * @since 4.5.0 + */ + public static long copy(ReadableByteChannel in, WritableByteChannel out, int bufferSize) throws IORuntimeException { + return copy(in, out, bufferSize, null); + } + + /** + * 拷贝流，使用NIO，不会关闭channel + * + * @param in {@link ReadableByteChannel} + * @param out {@link WritableByteChannel} + * @param bufferSize 缓冲大小，如果小于等于0，使用默认 + * @param streamProgress {@link StreamProgress}进度处理器 + * @return 拷贝的字节数 + * @throws IORuntimeException IO异常 + */ + public static long copy(ReadableByteChannel in, WritableByteChannel out, int bufferSize, StreamProgress streamProgress) throws IORuntimeException { + return copy(in, out, bufferSize, -1, streamProgress); + } + + /** + * 拷贝流，使用NIO，不会关闭channel + * + * @param in {@link ReadableByteChannel} + * @param out {@link WritableByteChannel} + * @param bufferSize 缓冲大小，如果小于等于0，使用默认 + * @param count 读取总长度 + * @param streamProgress {@link StreamProgress}进度处理器 + * @return 拷贝的字节数 + * @throws IORuntimeException IO异常 + * @since 5.7.8 + */ + public static long copy(ReadableByteChannel in, WritableByteChannel out, int bufferSize, long count, StreamProgress streamProgress) throws IORuntimeException { + return new ChannelCopier(bufferSize, count, streamProgress).copy(in, out); + } + + /** + * 从流中读取内容，读取完毕后并不关闭流 + * + * @param channel 可读通道，读取完毕后并不关闭通道 + * @param charset 字符集 + * @return 内容 + * @throws IORuntimeException IO异常 + * @since 4.5.0 + */ + public static String read(ReadableByteChannel channel, Charset charset) throws IORuntimeException { + FastByteArrayOutputStream out = read(channel); + return null == charset ? out.toString() : out.toString(charset); + } + + /** + * 从流中读取内容，读到输出流中 + * + * @param channel 可读通道，读取完毕后并不关闭通道 + * @return 输出流 + * @throws IORuntimeException IO异常 + */ + public static FastByteArrayOutputStream read(ReadableByteChannel channel) throws IORuntimeException { + final FastByteArrayOutputStream out = new FastByteArrayOutputStream(); + copy(channel, Channels.newChannel(out)); + return out; + } + + /** + * 从FileChannel中读取UTF-8编码内容 + * + * @param fileChannel 文件管道 + * @return 内容 + * @throws IORuntimeException IO异常 + */ + public static String readUtf8(FileChannel fileChannel) throws IORuntimeException { + return read(fileChannel, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 从FileChannel中读取内容，读取完毕后并不关闭Channel + * + * @param fileChannel 文件管道 + * @param charsetName 字符集 + * @return 内容 + * @throws IORuntimeException IO异常 + */ + public static String read(FileChannel fileChannel, String charsetName) throws IORuntimeException { + return read(fileChannel, CharsetUtil.charset(charsetName)); + } + + /** + * 从FileChannel中读取内容 + * + * @param fileChannel 文件管道 + * @param charset 字符集 + * @return 内容 + * @throws IORuntimeException IO异常 + */ + public static String read(FileChannel fileChannel, Charset charset) throws IORuntimeException { + MappedByteBuffer buffer; + try { + buffer = fileChannel.map(FileChannel.MapMode.READ_ONLY, 0, fileChannel.size()).load(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + return StrUtil.str(buffer, charset); + } + + /** + * 关闭
+ * 关闭失败不会抛出异常 + * + * @param closeable 被关闭的对象 + */ + public static void close(AutoCloseable closeable) { + if (null != closeable) { + try { + closeable.close(); + } catch (Exception e) { + // 静默关闭 + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/NullOutputStream.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/NullOutputStream.java new file mode 100644 index 0000000..bca80ab --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/NullOutputStream.java @@ -0,0 +1,53 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import java.io.IOException; +import java.io.OutputStream; + +/** + * 此OutputStream写出数据到/dev/null，即忽略所有数据
+ * 来自 Apache Commons io + * + * @author looly + * @since 4.0.6 + */ +public class NullOutputStream extends OutputStream { + + /** + * 单例 + */ + public static final NullOutputStream NULL_OUTPUT_STREAM = new NullOutputStream(); + + /** + * 什么也不做，写出到/dev/null. + * + * @param b 写出的数据 + * @param off 开始位置 + * @param len 长度 + */ + @Override + public void write(byte[] b, int off, int len) { + // to /dev/null + } + + /** + * 什么也不做，写出到 /dev/null. + * + * @param b 写出的数据 + */ + @Override + public void write(int b) { + // to /dev/null + } + + /** + * 什么也不做，写出到 /dev/null. + * + * @param b 写出的数据 + * @throws IOException 不抛出 + */ + @Override + public void write(byte[] b) throws IOException { + // to /dev/null + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/StreamProgress.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/StreamProgress.java new file mode 100644 index 0000000..31e6734 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/StreamProgress.java @@ -0,0 +1,29 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +/** + * Stream进度条
+ * 提供流拷贝进度监测，如开始、结束触发，以及进度回调。
+ * 注意进度回调的{@code total}参数为总大小，某些场景下无总大小的标记，则此值应为-1或者{@link Long#MAX_VALUE}，表示此参数无效。 + * + * @author Looly + */ +public interface StreamProgress { + + /** + * 开始 + */ + void start(); + + /** + * 进行中 + * + * @param total 总大小，如果未知为 -1或者{@link Long#MAX_VALUE} + * @param progressSize 已经进行的大小 + */ + void progress(long total, long progressSize); + + /** + * 结束 + */ + void finish(); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/ValidateObjectInputStream.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/ValidateObjectInputStream.java new file mode 100644 index 0000000..9483e2b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/ValidateObjectInputStream.java @@ -0,0 +1,101 @@ +package aiyh.utils.tool.cn.hutool.core.io; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; + +import java.io.IOException; +import java.io.InputStream; +import java.io.InvalidClassException; +import java.io.ObjectInputStream; +import java.io.ObjectStreamClass; +import java.util.HashSet; +import java.util.Set; + +/** + * 带有类验证的对象流，用于避免反序列化漏洞
+ * 详细见：https://xz.aliyun.com/t/41/ + * + * @author looly + * @since 5.2.6 + */ +public class ValidateObjectInputStream extends ObjectInputStream { + + private Set whiteClassSet; + private Set blackClassSet; + + /** + * 构造 + * + * @param inputStream 流 + * @param acceptClasses 白名单的类 + * @throws IOException IO异常 + */ + public ValidateObjectInputStream(InputStream inputStream, Class... acceptClasses) throws IOException { + super(inputStream); + accept(acceptClasses); + } + + /** + * 禁止反序列化的类，用于反序列化验证 + * + * @param refuseClasses 禁止反序列化的类 + * @since 5.3.5 + */ + public void refuse(Class... refuseClasses) { + if(null == this.blackClassSet){ + this.blackClassSet = new HashSet<>(); + } + for (Class acceptClass : refuseClasses) { + this.blackClassSet.add(acceptClass.getName()); + } + } + + /** + * 接受反序列化的类，用于反序列化验证 + * + * @param acceptClasses 接受反序列化的类 + */ + public void accept(Class... acceptClasses) { + if(null == this.whiteClassSet){ + this.whiteClassSet = new HashSet<>(); + } + for (Class acceptClass : acceptClasses) { + this.whiteClassSet.add(acceptClass.getName()); + } + } + + /** + * 只允许反序列化SerialObject class + */ + @Override + protected Class resolveClass(ObjectStreamClass desc) throws IOException, ClassNotFoundException { + validateClassName(desc.getName()); + return super.resolveClass(desc); + } + + /** + * 验证反序列化的类是否合法 + * @param className 类名 + * @throws InvalidClassException 非法类 + */ + private void validateClassName(String className) throws InvalidClassException { + // 黑名单 + if(CollUtil.isNotEmpty(this.blackClassSet)){ + if(this.blackClassSet.contains(className)){ + throw new InvalidClassException("Unauthorized deserialization attempt by black list", className); + } + } + + if(CollUtil.isEmpty(this.whiteClassSet)){ + return; + } + if(className.startsWith("java.")){ + // java中的类默认在白名单中 + return; + } + if(this.whiteClassSet.contains(className)){ + return; + } + + throw new InvalidClassException("Unauthorized deserialization attempt", className); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/CRC16.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/CRC16.java new file mode 100644 index 0000000..65c986f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/CRC16.java @@ -0,0 +1,73 @@ +package aiyh.utils.tool.cn.hutool.core.io.checksum; + +import aiyh.utils.tool.cn.hutool.core.io.checksum.crc16.CRC16Checksum; +import aiyh.utils.tool.cn.hutool.core.io.checksum.crc16.CRC16IBM; + +import java.io.Serializable; +import java.util.zip.Checksum; + +/** + * CRC16 循环冗余校验码（Cyclic Redundancy Check）实现，默认IBM算法 + * + * @author looly + * @since 4.4.1 + */ +public class CRC16 implements Checksum, Serializable { + private static final long serialVersionUID = 1L; + + private final CRC16Checksum crc16; + + public CRC16() { + this(new CRC16IBM()); + } + + /** + * 构造 + * + * @param crc16Checksum {@link CRC16Checksum} 实现 + */ + public CRC16(CRC16Checksum crc16Checksum) { + this.crc16 = crc16Checksum; + } + + /** + * 获取16进制的CRC16值 + * + * @return 16进制的CRC16值 + * @since 5.7.22 + */ + public String getHexValue() { + return this.crc16.getHexValue(); + } + + /** + * 获取16进制的CRC16值 + * + * @param isPadding 不足4位时，是否填充0以满足位数 + * @return 16进制的CRC16值，4位 + * @since 5.7.22 + */ + public String getHexValue(boolean isPadding) { + return crc16.getHexValue(isPadding); + } + + @Override + public long getValue() { + return crc16.getValue(); + } + + @Override + public void reset() { + crc16.reset(); + } + + @Override + public void update(byte[] b, int off, int len) { + crc16.update(b, off, len); + } + + @Override + public void update(int b) { + crc16.update(b); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/CRC8.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/CRC8.java new file mode 100644 index 0000000..14b570d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/CRC8.java @@ -0,0 +1,72 @@ +package aiyh.utils.tool.cn.hutool.core.io.checksum; + +import java.io.Serializable; +import java.util.zip.Checksum; + +/** + * CRC8 循环冗余校验码（Cyclic Redundancy Check）实现
+ * 代码来自：https://github.com/BBSc0der + * + * @author Bolek,Looly + * @since 4.4.1 + */ +public class CRC8 implements Checksum, Serializable { + private static final long serialVersionUID = 1L; + + private final short init; + private final short[] crcTable = new short[256]; + private short value; + + /** + * 构造
+ * + * @param polynomial Polynomial, typically one of the POLYNOMIAL_* constants. + * @param init Initial value, typically either 0xff or zero. + */ + public CRC8(int polynomial, short init) { + this.value = this.init = init; + for (int dividend = 0; dividend < 256; dividend++) { + int remainder = dividend;// << 8; + for (int bit = 0; bit < 8; ++bit) { + if ((remainder & 0x01) != 0) { + remainder = (remainder >>> 1) ^ polynomial; + } else { + remainder >>>= 1; + } + } + crcTable[dividend] = (short) remainder; + } + } + + @Override + public void update(byte[] buffer, int offset, int len) { + for (int i = 0; i < len; i++) { + int data = buffer[offset + i] ^ value; + value = (short) (crcTable[data & 0xff] ^ (value << 8)); + } + } + + /** + * Updates the current checksum with the specified array of bytes. Equivalent to calling update(buffer, 0, buffer.length). + * + * @param buffer the byte array to update the checksum with + */ + public void update(byte[] buffer) { + update(buffer, 0, buffer.length); + } + + @Override + public void update(int b) { + update(new byte[] { (byte) b }, 0, 1); + } + + @Override + public long getValue() { + return value & 0xff; + } + + @Override + public void reset() { + value = init; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16Ansi.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16Ansi.java new file mode 100644 index 0000000..e4a64cd --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16Ansi.java @@ -0,0 +1,33 @@ +package aiyh.utils.tool.cn.hutool.core.io.checksum.crc16; + +/** + * CRC16_ANSI + * + * @author looly + * @since 5.3.10 + */ +public class CRC16Ansi extends CRC16Checksum{ + private static final long serialVersionUID = 1L; + + private static final int WC_POLY = 0xa001; + + @Override + public void reset() { + this.wCRCin = 0xffff; + } + + @Override + public void update(int b) { + int hi = wCRCin >> 8; + hi ^= b; + wCRCin = hi; + + for (int i = 0; i < 8; i++) { + int flag = wCRCin & 0x0001; + wCRCin = wCRCin >> 1; + if (flag == 1) { + wCRCin ^= WC_POLY; + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16CCITT.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16CCITT.java new file mode 100644 index 0000000..ee549ec --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16CCITT.java @@ -0,0 +1,27 @@ +package aiyh.utils.tool.cn.hutool.core.io.checksum.crc16; + +/** + * CRC16_CCITT：多项式x16+x12+x5+1（0x1021），初始值0x0000，低位在前，高位在后，结果与0x0000异或 + * 0x8408是0x1021按位颠倒后的结果。 + * + * @author looly + * @since 5.3.10 + */ +public class CRC16CCITT extends CRC16Checksum{ + private static final long serialVersionUID = 1L; + + private static final int WC_POLY = 0x8408; + + @Override + public void update(int b) { + wCRCin ^= (b & 0x00ff); + for (int j = 0; j < 8; j++) { + if ((wCRCin & 0x0001) != 0) { + wCRCin >>= 1; + wCRCin ^= WC_POLY; + } else { + wCRCin >>= 1; + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16CCITTFalse.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16CCITTFalse.java new file mode 100644 index 0000000..544602b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16CCITTFalse.java @@ -0,0 +1,35 @@ +package aiyh.utils.tool.cn.hutool.core.io.checksum.crc16; + +/** + * CRC16_CCITT_FALSE：多项式x16+x12+x5+1（0x1021），初始值0xFFFF，低位在后，高位在前，结果与0x0000异或 + * + * @author looly + * @since 5.3.10 + */ +public class CRC16CCITTFalse extends CRC16Checksum{ + private static final long serialVersionUID = 1L; + + private static final int WC_POLY = 0x1021; + + @Override + public void reset() { + this.wCRCin = 0xffff; + } + + @Override + public void update(byte[] b, int off, int len) { + super.update(b, off, len); + wCRCin &= 0xffff; + } + + @Override + public void update(int b) { + for (int i = 0; i < 8; i++) { + boolean bit = ((b >> (7 - i) & 1) == 1); + boolean c15 = ((wCRCin >> 15 & 1) == 1); + wCRCin <<= 1; + if (c15 ^ bit) + wCRCin ^= WC_POLY; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16Checksum.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16Checksum.java new file mode 100755 index 0000000..3aec165 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16Checksum.java @@ -0,0 +1,75 @@ +package aiyh.utils.tool.cn.hutool.core.io.checksum.crc16; + +import aiyh.utils.tool.cn.hutool.core.util.HexUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.util.zip.Checksum; + +/** + * CRC16 Checksum，用于提供多种CRC16算法的通用实现
+ * 通过继承此类，重写update和reset完成相应算法。 + * + * @author looly + * @since 5.3.10 + */ +public abstract class CRC16Checksum implements Checksum, Serializable { + private static final long serialVersionUID = 1L; + + /** + * CRC16 Checksum 结果值 + */ + protected int wCRCin; + + public CRC16Checksum(){ + reset(); + } + + @Override + public long getValue() { + return wCRCin; + } + + /** + * 获取16进制的CRC16值 + * + * @return 16进制的CRC16值 + */ + public String getHexValue(){ + return getHexValue(false); + } + + /** + * 获取16进制的CRC16值 + * @param isPadding 不足4位时，是否填充0以满足位数 + * @return 16进制的CRC16值，4位 + */ + public String getHexValue(boolean isPadding){ + String hex = HexUtil.toHex(getValue()); + if(isPadding){ + hex = StrUtil.padPre(hex, 4, '0'); + } + + return hex; + } + + @Override + public void reset() { + wCRCin = 0x0000; + } + + /** + * 计算全部字节 + * @param b 字节 + */ + public void update(byte[] b){ + update(b, 0, b.length); + } + + @Override + public void update(byte[] b, int off, int len) { + for (int i = off; i < off + len; i++) + update(b[i]); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16DNP.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16DNP.java new file mode 100644 index 0000000..0598e83 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16DNP.java @@ -0,0 +1,33 @@ +package aiyh.utils.tool.cn.hutool.core.io.checksum.crc16; + +/** + * CRC16_DNP：多项式x16+x13+x12+x11+x10+x8+x6+x5+x2+1（0x3D65），初始值0x0000，低位在前，高位在后，结果与0xFFFF异或 + * 0xA6BC是0x3D65按位颠倒后的结果 + * + * @author looly + * @since 5.3.10 + */ +public class CRC16DNP extends CRC16Checksum{ + private static final long serialVersionUID = 1L; + + private static final int WC_POLY = 0xA6BC; + + @Override + public void update(byte[] b, int off, int len) { + super.update(b, off, len); + wCRCin ^= 0xffff; + } + + @Override + public void update(int b) { + wCRCin ^= (b & 0x00ff); + for (int j = 0; j < 8; j++) { + if ((wCRCin & 0x0001) != 0) { + wCRCin >>= 1; + wCRCin ^= WC_POLY; + } else { + wCRCin >>= 1; + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16IBM.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16IBM.java new file mode 100644 index 0000000..6f1d6e9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16IBM.java @@ -0,0 +1,27 @@ +package aiyh.utils.tool.cn.hutool.core.io.checksum.crc16; + +/** + * CRC16_IBM：多项式x16+x15+x2+1（0x8005），初始值0x0000，低位在前，高位在后，结果与0x0000异或 + * 0xA001是0x8005按位颠倒后的结果 + * + * @author looly + * @since 5.3.10 + */ +public class CRC16IBM extends CRC16Checksum{ + private static final long serialVersionUID = 1L; + + private static final int WC_POLY = 0xa001; + + @Override + public void update(int b) { + wCRCin ^= (b & 0x00ff); + for (int j = 0; j < 8; j++) { + if ((wCRCin & 0x0001) != 0) { + wCRCin >>= 1; + wCRCin ^= WC_POLY; + } else { + wCRCin >>= 1; + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16Maxim.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16Maxim.java new file mode 100644 index 0000000..464e1ab --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16Maxim.java @@ -0,0 +1,33 @@ +package aiyh.utils.tool.cn.hutool.core.io.checksum.crc16; + +/** + * CRC16_MAXIM：多项式x16+x15+x2+1（0x8005），初始值0x0000，低位在前，高位在后，结果与0xFFFF异或 + * 0xA001是0x8005按位颠倒后的结果 + * + * @author looly + * @since 5.3.10 + */ +public class CRC16Maxim extends CRC16Checksum{ + private static final long serialVersionUID = 1L; + + private static final int WC_POLY = 0xa001; + + @Override + public void update(byte[] b, int off, int len) { + super.update(b, off, len); + wCRCin ^= 0xffff; + } + + @Override + public void update(int b) { + wCRCin ^= (b & 0x00ff); + for (int j = 0; j < 8; j++) { + if ((wCRCin & 0x0001) != 0) { + wCRCin >>= 1; + wCRCin ^= WC_POLY; + } else { + wCRCin >>= 1; + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16Modbus.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16Modbus.java new file mode 100644 index 0000000..cde444d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16Modbus.java @@ -0,0 +1,33 @@ +package aiyh.utils.tool.cn.hutool.core.io.checksum.crc16; + +/** + * CRC-16 (Modbus) + * CRC16_MODBUS：多项式x16+x15+x2+1（0x8005），初始值0xFFFF，低位在前，高位在后，结果与0x0000异或 + * 0xA001是0x8005按位颠倒后的结果 + * + * @author looly + * @since 5.3.10 + */ +public class CRC16Modbus extends CRC16Checksum{ + private static final long serialVersionUID = 1L; + + private static final int WC_POLY = 0xa001; + + @Override + public void reset(){ + this.wCRCin = 0xffff; + } + + @Override + public void update(int b) { + wCRCin ^= (b & 0x00ff); + for (int j = 0; j < 8; j++) { + if ((wCRCin & 0x0001) != 0) { + wCRCin >>= 1; + wCRCin ^= WC_POLY; + } else { + wCRCin >>= 1; + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16USB.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16USB.java new file mode 100644 index 0000000..ea78bb0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16USB.java @@ -0,0 +1,38 @@ +package aiyh.utils.tool.cn.hutool.core.io.checksum.crc16; + +/** + * CRC16_USB：多项式x16+x15+x2+1（0x8005），初始值0xFFFF，低位在前，高位在后，结果与0xFFFF异或 + * 0xA001是0x8005按位颠倒后的结果 + * + * @author looly + * @since 5.3.10 + */ +public class CRC16USB extends CRC16Checksum{ + private static final long serialVersionUID = 1L; + + private static final int WC_POLY = 0xa001; + + @Override + public void reset(){ + this.wCRCin = 0xFFFF; + } + + @Override + public void update(byte[] b, int off, int len) { + super.update(b, off, len); + wCRCin ^= 0xffff; + } + + @Override + public void update(int b) { + wCRCin ^= (b & 0x00ff); + for (int j = 0; j < 8; j++) { + if ((wCRCin & 0x0001) != 0) { + wCRCin >>= 1; + wCRCin ^= WC_POLY; + } else { + wCRCin >>= 1; + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16X25.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16X25.java new file mode 100644 index 0000000..a2b9fd8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16X25.java @@ -0,0 +1,38 @@ +package aiyh.utils.tool.cn.hutool.core.io.checksum.crc16; + +/** + * CRC16_X25：多项式x16+x12+x5+1（0x1021），初始值0xffff，低位在前，高位在后，结果与0xFFFF异或 + * 0x8408是0x1021按位颠倒后的结果。 + * + * @author looly + * @since 5.3.10 + */ +public class CRC16X25 extends CRC16Checksum{ + private static final long serialVersionUID = 1L; + + private static final int WC_POLY = 0x8408; + + @Override + public void reset(){ + this.wCRCin = 0xffff; + } + + @Override + public void update(byte[] b, int off, int len) { + super.update(b, off, len); + wCRCin ^= 0xffff; + } + + @Override + public void update(int b) { + wCRCin ^= (b & 0x00ff); + for (int j = 0; j < 8; j++) { + if ((wCRCin & 0x0001) != 0) { + wCRCin >>= 1; + wCRCin ^= WC_POLY; + } else { + wCRCin >>= 1; + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16XModem.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16XModem.java new file mode 100644 index 0000000..411d015 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/CRC16XModem.java @@ -0,0 +1,32 @@ +package aiyh.utils.tool.cn.hutool.core.io.checksum.crc16; + +/** + * CRC-CCITT (XModem) + * CRC16_XMODEM：多项式x16+x12+x5+1（0x1021），初始值0x0000，低位在后，高位在前，结果与0x0000异或 + * + * @author looly + * @since 5.3.10 + */ +public class CRC16XModem extends CRC16Checksum{ + private static final long serialVersionUID = 1L; + + // 0001 0000 0010 0001 (0, 5, 12) + private static final int WC_POLY = 0x1021; + + @Override + public void update(byte[] b, int off, int len) { + super.update(b, off, len); + wCRCin &= 0xffff; + } + + @Override + public void update(int b) { + for (int i = 0; i < 8; i++) { + boolean bit = ((b >> (7 - i) & 1) == 1); + boolean c15 = ((wCRCin >> 15 & 1) == 1); + wCRCin <<= 1; + if (c15 ^ bit) + wCRCin ^= WC_POLY; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/package-info.java new file mode 100644 index 0000000..5ebaf58 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/crc16/package-info.java @@ -0,0 +1,7 @@ +/** + * CRC16相关算法封装为Checksum + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.io.checksum.crc16; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/package-info.java new file mode 100644 index 0000000..80a8430 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/checksum/package-info.java @@ -0,0 +1,7 @@ +/** + * IO校验相关库和工具 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.io.checksum; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/ChannelCopier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/ChannelCopier.java new file mode 100755 index 0000000..c30075a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/ChannelCopier.java @@ -0,0 +1,116 @@ +package aiyh.utils.tool.cn.hutool.core.io.copy; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.io.StreamProgress; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.ByteBuffer; +import java.nio.channels.ReadableByteChannel; +import java.nio.channels.WritableByteChannel; + +/** + * {@link ReadableByteChannel} 向 {@link WritableByteChannel} 拷贝 + * + * @author looly + * @since 5.7.8 + */ +public class ChannelCopier extends IoCopier { + + /** + * 构造 + */ + public ChannelCopier() { + this(IoUtil.DEFAULT_BUFFER_SIZE); + } + + /** + * 构造 + * + * @param bufferSize 缓存大小 + */ + public ChannelCopier(int bufferSize) { + this(bufferSize, -1); + } + + /** + * 构造 + * + * @param bufferSize 缓存大小 + * @param count 拷贝总数 + */ + public ChannelCopier(int bufferSize, long count) { + this(bufferSize, count, null); + } + + /** + * 构造 + * + * @param bufferSize 缓存大小 + * @param count 拷贝总数 + * @param progress 进度条 + */ + public ChannelCopier(int bufferSize, long count, StreamProgress progress) { + super(bufferSize, count, progress); + } + + @Override + public long copy(ReadableByteChannel source, WritableByteChannel target) { + Assert.notNull(source, "InputStream is null !"); + Assert.notNull(target, "OutputStream is null !"); + + final StreamProgress progress = this.progress; + if (null != progress) { + progress.start(); + } + final long size; + try { + size = doCopy(source, target, ByteBuffer.allocate(bufferSize(this.count)), progress); + } catch (IOException e) { + throw new IORuntimeException(e); + } + + if (null != progress) { + progress.finish(); + } + return size; + } + + /** + * 执行拷贝，如果限制最大长度，则按照最大长度读取，否则一直读取直到遇到-1 + * + * @param source {@link InputStream} + * @param target {@link OutputStream} + * @param buffer 缓存 + * @param progress 进度条 + * @return 拷贝总长度 + * @throws IOException IO异常 + */ + private long doCopy(ReadableByteChannel source, WritableByteChannel target, ByteBuffer buffer, StreamProgress progress) throws IOException { + long numToRead = this.count > 0 ? this.count : Long.MAX_VALUE; + long total = 0; + + int read; + while (numToRead > 0) { + read = source.read(buffer); + if (read < 0) { + // 提前读取到末尾 + break; + } + buffer.flip();// 写转读 + target.write(buffer); + buffer.clear(); + + numToRead -= read; + total += read; + if (null != progress) { + progress.progress(this.count, total); + } + } + + return total; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/IoCopier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/IoCopier.java new file mode 100755 index 0000000..0215d2c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/IoCopier.java @@ -0,0 +1,76 @@ +package aiyh.utils.tool.cn.hutool.core.io.copy; + +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.io.StreamProgress; + +/** + * IO拷贝抽象，可自定义包括缓存、进度条等信息
+ * 此对象非线程安全 + * + * @param 拷贝源类型，如InputStream、Reader等 + * @param 拷贝目标类型，如OutputStream、Writer等 + * @author looly + * @since 5.7.8 + */ +public abstract class IoCopier { + + protected final int bufferSize; + /** + * 拷贝总数 + */ + protected final long count; + + /** + * 进度条 + */ + protected StreamProgress progress; + + /** + * 是否每次写出一个buffer内容就执行flush + */ + protected boolean flushEveryBuffer; + + /** + * 构造 + * + * @param bufferSize 缓存大小，< 0 表示默认{@link IoUtil#DEFAULT_BUFFER_SIZE} + * @param count 拷贝总数，-1表示无限制 + * @param progress 进度条 + */ + public IoCopier(int bufferSize, long count, StreamProgress progress) { + this.bufferSize = bufferSize > 0 ? bufferSize : IoUtil.DEFAULT_BUFFER_SIZE; + this.count = count <= 0 ? Long.MAX_VALUE : count; + this.progress = progress; + } + + /** + * 执行拷贝 + * + * @param source 拷贝源，如InputStream、Reader等 + * @param target 拷贝目标，如OutputStream、Writer等 + * @return 拷贝的实际长度 + */ + public abstract long copy(S source, T target); + + /** + * 缓存大小，取默认缓存和目标长度最小值 + * + * @param count 目标长度 + * @return 缓存大小 + */ + protected int bufferSize(long count) { + return (int) Math.min(this.bufferSize, count); + } + + /** + * 设置是否每次写出一个buffer内容就执行flush + * + * @param flushEveryBuffer 是否每次写出一个buffer内容就执行flush + * @return this + * @since 5.7.18 + */ + public IoCopier setFlushEveryBuffer(boolean flushEveryBuffer){ + this.flushEveryBuffer = flushEveryBuffer; + return this; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/ReaderWriterCopier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/ReaderWriterCopier.java new file mode 100755 index 0000000..da04bb0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/ReaderWriterCopier.java @@ -0,0 +1,117 @@ +package aiyh.utils.tool.cn.hutool.core.io.copy; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.io.StreamProgress; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.Reader; +import java.io.Writer; + +/** + * {@link Reader} 向 {@link Writer} 拷贝 + * + * @author looly + * @since 5.7.8 + */ +public class ReaderWriterCopier extends IoCopier { + + /** + * 构造 + */ + public ReaderWriterCopier() { + this(IoUtil.DEFAULT_BUFFER_SIZE); + } + + /** + * 构造 + * + * @param bufferSize 缓存大小 + */ + public ReaderWriterCopier(int bufferSize) { + this(bufferSize, -1); + } + + /** + * 构造 + * + * @param bufferSize 缓存大小 + * @param count 拷贝总数 + */ + public ReaderWriterCopier(int bufferSize, long count) { + this(bufferSize, count, null); + } + + /** + * 构造 + * + * @param bufferSize 缓存大小 + * @param count 拷贝总数 + * @param progress 进度条 + */ + public ReaderWriterCopier(int bufferSize, long count, StreamProgress progress) { + super(bufferSize, count, progress); + } + + @Override + public long copy(Reader source, Writer target) { + Assert.notNull(source, "InputStream is null !"); + Assert.notNull(target, "OutputStream is null !"); + + final StreamProgress progress = this.progress; + if (null != progress) { + progress.start(); + } + final long size; + try { + size = doCopy(source, target, new char[bufferSize(this.count)], progress); + target.flush(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + + if (null != progress) { + progress.finish(); + } + return size; + } + + /** + * 执行拷贝，如果限制最大长度，则按照最大长度读取，否则一直读取直到遇到-1 + * + * @param source {@link InputStream} + * @param target {@link OutputStream} + * @param buffer 缓存 + * @param progress 进度条 + * @return 拷贝总长度 + * @throws IOException IO异常 + */ + private long doCopy(Reader source, Writer target, char[] buffer, StreamProgress progress) throws IOException { + long numToRead = this.count > 0 ? this.count : Long.MAX_VALUE; + long total = 0; + + int read; + while (numToRead > 0) { + read = source.read(buffer, 0, bufferSize(numToRead)); + if (read < 0) { + // 提前读取到末尾 + break; + } + target.write(buffer, 0, read); + if(flushEveryBuffer){ + target.flush(); + } + + numToRead -= read; + total += read; + if (null != progress) { + progress.progress(this.count, total); + } + } + + return total; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/StreamCopier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/StreamCopier.java new file mode 100755 index 0000000..355c753 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/StreamCopier.java @@ -0,0 +1,116 @@ +package aiyh.utils.tool.cn.hutool.core.io.copy; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.io.StreamProgress; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; + +/** + * {@link InputStream} 向 {@link OutputStream} 拷贝 + * + * @author looly + * @since 5.7.8 + */ +public class StreamCopier extends IoCopier { + + /** + * 构造 + */ + public StreamCopier() { + this(IoUtil.DEFAULT_BUFFER_SIZE); + } + + /** + * 构造 + * + * @param bufferSize 缓存大小 + */ + public StreamCopier(int bufferSize) { + this(bufferSize, -1); + } + + /** + * 构造 + * + * @param bufferSize 缓存大小 + * @param count 拷贝总数 + */ + public StreamCopier(int bufferSize, long count) { + this(bufferSize, count, null); + } + + /** + * 构造 + * + * @param bufferSize 缓存大小 + * @param count 拷贝总数 + * @param progress 进度条 + */ + public StreamCopier(int bufferSize, long count, StreamProgress progress) { + super(bufferSize, count, progress); + } + + @Override + public long copy(InputStream source, OutputStream target) { + Assert.notNull(source, "InputStream is null !"); + Assert.notNull(target, "OutputStream is null !"); + + final StreamProgress progress = this.progress; + if (null != progress) { + progress.start(); + } + final long size; + try { + size = doCopy(source, target, new byte[bufferSize(this.count)], progress); + target.flush(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + + if (null != progress) { + progress.finish(); + } + + return size; + } + + /** + * 执行拷贝，如果限制最大长度，则按照最大长度读取，否则一直读取直到遇到-1 + * + * @param source {@link InputStream} + * @param target {@link OutputStream} + * @param buffer 缓存 + * @param progress 进度条 + * @return 拷贝总长度 + * @throws IOException IO异常 + */ + private long doCopy(InputStream source, OutputStream target, byte[] buffer, StreamProgress progress) throws IOException { + long numToRead = this.count > 0 ? this.count : Long.MAX_VALUE; + long total = 0; + + int read; + while (numToRead > 0) { + read = source.read(buffer, 0, bufferSize(numToRead)); + if (read < 0) { + // 提前读取到末尾 + break; + } + target.write(buffer, 0, read); + if(flushEveryBuffer){ + target.flush(); + } + + numToRead -= read; + total += read; + if (null != progress) { + progress.progress(this.count, total); + } + } + + return total; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/package-info.java new file mode 100755 index 0000000..cefeec4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/copy/package-info.java @@ -0,0 +1,7 @@ +/** + * IO流拷贝相关封装相关封装 + * + * @author looly + * @since 5.7.8 + */ +package aiyh.utils.tool.cn.hutool.core.io.copy; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileAppender.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileAppender.java new file mode 100644 index 0000000..afbf941 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileAppender.java @@ -0,0 +1,127 @@ +package aiyh.utils.tool.cn.hutool.core.io.file; + +import aiyh.utils.tool.cn.hutool.core.thread.lock.LockUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.io.File; +import java.io.PrintWriter; +import java.io.Serializable; +import java.nio.charset.Charset; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.locks.Lock; + +/** + * 文件追加器
+ * 持有一个文件，在内存中积累一定量的数据后统一追加到文件
+ * 此类只有在写入文件时打开文件，并在写入结束后关闭之。因此此类不需要关闭
+ * 在调用append方法后会缓存于内存，只有超过容量后才会一次性写入文件，因此内存中随时有剩余未写入文件的内容，在最后必须调用flush方法将剩余内容刷入文件 + * + * @author looly + * @since 3.1.2 + */ +public class FileAppender implements Serializable { + private static final long serialVersionUID = 1L; + + private final FileWriter writer; + /** + * 内存中持有的字符串数 + */ + private final int capacity; + /** + * 追加内容是否为新行 + */ + private final boolean isNewLineMode; + /** + * 数据行缓存 + */ + private final List list; + /** + * 写出锁，用于保护写出线程安全 + */ + private final Lock lock; + + /** + * 构造 + * + * @param destFile 目标文件 + * @param capacity 当行数积累多少条时刷入到文件 + * @param isNewLineMode 追加内容是否为新行 + */ + public FileAppender(File destFile, int capacity, boolean isNewLineMode) { + this(destFile, CharsetUtil.CHARSET_UTF_8, capacity, isNewLineMode); + } + + /** + * 构造 + * + * @param destFile 目标文件 + * @param charset 编码 + * @param capacity 当行数积累多少条时刷入到文件 + * @param isNewLineMode 追加内容是否为新行 + */ + public FileAppender(File destFile, Charset charset, int capacity, boolean isNewLineMode) { + this(destFile, charset, capacity, isNewLineMode, null); + } + + /** + * 构造 + * + * @param destFile 目标文件 + * @param charset 编码 + * @param capacity 当行数积累多少条时刷入到文件 + * @param isNewLineMode 追加内容是否为新行 + * @param lock 是否加锁，添加则使用给定锁保护写出，保证线程安全，{@code null}则表示无锁 + */ + public FileAppender(File destFile, Charset charset, int capacity, boolean isNewLineMode, Lock lock) { + this.capacity = capacity; + this.list = new ArrayList<>(capacity); + this.isNewLineMode = isNewLineMode; + this.writer = FileWriter.create(destFile, charset); + this.lock = ObjectUtil.defaultIfNull(lock, LockUtil::getNoLock); + } + + /** + * 追加 + * + * @param line 行 + * @return this + */ + public FileAppender append(String line) { + if (list.size() >= capacity) { + flush(); + } + + this.lock.lock(); + try{ + list.add(line); + } finally { + this.lock.unlock(); + } + return this; + } + + /** + * 刷入到文件 + * + * @return this + */ + public FileAppender flush() { + this.lock.lock(); + try{ + try (PrintWriter pw = writer.getPrintWriter(true)) { + for (String str : list) { + pw.print(str); + if (isNewLineMode) { + pw.println(); + } + } + } + list.clear(); + } finally { + this.lock.unlock(); + } + return this; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileCopier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileCopier.java new file mode 100755 index 0000000..6eb8b01 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileCopier.java @@ -0,0 +1,291 @@ +package aiyh.utils.tool.cn.hutool.core.io.file; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.copier.SrcToDestCopier; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.File; +import java.io.IOException; +import java.nio.file.CopyOption; +import java.nio.file.Files; +import java.nio.file.StandardCopyOption; +import java.util.ArrayList; + +/** + * 文件拷贝器
+ * 支持以下几种情况： + * 
+ * 1、文件复制到文件
+ * 2、文件复制到目录
+ * 3、目录复制到目录
+ * 4、目录下的文件和目录复制到另一个目录
+ *
+ * + * @author Looly + * @since 3.0.9 + */ +public class FileCopier extends SrcToDestCopier{ + private static final long serialVersionUID = 1L; + + /** 是否覆盖目标文件 */ + private boolean isOverride; + /** 是否拷贝所有属性 */ + private boolean isCopyAttributes; + /** 当拷贝来源是目录时是否只拷贝目录下的内容 */ + private boolean isCopyContentIfDir; + /** 当拷贝来源是目录时是否只拷贝文件而忽略子目录 */ + private boolean isOnlyCopyFile; + + //-------------------------------------------------------------------------------------------------------- static method start + /** + * 新建一个文件复制器 + * @param srcPath 源文件路径（相对ClassPath路径或绝对路径） + * @param destPath 目标文件路径（相对ClassPath路径或绝对路径） + * @return this + */ + public static FileCopier create(String srcPath, String destPath) { + return new FileCopier(FileUtil.file(srcPath), FileUtil.file(destPath)); + } + + /** + * 新建一个文件复制器 + * @param src 源文件 + * @param dest 目标文件 + * @return this + */ + public static FileCopier create(File src, File dest) { + return new FileCopier(src, dest); + } + //-------------------------------------------------------------------------------------------------------- static method end + + //-------------------------------------------------------------------------------------------------------- Constructor start + /** + * 构造 + * @param src 源文件 + * @param dest 目标文件 + */ + public FileCopier(File src, File dest) { + this.src = src; + this.dest = dest; + } + //-------------------------------------------------------------------------------------------------------- Constructor end + + //-------------------------------------------------------------------------------------------------------- Getters and Setters start + /** + * 是否覆盖目标文件 + * @return 是否覆盖目标文件 + */ + public boolean isOverride() { + return isOverride; + } + /** + * 设置是否覆盖目标文件 + * @param isOverride 是否覆盖目标文件 + * @return this + */ + public FileCopier setOverride(boolean isOverride) { + this.isOverride = isOverride; + return this; + } + + /** + * 是否拷贝所有属性 + * @return 是否拷贝所有属性 + */ + public boolean isCopyAttributes() { + return isCopyAttributes; + } + /** + * 设置是否拷贝所有属性 + * @param isCopyAttributes 是否拷贝所有属性 + * @return this + */ + public FileCopier setCopyAttributes(boolean isCopyAttributes) { + this.isCopyAttributes = isCopyAttributes; + return this; + } + + /** + * 当拷贝来源是目录时是否只拷贝目录下的内容 + * @return 当拷贝来源是目录时是否只拷贝目录下的内容 + */ + public boolean isCopyContentIfDir() { + return isCopyContentIfDir; + } + + /** + * 当拷贝来源是目录时是否只拷贝目录下的内容 + * @param isCopyContentIfDir 是否只拷贝目录下的内容 + * @return this + */ + public FileCopier setCopyContentIfDir(boolean isCopyContentIfDir) { + this.isCopyContentIfDir = isCopyContentIfDir; + return this; + } + + /** + * 当拷贝来源是目录时是否只拷贝文件而忽略子目录 + * + * @return 当拷贝来源是目录时是否只拷贝文件而忽略子目录 + * @since 4.1.5 + */ + public boolean isOnlyCopyFile() { + return isOnlyCopyFile; + } + + /** + * 设置当拷贝来源是目录时是否只拷贝文件而忽略子目录 + * + * @param isOnlyCopyFile 当拷贝来源是目录时是否只拷贝文件而忽略子目录 + * @return this + * @since 4.1.5 + */ + public FileCopier setOnlyCopyFile(boolean isOnlyCopyFile) { + this.isOnlyCopyFile = isOnlyCopyFile; + return this; + } + //-------------------------------------------------------------------------------------------------------- Getters and Setters end + + /** + * 执行拷贝
+ * 拷贝规则为： + * 
+	 * 1、源为文件，目标为已存在目录，则拷贝到目录下，文件名不变
+	 * 2、源为文件，目标为不存在路径，则目标以文件对待（自动创建父级目录）比如：/dest/aaa，如果aaa不存在，则aaa被当作文件名
+	 * 3、源为文件，目标是一个已存在的文件，则当{@link #setOverride(boolean)}设为true时会被覆盖，默认不覆盖
+	 * 4、源为目录，目标为已存在目录，当{@link #setCopyContentIfDir(boolean)}为true时，只拷贝目录中的内容到目标目录中，否则整个源目录连同其目录拷贝到目标目录中
+	 * 5、源为目录，目标为不存在路径，则自动创建目标为新目录，然后按照规则4复制
+	 * 6、源为目录，目标为文件，抛出IO异常
+	 * 7、源路径和目标路径相同时，抛出IO异常
+	 *
+ * + * @return 拷贝后目标的文件或目录 + * @throws IORuntimeException IO异常 + */ + @Override + public File copy() throws IORuntimeException{ + final File src = this.src; + File dest = this.dest; + // check + Assert.notNull(src, "Source File is null !"); + if (false == src.exists()) { + throw new IORuntimeException("File not exist: " + src); + } + Assert.notNull(dest, "Destination File or directiory is null !"); + if (FileUtil.equals(src, dest)) { + throw new IORuntimeException("Files '{}' and '{}' are equal", src, dest); + } + + if (src.isDirectory()) {// 复制目录 + if(dest.exists() && false == dest.isDirectory()) { + //源为目录，目标为文件，抛出IO异常 + throw new IORuntimeException("Src is a directory but dest is a file!"); + } + if(FileUtil.isSub(src, dest)) { + throw new IORuntimeException("Dest is a sub directory of src !"); + } + + final File subTarget = isCopyContentIfDir ? dest : FileUtil.mkdir(FileUtil.file(dest, src.getName())); + internalCopyDirContent(src, subTarget); + } else {// 复制文件 + dest = internalCopyFile(src, dest); + } + return dest; + } + + //----------------------------------------------------------------------------------------- Private method start + /** + * 拷贝目录内容，只用于内部，不做任何安全检查
+ * 拷贝内容的意思为源目录下的所有文件和目录拷贝到另一个目录下，而不拷贝源目录本身 + * + * @param src 源目录 + * @param dest 目标目录 + * @throws IORuntimeException IO异常 + */ + private void internalCopyDirContent(File src, File dest) throws IORuntimeException { + if (null != copyFilter && false == copyFilter.accept(src)) { + //被过滤的目录跳过 + return; + } + + if (false == dest.exists()) { + //目标为不存在路径，创建为目录 + //noinspection ResultOfMethodCallIgnored + dest.mkdirs(); + } else if (false == dest.isDirectory()) { + throw new IORuntimeException(StrUtil.format("Src [{}] is a directory but dest [{}] is a file!", src.getPath(), dest.getPath())); + } + + final String[] files = src.list(); + if(ArrayUtil.isNotEmpty(files)){ + File srcFile; + File destFile; + for (String file : files) { + srcFile = new File(src, file); + destFile = this.isOnlyCopyFile ? dest : new File(dest, file); + // 递归复制 + if (srcFile.isDirectory()) { + internalCopyDirContent(srcFile, destFile); + } else { + internalCopyFile(srcFile, destFile); + } + } + } + } + + /** + * 拷贝文件，只用于内部，不做任何安全检查
+ * 情况如下： + * 
+	 * 1、如果目标是一个不存在的路径，则目标以文件对待（自动创建父级目录）比如：/dest/aaa，如果aaa不存在，则aaa被当作文件名
+	 * 2、如果目标是一个已存在的目录，则文件拷贝到此目录下，文件名与原文件名一致
+	 *
+ * + * @param src 源文件，必须为文件 + * @param dest 目标文件，如果非覆盖模式必须为目录 + * @return 目标的目录或文件 + * @throws IORuntimeException IO异常 + */ + private File internalCopyFile(File src, File dest) throws IORuntimeException { + if (null != copyFilter && false == copyFilter.accept(src)) { + //被过滤的文件跳过 + return src; + } + + // 如果已经存在目标文件，切为不覆盖模式，跳过之 + if (dest.exists()) { + if(dest.isDirectory()) { + //目标为目录，目录下创建同名文件 + dest = new File(dest, src.getName()); + } + + if(dest.exists() && false == isOverride) { + //非覆盖模式跳过 + return src; + } + }else { + //路径不存在则创建父目录 + FileUtil.mkParentDirs(dest); + } + + final ArrayList optionList = new ArrayList<>(2); + if(isOverride) { + optionList.add(StandardCopyOption.REPLACE_EXISTING); + } + if(isCopyAttributes) { + optionList.add(StandardCopyOption.COPY_ATTRIBUTES); + } + + try { + Files.copy(src.toPath(), dest.toPath(), optionList.toArray(new CopyOption[0])); + } catch (IOException e) { + throw new IORuntimeException(e); + } + + return dest; + } + //----------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileMode.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileMode.java new file mode 100644 index 0000000..9565899 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileMode.java @@ -0,0 +1,19 @@ +package aiyh.utils.tool.cn.hutool.core.io.file; + +/** + * 文件读写模式，常用于RandomAccessFile + * + * @author looly + * @since 4.5.2 + */ +public enum FileMode { + /** 以只读方式打开。调用结果对象的任何 write 方法都将导致抛出 IOException。 */ + r, + /** 打开以便读取和写入。 */ + rw, + /** 打开以便读取和写入。相对于 "rw"，"rws" 还要求对“文件的内容”或“元数据”的每个更新都同步写入到基础存储设备。 */ + rws, + /** 打开以便读取和写入，相对于 "rw"，"rwd" 还要求对“文件的内容”的每个更新都同步写入到基础存储设备。 */ + rwd + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileNameUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileNameUtil.java new file mode 100755 index 0000000..780ed62 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileNameUtil.java @@ -0,0 +1,285 @@ +package aiyh.utils.tool.cn.hutool.core.io.file; + +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.File; +import java.util.regex.Pattern; + +/** + * 文件名相关工具类 + * + * @author looly + * @since 5.4.1 + */ +public class FileNameUtil { + + /** + * .java文件扩展名 + */ + public static final String EXT_JAVA = ".java"; + /** + * .class文件扩展名 + */ + public static final String EXT_CLASS = ".class"; + /** + * .jar文件扩展名 + */ + public static final String EXT_JAR = ".jar"; + + /** + * 类Unix路径分隔符 + */ + public static final char UNIX_SEPARATOR = CharUtil.SLASH; + /** + * Windows路径分隔符 + */ + public static final char WINDOWS_SEPARATOR = CharUtil.BACKSLASH; + + /** + * Windows下文件名中的无效字符 + */ + private static final Pattern FILE_NAME_INVALID_PATTERN_WIN = Pattern.compile("[\\\\/:*?\"<>|\r\n]"); + + /** + * 特殊后缀 + */ + private static final CharSequence[] SPECIAL_SUFFIX = {"tar.bz2", "tar.Z", "tar.gz", "tar.xz"}; + + + // -------------------------------------------------------------------------------------------- name start + + /** + * 返回文件名 + * + * @param file 文件 + * @return 文件名 + * @since 4.1.13 + */ + public static String getName(File file) { + return (null != file) ? file.getName() : null; + } + + /** + * 返回文件名
+ * 
+	 * "d:/test/aaa" 返回 "aaa"
+	 * "/test/aaa.jpg" 返回 "aaa.jpg"
+	 *
+ * + * @param filePath 文件 + * @return 文件名 + * @since 4.1.13 + */ + public static String getName(String filePath) { + if (null == filePath) { + return null; + } + int len = filePath.length(); + if (0 == len) { + return filePath; + } + if (CharUtil.isFileSeparator(filePath.charAt(len - 1))) { + // 以分隔符结尾的去掉结尾分隔符 + len--; + } + + int begin = 0; + char c; + for (int i = len - 1; i > -1; i--) { + c = filePath.charAt(i); + if (CharUtil.isFileSeparator(c)) { + // 查找最后一个路径分隔符（/或者\） + begin = i + 1; + break; + } + } + + return filePath.substring(begin, len); + } + + /** + * 获取文件后缀名，扩展名不带“.” + * + * @param file 文件 + * @return 扩展名 + * @see #extName(File) + * @since 5.3.8 + */ + public static String getSuffix(File file) { + return extName(file); + } + + /** + * 获得文件后缀名，扩展名不带“.” + * + * @param fileName 文件名 + * @return 扩展名 + * @see #extName(String) + * @since 5.3.8 + */ + public static String getSuffix(String fileName) { + return extName(fileName); + } + + /** + * 返回主文件名 + * + * @param file 文件 + * @return 主文件名 + * @see #mainName(File) + * @since 5.3.8 + */ + public static String getPrefix(File file) { + return mainName(file); + } + + /** + * 返回主文件名 + * + * @param fileName 完整文件名 + * @return 主文件名 + * @see #mainName(String) + * @since 5.3.8 + */ + public static String getPrefix(String fileName) { + return mainName(fileName); + } + + /** + * 返回主文件名 + * + * @param file 文件 + * @return 主文件名 + */ + public static String mainName(File file) { + if (file.isDirectory()) { + return file.getName(); + } + return mainName(file.getName()); + } + + /** + * 返回主文件名 + * + * @param fileName 完整文件名 + * @return 主文件名 + */ + public static String mainName(String fileName) { + if (null == fileName) { + return null; + } + int len = fileName.length(); + if (0 == len) { + return fileName; + } + + //issue#2642，多级扩展名的主文件名 + for (final CharSequence specialSuffix : SPECIAL_SUFFIX) { + if(StrUtil.endWith(fileName, "." + specialSuffix)){ + return StrUtil.subPre(fileName, len - specialSuffix.length() - 1); + } + } + + if (CharUtil.isFileSeparator(fileName.charAt(len - 1))) { + len--; + } + + int begin = 0; + int end = len; + char c; + for (int i = len - 1; i >= 0; i--) { + c = fileName.charAt(i); + if (len == end && CharUtil.DOT == c) { + // 查找最后一个文件名和扩展名的分隔符：. + end = i; + } + // 查找最后一个路径分隔符（/或者\），如果这个分隔符在.之后，则继续查找，否则结束 + if (CharUtil.isFileSeparator(c)) { + begin = i + 1; + break; + } + } + + return fileName.substring(begin, end); + } + + /** + * 获取文件扩展名（后缀名），扩展名不带“.” + * + * @param file 文件 + * @return 扩展名 + */ + public static String extName(File file) { + if (null == file) { + return null; + } + if (file.isDirectory()) { + return null; + } + return extName(file.getName()); + } + + /** + * 获得文件的扩展名（后缀名），扩展名不带“.” + * + * @param fileName 文件名 + * @return 扩展名 + */ + public static String extName(String fileName) { + if (fileName == null) { + return null; + } + final int index = fileName.lastIndexOf(StrUtil.DOT); + if (index == -1) { + return StrUtil.EMPTY; + } else { + // issue#I4W5FS@Gitee + final int secondToLastIndex = fileName.substring(0, index).lastIndexOf(StrUtil.DOT); + final String substr = fileName.substring(secondToLastIndex == -1 ? index : secondToLastIndex + 1); + if (StrUtil.containsAny(substr, SPECIAL_SUFFIX)) { + return substr; + } + + final String ext = fileName.substring(index + 1); + // 扩展名中不能包含路径相关的符号 + return StrUtil.containsAny(ext, UNIX_SEPARATOR, WINDOWS_SEPARATOR) ? StrUtil.EMPTY : ext; + } + } + + /** + * 清除文件名中的在Windows下不支持的非法字符，包括： \ / : * ? " < > | + * + * @param fileName 文件名（必须不包括路径，否则路径符将被替换） + * @return 清理后的文件名 + * @since 3.3.1 + */ + public static String cleanInvalid(String fileName) { + return StrUtil.isBlank(fileName) ? fileName : ReUtil.delAll(FILE_NAME_INVALID_PATTERN_WIN, fileName); + } + + /** + * 文件名中是否包含在Windows下不支持的非法字符，包括： \ / : * ? " < > | + * + * @param fileName 文件名（必须不包括路径，否则路径符将被替换） + * @return 是否包含非法字符 + * @since 3.3.1 + */ + public static boolean containsInvalid(String fileName) { + return (false == StrUtil.isBlank(fileName)) && ReUtil.contains(FILE_NAME_INVALID_PATTERN_WIN, fileName); + } + + /** + * 根据文件名检查文件类型，忽略大小写 + * + * @param fileName 文件名，例如hutool.png + * @param extNames 被检查的扩展名数组，同一文件类型可能有多种扩展名，扩展名不带“.” + * @return 是否是指定扩展名的类型 + * @since 5.5.2 + */ + public static boolean isType(String fileName, String... extNames) { + return StrUtil.equalsAnyIgnoreCase(extName(fileName), extNames); + } + // -------------------------------------------------------------------------------------------- name end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileReader.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileReader.java new file mode 100644 index 0000000..b13d8df --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileReader.java @@ -0,0 +1,306 @@ +package aiyh.utils.tool.cn.hutool.core.io.file; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.io.LineHandler; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.BufferedInputStream; +import java.io.BufferedReader; +import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.OutputStream; +import java.nio.charset.Charset; +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; + +/** + * 文件读取器 + * + * @author Looly + * + */ +public class FileReader extends FileWrapper { + private static final long serialVersionUID = 1L; + + /** + * 创建 FileReader + * @param file 文件 + * @param charset 编码，使用 {@link CharsetUtil} + * @return FileReader + */ + public static FileReader create(File file, Charset charset){ + return new FileReader(file, charset); + } + + /** + * 创建 FileReader, 编码：{@link FileWrapper#DEFAULT_CHARSET} + * @param file 文件 + * @return FileReader + */ + public static FileReader create(File file){ + return new FileReader(file); + } + + // ------------------------------------------------------- Constructor start + /** + * 构造 + * @param file 文件 + * @param charset 编码，使用 {@link CharsetUtil} + */ + public FileReader(File file, Charset charset) { + super(file, charset); + checkFile(); + } + + /** + * 构造 + * @param file 文件 + * @param charset 编码，使用 {@link CharsetUtil#charset(String)} + */ + public FileReader(File file, String charset) { + this(file, CharsetUtil.charset(charset)); + } + + /** + * 构造 + * @param filePath 文件路径，相对路径会被转换为相对于ClassPath的路径 + * @param charset 编码，使用 {@link CharsetUtil} + */ + public FileReader(String filePath, Charset charset) { + this(FileUtil.file(filePath), charset); + } + + /** + * 构造 + * @param filePath 文件路径，相对路径会被转换为相对于ClassPath的路径 + * @param charset 编码，使用 {@link CharsetUtil#charset(String)} + */ + public FileReader(String filePath, String charset) { + this(FileUtil.file(filePath), CharsetUtil.charset(charset)); + } + + /** + * 构造
+ * 编码使用 {@link FileWrapper#DEFAULT_CHARSET} + * @param file 文件 + */ + public FileReader(File file) { + this(file, DEFAULT_CHARSET); + } + + /** + * 构造
+ * 编码使用 {@link FileWrapper#DEFAULT_CHARSET} + * @param filePath 文件路径，相对路径会被转换为相对于ClassPath的路径 + */ + public FileReader(String filePath) { + this(filePath, DEFAULT_CHARSET); + } + // ------------------------------------------------------- Constructor end + + /** + * 读取文件所有数据
+ * 文件的长度不能超过 {@link Integer#MAX_VALUE} + * + * @return 字节码 + * @throws IORuntimeException IO异常 + */ + public byte[] readBytes() throws IORuntimeException { + long len = file.length(); + if (len >= Integer.MAX_VALUE) { + throw new IORuntimeException("File is larger then max array size"); + } + + byte[] bytes = new byte[(int) len]; + FileInputStream in = null; + int readLength; + try { + in = new FileInputStream(file); + readLength = in.read(bytes); + if(readLength < len){ + throw new IOException(StrUtil.format("File length is [{}] but read [{}]!", len, readLength)); + } + } catch (Exception e) { + throw new IORuntimeException(e); + } finally { + IoUtil.close(in); + } + + return bytes; + } + + /** + * 读取文件内容 + * + * @return 内容 + * @throws IORuntimeException IO异常 + */ + public String readString() throws IORuntimeException{ + return new String(readBytes(), this.charset); + } + + /** + * 从文件中读取每一行数据 + * + * @param 集合类型 + * @param collection 集合 + * @return 文件中的每行内容的集合 + * @throws IORuntimeException IO异常 + */ + public > T readLines(T collection) throws IORuntimeException { + BufferedReader reader = null; + try { + reader = FileUtil.getReader(file, charset); + String line; + while (true) { + line = reader.readLine(); + if (line == null) { + break; + } + collection.add(line); + } + return collection; + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + IoUtil.close(reader); + } + } + + /** + * 按照行处理文件内容 + * + * @param lineHandler 行处理器 + * @throws IORuntimeException IO异常 + * @since 3.0.9 + */ + public void readLines(LineHandler lineHandler) throws IORuntimeException{ + BufferedReader reader = null; + try { + reader = FileUtil.getReader(file, charset); + IoUtil.readLines(reader, lineHandler); + } finally { + IoUtil.close(reader); + } + } + + /** + * 从文件中读取每一行数据 + * + * @return 文件中的每行内容的集合 + * @throws IORuntimeException IO异常 + */ + public List readLines() throws IORuntimeException { + return readLines(new ArrayList<>()); + } + + /** + * 按照给定的readerHandler读取文件中的数据 + * + * @param 读取的结果对象类型 + * @param readerHandler Reader处理类 + * @return 从文件中read出的数据 + * @throws IORuntimeException IO异常 + */ + public T read(ReaderHandler readerHandler) throws IORuntimeException { + BufferedReader reader = null; + T result; + try { + reader = FileUtil.getReader(this.file, charset); + result = readerHandler.handle(reader); + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + IoUtil.close(reader); + } + return result; + } + + /** + * 获得一个文件读取器 + * + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + */ + public BufferedReader getReader() throws IORuntimeException { + return IoUtil.getReader(getInputStream(), this.charset); + } + + /** + * 获得输入流 + * + * @return 输入流 + * @throws IORuntimeException IO异常 + */ + public BufferedInputStream getInputStream() throws IORuntimeException { + try { + return new BufferedInputStream(new FileInputStream(this.file)); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 将文件写入流中，此方法不会关闭比输出流 + * + * @param out 流 + * @return 写出的流byte数 + * @throws IORuntimeException IO异常 + */ + public long writeToStream(OutputStream out) throws IORuntimeException { + return writeToStream(out, false); + } + + /** + * 将文件写入流中 + * + * @param out 流 + * @param isCloseOut 是否关闭输出流 + * @return 写出的流byte数 + * @throws IORuntimeException IO异常 + * @since 5.5.2 + */ + public long writeToStream(OutputStream out, boolean isCloseOut) throws IORuntimeException { + try (FileInputStream in = new FileInputStream(this.file)){ + return IoUtil.copy(in, out); + }catch (IOException e) { + throw new IORuntimeException(e); + } finally{ + if(isCloseOut){ + IoUtil.close(out); + } + } + } + + // -------------------------------------------------------------------------- Interface start + /** + * Reader处理接口 + * + * @author Luxiaolei + * + * @param Reader处理返回结果类型 + */ + public interface ReaderHandler { + T handle(BufferedReader reader) throws IOException; + } + // -------------------------------------------------------------------------- Interface end + + /** + * 检查文件 + * + * @throws IORuntimeException IO异常 + */ + private void checkFile() throws IORuntimeException { + if (false == file.exists()) { + throw new IORuntimeException("File not exist: " + file); + } + if (false == file.isFile()) { + throw new IORuntimeException("Not a file:" + file); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileSystemUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileSystemUtil.java new file mode 100644 index 0000000..4b9dac3 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileSystemUtil.java @@ -0,0 +1,84 @@ +package aiyh.utils.tool.cn.hutool.core.io.file; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.IOException; +import java.net.URI; +import java.nio.charset.Charset; +import java.nio.file.FileSystem; +import java.nio.file.FileSystems; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.HashMap; + +/** + * {@link FileSystem}相关工具类封装
+ * 参考：https://blog.csdn.net/j16421881/article/details/78858690 + * + * @author looly + * @since 5.7.15 + */ +public class FileSystemUtil { + + /** + * 创建 {@link FileSystem} + * + * @param path 文件路径，可以是目录或Zip文件等 + * @return {@link FileSystem} + */ + public static FileSystem create(String path) { + try { + return FileSystems.newFileSystem( + Paths.get(path).toUri(), + MapUtil.of("create", "true")); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 创建 Zip的{@link FileSystem}，默认UTF-8编码 + * + * @param path 文件路径，可以是目录或Zip文件等 + * @return {@link FileSystem} + */ + public static FileSystem createZip(String path) { + return createZip(path, null); + } + + /** + * 创建 Zip的{@link FileSystem} + * + * @param path 文件路径，可以是目录或Zip文件等 + * @param charset 编码 + * @return {@link FileSystem} + */ + public static FileSystem createZip(String path, Charset charset) { + if(null == charset){ + charset = CharsetUtil.CHARSET_UTF_8; + } + final HashMap env = new HashMap<>(); + env.put("create", "true"); + env.put("encoding", charset.name()); + + try { + return FileSystems.newFileSystem( + URI.create("jar:" + Paths.get(path).toUri()), env); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 获取目录的根路径，或Zip文件中的根路径 + * + * @param fileSystem {@link FileSystem} + * @return 根 {@link Path} + */ + public static Path getRoot(FileSystem fileSystem) { + return fileSystem.getPath(StrUtil.SLASH); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileWrapper.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileWrapper.java new file mode 100644 index 0000000..039afc9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileWrapper.java @@ -0,0 +1,83 @@ +package aiyh.utils.tool.cn.hutool.core.io.file; + +import java.io.File; +import java.io.Serializable; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; + +/** + * 文件包装器，扩展文件对象 + * + * @author Looly + * + */ +public class FileWrapper implements Serializable{ + private static final long serialVersionUID = 1L; + + protected File file; + protected Charset charset; + + /** 默认编码：UTF-8 */ + public static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8; + + // ------------------------------------------------------- Constructor start + /** + * 构造 + * @param file 文件 + * @param charset 编码，使用 {@link CharsetUtil} + */ + public FileWrapper(File file, Charset charset) { + this.file = file; + this.charset = charset; + } + // ------------------------------------------------------- Constructor end + + // ------------------------------------------------------- Setters and Getters start start + /** + * 获得文件 + * @return 文件 + */ + public File getFile() { + return file; + } + + /** + * 设置文件 + * @param file 文件 + * @return 自身 + */ + public FileWrapper setFile(File file) { + this.file = file; + return this; + } + + /** + * 获得字符集编码 + * @return 编码 + */ + public Charset getCharset() { + return charset; + } + + /** + * 设置字符集编码 + * @param charset 编码 + * @return 自身 + */ + public FileWrapper setCharset(Charset charset) { + this.charset = charset; + return this; + } + // ------------------------------------------------------- Setters and Getters start end + + /** + * 可读的文件大小 + * @return 大小 + */ + public String readableFileSize() { + return FileUtil.readableFileSize(file.length()); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileWriter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileWriter.java new file mode 100644 index 0000000..2993bd4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/FileWriter.java @@ -0,0 +1,422 @@ +package aiyh.utils.tool.cn.hutool.core.io.file; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.BufferedOutputStream; +import java.io.BufferedWriter; +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStreamWriter; +import java.io.PrintWriter; +import java.nio.charset.Charset; +import java.util.Map; +import java.util.Map.Entry; + +/** + * 文件写入器 + * + * @author Looly + */ +public class FileWriter extends FileWrapper { + private static final long serialVersionUID = 1L; + + /** + * 创建 FileWriter + * + * @param file 文件 + * @param charset 编码，使用 {@link CharsetUtil} + * @return FileWriter + */ + public static FileWriter create(File file, Charset charset) { + return new FileWriter(file, charset); + } + + /** + * 创建 FileWriter, 编码：{@link FileWrapper#DEFAULT_CHARSET} + * + * @param file 文件 + * @return FileWriter + */ + public static FileWriter create(File file) { + return new FileWriter(file); + } + + // ------------------------------------------------------- Constructor start + + /** + * 构造 + * + * @param file 文件 + * @param charset 编码，使用 {@link CharsetUtil} + */ + public FileWriter(File file, Charset charset) { + super(file, charset); + checkFile(); + } + + /** + * 构造 + * + * @param file 文件 + * @param charset 编码，使用 {@link CharsetUtil#charset(String)} + */ + public FileWriter(File file, String charset) { + this(file, CharsetUtil.charset(charset)); + } + + /** + * 构造 + * + * @param filePath 文件路径，相对路径会被转换为相对于ClassPath的路径 + * @param charset 编码，使用 {@link CharsetUtil} + */ + public FileWriter(String filePath, Charset charset) { + this(FileUtil.file(filePath), charset); + } + + /** + * 构造 + * + * @param filePath 文件路径，相对路径会被转换为相对于ClassPath的路径 + * @param charset 编码，使用 {@link CharsetUtil#charset(String)} + */ + public FileWriter(String filePath, String charset) { + this(FileUtil.file(filePath), CharsetUtil.charset(charset)); + } + + /** + * 构造
+ * 编码使用 {@link FileWrapper#DEFAULT_CHARSET} + * + * @param file 文件 + */ + public FileWriter(File file) { + this(file, DEFAULT_CHARSET); + } + + /** + * 构造
+ * 编码使用 {@link FileWrapper#DEFAULT_CHARSET} + * + * @param filePath 文件路径，相对路径会被转换为相对于ClassPath的路径 + */ + public FileWriter(String filePath) { + this(filePath, DEFAULT_CHARSET); + } + // ------------------------------------------------------- Constructor end + + /** + * 将String写入文件 + * + * @param content 写入的内容 + * @param isAppend 是否追加 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public File write(String content, boolean isAppend) throws IORuntimeException { + BufferedWriter writer = null; + try { + writer = getWriter(isAppend); + writer.write(content); + writer.flush(); + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + IoUtil.close(writer); + } + return file; + } + + /** + * 将String写入文件，覆盖模式 + * + * @param content 写入的内容 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public File write(String content) throws IORuntimeException { + return write(content, false); + } + + /** + * 将String写入文件，追加模式 + * + * @param content 写入的内容 + * @return 写入的文件 + * @throws IORuntimeException IO异常 + */ + public File append(String content) throws IORuntimeException { + return write(content, true); + } + + /** + * 将列表写入文件，覆盖模式 + * + * @param 集合元素类型 + * @param list 列表 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public File writeLines(Iterable list) throws IORuntimeException { + return writeLines(list, false); + } + + /** + * 将列表写入文件，追加模式 + * + * @param 集合元素类型 + * @param list 列表 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public File appendLines(Iterable list) throws IORuntimeException { + return writeLines(list, true); + } + + /** + * 将列表写入文件 + * + * @param 集合元素类型 + * @param list 列表 + * @param isAppend 是否追加 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public File writeLines(Iterable list, boolean isAppend) throws IORuntimeException { + return writeLines(list, null, isAppend); + } + + /** + * 将列表写入文件 + * + * @param 集合元素类型 + * @param list 列表 + * @param lineSeparator 换行符枚举（Windows、Mac或Linux换行符） + * @param isAppend 是否追加 + * @return 目标文件 + * @throws IORuntimeException IO异常 + * @since 3.1.0 + */ + public File writeLines(Iterable list, LineSeparator lineSeparator, boolean isAppend) throws IORuntimeException { + try (PrintWriter writer = getPrintWriter(isAppend)) { + boolean isFirst = true; + for (T t : list) { + if (null != t) { + if(isFirst){ + isFirst = false; + if(isAppend && FileUtil.isNotEmpty(this.file)){ + // 追加模式下且文件非空，补充换行符 + printNewLine(writer, lineSeparator); + } + } else{ + printNewLine(writer, lineSeparator); + } + writer.print(t); + + writer.flush(); + } + } + } + return this.file; + } + + /** + * 将Map写入文件，每个键值对为一行，一行中键与值之间使用kvSeparator分隔 + * + * @param map Map + * @param kvSeparator 键和值之间的分隔符，如果传入null使用默认分隔符" = " + * @param isAppend 是否追加 + * @return 目标文件 + * @throws IORuntimeException IO异常 + * @since 4.0.5 + */ + public File writeMap(Map map, String kvSeparator, boolean isAppend) throws IORuntimeException { + return writeMap(map, null, kvSeparator, isAppend); + } + + /** + * 将Map写入文件，每个键值对为一行，一行中键与值之间使用kvSeparator分隔 + * + * @param map Map + * @param lineSeparator 换行符枚举（Windows、Mac或Linux换行符） + * @param kvSeparator 键和值之间的分隔符，如果传入null使用默认分隔符" = " + * @param isAppend 是否追加 + * @return 目标文件 + * @throws IORuntimeException IO异常 + * @since 4.0.5 + */ + public File writeMap(Map map, LineSeparator lineSeparator, String kvSeparator, boolean isAppend) throws IORuntimeException { + if (null == kvSeparator) { + kvSeparator = " = "; + } + try (PrintWriter writer = getPrintWriter(isAppend)) { + for (Entry entry : map.entrySet()) { + if (null != entry) { + writer.print(StrUtil.format("{}{}{}", entry.getKey(), kvSeparator, entry.getValue())); + printNewLine(writer, lineSeparator); + writer.flush(); + } + } + } + return this.file; + } + + /** + * 写入数据到文件 + * + * @param data 数据 + * @param off 数据开始位置 + * @param len 数据长度 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public File write(byte[] data, int off, int len) throws IORuntimeException { + return write(data, off, len, false); + } + + /** + * 追加数据到文件 + * + * @param data 数据 + * @param off 数据开始位置 + * @param len 数据长度 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public File append(byte[] data, int off, int len) throws IORuntimeException { + return write(data, off, len, true); + } + + /** + * 写入数据到文件 + * + * @param data 数据 + * @param off 数据开始位置 + * @param len 数据长度 + * @param isAppend 是否追加模式 + * @return 目标文件 + * @throws IORuntimeException IO异常 + */ + public File write(byte[] data, int off, int len, boolean isAppend) throws IORuntimeException { + try (FileOutputStream out = new FileOutputStream(FileUtil.touch(file), isAppend)) { + out.write(data, off, len); + out.flush(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + return file; + } + + /** + * 将流的内容写入文件
+ * 此方法会自动关闭输入流 + * + * @param in 输入流，不关闭 + * @return dest + * @throws IORuntimeException IO异常 + */ + public File writeFromStream(InputStream in) throws IORuntimeException { + return writeFromStream(in, true); + } + + /** + * 将流的内容写入文件 + * + * @param in 输入流，不关闭 + * @param isCloseIn 是否关闭输入流 + * @return dest + * @throws IORuntimeException IO异常 + * @since 5.5.2 + */ + public File writeFromStream(InputStream in, boolean isCloseIn) throws IORuntimeException { + FileOutputStream out = null; + try { + out = new FileOutputStream(FileUtil.touch(file)); + IoUtil.copy(in, out); + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + IoUtil.close(out); + if (isCloseIn) { + IoUtil.close(in); + } + } + return file; + } + + /** + * 获得一个输出流对象 + * + * @return 输出流对象 + * @throws IORuntimeException IO异常 + */ + public BufferedOutputStream getOutputStream() throws IORuntimeException { + try { + return new BufferedOutputStream(new FileOutputStream(FileUtil.touch(file))); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 获得一个带缓存的写入对象 + * + * @param isAppend 是否追加 + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + */ + public BufferedWriter getWriter(boolean isAppend) throws IORuntimeException { + try { + return new BufferedWriter(new OutputStreamWriter(new FileOutputStream(FileUtil.touch(file), isAppend), charset)); + } catch (Exception e) { + throw new IORuntimeException(e); + } + } + + /** + * 获得一个打印写入对象，可以有print + * + * @param isAppend 是否追加 + * @return 打印对象 + * @throws IORuntimeException IO异常 + */ + public PrintWriter getPrintWriter(boolean isAppend) throws IORuntimeException { + return new PrintWriter(getWriter(isAppend)); + } + + /** + * 检查文件 + * + * @throws IORuntimeException IO异常 + */ + private void checkFile() throws IORuntimeException { + Assert.notNull(file, "File to write content is null !"); + if (this.file.exists() && false == file.isFile()) { + throw new IORuntimeException("File [{}] is not a file !", this.file.getAbsoluteFile()); + } + } + + /** + * 打印新行 + * + * @param writer Writer + * @param lineSeparator 换行符枚举 + * @since 4.0.5 + */ + private void printNewLine(PrintWriter writer, LineSeparator lineSeparator) { + if (null == lineSeparator) { + //默认换行符 + writer.println(); + } else { + //自定义换行符 + writer.print(lineSeparator.getValue()); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/LineReadWatcher.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/LineReadWatcher.java new file mode 100644 index 0000000..0311e44 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/LineReadWatcher.java @@ -0,0 +1,71 @@ +package aiyh.utils.tool.cn.hutool.core.io.file; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.LineHandler; +import aiyh.utils.tool.cn.hutool.core.io.watch.SimpleWatcher; + +import java.io.IOException; +import java.io.RandomAccessFile; +import java.nio.charset.Charset; +import java.nio.file.Path; +import java.nio.file.WatchEvent; + +/** + * 行处理的Watcher实现 + * + * @author looly + * @since 4.5.2 + */ +public class LineReadWatcher extends SimpleWatcher implements Runnable { + + private final RandomAccessFile randomAccessFile; + private final Charset charset; + private final LineHandler lineHandler; + + /** + * 构造 + * + * @param randomAccessFile {@link RandomAccessFile} + * @param charset 编码 + * @param lineHandler 行处理器{@link LineHandler}实现 + */ + public LineReadWatcher(RandomAccessFile randomAccessFile, Charset charset, LineHandler lineHandler) { + this.randomAccessFile = randomAccessFile; + this.charset = charset; + this.lineHandler = lineHandler; + } + + @Override + public void run() { + onModify(null, null); + } + + @Override + public void onModify(WatchEvent event, Path currentPath) { + final RandomAccessFile randomAccessFile = this.randomAccessFile; + final Charset charset = this.charset; + final LineHandler lineHandler = this.lineHandler; + + try { + final long currentLength = randomAccessFile.length(); + final long position = randomAccessFile.getFilePointer(); + if (position == currentLength) { + // 内容长度不变时忽略此次事件 + return; + } else if (currentLength < position) { + // 如果内容变短或变0，说明文件做了删改或清空，回到内容末尾或0 + randomAccessFile.seek(currentLength); + return; + } + + // 读取行 + FileUtil.readLines(randomAccessFile, charset, lineHandler); + + // 记录当前读到的位置 + randomAccessFile.seek(currentLength); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/LineSeparator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/LineSeparator.java new file mode 100644 index 0000000..86d9364 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/LineSeparator.java @@ -0,0 +1,35 @@ +package aiyh.utils.tool.cn.hutool.core.io.file; + +/** + * 换行符枚举
+ * 换行符包括： + * 
+ * Mac系统换行符："\r"
+ * Linux系统换行符："\n"
+ * Windows系统换行符："\r\n"
+ *
+ * + * @see #MAC + * @see #LINUX + * @see #WINDOWS + * @author Looly + * @since 3.1.0 + */ +public enum LineSeparator { + /** Mac系统换行符："\r" */ + MAC("\r"), + /** Linux系统换行符："\n" */ + LINUX("\n"), + /** Windows系统换行符："\r\n" */ + WINDOWS("\r\n"); + + private final String value; + + LineSeparator(String lineSeparator) { + this.value = lineSeparator; + } + + public String getValue() { + return this.value; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/PathUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/PathUtil.java new file mode 100644 index 0000000..79d8203 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/PathUtil.java @@ -0,0 +1,701 @@ +package aiyh.utils.tool.cn.hutool.core.io.file; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.io.file.visitor.CopyVisitor; +import aiyh.utils.tool.cn.hutool.core.io.file.visitor.DelVisitor; +import aiyh.utils.tool.cn.hutool.core.io.file.visitor.MoveVisitor; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; + +import java.io.BufferedInputStream; +import java.io.BufferedOutputStream; +import java.io.BufferedReader; +import java.io.File; +import java.io.FileFilter; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.charset.Charset; +import java.nio.file.AccessDeniedException; +import java.nio.file.CopyOption; +import java.nio.file.DirectoryStream; +import java.nio.file.FileAlreadyExistsException; +import java.nio.file.FileVisitOption; +import java.nio.file.FileVisitResult; +import java.nio.file.FileVisitor; +import java.nio.file.Files; +import java.nio.file.LinkOption; +import java.nio.file.Path; +import java.nio.file.SimpleFileVisitor; +import java.nio.file.StandardCopyOption; +import java.nio.file.attribute.BasicFileAttributes; +import java.util.ArrayList; +import java.util.EnumSet; +import java.util.List; + +/** + * NIO中Path对象操作封装 + * + * @author looly + * @since 5.4.1 + */ +public class PathUtil { + /** + * 目录是否为空 + * + * @param dirPath 目录 + * @return 是否为空 + * @throws IORuntimeException IOException + */ + public static boolean isDirEmpty(Path dirPath) { + try (DirectoryStream dirStream = Files.newDirectoryStream(dirPath)) { + return false == dirStream.iterator().hasNext(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 递归遍历目录以及子目录中的所有文件
+ * 如果提供path为文件，直接返回过滤结果 + * + * @param path 当前遍历文件或目录 + * @param fileFilter 文件过滤规则对象，选择要保留的文件，只对文件有效，不过滤目录，null表示接收全部文件 + * @return 文件列表 + * @since 5.4.1 + */ + public static List loopFiles(Path path, FileFilter fileFilter) { + return loopFiles(path, -1, fileFilter); + } + + /** + * 递归遍历目录以及子目录中的所有文件
+ * 如果提供path为文件，直接返回过滤结果 + * + * @param path 当前遍历文件或目录 + * @param maxDepth 遍历最大深度，-1表示遍历到没有目录为止 + * @param fileFilter 文件过滤规则对象，选择要保留的文件，只对文件有效，不过滤目录，null表示接收全部文件 + * @return 文件列表 + * @since 5.4.1 + */ + public static List loopFiles(Path path, int maxDepth, FileFilter fileFilter) { + final List fileList = new ArrayList<>(); + + if (null == path || false == Files.exists(path)) { + return fileList; + } else if (false == isDirectory(path)) { + final File file = path.toFile(); + if (null == fileFilter || fileFilter.accept(file)) { + fileList.add(file); + } + return fileList; + } + + walkFiles(path, maxDepth, new SimpleFileVisitor() { + + @Override + public FileVisitResult visitFile(Path path, BasicFileAttributes attrs) { + final File file = path.toFile(); + if (null == fileFilter || fileFilter.accept(file)) { + fileList.add(file); + } + return FileVisitResult.CONTINUE; + } + }); + + return fileList; + } + + /** + * 遍历指定path下的文件并做处理 + * + * @param start 起始路径，必须为目录 + * @param visitor {@link FileVisitor} 接口，用于自定义在访问文件时，访问目录前后等节点做的操作 + * @see Files#walkFileTree(Path, java.util.Set, int, FileVisitor) + * @since 5.5.2 + */ + public static void walkFiles(Path start, FileVisitor visitor) { + walkFiles(start, -1, visitor); + } + + /** + * 遍历指定path下的文件并做处理 + * + * @param start 起始路径，必须为目录 + * @param maxDepth 最大遍历深度，-1表示不限制深度 + * @param visitor {@link FileVisitor} 接口，用于自定义在访问文件时，访问目录前后等节点做的操作 + * @see Files#walkFileTree(Path, java.util.Set, int, FileVisitor) + * @since 4.6.3 + */ + public static void walkFiles(Path start, int maxDepth, FileVisitor visitor) { + if (maxDepth < 0) { + // < 0 表示遍历到最底层 + maxDepth = Integer.MAX_VALUE; + } + + try { + Files.walkFileTree(start, EnumSet.noneOf(FileVisitOption.class), maxDepth, visitor); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 删除文件或者文件夹，不追踪软链
+ * 注意：删除文件夹时不会判断文件夹是否为空，如果不空则递归删除子文件或文件夹
+ * 某个文件删除失败会终止删除操作 + * + * @param path 文件对象 + * @return 成功与否 + * @throws IORuntimeException IO异常 + * @since 4.4.2 + */ + public static boolean del(Path path) throws IORuntimeException { + if (Files.notExists(path)) { + return true; + } + + try { + if (isDirectory(path)) { + Files.walkFileTree(path, DelVisitor.INSTANCE); + } else { + delFile(path); + } + } catch (IOException e) { + throw new IORuntimeException(e); + } + return true; + } + + /** + * 通过JDK7+的 {@link Files#copy(Path, Path, CopyOption...)} 方法拷贝文件
+ * 此方法不支持递归拷贝目录，如果src传入是目录，只会在目标目录中创建空目录 + * + * @param src 源文件路径，如果为目录只在目标中创建新目录 + * @param dest 目标文件或目录，如果为目录使用与源文件相同的文件名 + * @param options {@link StandardCopyOption} + * @return Path + * @throws IORuntimeException IO异常 + */ + public static Path copyFile(Path src, Path dest, StandardCopyOption... options) throws IORuntimeException { + return copyFile(src, dest, (CopyOption[]) options); + } + + /** + * 通过JDK7+的 {@link Files#copy(Path, Path, CopyOption...)} 方法拷贝文件
+ * 此方法不支持递归拷贝目录，如果src传入是目录，只会在目标目录中创建空目录 + * + * @param src 源文件路径，如果为目录只在目标中创建新目录 + * @param target 目标文件或目录，如果为目录使用与源文件相同的文件名 + * @param options {@link StandardCopyOption} + * @return Path + * @throws IORuntimeException IO异常 + * @since 5.4.1 + */ + public static Path copyFile(Path src, Path target, CopyOption... options) throws IORuntimeException { + Assert.notNull(src, "Source File is null !"); + Assert.notNull(target, "Destination File or directory is null !"); + + final Path targetPath = isDirectory(target) ? target.resolve(src.getFileName()) : target; + // 创建级联父目录 + mkParentDirs(targetPath); + try { + return Files.copy(src, targetPath, options); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 拷贝文件或目录，拷贝规则为： + * + *
    + *
  • 源文件为目录，目标也为目录或不存在，则拷贝整个目录到目标目录下
    • + *
  • 源文件为文件，目标为目录或不存在，则拷贝文件到目标目录下
    • + *
  • 源文件为文件，目标也为文件，则在{@link StandardCopyOption#REPLACE_EXISTING}情况下覆盖之
    • + *
+ * + * @param src 源文件路径，如果为目录会在目标中创建新目录 + * @param target 目标文件或目录，如果为目录使用与源文件相同的文件名 + * @param options {@link StandardCopyOption} + * @return Path + * @throws IORuntimeException IO异常 + * @since 5.5.1 + */ + public static Path copy(Path src, Path target, CopyOption... options) throws IORuntimeException { + Assert.notNull(src, "Src path must be not null !"); + Assert.notNull(target, "Target path must be not null !"); + + if (isDirectory(src)) { + return copyContent(src, target.resolve(src.getFileName()), options); + } + return copyFile(src, target, options); + } + + /** + * 拷贝目录下的所有文件或目录到目标目录中，此方法不支持文件对文件的拷贝。 + *
    + *
  • 源文件为目录，目标也为目录或不存在，则拷贝目录下所有文件和目录到目标目录下
    • + *
  • 源文件为文件，目标为目录或不存在，则拷贝文件到目标目录下
    • + *
+ * + * @param src 源文件路径，如果为目录只在目标中创建新目录 + * @param target 目标目录，如果为目录使用与源文件相同的文件名 + * @param options {@link StandardCopyOption} + * @return Path + * @throws IORuntimeException IO异常 + * @since 5.5.1 + */ + public static Path copyContent(Path src, Path target, CopyOption... options) throws IORuntimeException { + Assert.notNull(src, "Src path must be not null !"); + Assert.notNull(target, "Target path must be not null !"); + + try { + Files.walkFileTree(src, new CopyVisitor(src, target, options)); + } catch (IOException e) { + throw new IORuntimeException(e); + } + return target; + } + + /** + * 判断是否为目录，如果file为null，则返回false
+ * 此方法不会追踪到软链对应的真实地址，即软链被当作文件 + * + * @param path {@link Path} + * @return 如果为目录true + * @since 5.5.1 + */ + public static boolean isDirectory(Path path) { + return isDirectory(path, false); + } + + /** + * 判断是否为目录，如果file为null，则返回false + * + * @param path {@link Path} + * @param isFollowLinks 是否追踪到软链对应的真实地址 + * @return 如果为目录true + * @since 3.1.0 + */ + public static boolean isDirectory(Path path, boolean isFollowLinks) { + if (null == path) { + return false; + } + final LinkOption[] options = isFollowLinks ? new LinkOption[0] : new LinkOption[]{LinkOption.NOFOLLOW_LINKS}; + return Files.isDirectory(path, options); + } + + /** + * 获取指定位置的子路径部分，支持负数，例如index为-1表示从后数第一个节点位置 + * + * @param path 路径 + * @param index 路径节点位置，支持负数（负数从后向前计数） + * @return 获取的子路径 + * @since 3.1.2 + */ + public static Path getPathEle(Path path, int index) { + return subPath(path, index, index == -1 ? path.getNameCount() : index + 1); + } + + /** + * 获取指定位置的最后一个子路径部分 + * + * @param path 路径 + * @return 获取的最后一个子路径 + * @since 3.1.2 + */ + public static Path getLastPathEle(Path path) { + return getPathEle(path, path.getNameCount() - 1); + } + + /** + * 获取指定位置的子路径部分，支持负数，例如起始为-1表示从后数第一个节点位置 + * + * @param path 路径 + * @param fromIndex 起始路径节点（包括） + * @param toIndex 结束路径节点（不包括） + * @return 获取的子路径 + * @since 3.1.2 + */ + public static Path subPath(Path path, int fromIndex, int toIndex) { + if (null == path) { + return null; + } + final int len = path.getNameCount(); + + if (fromIndex < 0) { + fromIndex = len + fromIndex; + if (fromIndex < 0) { + fromIndex = 0; + } + } else if (fromIndex > len) { + fromIndex = len; + } + + if (toIndex < 0) { + toIndex = len + toIndex; + if (toIndex < 0) { + toIndex = len; + } + } else if (toIndex > len) { + toIndex = len; + } + + if (toIndex < fromIndex) { + int tmp = fromIndex; + fromIndex = toIndex; + toIndex = tmp; + } + + if (fromIndex == toIndex) { + return null; + } + return path.subpath(fromIndex, toIndex); + } + + /** + * 获取文件属性 + * + * @param path 文件路径{@link Path} + * @param isFollowLinks 是否跟踪到软链对应的真实路径 + * @return {@link BasicFileAttributes} + * @throws IORuntimeException IO异常 + */ + public static BasicFileAttributes getAttributes(Path path, boolean isFollowLinks) throws IORuntimeException { + if (null == path) { + return null; + } + + final LinkOption[] options = isFollowLinks ? new LinkOption[0] : new LinkOption[]{LinkOption.NOFOLLOW_LINKS}; + try { + return Files.readAttributes(path, BasicFileAttributes.class, options); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 获得输入流 + * + * @param path Path + * @return 输入流 + * @throws IORuntimeException 文件未找到 + * @since 4.0.0 + */ + public static BufferedInputStream getInputStream(Path path) throws IORuntimeException { + final InputStream in; + try { + in = Files.newInputStream(path); + } catch (IOException e) { + throw new IORuntimeException(e); + } + return IoUtil.toBuffered(in); + } + + /** + * 获得一个文件读取器 + * + * @param path 文件Path + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + * @since 4.0.0 + */ + public static BufferedReader getUtf8Reader(Path path) throws IORuntimeException { + return getReader(path, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 获得一个文件读取器 + * + * @param path 文件Path + * @param charset 字符集 + * @return BufferedReader对象 + * @throws IORuntimeException IO异常 + * @since 4.0.0 + */ + public static BufferedReader getReader(Path path, Charset charset) throws IORuntimeException { + return IoUtil.getReader(getInputStream(path), charset); + } + + /** + * 读取文件的所有内容为byte数组 + * + * @param path 文件 + * @return byte数组 + * @since 5.5.4 + */ + public static byte[] readBytes(Path path) { + try { + return Files.readAllBytes(path); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 获得输出流 + * + * @param path Path + * @return 输入流 + * @throws IORuntimeException 文件未找到 + * @since 5.4.1 + */ + public static BufferedOutputStream getOutputStream(Path path) throws IORuntimeException { + final OutputStream in; + try { + in = Files.newOutputStream(path); + } catch (IOException e) { + throw new IORuntimeException(e); + } + return IoUtil.toBuffered(in); + } + + /** + * 修改文件或目录的文件名，不变更路径，只是简单修改文件名
+ * + * 
+	 * FileUtil.rename(file, "aaa.jpg", false) xx/xx.png =》xx/aaa.jpg
+	 *
+ * + * @param path 被修改的文件 + * @param newName 新的文件名，包括扩展名 + * @param isOverride 是否覆盖目标文件 + * @return 目标文件Path + * @since 5.4.1 + */ + public static Path rename(Path path, String newName, boolean isOverride) { + return move(path, path.resolveSibling(newName), isOverride); + } + + /** + * 移动文件或目录
+ * 当目标是目录时，会将源文件或文件夹整体移动至目标目录下
+ * 例如： + *
    + *
  • move("/usr/aaa/abc.txt", "/usr/bbb")结果为："/usr/bbb/abc.txt"
    • + *
  • move("/usr/aaa", "/usr/bbb")结果为："/usr/bbb/aaa"
    • + *
+ * + * @param src 源文件或目录路径 + * @param target 目标路径，如果为目录，则移动到此目录下 + * @param isOverride 是否覆盖目标文件 + * @return 目标文件Path + * @since 5.5.1 + */ + public static Path move(Path src, Path target, boolean isOverride) { + Assert.notNull(src, "Src path must be not null !"); + Assert.notNull(target, "Target path must be not null !"); + + if(equals(src, target)){ + // issue#2845，当用户传入目标路径与源路径一致时，直接返回，否则会导致删除风险。 + return target; + } + + if (isDirectory(target)) { + target = target.resolve(src.getFileName()); + } + return moveContent(src, target, isOverride); + } + + /** + * 移动文件或目录内容到目标目录中，例如： + *
    + *
  • moveContent("/usr/aaa/abc.txt", "/usr/bbb")结果为："/usr/bbb/abc.txt"
    • + *
  • moveContent("/usr/aaa", "/usr/bbb")结果为："/usr/bbb"
    • + *
+ * + * @param src 源文件或目录路径 + * @param target 目标路径，如果为目录，则移动到此目录下 + * @param isOverride 是否覆盖目标文件 + * @return 目标文件Path + * @since 5.7.9 + */ + public static Path moveContent(Path src, Path target, boolean isOverride) { + Assert.notNull(src, "Src path must be not null !"); + Assert.notNull(target, "Target path must be not null !"); + final CopyOption[] options = isOverride ? new CopyOption[]{StandardCopyOption.REPLACE_EXISTING} : new CopyOption[]{}; + + // 自动创建目标的父目录 + mkParentDirs(target); + try { + return Files.move(src, target, options); + } catch (IOException e) { + if(e instanceof FileAlreadyExistsException){ + // 目标文件已存在，直接抛出异常 + // issue#I4QV0L@Gitee + throw new IORuntimeException(e); + } + // 移动失败，可能是跨分区移动导致的，采用递归移动方式 + try { + Files.walkFileTree(src, new MoveVisitor(src, target, options)); + // 移动后空目录没有删除， + del(src); + } catch (IOException e2) { + throw new IORuntimeException(e2); + } + return target; + } + } + + /** + * 检查两个文件是否是同一个文件
+ * 所谓文件相同，是指Path对象是否指向同一个文件或文件夹 + * + * @param file1 文件1 + * @param file2 文件2 + * @return 是否相同 + * @throws IORuntimeException IO异常 + * @see Files#isSameFile(Path, Path) + * @since 5.4.1 + */ + public static boolean equals(Path file1, Path file2) throws IORuntimeException { + try { + return Files.isSameFile(file1, file2); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 判断是否为文件，如果file为null，则返回false + * + * @param path 文件 + * @param isFollowLinks 是否跟踪软链（快捷方式） + * @return 如果为文件true + * @see Files#isRegularFile(Path, LinkOption...) + */ + public static boolean isFile(Path path, boolean isFollowLinks) { + if (null == path) { + return false; + } + final LinkOption[] options = isFollowLinks ? new LinkOption[0] : new LinkOption[]{LinkOption.NOFOLLOW_LINKS}; + return Files.isRegularFile(path, options); + } + + /** + * 判断是否为符号链接文件 + * + * @param path 被检查的文件 + * @return 是否为符号链接文件 + * @since 4.4.2 + */ + public static boolean isSymlink(Path path) { + return Files.isSymbolicLink(path); + } + + /** + * 判断文件或目录是否存在 + * + * @param path 文件 + * @param isFollowLinks 是否跟踪软链（快捷方式） + * @return 是否存在 + * @since 5.5.3 + */ + public static boolean exists(Path path, boolean isFollowLinks) { + final LinkOption[] options = isFollowLinks ? new LinkOption[0] : new LinkOption[]{LinkOption.NOFOLLOW_LINKS}; + return Files.exists(path, options); + } + + /** + * 判断给定的目录是否为给定文件或文件夹的子目录 + * + * @param parent 父目录 + * @param sub 子目录 + * @return 子目录是否为父目录的子目录 + * @since 5.5.5 + */ + public static boolean isSub(Path parent, Path sub) { + return toAbsNormal(sub).startsWith(toAbsNormal(parent)); + } + + /** + * 将Path路径转换为标准的绝对路径 + * + * @param path 文件或目录Path + * @return 转换后的Path + * @since 5.5.5 + */ + public static Path toAbsNormal(Path path) { + Assert.notNull(path); + return path.toAbsolutePath().normalize(); + } + + /** + * 获得文件的MimeType + * + * @param file 文件 + * @return MimeType + * @see Files#probeContentType(Path) + * @since 5.5.5 + */ + public static String getMimeType(Path file) { + try { + return Files.probeContentType(file); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 创建所给目录及其父目录 + * + * @param dir 目录 + * @return 目录 + * @since 5.5.7 + */ + public static Path mkdir(Path dir) { + if (null != dir && false == exists(dir, false)) { + try { + Files.createDirectories(dir); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + return dir; + } + + /** + * 创建所给文件或目录的父目录 + * + * @param path 文件或目录 + * @return 父目录 + * @since 5.5.7 + */ + public static Path mkParentDirs(Path path) { + return mkdir(path.getParent()); + } + + /** + * 获取{@link Path}文件名 + * + * @param path {@link Path} + * @return 文件名 + * @since 5.7.15 + */ + public static String getName(Path path) { + if (null == path) { + return null; + } + return path.getFileName().toString(); + } + + /** + * 删除文件或空目录，不追踪软链 + * + * @param path 文件对象 + * @throws IOException IO异常 + * @since 5.7.7 + */ + protected static void delFile(Path path) throws IOException { + try { + Files.delete(path); + } catch (AccessDeniedException e) { + // 可能遇到只读文件，无法删除.使用 file 方法删除 + if (false == path.toFile().delete()) { + throw e; + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/Tailer.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/Tailer.java new file mode 100755 index 0000000..9377b78 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/Tailer.java @@ -0,0 +1,231 @@ +package aiyh.utils.tool.cn.hutool.core.io.file; + +import aiyh.utils.tool.cn.hutool.core.date.DateUnit; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.LineHandler; +import aiyh.utils.tool.cn.hutool.core.lang.Console; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; + +import java.io.File; +import java.io.IOException; +import java.io.RandomAccessFile; +import java.io.Serializable; +import java.nio.charset.Charset; +import java.util.Stack; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Executors; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.ScheduledFuture; +import java.util.concurrent.TimeUnit; + +/** + * 文件内容跟随器，实现类似Linux下"tail -f"命令功能 + * + * @author looly + * @since 4.5.2 + */ +public class Tailer implements Serializable { + private static final long serialVersionUID = 1L; + + public static final LineHandler CONSOLE_HANDLER = new ConsoleLineHandler(); + + /** 编码 */ + private final Charset charset; + /** 行处理器 */ + private final LineHandler lineHandler; + /** 初始读取的行数 */ + private final int initReadLine; + /** 定时任务检查间隔时长 */ + private final long period; + + private final RandomAccessFile randomAccessFile; + private final ScheduledExecutorService executorService; + + /** + * 构造，默认UTF-8编码 + * + * @param file 文件 + * @param lineHandler 行处理器 + */ + public Tailer(File file, LineHandler lineHandler) { + this(file, lineHandler, 0); + } + + /** + * 构造，默认UTF-8编码 + * + * @param file 文件 + * @param lineHandler 行处理器 + * @param initReadLine 启动时预读取的行数 + */ + public Tailer(File file, LineHandler lineHandler, int initReadLine) { + this(file, CharsetUtil.CHARSET_UTF_8, lineHandler, initReadLine, DateUnit.SECOND.getMillis()); + } + + /** + * 构造 + * + * @param file 文件 + * @param charset 编码 + * @param lineHandler 行处理器 + */ + public Tailer(File file, Charset charset, LineHandler lineHandler) { + this(file, charset, lineHandler, 0, DateUnit.SECOND.getMillis()); + } + + /** + * 构造 + * + * @param file 文件 + * @param charset 编码 + * @param lineHandler 行处理器 + * @param initReadLine 启动时预读取的行数 + * @param period 检查间隔 + */ + public Tailer(File file, Charset charset, LineHandler lineHandler, int initReadLine, long period) { + checkFile(file); + this.charset = charset; + this.lineHandler = lineHandler; + this.period = period; + this.initReadLine = initReadLine; + this.randomAccessFile = FileUtil.createRandomAccessFile(file, FileMode.r); + this.executorService = Executors.newSingleThreadScheduledExecutor(); + } + + /** + * 开始监听 + */ + public void start() { + start(false); + } + + /** + * 开始监听 + * + * @param async 是否异步执行 + */ + public void start(boolean async) { + // 初始读取 + try { + this.readTail(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + + final LineReadWatcher lineReadWatcher = new LineReadWatcher(this.randomAccessFile, this.charset, this.lineHandler); + final ScheduledFuture scheduledFuture = this.executorService.scheduleAtFixedRate(// + lineReadWatcher, // + 0, // + this.period, TimeUnit.MILLISECONDS// + ); + + if (false == async) { + try { + scheduledFuture.get(); + } catch (ExecutionException e) { + throw new UtilException(e); + } catch (InterruptedException e) { + // ignore and exist + } + } + } + + /** + * 结束，此方法需在异步模式或 + */ + public void stop(){ + this.executorService.shutdown(); + } + + // ---------------------------------------------------------------------------------------- Private method start + /** + * 预读取行 + * + * @throws IOException IO异常 + */ + private void readTail() throws IOException { + final long len = this.randomAccessFile.length(); + + if (initReadLine > 0) { + Stack stack = new Stack<>(); + + long start = this.randomAccessFile.getFilePointer(); + long nextEnd = (len - 1) < 0 ? 0 : len - 1; + this.randomAccessFile.seek(nextEnd); + int c; + int currentLine = 0; + while (nextEnd > start) { + // 满 + if (currentLine > initReadLine) { + break; + } + + c = this.randomAccessFile.read(); + if (c == CharUtil.LF || c == CharUtil.CR) { + // FileUtil.readLine(this.randomAccessFile, this.charset, this.lineHandler); + final String line = FileUtil.readLine(this.randomAccessFile, this.charset); + if(null != line) { + stack.push(line); + } + currentLine++; + nextEnd--; + } + nextEnd--; + this.randomAccessFile.seek(nextEnd); + if (nextEnd == 0) { + // 当文件指针退至文件开始处，输出第一行 + // FileUtil.readLine(this.randomAccessFile, this.charset, this.lineHandler); + final String line = FileUtil.readLine(this.randomAccessFile, this.charset); + if(null != line) { + stack.push(line); + } + break; + } + } + + // 输出缓存栈中的内容 + while (false == stack.isEmpty()) { + this.lineHandler.handle(stack.pop()); + } + } + + // 将指针置于末尾 + try { + this.randomAccessFile.seek(len); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 检查文件有效性 + * + * @param file 文件 + */ + private static void checkFile(File file) { + if (false == file.exists()) { + throw new UtilException("File [{}] not exist !", file.getAbsolutePath()); + } + if (false == file.isFile()) { + throw new UtilException("Path [{}] is not a file !", file.getAbsolutePath()); + } + } + // ---------------------------------------------------------------------------------------- Private method end + + /** + * 命令行打印的行处理器 + * + * @author looly + * @since 4.5.2 + */ + public static class ConsoleLineHandler implements LineHandler { + @Override + public void handle(String line) { + Console.log(line); + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/package-info.java new file mode 100644 index 0000000..49b9d36 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/package-info.java @@ -0,0 +1,7 @@ +/** + * 对文件读写的封装，包括文件拷贝、文件读取、文件写出、行处理等 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.io.file; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/visitor/CopyVisitor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/visitor/CopyVisitor.java new file mode 100644 index 0000000..52b4bd4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/visitor/CopyVisitor.java @@ -0,0 +1,103 @@ +package aiyh.utils.tool.cn.hutool.core.io.file.visitor; + +import aiyh.utils.tool.cn.hutool.core.io.file.PathUtil; + +import java.io.IOException; +import java.nio.file.CopyOption; +import java.nio.file.FileAlreadyExistsException; +import java.nio.file.FileVisitResult; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.SimpleFileVisitor; +import java.nio.file.attribute.BasicFileAttributes; + +/** + * 文件拷贝的FileVisitor实现，用于递归遍历拷贝目录，此类非线程安全
+ * 此类在遍历源目录并复制过程中会自动创建目标目录中不存在的上级目录。 + * + * @author looly + * @since 5.5.1 + */ +public class CopyVisitor extends SimpleFileVisitor { + + /** + * 源Path，或基准路径，用于计算被拷贝文件的相对路径 + */ + private final Path source; + private final Path target; + private final CopyOption[] copyOptions; + + /** + * 标记目标目录是否创建，省略每次判断目标是否存在 + */ + private boolean isTargetCreated; + + /** + * 构造 + * + * @param source 源Path，或基准路径，用于计算被拷贝文件的相对路径 + * @param target 目标Path + * @param copyOptions 拷贝选项，如跳过已存在等 + */ + public CopyVisitor(Path source, Path target, CopyOption... copyOptions) { + if (PathUtil.exists(target, false) && false == PathUtil.isDirectory(target)) { + throw new IllegalArgumentException("Target must be a directory"); + } + this.source = source; + this.target = target; + this.copyOptions = copyOptions; + } + + @Override + public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException { + initTargetDir(); + // 将当前目录相对于源路径转换为相对于目标路径 + final Path targetDir = resolveTarget(dir); + + // 在目录不存在的情况下，copy方法会创建新目录 + try { + Files.copy(dir, targetDir, copyOptions); + } catch (FileAlreadyExistsException e) { + if (false == Files.isDirectory(targetDir)) { + // 目标文件存在抛出异常，目录忽略 + throw e; + } + } + return FileVisitResult.CONTINUE; + } + + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) + throws IOException { + initTargetDir(); + // 如果目标存在，无论目录还是文件都抛出FileAlreadyExistsException异常，此处不做特别处理 + Files.copy(file, resolveTarget(file), copyOptions); + return FileVisitResult.CONTINUE; + } + + /** + * 根据源文件或目录路径，拼接生成目标的文件或目录路径
+ * 原理是首先截取源路径，得到相对路径，再和目标路径拼接 + * + *

+ * 如：源路径是 /opt/test/，需要拷贝的文件是 /opt/test/a/a.txt，得到相对路径 a/a.txt
+ * 目标路径是/home/，则得到最终目标路径是 /home/a/a.txt + *

+ * + * @param file 需要拷贝的文件或目录Path + * @return 目标Path + */ + private Path resolveTarget(Path file) { + return target.resolve(source.relativize(file)); + } + + /** + * 初始化目标文件或目录 + */ + private void initTargetDir() { + if (false == this.isTargetCreated) { + PathUtil.mkdir(this.target); + this.isTargetCreated = true; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/visitor/DelVisitor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/visitor/DelVisitor.java new file mode 100644 index 0000000..a842dca --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/visitor/DelVisitor.java @@ -0,0 +1,44 @@ +package aiyh.utils.tool.cn.hutool.core.io.file.visitor; + +import java.io.IOException; +import java.nio.file.FileVisitResult; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.SimpleFileVisitor; +import java.nio.file.attribute.BasicFileAttributes; + +/** + * 删除操作的FileVisitor实现，用于递归遍历删除文件夹 + * + * @author looly + * @since 5.5.1 + */ +public class DelVisitor extends SimpleFileVisitor { + + public static DelVisitor INSTANCE = new DelVisitor(); + + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException { + Files.delete(file); + return FileVisitResult.CONTINUE; + } + + /** + * 访问目录结束后删除目录，当执行此方法时，子文件或目录都已访问（删除）完毕
+ * 理论上当执行到此方法时，目录下已经被清空了 + * + * @param dir 目录 + * @param e 异常 + * @return {@link FileVisitResult} + * @throws IOException IO异常 + */ + @Override + public FileVisitResult postVisitDirectory(Path dir, IOException e) throws IOException { + if (e == null) { + Files.delete(dir); + return FileVisitResult.CONTINUE; + } else { + throw e; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/visitor/MoveVisitor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/visitor/MoveVisitor.java new file mode 100755 index 0000000..196d501 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/visitor/MoveVisitor.java @@ -0,0 +1,75 @@ +package aiyh.utils.tool.cn.hutool.core.io.file.visitor; + +import aiyh.utils.tool.cn.hutool.core.io.file.PathUtil; + +import java.io.IOException; +import java.nio.file.CopyOption; +import java.nio.file.FileAlreadyExistsException; +import java.nio.file.FileVisitResult; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.SimpleFileVisitor; +import java.nio.file.attribute.BasicFileAttributes; + +/** + * 文件移动操作的FileVisitor实现，用于递归遍历移动目录和文件，此类非线程安全
+ * 此类在遍历源目录并移动过程中会自动创建目标目录中不存在的上级目录。 + * + * @author looly + * @since 5.7.7 + */ +public class MoveVisitor extends SimpleFileVisitor { + + private final Path source; + private final Path target; + private boolean isTargetCreated; + private final CopyOption[] copyOptions; + + /** + * 构造 + * + * @param source 源Path + * @param target 目标Path + * @param copyOptions 拷贝（移动）选项 + */ + public MoveVisitor(Path source, Path target, CopyOption... copyOptions) { + if(PathUtil.exists(target, false) && false == PathUtil.isDirectory(target)){ + throw new IllegalArgumentException("Target must be a directory"); + } + this.source = source; + this.target = target; + this.copyOptions = copyOptions; + } + + @Override + public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) + throws IOException { + initTarget(); + // 将当前目录相对于源路径转换为相对于目标路径 + final Path targetDir = target.resolve(source.relativize(dir)); + if(false == Files.exists(targetDir)){ + Files.createDirectories(targetDir); + } else if(false == Files.isDirectory(targetDir)){ + throw new FileAlreadyExistsException(targetDir.toString()); + } + return FileVisitResult.CONTINUE; + } + + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) + throws IOException { + initTarget(); + Files.move(file, target.resolve(source.relativize(file)), copyOptions); + return FileVisitResult.CONTINUE; + } + + /** + * 初始化目标文件或目录 + */ + private void initTarget(){ + if(false == this.isTargetCreated){ + PathUtil.mkdir(this.target); + this.isTargetCreated = true; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/visitor/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/visitor/package-info.java new file mode 100644 index 0000000..b726695 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/file/visitor/package-info.java @@ -0,0 +1,7 @@ +/** + * FileVisitor功能性实现，包括递归删除、拷贝等 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.io.file.visitor; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/package-info.java new file mode 100644 index 0000000..3a00143 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/package-info.java @@ -0,0 +1,7 @@ +/** + * IO相关封装和工具类，包括Inputstream和OutputStream实现类，工具包括流工具IoUtil、文件工具FileUtil和Buffer工具BufferUtil + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.io; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/BytesResource.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/BytesResource.java new file mode 100644 index 0000000..bab2368 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/BytesResource.java @@ -0,0 +1,70 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.ByteArrayInputStream; +import java.io.InputStream; +import java.io.Serializable; +import java.net.URL; +import java.nio.charset.Charset; + +/** + * 基于byte[]的资源获取器
+ * 注意：此对象中getUrl方法始终返回null + * + * @author looly + * @since 4.0.9 + */ +public class BytesResource implements Resource, Serializable { + private static final long serialVersionUID = 1L; + + private final byte[] bytes; + private final String name; + + /** + * 构造 + * + * @param bytes 字节数组 + */ + public BytesResource(byte[] bytes) { + this(bytes, null); + } + + /** + * 构造 + * + * @param bytes 字节数组 + * @param name 资源名称 + */ + public BytesResource(byte[] bytes, String name) { + this.bytes = bytes; + this.name = name; + } + + @Override + public String getName() { + return this.name; + } + + @Override + public URL getUrl() { + return null; + } + + @Override + public InputStream getStream() { + return new ByteArrayInputStream(this.bytes); + } + + @Override + public String readStr(Charset charset) throws IORuntimeException { + return StrUtil.str(this.bytes, charset); + } + + @Override + public byte[] readBytes() throws IORuntimeException { + return this.bytes; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/CharSequenceResource.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/CharSequenceResource.java new file mode 100644 index 0000000..90ae171 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/CharSequenceResource.java @@ -0,0 +1,91 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.BufferedReader; +import java.io.ByteArrayInputStream; +import java.io.InputStream; +import java.io.Serializable; +import java.io.StringReader; +import java.net.URL; +import java.nio.charset.Charset; + +/** + * {@link CharSequence}资源，字符串做为资源 + * + * @author looly + * @since 5.5.2 + */ +public class CharSequenceResource implements Resource, Serializable { + private static final long serialVersionUID = 1L; + + private final CharSequence data; + private final CharSequence name; + private final Charset charset; + + /** + * 构造，使用UTF8编码 + * + * @param data 资源数据 + */ + public CharSequenceResource(CharSequence data) { + this(data, null); + } + + /** + * 构造，使用UTF8编码 + * + * @param data 资源数据 + * @param name 资源名称 + */ + public CharSequenceResource(CharSequence data, String name) { + this(data, name, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 构造 + * + * @param data 资源数据 + * @param name 资源名称 + * @param charset 编码 + */ + public CharSequenceResource(CharSequence data, CharSequence name, Charset charset) { + this.data = data; + this.name = name; + this.charset = charset; + } + + @Override + public String getName() { + return StrUtil.str(this.name); + } + + @Override + public URL getUrl() { + return null; + } + + @Override + public InputStream getStream() { + return new ByteArrayInputStream(readBytes()); + } + + @Override + public BufferedReader getReader(Charset charset) { + return IoUtil.getReader(new StringReader(this.data.toString())); + } + + @Override + public String readStr(Charset charset) throws IORuntimeException { + return this.data.toString(); + } + + @Override + public byte[] readBytes() throws IORuntimeException { + return this.data.toString().getBytes(this.charset); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/ClassPathResource.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/ClassPathResource.java new file mode 100644 index 0000000..e233e88 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/ClassPathResource.java @@ -0,0 +1,145 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; + +import java.net.URL; + +/** + * ClassPath单一资源访问类
+ * 传入路径path必须为相对路径，如果传入绝对路径，Linux路径会去掉开头的“/”，而Windows路径会直接报错。
+ * 传入的path所指向的资源必须存在，否则报错 + * + * @author Looly + * + */ +public class ClassPathResource extends UrlResource { + private static final long serialVersionUID = 1L; + + private final String path; + private final ClassLoader classLoader; + private final Class clazz; + + // -------------------------------------------------------------------------------------- Constructor start + /** + * 构造 + * + * @param path 相对于ClassPath的路径 + */ + public ClassPathResource(String path) { + this(path, null, null); + } + + /** + * 构造 + * + * @param path 相对于ClassPath的路径 + * @param classLoader {@link ClassLoader} + */ + public ClassPathResource(String path, ClassLoader classLoader) { + this(path, classLoader, null); + } + + /** + * 构造 + * + * @param path 相对于给定Class的路径 + * @param clazz {@link Class} 用于定位路径 + */ + public ClassPathResource(String path, Class clazz) { + this(path, null, clazz); + } + + /** + * 构造 + * + * @param pathBaseClassLoader 相对路径 + * @param classLoader {@link ClassLoader} + * @param clazz {@link Class} 用于定位路径 + */ + public ClassPathResource(String pathBaseClassLoader, ClassLoader classLoader, Class clazz) { + super((URL) null); + Assert.notNull(pathBaseClassLoader, "Path must not be null"); + + final String path = normalizePath(pathBaseClassLoader); + this.path = path; + this.name = StrUtil.isBlank(path) ? null : FileUtil.getName(path); + + this.classLoader = ObjectUtil.defaultIfNull(classLoader, ClassUtil::getClassLoader); + this.clazz = clazz; + initUrl(); + } + // -------------------------------------------------------------------------------------- Constructor end + + /** + * 获得Path + * + * @return path + */ + public final String getPath() { + return this.path; + } + + /** + * 获得绝对路径Path
+ * 对于不存在的资源，返回拼接后的绝对路径 + * + * @return 绝对路径path + */ + public final String getAbsolutePath() { + if (FileUtil.isAbsolutePath(this.path)) { + return this.path; + } + // url在初始化的时候已经断言，此处始终不为null + return FileUtil.normalize(URLUtil.getDecodedPath(this.url)); + } + + /** + * 获得 {@link ClassLoader} + * + * @return {@link ClassLoader} + */ + public final ClassLoader getClassLoader() { + return this.classLoader; + } + + /** + * 根据给定资源初始化URL + */ + private void initUrl() { + if (null != this.clazz) { + super.url = this.clazz.getResource(this.path); + } else if (null != this.classLoader) { + super.url = this.classLoader.getResource(this.path); + } else { + super.url = ClassLoader.getSystemResource(this.path); + } + if (null == super.url) { + throw new NoResourceException("Resource of path [{}] not exist!", this.path); + } + } + + @Override + public String toString() { + return (null == this.path) ? super.toString() : "classpath:" + this.path; + } + + /** + * 标准化Path格式 + * + * @param path Path + * @return 标准化后的path + */ + private String normalizePath(String path) { + // 标准化路径 + path = FileUtil.normalize(path); + path = StrUtil.removePrefix(path, StrUtil.SLASH); + + Assert.isFalse(FileUtil.isAbsolutePath(path), "Path [{}] must be a relative path !", path); + return path; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/FileObjectResource.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/FileObjectResource.java new file mode 100644 index 0000000..77e785d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/FileObjectResource.java @@ -0,0 +1,73 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; + +import javax.tools.FileObject; +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.net.MalformedURLException; +import java.net.URL; +import java.nio.charset.Charset; + +/** + * {@link FileObject} 资源包装 + * + * @author looly + * @since 5.5.2 + */ +public class FileObjectResource implements Resource { + + private final FileObject fileObject; + + /** + * 构造 + * + * @param fileObject {@link FileObject} + */ + public FileObjectResource(FileObject fileObject) { + this.fileObject = fileObject; + } + + /** + * 获取原始的{@link FileObject} + * + * @return {@link FileObject} + */ + public FileObject getFileObject() { + return this.fileObject; + } + + @Override + public String getName() { + return this.fileObject.getName(); + } + + @Override + public URL getUrl() { + try { + return this.fileObject.toUri().toURL(); + } catch (MalformedURLException e) { + return null; + } + } + + @Override + public InputStream getStream() { + try { + return this.fileObject.openInputStream(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + @Override + public BufferedReader getReader(Charset charset) { + try { + return IoUtil.getReader(this.fileObject.openReader(false)); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/FileResource.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/FileResource.java new file mode 100644 index 0000000..a5c8f48 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/FileResource.java @@ -0,0 +1,107 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; + +import java.io.File; +import java.io.InputStream; +import java.io.Serializable; +import java.net.URL; +import java.nio.file.Path; + +/** + * 文件资源访问对象，支持{@link Path} 和 {@link File} 访问 + * + * @author looly + */ +public class FileResource implements Resource, Serializable { + private static final long serialVersionUID = 1L; + + private final File file; + private final long lastModified; + private final String name; + + // ----------------------------------------------------------------------- Constructor start + /** + * 构造 + * + * @param path 文件绝对路径或相对ClassPath路径，但是这个路径不能指向一个jar包中的文件 + */ + public FileResource(String path) { + this(FileUtil.file(path)); + } + + /** + * 构造，文件名使用文件本身的名字，带扩展名 + * + * @param path 文件 + * @since 4.4.1 + */ + public FileResource(Path path) { + this(path.toFile()); + } + + /** + * 构造，文件名使用文件本身的名字，带扩展名 + * + * @param file 文件 + */ + public FileResource(File file) { + this(file, null); + } + + /** + * 构造 + * + * @param file 文件 + * @param fileName 文件名，带扩展名，如果为null获取文件本身的文件名 + */ + public FileResource(File file, String fileName) { + Assert.notNull(file, "File must be not null !"); + this.file = file; + this.lastModified = file.lastModified(); + this.name = ObjectUtil.defaultIfNull(fileName, file::getName); + } + + // ----------------------------------------------------------------------- Constructor end + + @Override + public String getName() { + return this.name; + } + + @Override + public URL getUrl(){ + return URLUtil.getURL(this.file); + } + + @Override + public InputStream getStream() throws NoResourceException { + return FileUtil.getInputStream(this.file); + } + + /** + * 获取文件 + * + * @return 文件 + */ + public File getFile() { + return this.file; + } + + @Override + public boolean isModified() { + return this.lastModified != file.lastModified(); + } + + /** + * 返回路径 + * @return 返回URL路径 + */ + @Override + public String toString() { + return this.file.toString(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/InputStreamResource.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/InputStreamResource.java new file mode 100644 index 0000000..2bc6bc1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/InputStreamResource.java @@ -0,0 +1,54 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import java.io.InputStream; +import java.io.Serializable; +import java.net.URL; + +/** + * 基于{@link InputStream}的资源获取器
+ * 注意：此对象中getUrl方法始终返回null + * + * @author looly + * @since 4.0.9 + */ +public class InputStreamResource implements Resource, Serializable { + private static final long serialVersionUID = 1L; + + private final InputStream in; + private final String name; + + /** + * 构造 + * + * @param in {@link InputStream} + */ + public InputStreamResource(InputStream in) { + this(in, null); + } + + /** + * 构造 + * + * @param in {@link InputStream} + * @param name 资源名称 + */ + public InputStreamResource(InputStream in, String name) { + this.in = in; + this.name = name; + } + + @Override + public String getName() { + return this.name; + } + + @Override + public URL getUrl() { + return null; + } + + @Override + public InputStream getStream() { + return this.in; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/MultiFileResource.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/MultiFileResource.java new file mode 100644 index 0000000..f826516 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/MultiFileResource.java @@ -0,0 +1,64 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import java.io.File; +import java.util.Collection; + +/** + * 多文件组合资源
+ * 此资源为一个利用游标自循环资源，只有调用{@link #next()} 方法才会获取下一个资源，使用完毕后调用{@link #reset()}方法重置游标 + * + * @author looly + * + */ +public class MultiFileResource extends MultiResource{ + private static final long serialVersionUID = 1L; + + /** + * 构造 + * + * @param files 文件资源列表 + */ + public MultiFileResource(Collection files) { + add(files); + } + + /** + * 构造 + * + * @param files 文件资源列表 + */ + public MultiFileResource(File... files) { + add(files); + } + + /** + * 增加文件资源 + * + * @param files 文件资源 + * @return this + */ + public MultiFileResource add(File... files) { + for (File file : files) { + this.add(new FileResource(file)); + } + return this; + } + + /** + * 增加文件资源 + * + * @param files 文件资源 + * @return this + */ + public MultiFileResource add(Collection files) { + for (File file : files) { + this.add(new FileResource(file)); + } + return this; + } + + @Override + public MultiFileResource add(Resource resource) { + return (MultiFileResource)super.add(resource); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/MultiResource.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/MultiResource.java new file mode 100644 index 0000000..ae6d947 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/MultiResource.java @@ -0,0 +1,132 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; + +import java.io.BufferedReader; +import java.io.InputStream; +import java.io.Serializable; +import java.net.URL; +import java.nio.charset.Charset; +import java.util.Collection; +import java.util.ConcurrentModificationException; +import java.util.Iterator; +import java.util.List; + +/** + * 多资源组合资源
+ * 此资源为一个利用游标自循环资源，只有调用{@link #next()} 方法才会获取下一个资源，使用完毕后调用{@link #reset()}方法重置游标 + * + * @author looly + * @since 4.1.0 + */ +public class MultiResource implements Resource, Iterable, Iterator, Serializable { + private static final long serialVersionUID = 1L; + + private final List resources; + private int cursor; + + /** + * 构造 + * + * @param resources 资源数组 + */ + public MultiResource(Resource... resources) { + this(CollUtil.newArrayList(resources)); + } + + /** + * 构造 + * + * @param resources 资源列表 + */ + public MultiResource(Collection resources) { + if(resources instanceof List) { + this.resources = (List)resources; + }else { + this.resources = CollUtil.newArrayList(resources); + } + } + + @Override + public String getName() { + return resources.get(cursor).getName(); + } + + @Override + public URL getUrl() { + return resources.get(cursor).getUrl(); + } + + @Override + public InputStream getStream() { + return resources.get(cursor).getStream(); + } + + @Override + public boolean isModified() { + return resources.get(cursor).isModified(); + } + + @Override + public BufferedReader getReader(Charset charset) { + return resources.get(cursor).getReader(charset); + } + + @Override + public String readStr(Charset charset) throws IORuntimeException { + return resources.get(cursor).readStr(charset); + } + + @Override + public String readUtf8Str() throws IORuntimeException { + return resources.get(cursor).readUtf8Str(); + } + + @Override + public byte[] readBytes() throws IORuntimeException { + return resources.get(cursor).readBytes(); + } + + @Override + public Iterator iterator() { + return resources.iterator(); + } + + @Override + public boolean hasNext() { + return cursor < resources.size(); + } + + @Override + public synchronized Resource next() { + if (cursor >= resources.size()) { + throw new ConcurrentModificationException(); + } + this.cursor++; + return this; + } + + @Override + public void remove() { + this.resources.remove(this.cursor); + } + + /** + * 重置游标 + */ + public synchronized void reset() { + this.cursor = 0; + } + + /** + * 增加资源 + * @param resource 资源 + * @return this + */ + public MultiResource add(Resource resource) { + this.resources.add(resource); + return this; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/NoResourceException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/NoResourceException.java new file mode 100644 index 0000000..ed3e72b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/NoResourceException.java @@ -0,0 +1,47 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import aiyh.utils.tool.cn.hutool.core.exceptions.ExceptionUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 资源文件或资源不存在异常 + * + * @author xiaoleilu + * @since 4.0.2 + */ +public class NoResourceException extends IORuntimeException { + private static final long serialVersionUID = -623254467603299129L; + + public NoResourceException(Throwable e) { + super(ExceptionUtil.getMessage(e), e); + } + + public NoResourceException(String message) { + super(message); + } + + public NoResourceException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public NoResourceException(String message, Throwable throwable) { + super(message, throwable); + } + + public NoResourceException(Throwable throwable, String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params), throwable); + } + + /** + * 导致这个异常的异常是否是指定类型的异常 + * + * @param clazz 异常类 + * @return 是否为指定类型异常 + */ + @Override + public boolean causeInstanceOf(Class clazz) { + final Throwable cause = this.getCause(); + return clazz.isInstance(cause); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/Resource.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/Resource.java new file mode 100644 index 0000000..cb3fcc0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/Resource.java @@ -0,0 +1,125 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.net.URL; +import java.nio.charset.Charset; + +/** + * 资源接口定义
+ *

资源是数据表示的统称，我们可以将任意的数据封装为一个资源，然后读取其内容。

+ *

资源可以是文件、URL、ClassPath中的文件亦或者jar(zip)包中的文件。

+ *

+ * 提供资源接口的意义在于，我们可以使用一个方法接收任意类型的数据，从而处理数据， + * 无需专门针对File、InputStream等写多个重载方法，同时也为更好的扩展提供了可能。 + *

+ *

使用非常简单，假设我们需要从classpath中读取一个xml，我们不用关心这个文件在目录中还是在jar中：

+ * 
+ *     Resource resource = new ClassPathResource("test.xml");
+ *     String xmlStr = resource.readUtf8Str();
+ *
+ *

同样，我们可以自己实现Resource接口，按照业务需要从任意位置读取数据，比如从数据库中。

+ * + * @author looly + * @since 3.2.1 + */ +public interface Resource { + + /** + * 获取资源名，例如文件资源的资源名为文件名 + * + * @return 资源名 + * @since 4.0.13 + */ + String getName(); + + /** + * 获得解析后的{@link URL}，无对应URL的返回{@code null} + * + * @return 解析后的{@link URL} + */ + URL getUrl(); + + /** + * 获得 {@link InputStream} + * + * @return {@link InputStream} + */ + InputStream getStream(); + + /** + * 检查资源是否变更
+ * 一般用于文件类资源，检查文件是否被修改过。 + * + * @return 是否变更 + * @since 5.7.21 + */ + default boolean isModified(){ + return false; + } + + /** + * 将资源内容写出到流，不关闭输出流，但是关闭资源流 + * + * @param out 输出流 + * @throws IORuntimeException IO异常 + * @since 5.3.5 + */ + default void writeTo(OutputStream out) throws IORuntimeException { + try (InputStream in = getStream()) { + IoUtil.copy(in, out); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 获得Reader + * + * @param charset 编码 + * @return {@link BufferedReader} + */ + default BufferedReader getReader(Charset charset) { + return IoUtil.getReader(getStream(), charset); + } + + /** + * 读取资源内容，读取完毕后会关闭流
+ * 关闭流并不影响下一次读取 + * + * @param charset 编码 + * @return 读取资源内容 + * @throws IORuntimeException 包装{@link IOException} + */ + default String readStr(Charset charset) throws IORuntimeException { + return IoUtil.read(getReader(charset)); + } + + /** + * 读取资源内容，读取完毕后会关闭流
+ * 关闭流并不影响下一次读取 + * + * @return 读取资源内容 + * @throws IORuntimeException 包装IOException + */ + default String readUtf8Str() throws IORuntimeException { + return readStr(CharsetUtil.CHARSET_UTF_8); + } + + /** + * 读取资源内容，读取完毕后会关闭流
+ * 关闭流并不影响下一次读取 + * + * @return 读取资源内容 + * @throws IORuntimeException 包装IOException + */ + default byte[] readBytes() throws IORuntimeException { + return IoUtil.readBytes(getStream()); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/ResourceUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/ResourceUtil.java new file mode 100755 index 0000000..1d0622d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/ResourceUtil.java @@ -0,0 +1,232 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import aiyh.utils.tool.cn.hutool.core.collection.EnumerationIter; +import aiyh.utils.tool.cn.hutool.core.collection.IterUtil; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.lang.Filter; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.ClassLoaderUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.net.URL; +import java.nio.charset.Charset; +import java.util.Enumeration; +import java.util.List; + +/** + * Resource资源工具类 + * + * @author Looly + */ +public class ResourceUtil { + + /** + * 读取Classpath下的资源为字符串，使用UTF-8编码 + * + * @param resource 资源路径，使用相对ClassPath的路径 + * @return 资源内容 + * @since 3.1.1 + */ + public static String readUtf8Str(String resource) { + return getResourceObj(resource).readUtf8Str(); + } + + /** + * 读取Classpath下的资源为字符串 + * + * @param resource 可以是绝对路径，也可以是相对路径（相对ClassPath） + * @param charset 编码 + * @return 资源内容 + * @since 3.1.1 + */ + public static String readStr(String resource, Charset charset) { + return getResourceObj(resource).readStr(charset); + } + + /** + * 读取Classpath下的资源为byte[] + * + * @param resource 可以是绝对路径，也可以是相对路径（相对ClassPath） + * @return 资源内容 + * @since 4.5.19 + */ + public static byte[] readBytes(String resource) { + return getResourceObj(resource).readBytes(); + } + + /** + * 从ClassPath资源中获取{@link InputStream} + * + * @param resource ClassPath资源 + * @return {@link InputStream} + * @throws NoResourceException 资源不存在异常 + * @since 3.1.2 + */ + public static InputStream getStream(String resource) throws NoResourceException { + return getResourceObj(resource).getStream(); + } + + /** + * 从ClassPath资源中获取{@link InputStream}，当资源不存在时返回null + * + * @param resource ClassPath资源 + * @return {@link InputStream} + * @since 4.0.3 + */ + public static InputStream getStreamSafe(String resource) { + try { + return getResourceObj(resource).getStream(); + } catch (NoResourceException e) { + // ignore + } + return null; + } + + /** + * 从ClassPath资源中获取{@link BufferedReader} + * + * @param resource ClassPath资源 + * @return {@link InputStream} + * @since 5.3.6 + */ + public static BufferedReader getUtf8Reader(String resource) { + return getReader(resource, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 从ClassPath资源中获取{@link BufferedReader} + * + * @param resource ClassPath资源 + * @param charset 编码 + * @return {@link InputStream} + * @since 3.1.2 + */ + public static BufferedReader getReader(String resource, Charset charset) { + return getResourceObj(resource).getReader(charset); + } + + /** + * 获得资源的URL
+ * 路径用/分隔，例如: + * + * 
+	 * config/a/db.config
+	 * spring/xml/test.xml
+	 *
+ * + * @param resource 资源（相对Classpath的路径） + * @return 资源URL + */ + public static URL getResource(String resource) throws IORuntimeException { + return getResource(resource, null); + } + + /** + * 获取指定路径下的资源列表
+ * 路径格式必须为目录格式,用/分隔，例如: + * + * 
+	 * config/a
+	 * spring/xml
+	 *
+ * + * @param resource 资源路径 + * @return 资源列表 + */ + public static List getResources(String resource) { + return getResources(resource, null); + } + + /** + * 获取指定路径下的资源列表
+ * 路径格式必须为目录格式,用/分隔，例如: + * + * 
+	 * config/a
+	 * spring/xml
+	 *
+ * + * @param resource 资源路径 + * @param filter 过滤器，用于过滤不需要的资源，{@code null}表示不过滤，保留所有元素 + * @return 资源列表 + */ + public static List getResources(String resource, Filter filter) { + return IterUtil.filterToList(getResourceIter(resource), filter); + } + + /** + * 获取指定路径下的资源Iterator
+ * 路径格式必须为目录格式,用/分隔，例如: + * + * 
+	 * config/a
+	 * spring/xml
+	 *
+ * + * @param resource 资源路径 + * @return 资源列表 + * @since 4.1.5 + */ + public static EnumerationIter getResourceIter(String resource) { + return getResourceIter(resource, null); + } + + /** + * 获取指定路径下的资源Iterator
+ * 路径格式必须为目录格式,用/分隔，例如: + * + * 
+	 * config/a
+	 * spring/xml
+	 *
+ * + * @param resource 资源路径 + * @param classLoader {@link ClassLoader} + * @return 资源列表 + * @since 4.1.5 + */ + public static EnumerationIter getResourceIter(String resource, ClassLoader classLoader) { + final Enumeration resources; + try { + resources = ObjUtil.defaultIfNull(classLoader, ClassLoaderUtil::getClassLoader).getResources(resource); + } catch (final IOException e) { + throw new IORuntimeException(e); + } + return new EnumerationIter<>(resources); + } + + /** + * 获得资源相对路径对应的URL + * + * @param resource 资源相对路径，{@code null}和""都表示classpath根路径 + * @param baseClass 基准Class，获得的相对路径相对于此Class所在路径，如果为{@code null}则相对ClassPath + * @return {@link URL} + */ + public static URL getResource(String resource, Class baseClass) { + resource = StrUtil.nullToEmpty(resource); + return (null != baseClass) ? baseClass.getResource(resource) : ClassLoaderUtil.getClassLoader().getResource(resource); + } + + /** + * 获取{@link Resource} 资源对象
+ * 如果提供路径为绝对路径或路径以file:开头，返回{@link FileResource}，否则返回{@link ClassPathResource} + * + * @param path 路径，可以是绝对路径，也可以是相对路径（相对ClassPath） + * @return {@link Resource} 资源对象 + * @since 3.2.1 + */ + public static Resource getResourceObj(String path) { + if (StrUtil.isNotBlank(path)) { + if (path.startsWith(URLUtil.FILE_URL_PREFIX) || FileUtil.isAbsolutePath(path)) { + return new FileResource(path); + } + } + return new ClassPathResource(path); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/StringResource.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/StringResource.java new file mode 100644 index 0000000..c361c9a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/StringResource.java @@ -0,0 +1,47 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; + +import java.nio.charset.Charset; + +/** + * 字符串资源，字符串做为资源 + * + * @author looly + * @since 4.1.0 + * @see CharSequenceResource + */ +public class StringResource extends CharSequenceResource { + private static final long serialVersionUID = 1L; + + + /** + * 构造，使用UTF8编码 + * + * @param data 资源数据 + */ + public StringResource(String data) { + super(data, null); + } + + /** + * 构造，使用UTF8编码 + * + * @param data 资源数据 + * @param name 资源名称 + */ + public StringResource(String data, String name) { + super(data, name, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 构造 + * + * @param data 资源数据 + * @param name 资源名称 + * @param charset 编码 + */ + public StringResource(String data, String name, Charset charset) { + super(data, name, charset); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/UrlResource.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/UrlResource.java new file mode 100755 index 0000000..45e194c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/UrlResource.java @@ -0,0 +1,107 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; + +import java.io.File; +import java.io.InputStream; +import java.io.Serializable; +import java.net.URI; +import java.net.URL; + +/** + * URL资源访问类 + * @author Looly + * + */ +public class UrlResource implements Resource, Serializable{ + private static final long serialVersionUID = 1L; + + protected URL url; + private long lastModified = 0; + protected String name; + + //-------------------------------------------------------------------------------------- Constructor start + /** + * 构造 + * @param uri URI + * @since 5.7.21 + */ + public UrlResource(URI uri) { + this(URLUtil.url(uri), null); + } + + /** + * 构造 + * @param url URL + */ + public UrlResource(URL url) { + this(url, null); + } + + /** + * 构造 + * @param url URL，允许为空 + * @param name 资源名称 + */ + public UrlResource(URL url, String name) { + this.url = url; + if(null != url && URLUtil.URL_PROTOCOL_FILE.equals(url.getProtocol())){ + this.lastModified = FileUtil.file(url).lastModified(); + } + this.name = ObjectUtil.defaultIfNull(name, () -> (null != url ? FileUtil.getName(url.getPath()) : null)); + } + + /** + * 构造 + * @param file 文件路径 + * @deprecated Please use {@link FileResource} + */ + @Deprecated + public UrlResource(File file) { + this.url = URLUtil.getURL(file); + } + //-------------------------------------------------------------------------------------- Constructor end + + @Override + public String getName() { + return this.name; + } + + @Override + public URL getUrl(){ + return this.url; + } + + @Override + public InputStream getStream() throws NoResourceException{ + if(null == this.url){ + throw new NoResourceException("Resource URL is null!"); + } + return URLUtil.getStream(url); + } + + @Override + public boolean isModified() { + // lastModified == 0表示此资源非文件资源 + return (0 != this.lastModified) && this.lastModified != getFile().lastModified(); + } + + /** + * 获得File + * @return {@link File} + */ + public File getFile(){ + return FileUtil.file(this.url); + } + + /** + * 返回路径 + * @return 返回URL路径 + */ + @Override + public String toString() { + return (null == this.url) ? "null" : this.url.toString(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/VfsResource.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/VfsResource.java new file mode 100755 index 0000000..5de10ac --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/VfsResource.java @@ -0,0 +1,107 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ClassLoaderUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; + +import java.io.InputStream; +import java.lang.reflect.Method; +import java.net.URL; + +/** + * VFS资源封装
+ * 支持VFS 3.x on JBoss AS 6+，JBoss AS 7 and WildFly 8+
+ * 参考：org.springframework.core.io.VfsUtils + * + * @author looly, Spring + * @since 5.7.21 + */ +public class VfsResource implements Resource { + private static final String VFS3_PKG = "org.jboss.vfs."; + + private static final Method VIRTUAL_FILE_METHOD_EXISTS; + private static final Method VIRTUAL_FILE_METHOD_GET_INPUT_STREAM; + private static final Method VIRTUAL_FILE_METHOD_GET_SIZE; + private static final Method VIRTUAL_FILE_METHOD_GET_LAST_MODIFIED; + private static final Method VIRTUAL_FILE_METHOD_TO_URL; + private static final Method VIRTUAL_FILE_METHOD_GET_NAME; + + static { + Class virtualFile = ClassLoaderUtil.loadClass(VFS3_PKG + "VirtualFile"); + try { + VIRTUAL_FILE_METHOD_EXISTS = virtualFile.getMethod("exists"); + VIRTUAL_FILE_METHOD_GET_INPUT_STREAM = virtualFile.getMethod("openStream"); + VIRTUAL_FILE_METHOD_GET_SIZE = virtualFile.getMethod("getSize"); + VIRTUAL_FILE_METHOD_GET_LAST_MODIFIED = virtualFile.getMethod("getLastModified"); + VIRTUAL_FILE_METHOD_TO_URL = virtualFile.getMethod("toURL"); + VIRTUAL_FILE_METHOD_GET_NAME = virtualFile.getMethod("getName"); + } catch (NoSuchMethodException ex) { + throw new IllegalStateException("Could not detect JBoss VFS infrastructure", ex); + } + } + + /** + * org.jboss.vfs.VirtualFile实例对象 + */ + private final Object virtualFile; + private final long lastModified; + + /** + * 构造 + * + * @param resource org.jboss.vfs.VirtualFile实例对象 + */ + public VfsResource(Object resource) { + Assert.notNull(resource, "VirtualFile must not be null"); + this.virtualFile = resource; + this.lastModified = getLastModified(); + } + + /** + * VFS文件是否存在 + * + * @return 文件是否存在 + */ + public boolean exists() { + return ReflectUtil.invoke(virtualFile, VIRTUAL_FILE_METHOD_EXISTS); + } + + @Override + public String getName() { + return ReflectUtil.invoke(virtualFile, VIRTUAL_FILE_METHOD_GET_NAME); + } + + @Override + public URL getUrl() { + return ReflectUtil.invoke(virtualFile, VIRTUAL_FILE_METHOD_TO_URL); + } + + @Override + public InputStream getStream() { + return ReflectUtil.invoke(virtualFile, VIRTUAL_FILE_METHOD_GET_INPUT_STREAM); + } + + @Override + public boolean isModified() { + return this.lastModified != getLastModified(); + } + + /** + * 获得VFS文件最后修改时间 + * + * @return 最后修改时间 + */ + public long getLastModified() { + return ReflectUtil.invoke(virtualFile, VIRTUAL_FILE_METHOD_GET_LAST_MODIFIED); + } + + /** + * 获取VFS文件大小 + * + * @return VFS文件大小 + */ + public long size() { + return ReflectUtil.invoke(virtualFile, VIRTUAL_FILE_METHOD_GET_SIZE); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/WebAppResource.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/WebAppResource.java new file mode 100644 index 0000000..08a9cb2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/WebAppResource.java @@ -0,0 +1,25 @@ +package aiyh.utils.tool.cn.hutool.core.io.resource; + +import java.io.File; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; + +/** + * Web root资源访问对象 + * + * @author looly + * @since 4.1.11 + */ +public class WebAppResource extends FileResource { + private static final long serialVersionUID = 1L; + + /** + * 构造 + * + * @param path 相对于Web root的路径 + */ + public WebAppResource(String path) { + super(new File(FileUtil.getWebRoot(), path)); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/package-info.java new file mode 100644 index 0000000..bf7c487 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/resource/package-info.java @@ -0,0 +1,7 @@ +/** + * 针对ClassPath和文件中资源读取的封装，主要入口为工具类ResourceUtil + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.io.resource; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/unit/DataSize.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/unit/DataSize.java new file mode 100644 index 0000000..3b89dac --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/unit/DataSize.java @@ -0,0 +1,292 @@ +package aiyh.utils.tool.cn.hutool.core.io.unit; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.math.BigDecimal; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * 数据大小，可以将类似于'12MB'表示转换为bytes长度的数字 + *

+ * 此类来自于：Spring-framework + * + * 

+ *     byte        1B     1
+ *     kilobyte    1KB    1,024
+ *     megabyte    1MB    1,048,576
+ *     gigabyte    1GB    1,073,741,824
+ *     terabyte    1TB    1,099,511,627,776
+ *
+ * + * @author Sam Brannen,Stephane Nicoll + * @since 5.3.10 + */ +public final class DataSize implements Comparable { + + /** + * The pattern for parsing. + */ + private static final Pattern PATTERN = Pattern.compile("^([+-]?\\d+(\\.\\d+)?)([a-zA-Z]{0,2})$"); + + /** + * Bytes per Kilobyte(KB). + */ + private static final long BYTES_PER_KB = 1024; + + /** + * Bytes per Megabyte(MB). + */ + private static final long BYTES_PER_MB = BYTES_PER_KB * 1024; + + /** + * Bytes per Gigabyte(GB). + */ + private static final long BYTES_PER_GB = BYTES_PER_MB * 1024; + + /** + * Bytes per Terabyte(TB). + */ + private static final long BYTES_PER_TB = BYTES_PER_GB * 1024; + + + /** + * bytes长度 + */ + private final long bytes; + + + /** + * 构造 + * + * @param bytes 长度 + */ + private DataSize(long bytes) { + this.bytes = bytes; + } + + + /** + * 获得对应bytes的DataSize + * + * @param bytes bytes大小，可正可负 + * @return this + */ + public static DataSize ofBytes(long bytes) { + return new DataSize(bytes); + } + + /** + * 获得对应kilobytes的DataSize + * + * @param kilobytes kilobytes大小，可正可负 + * @return a DataSize + */ + public static DataSize ofKilobytes(long kilobytes) { + return new DataSize(Math.multiplyExact(kilobytes, BYTES_PER_KB)); + } + + /** + * 获得对应megabytes的DataSize + * + * @param megabytes megabytes大小，可正可负 + * @return a DataSize + */ + public static DataSize ofMegabytes(long megabytes) { + return new DataSize(Math.multiplyExact(megabytes, BYTES_PER_MB)); + } + + /** + * 获得对应gigabytes的DataSize + * + * @param gigabytes gigabytes大小，可正可负 + * @return a DataSize + */ + public static DataSize ofGigabytes(long gigabytes) { + return new DataSize(Math.multiplyExact(gigabytes, BYTES_PER_GB)); + } + + /** + * 获得对应terabytes的DataSize + * + * @param terabytes terabytes大小，可正可负 + * @return a DataSize + */ + public static DataSize ofTerabytes(long terabytes) { + return new DataSize(Math.multiplyExact(terabytes, BYTES_PER_TB)); + } + + /** + * 获得指定{@link DataUnit}对应的DataSize + * + * @param amount 大小 + * @param unit 数据大小单位，null表示默认的BYTES + * @return DataSize + */ + public static DataSize of(long amount, DataUnit unit) { + if(null == unit){ + unit = DataUnit.BYTES; + } + return new DataSize(Math.multiplyExact(amount, unit.size().toBytes())); + } + + /** + * 获得指定{@link DataUnit}对应的DataSize + * + * @param amount 大小 + * @param unit 数据大小单位，null表示默认的BYTES + * @return DataSize + * @since 5.4.5 + */ + public static DataSize of(BigDecimal amount, DataUnit unit) { + if(null == unit){ + unit = DataUnit.BYTES; + } + return new DataSize(amount.multiply(new BigDecimal(unit.size().toBytes())).longValue()); + } + + /** + * 获取指定数据大小文本对应的DataSize对象，如果无单位指定，默认获取{@link DataUnit#BYTES} + *

+ * 例如： + * 

+	 * "12KB" -- parses as "12 kilobytes"
+	 * "5MB"  -- parses as "5 megabytes"
+	 * "20"   -- parses as "20 bytes"
+	 *
+ * + * @param text the text to parse + * @return the parsed DataSize + * @see #parse(CharSequence, DataUnit) + */ + public static DataSize parse(CharSequence text) { + return parse(text, null); + } + + /** + * Obtain a DataSize from a text string such as {@code 12MB} using + * the specified default {@link DataUnit} if no unit is specified. + *

+ * The string starts with a number followed optionally by a unit matching one of the + * supported {@linkplain DataUnit suffixes}. + *

+ * Examples: + * 

+	 * "12KB" -- parses as "12 kilobytes"
+	 * "5MB"  -- parses as "5 megabytes"
+	 * "20"   -- parses as "20 kilobytes" (where the {@code defaultUnit} is {@link DataUnit#KILOBYTES})
+	 *
+ * + * @param text the text to parse + * @param defaultUnit 默认的数据单位 + * @return the parsed DataSize + */ + public static DataSize parse(CharSequence text, DataUnit defaultUnit) { + Assert.notNull(text, "Text must not be null"); + try { + final Matcher matcher = PATTERN.matcher(text); + Assert.state(matcher.matches(), "Does not match data size pattern"); + + final DataUnit unit = determineDataUnit(matcher.group(3), defaultUnit); + return DataSize.of(new BigDecimal(matcher.group(1)), unit); + } catch (Exception ex) { + throw new IllegalArgumentException("'" + text + "' is not a valid data size", ex); + } + } + + /** + * 决定数据单位，后缀不识别时使用默认单位 + * @param suffix 后缀 + * @param defaultUnit 默认单位 + * @return {@link DataUnit} + */ + private static DataUnit determineDataUnit(String suffix, DataUnit defaultUnit) { + DataUnit defaultUnitToUse = (defaultUnit != null ? defaultUnit : DataUnit.BYTES); + return (StrUtil.isNotEmpty(suffix) ? DataUnit.fromSuffix(suffix) : defaultUnitToUse); + } + + /** + * 是否为负数，不包括0 + * + * @return 负数返回true，否则false + */ + public boolean isNegative() { + return this.bytes < 0; + } + + /** + * 返回bytes大小 + * + * @return bytes大小 + */ + public long toBytes() { + return this.bytes; + } + + /** + * 返回KB大小 + * + * @return KB大小 + */ + public long toKilobytes() { + return this.bytes / BYTES_PER_KB; + } + + /** + * 返回MB大小 + * + * @return MB大小 + */ + public long toMegabytes() { + return this.bytes / BYTES_PER_MB; + } + + /** + * 返回GB大小 + * + * @return GB大小 + * + */ + public long toGigabytes() { + return this.bytes / BYTES_PER_GB; + } + + /** + * 返回TB大小 + * + * @return TB大小 + */ + public long toTerabytes() { + return this.bytes / BYTES_PER_TB; + } + + @Override + public int compareTo(DataSize other) { + return Long.compare(this.bytes, other.bytes); + } + + @Override + public String toString() { + return String.format("%dB", this.bytes); + } + + + @Override + public boolean equals(Object other) { + if (this == other) { + return true; + } + if (other == null || getClass() != other.getClass()) { + return false; + } + DataSize otherSize = (DataSize) other; + return (this.bytes == otherSize.bytes); + } + + @Override + public int hashCode() { + return Long.hashCode(this.bytes); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/unit/DataSizeUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/unit/DataSizeUtil.java new file mode 100644 index 0000000..f2a83a5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/unit/DataSizeUtil.java @@ -0,0 +1,38 @@ +package aiyh.utils.tool.cn.hutool.core.io.unit; + +import java.text.DecimalFormat; + +/** + * 数据大小工具类 + * + * @author looly + * @since 5.3.10 + */ +public class DataSizeUtil { + + /** + * 解析数据大小字符串，转换为bytes大小 + * + * @param text 数据大小字符串，类似于：12KB, 5MB等 + * @return bytes大小 + */ + public static long parse(String text) { + return DataSize.parse(text).toBytes(); + } + + /** + * 可读的文件大小
+ * 参考 http://stackoverflow.com/questions/3263892/format-file-size-as-mb-gb-etc + * + * @param size Long类型大小 + * @return 大小 + */ + public static String format(long size) { + if (size <= 0) { + return "0"; + } + int digitGroups = Math.min(DataUnit.UNIT_NAMES.length-1, (int) (Math.log10(size) / Math.log10(1024))); + return new DecimalFormat("#,##0.##") + .format(size / Math.pow(1024, digitGroups)) + " " + DataUnit.UNIT_NAMES[digitGroups]; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/unit/DataUnit.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/unit/DataUnit.java new file mode 100644 index 0000000..9add169 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/unit/DataUnit.java @@ -0,0 +1,80 @@ +package aiyh.utils.tool.cn.hutool.core.io.unit; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 数据单位封装

+ * 此类来自于：Spring-framework + * + * 

+ *     BYTES      1B      2^0     1
+ *     KILOBYTES  1KB     2^10    1,024
+ *     MEGABYTES  1MB     2^20    1,048,576
+ *     GIGABYTES  1GB     2^30    1,073,741,824
+ *     TERABYTES  1TB     2^40    1,099,511,627,776
+ *
+ * + * @author Sam Brannen，Stephane Nicoll + * @since 5.3.10 + */ +public enum DataUnit { + + /** + * Bytes, 后缀表示为： {@code B}. + */ + BYTES("B", DataSize.ofBytes(1)), + + /** + * Kilobytes, 后缀表示为： {@code KB}. + */ + KILOBYTES("KB", DataSize.ofKilobytes(1)), + + /** + * Megabytes, 后缀表示为： {@code MB}. + */ + MEGABYTES("MB", DataSize.ofMegabytes(1)), + + /** + * Gigabytes, 后缀表示为： {@code GB}. + */ + GIGABYTES("GB", DataSize.ofGigabytes(1)), + + /** + * Terabytes, 后缀表示为： {@code TB}. + */ + TERABYTES("TB", DataSize.ofTerabytes(1)); + + public static final String[] UNIT_NAMES = new String[]{"B", "KB", "MB", "GB", "TB", "PB", "EB"}; + + private final String suffix; + + private final DataSize size; + + + DataUnit(String suffix, DataSize size) { + this.suffix = suffix; + this.size = size; + } + + DataSize size() { + return this.size; + } + + /** + * 通过后缀返回对应的 DataUnit + * + * @param suffix 单位后缀 + * @return 匹配到的{@link DataUnit} + * @throws IllegalArgumentException 后缀无法识别报错 + */ + public static DataUnit fromSuffix(String suffix) { + for (DataUnit candidate : values()) { + // 支持类似于 3MB，3M，3m等写法 + if (StrUtil.startWithIgnoreCase(candidate.suffix, suffix)) { + return candidate; + } + } + throw new IllegalArgumentException("Unknown data unit suffix '" + suffix + "'"); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/unit/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/unit/package-info.java new file mode 100644 index 0000000..816c240 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/unit/package-info.java @@ -0,0 +1,7 @@ +/** + * 数据单位相关封装，包括DataUnit数据单位和DataSize数据大小 + * + * @author looly + * @since 5.3.10 + */ +package aiyh.utils.tool.cn.hutool.core.io.unit; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/SimpleWatcher.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/SimpleWatcher.java new file mode 100644 index 0000000..fef7605 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/SimpleWatcher.java @@ -0,0 +1,13 @@ +package aiyh.utils.tool.cn.hutool.core.io.watch; + +import aiyh.utils.tool.cn.hutool.core.io.watch.watchers.IgnoreWatcher; + +/** + * 空白WatchListener
+ * 用户继承此类后实现需要监听的方法 + * @author Looly + * + */ +public class SimpleWatcher extends IgnoreWatcher{ + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchAction.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchAction.java new file mode 100644 index 0000000..7dc444d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchAction.java @@ -0,0 +1,24 @@ +package aiyh.utils.tool.cn.hutool.core.io.watch; + +import java.nio.file.Path; +import java.nio.file.WatchEvent; + +/** + * 监听事件处理函数接口 + * + * @author looly + * @since 5.4.0 + */ +@FunctionalInterface +public interface WatchAction { + + /** + * 事件处理，通过实现此方法处理各种事件。 + * + * 事件可以调用 {@link WatchEvent#kind()}获取，对应事件见{@link WatchKind} + * + * @param event 事件 + * @param currentPath 事件发生的当前Path路径 + */ + void doAction(WatchEvent event, Path currentPath); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchException.java new file mode 100644 index 0000000..1f9a5c6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchException.java @@ -0,0 +1,33 @@ +package aiyh.utils.tool.cn.hutool.core.io.watch; + +import aiyh.utils.tool.cn.hutool.core.exceptions.ExceptionUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 监听异常 + * @author Looly + * + */ +public class WatchException extends RuntimeException { + private static final long serialVersionUID = 8068509879445395353L; + + public WatchException(Throwable e) { + super(ExceptionUtil.getMessage(e), e); + } + + public WatchException(String message) { + super(message); + } + + public WatchException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public WatchException(String message, Throwable throwable) { + super(message, throwable); + } + + public WatchException(Throwable throwable, String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params), throwable); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchKind.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchKind.java new file mode 100644 index 0000000..bf426f0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchKind.java @@ -0,0 +1,67 @@ +package aiyh.utils.tool.cn.hutool.core.io.watch; + +import java.nio.file.StandardWatchEventKinds; +import java.nio.file.WatchEvent; + +/** + * 监听事件类型枚举，包括： + * + * 
+ *      1. 事件丢失 OVERFLOW -》StandardWatchEventKinds.OVERFLOW
+ *      2. 修改事件 MODIFY   -》StandardWatchEventKinds.ENTRY_MODIFY
+ *      3. 创建事件 CREATE   -》StandardWatchEventKinds.ENTRY_CREATE
+ *      4. 删除事件 DELETE   -》StandardWatchEventKinds.ENTRY_DELETE
+ *
+ * + * @author loolly + * @since 5.1.0 + */ +public enum WatchKind { + + /** + * 事件丢失 + */ + OVERFLOW(StandardWatchEventKinds.OVERFLOW), + /** + * 修改事件 + */ + MODIFY(StandardWatchEventKinds.ENTRY_MODIFY), + /** + * 创建事件 + */ + CREATE(StandardWatchEventKinds.ENTRY_CREATE), + /** + * 删除事件 + */ + DELETE(StandardWatchEventKinds.ENTRY_DELETE); + + /** + * 全部事件 + */ + public static final WatchEvent.Kind[] ALL = {// + OVERFLOW.getValue(), //事件丢失 + MODIFY.getValue(), //修改 + CREATE.getValue(), //创建 + DELETE.getValue() //删除 + }; + + private final WatchEvent.Kind value; + + /** + * 构造 + * + * @param value 事件类型 + */ + WatchKind(WatchEvent.Kind value) { + this.value = value; + } + + /** + * 获取枚举对应的事件类型 + * + * @return 事件类型值 + */ + public WatchEvent.Kind getValue() { + return this.value; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchMonitor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchMonitor.java new file mode 100644 index 0000000..8561feb --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchMonitor.java @@ -0,0 +1,426 @@ +package aiyh.utils.tool.cn.hutool.core.io.watch; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.watch.watchers.WatcherChain; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; + +import java.io.File; +import java.io.IOException; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; +import java.nio.file.Files; +import java.nio.file.LinkOption; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.nio.file.WatchEvent; +import java.nio.file.WatchService; + +/** + * 路径监听器 + * + *

+ * 监听器可监听目录或文件
+ * 如果监听的Path不存在，则递归创建空目录然后监听此空目录
+ * 递归监听目录时，并不会监听新创建的目录 + * + * @author Looly + */ +public class WatchMonitor extends WatchServer { + private static final long serialVersionUID = 1L; + + /** + * 事件丢失 + */ + public static final WatchEvent.Kind OVERFLOW = WatchKind.OVERFLOW.getValue(); + /** + * 修改事件 + */ + public static final WatchEvent.Kind ENTRY_MODIFY = WatchKind.MODIFY.getValue(); + /** + * 创建事件 + */ + public static final WatchEvent.Kind ENTRY_CREATE = WatchKind.CREATE.getValue(); + /** + * 删除事件 + */ + public static final WatchEvent.Kind ENTRY_DELETE = WatchKind.DELETE.getValue(); + /** + * 全部事件 + */ + public static final WatchEvent.Kind[] EVENTS_ALL = WatchKind.ALL; + + /** + * 监听路径，必须为目录 + */ + private Path path; + /** + * 递归目录的最大深度，当小于1时不递归下层目录 + */ + private int maxDepth; + /** + * 监听的文件，对于单文件监听不为空 + */ + private Path filePath; + + /** + * 监听器 + */ + private Watcher watcher; + //------------------------------------------------------ Static method start + + /** + * 创建并初始化监听 + * + * @param url URL + * @param events 监听的事件列表 + * @return 监听对象 + */ + public static WatchMonitor create(URL url, WatchEvent.Kind... events) { + return create(url, 0, events); + } + + /** + * 创建并初始化监听 + * + * @param url URL + * @param events 监听的事件列表 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @return 监听对象 + */ + public static WatchMonitor create(URL url, int maxDepth, WatchEvent.Kind... events) { + return create(URLUtil.toURI(url), maxDepth, events); + } + + /** + * 创建并初始化监听 + * + * @param uri URI + * @param events 监听的事件列表 + * @return 监听对象 + */ + public static WatchMonitor create(URI uri, WatchEvent.Kind... events) { + return create(uri, 0, events); + } + + /** + * 创建并初始化监听 + * + * @param uri URI + * @param events 监听的事件列表 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @return 监听对象 + */ + public static WatchMonitor create(URI uri, int maxDepth, WatchEvent.Kind... events) { + return create(Paths.get(uri), maxDepth, events); + } + + /** + * 创建并初始化监听 + * + * @param file 文件 + * @param events 监听的事件列表 + * @return 监听对象 + */ + public static WatchMonitor create(File file, WatchEvent.Kind... events) { + return create(file, 0, events); + } + + /** + * 创建并初始化监听 + * + * @param file 文件 + * @param events 监听的事件列表 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @return 监听对象 + */ + public static WatchMonitor create(File file, int maxDepth, WatchEvent.Kind... events) { + return create(file.toPath(), maxDepth, events); + } + + /** + * 创建并初始化监听 + * + * @param path 路径 + * @param events 监听的事件列表 + * @return 监听对象 + */ + public static WatchMonitor create(String path, WatchEvent.Kind... events) { + return create(path, 0, events); + } + + /** + * 创建并初始化监听 + * + * @param path 路径 + * @param events 监听的事件列表 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @return 监听对象 + */ + public static WatchMonitor create(String path, int maxDepth, WatchEvent.Kind... events) { + return create(Paths.get(path), maxDepth, events); + } + + /** + * 创建并初始化监听 + * + * @param path 路径 + * @param events 监听事件列表 + * @return 监听对象 + */ + public static WatchMonitor create(Path path, WatchEvent.Kind... events) { + return create(path, 0, events); + } + + /** + * 创建并初始化监听 + * + * @param path 路径 + * @param events 监听事件列表 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @return 监听对象 + */ + public static WatchMonitor create(Path path, int maxDepth, WatchEvent.Kind... events) { + return new WatchMonitor(path, maxDepth, events); + } + + //--------- createAll + + /** + * 创建并初始化监听，监听所有事件 + * + * @param uri URI + * @param watcher {@link Watcher} + * @return WatchMonitor + */ + public static WatchMonitor createAll(URI uri, Watcher watcher) { + return createAll(Paths.get(uri), watcher); + } + + /** + * 创建并初始化监听，监听所有事件 + * + * @param url URL + * @param watcher {@link Watcher} + * @return WatchMonitor + */ + public static WatchMonitor createAll(URL url, Watcher watcher) { + try { + return createAll(Paths.get(url.toURI()), watcher); + } catch (URISyntaxException e) { + throw new WatchException(e); + } + } + + /** + * 创建并初始化监听，监听所有事件 + * + * @param file 被监听文件 + * @param watcher {@link Watcher} + * @return WatchMonitor + */ + public static WatchMonitor createAll(File file, Watcher watcher) { + return createAll(file.toPath(), watcher); + } + + /** + * 创建并初始化监听，监听所有事件 + * + * @param path 路径 + * @param watcher {@link Watcher} + * @return WatchMonitor + */ + public static WatchMonitor createAll(String path, Watcher watcher) { + return createAll(Paths.get(path), watcher); + } + + /** + * 创建并初始化监听，监听所有事件 + * + * @param path 路径 + * @param watcher {@link Watcher} + * @return WatchMonitor + */ + public static WatchMonitor createAll(Path path, Watcher watcher) { + final WatchMonitor watchMonitor = create(path, EVENTS_ALL); + watchMonitor.setWatcher(watcher); + return watchMonitor; + } + //------------------------------------------------------ Static method end + + //------------------------------------------------------ Constructor method start + + /** + * 构造 + * + * @param file 文件 + * @param events 监听的事件列表 + */ + public WatchMonitor(File file, WatchEvent.Kind... events) { + this(file.toPath(), events); + } + + /** + * 构造 + * + * @param path 字符串路径 + * @param events 监听的事件列表 + */ + public WatchMonitor(String path, WatchEvent.Kind... events) { + this(Paths.get(path), events); + } + + /** + * 构造 + * + * @param path 字符串路径 + * @param events 监听事件列表 + */ + public WatchMonitor(Path path, WatchEvent.Kind... events) { + this(path, 0, events); + } + + /** + * 构造
+ * 例如设置： + * 

+	 * maxDepth <= 1 表示只监听当前目录
+	 * maxDepth = 2 表示监听当前目录以及下层目录
+	 * maxDepth = 3 表示监听当前目录以及下两层
+	 *
+ * + * @param path 字符串路径 + * @param maxDepth 递归目录的最大深度，当小于2时不递归下层目录 + * @param events 监听事件列表 + */ + public WatchMonitor(Path path, int maxDepth, WatchEvent.Kind... events) { + this.path = path; + this.maxDepth = maxDepth; + this.events = events; + this.init(); + } + //------------------------------------------------------ Constructor method end + + /** + * 初始化
+ * 初始化包括： + * 
+	 * 1、解析传入的路径，判断其为目录还是文件
+	 * 2、创建{@link WatchService} 对象
+	 *
+ * + * @throws WatchException 监听异常，IO异常时抛出此异常 + */ + @Override + public void init() throws WatchException { + //获取目录或文件路径 + if (false == Files.exists(this.path, LinkOption.NOFOLLOW_LINKS)) { + // 不存在的路径 + final Path lastPathEle = FileUtil.getLastPathEle(this.path); + if (null != lastPathEle) { + final String lastPathEleStr = lastPathEle.toString(); + //带有点表示有扩展名，按照未创建的文件对待。Linux下.d的为目录，排除之 + if (StrUtil.contains(lastPathEleStr, StrUtil.C_DOT) && false == StrUtil.endWithIgnoreCase(lastPathEleStr, ".d")) { + this.filePath = this.path; + this.path = this.filePath.getParent(); + } + } + + //创建不存在的目录或父目录 + try { + Files.createDirectories(this.path); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } else if (Files.isRegularFile(this.path, LinkOption.NOFOLLOW_LINKS)) { + // 文件路径 + this.filePath = this.path; + this.path = this.filePath.getParent(); + } + + super.init(); + } + + /** + * 设置监听
+ * 多个监听请使用{@link WatcherChain} + * + * @param watcher 监听 + * @return WatchMonitor + */ + public WatchMonitor setWatcher(Watcher watcher) { + this.watcher = watcher; + return this; + } + + @Override + public void run() { + watch(); + } + + /** + * 开始监听事件，阻塞当前进程 + */ + public void watch() { + watch(this.watcher); + } + + /** + * 开始监听事件，阻塞当前进程 + * + * @param watcher 监听 + * @throws WatchException 监听异常，如果监听关闭抛出此异常 + */ + public void watch(Watcher watcher) throws WatchException { + if (isClosed) { + throw new WatchException("Watch Monitor is closed !"); + } + + // 按照层级注册路径及其子路径 + registerPath(); +// log.debug("Start watching path: [{}]", this.path); + + while (false == isClosed) { + doTakeAndWatch(watcher); + } + } + + /** + * 当监听目录时，监听目录的最大深度
+ * 当设置值为1（或小于1）时，表示不递归监听子目录
+ * 例如设置： + * 
+	 * maxDepth <= 1 表示只监听当前目录
+	 * maxDepth = 2 表示监听当前目录以及下层目录
+	 * maxDepth = 3 表示监听当前目录以及下层
+	 *
+ * + * @param maxDepth 最大深度，当设置值为1（或小于1）时，表示不递归监听子目录，监听所有子目录请传{@link Integer#MAX_VALUE} + * @return this + */ + public WatchMonitor setMaxDepth(int maxDepth) { + this.maxDepth = maxDepth; + return this; + } + + //------------------------------------------------------ private method start + + /** + * 执行事件获取并处理 + * + * @param watcher {@link Watcher} + */ + private void doTakeAndWatch(Watcher watcher) { + super.watch(watcher, watchEvent -> null == filePath || filePath.endsWith(watchEvent.context().toString())); + } + + /** + * 注册监听路径 + */ + private void registerPath() { + registerPath(this.path, (null != this.filePath) ? 0 : this.maxDepth); + } + //------------------------------------------------------ private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchServer.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchServer.java new file mode 100755 index 0000000..11734c1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchServer.java @@ -0,0 +1,189 @@ +package aiyh.utils.tool.cn.hutool.core.io.watch; + +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Filter; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; + +import java.io.Closeable; +import java.io.IOException; +import java.io.Serializable; +import java.nio.file.AccessDeniedException; +import java.nio.file.ClosedWatchServiceException; +import java.nio.file.FileSystems; +import java.nio.file.FileVisitOption; +import java.nio.file.FileVisitResult; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.SimpleFileVisitor; +import java.nio.file.WatchEvent; +import java.nio.file.WatchKey; +import java.nio.file.WatchService; +import java.util.EnumSet; +import java.util.HashMap; +import java.util.Map; + +/** + * 文件监听服务，此服务可以同时监听多个路径。 + * + * @author loolly + * @since 5.1.0 + */ +public class WatchServer extends Thread implements Closeable, Serializable { + private static final long serialVersionUID = 1L; + + /** + * 监听服务 + */ + private WatchService watchService; + /** + * 监听事件列表 + */ + protected WatchEvent.Kind[] events; + /** + * 监听选项，例如监听频率等 + */ + private WatchEvent.Modifier[] modifiers; + /** + * 监听是否已经关闭 + */ + protected boolean isClosed; + /** + * WatchKey 和 Path的对应表 + */ + private final Map watchKeyPathMap = new HashMap<>(); + + /** + * 初始化
+ * 初始化包括： + * 
+	 * 1、解析传入的路径，判断其为目录还是文件
+	 * 2、创建{@link WatchService} 对象
+	 *
+ * + * @throws WatchException 监听异常，IO异常时抛出此异常 + */ + public void init() throws WatchException { + //初始化监听 + try { + watchService = FileSystems.getDefault().newWatchService(); + } catch (IOException e) { + throw new WatchException(e); + } + + isClosed = false; + } + + /** + * 设置监听选项，例如监听频率等，可设置项包括： + * + * 
+	 * 1、com.sun.nio.file.StandardWatchEventKinds
+	 * 2、com.sun.nio.file.SensitivityWatchEventModifier
+	 *
+ * + * @param modifiers 监听选项，例如监听频率等 + */ + public void setModifiers(WatchEvent.Modifier[] modifiers) { + this.modifiers = modifiers; + } + + /** + * 将指定路径加入到监听中 + * + * @param path 路径 + * @param maxDepth 递归下层目录的最大深度 + */ + public void registerPath(Path path, int maxDepth) { + final WatchEvent.Kind[] kinds = ArrayUtil.defaultIfEmpty(this.events, WatchKind.ALL); + + try { + final WatchKey key; + if (ArrayUtil.isEmpty(this.modifiers)) { + key = path.register(this.watchService, kinds); + } else { + key = path.register(this.watchService, kinds, this.modifiers); + } + watchKeyPathMap.put(key, path); + + // 递归注册下一层层级的目录 + if (maxDepth > 1) { + //遍历所有子目录并加入监听 + Files.walkFileTree(path, EnumSet.noneOf(FileVisitOption.class), maxDepth, new SimpleFileVisitor() { + @Override + public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException { + registerPath(dir, 0);//继续添加目录 + return super.postVisitDirectory(dir, exc); + } + }); + } + } catch (IOException e) { + if (false == (e instanceof AccessDeniedException)) { + throw new WatchException(e); + } + + //对于禁止访问的目录，跳过监听 + } + } + + /** + * 执行事件获取并处理 + * + * @param action 监听回调函数，实现此函数接口用于处理WatchEvent事件 + * @param watchFilter 监听过滤接口，通过实现此接口过滤掉不需要监听的情况，null表示不过滤 + * @since 5.4.0 + */ + public void watch(WatchAction action, Filter> watchFilter) { + WatchKey wk; + try { + wk = watchService.take(); + } catch (InterruptedException | ClosedWatchServiceException e) { + // 用户中断 + close(); + return; + } + + final Path currentPath = watchKeyPathMap.get(wk); + + for (WatchEvent event : wk.pollEvents()) { + // 如果监听文件，检查当前事件是否与所监听文件关联 + if (null != watchFilter && false == watchFilter.accept(event)) { + continue; + } + + action.doAction(event, currentPath); + } + + wk.reset(); + } + + /** + * 执行事件获取并处理 + * + * @param watcher {@link Watcher} + * @param watchFilter 监听过滤接口，通过实现此接口过滤掉不需要监听的情况，null表示不过滤 + */ + public void watch(Watcher watcher, Filter> watchFilter) { + watch((event, currentPath)->{ + final WatchEvent.Kind kind = event.kind(); + + if (kind == WatchKind.CREATE.getValue()) { + watcher.onCreate(event, currentPath); + } else if (kind == WatchKind.MODIFY.getValue()) { + watcher.onModify(event, currentPath); + } else if (kind == WatchKind.DELETE.getValue()) { + watcher.onDelete(event, currentPath); + } else if (kind == WatchKind.OVERFLOW.getValue()) { + watcher.onOverflow(event, currentPath); + } + }, watchFilter); + } + + /** + * 关闭监听 + */ + @Override + public void close() { + isClosed = true; + IoUtil.close(watchService); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchUtil.java new file mode 100644 index 0000000..2b6872f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/WatchUtil.java @@ -0,0 +1,397 @@ +package aiyh.utils.tool.cn.hutool.core.io.watch; + +import java.io.File; +import java.io.IOException; +import java.net.URI; +import java.net.URL; +import java.nio.file.*; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; + +/** + * 监听工具类
+ * 主要负责文件监听器的快捷创建 + * + * @author Looly + * @since 3.1.0 + */ +public class WatchUtil { + /** + * 创建并初始化监听 + * + * @param url URL + * @param events 监听的事件列表 + * @return 监听对象 + */ + public static WatchMonitor create(URL url, WatchEvent.Kind... events) { + return create(url, 0, events); + } + + /** + * 创建并初始化监听 + * + * @param url URL + * @param events 监听的事件列表 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @return 监听对象 + */ + public static WatchMonitor create(URL url, int maxDepth, WatchEvent.Kind... events) { + return create(URLUtil.toURI(url), maxDepth, events); + } + + /** + * 创建并初始化监听 + * + * @param uri URI + * @param events 监听的事件列表 + * @return 监听对象 + */ + public static WatchMonitor create(URI uri, WatchEvent.Kind... events) { + return create(uri, 0, events); + } + + /** + * 创建并初始化监听 + * + * @param uri URI + * @param events 监听的事件列表 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @return 监听对象 + */ + public static WatchMonitor create(URI uri, int maxDepth, WatchEvent.Kind... events) { + return create(Paths.get(uri), maxDepth, events); + } + + /** + * 创建并初始化监听 + * + * @param file 文件 + * @param events 监听的事件列表 + * @return 监听对象 + */ + public static WatchMonitor create(File file, WatchEvent.Kind... events) { + return create(file, 0, events); + } + + /** + * 创建并初始化监听 + * + * @param file 文件 + * @param events 监听的事件列表 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @return 监听对象 + */ + public static WatchMonitor create(File file, int maxDepth, WatchEvent.Kind... events) { + return create(file.toPath(), maxDepth, events); + } + + /** + * 创建并初始化监听 + * + * @param path 路径 + * @param events 监听的事件列表 + * @return 监听对象 + */ + public static WatchMonitor create(String path, WatchEvent.Kind... events) { + return create(path, 0, events); + } + + /** + * 创建并初始化监听 + * + * @param path 路径 + * @param events 监听的事件列表 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @return 监听对象 + */ + public static WatchMonitor create(String path, int maxDepth, WatchEvent.Kind... events) { + return create(Paths.get(path), maxDepth, events); + } + + /** + * 创建并初始化监听 + * + * @param path 路径 + * @param events 监听事件列表 + * @return 监听对象 + */ + public static WatchMonitor create(Path path, WatchEvent.Kind... events) { + return create(path, 0, events); + } + + /** + * 创建并初始化监听 + * + * @param path 路径 + * @param events 监听事件列表 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @return 监听对象 + */ + public static WatchMonitor create(Path path, int maxDepth, WatchEvent.Kind... events) { + return new WatchMonitor(path, maxDepth, events); + } + + // ---------------------------------------------------------------------------------------------------------- createAll + /** + * 创建并初始化监听，监听所有事件 + * + * @param url URL + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + */ + public static WatchMonitor createAll(URL url, Watcher watcher) { + return createAll(url, 0, watcher); + } + + /** + * 创建并初始化监听，监听所有事件 + * + * @param url URL + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + */ + public static WatchMonitor createAll(URL url, int maxDepth, Watcher watcher) { + return createAll(URLUtil.toURI(url), maxDepth, watcher); + } + + /** + * 创建并初始化监听，监听所有事件 + * + * @param uri URI + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + */ + public static WatchMonitor createAll(URI uri, Watcher watcher) { + return createAll(uri, 0, watcher); + } + + /** + * 创建并初始化监听，监听所有事件 + * + * @param uri URI + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + */ + public static WatchMonitor createAll(URI uri, int maxDepth, Watcher watcher) { + return createAll(Paths.get(uri), maxDepth, watcher); + } + + /** + * 创建并初始化监听，监听所有事件 + * + * @param file 被监听文件 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + */ + public static WatchMonitor createAll(File file, Watcher watcher) { + return createAll(file, 0, watcher); + } + + /** + * 创建并初始化监听，监听所有事件 + * + * @param file 被监听文件 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + */ + public static WatchMonitor createAll(File file, int maxDepth, Watcher watcher) { + return createAll(file.toPath(), 0, watcher); + } + + /** + * 创建并初始化监听，监听所有事件 + * + * @param path 路径 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + */ + public static WatchMonitor createAll(String path, Watcher watcher) { + return createAll(path, 0, watcher); + } + + /** + * 创建并初始化监听，监听所有事件 + * + * @param path 路径 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + */ + public static WatchMonitor createAll(String path, int maxDepth, Watcher watcher) { + return createAll(Paths.get(path), maxDepth, watcher); + } + + /** + * 创建并初始化监听，监听所有事件 + * + * @param path 路径 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + */ + public static WatchMonitor createAll(Path path, Watcher watcher) { + return createAll(path, 0, watcher); + } + + /** + * 创建并初始化监听，监听所有事件 + * + * @param path 路径 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + */ + public static WatchMonitor createAll(Path path, int maxDepth, Watcher watcher) { + final WatchMonitor watchMonitor = create(path, maxDepth, WatchMonitor.EVENTS_ALL); + watchMonitor.setWatcher(watcher); + return watchMonitor; + } + + // ---------------------------------------------------------------------------------------------------------- createModify + /** + * 创建并初始化监听，监听修改事件 + * + * @param url URL + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + * @since 4.5.2 + */ + public static WatchMonitor createModify(URL url, Watcher watcher) { + return createModify(url, 0, watcher); + } + + /** + * 创建并初始化监听，监听修改事件 + * + * @param url URL + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + * @since 4.5.2 + */ + public static WatchMonitor createModify(URL url, int maxDepth, Watcher watcher) { + return createModify(URLUtil.toURI(url), maxDepth, watcher); + } + + /** + * 创建并初始化监听，监听修改事件 + * + * @param uri URI + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + * @since 4.5.2 + */ + public static WatchMonitor createModify(URI uri, Watcher watcher) { + return createModify(uri, 0, watcher); + } + + /** + * 创建并初始化监听，监听修改事件 + * + * @param uri URI + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + * @since 4.5.2 + */ + public static WatchMonitor createModify(URI uri, int maxDepth, Watcher watcher) { + return createModify(Paths.get(uri), maxDepth, watcher); + } + + /** + * 创建并初始化监听，监听修改事件 + * + * @param file 被监听文件 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + * @since 4.5.2 + */ + public static WatchMonitor createModify(File file, Watcher watcher) { + return createModify(file, 0, watcher); + } + + /** + * 创建并初始化监听，监听修改事件 + * + * @param file 被监听文件 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + * @since 4.5.2 + */ + public static WatchMonitor createModify(File file, int maxDepth, Watcher watcher) { + return createModify(file.toPath(), 0, watcher); + } + + /** + * 创建并初始化监听，监听修改事件 + * + * @param path 路径 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + * @since 4.5.2 + */ + public static WatchMonitor createModify(String path, Watcher watcher) { + return createModify(path, 0, watcher); + } + + /** + * 创建并初始化监听，监听修改事件 + * + * @param path 路径 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + * @since 4.5.2 + */ + public static WatchMonitor createModify(String path, int maxDepth, Watcher watcher) { + return createModify(Paths.get(path), maxDepth, watcher); + } + + /** + * 创建并初始化监听，监听修改事件 + * + * @param path 路径 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + * @since 4.5.2 + */ + public static WatchMonitor createModify(Path path, Watcher watcher) { + return createModify(path, 0, watcher); + } + + /** + * 创建并初始化监听，监听修改事件 + * + * @param path 路径 + * @param maxDepth 当监听目录时，监听目录的最大深度，当设置值为1（或小于1）时，表示不递归监听子目录 + * @param watcher {@link Watcher} + * @return {@link WatchMonitor} + * @since 4.5.2 + */ + public static WatchMonitor createModify(Path path, int maxDepth, Watcher watcher) { + final WatchMonitor watchMonitor = create(path, maxDepth, WatchMonitor.ENTRY_MODIFY); + watchMonitor.setWatcher(watcher); + return watchMonitor; + } + + /** + * 注册Watchable对象到WatchService服务 + * + * @param watchable 可注册对象 + * @param watcher WatchService对象 + * @param events 监听事件 + * @return {@link WatchKey} + * @since 4.6.9 + */ + public static WatchKey register(Watchable watchable, WatchService watcher, WatchEvent.Kind... events){ + try { + return watchable.register(watcher, events); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/Watcher.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/Watcher.java new file mode 100644 index 0000000..640d2b2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/Watcher.java @@ -0,0 +1,44 @@ +package aiyh.utils.tool.cn.hutool.core.io.watch; + +import java.nio.file.Path; +import java.nio.file.WatchEvent; + +/** + * 观察者（监视器） + * + * @author Looly + */ +public interface Watcher { + /** + * 文件创建时执行的方法 + * + * @param event 事件 + * @param currentPath 事件发生的当前Path路径 + */ + void onCreate(WatchEvent event, Path currentPath); + + /** + * 文件修改时执行的方法
+ * 文件修改可能触发多次 + * + * @param event 事件 + * @param currentPath 事件发生的当前Path路径 + */ + void onModify(WatchEvent event, Path currentPath); + + /** + * 文件删除时执行的方法 + * + * @param event 事件 + * @param currentPath 事件发生的当前Path路径 + */ + void onDelete(WatchEvent event, Path currentPath); + + /** + * 事件丢失或出错时执行的方法 + * + * @param event 事件 + * @param currentPath 事件发生的当前Path路径 + */ + void onOverflow(WatchEvent event, Path currentPath); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/package-info.java new file mode 100644 index 0000000..63a06b0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/package-info.java @@ -0,0 +1,7 @@ +/** + * 基于JDK7+ WatchService的文件和目录监听封装，支持多级目录 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.io.watch; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/watchers/DelayWatcher.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/watchers/DelayWatcher.java new file mode 100644 index 0000000..235fe64 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/watchers/DelayWatcher.java @@ -0,0 +1,105 @@ +package aiyh.utils.tool.cn.hutool.core.io.watch.watchers; + +import aiyh.utils.tool.cn.hutool.core.collection.ConcurrentHashSet; +import aiyh.utils.tool.cn.hutool.core.io.watch.Watcher; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.thread.ThreadUtil; + +import java.nio.file.Path; +import java.nio.file.Paths; +import java.nio.file.WatchEvent; +import java.nio.file.WatchService; +import java.util.Set; + +/** + * 延迟观察者
+ * 使用此观察者通过定义一定的延迟时间，解决{@link WatchService}多个modify的问题
+ * 在监听目录或文件时，如果这个文件有修改操作，会多次触发modify方法。
+ * 此类通过维护一个Set将短时间内相同文件多次modify的事件合并处理触发，从而避免以上问题。
+ * 注意：延迟只针对modify事件，其它事件无效 + * + * @author Looly + * @since 3.1.0 + */ +public class DelayWatcher implements Watcher { + + /** Path集合。此集合用于去重在指定delay内多次触发的文件Path */ + private final Set eventSet = new ConcurrentHashSet<>(); + /** 实际处理 */ + private final Watcher watcher; + /** 延迟，单位毫秒 */ + private final long delay; + + //---------------------------------------------------------------------------------------------------------- Constructor start + /** + * 构造 + * @param watcher 实际处理触发事件的监视器{@link Watcher}，不可以是{@link DelayWatcher} + * @param delay 延迟时间，单位毫秒 + */ + public DelayWatcher(Watcher watcher, long delay) { + Assert.notNull(watcher); + if(watcher instanceof DelayWatcher) { + throw new IllegalArgumentException("Watcher must not be a DelayWatcher"); + } + this.watcher = watcher; + this.delay = delay; + } + //---------------------------------------------------------------------------------------------------------- Constructor end + + @Override + public void onModify(WatchEvent event, Path currentPath) { + if(this.delay < 1) { + this.watcher.onModify(event, currentPath); + }else { + onDelayModify(event, currentPath); + } + } + + @Override + public void onCreate(WatchEvent event, Path currentPath) { + watcher.onCreate(event, currentPath); + } + + @Override + public void onDelete(WatchEvent event, Path currentPath) { + watcher.onDelete(event, currentPath); + } + + @Override + public void onOverflow(WatchEvent event, Path currentPath) { + watcher.onOverflow(event, currentPath); + } + + //---------------------------------------------------------------------------------------------------------- Private method start + /** + * 触发延迟修改 + * @param event 事件 + * @param currentPath 事件发生的当前Path路径 + */ + private void onDelayModify(WatchEvent event, Path currentPath) { + Path eventPath = Paths.get(currentPath.toString(), event.context().toString()); + if(eventSet.contains(eventPath)) { + //此事件已经被触发过，后续事件忽略，等待统一处理。 + return; + } + + //事件第一次触发，此时标记事件，并启动处理线程延迟处理，处理结束后会删除标记 + eventSet.add(eventPath); + startHandleModifyThread(event, currentPath); + } + + /** + * 开启处理线程 + * + * @param event 事件 + * @param currentPath 事件发生的当前Path路径 + */ + private void startHandleModifyThread(final WatchEvent event, final Path currentPath) { + ThreadUtil.execute(() -> { + ThreadUtil.sleep(delay); + eventSet.remove(Paths.get(currentPath.toString(), event.context().toString())); + watcher.onModify(event, currentPath); + }); + } + //---------------------------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/watchers/IgnoreWatcher.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/watchers/IgnoreWatcher.java new file mode 100644 index 0000000..81e7baf --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/watchers/IgnoreWatcher.java @@ -0,0 +1,32 @@ +package aiyh.utils.tool.cn.hutool.core.io.watch.watchers; + +import java.nio.file.Path; +import java.nio.file.WatchEvent; + +import aiyh.utils.tool.cn.hutool.core.io.watch.Watcher; + +/** + * 跳过所有事件处理Watcher
+ * 用户继承此类后实现需要监听的方法 + * + * @author Looly + * @since 3.1.0 + */ +public class IgnoreWatcher implements Watcher { + + @Override + public void onCreate(WatchEvent event, Path currentPath) { + } + + @Override + public void onModify(WatchEvent event, Path currentPath) { + } + + @Override + public void onDelete(WatchEvent event, Path currentPath) { + } + + @Override + public void onOverflow(WatchEvent event, Path currentPath) { + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/watchers/WatcherChain.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/watchers/WatcherChain.java new file mode 100644 index 0000000..690db17 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/watchers/WatcherChain.java @@ -0,0 +1,81 @@ +package aiyh.utils.tool.cn.hutool.core.io.watch.watchers; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.io.watch.Watcher; +import aiyh.utils.tool.cn.hutool.core.lang.Chain; + +import java.nio.file.Path; +import java.nio.file.WatchEvent; +import java.util.Iterator; +import java.util.List; + +/** + * 观察者链
+ * 用于加入多个观察者 + * + * @author Looly + * @since 3.1.0 + */ +public class WatcherChain implements Watcher, Chain{ + + /** 观察者列表 */ + final private List chain; + + /** + * 创建观察者链{@link WatcherChain} + * @param watchers 观察者列表 + * @return {@link WatcherChain} + */ + public static WatcherChain create(Watcher... watchers) { + return new WatcherChain(watchers); + } + + /** + * 构造 + * @param watchers 观察者列表 + */ + public WatcherChain(Watcher... watchers) { + chain = CollUtil.newArrayList(watchers); + } + + @Override + public void onCreate(WatchEvent event, Path currentPath) { + for (Watcher watcher : chain) { + watcher.onCreate(event, currentPath); + } + } + + @Override + public void onModify(WatchEvent event, Path currentPath) { + for (Watcher watcher : chain) { + watcher.onModify(event, currentPath); + } + } + + @Override + public void onDelete(WatchEvent event, Path currentPath) { + for (Watcher watcher : chain) { + watcher.onDelete(event, currentPath); + } + } + + @Override + public void onOverflow(WatchEvent event, Path currentPath) { + for (Watcher watcher : chain) { + watcher.onOverflow(event, currentPath); + } + } + + @SuppressWarnings("NullableProblems") + @Override + public Iterator iterator() { + return this.chain.iterator(); + } + + @Override + public WatcherChain addChain(Watcher element) { + this.chain.add(element); + return this; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/watchers/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/watchers/package-info.java new file mode 100644 index 0000000..19a94d9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/io/watch/watchers/package-info.java @@ -0,0 +1,7 @@ +/** + * 文件监听中的观察者实现类，包括延迟处理、处理链等 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.io.watch.watchers; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Assert.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Assert.java new file mode 100644 index 0000000..8e40966 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Assert.java @@ -0,0 +1,1121 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.Map; +import java.util.function.Supplier; + +/** + * 断言
+ * 断言某些对象或值是否符合规定，否则抛出异常。经常用于做变量检查 + * + * @author Looly + */ +public class Assert { + + private static final String TEMPLATE_VALUE_MUST_BE_BETWEEN_AND = "The value must be between {} and {}."; + + + /** + * 断言是否为真，如果为 {@code false} 抛出给定的异常
+ * + * 
+	 * Assert.isTrue(i > 0, IllegalArgumentException::new);
+	 *
+ * + * @param 异常类型 + * @param expression 布尔值 + * @param supplier 指定断言不通过时抛出的异常 + * @throws X if expression is {@code false} + */ + public static void isTrue(boolean expression, Supplier supplier) throws X { + if (false == expression) { + throw supplier.get(); + } + } + + /** + * 断言是否为真，如果为 {@code false} 抛出 {@code IllegalArgumentException} 异常
+ * + * 
+	 * Assert.isTrue(i > 0, "The value must be greater than zero");
+	 *
+ * + * @param expression 布尔值 + * @param errorMsgTemplate 错误抛出异常附带的消息模板，变量用{}代替 + * @param params 参数列表 + * @throws IllegalArgumentException if expression is {@code false} + */ + public static void isTrue(boolean expression, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + isTrue(expression, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 断言是否为真，如果为 {@code false} 抛出 {@code IllegalArgumentException} 异常
+ * + * 
+	 * Assert.isTrue(i > 0);
+	 *
+ * + * @param expression 布尔值 + * @throws IllegalArgumentException if expression is {@code false} + */ + public static void isTrue(boolean expression) throws IllegalArgumentException { + isTrue(expression, "[Assertion failed] - this expression must be true"); + } + + /** + * 断言是否为假，如果为 {@code true} 抛出指定类型异常
+ * 并使用指定的函数获取错误信息返回 + * 
+	 *  Assert.isFalse(i > 0, ()->{
+	 *      // to query relation message
+	 *      return new IllegalArgumentException("relation message to return");
+	 *  });
+	 *
+ * + * @param 异常类型 + * @param expression 布尔值 + * @param errorSupplier 指定断言不通过时抛出的异常 + * @throws X if expression is {@code false} + * @since 5.4.5 + */ + public static void isFalse(boolean expression, Supplier errorSupplier) throws X { + if (expression) { + throw errorSupplier.get(); + } + } + + /** + * 断言是否为假，如果为 {@code true} 抛出 {@code IllegalArgumentException} 异常
+ * + * 
+	 * Assert.isFalse(i < 0, "The value must not be negative");
+	 *
+ * + * @param expression 布尔值 + * @param errorMsgTemplate 错误抛出异常附带的消息模板，变量用{}代替 + * @param params 参数列表 + * @throws IllegalArgumentException if expression is {@code false} + */ + public static void isFalse(boolean expression, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + isFalse(expression, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 断言是否为假，如果为 {@code true} 抛出 {@code IllegalArgumentException} 异常
+ * + * 
+	 * Assert.isFalse(i < 0);
+	 *
+ * + * @param expression 布尔值 + * @throws IllegalArgumentException if expression is {@code false} + */ + public static void isFalse(boolean expression) throws IllegalArgumentException { + isFalse(expression, "[Assertion failed] - this expression must be false"); + } + + /** + * 断言对象是否为{@code null} ，如果不为{@code null} 抛出指定类型异常 + * 并使用指定的函数获取错误信息返回 + * 
+	 * Assert.isNull(value, ()->{
+	 *      // to query relation message
+	 *      return new IllegalArgumentException("relation message to return");
+	 *  });
+	 *
+ * + * @param 异常类型 + * @param object 被检查的对象 + * @param errorSupplier 错误抛出异常附带的消息生产接口 + * @throws X if the object is not {@code null} + * @since 5.4.5 + */ + public static void isNull(Object object, Supplier errorSupplier) throws X { + if (null != object) { + throw errorSupplier.get(); + } + } + + /** + * 断言对象是否为{@code null} ，如果不为{@code null} 抛出{@link IllegalArgumentException} 异常 + * + * 
+	 * Assert.isNull(value, "The value must be null");
+	 *
+ * + * @param object 被检查的对象 + * @param errorMsgTemplate 消息模板，变量使用{}表示 + * @param params 参数列表 + * @throws IllegalArgumentException if the object is not {@code null} + */ + public static void isNull(Object object, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + isNull(object, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 断言对象是否为{@code null} ，如果不为{@code null} 抛出{@link IllegalArgumentException} 异常 + * + * 
+	 * Assert.isNull(value);
+	 *
+ * + * @param object 被检查对象 + * @throws IllegalArgumentException if the object is not {@code null} + */ + public static void isNull(Object object) throws IllegalArgumentException { + isNull(object, "[Assertion failed] - the object argument must be null"); + } + + // ----------------------------------------------------------------------------------------------------------- Check not null + + /** + * 断言对象是否不为{@code null} ，如果为{@code null} 抛出指定类型异常 + * 并使用指定的函数获取错误信息返回 + * 
+	 * Assert.notNull(clazz, ()->{
+	 *      // to query relation message
+	 *      return new IllegalArgumentException("relation message to return");
+	 *  });
+	 *
+ * + * @param 被检查对象泛型类型 + * @param 异常类型 + * @param object 被检查对象 + * @param errorSupplier 错误抛出异常附带的消息生产接口 + * @return 被检查后的对象 + * @throws X if the object is {@code null} + * @since 5.4.5 + */ + public static T notNull(T object, Supplier errorSupplier) throws X { + if (null == object) { + throw errorSupplier.get(); + } + return object; + } + + /** + * 断言对象是否不为{@code null} ，如果为{@code null} 抛出{@link IllegalArgumentException} 异常 Assert that an object is not {@code null} . + * + * 
+	 * Assert.notNull(clazz, "The class must not be null");
+	 *
+ * + * @param 被检查对象泛型类型 + * @param object 被检查对象 + * @param errorMsgTemplate 错误消息模板，变量使用{}表示 + * @param params 参数 + * @return 被检查后的对象 + * @throws IllegalArgumentException if the object is {@code null} + */ + public static T notNull(T object, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + return notNull(object, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 断言对象是否不为{@code null} ，如果为{@code null} 抛出{@link IllegalArgumentException} 异常 + * + * 
+	 * Assert.notNull(clazz);
+	 *
+ * + * @param 被检查对象类型 + * @param object 被检查对象 + * @return 非空对象 + * @throws IllegalArgumentException if the object is {@code null} + */ + public static T notNull(T object) throws IllegalArgumentException { + return notNull(object, "[Assertion failed] - this argument is required; it must not be null"); + } + + // ----------------------------------------------------------------------------------------------------------- Check empty + + /** + * 检查给定字符串是否为空，为空抛出自定义异常，并使用指定的函数获取错误信息返回。 + * 
+	 * Assert.notEmpty(name, ()->{
+	 *      // to query relation message
+	 *      return new IllegalArgumentException("relation message to return");
+	 *  });
+	 *
+ * + * @param 异常类型 + * @param 字符串类型 + * @param text 被检查字符串 + * @param errorSupplier 错误抛出异常附带的消息生产接口 + * @return 非空字符串 + * @throws X 被检查字符串为空抛出此异常 + * @see StrUtil#isNotEmpty(CharSequence) + * @since 5.4.5 + */ + public static T notEmpty(T text, Supplier errorSupplier) throws X { + if (StrUtil.isEmpty(text)) { + throw errorSupplier.get(); + } + return text; + } + + /** + * 检查给定字符串是否为空，为空抛出 {@link IllegalArgumentException} + * + * 
+	 * Assert.notEmpty(name, "Name must not be empty");
+	 *
+ * + * @param 字符串类型 + * @param text 被检查字符串 + * @param errorMsgTemplate 错误消息模板，变量使用{}表示 + * @param params 参数 + * @return 非空字符串 + * @throws IllegalArgumentException 被检查字符串为空 + * @see StrUtil#isNotEmpty(CharSequence) + */ + public static T notEmpty(T text, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + return notEmpty(text, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 检查给定字符串是否为空，为空抛出 {@link IllegalArgumentException} + * + * 
+	 * Assert.notEmpty(name);
+	 *
+ * + * @param 字符串类型 + * @param text 被检查字符串 + * @return 被检查的字符串 + * @throws IllegalArgumentException 被检查字符串为空 + * @see StrUtil#isNotEmpty(CharSequence) + */ + public static T notEmpty(T text) throws IllegalArgumentException { + return notEmpty(text, "[Assertion failed] - this String argument must have length; it must not be null or empty"); + } + + /** + * 检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出自定义异常。 + * 并使用指定的函数获取错误信息返回 + * 
+	 * Assert.notBlank(name, ()->{
+	 *      // to query relation message
+	 *      return new IllegalArgumentException("relation message to return");
+	 *  });
+	 *
+ * + * @param 异常类型 + * @param 字符串类型 + * @param text 被检查字符串 + * @param errorMsgSupplier 错误抛出异常附带的消息生产接口 + * @return 非空字符串 + * @throws X 被检查字符串为空白 + * @see StrUtil#isNotBlank(CharSequence) + */ + public static T notBlank(T text, Supplier errorMsgSupplier) throws X { + if (StrUtil.isBlank(text)) { + throw errorMsgSupplier.get(); + } + return text; + } + + /** + * 检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出 {@link IllegalArgumentException} + * + * 
+	 * Assert.notBlank(name, "Name must not be blank");
+	 *
+ * + * @param 字符串类型 + * @param text 被检查字符串 + * @param errorMsgTemplate 错误消息模板，变量使用{}表示 + * @param params 参数 + * @return 非空字符串 + * @throws IllegalArgumentException 被检查字符串为空白 + * @see StrUtil#isNotBlank(CharSequence) + */ + public static T notBlank(T text, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + return notBlank(text, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 检查给定字符串是否为空白（null、空串或只包含空白符），为空抛出 {@link IllegalArgumentException} + * + * 
+	 * Assert.notBlank(name);
+	 *
+ * + * @param 字符串类型 + * @param text 被检查字符串 + * @return 非空字符串 + * @throws IllegalArgumentException 被检查字符串为空白 + * @see StrUtil#isNotBlank(CharSequence) + */ + public static T notBlank(T text) throws IllegalArgumentException { + return notBlank(text, "[Assertion failed] - this String argument must have text; it must not be null, empty, or blank"); + } + + /** + * 断言给定字符串是否不被另一个字符串包含（即是否为子串） + * 并使用指定的函数获取错误信息返回 + * 
+	 * Assert.notContain(name, "rod", ()->{
+	 *      // to query relation message
+	 *      return new IllegalArgumentException("relation message to return ");
+	 *  });
+	 *
+ * + * @param 字符串类型 + * @param 异常类型 + * @param textToSearch 被搜索的字符串 + * @param substring 被检查的子串 + * @param errorSupplier 错误抛出异常附带的消息生产接口 + * @return 被检查的子串 + * @throws X 非子串抛出异常 + * @see StrUtil#contains(CharSequence, CharSequence) + * @since 5.4.5 + */ + public static T notContain(CharSequence textToSearch, T substring, Supplier errorSupplier) throws X { + if (StrUtil.contains(textToSearch, substring)) { + throw errorSupplier.get(); + } + return substring; + } + + /** + * 断言给定字符串是否不被另一个字符串包含（即是否为子串） + * + * 
+	 * Assert.notContain(name, "rod", "Name must not contain 'rod'");
+	 *
+ * + * @param textToSearch 被搜索的字符串 + * @param substring 被检查的子串 + * @param errorMsgTemplate 异常时的消息模板 + * @param params 参数列表 + * @return 被检查的子串 + * @throws IllegalArgumentException 非子串抛出异常 + */ + public static String notContain(String textToSearch, String substring, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + return notContain(textToSearch, substring, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 断言给定字符串是否不被另一个字符串包含（即是否为子串） + * + * 
+	 * Assert.notContain(name, "rod");
+	 *
+ * + * @param textToSearch 被搜索的字符串 + * @param substring 被检查的子串 + * @return 被检查的子串 + * @throws IllegalArgumentException 非子串抛出异常 + */ + public static String notContain(String textToSearch, String substring) throws IllegalArgumentException { + return notContain(textToSearch, substring, "[Assertion failed] - this String argument must not contain the substring [{}]", substring); + } + + /** + * 断言给定数组是否包含元素，数组必须不为 {@code null} 且至少包含一个元素 + * 并使用指定的函数获取错误信息返回 + * + * 
+	 * Assert.notEmpty(array, ()->{
+	 *      // to query relation message
+	 *      return new IllegalArgumentException("relation message to return");
+	 *  });
+	 *
+ * + * @param 数组元素类型 + * @param 异常类型 + * @param array 被检查的数组 + * @param errorSupplier 错误抛出异常附带的消息生产接口 + * @return 被检查的数组 + * @throws X if the object array is {@code null} or has no elements + * @see ArrayUtil#isNotEmpty(Object[]) + * @since 5.4.5 + */ + public static T[] notEmpty(T[] array, Supplier errorSupplier) throws X { + if (ArrayUtil.isEmpty(array)) { + throw errorSupplier.get(); + } + return array; + } + + /** + * 断言给定数组是否包含元素，数组必须不为 {@code null} 且至少包含一个元素 + * + * 
+	 * Assert.notEmpty(array, "The array must have elements");
+	 *
+ * + * @param 数组元素类型 + * @param array 被检查的数组 + * @param errorMsgTemplate 异常时的消息模板 + * @param params 参数列表 + * @return 被检查的数组 + * @throws IllegalArgumentException if the object array is {@code null} or has no elements + */ + public static T[] notEmpty(T[] array, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + return notEmpty(array, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 断言给定数组是否包含元素，数组必须不为 {@code null} 且至少包含一个元素 + * + * 
+	 * Assert.notEmpty(array, "The array must have elements");
+	 *
+ * + * @param 数组元素类型 + * @param array 被检查的数组 + * @return 被检查的数组 + * @throws IllegalArgumentException if the object array is {@code null} or has no elements + */ + public static T[] notEmpty(T[] array) throws IllegalArgumentException { + return notEmpty(array, "[Assertion failed] - this array must not be empty: it must contain at least 1 element"); + } + + /** + * 断言给定数组是否不包含{@code null}元素，如果数组为空或 {@code null}将被认为不包含 + * 并使用指定的函数获取错误信息返回 + * 
+	 * Assert.noNullElements(array, ()->{
+	 *      // to query relation message
+	 *      return new IllegalArgumentException("relation message to return ");
+	 *  });
+	 *
+ * + * @param 数组元素类型 + * @param 异常类型 + * @param array 被检查的数组 + * @param errorSupplier 错误抛出异常附带的消息生产接口 + * @return 被检查的数组 + * @throws X if the object array contains a {@code null} element + * @see ArrayUtil#hasNull(Object[]) + * @since 5.4.5 + */ + public static T[] noNullElements(T[] array, Supplier errorSupplier) throws X { + if (ArrayUtil.hasNull(array)) { + throw errorSupplier.get(); + } + return array; + } + + /** + * 断言给定数组是否不包含{@code null}元素，如果数组为空或 {@code null}将被认为不包含 + * + * 
+	 * Assert.noNullElements(array, "The array must not have null elements");
+	 *
+ * + * @param 数组元素类型 + * @param array 被检查的数组 + * @param errorMsgTemplate 异常时的消息模板 + * @param params 参数列表 + * @return 被检查的数组 + * @throws IllegalArgumentException if the object array contains a {@code null} element + */ + public static T[] noNullElements(T[] array, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + return noNullElements(array, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 断言给定数组是否不包含{@code null}元素，如果数组为空或 {@code null}将被认为不包含 + * + * 
+	 * Assert.noNullElements(array);
+	 *
+ * + * @param 数组元素类型 + * @param array 被检查的数组 + * @return 被检查的数组 + * @throws IllegalArgumentException if the object array contains a {@code null} element + */ + public static T[] noNullElements(T[] array) throws IllegalArgumentException { + return noNullElements(array, "[Assertion failed] - this array must not contain any null elements"); + } + + /** + * 断言给定集合非空 + * 并使用指定的函数获取错误信息返回 + * 
+	 * Assert.notEmpty(collection, ()->{
+	 *      // to query relation message
+	 *      return new IllegalArgumentException("relation message to return");
+	 *  });
+	 *
+ * + * @param 集合元素类型 + * @param 集合类型 + * @param 异常类型 + * @param collection 被检查的集合 + * @param errorSupplier 错误抛出异常附带的消息生产接口 + * @return 非空集合 + * @throws X if the collection is {@code null} or has no elements + * @see CollUtil#isNotEmpty(Iterable) + * @since 5.4.5 + */ + public static , X extends Throwable> T notEmpty(T collection, Supplier errorSupplier) throws X { + if (CollUtil.isEmpty(collection)) { + throw errorSupplier.get(); + } + return collection; + } + + /** + * 断言给定集合非空 + * + * 
+	 * Assert.notEmpty(collection, "Collection must have elements");
+	 *
+ * + * @param 集合元素类型 + * @param 集合类型 + * @param collection 被检查的集合 + * @param errorMsgTemplate 异常时的消息模板 + * @param params 参数列表 + * @return 非空集合 + * @throws IllegalArgumentException if the collection is {@code null} or has no elements + */ + public static > T notEmpty(T collection, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + return notEmpty(collection, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 断言给定集合非空 + * + * 
+	 * Assert.notEmpty(collection);
+	 *
+ * + * @param 集合元素类型 + * @param 集合类型 + * @param collection 被检查的集合 + * @return 被检查集合 + * @throws IllegalArgumentException if the collection is {@code null} or has no elements + */ + public static > T notEmpty(T collection) throws IllegalArgumentException { + return notEmpty(collection, "[Assertion failed] - this collection must not be empty: it must contain at least 1 element"); + } + + /** + * 断言给定Map非空 + * 并使用指定的函数获取错误信息返回 + * 
+	 * Assert.notEmpty(map, ()->{
+	 *      // to query relation message
+	 *      return new IllegalArgumentException("relation message to return");
+	 *  });
+	 *
+ * + * @param Key类型 + * @param Value类型 + * @param Map类型 + * @param 异常类型 + * @param map 被检查的Map + * @param errorSupplier 错误抛出异常附带的消息生产接口 + * @return 被检查的Map + * @throws X if the map is {@code null} or has no entries + * @see MapUtil#isNotEmpty(Map) + * @since 5.4.5 + */ + public static , X extends Throwable> T notEmpty(T map, Supplier errorSupplier) throws X { + if (MapUtil.isEmpty(map)) { + throw errorSupplier.get(); + } + return map; + } + + /** + * 断言给定Map非空 + * + * 
+	 * Assert.notEmpty(map, "Map must have entries");
+	 *
+ * + * @param Key类型 + * @param Value类型 + * @param Map类型 + * @param map 被检查的Map + * @param errorMsgTemplate 异常时的消息模板 + * @param params 参数列表 + * @return 被检查的Map + * @throws IllegalArgumentException if the map is {@code null} or has no entries + */ + public static > T notEmpty(T map, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + return notEmpty(map, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 断言给定Map非空 + * + * 
+	 * Assert.notEmpty(map, "Map must have entries");
+	 *
+ * + * @param Key类型 + * @param Value类型 + * @param Map类型 + * @param map 被检查的Map + * @return 被检查的Map + * @throws IllegalArgumentException if the map is {@code null} or has no entries + */ + public static > T notEmpty(T map) throws IllegalArgumentException { + return notEmpty(map, "[Assertion failed] - this map must not be empty; it must contain at least one entry"); + } + + /** + * 断言给定对象是否是给定类的实例 + * + * 
+	 * Assert.instanceOf(Foo.class, foo);
+	 *
+ * + * @param 被检查对象泛型类型 + * @param type 被检查对象匹配的类型 + * @param obj 被检查对象 + * @return 被检查的对象 + * @throws IllegalArgumentException if the object is not an instance of clazz + * @see Class#isInstance(Object) + */ + public static T isInstanceOf(Class type, T obj) { + return isInstanceOf(type, obj, "Object [{}] is not instanceof [{}]", obj, type); + } + + /** + * 断言给定对象是否是给定类的实例 + * + * 
+	 * Assert.instanceOf(Foo.class, foo, "foo must be an instance of class Foo");
+	 *
+ * + * @param 被检查对象泛型类型 + * @param type 被检查对象匹配的类型 + * @param obj 被检查对象 + * @param errorMsgTemplate 异常时的消息模板 + * @param params 参数列表 + * @return 被检查对象 + * @throws IllegalArgumentException if the object is not an instance of clazz + * @see Class#isInstance(Object) + */ + public static T isInstanceOf(Class type, T obj, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + notNull(type, "Type to check against must not be null"); + if (false == type.isInstance(obj)) { + throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params)); + } + return obj; + } + + /** + * 断言 {@code superType.isAssignableFrom(subType)} 是否为 {@code true}. + * + * 
+	 * Assert.isAssignable(Number.class, myClass);
+	 *
+ * + * @param superType 需要检查的父类或接口 + * @param subType 需要检查的子类 + * @throws IllegalArgumentException 如果子类非继承父类，抛出此异常 + */ + public static void isAssignable(Class superType, Class subType) throws IllegalArgumentException { + isAssignable(superType, subType, "{} is not assignable to {})", subType, superType); + } + + /** + * 断言 {@code superType.isAssignableFrom(subType)} 是否为 {@code true}. + * + * 
+	 * Assert.isAssignable(Number.class, myClass, "myClass must can be assignable to class Number");
+	 *
+ * + * @param superType 需要检查的父类或接口 + * @param subType 需要检查的子类 + * @param errorMsgTemplate 异常时的消息模板 + * @param params 参数列表 + * @throws IllegalArgumentException 如果子类非继承父类，抛出此异常 + */ + public static void isAssignable(Class superType, Class subType, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + notNull(superType, "Type to check against must not be null"); + if (subType == null || !superType.isAssignableFrom(subType)) { + throw new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params)); + } + } + + /** + * 检查boolean表达式，当检查结果为false时抛出 {@code IllegalStateException}。 + * 并使用指定的函数获取错误信息返回 + * 
+	 * Assert.state(id == null, ()->{
+	 *      // to query relation message
+	 *      return "relation message to return ";
+	 *  });
+	 *
+ * + * @param expression boolean 表达式 + * @param errorMsgSupplier 错误抛出异常附带的消息生产接口 + * @throws IllegalStateException 表达式为 {@code false} 抛出此异常 + */ + public static void state(boolean expression, Supplier errorMsgSupplier) throws IllegalStateException { + if (false == expression) { + throw new IllegalStateException(errorMsgSupplier.get()); + } + } + + /** + * 检查boolean表达式，当检查结果为false时抛出 {@code IllegalStateException}。 + * + * 
+	 * Assert.state(id == null, "The id property must not already be initialized");
+	 *
+ * + * @param expression boolean 表达式 + * @param errorMsgTemplate 异常时的消息模板 + * @param params 参数列表 + * @throws IllegalStateException 表达式为 {@code false} 抛出此异常 + */ + public static void state(boolean expression, String errorMsgTemplate, Object... params) throws IllegalStateException { + if (false == expression) { + throw new IllegalStateException(StrUtil.format(errorMsgTemplate, params)); + } + } + + /** + * 检查boolean表达式，当检查结果为false时抛出 {@code IllegalStateException}。 + * + * 
+	 * Assert.state(id == null);
+	 *
+ * + * @param expression boolean 表达式 + * @throws IllegalStateException 表达式为 {@code false} 抛出此异常 + */ + public static void state(boolean expression) throws IllegalStateException { + state(expression, "[Assertion failed] - this state invariant must be true"); + } + + /** + * 检查下标（数组、集合、字符串）是否符合要求，下标必须满足： + * + * 
+	 * 0 ≤ index < size
+	 *
+ * + * @param index 下标 + * @param size 长度 + * @return 检查后的下标 + * @throws IllegalArgumentException 如果size < 0 抛出此异常 + * @throws IndexOutOfBoundsException 如果index < 0或者 index ≥ size 抛出此异常 + * @since 4.1.9 + */ + public static int checkIndex(int index, int size) throws IllegalArgumentException, IndexOutOfBoundsException { + return checkIndex(index, size, "[Assertion failed]"); + } + + /** + * 检查下标（数组、集合、字符串）是否符合要求，下标必须满足： + * + * 
+	 * 0 ≤ index < size
+	 *
+ * + * @param index 下标 + * @param size 长度 + * @param errorMsgTemplate 异常时的消息模板 + * @param params 参数列表 + * @return 检查后的下标 + * @throws IllegalArgumentException 如果size < 0 抛出此异常 + * @throws IndexOutOfBoundsException 如果index < 0或者 index ≥ size 抛出此异常 + * @since 4.1.9 + */ + public static int checkIndex(int index, int size, String errorMsgTemplate, Object... params) throws IllegalArgumentException, IndexOutOfBoundsException { + if (index < 0 || index >= size) { + throw new IndexOutOfBoundsException(badIndexMsg(index, size, errorMsgTemplate, params)); + } + return index; + } + + /** + * 检查值是否在指定范围内 + * + * @param 异常类型 + * @param value 值 + * @param min 最小值（包含） + * @param max 最大值（包含） + * @param errorSupplier 错误抛出异常附带的消息生产接口 + * @return 经过检查后的值 + * @throws X if value is out of bound + * @since 5.7.15 + */ + public static int checkBetween(int value, int min, int max, Supplier errorSupplier) throws X { + if (value < min || value > max) { + throw errorSupplier.get(); + } + + return value; + } + + /** + * 检查值是否在指定范围内 + * + * @param value 值 + * @param min 最小值（包含） + * @param max 最大值（包含） + * @param errorMsgTemplate 异常信息模板，类似于"aa{}bb{}cc" + * @param params 异常信息参数，用于替换"{}"占位符 + * @return 经过检查后的值 + * @since 5.7.15 + */ + public static int checkBetween(int value, int min, int max, String errorMsgTemplate, Object... params) { + return checkBetween(value, min, max, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 检查值是否在指定范围内 + * + * @param value 值 + * @param min 最小值（包含） + * @param max 最大值（包含） + * @return 检查后的长度值 + * @since 4.1.10 + */ + public static int checkBetween(int value, int min, int max) { + return checkBetween(value, min, max, TEMPLATE_VALUE_MUST_BE_BETWEEN_AND, min, max); + } + + /** + * 检查值是否在指定范围内 + * + * @param 异常类型 + * @param value 值 + * @param min 最小值（包含） + * @param max 最大值（包含） + * @param errorSupplier 错误抛出异常附带的消息生产接口 + * @return 经过检查后的值 + * @throws X if value is out of bound + * @since 5.7.15 + */ + public static long checkBetween(long value, long min, long max, Supplier errorSupplier) throws X { + if (value < min || value > max) { + throw errorSupplier.get(); + } + + return value; + } + + /** + * 检查值是否在指定范围内 + * + * @param value 值 + * @param min 最小值（包含） + * @param max 最大值（包含） + * @param errorMsgTemplate 异常信息模板，类似于"aa{}bb{}cc" + * @param params 异常信息参数，用于替换"{}"占位符 + * @return 经过检查后的值 + * @since 5.7.15 + */ + public static long checkBetween(long value, long min, long max, String errorMsgTemplate, Object... params) { + return checkBetween(value, min, max, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 检查值是否在指定范围内 + * + * @param value 值 + * @param min 最小值（包含） + * @param max 最大值（包含） + * @return 检查后的长度值 + * @since 4.1.10 + */ + public static long checkBetween(long value, long min, long max) { + return checkBetween(value, min, max, TEMPLATE_VALUE_MUST_BE_BETWEEN_AND, min, max); + } + + /** + * 检查值是否在指定范围内 + * + * @param 异常类型 + * @param value 值 + * @param min 最小值（包含） + * @param max 最大值（包含） + * @param errorSupplier 错误抛出异常附带的消息生产接口 + * @return 经过检查后的值 + * @throws X if value is out of bound + * @since 5.7.15 + */ + public static double checkBetween(double value, double min, double max, Supplier errorSupplier) throws X { + if (value < min || value > max) { + throw errorSupplier.get(); + } + + return value; + } + + /** + * 检查值是否在指定范围内 + * + * @param value 值 + * @param min 最小值（包含） + * @param max 最大值（包含） + * @param errorMsgTemplate 异常信息模板，类似于"aa{}bb{}cc" + * @param params 异常信息参数，用于替换"{}"占位符 + * @return 经过检查后的值 + * @since 5.7.15 + */ + public static double checkBetween(double value, double min, double max, String errorMsgTemplate, Object... params) { + return checkBetween(value, min, max, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 检查值是否在指定范围内 + * + * @param value 值 + * @param min 最小值（包含） + * @param max 最大值（包含） + * @return 检查后的长度值 + * @since 4.1.10 + */ + public static double checkBetween(double value, double min, double max) { + return checkBetween(value, min, max, TEMPLATE_VALUE_MUST_BE_BETWEEN_AND, min, max); + } + + /** + * 检查值是否在指定范围内 + * + * @param value 值 + * @param min 最小值（包含） + * @param max 最大值（包含） + * @return 检查后的长度值 + * @since 4.1.10 + */ + public static Number checkBetween(Number value, Number min, Number max) { + notNull(value); + notNull(min); + notNull(max); + double valueDouble = value.doubleValue(); + double minDouble = min.doubleValue(); + double maxDouble = max.doubleValue(); + if (valueDouble < minDouble || valueDouble > maxDouble) { + throw new IllegalArgumentException(StrUtil.format(TEMPLATE_VALUE_MUST_BE_BETWEEN_AND, min, max)); + } + return value; + } + + /** + * 断言两个对象是否不相等,如果两个对象相等 抛出IllegalArgumentException 异常 + * 
+	 *   Assert.notEquals(obj1,obj2);
+	 *
+ * + * @param obj1 对象1 + * @param obj2 对象2 + * @throws IllegalArgumentException obj1 must be not equals obj2 + */ + public static void notEquals(Object obj1, Object obj2) { + notEquals(obj1, obj2, "({}) must be not equals ({})", obj1, obj2); + } + + /** + * 断言两个对象是否不相等,如果两个对象相等 抛出IllegalArgumentException 异常 + * 
+	 *   Assert.notEquals(obj1,obj2,"obj1 must be not equals obj2");
+	 *
+ * + * @param obj1 对象1 + * @param obj2 对象2 + * @param errorMsgTemplate 异常信息模板，类似于"aa{}bb{}cc" + * @param params 异常信息参数，用于替换"{}"占位符 + * @throws IllegalArgumentException obj1 must be not equals obj2 + */ + public static void notEquals(Object obj1, Object obj2, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + notEquals(obj1, obj2, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 断言两个对象是否不相等,如果两个对象相等,抛出指定类型异常,并使用指定的函数获取错误信息返回 + * + * @param obj1 对象1 + * @param obj2 对象2 + * @param errorSupplier 错误抛出异常附带的消息生产接口 + * @param 异常类型 + * @throws X obj1 must be not equals obj2 + */ + public static void notEquals(Object obj1, Object obj2, Supplier errorSupplier) throws X { + if (ObjectUtil.equals(obj1, obj2)) { + throw errorSupplier.get(); + } + } + // ----------------------------------------------------------------------------------------------------------- Check not equals + + /** + * 断言两个对象是否相等,如果两个对象不相等 抛出IllegalArgumentException 异常 + * 
+	 *   Assert.isEquals(obj1,obj2);
+	 *
+ * + * @param obj1 对象1 + * @param obj2 对象2 + * @throws IllegalArgumentException obj1 must be equals obj2 + */ + public static void equals(Object obj1, Object obj2) { + equals(obj1, obj2, "({}) must be equals ({})", obj1, obj2); + } + + /** + * 断言两个对象是否相等,如果两个对象不相等 抛出IllegalArgumentException 异常 + * 
+	 *   Assert.isEquals(obj1,obj2,"obj1 must be equals obj2");
+	 *
+ * + * @param obj1 对象1 + * @param obj2 对象2 + * @param errorMsgTemplate 异常信息模板，类似于"aa{}bb{}cc" + * @param params 异常信息参数，用于替换"{}"占位符 + * @throws IllegalArgumentException obj1 must be equals obj2 + */ + public static void equals(Object obj1, Object obj2, String errorMsgTemplate, Object... params) throws IllegalArgumentException { + equals(obj1, obj2, () -> new IllegalArgumentException(StrUtil.format(errorMsgTemplate, params))); + } + + /** + * 断言两个对象是否相等,如果两个对象不相等,抛出指定类型异常,并使用指定的函数获取错误信息返回 + * + * @param obj1 对象1 + * @param obj2 对象2 + * @param errorSupplier 错误抛出异常附带的消息生产接口 + * @param 异常类型 + * @throws X obj1 must be equals obj2 + */ + public static void equals(Object obj1, Object obj2, Supplier errorSupplier) throws X { + if (ObjectUtil.notEqual(obj1, obj2)) { + throw errorSupplier.get(); + } + } + + // ----------------------------------------------------------------------------------------------------------- Check is equals + + // -------------------------------------------------------------------------------------------------------------------------------------------- Private method start + + /** + * 错误的下标时显示的消息 + * + * @param index 下标 + * @param size 长度 + * @param desc 异常时的消息模板 + * @param params 参数列表 + * @return 消息 + */ + private static String badIndexMsg(int index, int size, String desc, Object... params) { + if (index < 0) { + return StrUtil.format("{} ({}) must not be negative", StrUtil.format(desc, params), index); + } else if (size < 0) { + throw new IllegalArgumentException("negative size: " + size); + } else { // index >= size + return StrUtil.format("{} ({}) must be less than size ({})", StrUtil.format(desc, params), index, size); + } + } + // -------------------------------------------------------------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Chain.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Chain.java new file mode 100644 index 0000000..8908139 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Chain.java @@ -0,0 +1,17 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +/** + * 责任链接口 + * @author Looly + * + * @param 元素类型 + * @param 目标类类型，用于返回this对象 + */ +public interface Chain extends Iterable{ + /** + * 加入责任链 + * @param element 责任链新的环节元素 + * @return this + */ + T addChain(E element); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ClassScanner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ClassScanner.java new file mode 100755 index 0000000..0bfd693 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ClassScanner.java @@ -0,0 +1,460 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.collection.EnumerationIter; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.resource.ResourceUtil; +import aiyh.utils.tool.cn.hutool.core.util.*; + +import java.io.File; +import java.io.IOException; +import java.io.Serializable; +import java.lang.annotation.Annotation; +import java.net.URL; +import java.nio.charset.Charset; +import java.util.Collections; +import java.util.HashSet; +import java.util.Set; +import java.util.jar.JarEntry; +import java.util.jar.JarFile; + +/** + * 类扫描器 + * + * @author looly + * @since 4.6.9 + */ +public class ClassScanner implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * 包名 + */ + private final String packageName; + /** + * 包名，最后跟一个点，表示包名，避免在检查前缀时的歧义
+ * 如果包名指定为空，不跟点 + */ + private final String packageNameWithDot; + /** + * 包路径，用于文件中对路径操作 + */ + private final String packageDirName; + /** + * 包路径，用于jar中对路径操作，在Linux下与packageDirName一致 + */ + private final String packagePath; + /** + * 过滤器 + */ + private final Filter> classFilter; + /** + * 编码 + */ + private final Charset charset; + /** + * 类加载器 + */ + private ClassLoader classLoader; + /** + * 是否初始化类 + */ + private boolean initialize; + /** + * 扫描结果集 + */ + private final Set> classes = new HashSet<>(); + + /** + * 忽略loadClass时的错误 + */ + private boolean ignoreLoadError = false; + + /** + * 获取加载错误的类名列表 + */ + private final Set classesOfLoadError = new HashSet<>(); + + /** + * 扫描指定包路径下所有包含指定注解的类，包括其他加载的jar或者类 + * + * @param packageName 包路径 + * @param annotationClass 注解类 + * @return 类集合 + */ + public static Set> scanAllPackageByAnnotation(String packageName, Class annotationClass) { + return scanAllPackage(packageName, clazz -> clazz.isAnnotationPresent(annotationClass)); + } + + /** + * 扫描指定包路径下所有包含指定注解的类
+ * 如果classpath下已经有类，不再扫描其他加载的jar或者类 + * + * @param packageName 包路径 + * @param annotationClass 注解类 + * @return 类集合 + */ + public static Set> scanPackageByAnnotation(String packageName, Class annotationClass) { + return scanPackage(packageName, clazz -> clazz.isAnnotationPresent(annotationClass)); + } + + /** + * 扫描指定包路径下所有指定类或接口的子类或实现类，不包括指定父类本身，包括其他加载的jar或者类 + * + * @param packageName 包路径 + * @param superClass 父类或接口（不包括） + * @return 类集合 + */ + public static Set> scanAllPackageBySuper(String packageName, Class superClass) { + return scanAllPackage(packageName, clazz -> superClass.isAssignableFrom(clazz) && !superClass.equals(clazz)); + } + + /** + * 扫描指定包路径下所有指定类或接口的子类或实现类，不包括指定父类本身
+ * 如果classpath下已经有类，不再扫描其他加载的jar或者类 + * + * @param packageName 包路径 + * @param superClass 父类或接口（不包括） + * @return 类集合 + */ + public static Set> scanPackageBySuper(String packageName, Class superClass) { + return scanPackage(packageName, clazz -> superClass.isAssignableFrom(clazz) && !superClass.equals(clazz)); + } + + /** + * 扫描该包路径下所有class文件，包括其他加载的jar或者类 + * + * @return 类集合 + * @since 5.7.5 + */ + public static Set> scanAllPackage() { + return scanAllPackage(StrUtil.EMPTY, null); + } + + /** + * 扫描classpath下所有class文件，如果classpath下已经有类，不再扫描其他加载的jar或者类 + * + * @return 类集合 + */ + public static Set> scanPackage() { + return scanPackage(StrUtil.EMPTY, null); + } + + /** + * 扫描该包路径下所有class文件 + * + * @param packageName 包路径 com | com. | com.abs | com.abs. + * @return 类集合 + */ + public static Set> scanPackage(String packageName) { + return scanPackage(packageName, null); + } + + /** + * 扫描包路径下和所有在classpath中加载的类，满足class过滤器条件的所有class文件，
+ * 如果包路径为 com.abs + A.class 但是输入 abs会产生classNotFoundException
+ * 因为className 应该为 com.abs.A 现在却成为abs.A,此工具类对该异常进行忽略处理
+ * + * @param packageName 包路径 com | com. | com.abs | com.abs. + * @param classFilter class过滤器，过滤掉不需要的class + * @return 类集合 + * @since 5.7.5 + */ + public static Set> scanAllPackage(String packageName, Filter> classFilter) { + return new ClassScanner(packageName, classFilter).scan(true); + } + + /** + * 扫描包路径下满足class过滤器条件的所有class文件，
+ * 如果包路径为 com.abs + A.class 但是输入 abs会产生classNotFoundException
+ * 因为className 应该为 com.abs.A 现在却成为abs.A,此工具类对该异常进行忽略处理
+ * + * @param packageName 包路径 com | com. | com.abs | com.abs. + * @param classFilter class过滤器，过滤掉不需要的class + * @return 类集合 + */ + public static Set> scanPackage(String packageName, Filter> classFilter) { + return new ClassScanner(packageName, classFilter).scan(); + } + + /** + * 构造，默认UTF-8编码 + */ + public ClassScanner() { + this(null); + } + + /** + * 构造，默认UTF-8编码 + * + * @param packageName 包名，所有包传入""或者null + */ + public ClassScanner(String packageName) { + this(packageName, null); + } + + /** + * 构造，默认UTF-8编码 + * + * @param packageName 包名，所有包传入""或者null + * @param classFilter 过滤器，无需传入null + */ + public ClassScanner(String packageName, Filter> classFilter) { + this(packageName, classFilter, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 构造 + * + * @param packageName 包名，所有包传入""或者null + * @param classFilter 过滤器，无需传入null + * @param charset 编码 + */ + public ClassScanner(String packageName, Filter> classFilter, Charset charset) { + packageName = StrUtil.nullToEmpty(packageName); + this.packageName = packageName; + this.packageNameWithDot = StrUtil.addSuffixIfNot(packageName, StrUtil.DOT); + this.packageDirName = packageName.replace(CharUtil.DOT, File.separatorChar); + this.packagePath = packageName.replace(CharUtil.DOT, CharUtil.SLASH); + this.classFilter = classFilter; + this.charset = charset; + } + + /** + * 设置是否忽略loadClass时的错误 + * + * @param ignoreLoadError 忽略loadClass时的错误 + * @return this + */ + public ClassScanner setIgnoreLoadError(boolean ignoreLoadError) { + this.ignoreLoadError = ignoreLoadError; + return this; + } + + /** + * 扫描包路径下满足class过滤器条件的所有class文件
+ * 此方法首先扫描指定包名下的资源目录，如果未扫描到，则扫描整个classpath中所有加载的类 + * + * @return 类集合 + */ + public Set> scan() { + return scan(false); + } + + /** + * 扫描包路径下满足class过滤器条件的所有class文件 + * + * @param forceScanJavaClassPaths 是否强制扫描其他位于classpath关联jar中的类 + * @return 类集合 + * @since 5.7.5 + */ + public Set> scan(boolean forceScanJavaClassPaths) { + + //多次扫描时,清理上次扫描历史 + this.classes.clear(); + this.classesOfLoadError.clear(); + + for (URL url : ResourceUtil.getResourceIter(this.packagePath, this.classLoader)) { + switch (url.getProtocol()) { + case "file": + scanFile(new File(URLUtil.decode(url.getFile(), this.charset.name())), null); + break; + case "jar": + scanJar(URLUtil.getJarFile(url)); + break; + } + } + + // classpath下未找到，则扫描其他jar包下的类 + if (forceScanJavaClassPaths || CollUtil.isEmpty(this.classes)) { + scanJavaClassPaths(); + } + + return Collections.unmodifiableSet(this.classes); + } + + /** + * 设置是否在扫描到类时初始化类 + * + * @param initialize 是否初始化类 + */ + public void setInitialize(boolean initialize) { + this.initialize = initialize; + } + + /** + * 设置自定义的类加载器 + * + * @param classLoader 类加载器 + * @since 4.6.9 + */ + public void setClassLoader(ClassLoader classLoader) { + this.classLoader = classLoader; + } + + /** + * 忽略加载错误扫描后，可以获得之前扫描时加载错误的类名字集合 + */ + public Set getClassesOfLoadError() { + return Collections.unmodifiableSet(this.classesOfLoadError); + } + + // --------------------------------------------------------------------------------------------------- Private method start + + @Override + protected Object clone() throws CloneNotSupportedException { + return super.clone(); + } + + /** + * 扫描Java指定的ClassPath路径 + */ + private void scanJavaClassPaths() { + final String[] javaClassPaths = ClassUtil.getJavaClassPaths(); + for (String classPath : javaClassPaths) { + // bug修复，由于路径中空格和中文导致的Jar找不到 + classPath = URLUtil.decode(classPath, CharsetUtil.systemCharsetName()); + + scanFile(new File(classPath), null); + } + } + + /** + * 扫描文件或目录中的类 + * + * @param file 文件或目录 + * @param rootDir 包名对应classpath绝对路径 + */ + private void scanFile(File file, String rootDir) { + if (file.isFile()) { + final String fileName = file.getAbsolutePath(); + if (fileName.endsWith(FileUtil.CLASS_EXT)) { + final String className = fileName// + // 8为classes长度，fileName.length() - 6为".class"的长度 + .substring(rootDir.length(), fileName.length() - 6)// + .replace(File.separatorChar, CharUtil.DOT);// + //加入满足条件的类 + addIfAccept(className); + } else if (fileName.endsWith(FileUtil.JAR_FILE_EXT)) { + try { + scanJar(new JarFile(file)); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + } else if (file.isDirectory()) { + final File[] files = file.listFiles(); + if (null != files) { + for (File subFile : files) { + scanFile(subFile, (null == rootDir) ? subPathBeforePackage(file) : rootDir); + } + } + } + } + + /** + * 扫描jar包 + * + * @param jar jar包 + */ + private void scanJar(JarFile jar) { + String name; + for (JarEntry entry : new EnumerationIter<>(jar.entries())) { + name = StrUtil.removePrefix(entry.getName(), StrUtil.SLASH); + if (StrUtil.isEmpty(packagePath) || name.startsWith(this.packagePath)) { + if (name.endsWith(FileUtil.CLASS_EXT) && false == entry.isDirectory()) { + final String className = name// + .substring(0, name.length() - 6)// + .replace(CharUtil.SLASH, CharUtil.DOT);// + addIfAccept(loadClass(className)); + } + } + } + } + + /** + * 加载类 + * + * @param className 类名 + * @return 加载的类 + */ + protected Class loadClass(String className) { + ClassLoader loader = this.classLoader; + if (null == loader) { + loader = ClassLoaderUtil.getClassLoader(); + this.classLoader = loader; + } + + Class clazz = null; + try { + clazz = Class.forName(className, this.initialize, loader); + } catch (NoClassDefFoundError | ClassNotFoundException e) { + // 由于依赖库导致的类无法加载，直接跳过此类 + classesOfLoadError.add(className); + } catch (UnsupportedClassVersionError e) { + // 版本导致的不兼容的类，跳过 + classesOfLoadError.add(className); + } catch (Throwable e) { + if (false == this.ignoreLoadError) { + throw new RuntimeException(e); + } else { + classesOfLoadError.add(className); + } + } + return clazz; + } + + /** + * 通过过滤器，是否满足接受此类的条件 + * + * @param className 类名 + */ + private void addIfAccept(String className) { + if (StrUtil.isBlank(className)) { + return; + } + int classLen = className.length(); + int packageLen = this.packageName.length(); + if (classLen == packageLen) { + //类名和包名长度一致，用户可能传入的包名是类名 + if (className.equals(this.packageName)) { + addIfAccept(loadClass(className)); + } + } else if (classLen > packageLen) { + //检查类名是否以指定包名为前缀，包名后加.（避免类似于cn.hutool.A和cn.hutool.ATest这类类名引起的歧义） + if (".".equals(this.packageNameWithDot) || className.startsWith(this.packageNameWithDot)) { + addIfAccept(loadClass(className)); + } + } + } + + /** + * 通过过滤器，是否满足接受此类的条件 + * + * @param clazz 类 + */ + private void addIfAccept(Class clazz) { + if (null != clazz) { + Filter> classFilter = this.classFilter; + if (classFilter == null || classFilter.accept(clazz)) { + this.classes.add(clazz); + } + } + } + + /** + * 截取文件绝对路径中包名之前的部分 + * + * @param file 文件 + * @return 包名之前的部分 + */ + private String subPathBeforePackage(File file) { + String filePath = file.getAbsolutePath(); + if (StrUtil.isNotEmpty(this.packageDirName)) { + filePath = StrUtil.subBefore(filePath, this.packageDirName, true); + } + return StrUtil.addSuffixIfNot(filePath, File.separator); + } + // --------------------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ConsistentHash.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ConsistentHash.java new file mode 100755 index 0000000..49d04be --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ConsistentHash.java @@ -0,0 +1,101 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.lang.hash.Hash32; +import aiyh.utils.tool.cn.hutool.core.util.HashUtil; + +import java.io.Serializable; +import java.util.Collection; +import java.util.SortedMap; +import java.util.TreeMap; + +/** + * 一致性Hash算法 + * 算法详解：http://blog.csdn.net/sparkliang/article/details/5279393 + * 算法实现：https://weblogs.java.net/blog/2007/11/27/consistent-hashing + * @author xiaoleilu + * + * @param 节点类型 + */ +public class ConsistentHash implements Serializable{ + private static final long serialVersionUID = 1L; + + /** Hash计算对象，用于自定义hash算法 */ + Hash32 hashFunc; + /** 复制的节点个数 */ + private final int numberOfReplicas; + /** 一致性Hash环 */ + private final SortedMap circle = new TreeMap<>(); + + /** + * 构造，使用Java默认的Hash算法 + * @param numberOfReplicas 复制的节点个数，增加每个节点的复制节点有利于负载均衡 + * @param nodes 节点对象 + */ + public ConsistentHash(int numberOfReplicas, Collection nodes) { + this.numberOfReplicas = numberOfReplicas; + this.hashFunc = key -> { + //默认使用FNV1hash算法 + return HashUtil.fnvHash(key.toString()); + }; + //初始化节点 + for (T node : nodes) { + add(node); + } + } + + /** + * 构造 + * @param hashFunc hash算法对象 + * @param numberOfReplicas 复制的节点个数，增加每个节点的复制节点有利于负载均衡 + * @param nodes 节点对象 + */ + public ConsistentHash(Hash32 hashFunc, int numberOfReplicas, Collection nodes) { + this.numberOfReplicas = numberOfReplicas; + this.hashFunc = hashFunc; + //初始化节点 + for (T node : nodes) { + add(node); + } + } + + /** + * 增加节点
+ * 每增加一个节点，就会在闭环上增加给定复制节点数
+ * 例如复制节点数是2，则每调用此方法一次，增加两个虚拟节点，这两个节点指向同一Node + * 由于hash算法会调用node的toString方法，故按照toString去重 + * @param node 节点对象 + */ + public void add(T node) { + for (int i = 0; i < numberOfReplicas; i++) { + circle.put(hashFunc.hash32(node.toString() + i), node); + } + } + + /** + * 移除节点的同时移除相应的虚拟节点 + * @param node 节点对象 + */ + public void remove(T node) { + for (int i = 0; i < numberOfReplicas; i++) { + circle.remove(hashFunc.hash32(node.toString() + i)); + } + } + + /** + * 获得一个最近的顺时针节点 + * @param key 为给定键取Hash，取得顺时针方向上最近的一个虚拟节点对应的实际节点 + * @return 节点对象 + */ + public T get(Object key) { + if (circle.isEmpty()) { + return null; + } + int hash = hashFunc.hash32(key); + if (false == circle.containsKey(hash)) { + SortedMap tailMap = circle.tailMap(hash); //返回此映射的部分视图，其键大于等于 hash + hash = tailMap.isEmpty() ? circle.firstKey() : tailMap.firstKey(); + } + //正好命中 + return circle.get(hash); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Console.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Console.java new file mode 100644 index 0000000..033e67f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Console.java @@ -0,0 +1,331 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.Scanner; + +import static java.lang.System.err; +import static java.lang.System.out; + +/** + * 命令行（控制台）工具方法类
+ * 此类主要针对{@link System#out} 和 {@link System#err} 做封装。 + * + * @author Looly + */ + +public class Console { + + private static final String TEMPLATE_VAR = "{}"; + + // --------------------------------------------------------------------------------- Log + + /** + * 同 System.out.println()方法，打印控制台日志 + */ + public static void log() { + out.println(); + } + + /** + * 同 System.out.println()方法，打印控制台日志
+ * 如果传入打印对象为{@link Throwable}对象，那么同时打印堆栈 + * + * @param obj 要打印的对象 + */ + public static void log(Object obj) { + if (obj instanceof Throwable) { + final Throwable e = (Throwable) obj; + log(e, e.getMessage()); + } else { + log(TEMPLATE_VAR, obj); + } + } + + /** + * 同 System.out.println()方法，打印控制台日志
+ * 如果传入打印对象为{@link Throwable}对象，那么同时打印堆栈 + * + * @param obj1 第一个要打印的对象 + * @param otherObjs 其它要打印的对象 + * @since 5.4.3 + */ + public static void log(Object obj1, Object... otherObjs) { + if (ArrayUtil.isEmpty(otherObjs)) { + log(obj1); + } else { + log(buildTemplateSplitBySpace(otherObjs.length + 1), ArrayUtil.insert(otherObjs, 0, obj1)); + } + } + + /** + * 同 System.out.println()方法，打印控制台日志
+ * 当传入template无"{}"时，被认为非模板，直接打印多个参数以空格分隔 + * + * @param template 文本模板，被替换的部分用 {} 表示 + * @param values 值 + */ + public static void log(String template, Object... values) { + if (ArrayUtil.isEmpty(values) || StrUtil.contains(template, TEMPLATE_VAR)) { + logInternal(template, values); + } else { + logInternal(buildTemplateSplitBySpace(values.length + 1), ArrayUtil.insert(values, 0, template)); + } + } + + /** + * 同 System.out.println()方法，打印控制台日志 + * + * @param t 异常对象 + * @param template 文本模板，被替换的部分用 {} 表示 + * @param values 值 + */ + public static void log(Throwable t, String template, Object... values) { + out.println(StrUtil.format(template, values)); + if (null != t) { + //noinspection CallToPrintStackTrace + t.printStackTrace(out); + out.flush(); + } + } + + /** + * 同 System.out.println()方法，打印控制台日志 + * + * @param template 文本模板，被替换的部分用 {} 表示 + * @param values 值 + * @since 5.4.3 + */ + private static void logInternal(String template, Object... values) { + log(null, template, values); + } + + // --------------------------------------------------------------------------------- print + + /** + * 打印表格到控制台 + * + * @param consoleTable 控制台表格 + * @since 5.4.5 + */ + public static void table(ConsoleTable consoleTable) { + print(consoleTable.toString()); + } + + /** + * 同 System.out.print()方法，打印控制台日志 + * + * @param obj 要打印的对象 + * @since 3.3.1 + */ + public static void print(Object obj) { + print(TEMPLATE_VAR, obj); + } + + /** + * 同 System.out.println()方法，打印控制台日志
+ * 如果传入打印对象为{@link Throwable}对象，那么同时打印堆栈 + * + * @param obj1 第一个要打印的对象 + * @param otherObjs 其它要打印的对象 + * @since 5.4.3 + */ + public static void print(Object obj1, Object... otherObjs) { + if (ArrayUtil.isEmpty(otherObjs)) { + print(obj1); + } else { + print(buildTemplateSplitBySpace(otherObjs.length + 1), ArrayUtil.insert(otherObjs, 0, obj1)); + } + } + + /** + * 同 System.out.print()方法，打印控制台日志 + * + * @param template 文本模板，被替换的部分用 {} 表示 + * @param values 值 + * @since 3.3.1 + */ + public static void print(String template, Object... values) { + if (ArrayUtil.isEmpty(values) || StrUtil.contains(template, TEMPLATE_VAR)) { + printInternal(template, values); + } else { + printInternal(buildTemplateSplitBySpace(values.length + 1), ArrayUtil.insert(values, 0, template)); + } + } + + /** + * 打印进度条 + * + * @param showChar 进度条提示字符，例如“#” + * @param len 打印长度 + * @since 4.5.6 + */ + public static void printProgress(char showChar, int len) { + print("{}{}", CharUtil.CR, StrUtil.repeat(showChar, len)); + } + + /** + * 打印进度条 + * + * @param showChar 进度条提示字符，例如“#” + * @param totalLen 总长度 + * @param rate 总长度所占比取值0~1 + * @since 4.5.6 + */ + public static void printProgress(char showChar, int totalLen, double rate) { + Assert.isTrue(rate >= 0 && rate <= 1, "Rate must between 0 and 1 (both include)"); + printProgress(showChar, (int) (totalLen * rate)); + } + + /** + * 同 System.out.println()方法，打印控制台日志 + * + * @param template 文本模板，被替换的部分用 {} 表示 + * @param values 值 + * @since 5.4.3 + */ + private static void printInternal(String template, Object... values) { + out.print(StrUtil.format(template, values)); + } + + // --------------------------------------------------------------------------------- Error + + /** + * 同 System.err.println()方法，打印控制台日志 + */ + public static void error() { + err.println(); + } + + /** + * 同 System.err.println()方法，打印控制台日志 + * + * @param obj 要打印的对象 + */ + public static void error(Object obj) { + if (obj instanceof Throwable) { + Throwable e = (Throwable) obj; + error(e, e.getMessage()); + } else { + error(TEMPLATE_VAR, obj); + } + } + + /** + * 同 System.out.println()方法，打印控制台日志
+ * 如果传入打印对象为{@link Throwable}对象，那么同时打印堆栈 + * + * @param obj1 第一个要打印的对象 + * @param otherObjs 其它要打印的对象 + * @since 5.4.3 + */ + public static void error(Object obj1, Object... otherObjs) { + if (ArrayUtil.isEmpty(otherObjs)) { + error(obj1); + } else { + error(buildTemplateSplitBySpace(otherObjs.length + 1), ArrayUtil.insert(otherObjs, 0, obj1)); + } + } + + /** + * 同 System.err.println()方法，打印控制台日志 + * + * @param template 文本模板，被替换的部分用 {} 表示 + * @param values 值 + */ + public static void error(String template, Object... values) { + if (ArrayUtil.isEmpty(values) || StrUtil.contains(template, TEMPLATE_VAR)) { + errorInternal(template, values); + } else { + errorInternal(buildTemplateSplitBySpace(values.length + 1), ArrayUtil.insert(values, 0, template)); + } + } + + /** + * 同 System.err.println()方法，打印控制台日志 + * + * @param t 异常对象 + * @param template 文本模板，被替换的部分用 {} 表示 + * @param values 值 + */ + public static void error(Throwable t, String template, Object... values) { + err.println(StrUtil.format(template, values)); + if (null != t) { + t.printStackTrace(err); + err.flush(); + } + } + + /** + * 同 System.err.println()方法，打印控制台日志 + * + * @param template 文本模板，被替换的部分用 {} 表示 + * @param values 值 + */ + private static void errorInternal(String template, Object... values) { + error(null, template, values); + } + + // --------------------------------------------------------------------------------- in + + /** + * 创建从控制台读取内容的{@link Scanner} + * + * @return {@link Scanner} + * @since 3.3.1 + */ + public static Scanner scanner() { + return new Scanner(System.in); + } + + /** + * 读取用户输入的内容（在控制台敲回车前的内容） + * + * @return 用户输入的内容 + * @since 3.3.1 + */ + public static String input() { + return scanner().nextLine(); + } + + // --------------------------------------------------------------------------------- console lineNumber + + /** + * 返回当前位置+行号 (不支持Lambda、内部类、递归内使用) + * + * @return 返回当前行号 + * @author dahuoyzs + * @since 5.2.5 + */ + public static String where() { + final StackTraceElement stackTraceElement = new Throwable().getStackTrace()[1]; + final String className = stackTraceElement.getClassName(); + final String methodName = stackTraceElement.getMethodName(); + final String fileName = stackTraceElement.getFileName(); + final Integer lineNumber = stackTraceElement.getLineNumber(); + return String.format("%s.%s(%s:%s)", className, methodName, fileName, lineNumber); + } + + /** + * 返回当前行号 (不支持Lambda、内部类、递归内使用) + * + * @return 返回当前行号 + * @since 5.2.5 + */ + public static Integer lineNumber() { + return new Throwable().getStackTrace()[1].getLineNumber(); + } + + /** + * 构建空格分隔的模板，类似于"{} {} {} {}" + * + * @param count 变量数量 + * @return 模板 + */ + private static String buildTemplateSplitBySpace(int count) { + return StrUtil.repeatAndJoin(TEMPLATE_VAR, count, StrUtil.SPACE); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ConsoleTable.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ConsoleTable.java new file mode 100644 index 0000000..9a7021b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ConsoleTable.java @@ -0,0 +1,206 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +/** + * 控制台打印表格工具 + * + * @author 孙宇 + * @since 5.4.4 + */ +public class ConsoleTable { + + private static final char ROW_LINE = '－'; + private static final char COLUMN_LINE = '|'; + private static final char CORNER = '+'; + private static final char SPACE = '\u3000'; + private static final char LF = CharUtil.LF; + + private boolean isSBCMode = true; + + /** + * 创建ConsoleTable对象 + * + * @return ConsoleTable + * @since 5.4.5 + */ + public static ConsoleTable create() { + return new ConsoleTable(); + } + + /** + * 表格头信息 + */ + private final List> headerList = new ArrayList<>(); + /** + * 表格体信息 + */ + private final List> bodyList = new ArrayList<>(); + /** + * 每列最大字符个数 + */ + private List columnCharNumber; + + /** + * 设置是否使用全角模式
+ * 当包含中文字符时，输出的表格可能无法对齐，因此当设置为全角模式时，全部字符转为全角。 + * + * @param isSBCMode 是否全角模式 + * @return this + * @since 5.8.0 + */ + public ConsoleTable setSBCMode(boolean isSBCMode) { + this.isSBCMode = isSBCMode; + return this; + } + + /** + * 添加头信息 + * + * @param titles 列名 + * @return 自身对象 + */ + public ConsoleTable addHeader(String... titles) { + if (columnCharNumber == null) { + columnCharNumber = new ArrayList<>(Collections.nCopies(titles.length, 0)); + } + List l = new ArrayList<>(); + fillColumns(l, titles); + headerList.add(l); + return this; + } + + /** + * 添加体信息 + * + * @param values 列值 + * @return 自身对象 + */ + public ConsoleTable addBody(String... values) { + List l = new ArrayList<>(); + bodyList.add(l); + fillColumns(l, values); + return this; + } + + /** + * 填充表格头或者体 + * + * @param l 被填充列表 + * @param columns 填充内容 + */ + private void fillColumns(List l, String[] columns) { + for (int i = 0; i < columns.length; i++) { + String column = columns[i]; + if (isSBCMode) { + column = Convert.toSBC(column); + } + l.add(column); + int width = column.length(); + if (width > columnCharNumber.get(i)) { + columnCharNumber.set(i, width); + } + } + } + + /** + * 获取表格字符串 + * + * @return 表格字符串 + */ + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + fillBorder(sb); + fillRows(sb, headerList); + fillBorder(sb); + fillRows(sb, bodyList); + fillBorder(sb); + return sb.toString(); + } + + /** + * 填充表头或者表体信息（多行） + * + * @param sb 内容 + * @param list 表头列表或者表体列表 + */ + private void fillRows(StringBuilder sb, List> list) { + for (List row : list) { + sb.append(COLUMN_LINE); + fillRow(sb, row); + sb.append(LF); + } + } + + /** + * 填充一行数据 + * + * @param sb 内容 + * @param row 一行数据 + */ + private void fillRow(StringBuilder sb, List row) { + final int size = row.size(); + String value; + for (int i = 0; i < size; i++) { + value = row.get(i); + sb.append(SPACE); + sb.append(value); + final int length = value.length(); + final int sbcCount = sbcCount(value); + if(sbcCount % 2 == 1){ + sb.append(CharUtil.SPACE); + } + sb.append(SPACE); + int maxLength = columnCharNumber.get(i); + for (int j = 0; j < (maxLength - length + (sbcCount / 2)); j++) { + sb.append(SPACE); + } + sb.append(COLUMN_LINE); + } + } + + /** + * 拼装边框 + * + * @param sb StringBuilder + */ + private void fillBorder(StringBuilder sb) { + sb.append(CORNER); + for (Integer width : columnCharNumber) { + sb.append(StrUtil.repeat(ROW_LINE, width + 2)); + sb.append(CORNER); + } + sb.append(LF); + } + + /** + * 打印到控制台 + */ + public void print() { + Console.print(toString()); + } + + /** + * 半角字符数量 + * + * @param value 字符串 + * @return 填充空格数量 + */ + private int sbcCount(String value) { + int count = 0; + for (int i = 0; i < value.length(); i++) { + if (value.charAt(i) < '\177') { + count++; + } + } + + return count; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/DefaultSegment.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/DefaultSegment.java new file mode 100644 index 0000000..be6e578 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/DefaultSegment.java @@ -0,0 +1,34 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +/** + * 片段默认实现 + * + * @param 数字类型，用于表示位置index + * @author looly + * @since 5.5.3 + */ +public class DefaultSegment implements Segment { + + protected T startIndex; + protected T endIndex; + + /** + * 构造 + * @param startIndex 起始位置 + * @param endIndex 结束位置 + */ + public DefaultSegment(T startIndex, T endIndex) { + this.startIndex = startIndex; + this.endIndex = endIndex; + } + + @Override + public T getStartIndex() { + return this.startIndex; + } + + @Override + public T getEndIndex() { + return this.endIndex; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Dict.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Dict.java new file mode 100755 index 0000000..51c6885 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Dict.java @@ -0,0 +1,680 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanPath; +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.getter.BasicTypeGetter; +import aiyh.utils.tool.cn.hutool.core.lang.func.Func0; +import aiyh.utils.tool.cn.hutool.core.lang.func.LambdaUtil; + +import java.math.BigDecimal; +import java.math.BigInteger; +import java.sql.Time; +import java.sql.Timestamp; +import java.util.Arrays; +import java.util.Date; +import java.util.HashMap; +import java.util.HashSet; +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.Objects; +import java.util.function.BiFunction; +import java.util.function.Function; + +/** + * 字典对象，扩充了HashMap中的方法 + * + * @author loolly + */ +public class Dict extends LinkedHashMap implements BasicTypeGetter { + private static final long serialVersionUID = 6135423866861206530L; + + static final float DEFAULT_LOAD_FACTOR = 0.75f; + static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16 + + /** + * 是否大小写不敏感 + */ + private boolean caseInsensitive; + + // --------------------------------------------------------------- Static method start + + /** + * 创建Dict + * + * @return Dict + */ + public static Dict create() { + return new Dict(); + } + + /** + * 将PO对象转为Dict + * + * @param Bean类型 + * @param bean Bean对象 + * @return Vo + */ + public static Dict parse(T bean) { + return create().parseBean(bean); + } + + /** + * 根据给定的Pair数组创建Dict对象 + * + * @param pairs 键值对 + * @return Dict + * @since 5.4.1 + */ + @SafeVarargs + public static Dict of(Pair... pairs) { + final Dict dict = create(); + for (Pair pair : pairs) { + dict.put(pair.getKey(), pair.getValue()); + } + return dict; + } + + /** + * 根据给定的键值对数组创建Dict对象，传入参数必须为key,value,key,value... + * + *

奇数参数必须为key，key最后会转换为String类型。

+ *

偶数参数必须为value，可以为任意类型。

+ * + * 
+	 * Dict dict = Dict.of(
+	 * 	"RED", "#FF0000",
+	 * 	"GREEN", "#00FF00",
+	 * 	"BLUE", "#0000FF"
+	 * );
+	 *
+ * + * @param keysAndValues 键值对列表，必须奇数参数为key，偶数参数为value + * @return Dict + * @since 5.4.1 + */ + public static Dict of(Object... keysAndValues) { + final Dict dict = create(); + + String key = null; + for (int i = 0; i < keysAndValues.length; i++) { + if (i % 2 == 0) { + key = Convert.toStr(keysAndValues[i]); + } else { + dict.put(key, keysAndValues[i]); + } + } + + return dict; + } + // --------------------------------------------------------------- Static method end + + // --------------------------------------------------------------- Constructor start + + /** + * 构造 + */ + public Dict() { + this(false); + } + + /** + * 构造 + * + * @param caseInsensitive 是否大小写不敏感 + */ + public Dict(boolean caseInsensitive) { + this(DEFAULT_INITIAL_CAPACITY, caseInsensitive); + } + + /** + * 构造 + * + * @param initialCapacity 初始容量 + */ + public Dict(int initialCapacity) { + this(initialCapacity, false); + } + + /** + * 构造 + * + * @param initialCapacity 初始容量 + * @param caseInsensitive 是否大小写不敏感 + */ + public Dict(int initialCapacity, boolean caseInsensitive) { + this(initialCapacity, DEFAULT_LOAD_FACTOR, caseInsensitive); + } + + /** + * 构造 + * + * @param initialCapacity 初始容量 + * @param loadFactor 容量增长因子，0~1，即达到容量的百分之多少时扩容 + */ + public Dict(int initialCapacity, float loadFactor) { + this(initialCapacity, loadFactor, false); + } + + /** + * 构造 + * + * @param initialCapacity 初始容量 + * @param loadFactor 容量增长因子，0~1，即达到容量的百分之多少时扩容 + * @param caseInsensitive 是否大小写不敏感 + * @since 4.5.16 + */ + public Dict(int initialCapacity, float loadFactor, boolean caseInsensitive) { + super(initialCapacity, loadFactor); + this.caseInsensitive = caseInsensitive; + } + + /** + * 构造 + * + * @param m Map + */ + public Dict(Map m) { + super((null == m) ? new HashMap<>() : m); + } + // --------------------------------------------------------------- Constructor end + + /** + * 转换为Bean对象 + * + * @param Bean类型 + * @param bean Bean + * @return Bean + */ + public T toBean(T bean) { + return toBean(bean, false); + } + + /** + * 转换为Bean对象 + * + * @param Bean类型 + * @param bean Bean + * @return Bean + * @since 3.3.1 + */ + public T toBeanIgnoreCase(T bean) { + BeanUtil.fillBeanWithMapIgnoreCase(this, bean, false); + return bean; + } + + /** + * 转换为Bean对象 + * + * @param Bean类型 + * @param bean Bean + * @param isToCamelCase 是否转换为驼峰模式 + * @return Bean + */ + public T toBean(T bean, boolean isToCamelCase) { + BeanUtil.fillBeanWithMap(this, bean, isToCamelCase, false); + return bean; + } + + /** + * 转换为Bean对象,并使用驼峰法模式转换 + * + * @param Bean类型 + * @param bean Bean + * @return Bean + */ + public T toBeanWithCamelCase(T bean) { + BeanUtil.fillBeanWithMap(this, bean, true, false); + return bean; + } + + /** + * 填充Value Object对象 + * + * @param Bean类型 + * @param clazz Value Object（或者POJO）的类 + * @return vo + */ + public T toBean(Class clazz) { + return BeanUtil.toBean(this, clazz); + } + + /** + * 填充Value Object对象，忽略大小写 + * + * @param Bean类型 + * @param clazz Value Object（或者POJO）的类 + * @return vo + */ + public T toBeanIgnoreCase(Class clazz) { + return BeanUtil.toBeanIgnoreCase(this, clazz, false); + } + + /** + * 将值对象转换为Dict
+ * 类名会被当作表名，小写第一个字母 + * + * @param Bean类型 + * @param bean 值对象 + * @return 自己 + */ + public Dict parseBean(T bean) { + Assert.notNull(bean, "Bean class must be not null"); + this.putAll(BeanUtil.beanToMap(bean)); + return this; + } + + /** + * 将值对象转换为Dict
+ * 类名会被当作表名，小写第一个字母 + * + * @param Bean类型 + * @param bean 值对象 + * @param isToUnderlineCase 是否转换为下划线模式 + * @param ignoreNullValue 是否忽略值为空的字段 + * @return 自己 + */ + public Dict parseBean(T bean, boolean isToUnderlineCase, boolean ignoreNullValue) { + Assert.notNull(bean, "Bean class must be not null"); + this.putAll(BeanUtil.beanToMap(bean, isToUnderlineCase, ignoreNullValue)); + return this; + } + + /** + * 与给定实体对比并去除相同的部分
+ * 此方法用于在更新操作时避免所有字段被更新，跳过不需要更新的字段 version from 2.0.0 + * + * @param 字典对象类型 + * @param dict 字典对象 + * @param withoutNames 不需要去除的字段名 + */ + public void removeEqual(T dict, String... withoutNames) { + HashSet withoutSet = CollUtil.newHashSet(withoutNames); + for (Map.Entry entry : dict.entrySet()) { + if (withoutSet.contains(entry.getKey())) { + continue; + } + + final Object value = this.get(entry.getKey()); + if (Objects.equals(value, entry.getValue())) { + this.remove(entry.getKey()); + } + } + } + + /** + * 过滤Map保留指定键值对，如果键不存在跳过 + * + * @param keys 键列表 + * @return Dict 结果 + * @since 4.0.10 + */ + public Dict filter(String... keys) { + final Dict result = new Dict(keys.length, 1); + + for (String key : keys) { + if (this.containsKey(key)) { + result.put(key, this.get(key)); + } + } + return result; + } + + // -------------------------------------------------------------------- Set start + + /** + * 设置列 + * + * @param attr 属性 + * @param value 值 + * @return 本身 + */ + public Dict set(String attr, Object value) { + this.put(attr, value); + return this; + } + + /** + * 设置列，当键或值为null时忽略 + * + * @param attr 属性 + * @param value 值 + * @return 本身 + */ + public Dict setIgnoreNull(String attr, Object value) { + if (null != attr && null != value) { + set(attr, value); + } + return this; + } + // -------------------------------------------------------------------- Set end + + // -------------------------------------------------------------------- Get start + + @Override + public Object getObj(String key) { + return super.get(key); + } + + /** + * 获得特定类型值 + * + * @param 值类型 + * @param attr 字段名 + * @return 字段值 + * @since 4.6.3 + */ + public T getBean(String attr) { + return get(attr, null); + } + + /** + * 获得特定类型值 + * + * @param 值类型 + * @param attr 字段名 + * @param defaultValue 默认值 + * @return 字段值 + */ + @SuppressWarnings("unchecked") + public T get(String attr, T defaultValue) { + final Object result = get(attr); + return (T) (result != null ? result : defaultValue); + } + + /** + * @param attr 字段名 + * @return 字段值 + */ + @Override + public String getStr(String attr) { + return Convert.toStr(get(attr), null); + } + + /** + * @param attr 字段名 + * @return 字段值 + */ + @Override + public Integer getInt(String attr) { + return Convert.toInt(get(attr), null); + } + + /** + * @param attr 字段名 + * @return 字段值 + */ + @Override + public Long getLong(String attr) { + return Convert.toLong(get(attr), null); + } + + /** + * @param attr 字段名 + * @return 字段值 + */ + @Override + public Float getFloat(String attr) { + return Convert.toFloat(get(attr), null); + } + + @Override + public Short getShort(String attr) { + return Convert.toShort(get(attr), null); + } + + @Override + public Character getChar(String attr) { + return Convert.toChar(get(attr), null); + } + + @Override + public Double getDouble(String attr) { + return Convert.toDouble(get(attr), null); + } + + @Override + public Byte getByte(String attr) { + return Convert.toByte(get(attr), null); + } + + /** + * @param attr 字段名 + * @return 字段值 + */ + @Override + public Boolean getBool(String attr) { + return Convert.toBool(get(attr), null); + } + + /** + * @param attr 字段名 + * @return 字段值 + */ + @Override + public BigDecimal getBigDecimal(String attr) { + return Convert.toBigDecimal(get(attr)); + } + + /** + * @param attr 字段名 + * @return 字段值 + */ + @Override + public BigInteger getBigInteger(String attr) { + return Convert.toBigInteger(get(attr)); + } + + @Override + public > E getEnum(Class clazz, String key) { + return Convert.toEnum(clazz, get(key)); + } + + /** + * @param attr 字段名 + * @return 字段值 + */ + public byte[] getBytes(String attr) { + return get(attr, null); + } + + /** + * @param attr 字段名 + * @return 字段值 + */ + @Override + public Date getDate(String attr) { + return get(attr, null); + } + + /** + * @param attr 字段名 + * @return 字段值 + */ + public Time getTime(String attr) { + return get(attr, null); + } + + /** + * @param attr 字段名 + * @return 字段值 + */ + public Timestamp getTimestamp(String attr) { + return get(attr, null); + } + + /** + * @param attr 字段名 + * @return 字段值 + */ + public Number getNumber(String attr) { + return get(attr, null); + } + + /** + * 通过表达式获取JSON中嵌套的对象
+ *
    + *
  1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. + *
  2. []表达式，可以获取集合等对象中对应index的值
    3. + *
+ *

+ * 表达式栗子： + * + * 

+	 * persion
+	 * persion.name
+	 * persons[3]
+	 * person.friends[5].name
+	 *
+ * + * @param 目标类型 + * @param expression 表达式 + * @return 对象 + * @see BeanPath#get(Object) + * @since 5.7.14 + */ + @SuppressWarnings("unchecked") + public T getByPath(String expression) { + return (T) BeanPath.create(expression).get(this); + } + + /** + * 通过表达式获取JSON中嵌套的对象
+ *
    + *
  1. .表达式，可以获取Bean对象中的属性（字段）值或者Map中key对应的值
    2. + *
  2. []表达式，可以获取集合等对象中对应index的值
    3. + *
+ *

+ * 表达式栗子： + * + * 

+	 * persion
+	 * persion.name
+	 * persons[3]
+	 * person.friends[5].name
+	 *
+ *

+ * 获取表达式对应值后转换为对应类型的值 + * + * @param 返回值类型 + * @param expression 表达式 + * @param resultType 返回值类型 + * @return 对象 + * @see BeanPath#get(Object) + * @since 5.7.14 + */ + public T getByPath(String expression, Class resultType) { + return Convert.convert(resultType, getByPath(expression)); + } + // -------------------------------------------------------------------- Get end + + @Override + public boolean containsKey(Object key) { + return super.containsKey(customKey((String) key)); + } + + @Override + public Object get(Object key) { + return super.get(customKey((String) key)); + } + + @Override + public Object put(String key, Object value) { + return super.put(customKey(key), value); + } + + @Override + public void putAll(Map m) { + m.forEach(this::put); + } + + @Override + public Dict clone() { + return (Dict) super.clone(); + } + + @Override + public Object remove(Object key) { + return super.remove(customKey((String) key)); + } + + @Override + public boolean remove(Object key, Object value) { + return super.remove(customKey((String) key), value); + } + + @Override + public boolean replace(String key, Object oldValue, Object newValue) { + return super.replace(customKey(key), oldValue, newValue); + } + + @Override + public Object replace(String key, Object value) { + return super.replace(customKey(key), value); + } + + //---------------------------------------------------------------------------- Override default methods start + @Override + public Object getOrDefault(Object key, Object defaultValue) { + return super.getOrDefault(customKey((String) key), defaultValue); + } + + @Override + public Object computeIfPresent(final String key, final BiFunction remappingFunction) { + return super.computeIfPresent(customKey(key), remappingFunction); + } + + @Override + public Object compute(final String key, final BiFunction remappingFunction) { + return super.compute(customKey(key), remappingFunction); + } + + @Override + public Object merge(final String key, final Object value, final BiFunction remappingFunction) { + return super.merge(customKey(key), value, remappingFunction); + } + + @Override + public Object putIfAbsent(String key, Object value) { + return super.putIfAbsent(customKey(key), value); + } + + @Override + public Object computeIfAbsent(String key, Function mappingFunction) { + return super.computeIfAbsent(customKey(key), mappingFunction); + } + + //---------------------------------------------------------------------------- Override default methods end + + /** + * 将Key转为小写 + * + * @param key KEY + * @return 小写KEY + */ + private String customKey(String key) { + if (this.caseInsensitive && null != key) { + key = key.toLowerCase(); + } + return key; + } + + /** + * 通过lambda批量设置值
+ * 实际使用时，可以使用getXXX的方法引用来完成键值对的赋值： + * 

+	 *     User user = GenericBuilder.of(User::new).with(User::setUsername, "hutool").build();
+	 *     Dict.create().setFields(user::getNickname, user::getUsername);
+	 *
+ * + * @param fields lambda,不能为空 + * @return this + * @since 5.7.23 + */ + public Dict setFields(Func0... fields) { + Arrays.stream(fields).forEach(f -> set(LambdaUtil.getFieldName(f), f.callWithRuntimeException())); + return this; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Editor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Editor.java new file mode 100755 index 0000000..c5dc75c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Editor.java @@ -0,0 +1,24 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +/** + * 编辑器接口，常用于对于集合中的元素做统一编辑
+ * 此编辑器两个作用： + * + * 
+ * 1、如果返回值为{@code null}，表示此值被抛弃
+ * 2、对对象做修改
+ *
+ * + * @param 被编辑对象类型 + * @author Looly + */ +@FunctionalInterface +public interface Editor { + /** + * 修改过滤后的结果 + * + * @param t 被过滤的对象 + * @return 修改后的对象，如果被过滤返回{@code null} + */ + T edit(T t); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/EnumItem.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/EnumItem.java new file mode 100644 index 0000000..e2a91bf --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/EnumItem.java @@ -0,0 +1,78 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import java.io.Serializable; + +/** + * 枚举元素通用接口，在自定义枚举上实现此接口可以用于数据转换
+ * 数据库保存时建议保存 intVal()而非ordinal()防备需求变更
+ * + * @param Enum类型 + * @author nierjia + * @since 5.4.2 + */ +public interface EnumItem> extends Serializable { + + String name(); + + /** + * 在中文语境下，多数时间枚举会配合一个中文说明 + * + * @return enum名 + */ + default String text() { + return name(); + } + + int intVal(); + + /** + * 获取所有枚举对象 + * + * @return 枚举对象数组 + */ + @SuppressWarnings("unchecked") + default E[] items() { + return (E[]) this.getClass().getEnumConstants(); + } + + /** + * 通过int类型值查找兄弟其他枚举 + * + * @param intVal int值 + * @return Enum + */ + default E fromInt(Integer intVal) { + if (intVal == null) { + return null; + } + E[] vs = items(); + for (E enumItem : vs) { + if (enumItem.intVal() == intVal) { + return enumItem; + } + } + return null; + } + + /** + * 通过String类型的值转换，根据实现可以用name/text + * + * @param strVal String值 + * @return Enum + */ + default E fromStr(String strVal) { + if (strVal == null) { + return null; + } + E[] vs = items(); + for (E enumItem : vs) { + if (strVal.equalsIgnoreCase(enumItem.name())) { + return enumItem; + } + } + return null; + } + + +} + diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Filter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Filter.java new file mode 100755 index 0000000..8da402d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Filter.java @@ -0,0 +1,17 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +/** + * 过滤器接口 + * + * @author Looly + */ +@FunctionalInterface +public interface Filter { + /** + * 是否接受对象 + * + * @param t 检查的对象 + * @return 是否接受对象 + */ + boolean accept(T t); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/JarClassLoader.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/JarClassLoader.java new file mode 100644 index 0000000..666a289 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/JarClassLoader.java @@ -0,0 +1,172 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; + +import java.io.File; +import java.io.IOException; +import java.lang.reflect.Method; +import java.net.URL; +import java.net.URLClassLoader; +import java.util.List; + +/** + * 外部Jar的类加载器 + * + * @author Looly + */ +public class JarClassLoader extends URLClassLoader { + + /** + * 加载Jar到ClassPath + * + * @param dir jar文件或所在目录 + * @return JarClassLoader + */ + public static JarClassLoader load(File dir) { + final JarClassLoader loader = new JarClassLoader(); + loader.addJar(dir);//查找加载所有jar + loader.addURL(dir);//查找加载所有class + return loader; + } + + /** + * 加载Jar到ClassPath + * + * @param jarFile jar文件或所在目录 + * @return JarClassLoader + */ + public static JarClassLoader loadJar(File jarFile) { + final JarClassLoader loader = new JarClassLoader(); + loader.addJar(jarFile); + return loader; + } + + /** + * 加载Jar文件到指定loader中 + * + * @param loader {@link URLClassLoader} + * @param jarFile 被加载的jar + * @throws UtilException IO异常包装和执行异常 + */ + public static void loadJar(URLClassLoader loader, File jarFile) throws UtilException { + try { + final Method method = ClassUtil.getDeclaredMethod(URLClassLoader.class, "addURL", URL.class); + if (null != method) { + method.setAccessible(true); + final List jars = loopJar(jarFile); + for (File jar : jars) { + ReflectUtil.invoke(loader, method, jar.toURI().toURL()); + } + } + } catch (IOException e) { + throw new UtilException(e); + } + } + + /** + * 加载Jar文件到System ClassLoader中 + * + * @param jarFile 被加载的jar + * @return System ClassLoader + */ + public static URLClassLoader loadJarToSystemClassLoader(File jarFile) { + URLClassLoader urlClassLoader = (URLClassLoader) ClassLoader.getSystemClassLoader(); + loadJar(urlClassLoader, jarFile); + return urlClassLoader; + } + + // ------------------------------------------------------------------- Constructor start + + /** + * 构造 + */ + public JarClassLoader() { + this(new URL[]{}); + } + + /** + * 构造 + * + * @param urls 被加载的URL + */ + public JarClassLoader(URL[] urls) { + super(urls, ClassUtil.getClassLoader()); + } + + /** + * 构造 + * + * @param urls 被加载的URL + * @param classLoader 类加载器 + */ + public JarClassLoader(URL[] urls, ClassLoader classLoader) { + super(urls, classLoader); + } + // ------------------------------------------------------------------- Constructor end + + /** + * 加载Jar文件，或者加载目录 + * + * @param jarFileOrDir jar文件或者jar文件所在目录 + * @return this + */ + public JarClassLoader addJar(File jarFileOrDir) { + if (isJarFile(jarFileOrDir)) { + return addURL(jarFileOrDir); + } + final List jars = loopJar(jarFileOrDir); + for (File jar : jars) { + addURL(jar); + } + return this; + } + + @Override + public void addURL(URL url) { + super.addURL(url); + } + + /** + * 增加class所在目录或文件
+ * 如果为目录，此目录用于搜索class文件，如果为文件，需为jar文件 + * + * @param dir 目录 + * @return this + * @since 4.4.2 + */ + public JarClassLoader addURL(File dir) { + super.addURL(URLUtil.getURL(dir)); + return this; + } + + // ------------------------------------------------------------------- Private method start + + /** + * 递归获得Jar文件 + * + * @param file jar文件或者包含jar文件的目录 + * @return jar文件列表 + */ + private static List loopJar(File file) { + return FileUtil.loopFiles(file, JarClassLoader::isJarFile); + } + + /** + * 是否为jar文件 + * + * @param file 文件 + * @return 是否为jar文件 + * @since 4.4.2 + */ + private static boolean isJarFile(File file) { + if (false == FileUtil.isFile(file)) { + return false; + } + return file.getPath().toLowerCase().endsWith(".jar"); + } + // ------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Matcher.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Matcher.java new file mode 100755 index 0000000..8f443c9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Matcher.java @@ -0,0 +1,18 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +/** + * 匹配接口 + * + * @param 匹配的对象类型 + * @author Looly + */ +@FunctionalInterface +public interface Matcher { + /** + * 给定对象是否匹配 + * + * @param t 对象 + * @return 是否匹配 + */ + boolean match(T t); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ObjectId.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ObjectId.java new file mode 100755 index 0000000..78ae55f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ObjectId.java @@ -0,0 +1,191 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.date.DateUtil; +import aiyh.utils.tool.cn.hutool.core.util.ClassLoaderUtil; +import aiyh.utils.tool.cn.hutool.core.util.RandomUtil; +import aiyh.utils.tool.cn.hutool.core.util.RuntimeUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.net.NetworkInterface; +import java.nio.ByteBuffer; +import java.util.Enumeration; +import java.util.concurrent.atomic.AtomicInteger; + +/** + * MongoDB ID生成策略实现
+ * ObjectId由以下几部分组成： + * + * 
+ * 1. Time 时间戳。
+ * 2. Machine 所在主机的唯一标识符，一般是机器主机名的散列值。
+ * 3. PID 进程ID。确保同一机器中不冲突
+ * 4. INC 自增计数器。确保同一秒内产生objectId的唯一性。
+ *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
时间戳机器ID进程ID自增计数器
4323
+ * + * 参考：http://blog.csdn.net/qxc1281/article/details/54021882 + * + * @author looly + * @since 4.0.0 + * + */ +public class ObjectId { + + /** 线程安全的下一个随机数,每次生成自增+1 */ + private static final AtomicInteger NEXT_INC = new AtomicInteger(RandomUtil.randomInt()); + /** 机器信息 */ + private static final int MACHINE = getMachinePiece() | getProcessPiece(); + + /** + * 给定的字符串是否为有效的ObjectId + * + * @param s 字符串 + * @return 是否为有效的ObjectId + */ + public static boolean isValid(String s) { + if (s == null) { + return false; + } + s = StrUtil.removeAll(s, "-"); + final int len = s.length(); + if (len != 24) { + return false; + } + + char c; + for (int i = 0; i < len; i++) { + c = s.charAt(i); + if (c >= '0' && c <= '9') { + continue; + } + if (c >= 'a' && c <= 'f') { + continue; + } + if (c >= 'A' && c <= 'F') { + continue; + } + return false; + } + return true; + } + + /** + * 获取一个objectId的bytes表现形式 + * + * @return objectId + * @since 4.1.15 + */ + public static byte[] nextBytes() { + final ByteBuffer bb = ByteBuffer.wrap(new byte[12]); + bb.putInt((int) DateUtil.currentSeconds());// 4位 + bb.putInt(MACHINE);// 4位 + bb.putInt(NEXT_INC.getAndIncrement());// 4位 + + return bb.array(); + } + + /** + * 获取一个objectId用下划线分割 + * + * @return objectId + */ + public static String next() { + return next(false); + } + + /** + * 获取一个objectId + * + * @param withHyphen 是否包含分隔符 + * @return objectId + */ + public static String next(boolean withHyphen) { + byte[] array = nextBytes(); + final StringBuilder buf = new StringBuilder(withHyphen ? 26 : 24); + int t; + for (int i = 0; i < array.length; i++) { + if (withHyphen && i % 4 == 0 && i != 0) { + buf.append("-"); + } + t = array[i] & 0xff; + if (t < 16) { + buf.append('0'); + } + buf.append(Integer.toHexString(t)); + + } + return buf.toString(); + } + + // ----------------------------------------------------------------------------------------- Private method start + /** + * 获取机器码片段 + * + * @return 机器码片段 + */ + private static int getMachinePiece() { + // 机器码 + int machinePiece; + try { + StringBuilder netSb = new StringBuilder(); + // 返回机器所有的网络接口 + Enumeration e = NetworkInterface.getNetworkInterfaces(); + // 遍历网络接口 + while (e.hasMoreElements()) { + NetworkInterface ni = e.nextElement(); + // 网络接口信息 + netSb.append(ni.toString()); + } + // 保留后两位 + machinePiece = netSb.toString().hashCode() << 16; + } catch (Throwable e) { + // 出问题随机生成,保留后两位 + machinePiece = (RandomUtil.randomInt()) << 16; + } + return machinePiece; + } + + /** + * 获取进程码片段 + * + * @return 进程码片段 + */ + private static int getProcessPiece() { + // 进程码 + // 因为静态变量类加载可能相同,所以要获取进程ID + 加载对象的ID值 + final int processPiece; + // 进程ID初始化 + int processId; + try { + processId = RuntimeUtil.getPid(); + } catch (Throwable t) { + processId = RandomUtil.randomInt(); + } + + final ClassLoader loader = ClassLoaderUtil.getClassLoader(); + // 返回对象哈希码,无论是否重写hashCode方法 + int loaderId = (loader != null) ? System.identityHashCode(loader) : 0; + + // 进程ID + 对象加载ID + // 保留前2位 + final String processSb = Integer.toHexString(processId) + Integer.toHexString(loaderId); + processPiece = processSb.hashCode() & 0xFFFF; + + return processPiece; + } + // ----------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Opt.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Opt.java new file mode 100644 index 0000000..c43785d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Opt.java @@ -0,0 +1,568 @@ +/* + * Copyright (c) 2012, 2020, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.collection.CollectionUtil; +import aiyh.utils.tool.cn.hutool.core.lang.func.Func0; +import aiyh.utils.tool.cn.hutool.core.lang.func.VoidFunc0; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.Collection; +import java.util.NoSuchElementException; +import java.util.Objects; +import java.util.Optional; +import java.util.function.Consumer; +import java.util.function.Function; +import java.util.function.Predicate; +import java.util.function.Supplier; +import java.util.stream.Stream; + +/** + * 复制jdk16中的Optional，以及自己进行了一点调整和新增，比jdk8中的Optional多了几个实用的函数
+ * 详细见：https://gitee.com/dromara/hutool/pulls/426 + * + * @param 包裹里元素的类型 + * @author VampireAchao + * @see java.util.Optional + */ +public class Opt { + /** + * 一个空的{@code Opt} + */ + private static final Opt EMPTY = new Opt<>(null); + + /** + * 返回一个空的{@code Opt} + * + * @param 包裹里元素的类型 + * @return Opt + */ + public static Opt empty() { + @SuppressWarnings("unchecked") final Opt t = (Opt) EMPTY; + return t; + } + + /** + * 返回一个包裹里元素不可能为空的{@code Opt} + * + * @param value 包裹里的元素 + * @param 包裹里元素的类型 + * @return 一个包裹里元素不可能为空的 {@code Opt} + * @throws NullPointerException 如果传入的元素为空，抛出 {@code NPE} + */ + public static Opt of(T value) { + return new Opt<>(Objects.requireNonNull(value)); + } + + /** + * 返回一个包裹里元素可能为空的{@code Opt} + * + * @param value 传入需要包裹的元素 + * @param 包裹里元素的类型 + * @return 一个包裹里元素可能为空的 {@code Opt} + */ + public static Opt ofNullable(T value) { + return value == null ? empty() + : new Opt<>(value); + } + + /** + * 返回一个包裹里元素可能为空的{@code Opt}，额外判断了空字符串的情况 + * + * @param value 传入需要包裹的元素 + * @param 包裹里元素的类型 + * @return 一个包裹里元素可能为空，或者为空字符串的 {@code Opt} + */ + public static Opt ofBlankAble(T value) { + return StrUtil.isBlankIfStr(value) ? empty() : new Opt<>(value); + } + + /** + * 返回一个包裹里{@code List}集合可能为空的{@code Opt}，额外判断了集合内元素为空的情况 + * + * @param 包裹里元素的类型 + * @param 集合值类型 + * @param value 传入需要包裹的元素 + * @return 一个包裹里元素可能为空的 {@code Opt} + * @since 5.7.17 + */ + public static > Opt ofEmptyAble(R value) { + return CollectionUtil.isEmpty(value) ? empty() : new Opt<>(value); + } + + /** + * @param supplier 操作 + * @param 类型 + * @return 操作执行后的值 + */ + public static Opt ofTry(Func0 supplier) { + try { + return Opt.ofNullable(supplier.call()); + } catch (Exception e) { + final Opt empty = new Opt<>(null); + empty.exception = e; + return empty; + } + } + + /** + * 包裹里实际的元素 + */ + private final T value; + private Exception exception; + + /** + * {@code Opt}的构造函数 + * + * @param value 包裹里的元素 + */ + private Opt(T value) { + this.value = value; + } + + /** + * 返回包裹里的元素，取不到则为{@code null}，注意！！！此处和{@link java.util.Optional#get()}不同的一点是本方法并不会抛出{@code NoSuchElementException} + * 如果元素为空，则返回{@code null}，如果需要一个绝对不能为{@code null}的值，则使用{@link #orElseThrow()} + * + *

+ * 如果需要一个绝对不能为 {@code null}的值，则使用{@link #orElseThrow()} + * 做此处修改的原因是，有时候我们确实需要返回一个null给前端，并且这样的时候并不少见 + * 而使用 {@code .orElse(null)}需要写整整12个字符，用{@code .get()}就只需要6个啦 + * + * @return 包裹里的元素，有可能为{@code null} + */ + public T get() { + return this.value; + } + + /** + * 判断包裹里元素的值是否不存在，不存在为 {@code true}，否则为{@code false} + * + * @return 包裹里元素的值不存在 则为 {@code true}，否则为{@code false} + * @since 11 这是jdk11{@link java.util.Optional}中的新函数 + */ + public boolean isEmpty() { + return value == null; + } + + /** + * 获取异常
+ * 当调用 {@link #ofTry(Func0)}时，异常信息不会抛出，而是保存，调用此方法获取抛出的异常 + * + * @return 异常 + * @since 5.7.17 + */ + public Exception getException() { + return this.exception; + } + + /** + * 是否失败
+ * 当调用 {@link #ofTry(Func0)}时，抛出异常则表示失败 + * + * @return 是否失败 + * @since 5.7.17 + */ + public boolean isFail() { + return null != this.exception; + } + + /** + * 判断包裹里元素的值是否存在，存在为 {@code true}，否则为{@code false} + * + * @return 包裹里元素的值存在为 {@code true}，否则为{@code false} + */ + public boolean isPresent() { + return value != null; + } + + /** + * 如果包裹里的值存在，就执行传入的操作({@link Consumer#accept}) + * + *

例如如果值存在就打印结果 + * 

{@code
+	 * Opt.ofNullable("Hello Hutool!").ifPresent(Console::log);
+	 * }
+ * + * @param action 你想要执行的操作 + * @return this + * @throws NullPointerException 如果包裹里的值存在，但你传入的操作为{@code null}时抛出 + */ + public Opt ifPresent(Consumer action) { + if (isPresent()) { + action.accept(value); + } + return this; + } + + /** + * 如果包裹里的值存在，就执行传入的值存在时的操作({@link Consumer#accept}) + * 否则执行传入的值不存在时的操作({@link VoidFunc0}中的{@link VoidFunc0#call()}) + * + *

+ * 例如值存在就打印对应的值，不存在则用{@code Console.error}打印另一句字符串 + * 

{@code
+	 * Opt.ofNullable("Hello Hutool!").ifPresentOrElse(Console::log, () -> Console.error("Ops!Something is wrong!"));
+	 * }
+ * + * @param action 包裹里的值存在时的操作 + * @param emptyAction 包裹里的值不存在时的操作 + * @return this; + * @throws NullPointerException 如果包裹里的值存在时，执行的操作为 {@code null}, 或者包裹里的值不存在时的操作为 {@code null}，则抛出{@code NPE} + */ + public Opt ifPresentOrElse(Consumer action, VoidFunc0 emptyAction) { + if (isPresent()) { + action.accept(value); + } else { + emptyAction.callWithRuntimeException(); + } + return this; + } + + + /** + * 如果包裹里的值存在，就执行传入的值存在时的操作({@link Function#apply(Object)})支持链式调用、转换为其他类型 + * 否则执行传入的值不存在时的操作({@link VoidFunc0}中的{@link VoidFunc0#call()}) + * + *

+ * 如果值存在就转换为大写，否则用{@code Console.error}打印另一句字符串 + * 

{@code
+	 * String hutool = Opt.ofBlankAble("hutool").mapOrElse(String::toUpperCase, () -> Console.log("yes")).mapOrElse(String::intern, () -> Console.log("Value is not present~")).get();
+	 * }
+ * + * @param map后新的类型 + * @param mapper 包裹里的值存在时的操作 + * @param emptyAction 包裹里的值不存在时的操作 + * @return 新的类型的Opt + * @throws NullPointerException 如果包裹里的值存在时，执行的操作为 {@code null}, 或者包裹里的值不存在时的操作为 {@code null}，则抛出{@code NPE} + */ + public Opt mapOrElse(Function mapper, VoidFunc0 emptyAction) { + if (isPresent()) { + return ofNullable(mapper.apply(value)); + } else { + emptyAction.callWithRuntimeException(); + return empty(); + } + } + + /** + * 判断包裹里的值存在并且与给定的条件是否满足 ({@link Predicate#test}执行结果是否为true) + * 如果满足条件则返回本身 + * 不满足条件或者元素本身为空时返回一个返回一个空的{@code Opt} + * + * @param predicate 给定的条件 + * @return 如果满足条件则返回本身, 不满足条件或者元素本身为空时返回一个返回一个空的{@code Opt} + * @throws NullPointerException 如果给定的条件为 {@code null}，抛出{@code NPE} + */ + public Opt filter(Predicate predicate) { + Objects.requireNonNull(predicate); + if (isEmpty()) { + return this; + } else { + return predicate.test(value) ? this : empty(); + } + } + + /** + * 如果包裹里的值存在，就执行传入的操作({@link Function#apply})并返回一个包裹了该操作返回值的{@code Opt} + * 如果不存在，返回一个空的{@code Opt} + * + * @param mapper 值存在时执行的操作 + * @param 操作返回值的类型 + * @return 如果包裹里的值存在，就执行传入的操作({@link Function#apply})并返回一个包裹了该操作返回值的{@code Opt}， + * 如果不存在，返回一个空的{@code Opt} + * @throws NullPointerException 如果给定的操作为 {@code null}，抛出 {@code NPE} + */ + public Opt map(Function mapper) { + Objects.requireNonNull(mapper); + if (isEmpty()) { + return empty(); + } else { + return Opt.ofNullable(mapper.apply(value)); + } + } + + /** + * 如果包裹里的值存在，就执行传入的操作({@link Function#apply})并返回该操作返回值 + * 如果不存在，返回一个空的{@code Opt} + * 和 {@link Opt#map}的区别为 传入的操作返回值必须为 Opt + * + * @param mapper 值存在时执行的操作 + * @param 操作返回值的类型 + * @return 如果包裹里的值存在，就执行传入的操作({@link Function#apply})并返回该操作返回值 + * 如果不存在，返回一个空的{@code Opt} + * @throws NullPointerException 如果给定的操作为 {@code null}或者给定的操作执行结果为 {@code null}，抛出 {@code NPE} + */ + public Opt flatMap(Function> mapper) { + Objects.requireNonNull(mapper); + if (isEmpty()) { + return empty(); + } else { + @SuppressWarnings("unchecked") + final Opt r = (Opt) mapper.apply(value); + return Objects.requireNonNull(r); + } + } + + /** + * 如果包裹里的值存在，就执行传入的操作({@link Function#apply})并返回该操作返回值 + * 如果不存在，返回一个空的{@code Opt} + * 和 {@link Opt#map}的区别为 传入的操作返回值必须为 {@link Optional} + * + * @param mapper 值存在时执行的操作 + * @param 操作返回值的类型 + * @return 如果包裹里的值存在，就执行传入的操作({@link Function#apply})并返回该操作返回值 + * 如果不存在，返回一个空的{@code Opt} + * @throws NullPointerException 如果给定的操作为 {@code null}或者给定的操作执行结果为 {@code null}，抛出 {@code NPE} + * @see Optional#flatMap(Function) + * @since 5.7.16 + */ + public Opt flattedMap(Function> mapper) { + Objects.requireNonNull(mapper); + if (isEmpty()) { + return empty(); + } else { + return ofNullable(mapper.apply(value).orElse(null)); + } + } + + /** + * 如果包裹里元素的值存在，就执行对应的操作，并返回本身 + * 如果不存在，返回一个空的{@code Opt} + * + *

属于 {@link #ifPresent}的链式拓展 + * + * @param action 值存在时执行的操作 + * @return this + * @throws NullPointerException 如果值存在，并且传入的操作为 {@code null} + * @author VampireAchao + */ + public Opt peek(Consumer action) throws NullPointerException { + Objects.requireNonNull(action); + if (isEmpty()) { + return Opt.empty(); + } + action.accept(value); + return this; + } + + + /** + * 如果包裹里元素的值存在，就执行对应的操作集，并返回本身 + * 如果不存在，返回一个空的{@code Opt} + * + *

属于 {@link #ifPresent}的链式拓展 + *

属于 {@link #peek(Consumer)}的动态拓展 + * + * @param actions 值存在时执行的操作，动态参数，可传入数组，当数组为一个空数组时并不会抛出 {@code NPE} + * @return this + * @throws NullPointerException 如果值存在，并且传入的操作集中的元素为 {@code null} + * @author VampireAchao + */ + @SafeVarargs + public final Opt peeks(Consumer... actions) throws NullPointerException { + // 第三个参数 (opts, opt) -> null其实并不会执行到该函数式接口所以直接返回了个null + return Stream.of(actions).reduce(this, Opt::peek, (opts, opt) -> null); + } + + /** + * 如果包裹里元素的值存在，就返回本身，如果不存在，则使用传入的操作执行后获得的 {@code Opt} + * + * @param supplier 不存在时的操作 + * @return 如果包裹里元素的值存在，就返回本身，如果不存在，则使用传入的函数执行后获得的 {@code Opt} + * @throws NullPointerException 如果传入的操作为空，或者传入的操作执行后返回值为空，则抛出 {@code NPE} + */ + public Opt or(Supplier> supplier) { + Objects.requireNonNull(supplier); + if (isPresent()) { + return this; + } else { + @SuppressWarnings("unchecked") final Opt r = (Opt) supplier.get(); + return Objects.requireNonNull(r); + } + } + + /** + * 如果包裹里元素的值存在，就返回一个包含该元素的 {@link Stream}, + * 否则返回一个空元素的 {@link Stream} + * + *

该方法能将 Opt 中的元素传递给 {@link Stream} + * 

{@code
+	 *     Stream> os = ..
+	 *     Stream s = os.flatMap(Opt::stream)
+	 * }
+ * + * @return 返回一个包含该元素的 {@link Stream}或空的 {@link Stream} + */ + public Stream stream() { + if (isEmpty()) { + return Stream.empty(); + } else { + return Stream.of(value); + } + } + + /** + * 如果包裹里元素的值存在，则返回该值，否则返回传入的{@code other} + * + * @param other 元素为空时返回的值，有可能为 {@code null}. + * @return 如果包裹里元素的值存在，则返回该值，否则返回传入的{@code other} + */ + public T orElse(T other) { + return isPresent() ? value : other; + } + + /** + * 异常则返回另一个可选值 + * + * @param other 可选值 + * @return 如果未发生异常，则返回该值，否则返回传入的{@code other} + * @since 5.7.17 + */ + public T exceptionOrElse(T other) { + return isFail() ? other : value; + } + + /** + * 如果包裹里元素的值存在，则返回该值，否则返回传入的操作执行后的返回值 + * + * @param supplier 值不存在时需要执行的操作，返回一个类型与 包裹里元素类型 相同的元素 + * @return 如果包裹里元素的值存在，则返回该值，否则返回传入的操作执行后的返回值 + * @throws NullPointerException 如果之不存在，并且传入的操作为空，则抛出 {@code NPE} + */ + public T orElseGet(Supplier supplier) { + return isPresent() ? value : supplier.get(); + } + + /** + * 如果包裹里的值存在，则返回该值，否则抛出 {@code NoSuchElementException} + * + * @return 返回一个不为 {@code null} 的包裹里的值 + * @throws NoSuchElementException 如果包裹里的值不存在则抛出该异常 + */ + public T orElseThrow() { + return orElseThrow(NoSuchElementException::new, "No value present"); + } + + /** + * 如果包裹里的值存在，则返回该值，否则执行传入的操作，获取异常类型的返回值并抛出 + *

往往是一个包含无参构造器的异常 例如传入{@code IllegalStateException::new} + * + * @param 异常类型 + * @param exceptionSupplier 值不存在时执行的操作，返回值继承 {@link Throwable} + * @return 包裹里不能为空的值 + * @throws X 如果值不存在 + * @throws NullPointerException 如果值不存在并且 传入的操作为 {@code null}或者操作执行后的返回值为{@code null} + */ + public T orElseThrow(Supplier exceptionSupplier) throws X { + if (isPresent()) { + return value; + } else { + throw exceptionSupplier.get(); + } + } + + /** + * 如果包裹里的值存在，则返回该值，否则执行传入的操作，获取异常类型的返回值并抛出 + * + *

往往是一个包含 自定义消息 构造器的异常 例如 + * 

{@code
+	 * 		Opt.ofNullable(null).orElseThrow(IllegalStateException::new, "Ops!Something is wrong!");
+	 * }
+ * + * @param 异常类型 + * @param exceptionFunction 值不存在时执行的操作，返回值继承 {@link Throwable} + * @param message 作为传入操作执行时的参数，一般作为异常自定义提示语 + * @return 包裹里不能为空的值 + * @throws X 如果值不存在 + * @throws NullPointerException 如果值不存在并且 传入的操作为 {@code null}或者操作执行后的返回值为{@code null} + * @author VampireAchao + */ + public T orElseThrow(Function exceptionFunction, String message) throws X { + if (isPresent()) { + return value; + } else { + throw exceptionFunction.apply(message); + } + } + + /** + * 转换为 {@link Optional}对象 + * + * @return {@link Optional}对象 + * @since 5.7.16 + */ + public Optional toOptional() { + return Optional.ofNullable(this.value); + } + + /** + * 判断传入参数是否与 {@code Opt}相等 + * 在以下情况下返回true + *
    + *
  • 它也是一个 {@code Opt} 并且 + *
  • 它们包裹住的元素都为空 或者 + *
  • 它们包裹住的元素之间相互 {@code equals()} + *
+ * + * @param obj 一个要用来判断是否相等的参数 + * @return 如果传入的参数也是一个 {@code Opt}并且它们包裹住的元素都为空 + * 或者它们包裹住的元素之间相互 {@code equals()} 就返回{@code true} + * 否则返回 {@code false} + */ + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + + if (!(obj instanceof Opt)) { + return false; + } + + final Opt other = (Opt) obj; + return Objects.equals(value, other.value); + } + + /** + * 如果包裹内元素为空，则返回0，否则返回元素的 {@code hashcode} + * + * @return 如果包裹内元素为空，则返回0，否则返回元素的 {@code hashcode} + */ + @Override + public int hashCode() { + return Objects.hashCode(value); + } + + /** + * 返回包裹内元素调用{@code toString()}的结果，不存在则返回{@code null} + * + * @return 包裹内元素调用{@code toString()}的结果，不存在则返回{@code null} + */ + @Override + public String toString() { + return StrUtil.toStringOrNull(this.value); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Pair.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Pair.java new file mode 100644 index 0000000..c569a28 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Pair.java @@ -0,0 +1,87 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.clone.CloneSupport; + +import java.io.Serializable; +import java.util.Objects; + +/** + * 键值对对象，只能在构造时传入键值 + * + * @param 键类型 + * @param 值类型 + * @author looly + * @since 4.1.5 + */ +public class Pair extends CloneSupport> implements Serializable { + private static final long serialVersionUID = 1L; + + protected K key; + protected V value; + + /** + * 构建{@code Pair}对象 + * + * @param 键类型 + * @param 值类型 + * @param key 键 + * @param value 值 + * @return {@code Pair} + * @since 5.4.3 + */ + public static Pair of(K key, V value) { + return new Pair<>(key, value); + } + + /** + * 构造 + * + * @param key 键 + * @param value 值 + */ + public Pair(K key, V value) { + this.key = key; + this.value = value; + } + + /** + * 获取键 + * + * @return 键 + */ + public K getKey() { + return this.key; + } + + /** + * 获取值 + * + * @return 值 + */ + public V getValue() { + return this.value; + } + + @Override + public String toString() { + return "Pair [key=" + key + ", value=" + value + "]"; + } + + @Override + public boolean equals(Object o) { + if (this == o) + return true; + if (o instanceof Pair) { + Pair pair = (Pair) o; + return Objects.equals(getKey(), pair.getKey()) && + Objects.equals(getValue(), pair.getValue()); + } + return false; + } + + @Override + public int hashCode() { + //copy from 1.8 HashMap.Node + return Objects.hashCode(key) ^ Objects.hashCode(value); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ParameterizedTypeImpl.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ParameterizedTypeImpl.java new file mode 100755 index 0000000..a8f1cd8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ParameterizedTypeImpl.java @@ -0,0 +1,102 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import java.io.Serializable; +import java.lang.reflect.ParameterizedType; +import java.lang.reflect.Type; + +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * {@link ParameterizedType} 接口实现，用于重新定义泛型类型 + * + * @author looly + * @since 4.5.7 + */ +public class ParameterizedTypeImpl implements ParameterizedType, Serializable { + private static final long serialVersionUID = 1L; + + private final Type[] actualTypeArguments; + private final Type ownerType; + private final Type rawType; + + /** + * 构造 + * + * @param actualTypeArguments 实际的泛型参数类型 + * @param ownerType 拥有者类型 + * @param rawType 原始类型 + */ + public ParameterizedTypeImpl(Type[] actualTypeArguments, Type ownerType, Type rawType) { + this.actualTypeArguments = actualTypeArguments; + this.ownerType = ownerType; + this.rawType = rawType; + } + + @Override + public Type[] getActualTypeArguments() { + return actualTypeArguments; + } + + @Override + public Type getOwnerType() { + return ownerType; + } + + @Override + public Type getRawType() { + return rawType; + } + + @Override + public String toString() { + final StringBuilder buf = new StringBuilder(); + + final Type useOwner = this.ownerType; + final Class raw = (Class) this.rawType; + if (useOwner == null) { + buf.append(raw.getName()); + } else { + if (useOwner instanceof Class) { + buf.append(((Class) useOwner).getName()); + } else { + buf.append(useOwner.toString()); + } + buf.append('.').append(raw.getSimpleName()); + } + + appendAllTo(buf.append('<'), ", ", this.actualTypeArguments).append('>'); + return buf.toString(); + } + + /** + * 追加 {@code types} 到 @{code buf}，使用 {@code sep} 分隔 + * + * @param buf 目标 + * @param sep 分隔符 + * @param types 加入的类型 + * @return {@code buf} + */ + private static StringBuilder appendAllTo(final StringBuilder buf, final String sep, final Type... types) { + if (ArrayUtil.isNotEmpty(types)) { + boolean isFirst = true; + for (Type type : types) { + if (isFirst) { + isFirst = false; + } else { + buf.append(sep); + } + + String typeStr; + if(type instanceof Class) { + typeStr = ((Class)type).getName(); + }else { + typeStr = StrUtil.toString(type); + } + + buf.append(typeStr); + } + } + return buf; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/PatternPool.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/PatternPool.java new file mode 100755 index 0000000..0013b5b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/PatternPool.java @@ -0,0 +1,275 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.map.WeakConcurrentMap; + +import java.util.regex.Pattern; + +/** + * 常用正则表达式集合，更多正则见:
+ * https://any86.github.io/any-rule/ + * + * @author Looly + */ +public class PatternPool { + + /** + * 英文字母 、数字和下划线 + */ + public final static Pattern GENERAL = Pattern.compile(RegexPool.GENERAL); + /** + * 数字 + */ + public final static Pattern NUMBERS = Pattern.compile(RegexPool.NUMBERS); + /** + * 字母 + */ + public final static Pattern WORD = Pattern.compile(RegexPool.WORD); + /** + * 单个中文汉字 + */ + public final static Pattern CHINESE = Pattern.compile(RegexPool.CHINESE); + /** + * 中文汉字 + */ + public final static Pattern CHINESES = Pattern.compile(RegexPool.CHINESES); + /** + * 分组 + */ + public final static Pattern GROUP_VAR = Pattern.compile(RegexPool.GROUP_VAR); + /** + * IP v4 + */ + public final static Pattern IPV4 = Pattern.compile(RegexPool.IPV4); + /** + * IP v6 + */ + public final static Pattern IPV6 = Pattern.compile(RegexPool.IPV6); + /** + * 货币 + */ + public final static Pattern MONEY = Pattern.compile(RegexPool.MONEY); + /** + * 邮件，符合RFC 5322规范，正则来自：http://emailregex.com/
+ * https://stackoverflow.com/questions/386294/what-is-the-maximum-length-of-a-valid-email-address/44317754 + * 注意email 要宽松一点。比如 jetz.chong@hutool.cn、jetz-chong@ hutool.cn、jetz_chong@hutool.cn、dazhi.duan@hutool.cn 宽松一点把，都算是正常的邮箱 + */ + public final static Pattern EMAIL = Pattern.compile(RegexPool.EMAIL, Pattern.CASE_INSENSITIVE); + /** + * 移动电话 + */ + public final static Pattern MOBILE = Pattern.compile(RegexPool.MOBILE); + /** + * 中国香港移动电话 + * eg: 中国香港： +852 5100 4810， 三位区域码+10位数字, 中国香港手机号码8位数 + * eg: 中国大陆： +86 180 4953 1399，2位区域码标示+13位数字 + * 中国大陆 +86 Mainland China + * 中国香港 +852 Hong Kong + * 中国澳门 +853 Macao + * 中国台湾 +886 Taiwan + */ + public final static Pattern MOBILE_HK = Pattern.compile(RegexPool.MOBILE_HK); + /** + * 中国台湾移动电话 + * eg: 中国台湾： +886 09 60 000000， 三位区域码+号码以数字09开头 + 8位数字, 中国台湾手机号码10位数 + * 中国台湾 +886 Taiwan 国际域名缩写：TW + */ + public final static Pattern MOBILE_TW = Pattern.compile(RegexPool.MOBILE_TW); + /** + * 中国澳门移动电话 + * eg: 中国台湾： +853 68 00000， 三位区域码 +号码以数字6开头 + 7位数字, 中国台湾手机号码8位数 + * 中国澳门 +853 Macao 国际域名缩写：MO + */ + public final static Pattern MOBILE_MO = Pattern.compile(RegexPool.MOBILE_MO); + /** + * 座机号码 + */ + public final static Pattern TEL = Pattern.compile(RegexPool.TEL); + /** + * 座机号码+400+800电话 + * + * @see 800 + */ + public final static Pattern TEL_400_800 = Pattern.compile(RegexPool.TEL_400_800); + /** + * 18位身份证号码 + */ + public final static Pattern CITIZEN_ID = Pattern.compile(RegexPool.CITIZEN_ID); + /** + * 邮编，兼容港澳台 + */ + public final static Pattern ZIP_CODE = Pattern.compile(RegexPool.ZIP_CODE); + /** + * 生日 + */ + public final static Pattern BIRTHDAY = Pattern.compile(RegexPool.BIRTHDAY); + /** + * URL + */ + public final static Pattern URL = Pattern.compile(RegexPool.URL); + /** + * Http URL + */ + public final static Pattern URL_HTTP = Pattern.compile(RegexPool.URL_HTTP, Pattern.CASE_INSENSITIVE); + /** + * 中文字、英文字母、数字和下划线 + */ + public final static Pattern GENERAL_WITH_CHINESE = Pattern.compile(RegexPool.GENERAL_WITH_CHINESE); + /** + * UUID + */ + public final static Pattern UUID = Pattern.compile(RegexPool.UUID, Pattern.CASE_INSENSITIVE); + /** + * 不带横线的UUID + */ + public final static Pattern UUID_SIMPLE = Pattern.compile(RegexPool.UUID_SIMPLE); + /** + * MAC地址正则 + */ + public static final Pattern MAC_ADDRESS = Pattern.compile(RegexPool.MAC_ADDRESS, Pattern.CASE_INSENSITIVE); + /** + * 16进制字符串 + */ + public static final Pattern HEX = Pattern.compile(RegexPool.HEX); + /** + * 时间正则 + */ + public static final Pattern TIME = Pattern.compile(RegexPool.TIME); + /** + * 中国车牌号码（兼容新能源车牌） + */ + public final static Pattern PLATE_NUMBER = Pattern.compile(RegexPool.PLATE_NUMBER); + + /** + * 统一社会信用代码 + * 
+	 * 第一部分：登记管理部门代码1位 (数字或大写英文字母)
+	 * 第二部分：机构类别代码1位 (数字或大写英文字母)
+	 * 第三部分：登记管理机关行政区划码6位 (数字)
+	 * 第四部分：主体标识码（组织机构代码）9位 (数字或大写英文字母)
+	 * 第五部分：校验码1位 (数字或大写英文字母)
+	 *
+ */ + public static final Pattern CREDIT_CODE = Pattern.compile(RegexPool.CREDIT_CODE); + /** + * 车架号 + * 别名：车辆识别代号 车辆识别码 + * eg:LDC613P23A1305189 + * eg:LSJA24U62JG269225 + * 十七位码、车架号 + * 车辆的唯一标示 + */ + public static final Pattern CAR_VIN = Pattern.compile(RegexPool.CAR_VIN); + /** + * 驾驶证 别名：驾驶证档案编号、行驶证编号 + * eg:430101758218 + * 12位数字字符串 + * 仅限：中国驾驶证档案编号 + */ + public static final Pattern CAR_DRIVING_LICENCE = Pattern.compile(RegexPool.CAR_DRIVING_LICENCE); + /** + * 中文姓名 + * 总结中国人姓名：2-60位，只能是中文和 · + */ + public static final Pattern CHINESE_NAME = Pattern.compile(RegexPool.CHINESE_NAME); + + // ------------------------------------------------------------------------------------------------------------------------------------------------------------------- + /** + * Pattern池 + */ + private static final WeakConcurrentMap POOL = new WeakConcurrentMap<>(); + + /** + * 先从Pattern池中查找正则对应的{@link Pattern}，找不到则编译正则表达式并入池。 + * + * @param regex 正则表达式 + * @return {@link Pattern} + */ + public static Pattern get(String regex) { + return get(regex, 0); + } + + /** + * 先从Pattern池中查找正则对应的{@link Pattern}，找不到则编译正则表达式并入池。 + * + * @param regex 正则表达式 + * @param flags 正则标识位集合 {@link Pattern} + * @return {@link Pattern} + */ + public static Pattern get(String regex, int flags) { + final RegexWithFlag regexWithFlag = new RegexWithFlag(regex, flags); + return POOL.computeIfAbsent(regexWithFlag, (key)-> Pattern.compile(regex, flags)); + } + + /** + * 移除缓存 + * + * @param regex 正则 + * @param flags 标识 + * @return 移除的{@link Pattern}，可能为{@code null} + */ + public static Pattern remove(String regex, int flags) { + return POOL.remove(new RegexWithFlag(regex, flags)); + } + + /** + * 清空缓存池 + */ + public static void clear() { + POOL.clear(); + } + + // --------------------------------------------------------------------------------------------------------------------------------- + + /** + * 正则表达式和正则标识位的包装 + * + * @author Looly + */ + private static class RegexWithFlag { + private final String regex; + private final int flag; + + /** + * 构造 + * + * @param regex 正则 + * @param flag 标识 + */ + public RegexWithFlag(String regex, int flag) { + this.regex = regex; + this.flag = flag; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + flag; + result = prime * result + ((regex == null) ? 0 : regex.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + RegexWithFlag other = (RegexWithFlag) obj; + if (flag != other.flag) { + return false; + } + if (regex == null) { + return other.regex == null; + } else { + return regex.equals(other.regex); + } + } + + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Pid.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Pid.java new file mode 100755 index 0000000..0c4baab --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Pid.java @@ -0,0 +1,51 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.lang.management.ManagementFactory; + +/** + * 进程ID单例封装
+ * 第一次访问时调用{@link ManagementFactory#getRuntimeMXBean()}获取PID信息，之后直接使用缓存值 + * + * @author looly + * @since 5.8.0 + */ +public enum Pid { + INSTANCE; + + private final int pid; + + Pid() { + this.pid = getPid(); + } + + /** + * 获取PID值 + * + * @return pid + */ + public int get() { + return this.pid; + } + + /** + * 获取当前进程ID，首先获取进程名称，读取@前的ID值，如果不存在，则读取进程名的hash值 + * + * @return 进程ID + * @throws UtilException 进程名称为空 + */ + private static int getPid() throws UtilException { + final String processName = ManagementFactory.getRuntimeMXBean().getName(); + if (StrUtil.isBlank(processName)) { + throw new UtilException("Process name is blank!"); + } + final int atIndex = processName.indexOf('@'); + if (atIndex > 0) { + return Integer.parseInt(processName.substring(0, atIndex)); + } else { + return processName.hashCode(); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Range.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Range.java new file mode 100644 index 0000000..09c86d6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Range.java @@ -0,0 +1,233 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.thread.lock.NoLock; + +import java.io.Serializable; +import java.util.Iterator; +import java.util.NoSuchElementException; +import java.util.concurrent.locks.Lock; +import java.util.concurrent.locks.ReentrantLock; +import java.util.concurrent.locks.ReentrantReadWriteLock; + +/** + * 范围生成器。根据给定的初始值、结束值和步进生成一个步进列表生成器
+ * 由于用户自行实现{@link Stepper}来定义步进，因此Range本身无法判定边界（是否达到end），需在step实现边界判定逻辑。 + * + *

+ * 此类使用{@link ReentrantReadWriteLock}保证线程安全 + *

+ * + * @param 生成范围对象的类型 + * @author Looly + */ +public class Range implements Iterable, Iterator, Serializable { + private static final long serialVersionUID = 1L; + + /** + * 锁保证线程安全 + */ + private Lock lock = new ReentrantLock(); + /** + * 起始对象 + */ + private final T start; + /** + * 结束对象 + */ + private final T end; + /** + * 下一个对象 + */ + private T next; + /** + * 步进 + */ + private final Stepper stepper; + /** + * 索引 + */ + private int index = 0; + /** + * 是否包含第一个元素 + */ + private final boolean includeStart; + /** + * 是否包含最后一个元素 + */ + private final boolean includeEnd; + + /** + * 构造 + * + * @param start 起始对象（包括） + * @param stepper 步进 + */ + public Range(T start, Stepper stepper) { + this(start, null, stepper); + } + + /** + * 构造 + * + * @param start 起始对象（包含） + * @param end 结束对象（包含） + * @param stepper 步进 + */ + public Range(T start, T end, Stepper stepper) { + this(start, end, stepper, true, true); + } + + /** + * 构造 + * + * @param start 起始对象 + * @param end 结束对象 + * @param stepper 步进 + * @param isIncludeStart 是否包含第一个元素 + * @param isIncludeEnd 是否包含最后一个元素 + */ + public Range(T start, T end, Stepper stepper, boolean isIncludeStart, boolean isIncludeEnd) { + Assert.notNull(start, "First element must be not null!"); + this.start = start; + this.end = end; + this.stepper = stepper; + this.next = safeStep(this.start); + this.includeStart = isIncludeStart; + this.includeEnd = isIncludeEnd; + } + + /** + * 禁用锁，调用此方法后不再使用锁保护 + * + * @return this + * @since 4.3.1 + */ + public Range disableLock() { + this.lock = new NoLock(); + return this; + } + + @Override + public boolean hasNext() { + lock.lock(); + try { + if (0 == this.index && this.includeStart) { + return true; + } + if (null == this.next) { + return false; + } else if (false == includeEnd && this.next.equals(this.end)) { + return false; + } + } finally { + lock.unlock(); + } + return true; + } + + @Override + public T next() { + lock.lock(); + try { + if (false == this.hasNext()) { + throw new NoSuchElementException("Has no next range!"); + } + return nextUncheck(); + } finally { + lock.unlock(); + } + } + + /** + * 获取下一个元素，并将下下个元素准备好 + */ + private T nextUncheck() { + T current; + if(0 == this.index){ + current = start; + if(false == this.includeStart){ + // 获取下一组元素 + index ++; + return nextUncheck(); + } + } else { + current = next; + this.next = safeStep(this.next); + } + + index++; + return current; + } + + /** + * 不抛异常的获取下一步进的元素，如果获取失败返回{@code null} + * + * @param base 上一个元素 + * @return 下一步进 + */ + private T safeStep(T base) { + final int index = this.index; + T next = null; + try { + next = stepper.step(base, this.end, index); + } catch (Exception e) { + // ignore + } + + return next; + } + + @Override + public void remove() { + throw new UnsupportedOperationException("Can not remove ranged element!"); + } + + @Override + public Iterator iterator() { + return this; + } + + /** + * 重置Range + * + * @return this + */ + public Range reset() { + lock.lock(); + try { + this.index = 0; + this.next = safeStep(this.start); + } finally { + lock.unlock(); + } + return this; + } + + /** + * 步进接口，此接口用于实现如何对一个对象按照指定步进增加步进
+ * 步进接口可以定义以下逻辑： + * + * 
+	 * 1、步进规则，即对象如何做步进
+	 * 2、步进大小，通过实现此接口，在实现类中定义一个对象属性，可灵活定义步进大小
+	 * 3、限制range个数，通过实现此接口，在实现类中定义一个对象属性，可灵活定义limit，限制range个数
+	 *
+ * + * @param 需要增加步进的对象 + * @author Looly + */ + @FunctionalInterface + public interface Stepper { + /** + * 增加步进
+ * 增加步进后的返回值如果为{@code null}则表示步进结束
+ * 用户需根据end参数自行定义边界，当达到边界时返回null表示结束，否则Range中边界对象无效，会导致无限循环 + * + * @param current 上一次增加步进后的基础对象 + * @param end 结束对象 + * @param index 当前索引（步进到第几个元素），从0开始计数 + * @return 增加步进后的对象 + */ + T step(T current, T end, int index); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/RegexPool.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/RegexPool.java new file mode 100755 index 0000000..25bb2a8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/RegexPool.java @@ -0,0 +1,203 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +/** + * 常用正则表达式字符串池 + * + * @author looly + * @since 5.7.3 + */ +public interface RegexPool { + /** + * 英文字母 、数字和下划线 + */ + String GENERAL = "^\\w+$"; + /** + * 数字 + */ + String NUMBERS = "\\d+"; + /** + * 字母 + */ + String WORD = "[a-zA-Z]+"; + /** + * 单个中文汉字
+ * 参照维基百科汉字Unicode范围(https://zh.wikipedia.org/wiki/%E6%B1%89%E5%AD%97 页面右侧) + */ + String CHINESE = "[\u2E80-\u2EFF\u2F00-\u2FDF\u31C0-\u31EF\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF\uD840\uDC00-\uD869\uDEDF\uD869\uDF00-\uD86D\uDF3F\uD86D\uDF40-\uD86E\uDC1F\uD86E\uDC20-\uD873\uDEAF\uD87E\uDC00-\uD87E\uDE1F]"; + /** + * 中文汉字 + */ + String CHINESES = CHINESE + "+"; + /** + * 分组 + */ + String GROUP_VAR = "\\$(\\d+)"; + /** + * IP v4
+ * 采用分组方式便于解析地址的每一个段 + */ + //String IPV4 = "\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b"; + String IPV4 = "^(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)$"; + /** + * IP v6 + */ + String IPV6 = "(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]+|::(ffff(:0{1,4})?:)?((25[0-5]|(2[0-4]|1?[0-9])?[0-9])\\.){3}(25[0-5]|(2[0-4]|1?[0-9])?[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1?[0-9])?[0-9])\\.){3}(25[0-5]|(2[0-4]|1?[0-9])?[0-9]))"; + /** + * 货币 + */ + String MONEY = "^(\\d+(?:\\.\\d+)?)$"; + /** + * 邮件，符合RFC 5322规范，正则来自：http://emailregex.com/ + * What is the maximum length of a valid email address? https://stackoverflow.com/questions/386294/what-is-the-maximum-length-of-a-valid-email-address/44317754 + * 注意email 要宽松一点。比如 jetz.chong@hutool.cn、jetz-chong@ hutool.cn、jetz_chong@hutool.cn、dazhi.duan@hutool.cn 宽松一点把，都算是正常的邮箱 + */ + String EMAIL = "(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)])"; + /** + * 移动电话 + * eg: 中国大陆： +86 180 4953 1399，2位区域码标示+11位数字 + * 中国大陆 +86 Mainland China + */ + String MOBILE = "(?:0|86|\\+86)?1[3-9]\\d{9}"; + /** + * 中国香港移动电话 + * eg: 中国香港： +852 5100 4810， 三位区域码+10位数字, 中国香港手机号码8位数 + */ + String MOBILE_HK = "(?:0|852|\\+852)?\\d{8}"; + /** + * 中国台湾移动电话 + * eg: 中国台湾： +886 09 60 000000， 三位区域码+号码以数字09开头 + 8位数字, 中国台湾手机号码10位数 + * 中国台湾 +886 Taiwan 国际域名缩写：TW + */ + String MOBILE_TW = "(?:0|886|\\+886)?(?:|-)09\\d{8}"; + /** + * 中国澳门移动电话 + * eg: 中国澳门： +853 68 00000， 三位区域码 +号码以数字6开头 + 7位数字, 中国澳门手机号码8位数 + * 中国澳门 +853 Macao 国际域名缩写：MO + */ + String MOBILE_MO = "(?:0|853|\\+853)?(?:|-)6\\d{7}"; + /** + * 座机号码
+ * pr#387@Gitee + */ + String TEL = "(010|02\\d|0[3-9]\\d{2})-?(\\d{6,8})"; + /** + * 座机号码+400+800电话 + * + * @see 800 + */ + String TEL_400_800 = "0\\d{2,3}[\\- ]?[1-9]\\d{6,7}|[48]00[\\- ]?[1-9]\\d{6}"; + /** + * 18位身份证号码 + */ + String CITIZEN_ID = "[1-9]\\d{5}[1-2]\\d{3}((0\\d)|(1[0-2]))(([012]\\d)|3[0-1])\\d{3}(\\d|X|x)"; + /** + * 邮编，兼容港澳台 + */ + String ZIP_CODE = "^(0[1-7]|1[0-356]|2[0-7]|3[0-6]|4[0-7]|5[0-7]|6[0-7]|7[0-5]|8[0-9]|9[0-8])\\d{4}|99907[78]$"; + /** + * 生日 + */ + String BIRTHDAY = "^(\\d{2,4})([/\\-.年]?)(\\d{1,2})([/\\-.月]?)(\\d{1,2})日?$"; + /** + * URI
+ * 定义见：https://www.ietf.org/rfc/rfc3986.html#appendix-B + */ + String URI = "^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?"; + /** + * URL + */ + String URL = "[a-zA-Z]+://[\\w-+&@#/%?=~_|!:,.;]*[\\w-+&@#/%=~_|]"; + /** + * Http URL（来自：http://urlregex.com/）
+ * 此正则同时支持FTP、File等协议的URL + */ + String URL_HTTP = "(https?|ftp|file)://[\\w-+&@#/%?=~_|!:,.;]*[\\w-+&@#/%=~_|]"; + /** + * 中文字、英文字母、数字和下划线 + */ + String GENERAL_WITH_CHINESE = "^[\u4E00-\u9FFF\\w]+$"; + /** + * UUID + */ + String UUID = "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"; + /** + * 不带横线的UUID + */ + String UUID_SIMPLE = "^[0-9a-fA-F]{32}$"; + /** + * MAC地址正则 + */ + String MAC_ADDRESS = "((?:[a-fA-F0-9]{1,2}[:-]){5}[a-fA-F0-9]{1,2})|0x(\\d{12}).+ETHER"; + /** + * 16进制字符串 + */ + String HEX = "^[a-fA-F0-9]+$"; + /** + * 时间正则 + */ + String TIME = "\\d{1,2}:\\d{1,2}(:\\d{1,2})?"; + /** + * 中国车牌号码（兼容新能源车牌） + */ + String PLATE_NUMBER = + //https://gitee.com/dromara/hutool/issues/I1B77H?from=project-issue + "^(([京津沪渝冀豫云辽黑湘皖鲁新苏浙赣鄂桂甘晋蒙陕吉闽贵粤青藏川宁琼使领][A-Z](([0-9]{5}[ABCDEFGHJK])|([ABCDEFGHJK]([A-HJ-NP-Z0-9])[0-9]{4})))|" + + //https://gitee.com/dromara/hutool/issues/I1BJHE?from=project-issue + "([京津沪渝冀豫云辽黑湘皖鲁新苏浙赣鄂桂甘晋蒙陕吉闽贵粤青藏川宁琼使领]\\d{3}\\d{1,3}[领])|" + + "([京津沪渝冀豫云辽黑湘皖鲁新苏浙赣鄂桂甘晋蒙陕吉闽贵粤青藏川宁琼使领][A-Z][A-HJ-NP-Z0-9]{4}[A-HJ-NP-Z0-9挂学警港澳使领]))$"; + + /** + * 统一社会信用代码 + * 
+	 * 第一部分：登记管理部门代码1位 (数字或大写英文字母)
+	 * 第二部分：机构类别代码1位 (数字或大写英文字母)
+	 * 第三部分：登记管理机关行政区划码6位 (数字)
+	 * 第四部分：主体标识码（组织机构代码）9位 (数字或大写英文字母)
+	 * 第五部分：校验码1位 (数字或大写英文字母)
+	 *
+ */ + String CREDIT_CODE = "^[0-9A-HJ-NPQRTUWXY]{2}\\d{6}[0-9A-HJ-NPQRTUWXY]{10}$"; + /** + * 车架号 + * 别名：车辆识别代号 车辆识别码 + * eg:LDC613P23A1305189 + * eg:LSJA24U62JG269225 + * 十七位码、车架号 + * 车辆的唯一标示 + */ + String CAR_VIN = "^[A-HJ-NPR-Z0-9]{8}[0-9X][A-HJ-NPR-Z0-9]{2}\\d{6}$"; + /** + * 驾驶证 别名：驾驶证档案编号、行驶证编号 + * eg:430101758218 + * 12位数字字符串 + * 仅限：中国驾驶证档案编号 + */ + String CAR_DRIVING_LICENCE = "^[0-9]{12}$"; + /** + * 中文姓名 + * 维吾尔族姓名里面的点是 · 输入法中文状态下，键盘左上角数字1前面的那个符号；
+ * 错误字符：{@code ．.。．.}
+ * 正确维吾尔族姓名： + * 
+	 * 霍加阿卜杜拉·麦提喀斯木
+	 * 玛合萨提别克·哈斯木别克
+	 * 阿布都热依木江·艾斯卡尔
+	 * 阿卜杜尼亚孜·毛力尼亚孜
+	 *
+ * 
+	 * ----------
+	 * 错误示例：孟  伟                reason: 有空格
+	 * 错误示例：连逍遥0               reason: 数字
+	 * 错误示例：依帕古丽-艾则孜        reason: 特殊符号
+	 * 错误示例：牙力空.买提萨力        reason: 新疆人的点不对
+	 * 错误示例：王建鹏2002-3-2        reason: 有数字、特殊符号
+	 * 错误示例：雷金默(雷皓添）        reason: 有括号
+	 * 错误示例：翟冬:亮               reason: 有特殊符号
+	 * 错误示例：李                   reason: 少于2位
+	 * ----------
+	 *
+ * 总结中文姓名：2-60位，只能是中文和维吾尔族的点· + * 放宽汉字范围：如生僻姓名 刘欣䶮yǎn + */ + String CHINESE_NAME = "^[\u2E80-\u9FFF·]{2,60}$"; +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Replacer.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Replacer.java new file mode 100755 index 0000000..6f98b05 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Replacer.java @@ -0,0 +1,22 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +/** + * 替换器
+ * 通过实现此接口完成指定类型对象的替换操作，替换后的目标类型依旧为指定类型 + * + * @author looly + * + * @param 被替换操作的类型 + * @since 4.1.5 + */ +@FunctionalInterface +public interface Replacer { + + /** + * 替换指定类型为目标类型 + * + * @param t 被替换的对象 + * @return 替代后的对象 + */ + T replace(T t); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ResourceClassLoader.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ResourceClassLoader.java new file mode 100644 index 0000000..8d61707 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ResourceClassLoader.java @@ -0,0 +1,73 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.io.resource.Resource; +import aiyh.utils.tool.cn.hutool.core.util.ClassLoaderUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.security.SecureClassLoader; +import java.util.HashMap; +import java.util.Map; + +/** + * 资源类加载器，可以加载任意类型的资源类 + * + * @param {@link Resource}接口实现类 + * @author looly, lzpeng + * @since 5.5.2 + */ +public class ResourceClassLoader extends SecureClassLoader { + + private final Map resourceMap; + /** + * 缓存已经加载的类 + */ + private final Map> cacheClassMap; + + /** + * 构造 + * + * @param parentClassLoader 父类加载器，null表示默认当前上下文加载器 + * @param resourceMap 资源map + */ + public ResourceClassLoader(ClassLoader parentClassLoader, Map resourceMap) { + super(ObjectUtil.defaultIfNull(parentClassLoader, ClassLoaderUtil::getClassLoader)); + this.resourceMap = ObjectUtil.defaultIfNull(resourceMap, new HashMap<>()); + this.cacheClassMap = new HashMap<>(); + } + + /** + * 增加需要加载的类资源 + * + * @param resource 资源，可以是文件、流或者字符串 + * @return this + */ + public ResourceClassLoader addResource(T resource) { + this.resourceMap.put(resource.getName(), resource); + return this; + } + + @Override + protected Class findClass(String name) throws ClassNotFoundException { + final Class clazz = cacheClassMap.computeIfAbsent(name, this::defineByName); + if (clazz == null) { + return super.findClass(name); + } + return clazz; + } + + /** + * 从给定资源中读取class的二进制流，然后生成类
+ * 如果这个类资源不存在，返回{@code null} + * + * @param name 类名 + * @return 定义的类 + */ + private Class defineByName(String name) { + final Resource resource = resourceMap.get(name); + if (null != resource) { + final byte[] bytes = resource.readBytes(); + return defineClass(name, bytes, 0, bytes.length); + } + return null; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Segment.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Segment.java new file mode 100644 index 0000000..e4952ef --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Segment.java @@ -0,0 +1,41 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; + +import java.lang.reflect.Type; + +/** + * 片段表示，用于表示文本、集合等数据结构的一个区间。 + * @param 数字类型，用于表示位置index + * + * @author looly + * @since 5.5.3 + */ +public interface Segment { + + /** + * 获取起始位置 + * + * @return 起始位置 + */ + T getStartIndex(); + + /** + * 获取结束位置 + * + * @return 结束位置 + */ + T getEndIndex(); + + /** + * 片段长度，默认计算方法为abs({@link #getEndIndex()} - {@link #getEndIndex()}) + * + * @return 片段长度 + */ + default T length(){ + final T start = Assert.notNull(getStartIndex(), "Start index must be not null!"); + final T end = Assert.notNull(getEndIndex(), "End index must be not null!"); + return Convert.convert((Type) start.getClass(), NumberUtil.sub(end, start).abs()); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/SimpleCache.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/SimpleCache.java new file mode 100755 index 0000000..b7d57b9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/SimpleCache.java @@ -0,0 +1,192 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.collection.TransIter; +import aiyh.utils.tool.cn.hutool.core.lang.func.Func0; +import aiyh.utils.tool.cn.hutool.core.lang.mutable.Mutable; +import aiyh.utils.tool.cn.hutool.core.lang.mutable.MutableObj; +import aiyh.utils.tool.cn.hutool.core.map.SafeConcurrentHashMap; +import aiyh.utils.tool.cn.hutool.core.map.WeakConcurrentMap; + +import java.io.Serializable; +import java.util.Iterator; +import java.util.Map; +import java.util.WeakHashMap; +import java.util.concurrent.locks.Lock; +import java.util.concurrent.locks.ReadWriteLock; +import java.util.concurrent.locks.ReentrantLock; +import java.util.concurrent.locks.ReentrantReadWriteLock; +import java.util.function.Predicate; + +/** + * 简单缓存，无超时实现，默认使用{@link WeakConcurrentMap}实现缓存自动清理 + * + * @param 键类型 + * @param 值类型 + * @author Looly + */ +public class SimpleCache implements Iterable>, Serializable { + private static final long serialVersionUID = 1L; + + /** + * 池 + */ + private final Map, V> rawMap; + // 乐观读写锁 + private final ReadWriteLock lock = new ReentrantReadWriteLock(); + /** + * 写的时候每个key一把锁，降低锁的粒度 + */ + protected final Map keyLockMap = new SafeConcurrentHashMap<>(); + + /** + * 构造，默认使用{@link WeakHashMap}实现缓存自动清理 + */ + public SimpleCache() { + this(new WeakConcurrentMap<>()); + } + + /** + * 构造 + *

+ * 通过自定义Map初始化，可以自定义缓存实现。
+ * 比如使用{@link WeakHashMap}则会自动清理key，使用HashMap则不会清理
+ * 同时，传入的Map对象也可以自带初始化的键值对，防止在get时创建 + *

+ * + * @param initMap 初始Map，用于定义Map类型 + */ + public SimpleCache(Map, V> initMap) { + this.rawMap = initMap; + } + + /** + * 从缓存池中查找值 + * + * @param key 键 + * @return 值 + */ + public V get(K key) { + lock.readLock().lock(); + try { + return rawMap.get(MutableObj.of(key)); + } finally { + lock.readLock().unlock(); + } + } + + /** + * 从缓存中获得对象，当对象不在缓存中或已经过期返回Func0回调产生的对象 + * + * @param key 键 + * @param supplier 如果不存在回调方法，用于生产值对象 + * @return 值对象 + */ + public V get(K key, Func0 supplier) { + return get(key, null, supplier); + } + + /** + * 从缓存中获得对象，当对象不在缓存中或已经过期返回Func0回调产生的对象 + * + * @param key 键 + * @param validPredicate 检查结果对象是否可用，如是否断开连接等 + * @param supplier 如果不存在回调方法或结果不可用，用于生产值对象 + * @return 值对象 + * @since 5.7.9 + */ + public V get(K key, Predicate validPredicate, Func0 supplier) { + V v = get(key); + if((null != validPredicate && null != v && false == validPredicate.test(v))){ + v = null; + } + if (null == v && null != supplier) { + //每个key单独获取一把锁，降低锁的粒度提高并发能力，see pr#1385@Github + final Lock keyLock = keyLockMap.computeIfAbsent(key, k -> new ReentrantLock()); + keyLock.lock(); + try { + // 双重检查，防止在竞争锁的过程中已经有其它线程写入 + v = get(key); + if (null == v || (null != validPredicate && false == validPredicate.test(v))) { + try { + v = supplier.call(); + } catch (Exception e) { + throw new RuntimeException(e); + } + put(key, v); + } + } finally { + keyLock.unlock(); + keyLockMap.remove(key); + } + } + + return v; + } + + /** + * 放入缓存 + * + * @param key 键 + * @param value 值 + * @return 值 + */ + public V put(K key, V value) { + // 独占写锁 + lock.writeLock().lock(); + try { + rawMap.put(MutableObj.of(key), value); + } finally { + lock.writeLock().unlock(); + } + return value; + } + + /** + * 移除缓存 + * + * @param key 键 + * @return 移除的值 + */ + public V remove(K key) { + // 独占写锁 + lock.writeLock().lock(); + try { + return rawMap.remove(MutableObj.of(key)); + } finally { + lock.writeLock().unlock(); + } + } + + /** + * 清空缓存池 + */ + public void clear() { + // 独占写锁 + lock.writeLock().lock(); + try { + this.rawMap.clear(); + } finally { + lock.writeLock().unlock(); + } + } + + @Override + public Iterator> iterator() { + return new TransIter<>(this.rawMap.entrySet().iterator(), (entry)-> new Map.Entry() { + @Override + public K getKey() { + return entry.getKey().get(); + } + + @Override + public V getValue() { + return entry.getValue(); + } + + @Override + public V setValue(V value) { + return entry.setValue(value); + } + }); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Singleton.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Singleton.java new file mode 100755 index 0000000..7f99ba8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Singleton.java @@ -0,0 +1,161 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.lang.func.Func0; +import aiyh.utils.tool.cn.hutool.core.map.SafeConcurrentHashMap; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.Set; +import java.util.stream.Collectors; + +/** + * 单例类
+ * 提供单例对象的统一管理，当调用get方法时，如果对象池中存在此对象，返回此对象，否则创建新对象返回
+ * + * @author loolly + */ +public final class Singleton { + + private static final SafeConcurrentHashMap POOL = new SafeConcurrentHashMap<>(); + + private Singleton() { + } + + /** + * 获得指定类的单例对象
+ * 对象存在于池中返回，否则创建，每次调用此方法获得的对象为同一个对象
+ * 注意：单例针对的是类和参数，也就是说只有类、参数一致才会返回同一个对象 + * + * @param 单例对象类型 + * @param clazz 类 + * @param params 构造方法参数 + * @return 单例对象 + */ + public static T get(Class clazz, Object... params) { + Assert.notNull(clazz, "Class must be not null !"); + final String key = buildKey(clazz.getName(), params); + return get(key, () -> ReflectUtil.newInstance(clazz, params)); + } + + /** + * 获得指定类的单例对象
+ * 对象存在于池中返回，否则创建，每次调用此方法获得的对象为同一个对象
+ * + * @param 单例对象类型 + * @param key 自定义键 + * @param supplier 单例对象的创建函数 + * @return 单例对象 + * @since 5.3.3 + */ + @SuppressWarnings("unchecked") + public static T get(String key, Func0 supplier) { + return (T) POOL.computeIfAbsent(key, (k)-> supplier.callWithRuntimeException()); + } + + /** + * 获得指定类的单例对象
+ * 对象存在于池中返回，否则创建，每次调用此方法获得的对象为同一个对象
+ * + * @param 单例对象类型 + * @param className 类名 + * @param params 构造参数 + * @return 单例对象 + */ + public static T get(String className, Object... params) { + Assert.notBlank(className, "Class name must be not blank !"); + final Class clazz = ClassUtil.loadClass(className); + return get(clazz, params); + } + + /** + * 将已有对象放入单例中，其Class做为键 + * + * @param obj 对象 + * @since 4.0.7 + */ + public static void put(Object obj) { + Assert.notNull(obj, "Bean object must be not null !"); + put(obj.getClass().getName(), obj); + } + + /** + * 将已有对象放入单例中，key做为键 + * + * @param key 键 + * @param obj 对象 + * @since 5.3.3 + */ + public static void put(String key, Object obj) { + POOL.put(key, obj); + } + + /** + * 判断某个类的对象是否存在 + * + * @param clazz 类 + * @param params 构造参数 + * @return 是否存在 + */ + public static boolean exists(Class clazz, Object... params){ + if (null != clazz){ + final String key = buildKey(clazz.getName(), params); + return POOL.containsKey(key); + } + return false; + } + + /** + * 获取单例池中存在的所有类 + * + * @return 非重复的类集合 + */ + public static Set> getExistClass(){ + return POOL.values().stream().map(Object::getClass).collect(Collectors.toSet()); + } + + /** + * 移除指定Singleton对象 + * + * @param clazz 类 + */ + public static void remove(Class clazz) { + if (null != clazz) { + remove(clazz.getName()); + } + } + + /** + * 移除指定Singleton对象 + * + * @param key 键 + */ + public static void remove(String key) { + POOL.remove(key); + } + + /** + * 清除所有Singleton对象 + */ + public static void destroy() { + POOL.clear(); + } + + // ------------------------------------------------------------------------------------------- Private method start + + /** + * 构建key + * + * @param className 类名 + * @param params 参数列表 + * @return key + */ + private static String buildKey(String className, Object... params) { + if (ArrayUtil.isEmpty(params)) { + return className; + } + return StrUtil.format("{}#{}", className, ArrayUtil.join(params, "_")); + } + // ------------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Snowflake.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Snowflake.java new file mode 100755 index 0000000..ac2e6ac --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Snowflake.java @@ -0,0 +1,281 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.date.SystemClock; +import aiyh.utils.tool.cn.hutool.core.util.IdUtil; +import aiyh.utils.tool.cn.hutool.core.util.RandomUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.util.Date; + +/** + * Twitter的Snowflake 算法
+ * 分布式系统中，有一些需要使用全局唯一ID的场景，有些时候我们希望能使用一种简单一些的ID，并且希望ID能够按照时间有序生成。 + * + *

+ * snowflake的结构如下(每部分用-分开):
+ * + * 

+ * 符号位（1bit）- 时间戳相对值（41bit）- 数据中心标志（5bit）- 机器标志（5bit）- 递增序号（12bit）
+ * 0 - 0000000000 0000000000 0000000000 0000000000 0 - 00000 - 00000 - 000000000000
+ *
+ *

+ * 第一位为未使用(符号位表示正数)，接下来的41位为毫秒级时间(41位的长度可以使用69年)
+ * 然后是5位datacenterId和5位workerId(10位的长度最多支持部署1024个节点）
+ * 最后12位是毫秒内的计数（12位的计数顺序号支持每个节点每毫秒产生4096个ID序号） + *

+ * 并且可以通过生成的id反推出生成时间,datacenterId和workerId + *

+ * 参考：http://www.cnblogs.com/relucent/p/4955340.html
+ * 关于长度是18还是19的问题见：https://blog.csdn.net/unifirst/article/details/80408050 + * + * @author Looly + * @since 3.0.1 + */ +public class Snowflake implements Serializable { + private static final long serialVersionUID = 1L; + + + /** + * 默认的起始时间，为Thu, 04 Nov 2010 01:42:54 GMT + */ + public static long DEFAULT_TWEPOCH = 1288834974657L; + /** + * 默认回拨时间，2S + */ + public static long DEFAULT_TIME_OFFSET = 2000L; + + private static final long WORKER_ID_BITS = 5L; + // 最大支持机器节点数0~31，一共32个 + @SuppressWarnings({"PointlessBitwiseExpression", "FieldCanBeLocal"}) + private static final long MAX_WORKER_ID = -1L ^ (-1L << WORKER_ID_BITS); + private static final long DATA_CENTER_ID_BITS = 5L; + // 最大支持数据中心节点数0~31，一共32个 + @SuppressWarnings({"PointlessBitwiseExpression", "FieldCanBeLocal"}) + private static final long MAX_DATA_CENTER_ID = -1L ^ (-1L << DATA_CENTER_ID_BITS); + // 序列号12位（表示只允许workId的范围为：0-4095） + private static final long SEQUENCE_BITS = 12L; + // 机器节点左移12位 + private static final long WORKER_ID_SHIFT = SEQUENCE_BITS; + // 数据中心节点左移17位 + private static final long DATA_CENTER_ID_SHIFT = SEQUENCE_BITS + WORKER_ID_BITS; + // 时间毫秒数左移22位 + private static final long TIMESTAMP_LEFT_SHIFT = SEQUENCE_BITS + WORKER_ID_BITS + DATA_CENTER_ID_BITS; + // 序列掩码，用于限定序列最大值不能超过4095 + private static final long SEQUENCE_MASK = ~(-1L << SEQUENCE_BITS);// 4095 + + /** + * 初始化时间点 + */ + private final long twepoch; + private final long workerId; + private final long dataCenterId; + private final boolean useSystemClock; + /** + * 允许的时钟回拨毫秒数 + */ + private final long timeOffset; + /** + * 当在低频模式下时，序号始终为0，导致生成ID始终为偶数
+ * 此属性用于限定一个随机上限，在不同毫秒下生成序号时，给定一个随机数，避免偶数问题。
+ * 注意次数必须小于{@link #SEQUENCE_MASK}，{@code 0}表示不使用随机数。
+ * 这个上限不包括值本身。 + */ + private final long randomSequenceLimit; + + /** + * 自增序号，当高频模式下时，同一毫秒内生成N个ID，则这个序号在同一毫秒下，自增以避免ID重复。 + */ + private long sequence = 0L; + private long lastTimestamp = -1L; + + /** + * 构造，使用自动生成的工作节点ID和数据中心ID + */ + public Snowflake() { + this(IdUtil.getWorkerId(IdUtil.getDataCenterId(MAX_DATA_CENTER_ID), MAX_WORKER_ID)); + } + + /** + * 构造 + * + * @param workerId 终端ID + */ + public Snowflake(long workerId) { + this(workerId, IdUtil.getDataCenterId(MAX_DATA_CENTER_ID)); + } + + /** + * 构造 + * + * @param workerId 终端ID + * @param dataCenterId 数据中心ID + */ + public Snowflake(long workerId, long dataCenterId) { + this(workerId, dataCenterId, false); + } + + /** + * 构造 + * + * @param workerId 终端ID + * @param dataCenterId 数据中心ID + * @param isUseSystemClock 是否使用{@link SystemClock} 获取当前时间戳 + */ + public Snowflake(long workerId, long dataCenterId, boolean isUseSystemClock) { + this(null, workerId, dataCenterId, isUseSystemClock); + } + + /** + * @param epochDate 初始化时间起点（null表示默认起始日期）,后期修改会导致id重复,如果要修改连workerId dataCenterId，慎用 + * @param workerId 工作机器节点id + * @param dataCenterId 数据中心id + * @param isUseSystemClock 是否使用{@link SystemClock} 获取当前时间戳 + * @since 5.1.3 + */ + public Snowflake(Date epochDate, long workerId, long dataCenterId, boolean isUseSystemClock) { + this(epochDate, workerId, dataCenterId, isUseSystemClock, DEFAULT_TIME_OFFSET); + } + + /** + * @param epochDate 初始化时间起点（null表示默认起始日期）,后期修改会导致id重复,如果要修改连workerId dataCenterId，慎用 + * @param workerId 工作机器节点id + * @param dataCenterId 数据中心id + * @param isUseSystemClock 是否使用{@link SystemClock} 获取当前时间戳 + * @param timeOffset 允许时间回拨的毫秒数 + * @since 5.8.0 + */ + public Snowflake(Date epochDate, long workerId, long dataCenterId, boolean isUseSystemClock, long timeOffset) { + this(epochDate, workerId, dataCenterId, isUseSystemClock, timeOffset, 0); + } + + /** + * @param epochDate 初始化时间起点（null表示默认起始日期）,后期修改会导致id重复,如果要修改连workerId dataCenterId，慎用 + * @param workerId 工作机器节点id + * @param dataCenterId 数据中心id + * @param isUseSystemClock 是否使用{@link SystemClock} 获取当前时间戳 + * @param timeOffset 允许时间回拨的毫秒数 + * @param randomSequenceLimit 限定一个随机上限，在不同毫秒下生成序号时，给定一个随机数，避免偶数问题，0表示无随机，上限不包括值本身。 + * @since 5.8.0 + */ + public Snowflake(Date epochDate, long workerId, long dataCenterId, + boolean isUseSystemClock, long timeOffset, long randomSequenceLimit) { + this.twepoch = (null != epochDate) ? epochDate.getTime() : DEFAULT_TWEPOCH; + this.workerId = Assert.checkBetween(workerId, 0, MAX_WORKER_ID); + this.dataCenterId = Assert.checkBetween(dataCenterId, 0, MAX_DATA_CENTER_ID); + this.useSystemClock = isUseSystemClock; + this.timeOffset = timeOffset; + this.randomSequenceLimit = Assert.checkBetween(randomSequenceLimit, 0, SEQUENCE_MASK); + } + + /** + * 根据Snowflake的ID，获取机器id + * + * @param id snowflake算法生成的id + * @return 所属机器的id + */ + public long getWorkerId(long id) { + return id >> WORKER_ID_SHIFT & ~(-1L << WORKER_ID_BITS); + } + + /** + * 根据Snowflake的ID，获取数据中心id + * + * @param id snowflake算法生成的id + * @return 所属数据中心 + */ + public long getDataCenterId(long id) { + return id >> DATA_CENTER_ID_SHIFT & ~(-1L << DATA_CENTER_ID_BITS); + } + + /** + * 根据Snowflake的ID，获取生成时间 + * + * @param id snowflake算法生成的id + * @return 生成的时间 + */ + public long getGenerateDateTime(long id) { + return (id >> TIMESTAMP_LEFT_SHIFT & ~(-1L << 41L)) + twepoch; + } + + /** + * 下一个ID + * + * @return ID + */ + public synchronized long nextId() { + long timestamp = genTime(); + if (timestamp < this.lastTimestamp) { + if (this.lastTimestamp - timestamp < timeOffset) { + // 容忍指定的回拨，避免NTP校时造成的异常 + timestamp = lastTimestamp; + } else { + // 如果服务器时间有问题(时钟后退) 报错。 + throw new IllegalStateException(StrUtil.format("Clock moved backwards. Refusing to generate id for {}ms", lastTimestamp - timestamp)); + } + } + + if (timestamp == this.lastTimestamp) { + final long sequence = (this.sequence + 1) & SEQUENCE_MASK; + if (sequence == 0) { + timestamp = tilNextMillis(lastTimestamp); + } + this.sequence = sequence; + } else { + // issue#I51EJY + if (randomSequenceLimit > 1) { + sequence = RandomUtil.randomLong(randomSequenceLimit); + } else { + sequence = 0L; + } + } + + lastTimestamp = timestamp; + + return ((timestamp - twepoch) << TIMESTAMP_LEFT_SHIFT) + | (dataCenterId << DATA_CENTER_ID_SHIFT) + | (workerId << WORKER_ID_SHIFT) + | sequence; + } + + /** + * 下一个ID（字符串形式） + * + * @return ID 字符串形式 + */ + public String nextIdStr() { + return Long.toString(nextId()); + } + + // ------------------------------------------------------------------------------------------------------------------------------------ Private method start + + /** + * 循环等待下一个时间 + * + * @param lastTimestamp 上次记录的时间 + * @return 下一个时间 + */ + private long tilNextMillis(long lastTimestamp) { + long timestamp = genTime(); + // 循环直到操作系统时间戳变化 + while (timestamp == lastTimestamp) { + timestamp = genTime(); + } + if (timestamp < lastTimestamp) { + // 如果发现新的时间戳比上次记录的时间戳数值小，说明操作系统时间发生了倒退，报错 + throw new IllegalStateException( + StrUtil.format("Clock moved backwards. Refusing to generate id for {}ms", lastTimestamp - timestamp)); + } + return timestamp; + } + + /** + * 生成时间戳 + * + * @return 时间戳 + */ + private long genTime() { + return this.useSystemClock ? SystemClock.now() : System.currentTimeMillis(); + } + // ------------------------------------------------------------------------------------------------------------------------------------ Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Tuple.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Tuple.java new file mode 100644 index 0000000..a4394c4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Tuple.java @@ -0,0 +1,179 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.clone.CloneSupport; +import aiyh.utils.tool.cn.hutool.core.collection.ArrayIter; +import aiyh.utils.tool.cn.hutool.core.collection.ListUtil; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; + +import java.io.Serializable; +import java.util.Arrays; +import java.util.Iterator; +import java.util.List; +import java.util.Spliterator; +import java.util.Spliterators; +import java.util.stream.Stream; +import java.util.stream.StreamSupport; + +/** + * 不可变数组类型（元组），用于多值返回
+ * 多值可以支持每个元素值类型不同 + * + * @author Looly + */ +public class Tuple extends CloneSupport implements Iterable, Serializable { + private static final long serialVersionUID = -7689304393482182157L; + + private final Object[] members; + private int hashCode; + private boolean cacheHash; + + /** + * 构造 + * + * @param members 成员数组 + */ + public Tuple(Object... members) { + this.members = members; + } + + /** + * 获取指定位置元素 + * + * @param 返回对象类型 + * @param index 位置 + * @return 元素 + */ + @SuppressWarnings("unchecked") + public T get(int index) { + return (T) members[index]; + } + + /** + * 获得所有元素 + * + * @return 获得所有元素 + */ + public Object[] getMembers() { + return this.members; + } + + /** + * 将元组转换成列表 + * + * @return 转换得到的列表 + * @since 5.6.6 + */ + public final List toList() { + return ListUtil.toList(this.members); + } + + /** + * 缓存Hash值，当为true时，此对象的hash值只被计算一次，常用于Tuple中的值不变时使用。 + * 注意：当为true时，member变更对象后，hash值不会变更。 + * + * @param cacheHash 是否缓存hash值 + * @return this + * @since 5.2.1 + */ + public Tuple setCacheHash(boolean cacheHash) { + this.cacheHash = cacheHash; + return this; + } + + /** + * 得到元组的大小 + * + * @return 元组的大小 + * @since 5.6.6 + */ + public int size() { + return this.members.length; + } + + /** + * 判断元组中是否包含某元素 + * + * @param value 需要判定的元素 + * @return 是否包含 + * @since 5.6.6 + */ + public boolean contains(Object value) { + return ArrayUtil.contains(this.members, value); + } + + /** + * 将元组转成流 + * + * @return 流 + * @since 5.6.6 + */ + public final Stream stream() { + return Arrays.stream(this.members); + } + + /** + * 将元组转成并行流 + * + * @return 流 + * @since 5.6.6 + */ + public final Stream parallelStream() { + return StreamSupport.stream(spliterator(), true); + } + + /** + * 截取元组指定部分 + * + * @param start 起始位置（包括） + * @param end 终止位置（不包括） + * @return 截取得到的元组 + * @since 5.6.6 + */ + public final Tuple sub(final int start, final int end) { + return new Tuple(ArrayUtil.sub(this.members, start, end)); + } + + @Override + public int hashCode() { + if (this.cacheHash && 0 != this.hashCode) { + return this.hashCode; + } + final int prime = 31; + int result = 1; + result = prime * result + Arrays.deepHashCode(members); + if (this.cacheHash) { + this.hashCode = result; + } + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + Tuple other = (Tuple) obj; + return false != Arrays.deepEquals(members, other.members); + } + + @Override + public String toString() { + return Arrays.toString(members); + } + + @Override + public Iterator iterator() { + return new ArrayIter<>(members); + } + + @Override + public final Spliterator spliterator() { + return Spliterators.spliterator(this.members, Spliterator.ORDERED); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/TypeReference.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/TypeReference.java new file mode 100755 index 0000000..7d76ec9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/TypeReference.java @@ -0,0 +1,51 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import java.lang.reflect.Type; + +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +/** + * Type类型参考
+ * 通过构建一个类型参考子类，可以获取其泛型参数中的Type类型。例如： + * + * 
+ * TypeReference<List<String>> list = new TypeReference<List<String>>() {};
+ * Type t = tr.getType();
+ *
+ * + * 此类无法应用于通配符泛型参数（wildcard parameters），比如：{@code Class} 或者 {@code List? extends CharSequence>} + * + *

+ * 此类参考FastJSON的TypeReference实现 + * + * @author looly + * + * @param 需要自定义的参考类型 + * @since 4.2.2 + */ +public abstract class TypeReference implements Type { + + /** 泛型参数 */ + private final Type type; + + /** + * 构造 + */ + public TypeReference() { + this.type = TypeUtil.getTypeArgument(getClass()); + } + + /** + * 获取用户定义的泛型参数 + * + * @return 泛型参数 + */ + public Type getType() { + return this.type; + } + + @Override + public String toString() { + return this.type.toString(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/UUID.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/UUID.java new file mode 100755 index 0000000..32711d0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/UUID.java @@ -0,0 +1,447 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.util.RandomUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.security.SecureRandom; +import java.util.Random; + +/** + * 提供通用唯一识别码（universally unique identifier）（UUID）实现，UUID表示一个128位的值。
+ * 此类拷贝自java.util.UUID，用于生成不带-的UUID字符串 + * + *

+ * 这些通用标识符具有不同的变体。此类的方法用于操作 Leach-Salz 变体，不过构造方法允许创建任何 UUID 变体（将在下面进行描述）。 + *

+ * 变体 2 (Leach-Salz) UUID 的布局如下： long 型数据的最高有效位由以下无符号字段组成： + * + * 

+ * 0xFFFFFFFF00000000 time_low
+ * 0x00000000FFFF0000 time_mid
+ * 0x000000000000F000 version
+ * 0x0000000000000FFF time_hi
+ *
+ *

+ * long 型数据的最低有效位由以下无符号字段组成： + * + * 

+ * 0xC000000000000000 variant
+ * 0x3FFF000000000000 clock_seq
+ * 0x0000FFFFFFFFFFFF node
+ *
+ * + *

+ * variant 字段包含一个表示 UUID 布局的值。以上描述的位布局仅在 UUID 的 variant 值为 2（表示 Leach-Salz 变体）时才有效。 * + *

+ * version 字段保存描述此 UUID 类型的值。有 4 种不同的基本 UUID 类型：基于时间的 UUID、DCE 安全 UUID、基于名称的 UUID 和随机生成的 UUID。
+ * 这些类型的 version 值分别为 1、2、3 和 4。 + * + * @since 4.1.11 + */ +public class UUID implements java.io.Serializable, Comparable { + private static final long serialVersionUID = -1185015143654744140L; + + /** + * {@link SecureRandom} 的单例 + * + * @author looly + */ + private static class Holder { + static final SecureRandom NUMBER_GENERATOR = RandomUtil.getSecureRandom(); + } + + /** + * 此UUID的最高64有效位 + */ + private final long mostSigBits; + + /** + * 此UUID的最低64有效位 + */ + private final long leastSigBits; + + /** + * 私有构造 + * + * @param data 数据 + */ + private UUID(byte[] data) { + long msb = 0; + long lsb = 0; + assert data.length == 16 : "data must be 16 bytes in length"; + for (int i = 0; i < 8; i++) { + msb = (msb << 8) | (data[i] & 0xff); + } + for (int i = 8; i < 16; i++) { + lsb = (lsb << 8) | (data[i] & 0xff); + } + this.mostSigBits = msb; + this.leastSigBits = lsb; + } + + /** + * 使用指定的数据构造新的 UUID。 + * + * @param mostSigBits 用于 {@code UUID} 的最高有效 64 位 + * @param leastSigBits 用于 {@code UUID} 的最低有效 64 位 + */ + public UUID(long mostSigBits, long leastSigBits) { + this.mostSigBits = mostSigBits; + this.leastSigBits = leastSigBits; + } + + /** + * 获取类型 4（伪随机生成的）UUID 的静态工厂。 使用加密的本地线程伪随机数生成器生成该 UUID。 + * + * @return 随机生成的 {@code UUID} + */ + public static UUID fastUUID() { + return randomUUID(false); + } + + /** + * 获取类型 4（伪随机生成的）UUID 的静态工厂。 使用加密的强伪随机数生成器生成该 UUID。 + * + * @return 随机生成的 {@code UUID} + */ + public static UUID randomUUID() { + return randomUUID(true); + } + + /** + * 获取类型 4（伪随机生成的）UUID 的静态工厂。 使用加密的强伪随机数生成器生成该 UUID。 + * + * @param isSecure 是否使用{@link SecureRandom}如果是可以获得更安全的随机码，否则可以得到更好的性能 + * @return 随机生成的 {@code UUID} + */ + public static UUID randomUUID(boolean isSecure) { + final Random ng = isSecure ? Holder.NUMBER_GENERATOR : RandomUtil.getRandom(); + + final byte[] randomBytes = new byte[16]; + ng.nextBytes(randomBytes); + + randomBytes[6] &= 0x0f; /* clear version */ + randomBytes[6] |= 0x40; /* set to version 4 */ + randomBytes[8] &= 0x3f; /* clear variant */ + randomBytes[8] |= 0x80; /* set to IETF variant */ + + return new UUID(randomBytes); + } + + /** + * 根据指定的字节数组获取类型 3（基于名称的）UUID 的静态工厂。 + * + * @param name 用于构造 UUID 的字节数组。 + * @return 根据指定数组生成的 {@code UUID} + */ + public static UUID nameUUIDFromBytes(byte[] name) { + MessageDigest md; + try { + md = MessageDigest.getInstance("MD5"); + } catch (NoSuchAlgorithmException nsae) { + throw new InternalError("MD5 not supported"); + } + byte[] md5Bytes = md.digest(name); + md5Bytes[6] &= 0x0f; /* clear version */ + md5Bytes[6] |= 0x30; /* set to version 3 */ + md5Bytes[8] &= 0x3f; /* clear variant */ + md5Bytes[8] |= 0x80; /* set to IETF variant */ + return new UUID(md5Bytes); + } + + /** + * 根据 {@link #toString()} 方法中描述的字符串标准表示形式创建{@code UUID}。 + * + * @param name 指定 {@code UUID} 字符串 + * @return 具有指定值的 {@code UUID} + * @throws IllegalArgumentException 如果 name 与 {@link #toString} 中描述的字符串表示形式不符抛出此异常 + */ + public static UUID fromString(String name) { + String[] components = name.split("-"); + if (components.length != 5) { + throw new IllegalArgumentException("Invalid UUID string: " + name); + } + for (int i = 0; i < 5; i++) { + components[i] = "0x" + components[i]; + } + + long mostSigBits = Long.decode(components[0]); + mostSigBits <<= 16; + mostSigBits |= Long.decode(components[1]); + mostSigBits <<= 16; + mostSigBits |= Long.decode(components[2]); + + long leastSigBits = Long.decode(components[3]); + leastSigBits <<= 48; + leastSigBits |= Long.decode(components[4]); + + return new UUID(mostSigBits, leastSigBits); + } + + /** + * 返回此 UUID 的 128 位值中的最低有效 64 位。 + * + * @return 此 UUID 的 128 位值中的最低有效 64 位。 + */ + public long getLeastSignificantBits() { + return leastSigBits; + } + + /** + * 返回此 UUID 的 128 位值中的最高有效 64 位。 + * + * @return 此 UUID 的 128 位值中最高有效 64 位。 + */ + public long getMostSignificantBits() { + return mostSigBits; + } + + /** + * 与此 {@code UUID} 相关联的版本号. 版本号描述此 {@code UUID} 是如何生成的。 + *

+ * 版本号具有以下含意: + *

    + *
  • 1 基于时间的 UUID + *
  • 2 DCE 安全 UUID + *
  • 3 基于名称的 UUID + *
  • 4 随机生成的 UUID + *
+ * + * @return 此 {@code UUID} 的版本号 + */ + public int version() { + // Version is bits masked by 0x000000000000F000 in MS long + return (int) ((mostSigBits >> 12) & 0x0f); + } + + /** + * 与此 {@code UUID} 相关联的变体号。变体号描述 {@code UUID} 的布局。 + *

+ * 变体号具有以下含意： + *

    + *
  • 0 为 NCS 向后兼容保留 + *
  • 2 IETF RFC 4122(Leach-Salz), 用于此类 + *
  • 6 保留，微软向后兼容 + *
  • 7 保留供以后定义使用 + *
+ * + * @return 此 {@code UUID} 相关联的变体号 + */ + public int variant() { + // This field is composed of a varying number of bits. + // 0 - - Reserved for NCS backward compatibility + // 1 0 - The IETF aka Leach-Salz variant (used by this class) + // 1 1 0 Reserved, Microsoft backward compatibility + // 1 1 1 Reserved for future definition. + return (int) ((leastSigBits >>> (64 - (leastSigBits >>> 62))) & (leastSigBits >> 63)); + } + + /** + * 与此 UUID 相关联的时间戳值。 + * + *

+ * 60 位的时间戳值根据此 {@code UUID} 的 time_low、time_mid 和 time_hi 字段构造。
+ * 所得到的时间戳以 100 毫微秒为单位，从 UTC（通用协调时间） 1582 年 10 月 15 日零时开始。 + * + *

+ * 时间戳值仅在在基于时间的 UUID（其 version 类型为 1）中才有意义。
+ * 如果此 {@code UUID} 不是基于时间的 UUID，则此方法抛出 UnsupportedOperationException。 + * + * @return 时间戳值 + * @throws UnsupportedOperationException 如果此 {@code UUID} 不是 version 为 1 的 UUID。 + */ + public long timestamp() throws UnsupportedOperationException { + checkTimeBase(); + return (mostSigBits & 0x0FFFL) << 48// + | ((mostSigBits >> 16) & 0x0FFFFL) << 32// + | mostSigBits >>> 32; + } + + /** + * 与此 UUID 相关联的时钟序列值。 + * + *

+ * 14 位的时钟序列值根据此 UUID 的 clock_seq 字段构造。clock_seq 字段用于保证在基于时间的 UUID 中的时间唯一性。 + *

+ * {@code clockSequence} 值仅在基于时间的 UUID（其 version 类型为 1）中才有意义。 如果此 UUID 不是基于时间的 UUID，则此方法抛出 UnsupportedOperationException。 + * + * @return 此 {@code UUID} 的时钟序列 + * @throws UnsupportedOperationException 如果此 UUID 的 version 不为 1 + */ + public int clockSequence() throws UnsupportedOperationException { + checkTimeBase(); + return (int) ((leastSigBits & 0x3FFF000000000000L) >>> 48); + } + + /** + * 与此 UUID 相关的节点值。 + * + *

+ * 48 位的节点值根据此 UUID 的 node 字段构造。此字段旨在用于保存机器的 IEEE 802 地址，该地址用于生成此 UUID 以保证空间唯一性。 + *

+ * 节点值仅在基于时间的 UUID（其 version 类型为 1）中才有意义。
+ * 如果此 UUID 不是基于时间的 UUID，则此方法抛出 UnsupportedOperationException。 + * + * @return 此 {@code UUID} 的节点值 + * @throws UnsupportedOperationException 如果此 UUID 的 version 不为 1 + */ + public long node() throws UnsupportedOperationException { + checkTimeBase(); + return leastSigBits & 0x0000FFFFFFFFFFFFL; + } + + // Object Inherited Methods + + /** + * 返回此{@code UUID} 的字符串表现形式。 + * + *

+ * UUID 的字符串表示形式由此 BNF 描述： + * + * 

+	 * {@code
+	 * UUID                   = ----
+	 * time_low               = 4*
+	 * time_mid               = 2*
+	 * time_high_and_version  = 2*
+	 * variant_and_sequence   = 2*
+	 * node                   = 6*
+	 * hexOctet               = 
+	 * hexDigit               = [0-9a-fA-F]
+	 * }
+	 *
+ * + * @return 此{@code UUID} 的字符串表现形式 + * @see #toString(boolean) + */ + @Override + public String toString() { + return toString(false); + } + + /** + * 返回此{@code UUID} 的字符串表现形式。 + * + *

+ * UUID 的字符串表示形式由此 BNF 描述： + * + * 

+	 * {@code
+	 * UUID                   = ----
+	 * time_low               = 4*
+	 * time_mid               = 2*
+	 * time_high_and_version  = 2*
+	 * variant_and_sequence   = 2*
+	 * node                   = 6*
+	 * hexOctet               = 
+	 * hexDigit               = [0-9a-fA-F]
+	 * }
+	 *
+ * + * @param isSimple 是否简单模式，简单模式为不带'-'的UUID字符串 + * @return 此{@code UUID} 的字符串表现形式 + */ + public String toString(boolean isSimple) { + final StringBuilder builder = StrUtil.builder(isSimple ? 32 : 36); + // time_low + builder.append(digits(mostSigBits >> 32, 8)); + if (false == isSimple) { + builder.append('-'); + } + // time_mid + builder.append(digits(mostSigBits >> 16, 4)); + if (false == isSimple) { + builder.append('-'); + } + // time_high_and_version + builder.append(digits(mostSigBits, 4)); + if (false == isSimple) { + builder.append('-'); + } + // variant_and_sequence + builder.append(digits(leastSigBits >> 48, 4)); + if (false == isSimple) { + builder.append('-'); + } + // node + builder.append(digits(leastSigBits, 12)); + + return builder.toString(); + } + + /** + * 返回此 UUID 的哈希码。 + * + * @return UUID 的哈希码值。 + */ + @Override + public int hashCode() { + long hilo = mostSigBits ^ leastSigBits; + return ((int) (hilo >> 32)) ^ (int) hilo; + } + + /** + * 将此对象与指定对象比较。 + *

+ * 当且仅当参数不为 {@code null}、而是一个 UUID 对象、具有与此 UUID 相同的 varriant、包含相同的值（每一位均相同）时，结果才为 {@code true}。 + * + * @param obj 要与之比较的对象 + * @return 如果对象相同，则返回 {@code true}；否则返回 {@code false} + */ + @Override + public boolean equals(Object obj) { + if ((null == obj) || (obj.getClass() != UUID.class)) { + return false; + } + UUID id = (UUID) obj; + return (mostSigBits == id.mostSigBits && leastSigBits == id.leastSigBits); + } + + // Comparison Operations + + /** + * 将此 UUID 与指定的 UUID 比较。 + * + *

+ * 如果两个 UUID 不同，且第一个 UUID 的最高有效字段大于第二个 UUID 的对应字段，则第一个 UUID 大于第二个 UUID。 + * + * @param val 与此 UUID 比较的 UUID + * @return 在此 UUID 小于、等于或大于 val 时，分别返回 -1、0 或 1。 + */ + @Override + public int compareTo(UUID val) { + // The ordering is intentionally set up so that the UUIDs + // can simply be numerically compared as two numbers + int compare = Long.compare(this.mostSigBits, val.mostSigBits); + if(0 == compare){ + compare = Long.compare(this.leastSigBits, val.leastSigBits); + } + return compare; + } + + // ------------------------------------------------------------------------------------------------------------------- Private method start + + /** + * 返回指定数字对应的hex值 + * + * @param val 值 + * @param digits 位 + * @return 值 + */ + private static String digits(long val, int digits) { + long hi = 1L << (digits * 4); + return Long.toHexString(hi | (val & (hi - 1))).substring(1); + } + + /** + * 检查是否为time-based版本UUID + */ + private void checkTimeBase() { + if (version() != 1) { + throw new UnsupportedOperationException("Not a time-based UUID"); + } + } + // ------------------------------------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Validator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Validator.java new file mode 100755 index 0000000..8ed65c9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/Validator.java @@ -0,0 +1,1239 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.date.DateUtil; +import aiyh.utils.tool.cn.hutool.core.exceptions.ValidateException; +import aiyh.utils.tool.cn.hutool.core.util.CreditCodeUtil; +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import aiyh.utils.tool.cn.hutool.core.util.IdcardUtil; + +import java.net.MalformedURLException; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * 字段验证器（验证器），分两种类型的验证： + * + *

    + *
  • isXXX：通过返回boolean值判断是否满足给定格式。
    • + *
  • validateXXX：通过抛出异常{@link ValidateException}检查是否满足给定格式。
    • + *
+ *

+ * 主要验证字段非空、是否为满足指定格式等（如是否为Email、电话等） + * + * @author Looly + */ +public class Validator { + + /** + * 英文字母 、数字和下划线 + */ + public final static Pattern GENERAL = PatternPool.GENERAL; + /** + * 数字 + */ + public final static Pattern NUMBERS = PatternPool.NUMBERS; + /** + * 分组 + */ + public final static Pattern GROUP_VAR = PatternPool.GROUP_VAR; + /** + * IP v4 + */ + public final static Pattern IPV4 = PatternPool.IPV4; + /** + * IP v6 + */ + public final static Pattern IPV6 = PatternPool.IPV6; + /** + * 货币 + */ + public final static Pattern MONEY = PatternPool.MONEY; + /** + * 邮件 + */ + public final static Pattern EMAIL = PatternPool.EMAIL; + /** + * 移动电话 + */ + public final static Pattern MOBILE = PatternPool.MOBILE; + + /** + * 身份证号码 + */ + public final static Pattern CITIZEN_ID = PatternPool.CITIZEN_ID; + + /** + * 邮编 + */ + public final static Pattern ZIP_CODE = PatternPool.ZIP_CODE; + /** + * 生日 + */ + public final static Pattern BIRTHDAY = PatternPool.BIRTHDAY; + /** + * URL + */ + public final static Pattern URL = PatternPool.URL; + /** + * Http URL + */ + public final static Pattern URL_HTTP = PatternPool.URL_HTTP; + /** + * 中文字、英文字母、数字和下划线 + */ + public final static Pattern GENERAL_WITH_CHINESE = PatternPool.GENERAL_WITH_CHINESE; + /** + * UUID + */ + public final static Pattern UUID = PatternPool.UUID; + /** + * 不带横线的UUID + */ + public final static Pattern UUID_SIMPLE = PatternPool.UUID_SIMPLE; + /** + * 中国车牌号码 + */ + public final static Pattern PLATE_NUMBER = PatternPool.PLATE_NUMBER; + /** + * 车架号;别名：车辆识别代号 车辆识别码；十七位码 + */ + public final static Pattern CAR_VIN = PatternPool.CAR_VIN; + /** + * 驾驶证 别名：驾驶证档案编号、行驶证编号；12位数字字符串；仅限：中国驾驶证档案编号 + */ + public final static Pattern CAR_DRIVING_LICENCE = PatternPool.CAR_DRIVING_LICENCE; + + /** + * 给定值是否为{@code true} + * + * @param value 值 + * @return 是否为true + * @since 4.4.5 + */ + public static boolean isTrue(boolean value) { + return value; + } + + /** + * 给定值是否不为{@code false} + * + * @param value 值 + * @return 是否不为false + * @since 4.4.5 + */ + public static boolean isFalse(boolean value) { + return false == value; + } + + /** + * 检查指定值是否为{@code true} + * + * @param value 值 + * @param errorMsgTemplate 错误消息内容模板（变量使用{}表示） + * @param params 模板中变量替换后的值 + * @return 检查过后的值 + * @throws ValidateException 检查不满足条件抛出的异常 + * @since 4.4.5 + */ + public static boolean validateTrue(boolean value, String errorMsgTemplate, Object... params) throws ValidateException { + if (isFalse(value)) { + throw new ValidateException(errorMsgTemplate, params); + } + return true; + } + + /** + * 检查指定值是否为{@code false} + * + * @param value 值 + * @param errorMsgTemplate 错误消息内容模板（变量使用{}表示） + * @param params 模板中变量替换后的值 + * @return 检查过后的值 + * @throws ValidateException 检查不满足条件抛出的异常 + * @since 4.4.5 + */ + public static boolean validateFalse(boolean value, String errorMsgTemplate, Object... params) throws ValidateException { + if (isTrue(value)) { + throw new ValidateException(errorMsgTemplate, params); + } + return false; + } + + /** + * 给定值是否为{@code null} + * + * @param value 值 + * @return 是否为null + */ + public static boolean isNull(Object value) { + return null == value; + } + + /** + * 给定值是否不为{@code null} + * + * @param value 值 + * @return 是否不为null + */ + public static boolean isNotNull(Object value) { + return null != value; + } + + /** + * 检查指定值是否为{@code null} + * + * @param 被检查的对象类型 + * @param value 值 + * @param errorMsgTemplate 错误消息内容模板（变量使用{}表示） + * @param params 模板中变量替换后的值 + * @return 检查过后的值 + * @throws ValidateException 检查不满足条件抛出的异常 + * @since 4.4.5 + */ + public static T validateNull(T value, String errorMsgTemplate, Object... params) throws ValidateException { + if (isNotNull(value)) { + throw new ValidateException(errorMsgTemplate, params); + } + return null; + } + + /** + * 检查指定值是否非{@code null} + * + * @param 被检查的对象类型 + * @param value 值 + * @param errorMsgTemplate 错误消息内容模板（变量使用{}表示） + * @param params 模板中变量替换后的值 + * @return 检查过后的值 + * @throws ValidateException 检查不满足条件抛出的异常 + */ + public static T validateNotNull(T value, String errorMsgTemplate, Object... params) throws ValidateException { + if (isNull(value)) { + throw new ValidateException(errorMsgTemplate, params); + } + return value; + } + + /** + * 验证是否为空
+ * 对于String类型判定是否为empty(null 或 "")
+ * + * @param value 值 + * @return 是否为空 + */ + public static boolean isEmpty(Object value) { + return (null == value || (value instanceof String && StrUtil.isEmpty((String) value))); + } + + /** + * 验证是否为非空
+ * 对于String类型判定是否为empty(null 或 "")
+ * + * @param value 值 + * @return 是否为空 + */ + public static boolean isNotEmpty(Object value) { + return false == isEmpty(value); + } + + /** + * 验证是否为空，非空时抛出异常
+ * 对于String类型判定是否为empty(null 或 "")
+ * + * @param 值类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值，验证通过返回此值，空值 + * @throws ValidateException 验证异常 + */ + public static T validateEmpty(T value, String errorMsg) throws ValidateException { + if (isNotEmpty(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为非空，为空时抛出异常
+ * 对于String类型判定是否为empty(null 或 "")
+ * + * @param 值类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值，验证通过返回此值，非空值 + * @throws ValidateException 验证异常 + */ + public static T validateNotEmpty(T value, String errorMsg) throws ValidateException { + if (isEmpty(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否相等
+ * 当两值都为null返回true + * + * @param t1 对象1 + * @param t2 对象2 + * @return 当两值都为null或相等返回true + */ + public static boolean equal(Object t1, Object t2) { + return ObjectUtil.equal(t1, t2); + } + + /** + * 验证是否相等，不相等抛出异常
+ * + * @param t1 对象1 + * @param t2 对象2 + * @param errorMsg 错误信息 + * @return 相同值 + * @throws ValidateException 验证异常 + */ + public static Object validateEqual(Object t1, Object t2, String errorMsg) throws ValidateException { + if (false == equal(t1, t2)) { + throw new ValidateException(errorMsg); + } + return t1; + } + + /** + * 验证是否不等，相等抛出异常
+ * + * @param t1 对象1 + * @param t2 对象2 + * @param errorMsg 错误信息 + * @throws ValidateException 验证异常 + */ + public static void validateNotEqual(Object t1, Object t2, String errorMsg) throws ValidateException { + if (equal(t1, t2)) { + throw new ValidateException(errorMsg); + } + } + + /** + * 验证是否非空且与指定值相等
+ * 当数据为空时抛出验证异常
+ * 当两值不等时抛出异常 + * + * @param t1 对象1 + * @param t2 对象2 + * @param errorMsg 错误信息 + * @throws ValidateException 验证异常 + */ + public static void validateNotEmptyAndEqual(Object t1, Object t2, String errorMsg) throws ValidateException { + validateNotEmpty(t1, errorMsg); + validateEqual(t1, t2, errorMsg); + } + + /** + * 验证是否非空且与指定值相等
+ * 当数据为空时抛出验证异常
+ * 当两值相等时抛出异常 + * + * @param t1 对象1 + * @param t2 对象2 + * @param errorMsg 错误信息 + * @throws ValidateException 验证异常 + */ + public static void validateNotEmptyAndNotEqual(Object t1, Object t2, String errorMsg) throws ValidateException { + validateNotEmpty(t1, errorMsg); + validateNotEqual(t1, t2, errorMsg); + } + + /** + * 通过正则表达式验证
+ * 不符合正则抛出{@link ValidateException} 异常 + * + * @param 字符串类型 + * @param regex 正则 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateMatchRegex(String regex, T value, String errorMsg) throws ValidateException { + if (false == isMatchRegex(regex, value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 通过正则表达式验证 + * + * @param pattern 正则模式 + * @param value 值 + * @return 是否匹配正则 + */ + public static boolean isMatchRegex(Pattern pattern, CharSequence value) { + return ReUtil.isMatch(pattern, value); + } + + /** + * 通过正则表达式验证 + * + * @param regex 正则 + * @param value 值 + * @return 是否匹配正则 + */ + public static boolean isMatchRegex(String regex, CharSequence value) { + return ReUtil.isMatch(regex, value); + } + + /** + * 验证是否为英文字母 、数字和下划线 + * + * @param value 值 + * @return 是否为英文字母 、数字和下划线 + */ + public static boolean isGeneral(CharSequence value) { + return isMatchRegex(GENERAL, value); + } + + /** + * 验证是否为英文字母 、数字和下划线 + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateGeneral(T value, String errorMsg) throws ValidateException { + if (false == isGeneral(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为给定长度范围的英文字母 、数字和下划线 + * + * @param value 值 + * @param min 最小长度，负数自动识别为0 + * @param max 最大长度，0或负数表示不限制最大长度 + * @return 是否为给定长度范围的英文字母 、数字和下划线 + */ + public static boolean isGeneral(CharSequence value, int min, int max) { + if (min < 0) { + min = 0; + } + String reg = "^\\w{" + min + "," + max + "}$"; + if (max <= 0) { + reg = "^\\w{" + min + ",}$"; + } + return isMatchRegex(reg, value); + } + + /** + * 验证是否为给定长度范围的英文字母 、数字和下划线 + * + * @param 字符串类型 + * @param value 值 + * @param min 最小长度，负数自动识别为0 + * @param max 最大长度，0或负数表示不限制最大长度 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateGeneral(T value, int min, int max, String errorMsg) throws ValidateException { + if (false == isGeneral(value, min, max)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为给定最小长度的英文字母 、数字和下划线 + * + * @param value 值 + * @param min 最小长度，负数自动识别为0 + * @return 是否为给定最小长度的英文字母 、数字和下划线 + */ + public static boolean isGeneral(CharSequence value, int min) { + return isGeneral(value, min, 0); + } + + /** + * 验证是否为给定最小长度的英文字母 、数字和下划线 + * + * @param 字符串类型 + * @param value 值 + * @param min 最小长度，负数自动识别为0 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateGeneral(T value, int min, String errorMsg) throws ValidateException { + return validateGeneral(value, min, 0, errorMsg); + } + + /** + * 判断字符串是否全部为字母组成，包括大写和小写字母和汉字 + * + * @param value 值 + * @return 是否全部为字母组成，包括大写和小写字母和汉字 + * @since 3.3.0 + */ + public static boolean isLetter(CharSequence value) { + return StrUtil.isAllCharMatch(value, Character::isLetter); + } + + /** + * 验证是否全部为字母组成，包括大写和小写字母和汉字 + * + * @param 字符串类型 + * @param value 表单值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + * @since 3.3.0 + */ + public static T validateLetter(T value, String errorMsg) throws ValidateException { + if (false == isLetter(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 判断字符串是否全部为大写字母 + * + * @param value 值 + * @return 是否全部为大写字母 + * @since 3.3.0 + */ + public static boolean isUpperCase(CharSequence value) { + return StrUtil.isAllCharMatch(value, Character::isUpperCase); + } + + /** + * 验证字符串是否全部为大写字母 + * + * @param 字符串类型 + * @param value 表单值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + * @since 3.3.0 + */ + public static T validateUpperCase(T value, String errorMsg) throws ValidateException { + if (false == isUpperCase(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 判断字符串是否全部为小写字母 + * + * @param value 值 + * @return 是否全部为小写字母 + * @since 3.3.0 + */ + public static boolean isLowerCase(CharSequence value) { + return StrUtil.isAllCharMatch(value, Character::isLowerCase); + } + + /** + * 验证字符串是否全部为小写字母 + * + * @param 字符串类型 + * @param value 表单值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + * @since 3.3.0 + */ + public static T validateLowerCase(T value, String errorMsg) throws ValidateException { + if (false == isLowerCase(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证该字符串是否是数字 + * + * @param value 字符串内容 + * @return 是否是数字 + */ + public static boolean isNumber(CharSequence value) { + return NumberUtil.isNumber(value); + } + + /** + * 是否包含数字 + * + * @param value 当前字符串 + * @return boolean 是否存在数字 + * @since 5.6.5 + */ + public static boolean hasNumber(CharSequence value) { + return ReUtil.contains(PatternPool.NUMBERS, value); + } + + /** + * 验证是否为数字 + * + * @param value 表单值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static String validateNumber(String value, String errorMsg) throws ValidateException { + if (false == isNumber(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证该字符串是否是字母（包括大写和小写字母） + * + * @param value 字符串内容 + * @return 是否是字母（包括大写和小写字母） + * @since 4.1.8 + */ + public static boolean isWord(CharSequence value) { + return isMatchRegex(PatternPool.WORD, value); + } + + /** + * 验证是否为字母（包括大写和小写字母） + * + * @param 字符串类型 + * @param value 表单值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + * @since 4.1.8 + */ + public static T validateWord(T value, String errorMsg) throws ValidateException { + if (false == isWord(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为货币 + * + * @param value 值 + * @return 是否为货币 + */ + public static boolean isMoney(CharSequence value) { + return isMatchRegex(MONEY, value); + } + + /** + * 验证是否为货币 + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateMoney(T value, String errorMsg) throws ValidateException { + if (false == isMoney(value)) { + throw new ValidateException(errorMsg); + } + return value; + + } + + /** + * 验证是否为邮政编码（中国） + * + * @param value 值 + * @return 是否为邮政编码（中国） + */ + public static boolean isZipCode(CharSequence value) { + return isMatchRegex(ZIP_CODE, value); + } + + /** + * 验证是否为邮政编码（中国） + * + * @param 字符串类型 + * @param value 表单值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateZipCode(T value, String errorMsg) throws ValidateException { + if (false == isZipCode(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为可用邮箱地址 + * + * @param value 值 + * @return true为可用邮箱地址 + */ + public static boolean isEmail(CharSequence value) { + return isMatchRegex(EMAIL, value); + } + + /** + * 验证是否为可用邮箱地址 + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateEmail(T value, String errorMsg) throws ValidateException { + if (false == isEmail(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为手机号码（中国） + * + * @param value 值 + * @return 是否为手机号码（中国） + */ + public static boolean isMobile(CharSequence value) { + return isMatchRegex(MOBILE, value); + } + + /** + * 验证是否为手机号码（中国） + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateMobile(T value, String errorMsg) throws ValidateException { + if (false == isMobile(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为身份证号码（支持18位、15位和港澳台的10位） + * + * @param value 身份证号，支持18位、15位和港澳台的10位 + * @return 是否为有效身份证号码 + */ + public static boolean isCitizenId(CharSequence value) { + return IdcardUtil.isValidCard(String.valueOf(value)); + } + + /** + * 验证是否为身份证号码（支持18位、15位和港澳台的10位） + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateCitizenIdNumber(T value, String errorMsg) throws ValidateException { + if (false == isCitizenId(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为生日 + * + * @param year 年，从1900年开始计算 + * @param month 月，从1开始计数 + * @param day 日，从1开始计数 + * @return 是否为生日 + */ + public static boolean isBirthday(int year, int month, int day) { + // 验证年 + int thisYear = DateUtil.thisYear(); + if (year < 1900 || year > thisYear) { + return false; + } + + // 验证月 + if (month < 1 || month > 12) { + return false; + } + + // 验证日 + if (day < 1 || day > 31) { + return false; + } + // 检查几个特殊月的最大天数 + if (day == 31 && (month == 4 || month == 6 || month == 9 || month == 11)) { + return false; + } + if (month == 2) { + // 在2月，非闰年最大28，闰年最大29 + return day < 29 || (day == 29 && DateUtil.isLeapYear(year)); + } + return true; + } + + /** + * 验证是否为生日
+ * 只支持以下几种格式： + *

    + *
  • yyyyMMdd
    • + *
  • yyyy-MM-dd
    • + *
  • yyyy/MM/dd
    • + *
  • yyyy.MM.dd
    • + *
  • yyyy年MM月dd日
    • + *
+ * + * @param value 值 + * @return 是否为生日 + */ + public static boolean isBirthday(CharSequence value) { + final Matcher matcher = BIRTHDAY.matcher(value); + if (matcher.find()) { + int year = Integer.parseInt(matcher.group(1)); + int month = Integer.parseInt(matcher.group(3)); + int day = Integer.parseInt(matcher.group(5)); + return isBirthday(year, month, day); + } + return false; + } + + /** + * 验证验证是否为生日 + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateBirthday(T value, String errorMsg) throws ValidateException { + if (false == isBirthday(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为IPV4地址 + * + * @param value 值 + * @return 是否为IPV4地址 + */ + public static boolean isIpv4(CharSequence value) { + return isMatchRegex(IPV4, value); + } + + /** + * 验证是否为IPV4地址 + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateIpv4(T value, String errorMsg) throws ValidateException { + if (false == isIpv4(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为IPV6地址 + * + * @param value 值 + * @return 是否为IPV6地址 + */ + public static boolean isIpv6(CharSequence value) { + return isMatchRegex(IPV6, value); + } + + /** + * 验证是否为IPV6地址 + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateIpv6(T value, String errorMsg) throws ValidateException { + if (false == isIpv6(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为MAC地址 + * + * @param value 值 + * @return 是否为MAC地址 + * @since 4.1.3 + */ + public static boolean isMac(CharSequence value) { + return isMatchRegex(PatternPool.MAC_ADDRESS, value); + } + + /** + * 验证是否为MAC地址 + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + * @since 4.1.3 + */ + public static T validateMac(T value, String errorMsg) throws ValidateException { + if (false == isMac(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为中国车牌号 + * + * @param value 值 + * @return 是否为中国车牌号 + * @since 3.0.6 + */ + public static boolean isPlateNumber(CharSequence value) { + return isMatchRegex(PLATE_NUMBER, value); + } + + /** + * 验证是否为中国车牌号 + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + * @since 3.0.6 + */ + public static T validatePlateNumber(T value, String errorMsg) throws ValidateException { + if (false == isPlateNumber(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为URL + * + * @param value 值 + * @return 是否为URL + */ + public static boolean isUrl(CharSequence value) { + if (StrUtil.isBlank(value)) { + return false; + } + try { + new java.net.URL(StrUtil.str(value)); + } catch (MalformedURLException e) { + return false; + } + return true; + } + + /** + * 验证是否为URL + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateUrl(T value, String errorMsg) throws ValidateException { + if (false == isUrl(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否都为汉字 + * + * @param value 值 + * @return 是否为汉字 + */ + public static boolean isChinese(CharSequence value) { + return isMatchRegex(PatternPool.CHINESES, value); + } + + /** + * 验证是否包含汉字 + * + * @param value 值 + * @return 是否包含汉字 + * @since 5.2.1 + */ + public static boolean hasChinese(CharSequence value) { + return ReUtil.contains(ReUtil.RE_CHINESES, value); + } + + /** + * 验证是否为汉字 + * + * @param 字符串类型 + * @param value 表单值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateChinese(T value, String errorMsg) throws ValidateException { + if (false == isChinese(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为中文字、英文字母、数字和下划线 + * + * @param value 值 + * @return 是否为中文字、英文字母、数字和下划线 + */ + public static boolean isGeneralWithChinese(CharSequence value) { + return isMatchRegex(GENERAL_WITH_CHINESE, value); + } + + /** + * 验证是否为中文字、英文字母、数字和下划线 + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateGeneralWithChinese(T value, String errorMsg) throws ValidateException { + if (false == isGeneralWithChinese(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为UUID
+ * 包括带横线标准格式和不带横线的简单模式 + * + * @param value 值 + * @return 是否为UUID + */ + public static boolean isUUID(CharSequence value) { + return isMatchRegex(UUID, value) || isMatchRegex(UUID_SIMPLE, value); + } + + /** + * 验证是否为UUID
+ * 包括带横线标准格式和不带横线的简单模式 + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + */ + public static T validateUUID(T value, String errorMsg) throws ValidateException { + if (false == isUUID(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为Hex（16进制）字符串 + * + * @param value 值 + * @return 是否为Hex（16进制）字符串 + * @since 4.3.3 + */ + public static boolean isHex(CharSequence value) { + return isMatchRegex(PatternPool.HEX, value); + } + + /** + * 验证是否为Hex（16进制）字符串 + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + * @since 4.3.3 + */ + public static T validateHex(T value, String errorMsg) throws ValidateException { + if (false == isHex(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 检查给定的数字是否在指定范围内 + * + * @param value 值 + * @param min 最小值（包含） + * @param max 最大值（包含） + * @return 是否满足 + * @since 4.1.10 + */ + public static boolean isBetween(Number value, Number min, Number max) { + Assert.notNull(value); + Assert.notNull(min); + Assert.notNull(max); + final double doubleValue = value.doubleValue(); + return (doubleValue >= min.doubleValue()) && (doubleValue <= max.doubleValue()); + } + + /** + * 检查给定的数字是否在指定范围内 + * + * @param value 值 + * @param min 最小值（包含） + * @param max 最大值（包含） + * @param errorMsg 验证错误的信息 + * @throws ValidateException 验证异常 + * @since 4.1.10 + */ + public static void validateBetween(Number value, Number min, Number max, String errorMsg) throws ValidateException { + if (false == isBetween(value, min, max)) { + throw new ValidateException(errorMsg); + } + } + + /** + * 是否是有效的统一社会信用代码 + * 
+	 * 第一部分：登记管理部门代码1位 (数字或大写英文字母)
+	 * 第二部分：机构类别代码1位 (数字或大写英文字母)
+	 * 第三部分：登记管理机关行政区划码6位 (数字)
+	 * 第四部分：主体标识码（组织机构代码）9位 (数字或大写英文字母)
+	 * 第五部分：校验码1位 (数字或大写英文字母)
+	 *
+ * + * @param creditCode 统一社会信用代码 + * @return 校验结果 + * @since 5.2.4 + */ + public static boolean isCreditCode(CharSequence creditCode) { + return CreditCodeUtil.isCreditCode(creditCode); + } + + /** + * 验证是否为车架号；别名：行驶证编号 车辆识别代号 车辆识别码 + * + * @param value 值，17位车架号；形如：LSJA24U62JG269225、LDC613P23A1305189 + * @return 是否为车架号 + * @author dazer and ourslook + * @since 5.6.3 + */ + public static boolean isCarVin(CharSequence value) { + return isMatchRegex(CAR_VIN, value); + } + + /** + * 验证是否为车架号；别名：行驶证编号 车辆识别代号 车辆识别码 + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + * @author dazer and ourslook + * @since 5.6.3 + */ + public static T validateCarVin(T value, String errorMsg) throws ValidateException { + if (false == isCarVin(value)) { + throw new ValidateException(errorMsg); + } + return value; + } + + /** + * 验证是否为驾驶证 别名：驾驶证档案编号、行驶证编号 + * 仅限：中国驾驶证档案编号 + * + * @param value 值，12位数字字符串,eg:430101758218 + * @return 是否为档案编号 + * @author dazer and ourslook + * @since 5.6.3 + */ + public static boolean isCarDrivingLicence(CharSequence value) { + return isMatchRegex(CAR_DRIVING_LICENCE, value); + } + + + /** + * 是否是中文姓名 + * 维吾尔族姓名里面的点是 · 输入法中文状态下，键盘左上角数字1前面的那个符号；
+ * 错误字符：{@code ．.。．.}
+ * 正确维吾尔族姓名： + * 
+	 * 霍加阿卜杜拉·麦提喀斯木
+	 * 玛合萨提别克·哈斯木别克
+	 * 阿布都热依木江·艾斯卡尔
+	 * 阿卜杜尼亚孜·毛力尼亚孜
+	 *
+ * 
+	 * ----------
+	 * 错误示例：孟  伟                reason: 有空格
+	 * 错误示例：连逍遥0               reason: 数字
+	 * 错误示例：依帕古丽-艾则孜        reason: 特殊符号
+	 * 错误示例：牙力空.买提萨力        reason: 新疆人的点不对
+	 * 错误示例：王建鹏2002-3-2        reason: 有数字、特殊符号
+	 * 错误示例：雷金默(雷皓添）        reason: 有括号
+	 * 错误示例：翟冬:亮               reason: 有特殊符号
+	 * 错误示例：李                   reason: 少于2位
+	 * ----------
+	 *
+ * 总结中文姓名：2-60位，只能是中文和 · + * + * @param value 中文姓名 + * @return 是否是正确的中文姓名 + * @author dazer + * @since 5.8.0.M3 + */ + public static boolean isChineseName(CharSequence value) { + return isMatchRegex(PatternPool.CHINESE_NAME, value); + } + + + /** + * 验证是否为驾驶证 别名：驾驶证档案编号、行驶证编号 + * + * @param 字符串类型 + * @param value 值 + * @param errorMsg 验证错误的信息 + * @return 验证后的值 + * @throws ValidateException 验证异常 + * @author dazer and ourslook + * @since 5.6.3 + */ + public static T validateCarDrivingLicence(T value, String errorMsg) throws ValidateException { + if (false == isCarDrivingLicence(value)) { + throw new ValidateException(errorMsg); + } + return value; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/WeightRandom.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/WeightRandom.java new file mode 100755 index 0000000..c03361e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/WeightRandom.java @@ -0,0 +1,235 @@ +package aiyh.utils.tool.cn.hutool.core.lang; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.RandomUtil; + +import java.io.Serializable; +import java.util.Random; +import java.util.SortedMap; +import java.util.TreeMap; + +/** + * 权重随机算法实现
+ *

+ * 平时，经常会遇到权重随机算法，从不同权重的N个元素中随机选择一个，并使得总体选择结果是按照权重分布的。如广告投放、负载均衡等。 + *

+ *

+ * 如有4个元素A、B、C、D，权重分别为1、2、3、4，随机结果中A:B:C:D的比例要为1:2:3:4。
+ *

+ * 总体思路：累加每个元素的权重A(1)-B(3)-C(6)-D(10)，则4个元素的的权重管辖区间分别为[0,1)、[1,3)、[3,6)、[6,10)。
+ * 然后随机出一个[0,10)之间的随机数。落在哪个区间，则该区间之后的元素即为按权重命中的元素。
+ * + *

+ * 参考博客：https://www.cnblogs.com/waterystone/p/5708063.html + *

+ * + * @param 权重随机获取的对象类型 + * @author looly + * @since 3.3.0 + */ +public class WeightRandom implements Serializable { + private static final long serialVersionUID = -8244697995702786499L; + + private final TreeMap weightMap; + + + /** + * 创建权重随机获取器 + * + * @param 权重随机获取的对象类型 + * @return {@link WeightRandom} + */ + public static WeightRandom create() { + return new WeightRandom<>(); + } + + // ---------------------------------------------------------------------------------- Constructor start + /** + * 构造 + */ + public WeightRandom() { + weightMap = new TreeMap<>(); + + } + + /** + * 构造 + * + * @param weightObj 带有权重的对象 + */ + public WeightRandom(WeightObj weightObj) { + this(); + if(null != weightObj) { + add(weightObj); + } + } + + /** + * 构造 + * + * @param weightObjs 带有权重的对象 + */ + public WeightRandom(Iterable> weightObjs) { + this(); + if(CollUtil.isNotEmpty(weightObjs)) { + for (WeightObj weightObj : weightObjs) { + add(weightObj); + } + } + } + + /** + * 构造 + * + * @param weightObjs 带有权重的对象 + */ + public WeightRandom(WeightObj[] weightObjs) { + this(); + for (WeightObj weightObj : weightObjs) { + add(weightObj); + } + } + // ---------------------------------------------------------------------------------- Constructor end + + /** + * 增加对象 + * + * @param obj 对象 + * @param weight 权重 + * @return this + */ + public WeightRandom add(T obj, double weight) { + return add(new WeightObj<>(obj, weight)); + } + + /** + * 增加对象权重 + * + * @param weightObj 权重对象 + * @return this + */ + public WeightRandom add(WeightObj weightObj) { + if(null != weightObj) { + final double weight = weightObj.getWeight(); + if(weightObj.getWeight() > 0) { + double lastWeight = (this.weightMap.size() == 0) ? 0 : this.weightMap.lastKey(); + this.weightMap.put(weight + lastWeight, weightObj.getObj());// 权重累加 + } + } + return this; + } + + /** + * 清空权重表 + * + * @return this + */ + public WeightRandom clear() { + if(null != this.weightMap) { + this.weightMap.clear(); + } + return this; + } + + /** + * 下一个随机对象 + * + * @return 随机对象 + */ + public T next() { + if(MapUtil.isEmpty(this.weightMap)) { + return null; + } + final Random random = RandomUtil.getRandom(); + final double randomWeight = this.weightMap.lastKey() * random.nextDouble(); + final SortedMap tailMap = this.weightMap.tailMap(randomWeight, false); + return this.weightMap.get(tailMap.firstKey()); + } + + /** + * 带有权重的对象包装 + * + * @author looly + * + * @param 对象类型 + */ + public static class WeightObj { + /** 对象 */ + private T obj; + /** 权重 */ + private final double weight; + + /** + * 构造 + * + * @param obj 对象 + * @param weight 权重 + */ + public WeightObj(T obj, double weight) { + this.obj = obj; + this.weight = weight; + } + + /** + * 获取对象 + * + * @return 对象 + */ + public T getObj() { + return obj; + } + + /** + * 设置对象 + * + * @param obj 对象 + */ + public void setObj(T obj) { + this.obj = obj; + } + + /** + * 获取权重 + * + * @return 权重 + */ + public double getWeight() { + return weight; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((obj == null) ? 0 : obj.hashCode()); + long temp; + temp = Double.doubleToLongBits(weight); + result = prime * result + (int) (temp ^ (temp >>> 32)); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + WeightObj other = (WeightObj) obj; + if (this.obj == null) { + if (other.obj != null) { + return false; + } + } else if (!this.obj.equals(other.obj)) { + return false; + } + return Double.doubleToLongBits(weight) == Double.doubleToLongBits(other.weight); + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/Ansi8BitColor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/Ansi8BitColor.java new file mode 100755 index 0000000..f5d5969 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/Ansi8BitColor.java @@ -0,0 +1,93 @@ +package aiyh.utils.tool.cn.hutool.core.lang.ansi; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +/** + * ANSI 8-bit前景或背景色（即8位编码，共256种颜色（2^8） ）
+ *

    + *
  • 0-7： 标准颜色（同ESC [ 30–37 m）
    • + *
  • 8-15： 高强度颜色（同ESC [ 90–97 m）
    • + *
  • 16-231（6 × 6 × 6 共 216色）： 16 + 36 × r + 6 × g + b (0 ≤ r, g, b ≤ 5)
    • + *
  • 232-255： 从黑到白的24阶灰度色
    • + *
+ * + *

来自Spring Boot

+ * + * @author Toshiaki Maki, Phillip Webb + * @see #foreground(int) + * @see #background(int) + * @since 5.8.0 + */ +public final class Ansi8BitColor implements AnsiElement { + + private static final String PREFIX_FORE = "38;5;"; + private static final String PREFIX_BACK = "48;5;"; + + /** + * 前景色ANSI颜色实例 + * + * @param code 颜色代码(0-255) + * @return 前景色ANSI颜色实例 + */ + public static Ansi8BitColor foreground(int code) { + return new Ansi8BitColor(PREFIX_FORE, code); + } + + /** + * 背景色ANSI颜色实例 + * + * @param code 颜色代码(0-255) + * @return 背景色ANSI颜色实例 + */ + public static Ansi8BitColor background(int code) { + return new Ansi8BitColor(PREFIX_BACK, code); + } + + private final String prefix; + private final int code; + + /** + * 构造 + * + * @param prefix 前缀 + * @param code 颜色代码(0-255) + * @throws IllegalArgumentException 颜色代码不在0~255范围内 + */ + private Ansi8BitColor(String prefix, int code) { + Assert.isTrue(code >= 0 && code <= 255, "Code must be between 0 and 255"); + this.prefix = prefix; + this.code = code; + } + + /** + * 获取颜色代码(0-255) + * + * @return 颜色代码(0 - 255) + */ + @Override + public int getCode() { + return this.code; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null || getClass() != obj.getClass()) { + return false; + } + Ansi8BitColor other = (Ansi8BitColor) obj; + return this.prefix.equals(other.prefix) && this.code == other.code; + } + + @Override + public int hashCode() { + return this.prefix.hashCode() * 31 + this.code; + } + + @Override + public String toString() { + return this.prefix + this.code; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiBackground.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiBackground.java new file mode 100755 index 0000000..42e6227 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiBackground.java @@ -0,0 +1,121 @@ +package aiyh.utils.tool.cn.hutool.core.lang.ansi; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * ANSI背景颜色枚举 + * + *

来自Spring Boot

+ * + * @author Phillip Webb, Geoffrey Chandler + * @since 5.8.0 + */ +public enum AnsiBackground implements AnsiElement { + + /** + * 默认背景色 + */ + DEFAULT(49), + + /** + * 黑色 + */ + BLACK(40), + + /** + * 红 + */ + RED(41), + + /** + * 绿 + */ + GREEN(42), + + /** + * 黄 + */ + YELLOW(43), + + /** + * 蓝 + */ + BLUE(44), + + /** + * 品红 + */ + MAGENTA(45), + + /** + * 青 + */ + CYAN(46), + + /** + * 白 + */ + WHITE(47), + + /** + * 亮黑 + */ + BRIGHT_BLACK(100), + + /** + * 亮红 + */ + BRIGHT_RED(101), + + /** + * 亮绿 + */ + BRIGHT_GREEN(102), + + /** + * 亮黄 + */ + BRIGHT_YELLOW(103), + + /** + * 亮蓝 + */ + BRIGHT_BLUE(104), + + /** + * 亮品红 + */ + BRIGHT_MAGENTA(105), + + /** + * 亮青 + */ + BRIGHT_CYAN(106), + + /** + * 亮白 + */ + BRIGHT_WHITE(107); + + private final int code; + + AnsiBackground(int code) { + this.code = code; + } + + /** + * 获取ANSI颜色代码 + * + * @return 颜色代码 + */ + @Override + public int getCode() { + return this.code; + } + + @Override + public String toString() { + return StrUtil.toString(this.code); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiColor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiColor.java new file mode 100755 index 0000000..392d8d1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiColor.java @@ -0,0 +1,121 @@ +package aiyh.utils.tool.cn.hutool.core.lang.ansi; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * ANSI标准颜色 + * + *

来自Spring Boot

+ * + * @author Phillip Webb, Geoffrey Chandler + * @since 5.8.0 + */ +public enum AnsiColor implements AnsiElement { + + /** + * 默认前景色 + */ + DEFAULT(39), + + /** + * 黑 + */ + BLACK(30), + + /** + * 红 + */ + RED(31), + + /** + * 绿 + */ + GREEN(32), + + /** + * 黄 + */ + YELLOW(33), + + /** + * 蓝 + */ + BLUE(34), + + /** + * 品红 + */ + MAGENTA(35), + + /** + * 青 + */ + CYAN(36), + + /** + * 白 + */ + WHITE(37), + + /** + * 亮黑 + */ + BRIGHT_BLACK(90), + + /** + * 亮红 + */ + BRIGHT_RED(91), + + /** + * 亮绿 + */ + BRIGHT_GREEN(92), + + /** + * 亮黄 + */ + BRIGHT_YELLOW(93), + + /** + * 亮蓝 + */ + BRIGHT_BLUE(94), + + /** + * 亮品红 + */ + BRIGHT_MAGENTA(95), + + /** + * 亮青 + */ + BRIGHT_CYAN(96), + + /** + * 亮白 + */ + BRIGHT_WHITE(97); + + private final int code; + + AnsiColor(int code) { + this.code = code; + } + + /** + * 获取ANSI颜色代码 + * + * @return 颜色代码 + */ + @Override + public int getCode() { + return this.code; + } + + @Override + public String toString() { + return StrUtil.toString(this.code); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiColorWrapper.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiColorWrapper.java new file mode 100644 index 0000000..7bc2df2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiColorWrapper.java @@ -0,0 +1,80 @@ +package aiyh.utils.tool.cn.hutool.core.lang.ansi; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.Objects; + +/** + * ANSI 颜色包装类 + * + * @author TomXin + * @since 5.8.6 + */ +public class AnsiColorWrapper { + + private final int code; + + private final AnsiColors.BitDepth bitDepth; + + /** + * 创建指定位深度的 {@code AnsiColorWrapper} 实例 + * + * @param code 颜色编码，位深度为4bit时，code取值范围[30~37]，[90~97]。位深度为8bit时，code取值范围[0~255] + * @param bitDepth 位深度 + */ + public AnsiColorWrapper(int code, AnsiColors.BitDepth bitDepth) { + if (bitDepth == AnsiColors.BitDepth.FOUR) { + Assert.isTrue((30 <= code && code <= 37) || (90 <= code && code <= 97), "The value of 4 bit color only supported [30~37],[90~97]."); + } + Assert.isTrue((0 <= code && code <= 255), "The value of 8 bit color only supported [0~255]."); + this.code = code; + this.bitDepth = bitDepth; + } + + /** + * 转换为 {@link AnsiElement} 实例 + * + * @param foreOrBack 区分前景还是背景 + * @return {@link AnsiElement} 实例 + */ + public AnsiElement toAnsiElement(ForeOrBack foreOrBack) { + if (bitDepth == AnsiColors.BitDepth.FOUR) { + if (foreOrBack == ForeOrBack.FORE) { + for (AnsiColor item : AnsiColor.values()) { + if (item.getCode() == this.code) { + return item; + } + } + throw new IllegalArgumentException(StrUtil.format("No matched AnsiColor instance,code={}", this.code)); + } + for (AnsiBackground item : AnsiBackground.values()) { + if (item.getCode() == this.code + 10) { + return item; + } + } + throw new IllegalArgumentException(StrUtil.format("No matched AnsiBackground instance,code={}", this.code)); + } + if (foreOrBack == ForeOrBack.FORE) { + return Ansi8BitColor.foreground(this.code); + } + return Ansi8BitColor.background(this.code); + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + AnsiColorWrapper that = (AnsiColorWrapper) o; + return this.code == that.code && this.bitDepth == that.bitDepth; + } + + @Override + public int hashCode() { + return Objects.hash(this.code, this.bitDepth); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiColors.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiColors.java new file mode 100644 index 0000000..b776825 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiColors.java @@ -0,0 +1,153 @@ +package aiyh.utils.tool.cn.hutool.core.lang.ansi; + +import aiyh.utils.tool.cn.hutool.core.img.LabColor; + +import java.awt.Color; +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.Map; + +/** + * + * 在 {@link Color AWT Colors} 的上下文中使用 {@link AnsiColor} 的实用程序 + *

来自Spring Boot

+ * + * @author Craig Burke,Ruben Dijkstra,Phillip Webb,Michael Simons,Tom Xin + * @since 5.8.6 + */ +public final class AnsiColors { + + private static final Map ANSI_COLOR_MAP; + + /** + * @see AnsiColor#BRIGHT_WHITE + */ + private static final int CODE_OF_4_BIT_ANSI_COLOR_BRIGHT_WHITE = 97; + + static { + Map colorMap = new LinkedHashMap<>(16, 1); + colorMap.put(new AnsiColorWrapper(AnsiColor.BLACK.getCode(), BitDepth.FOUR), new LabColor(0x000000)); + colorMap.put(new AnsiColorWrapper(AnsiColor.RED.getCode(), BitDepth.FOUR), new LabColor(0xAA0000)); + colorMap.put(new AnsiColorWrapper(AnsiColor.GREEN.getCode(), BitDepth.FOUR), new LabColor(0x00AA00)); + colorMap.put(new AnsiColorWrapper(AnsiColor.YELLOW.getCode(), BitDepth.FOUR), new LabColor(0xAA5500)); + colorMap.put(new AnsiColorWrapper(AnsiColor.BLUE.getCode(), BitDepth.FOUR), new LabColor(0x0000AA)); + colorMap.put(new AnsiColorWrapper(AnsiColor.MAGENTA.getCode(), BitDepth.FOUR), new LabColor(0xAA00AA)); + colorMap.put(new AnsiColorWrapper(AnsiColor.CYAN.getCode(), BitDepth.FOUR), new LabColor(0x00AAAA)); + colorMap.put(new AnsiColorWrapper(AnsiColor.WHITE.getCode(), BitDepth.FOUR), new LabColor(0xAAAAAA)); + colorMap.put(new AnsiColorWrapper(AnsiColor.BRIGHT_BLACK.getCode(), BitDepth.FOUR), new LabColor(0x555555)); + colorMap.put(new AnsiColorWrapper(AnsiColor.BRIGHT_RED.getCode(), BitDepth.FOUR), new LabColor(0xFF5555)); + colorMap.put(new AnsiColorWrapper(AnsiColor.BRIGHT_GREEN.getCode(), BitDepth.FOUR), new LabColor(0x55FF00)); + colorMap.put(new AnsiColorWrapper(AnsiColor.BRIGHT_YELLOW.getCode(), BitDepth.FOUR), new LabColor(0xFFFF55)); + colorMap.put(new AnsiColorWrapper(AnsiColor.BRIGHT_BLUE.getCode(), BitDepth.FOUR), new LabColor(0x5555FF)); + colorMap.put(new AnsiColorWrapper(AnsiColor.BRIGHT_MAGENTA.getCode(), BitDepth.FOUR), new LabColor(0xFF55FF)); + colorMap.put(new AnsiColorWrapper(AnsiColor.BRIGHT_CYAN.getCode(), BitDepth.FOUR), new LabColor(0x55FFFF)); + colorMap.put(new AnsiColorWrapper(CODE_OF_4_BIT_ANSI_COLOR_BRIGHT_WHITE, BitDepth.FOUR), new LabColor(0xFFFFFF)); + ANSI_COLOR_MAP = Collections.unmodifiableMap(colorMap); + } + + private static final int[] ANSI_8BIT_COLOR_CODE_LOOKUP = new int[] { 0x000000, 0x800000, 0x008000, 0x808000, + 0x000080, 0x800080, 0x008080, 0xc0c0c0, 0x808080, 0xff0000, 0x00ff00, 0xffff00, 0x0000ff, 0xff00ff, + 0x00ffff, 0xffffff, 0x000000, 0x00005f, 0x000087, 0x0000af, 0x0000d7, 0x0000ff, 0x005f00, 0x005f5f, + 0x005f87, 0x005faf, 0x005fd7, 0x005fff, 0x008700, 0x00875f, 0x008787, 0x0087af, 0x0087d7, 0x0087ff, + 0x00af00, 0x00af5f, 0x00af87, 0x00afaf, 0x00afd7, 0x00afff, 0x00d700, 0x00d75f, 0x00d787, 0x00d7af, + 0x00d7d7, 0x00d7ff, 0x00ff00, 0x00ff5f, 0x00ff87, 0x00ffaf, 0x00ffd7, 0x00ffff, 0x5f0000, 0x5f005f, + 0x5f0087, 0x5f00af, 0x5f00d7, 0x5f00ff, 0x5f5f00, 0x5f5f5f, 0x5f5f87, 0x5f5faf, 0x5f5fd7, 0x5f5fff, + 0x5f8700, 0x5f875f, 0x5f8787, 0x5f87af, 0x5f87d7, 0x5f87ff, 0x5faf00, 0x5faf5f, 0x5faf87, 0x5fafaf, + 0x5fafd7, 0x5fafff, 0x5fd700, 0x5fd75f, 0x5fd787, 0x5fd7af, 0x5fd7d7, 0x5fd7ff, 0x5fff00, 0x5fff5f, + 0x5fff87, 0x5fffaf, 0x5fffd7, 0x5fffff, 0x870000, 0x87005f, 0x870087, 0x8700af, 0x8700d7, 0x8700ff, + 0x875f00, 0x875f5f, 0x875f87, 0x875faf, 0x875fd7, 0x875fff, 0x878700, 0x87875f, 0x878787, 0x8787af, + 0x8787d7, 0x8787ff, 0x87af00, 0x87af5f, 0x87af87, 0x87afaf, 0x87afd7, 0x87afff, 0x87d700, 0x87d75f, + 0x87d787, 0x87d7af, 0x87d7d7, 0x87d7ff, 0x87ff00, 0x87ff5f, 0x87ff87, 0x87ffaf, 0x87ffd7, 0x87ffff, + 0xaf0000, 0xaf005f, 0xaf0087, 0xaf00af, 0xaf00d7, 0xaf00ff, 0xaf5f00, 0xaf5f5f, 0xaf5f87, 0xaf5faf, + 0xaf5fd7, 0xaf5fff, 0xaf8700, 0xaf875f, 0xaf8787, 0xaf87af, 0xaf87d7, 0xaf87ff, 0xafaf00, 0xafaf5f, + 0xafaf87, 0xafafaf, 0xafafd7, 0xafafff, 0xafd700, 0xafd75f, 0xafd787, 0xafd7af, 0xafd7d7, 0xafd7ff, + 0xafff00, 0xafff5f, 0xafff87, 0xafffaf, 0xafffd7, 0xafffff, 0xd70000, 0xd7005f, 0xd70087, 0xd700af, + 0xd700d7, 0xd700ff, 0xd75f00, 0xd75f5f, 0xd75f87, 0xd75faf, 0xd75fd7, 0xd75fff, 0xd78700, 0xd7875f, + 0xd78787, 0xd787af, 0xd787d7, 0xd787ff, 0xd7af00, 0xd7af5f, 0xd7af87, 0xd7afaf, 0xd7afd7, 0xd7afff, + 0xd7d700, 0xd7d75f, 0xd7d787, 0xd7d7af, 0xd7d7d7, 0xd7d7ff, 0xd7ff00, 0xd7ff5f, 0xd7ff87, 0xd7ffaf, + 0xd7ffd7, 0xd7ffff, 0xff0000, 0xff005f, 0xff0087, 0xff00af, 0xff00d7, 0xff00ff, 0xff5f00, 0xff5f5f, + 0xff5f87, 0xff5faf, 0xff5fd7, 0xff5fff, 0xff8700, 0xff875f, 0xff8787, 0xff87af, 0xff87d7, 0xff87ff, + 0xffaf00, 0xffaf5f, 0xffaf87, 0xffafaf, 0xffafd7, 0xffafff, 0xffd700, 0xffd75f, 0xffd787, 0xffd7af, + 0xffd7d7, 0xffd7ff, 0xffff00, 0xffff5f, 0xffff87, 0xffffaf, 0xffffd7, 0xffffff, 0x080808, 0x121212, + 0x1c1c1c, 0x262626, 0x303030, 0x3a3a3a, 0x444444, 0x4e4e4e, 0x585858, 0x626262, 0x6c6c6c, 0x767676, + 0x808080, 0x8a8a8a, 0x949494, 0x9e9e9e, 0xa8a8a8, 0xb2b2b2, 0xbcbcbc, 0xc6c6c6, 0xd0d0d0, 0xdadada, + 0xe4e4e4, 0xeeeeee }; + + private final Map lookup; + + /** + * 创建具有指定位深度的新 {@code AnsiColors} 实例。 + * @param bitDepth 所需的位深度 + */ + public AnsiColors(BitDepth bitDepth) { + this.lookup = getLookup(bitDepth); + } + + private Map getLookup(BitDepth bitDepth) { + if (bitDepth == BitDepth.EIGHT) { + final Map lookup = new LinkedHashMap<>(256, 1); + for (int i = 0; i < ANSI_8BIT_COLOR_CODE_LOOKUP.length; i++) { + lookup.put(new AnsiColorWrapper(i,BitDepth.EIGHT), new LabColor(ANSI_8BIT_COLOR_CODE_LOOKUP[i])); + } + return Collections.unmodifiableMap(lookup); + } + return ANSI_COLOR_MAP; + } + + /** + * 找到最接近给定 AWT {@link Color} 的 {@link AnsiColorWrapper ANSI 颜色包装} 实例。 + * @param color AWT 颜色 + * @return 最接近指定 ANSI 颜色的 {@link AnsiColorWrapper ANSI 颜色包装} 实例 + */ + public AnsiColorWrapper findClosest(Color color) { + return findClosest(new LabColor(color)); + } + + private AnsiColorWrapper findClosest(LabColor color) { + AnsiColorWrapper closest = null; + double closestDistance = Float.MAX_VALUE; + for (Map.Entry entry : this.lookup.entrySet()) { + double candidateDistance = color.getDistance(entry.getValue()); + if (closest == null || candidateDistance < closestDistance) { + closestDistance = candidateDistance; + closest = entry.getKey(); + } + } + return closest; + } + + /** + * 此类支持的位深度。 + */ + public enum BitDepth { + + /** + * 4位 (16色). + * @see AnsiColor + * @see AnsiBackground + */ + FOUR(4), + + /** + * 8位 (256色). + * @see Ansi8BitColor + */ + EIGHT(8); + + private final int bits; + + BitDepth(int bits) { + this.bits = bits; + } + + public static BitDepth of(int bits) { + for (BitDepth candidate : values()) { + if (candidate.bits == bits) { + return candidate; + } + } + throw new IllegalArgumentException("Unsupported ANSI bit depth '" + bits + "'"); + } + + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiElement.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiElement.java new file mode 100755 index 0000000..7711058 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiElement.java @@ -0,0 +1,26 @@ +package aiyh.utils.tool.cn.hutool.core.lang.ansi; + +/** + * ANSI可转义节点接口，实现为ANSI颜色等 + * + *

来自Spring Boot

+ * + * @author Phillip Webb + */ +public interface AnsiElement { + + /** + * @return ANSI转义编码 + */ + @Override + String toString(); + + /** + * 获取ANSI代码，默认返回-1 + * @return ANSI代码 + * @since 5.8.7 + */ + default int getCode(){ + return -1; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiEncoder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiEncoder.java new file mode 100755 index 0000000..e1d1beb --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiEncoder.java @@ -0,0 +1,65 @@ +package aiyh.utils.tool.cn.hutool.core.lang.ansi; + +/** + * 生成ANSI格式的编码输出 + * + * @author Phillip Webb + * @since 1.0.0 + */ +public abstract class AnsiEncoder { + + private static final String ENCODE_JOIN = ";"; + private static final String ENCODE_START = "\033["; + private static final String ENCODE_END = "m"; + private static final String RESET = "0;" + AnsiColor.DEFAULT; + + /** + * 创建ANSI字符串，参数中的{@link AnsiElement}会被转换为编码形式。 + * + * @param elements 节点数组 + * @return ANSI字符串 + */ + public static String encode(Object... elements) { + final StringBuilder sb = new StringBuilder(); + buildEnabled(sb, elements); + return sb.toString(); + } + + /** + * 追加需要需转义的节点 + * + * @param sb {@link StringBuilder} + * @param elements 节点列表 + */ + private static void buildEnabled(StringBuilder sb, Object[] elements) { + boolean writingAnsi = false; + boolean containsEncoding = false; + for (Object element : elements) { + if (null == element) { + continue; + } + if (element instanceof AnsiElement) { + containsEncoding = true; + if (writingAnsi) { + sb.append(ENCODE_JOIN); + } else { + sb.append(ENCODE_START); + writingAnsi = true; + } + } else { + if (writingAnsi) { + sb.append(ENCODE_END); + writingAnsi = false; + } + } + sb.append(element); + } + + // 恢复默认 + if (containsEncoding) { + sb.append(writingAnsi ? ENCODE_JOIN : ENCODE_START); + sb.append(RESET); + sb.append(ENCODE_END); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiStyle.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiStyle.java new file mode 100755 index 0000000..6f644e5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/AnsiStyle.java @@ -0,0 +1,61 @@ +package aiyh.utils.tool.cn.hutool.core.lang.ansi; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * ANSI文本样式风格枚举 + * + *

来自Spring Boot

+ * + * @author Phillip Webb + * @since 5.8.0 + */ +public enum AnsiStyle implements AnsiElement { + + /** + * 重置/正常 + */ + NORMAL(0), + + /** + * 粗体或增加强度 + */ + BOLD(1), + + /** + * 弱化（降低强度） + */ + FAINT(2), + + /** + * 斜体 + */ + ITALIC(3), + + /** + * 下划线 + */ + UNDERLINE(4); + + private final int code; + + AnsiStyle(int code) { + this.code = code; + } + + /** + * 获取ANSI文本样式风格代码 + * + * @return 文本样式风格代码 + */ + @Override + public int getCode() { + return this.code; + } + + @Override + public String toString() { + return StrUtil.toString(this.code); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/ForeOrBack.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/ForeOrBack.java new file mode 100644 index 0000000..3aa42a0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/ForeOrBack.java @@ -0,0 +1,16 @@ +package aiyh.utils.tool.cn.hutool.core.lang.ansi; + +/** + * 区分前景还是背景 + */ +public enum ForeOrBack{ + + /** + * 前景 + */ + FORE, + /** + * 背景 + */ + BACK, +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/package-info.java new file mode 100755 index 0000000..948973d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/ansi/package-info.java @@ -0,0 +1,6 @@ +/** + * 命令行终端中ANSI 转义序列相关封装，如ANSI颜色等 + * + * @author spring, looly + */ +package aiyh.utils.tool.cn.hutool.core.lang.ansi; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/Caller.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/Caller.java new file mode 100644 index 0000000..30b456b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/Caller.java @@ -0,0 +1,47 @@ +package aiyh.utils.tool.cn.hutool.core.lang.caller; + +/** + * 调用者接口
+ * 可以通过此接口的实现类方法获取调用者、多级调用者以及判断是否被调用 + * + * @author Looly + * + */ +public interface Caller { + /** + * 获得调用者 + * + * @return 调用者 + */ + Class getCaller(); + + /** + * 获得调用者的调用者 + * + * @return 调用者的调用者 + */ + Class getCallerCaller(); + + /** + * 获得调用者，指定第几级调用者 调用者层级关系： + * + * 
+	 * 0 {@link CallerUtil}
+	 * 1 调用{@link CallerUtil}中方法的类
+	 * 2 调用者的调用者
+	 * ...
+	 *
+ * + * @param depth 层级。0表示{@link CallerUtil}本身，1表示调用{@link CallerUtil}的类，2表示调用者的调用者，依次类推 + * @return 第几级调用者 + */ + Class getCaller(int depth); + + /** + * 是否被指定类调用 + * + * @param clazz 调用者类 + * @return 是否被调用 + */ + boolean isCalledBy(Class clazz); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/CallerUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/CallerUtil.java new file mode 100755 index 0000000..f826942 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/CallerUtil.java @@ -0,0 +1,98 @@ +package aiyh.utils.tool.cn.hutool.core.lang.caller; + +/** + * 调用者。可以通过此类的方法获取调用者、多级调用者以及判断是否被调用 + * + * @author Looly + * @since 4.1.6 + */ +public class CallerUtil { + private static final Caller INSTANCE; + static { + INSTANCE = tryCreateCaller(); + } + + /** + * 获得调用者 + * + * @return 调用者 + */ + public static Class getCaller() { + return INSTANCE.getCaller(); + } + + /** + * 获得调用者的调用者 + * + * @return 调用者的调用者 + */ + public static Class getCallerCaller() { + return INSTANCE.getCallerCaller(); + } + + /** + * 获得调用者，指定第几级调用者
+ * 调用者层级关系： + * + * 
+	 * 0 CallerUtil
+	 * 1 调用CallerUtil中方法的类
+	 * 2 调用者的调用者
+	 * ...
+	 *
+ * + * @param depth 层级。0表示CallerUtil本身，1表示调用CallerUtil的类，2表示调用者的调用者，依次类推 + * @return 第几级调用者 + */ + public static Class getCaller(int depth) { + return INSTANCE.getCaller(depth); + } + + /** + * 是否被指定类调用 + * + * @param clazz 调用者类 + * @return 是否被调用 + */ + public static boolean isCalledBy(Class clazz) { + return INSTANCE.isCalledBy(clazz); + } + + /** + * 获取调用此方法的方法名 + * + * @param isFullName 是否返回全名，全名包括方法所在类的全路径名 + * @return 调用此方法的方法名 + * @since 5.2.4 + */ + public static String getCallerMethodName(boolean isFullName){ + final StackTraceElement stackTraceElement = Thread.currentThread().getStackTrace()[2]; + final String methodName = stackTraceElement.getMethodName(); + if(false == isFullName){ + return methodName; + } + + return stackTraceElement.getClassName() + "." + methodName; + } + + /** + * 尝试创建{@link Caller}实现 + * + * @return {@link Caller}实现 + */ + private static Caller tryCreateCaller() { + Caller caller; + try { + caller = new SecurityManagerCaller(); + if(null != caller.getCaller() && null != caller.getCallerCaller()) { + return caller; + } + } catch (Throwable e) { + //ignore + } + + caller = new StackTraceCaller(); + return caller; + } + // ---------------------------------------------------------------------------------------------- static interface and class +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/SecurityManagerCaller.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/SecurityManagerCaller.java new file mode 100644 index 0000000..35edcbf --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/SecurityManagerCaller.java @@ -0,0 +1,56 @@ +package aiyh.utils.tool.cn.hutool.core.lang.caller; + +import java.io.Serializable; + +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; + +/** + * {@link SecurityManager} 方式获取调用者 + * + * @author Looly + */ +public class SecurityManagerCaller extends SecurityManager implements Caller, Serializable { + private static final long serialVersionUID = 1L; + + private static final int OFFSET = 1; + + @Override + public Class getCaller() { + final Class[] context = getClassContext(); + if (null != context && (OFFSET + 1) < context.length) { + return context[OFFSET + 1]; + } + return null; + } + + @Override + public Class getCallerCaller() { + final Class[] context = getClassContext(); + if (null != context && (OFFSET + 2) < context.length) { + return context[OFFSET + 2]; + } + return null; + } + + @Override + public Class getCaller(int depth) { + final Class[] context = getClassContext(); + if (null != context && (OFFSET + depth) < context.length) { + return context[OFFSET + depth]; + } + return null; + } + + @Override + public boolean isCalledBy(Class clazz) { + final Class[] classes = getClassContext(); + if(ArrayUtil.isNotEmpty(classes)) { + for (Class contextClass : classes) { + if (contextClass.equals(clazz)) { + return true; + } + } + } + return false; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/StackTraceCaller.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/StackTraceCaller.java new file mode 100644 index 0000000..cc5ef5c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/StackTraceCaller.java @@ -0,0 +1,68 @@ +package aiyh.utils.tool.cn.hutool.core.lang.caller; + +import java.io.Serializable; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; + +/** + * 通过StackTrace方式获取调用者。此方式效率最低，不推荐使用 + * + * @author Looly + */ +public class StackTraceCaller implements Caller, Serializable { + private static final long serialVersionUID = 1L; + private static final int OFFSET = 2; + + @Override + public Class getCaller() { + final StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace(); + if (OFFSET + 1 >= stackTrace.length) { + return null; + } + final String className = stackTrace[OFFSET + 1].getClassName(); + try { + return Class.forName(className); + } catch (ClassNotFoundException e) { + throw new UtilException(e, "[{}] not found!", className); + } + } + + @Override + public Class getCallerCaller() { + final StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace(); + if (OFFSET + 2 >= stackTrace.length) { + return null; + } + final String className = stackTrace[OFFSET + 2].getClassName(); + try { + return Class.forName(className); + } catch (ClassNotFoundException e) { + throw new UtilException(e, "[{}] not found!", className); + } + } + + @Override + public Class getCaller(int depth) { + final StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace(); + if (OFFSET + depth >= stackTrace.length) { + return null; + } + final String className = stackTrace[OFFSET + depth].getClassName(); + try { + return Class.forName(className); + } catch (ClassNotFoundException e) { + throw new UtilException(e, "[{}] not found!", className); + } + } + + @Override + public boolean isCalledBy(Class clazz) { + final StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace(); + for (final StackTraceElement element : stackTrace) { + if (element.getClassName().equals(clazz.getName())) { + return true; + } + } + return false; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/package-info.java new file mode 100755 index 0000000..da1efb1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/caller/package-info.java @@ -0,0 +1,7 @@ +/** + * 调用者接口及实现。可以通过此类的方法获取调用者、多级调用者以及判断是否被调用 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.lang.caller; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/copier/Copier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/copier/Copier.java new file mode 100644 index 0000000..4945ae1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/copier/Copier.java @@ -0,0 +1,16 @@ +package aiyh.utils.tool.cn.hutool.core.lang.copier; + +/** + * 拷贝接口 + * @author Looly + * + * @param 拷贝目标类型 + */ +@FunctionalInterface +public interface Copier { + /** + * 执行拷贝 + * @return 拷贝的目标 + */ + T copy(); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/copier/SrcToDestCopier.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/copier/SrcToDestCopier.java new file mode 100755 index 0000000..5007072 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/copier/SrcToDestCopier.java @@ -0,0 +1,86 @@ +package aiyh.utils.tool.cn.hutool.core.lang.copier; + +import java.io.Serializable; + +import aiyh.utils.tool.cn.hutool.core.lang.Filter; + +/** + * 复制器抽象类
+ * 抽象复制器抽象了一个对象复制到另一个对象，通过实现{@link #copy()}方法实现复制逻辑。
+ * + * @author Looly + * + * @param 拷贝的对象 + * @param 本类的类型。用于set方法返回本对象，方便流式编程 + * @since 3.0.9 + */ +public abstract class SrcToDestCopier> implements Copier, Serializable{ + private static final long serialVersionUID = 1L; + + /** 源 */ + protected T src; + /** 目标 */ + protected T dest; + /** 拷贝过滤器，可以过滤掉不需要拷贝的源 */ + protected Filter copyFilter; + + //-------------------------------------------------------------------------------------------------------- Getters and Setters start + /** + * 获取源 + * @return 源 + */ + public T getSrc() { + return src; + } + /** + * 设置源 + * + * @param src 源 + * @return this + */ + @SuppressWarnings("unchecked") + public C setSrc(T src) { + this.src = src; + return (C)this; + } + + /** + * 获得目标 + * + * @return 目标 + */ + public T getDest() { + return dest; + } + /** + * 设置目标 + * + * @param dest 目标 + * @return this + */ + @SuppressWarnings("unchecked") + public C setDest(T dest) { + this.dest = dest; + return (C)this; + } + + /** + * 获得过滤器 + * @return 过滤器 + */ + public Filter getCopyFilter() { + return copyFilter; + } + /** + * 设置过滤器 + * + * @param copyFilter 过滤器 + * @return this + */ + @SuppressWarnings("unchecked") + public C setCopyFilter(Filter copyFilter) { + this.copyFilter = copyFilter; + return (C)this; + } + //-------------------------------------------------------------------------------------------------------- Getters and Setters end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/copier/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/copier/package-info.java new file mode 100755 index 0000000..3350b27 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/copier/package-info.java @@ -0,0 +1,7 @@ +/** + * 拷贝抽象实现，通过抽象拷贝，可以实现文件、流、Buffer之间的拷贝实现 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.lang.copier; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Consumer3.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Consumer3.java new file mode 100644 index 0000000..574fa21 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Consumer3.java @@ -0,0 +1,23 @@ +package aiyh.utils.tool.cn.hutool.core.lang.func; + +/** + * 3参数Consumer + * + * @param 参数一类型 + * @param 参数二类型 + * @param 参数三类型 + * @author TomXin + * @since 5.7.22 + */ +@FunctionalInterface +public interface Consumer3 { + + /** + * 接收参数方法 + * + * @param p1 参数一 + * @param p2 参数二 + * @param p3 参数三 + */ + void accept(P1 p1, P2 p2, P3 p3); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Func.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Func.java new file mode 100644 index 0000000..dbdedd2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Func.java @@ -0,0 +1,43 @@ +package aiyh.utils.tool.cn.hutool.core.lang.func; + +import java.io.Serializable; + +/** + * 函数对象
+ * 接口灵感来自于ActFramework
+ * 一个函数接口代表一个一个函数，用于包装一个函数为对象
+ * 在JDK8之前，Java的函数并不能作为参数传递，也不能作为返回值存在，此接口用于将一个函数包装成为一个对象，从而传递对象 + * + * @author Looly + * + * @param

参数类型 + * @param 返回值类型 + * @since 3.1.0 + */ +@FunctionalInterface +public interface Func extends Serializable { + /** + * 执行函数 + * + * @param parameters 参数列表 + * @return 函数执行结果 + * @throws Exception 自定义异常 + */ + @SuppressWarnings("unchecked") + R call(P... parameters) throws Exception; + + /** + * 执行函数，异常包装为RuntimeException + * + * @param parameters 参数列表 + * @return 函数执行结果 + */ + @SuppressWarnings("unchecked") + default R callWithRuntimeException(P... parameters){ + try { + return call(parameters); + } catch (Exception e) { + throw new RuntimeException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Func0.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Func0.java new file mode 100644 index 0000000..dbea273 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Func0.java @@ -0,0 +1,39 @@ +package aiyh.utils.tool.cn.hutool.core.lang.func; + +import java.io.Serializable; + +/** + * 无参数的函数对象
+ * 接口灵感来自于ActFramework
+ * 一个函数接口代表一个一个函数，用于包装一个函数为对象
+ * 在JDK8之前，Java的函数并不能作为参数传递，也不能作为返回值存在，此接口用于将一个函数包装成为一个对象，从而传递对象 + * + * @author Looly + * + * @param 返回值类型 + * @since 4.5.2 + */ +@FunctionalInterface +public interface Func0 extends Serializable { + /** + * 执行函数 + * + * @return 函数执行结果 + * @throws Exception 自定义异常 + */ + R call() throws Exception; + + /** + * 执行函数，异常包装为RuntimeException + * + * @return 函数执行结果 + * @since 5.3.6 + */ + default R callWithRuntimeException(){ + try { + return call(); + } catch (Exception e) { + throw new RuntimeException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Func1.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Func1.java new file mode 100644 index 0000000..2e52f77 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Func1.java @@ -0,0 +1,43 @@ +package aiyh.utils.tool.cn.hutool.core.lang.func; + +import java.io.Serializable; + +/** + * 只有一个参数的函数对象
+ * 接口灵感来自于ActFramework
+ * 一个函数接口代表一个一个函数，用于包装一个函数为对象
+ * 在JDK8之前，Java的函数并不能作为参数传递，也不能作为返回值存在，此接口用于将一个函数包装成为一个对象，从而传递对象 + * + * @author Looly + * + * @param

参数类型 + * @param 返回值类型 + * @since 4.2.2 + */ +@FunctionalInterface +public interface Func1 extends Serializable { + + /** + * 执行函数 + * + * @param parameter 参数 + * @return 函数执行结果 + * @throws Exception 自定义异常 + */ + R call(P parameter) throws Exception; + + /** + * 执行函数，异常包装为RuntimeException + * + * @param parameter 参数 + * @return 函数执行结果 + * @since 5.3.6 + */ + default R callWithRuntimeException(P parameter){ + try { + return call(parameter); + } catch (Exception e) { + throw new RuntimeException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/LambdaUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/LambdaUtil.java new file mode 100755 index 0000000..d9a4a3a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/LambdaUtil.java @@ -0,0 +1,208 @@ +package aiyh.utils.tool.cn.hutool.core.lang.func; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.map.WeakConcurrentMap; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.lang.invoke.MethodHandleInfo; +import java.lang.invoke.SerializedLambda; + +/** + * Lambda相关工具类 + * + * @author looly, Scen + * @since 5.6.3 + */ +public class LambdaUtil { + + private static final WeakConcurrentMap cache = new WeakConcurrentMap<>(); + + /** + * 通过对象的方法或类的静态方法引用，获取lambda实现类 + * 传入lambda无参数但含有返回值的情况能够匹配到此方法： + *

    + *
  • 引用特定对象的实例方法：
    {@code
+	 * MyTeacher myTeacher = new MyTeacher();
+	 * Class supplierClass = LambdaUtil.getRealClass(myTeacher::getAge);
+	 * Assert.assertEquals(MyTeacher.class, supplierClass);
+	 * }
    • + *
  • 引用静态无参方法：
    {@code
+	 * Class staticSupplierClass = LambdaUtil.getRealClass(MyTeacher::takeAge);
+	 * Assert.assertEquals(MyTeacher.class, staticSupplierClass);
+	 * }
    • + *
+ * 在以下场景无法获取到正确类型 + * 
{@code
+	 * // 枚举测试，只能获取到枚举类型
+	 * Class> enumSupplierClass = LambdaUtil.getRealClass(LambdaUtil.LambdaKindEnum.REF_NONE::ordinal);
+	 * Assert.assertEquals(Enum.class, enumSupplierClass);
+	 * // 调用父类方法，只能获取到父类类型
+	 * Class> superSupplierClass = LambdaUtil.getRealClass(myTeacher::getId);
+	 * Assert.assertEquals(Entity.class, superSupplierClass);
+	 * // 引用父类静态带参方法，只能获取到父类类型
+	 * Class> staticSuperFunctionClass = LambdaUtil.getRealClass(MyTeacher::takeId);
+	 * Assert.assertEquals(Entity.class, staticSuperFunctionClass);
+	 * }
+ * + * @param func lambda + * @param 类型 + * @return lambda实现类 + * @throws IllegalArgumentException 如果是不支持的方法引用，抛出该异常，见{@link LambdaUtil#checkLambdaTypeCanGetClass} + * @since 5.8.0 + * @author VampireAchao + */ + public static Class getRealClass(Func0 func) { + final SerializedLambda lambda = resolve(func); + checkLambdaTypeCanGetClass(lambda.getImplMethodKind()); + return ClassUtil.loadClass(lambda.getImplClass()); + } + + /** + * 解析lambda表达式,加了缓存。 + * 该缓存可能会在任意不定的时间被清除 + * + * @param Lambda类型 + * @param func 需要解析的 lambda 对象（无参方法） + * @return 返回解析后的结果 + */ + public static SerializedLambda resolve(Func1 func) { + return _resolve(func); + } + + /** + * 解析lambda表达式,加了缓存。 + * 该缓存可能会在任意不定的时间被清除 + * + * @param Lambda返回类型 + * @param func 需要解析的 lambda 对象（无参方法） + * @return 返回解析后的结果 + * @since 5.7.23 + */ + public static SerializedLambda resolve(Func0 func) { + return _resolve(func); + } + + /** + * 获取lambda表达式函数（方法）名称 + * + * @param

Lambda参数类型 + * @param func 函数（无参方法） + * @return 函数名称 + */ + public static

String getMethodName(Func1 func) { + return resolve(func).getImplMethodName(); + } + + /** + * 获取lambda表达式函数（方法）名称 + * + * @param Lambda返回类型 + * @param func 函数（无参方法） + * @return 函数名称 + * @since 5.7.23 + */ + public static String getMethodName(Func0 func) { + return resolve(func).getImplMethodName(); + } + + /** + * 通过对象的方法或类的静态方法引用，然后根据{@link SerializedLambda#getInstantiatedMethodType()}获取lambda实现类
+ * 传入lambda有参数且含有返回值的情况能够匹配到此方法： + *

    + *
  • 引用特定类型的任意对象的实例方法：
    {@code
+	 * Class functionClass = LambdaUtil.getRealClass(MyTeacher::getAge);
+	 * Assert.assertEquals(MyTeacher.class, functionClass);
+	 * }
    • + *
  • 引用静态带参方法：
    {@code
+	 * Class staticFunctionClass = LambdaUtil.getRealClass(MyTeacher::takeAgeBy);
+	 * Assert.assertEquals(MyTeacher.class, staticFunctionClass);
+	 * }
    • + *
+ * + * @param func lambda + * @param

方法调用方类型 + * @param 返回值类型 + * @return lambda实现类 + * @throws IllegalArgumentException 如果是不支持的方法引用，抛出该异常，见{@link LambdaUtil#checkLambdaTypeCanGetClass} + * @since 5.8.0 + * @author VampireAchao + */ + public static Class

getRealClass(Func1 func) { + final SerializedLambda lambda = resolve(func); + checkLambdaTypeCanGetClass(lambda.getImplMethodKind()); + final String instantiatedMethodType = lambda.getInstantiatedMethodType(); + return ClassUtil.loadClass(StrUtil.sub(instantiatedMethodType, 2, StrUtil.indexOf(instantiatedMethodType, ';'))); + } + + /** + * 获取lambda表达式Getter或Setter函数（方法）对应的字段名称，规则如下： + *

    + *
  • getXxxx获取为xxxx，如getName得到name。
    • + *
  • setXxxx获取为xxxx，如setName得到name。
    • + *
  • isXxxx获取为xxxx，如isName得到name。
    • + *
  • 其它不满足规则的方法名抛出{@link IllegalArgumentException}
    • + *
+ * + * @param Lambda类型 + * @param func 函数（无参方法） + * @return 方法名称 + * @throws IllegalArgumentException 非Getter或Setter方法 + * @since 5.7.10 + */ + public static String getFieldName(Func1 func) throws IllegalArgumentException { + return BeanUtil.getFieldName(getMethodName(func)); + } + + /** + * 获取lambda表达式Getter或Setter函数（方法）对应的字段名称，规则如下： + *
    + *
  • getXxxx获取为xxxx，如getName得到name。
    • + *
  • setXxxx获取为xxxx，如setName得到name。
    • + *
  • isXxxx获取为xxxx，如isName得到name。
    • + *
  • 其它不满足规则的方法名抛出{@link IllegalArgumentException}
    • + *
+ * + * @param Lambda类型 + * @param func 函数（无参方法） + * @return 方法名称 + * @throws IllegalArgumentException 非Getter或Setter方法 + * @since 5.7.23 + */ + public static String getFieldName(Func0 func) throws IllegalArgumentException { + return BeanUtil.getFieldName(getMethodName(func)); + } + + //region Private methods + /** + * 检查是否为支持的类型 + * + * @param implMethodKind 支持的lambda类型 + * @throws IllegalArgumentException 如果是不支持的方法引用，抛出该异常 + */ + private static void checkLambdaTypeCanGetClass(int implMethodKind) { + if (implMethodKind != MethodHandleInfo.REF_invokeVirtual && + implMethodKind != MethodHandleInfo.REF_invokeStatic) { + throw new IllegalArgumentException("该lambda不是合适的方法引用"); + } + } + + /** + * 解析lambda表达式,加了缓存。 + * 该缓存可能会在任意不定的时间被清除。 + * + *

+ * 通过反射调用实现序列化接口函数对象的writeReplace方法，从而拿到{@link SerializedLambda}
+ * 该对象中包含了lambda表达式的所有信息。 + *

+ * + * @param func 需要解析的 lambda 对象 + * @return 返回解析后的结果 + */ + private static SerializedLambda _resolve(Serializable func) { + return cache.computeIfAbsent(func.getClass().getName(), (key) -> ReflectUtil.invoke(func, "writeReplace")); + } + //endregion +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier1.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier1.java new file mode 100755 index 0000000..1254b23 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier1.java @@ -0,0 +1,32 @@ +package aiyh.utils.tool.cn.hutool.core.lang.func; + +import java.util.function.Supplier; + +/** + * 1参数Supplier + * + * @param 目标 类型 + * @param 参数一 类型 + * @author TomXin + * @since 5.7.21 + */ +@FunctionalInterface +public interface Supplier1 { + /** + * 生成实例的方法 + * + * @param p1 参数一 + * @return 目标对象 + */ + T get(P1 p1); + + /** + * 将带有参数的Supplier转换为无参{@link Supplier} + * + * @param p1 参数1 + * @return {@link Supplier} + */ + default Supplier toSupplier(P1 p1) { + return () -> get(p1); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier2.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier2.java new file mode 100755 index 0000000..10ac20d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier2.java @@ -0,0 +1,36 @@ +package aiyh.utils.tool.cn.hutool.core.lang.func; + +import java.util.function.Supplier; + +/** + * 两个参数的Supplier + * + * @param 目标 类型 + * @param 参数一 类型 + * @param 参数二 类型 + * @author TomXin + * @since 5.7.21 + */ +@FunctionalInterface +public interface Supplier2 { + + /** + * 生成实例的方法 + * + * @param p1 参数一 + * @param p2 参数二 + * @return 目标对象 + */ + T get(P1 p1, P2 p2); + + /** + * 将带有参数的Supplier转换为无参{@link Supplier} + * + * @param p1 参数1 + * @param p2 参数2 + * @return {@link Supplier} + */ + default Supplier toSupplier(P1 p1, P2 p2) { + return () -> get(p1, p2); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier3.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier3.java new file mode 100755 index 0000000..317e369 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier3.java @@ -0,0 +1,39 @@ +package aiyh.utils.tool.cn.hutool.core.lang.func; + +import java.util.function.Supplier; + +/** + * 3参数Supplier + * + * @param 目标类型 + * @param 参数一类型 + * @param 参数二类型 + * @param 参数三类型 + * @author TomXin + * @since 5.7.21 + */ +@FunctionalInterface +public interface Supplier3 { + + /** + * 生成实例的方法 + * + * @param p1 参数一 + * @param p2 参数二 + * @param p3 参数三 + * @return 目标对象 + */ + T get(P1 p1, P2 p2, P3 p3); + + /** + * 将带有参数的Supplier转换为无参{@link Supplier} + * + * @param p1 参数1 + * @param p2 参数2 + * @param p3 参数3 + * @return {@link Supplier} + */ + default Supplier toSupplier(P1 p1, P2 p2, P3 p3) { + return () -> get(p1, p2, p3); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier4.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier4.java new file mode 100755 index 0000000..e8c6fda --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier4.java @@ -0,0 +1,42 @@ +package aiyh.utils.tool.cn.hutool.core.lang.func; + +import java.util.function.Supplier; + +/** + * 4参数Supplier + * + * @param 目标 类型 + * @param 参数一 类型 + * @param 参数二 类型 + * @param 参数三 类型 + * @param 参数四 类型 + * @author TomXin + * @since 5.7.21 + */ +@FunctionalInterface +public interface Supplier4 { + + /** + * 生成实例的方法 + * + * @param p1 参数一 + * @param p2 参数二 + * @param p3 参数三 + * @param p4 参数四 + * @return 目标对象 + */ + T get(P1 p1, P2 p2, P3 p3, P4 p4); + + /** + * 将带有参数的Supplier转换为无参{@link Supplier} + * + * @param p1 参数1 + * @param p2 参数2 + * @param p3 参数3 + * @param p4 参数4 + * @return {@link Supplier} + */ + default Supplier toSupplier(P1 p1, P2 p2, P3 p3, P4 p4) { + return () -> get(p1, p2, p3, p4); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier5.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier5.java new file mode 100755 index 0000000..74a2109 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/Supplier5.java @@ -0,0 +1,45 @@ +package aiyh.utils.tool.cn.hutool.core.lang.func; + +import java.util.function.Supplier; + +/** + * 5参数Supplier + * + * @param 目标 类型 + * @param 参数一 类型 + * @param 参数二 类型 + * @param 参数三 类型 + * @param 参数四 类型 + * @param 参数五 类型 + * @author TomXin + * @since 5.7.21 + */ +@FunctionalInterface +public interface Supplier5 { + + /** + * 生成实例的方法 + * + * @param p1 参数一 + * @param p2 参数二 + * @param p3 参数三 + * @param p4 参数四 + * @param p5 参数五 + * @return 目标对象 + */ + T get(P1 p1, P2 p2, P3 p3, P4 p4, P5 p5); + + /** + * 将带有参数的Supplier转换为无参{@link Supplier} + * + * @param p1 参数1 + * @param p2 参数2 + * @param p3 参数3 + * @param p4 参数4 + * @param p5 参数5 + * @return {@link Supplier} + */ + default Supplier toSupplier(P1 p1, P2 p2, P3 p3, P4 p4, P5 p5) { + return () -> get(p1, p2, p3, p4, p5); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/VoidFunc.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/VoidFunc.java new file mode 100644 index 0000000..49b3a0d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/VoidFunc.java @@ -0,0 +1,41 @@ +package aiyh.utils.tool.cn.hutool.core.lang.func; + +import java.io.Serializable; + +/** + * 函数对象
+ * 接口灵感来自于ActFramework
+ * 一个函数接口代表一个一个函数，用于包装一个函数为对象
+ * 在JDK8之前，Java的函数并不能作为参数传递，也不能作为返回值存在，此接口用于将一个函数包装成为一个对象，从而传递对象 + * + * @author Looly + * + * @param

参数类型 + * @since 3.1.0 + */ +@FunctionalInterface +public interface VoidFunc

extends Serializable { + + /** + * 执行函数 + * + * @param parameters 参数列表 + * @throws Exception 自定义异常 + */ + @SuppressWarnings("unchecked") + void call(P... parameters) throws Exception; + + /** + * 执行函数，异常包装为RuntimeException + * + * @param parameters 参数列表 + */ + @SuppressWarnings("unchecked") + default void callWithRuntimeException(P... parameters){ + try { + call(parameters); + } catch (Exception e) { + throw new RuntimeException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/VoidFunc0.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/VoidFunc0.java new file mode 100644 index 0000000..5035d26 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/VoidFunc0.java @@ -0,0 +1,37 @@ +package aiyh.utils.tool.cn.hutool.core.lang.func; + +import java.io.Serializable; + +/** + * 函数对象
+ * 接口灵感来自于ActFramework
+ * 一个函数接口代表一个一个函数，用于包装一个函数为对象
+ * 在JDK8之前，Java的函数并不能作为参数传递，也不能作为返回值存在，此接口用于将一个函数包装成为一个对象，从而传递对象 + * + * @author Looly + * + * @since 3.2.3 + */ +@FunctionalInterface +public interface VoidFunc0 extends Serializable { + + /** + * 执行函数 + * + * @throws Exception 自定义异常 + */ + void call() throws Exception; + + /** + * 执行函数，异常包装为RuntimeException + * + * @since 5.3.6 + */ + default void callWithRuntimeException(){ + try { + call(); + } catch (Exception e) { + throw new RuntimeException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/VoidFunc1.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/VoidFunc1.java new file mode 100644 index 0000000..c466ee6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/VoidFunc1.java @@ -0,0 +1,39 @@ +package aiyh.utils.tool.cn.hutool.core.lang.func; + +import java.io.Serializable; + +/** + * 函数对象
+ * 接口灵感来自于ActFramework
+ * 一个函数接口代表一个一个函数，用于包装一个函数为对象
+ * 在JDK8之前，Java的函数并不能作为参数传递，也不能作为返回值存在，此接口用于将一个函数包装成为一个对象，从而传递对象 + * + * @author Looly + * + * @since 3.2.3 + */ +@FunctionalInterface +public interface VoidFunc1

extends Serializable { + + /** + * 执行函数 + * + * @param parameter 参数 + * @throws Exception 自定义异常 + */ + void call(P parameter) throws Exception; + + /** + * 执行函数，异常包装为RuntimeException + * + * @param parameter 参数 + * @since 5.3.6 + */ + default void callWithRuntimeException(P parameter){ + try { + call(parameter); + } catch (Exception e) { + throw new RuntimeException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/package-info.java new file mode 100755 index 0000000..2394991 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/func/package-info.java @@ -0,0 +1,10 @@ +/** + * 函数封装
+ * 接口灵感来自于ActFramework
+ * 一个函数接口代表一个一个函数，用于包装一个函数为对象
+ * 在JDK8之前，Java的函数并不能作为参数传递，也不能作为返回值存在，此接口用于将一个函数包装成为一个对象，从而传递对象 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.lang.func; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/Generator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/Generator.java new file mode 100644 index 0000000..70f36da --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/Generator.java @@ -0,0 +1,18 @@ +package aiyh.utils.tool.cn.hutool.core.lang.generator; + +/** + * 生成器泛型接口
+ * 通过实现此接口可以自定义生成对象的策略 + * + * @param 生成对象类型 + * @since 5.4.3 + */ +public interface Generator { + + /** + * 生成新的对象 + * + * @return 新的对象 + */ + T next(); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/ObjectGenerator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/ObjectGenerator.java new file mode 100644 index 0000000..0b1a13f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/ObjectGenerator.java @@ -0,0 +1,28 @@ +package aiyh.utils.tool.cn.hutool.core.lang.generator; + +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; + +/** + * 对象生成器，通过指定对象的Class类型，调用next方法时生成新的对象。 + * + * @param 对象类型 + * @author looly + * @since 5.4.3 + */ +public class ObjectGenerator implements Generator { + + private final Class clazz; + + /** + * 构造 + * @param clazz 对象类型 + */ + public ObjectGenerator(Class clazz) { + this.clazz = clazz; + } + + @Override + public T next() { + return ReflectUtil.newInstanceIfPossible(this.clazz); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/ObjectIdGenerator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/ObjectIdGenerator.java new file mode 100755 index 0000000..5669d15 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/ObjectIdGenerator.java @@ -0,0 +1,16 @@ +package aiyh.utils.tool.cn.hutool.core.lang.generator; + +import aiyh.utils.tool.cn.hutool.core.lang.ObjectId; + +/** + * ObjectId生成器 + * + * @author looly + * @since 5.4.3 + */ +public class ObjectIdGenerator implements Generator { + @Override + public String next() { + return ObjectId.next(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/SnowflakeGenerator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/SnowflakeGenerator.java new file mode 100755 index 0000000..84ba307 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/SnowflakeGenerator.java @@ -0,0 +1,38 @@ +package aiyh.utils.tool.cn.hutool.core.lang.generator; + +import aiyh.utils.tool.cn.hutool.core.lang.Snowflake; + +/** + * Snowflake生成器
+ * 注意，默认此生成器必须单例使用，否则会有重复
+ * 默认构造的终端ID和数据中心ID都为0，不适用于分布式环境。 + * + * @author looly + * @since 5.4.3 + */ +public class SnowflakeGenerator implements Generator { + + private final Snowflake snowflake; + + /** + * 构造 + */ + public SnowflakeGenerator() { + this(0, 0); + } + + /** + * 构造 + * + * @param workerId 终端ID + * @param dataCenterId 数据中心ID + */ + public SnowflakeGenerator(long workerId, long dataCenterId) { + snowflake = new Snowflake(workerId, dataCenterId); + } + + @Override + public Long next() { + return this.snowflake.nextId(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/UUIDGenerator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/UUIDGenerator.java new file mode 100755 index 0000000..5d780b9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/UUIDGenerator.java @@ -0,0 +1,16 @@ +package aiyh.utils.tool.cn.hutool.core.lang.generator; + +import aiyh.utils.tool.cn.hutool.core.util.IdUtil; + +/** + * UUID生成器 + * + * @author looly + * @since 5.4.3 + */ +public class UUIDGenerator implements Generator { + @Override + public String next() { + return IdUtil.fastUUID(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/package-info.java new file mode 100755 index 0000000..ea3a879 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/generator/package-info.java @@ -0,0 +1,7 @@ +/** + * 提供生成器接口及相关封装 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.lang.generator; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/CityHash.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/CityHash.java new file mode 100644 index 0000000..df6a532 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/CityHash.java @@ -0,0 +1,499 @@ +package aiyh.utils.tool.cn.hutool.core.lang.hash; + +import aiyh.utils.tool.cn.hutool.core.util.ByteUtil; + +import java.util.Arrays; + +/** + * Google发布的Hash计算算法：CityHash64 与 CityHash128。
+ * 它们分别根据字串计算 64 和 128 位的散列值。这些算法不适用于加密，但适合用在散列表等处。 + * + *

+ * 代码来自：https://github.com/rolandhe/string-tools
+ * 原始算法：https://github.com/google/cityhash + * + * @author hexiufeng + * @since 5.2.5 + */ +public class CityHash { + + // Some primes between 2^63 and 2^64 for various uses. + private static final long k0 = 0xc3a5c85c97cb3127L; + private static final long k1 = 0xb492b66fbe98f273L; + private static final long k2 = 0x9ae16a3b2f90404fL; + private static final long kMul = 0x9ddfea08eb382d69L; + + // Magic numbers for 32-bit hashing. Copied from Murmur3. + private static final int c1 = 0xcc9e2d51; + private static final int c2 = 0x1b873593; + + + /** + * 计算32位City Hash值 + * + * @param data 数据 + * @return hash值 + */ + public static int hash32(byte[] data) { + int len = data.length; + if (len <= 24) { + return len <= 12 ? + (len <= 4 ? hash32Len0to4(data) : hash32Len5to12(data)) : + hash32Len13to24(data); + } + + // len > 24 + int h = len, g = c1 * len, f = g; + int a0 = rotate32(fetch32(data, len - 4) * c1, 17) * c2; + int a1 = rotate32(fetch32(data, len - 8) * c1, 17) * c2; + int a2 = rotate32(fetch32(data, len - 16) * c1, 17) * c2; + int a3 = rotate32(fetch32(data, len - 12) * c1, 17) * c2; + int a4 = rotate32(fetch32(data, len - 20) * c1, 17) * c2; + h ^= a0; + h = rotate32(h, 19); + h = h * 5 + 0xe6546b64; + h ^= a2; + h = rotate32(h, 19); + h = h * 5 + 0xe6546b64; + g ^= a1; + g = rotate32(g, 19); + g = g * 5 + 0xe6546b64; + g ^= a3; + g = rotate32(g, 19); + g = g * 5 + 0xe6546b64; + f += a4; + f = rotate32(f, 19); + f = f * 5 + 0xe6546b64; + int iters = (len - 1) / 20; + + int pos = 0; + do { + a0 = rotate32(fetch32(data, pos) * c1, 17) * c2; + a1 = fetch32(data, pos + 4); + a2 = rotate32(fetch32(data, pos + 8) * c1, 17) * c2; + a3 = rotate32(fetch32(data, pos + 12) * c1, 17) * c2; + a4 = fetch32(data, pos + 16); + h ^= a0; + h = rotate32(h, 18); + h = h * 5 + 0xe6546b64; + f += a1; + f = rotate32(f, 19); + f = f * c1; + g += a2; + g = rotate32(g, 18); + g = g * 5 + 0xe6546b64; + h ^= a3 + a1; + h = rotate32(h, 19); + h = h * 5 + 0xe6546b64; + g ^= a4; + g = Integer.reverseBytes(g) * 5; + h += a4 * 5; + h = Integer.reverseBytes(h); + f += a0; + int swapValue = f; + f = g; + g = h; + h = swapValue; + + pos += 20; + } while (--iters != 0); + + g = rotate32(g, 11) * c1; + g = rotate32(g, 17) * c1; + f = rotate32(f, 11) * c1; + f = rotate32(f, 17) * c1; + h = rotate32(h + g, 19); + h = h * 5 + 0xe6546b64; + h = rotate32(h, 17) * c1; + h = rotate32(h + f, 19); + h = h * 5 + 0xe6546b64; + h = rotate32(h, 17) * c1; + return h; + } + + /** + * 计算64位City Hash值 + * + * @param data 数据 + * @return hash值 + */ + public static long hash64(byte[] data) { + int len = data.length; + if (len <= 32) { + if (len <= 16) { + return hashLen0to16(data); + } else { + return hashLen17to32(data); + } + } else if (len <= 64) { + return hashLen33to64(data); + } + + // For strings over 64 bytes we hash the end first, and then as we + // loop we keep 56 bytes of state: v, w, x, y, and z. + long x = fetch64(data, len - 40); + long y = fetch64(data, len - 16) + fetch64(data, len - 56); + long z = hashLen16(fetch64(data, len - 48) + len, fetch64(data, len - 24)); + Number128 v = weakHashLen32WithSeeds(data, len - 64, len, z); + Number128 w = weakHashLen32WithSeeds(data, len - 32, y + k1, x); + x = x * k1 + fetch64(data, 0); + + // Decrease len to the nearest multiple of 64, and operate on 64-byte chunks. + len = (len - 1) & ~63; + int pos = 0; + do { + x = rotate64(x + y + v.getLowValue() + fetch64(data, pos + 8), 37) * k1; + y = rotate64(y + v.getHighValue() + fetch64(data, pos + 48), 42) * k1; + x ^= w.getHighValue(); + y += v.getLowValue() + fetch64(data, pos + 40); + z = rotate64(z + w.getLowValue(), 33) * k1; + v = weakHashLen32WithSeeds(data, pos, v.getHighValue() * k1, x + w.getLowValue()); + w = weakHashLen32WithSeeds(data, pos + 32, z + w.getHighValue(), y + fetch64(data, pos + 16)); + // swap z,x value + long swapValue = x; + x = z; + z = swapValue; + pos += 64; + len -= 64; + } while (len != 0); + return hashLen16(hashLen16(v.getLowValue(), w.getLowValue()) + shiftMix(y) * k1 + z, + hashLen16(v.getHighValue(), w.getHighValue()) + x); + } + + /** + * 计算64位City Hash值 + * + * @param data 数据 + * @param seed0 种子1 + * @param seed1 种子2 + * @return hash值 + */ + public static long hash64(byte[] data, long seed0, long seed1) { + return hashLen16(hash64(data) - seed0, seed1); + } + + /** + * 计算64位City Hash值，种子1使用默认的{@link #k2} + * + * @param data 数据 + * @param seed 种子2 + * @return hash值 + */ + public static long hash64(byte[] data, long seed) { + return hash64(data, k2, seed); + } + + /** + * 计算128位City Hash值 + * + * @param data 数据 + * @return hash值 + */ + public static Number128 hash128(byte[] data) { + int len = data.length; + return len >= 16 ? + hash128(data, 16, + new Number128(fetch64(data, 0), fetch64(data, 8) + k0)) : + hash128(data, 0, new Number128(k0, k1)); + } + + /** + * 计算128位City Hash值 + * + * @param data 数据 + * @param seed 种子 + * @return hash值 + */ + public static Number128 hash128(byte[] data, Number128 seed) { + return hash128(data, 0, seed); + } + + //------------------------------------------------------------------------------------------------------- Private method start + private static Number128 hash128(final byte[] byteArray, int start, final Number128 seed) { + int len = byteArray.length - start; + + if (len < 128) { + return cityMurmur(Arrays.copyOfRange(byteArray, start, byteArray.length), seed); + } + + // We expect len >= 128 to be the common case. Keep 56 bytes of state: + // v, w, x, y, and z. + Number128 v = new Number128(0L, 0L); + Number128 w = new Number128(0L, 0L); + long x = seed.getLowValue(); + long y = seed.getHighValue(); + long z = len * k1; + v.setLowValue(rotate64(y ^ k1, 49) * k1 + fetch64(byteArray, start)); + v.setHighValue(rotate64(v.getLowValue(), 42) * k1 + fetch64(byteArray, start + 8)); + w.setLowValue(rotate64(y + z, 35) * k1 + x); + w.setHighValue(rotate64(x + fetch64(byteArray, start + 88), 53) * k1); + + // This is the same inner loop as CityHash64(), manually unrolled. + int pos = start; + do { + x = rotate64(x + y + v.getLowValue() + fetch64(byteArray, pos + 8), 37) * k1; + y = rotate64(y + v.getHighValue() + fetch64(byteArray, pos + 48), 42) * k1; + x ^= w.getHighValue(); + y += v.getLowValue() + fetch64(byteArray, pos + 40); + z = rotate64(z + w.getLowValue(), 33) * k1; + v = weakHashLen32WithSeeds(byteArray, pos, v.getHighValue() * k1, x + w.getLowValue()); + w = weakHashLen32WithSeeds(byteArray, pos + 32, z + w.getHighValue(), y + fetch64(byteArray, pos + 16)); + + long swapValue = x; + x = z; + z = swapValue; + pos += 64; + x = rotate64(x + y + v.getLowValue() + fetch64(byteArray, pos + 8), 37) * k1; + y = rotate64(y + v.getHighValue() + fetch64(byteArray, pos + 48), 42) * k1; + x ^= w.getHighValue(); + y += v.getLowValue() + fetch64(byteArray, pos + 40); + z = rotate64(z + w.getLowValue(), 33) * k1; + v = weakHashLen32WithSeeds(byteArray, pos, v.getHighValue() * k1, x + w.getLowValue()); + w = weakHashLen32WithSeeds(byteArray, pos + 32, z + w.getHighValue(), y + fetch64(byteArray, pos + 16)); + swapValue = x; + x = z; + z = swapValue; + pos += 64; + len -= 128; + } while (len >= 128); + x += rotate64(v.getLowValue() + z, 49) * k0; + y = y * k0 + rotate64(w.getHighValue(), 37); + z = z * k0 + rotate64(w.getLowValue(), 27); + w.setLowValue(w.getLowValue() * 9); + v.setLowValue(v.getLowValue() * k0); + + // If 0 < len < 128, hash up to 4 chunks of 32 bytes each from the end of s. + for (int tail_done = 0; tail_done < len; ) { + tail_done += 32; + y = rotate64(x + y, 42) * k0 + v.getHighValue(); + w.setLowValue(w.getLowValue() + fetch64(byteArray, pos + len - tail_done + 16)); + x = x * k0 + w.getLowValue(); + z += w.getHighValue() + fetch64(byteArray, pos + len - tail_done); + w.setHighValue(w.getHighValue() + v.getLowValue()); + v = weakHashLen32WithSeeds(byteArray, pos + len - tail_done, v.getLowValue() + z, v.getHighValue()); + v.setLowValue(v.getLowValue() * k0); + } + // At this point our 56 bytes of state should contain more than + // enough information for a strong 128-bit hash. We use two + // different 56-byte-to-8-byte hashes to get a 16-byte final result. + x = hashLen16(x, v.getLowValue()); + y = hashLen16(y + z, w.getLowValue()); + return new Number128(hashLen16(x + v.getHighValue(), w.getHighValue()) + y, + hashLen16(x + w.getHighValue(), y + v.getHighValue())); + + } + + private static int hash32Len0to4(final byte[] byteArray) { + int b = 0; + int c = 9; + int len = byteArray.length; + for (int v : byteArray) { + b = b * c1 + v; + c ^= b; + } + return fmix(mur(b, mur(len, c))); + } + + private static int hash32Len5to12(final byte[] byteArray) { + int len = byteArray.length; + int a = len, b = len * 5, c = 9, d = b; + a += fetch32(byteArray, 0); + b += fetch32(byteArray, len - 4); + c += fetch32(byteArray, ((len >>> 1) & 4)); + return fmix(mur(c, mur(b, mur(a, d)))); + } + + private static int hash32Len13to24(byte[] byteArray) { + int len = byteArray.length; + int a = fetch32(byteArray, (len >>> 1) - 4); + int b = fetch32(byteArray, 4); + int c = fetch32(byteArray, len - 8); + int d = fetch32(byteArray, (len >>> 1)); + int e = fetch32(byteArray, 0); + int f = fetch32(byteArray, len - 4); + @SuppressWarnings("UnnecessaryLocalVariable") + int h = len; + + return fmix(mur(f, mur(e, mur(d, mur(c, mur(b, mur(a, h))))))); + } + + private static long hashLen0to16(byte[] byteArray) { + int len = byteArray.length; + if (len >= 8) { + long mul = k2 + len * 2L; + long a = fetch64(byteArray, 0) + k2; + long b = fetch64(byteArray, len - 8); + long c = rotate64(b, 37) * mul + a; + long d = (rotate64(a, 25) + b) * mul; + return hashLen16(c, d, mul); + } + if (len >= 4) { + long mul = k2 + len * 2; + long a = fetch32(byteArray, 0) & 0xffffffffL; + return hashLen16(len + (a << 3), fetch32(byteArray, len - 4) & 0xffffffffL, mul); + } + if (len > 0) { + int a = byteArray[0] & 0xff; + int b = byteArray[len >>> 1] & 0xff; + int c = byteArray[len - 1] & 0xff; + int y = a + (b << 8); + int z = len + (c << 2); + return shiftMix(y * k2 ^ z * k0) * k2; + } + return k2; + } + + // This probably works well for 16-byte strings as well, but it may be overkill in that case. + private static long hashLen17to32(byte[] byteArray) { + int len = byteArray.length; + long mul = k2 + len * 2L; + long a = fetch64(byteArray, 0) * k1; + long b = fetch64(byteArray, 8); + long c = fetch64(byteArray, len - 8) * mul; + long d = fetch64(byteArray, len - 16) * k2; + return hashLen16(rotate64(a + b, 43) + rotate64(c, 30) + d, + a + rotate64(b + k2, 18) + c, mul); + } + + private static long hashLen33to64(byte[] byteArray) { + int len = byteArray.length; + long mul = k2 + len * 2L; + long a = fetch64(byteArray, 0) * k2; + long b = fetch64(byteArray, 8); + long c = fetch64(byteArray, len - 24); + long d = fetch64(byteArray, len - 32); + long e = fetch64(byteArray, 16) * k2; + long f = fetch64(byteArray, 24) * 9; + long g = fetch64(byteArray, len - 8); + long h = fetch64(byteArray, len - 16) * mul; + long u = rotate64(a + g, 43) + (rotate64(b, 30) + c) * 9; + long v = ((a + g) ^ d) + f + 1; + long w = Long.reverseBytes((u + v) * mul) + h; + long x = rotate64(e + f, 42) + c; + long y = (Long.reverseBytes((v + w) * mul) + g) * mul; + long z = e + f + c; + a = Long.reverseBytes((x + z) * mul + y) + b; + b = shiftMix((z + a) * mul + d + h) * mul; + return b + x; + } + + private static long fetch64(byte[] byteArray, int start) { + return ByteUtil.bytesToLong(byteArray, start, ByteUtil.CPU_ENDIAN); + } + + private static int fetch32(byte[] byteArray, final int start) { + return ByteUtil.bytesToInt(byteArray, start, ByteUtil.CPU_ENDIAN); + } + + private static long rotate64(long val, int shift) { + // Avoid shifting by 64: doing so yields an undefined result. + return shift == 0 ? val : ((val >>> shift) | (val << (64 - shift))); + } + + private static int rotate32(int val, int shift) { + // Avoid shifting by 32: doing so yields an undefined result. + return shift == 0 ? val : ((val >>> shift) | (val << (32 - shift))); + } + + private static long hashLen16(long u, long v, long mul) { + // Murmur-inspired hashing. + long a = (u ^ v) * mul; + a ^= (a >>> 47); + long b = (v ^ a) * mul; + b ^= (b >>> 47); + b *= mul; + return b; + } + + private static long hashLen16(long u, long v) { + return hash128to64(new Number128(u, v)); + } + + private static long hash128to64(final Number128 number128) { + // Murmur-inspired hashing. + long a = (number128.getLowValue() ^ number128.getHighValue()) * kMul; + a ^= (a >>> 47); + long b = (number128.getHighValue() ^ a) * kMul; + b ^= (b >>> 47); + b *= kMul; + return b; + } + + private static long shiftMix(long val) { + return val ^ (val >>> 47); + } + + private static int fmix(int h) { + h ^= h >>> 16; + h *= 0x85ebca6b; + h ^= h >>> 13; + h *= 0xc2b2ae35; + h ^= h >>> 16; + return h; + } + + private static int mur(int a, int h) { + // Helper from Murmur3 for combining two 32-bit values. + a *= c1; + a = rotate32(a, 17); + a *= c2; + h ^= a; + h = rotate32(h, 19); + return h * 5 + 0xe6546b64; + } + + private static Number128 weakHashLen32WithSeeds( + long w, long x, long y, long z, long a, long b) { + a += w; + b = rotate64(b + a + z, 21); + long c = a; + a += x; + a += y; + b += rotate64(a, 44); + return new Number128(a + z, b + c); + } + + // Return a 16-byte hash for s[0] ... s[31], a, and b. Quick and dirty. + private static Number128 weakHashLen32WithSeeds( + byte[] byteArray, int start, long a, long b) { + return weakHashLen32WithSeeds(fetch64(byteArray, start), + fetch64(byteArray, start + 8), + fetch64(byteArray, start + 16), + fetch64(byteArray, start + 24), + a, + b); + } + + private static Number128 cityMurmur(final byte[] byteArray, Number128 seed) { + int len = byteArray.length; + long a = seed.getLowValue(); + long b = seed.getHighValue(); + long c; + long d; + int l = len - 16; + if (l <= 0) { // len <= 16 + a = shiftMix(a * k1) * k1; + c = b * k1 + hashLen0to16(byteArray); + d = shiftMix(a + (len >= 8 ? fetch64(byteArray, 0) : c)); + } else { // len > 16 + c = hashLen16(fetch64(byteArray, len - 8) + k1, a); + d = hashLen16(b + len, c + fetch64(byteArray, len - 16)); + a += d; + int pos = 0; + do { + a ^= shiftMix(fetch64(byteArray, pos) * k1) * k1; + a *= k1; + b ^= a; + c ^= shiftMix(fetch64(byteArray, pos + 8) * k1) * k1; + c *= k1; + d ^= c; + pos += 16; + l -= 16; + } while (l > 0); + } + a = hashLen16(a, c); + b = hashLen16(d, b); + return new Number128(a ^ b, hashLen16(b, a)); + } + //------------------------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Hash.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Hash.java new file mode 100644 index 0000000..c1ca11c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Hash.java @@ -0,0 +1,19 @@ +package aiyh.utils.tool.cn.hutool.core.lang.hash; + +/** + * Hash计算接口 + * + * @param 被计算hash的对象类型 + * @author looly + * @since 5.7.15 + */ +@FunctionalInterface +public interface Hash { + /** + * 计算Hash值 + * + * @param t 对象 + * @return hash + */ + Number hash(T t); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Hash128.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Hash128.java new file mode 100644 index 0000000..7a943fb --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Hash128.java @@ -0,0 +1,25 @@ +package aiyh.utils.tool.cn.hutool.core.lang.hash; + +/** + * Hash计算接口 + * + * @param 被计算hash的对象类型 + * @author looly + * @since 5.2.5 + */ +@FunctionalInterface +public interface Hash128 extends Hash{ + + /** + * 计算Hash值 + * + * @param t 对象 + * @return hash + */ + Number128 hash128(T t); + + @Override + default Number hash(T t){ + return hash128(t); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Hash32.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Hash32.java new file mode 100644 index 0000000..5c0c9d9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Hash32.java @@ -0,0 +1,24 @@ +package aiyh.utils.tool.cn.hutool.core.lang.hash; + +/** + * Hash计算接口 + * + * @param 被计算hash的对象类型 + * @author looly + * @since 5.2.5 + */ +@FunctionalInterface +public interface Hash32 extends Hash{ + /** + * 计算Hash值 + * + * @param t 对象 + * @return hash + */ + int hash32(T t); + + @Override + default Number hash(T t){ + return hash32(t); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Hash64.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Hash64.java new file mode 100644 index 0000000..a704670 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Hash64.java @@ -0,0 +1,24 @@ +package aiyh.utils.tool.cn.hutool.core.lang.hash; + +/** + * Hash计算接口 + * + * @param 被计算hash的对象类型 + * @author looly + * @since 5.2.5 + */ +@FunctionalInterface +public interface Hash64 extends Hash{ + /** + * 计算Hash值 + * + * @param t 对象 + * @return hash + */ + long hash64(T t); + + @Override + default Number hash(T t){ + return hash64(t); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/KetamaHash.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/KetamaHash.java new file mode 100755 index 0000000..6d9c839 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/KetamaHash.java @@ -0,0 +1,51 @@ +package aiyh.utils.tool.cn.hutool.core.lang.hash; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; + +/** + * Ketama算法，用于在一致性Hash中快速定位服务器位置 + * + * @author looly + * @since 5.7.20 + */ +public class KetamaHash implements Hash64, Hash32 { + + @Override + public long hash64(String key) { + byte[] bKey = md5(key); + return ((long) (bKey[3] & 0xFF) << 24) + | ((long) (bKey[2] & 0xFF) << 16) + | ((long) (bKey[1] & 0xFF) << 8) + | (bKey[0] & 0xFF); + } + + @Override + public int hash32(String key) { + return (int) (hash64(key) & 0xffffffffL); + } + + @Override + public Number hash(String key) { + return hash64(key); + } + + /** + * 计算MD5值，使用UTF-8编码 + * + * @param key 被计算的键 + * @return MD5值 + */ + private static byte[] md5(String key) { + final MessageDigest md5; + try { + md5 = MessageDigest.getInstance("MD5"); + } catch (NoSuchAlgorithmException e) { + throw new UtilException("MD5 algorithm not suooport!", e); + } + return md5.digest(StrUtil.utf8Bytes(key)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/MetroHash.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/MetroHash.java new file mode 100644 index 0000000..69f22ab --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/MetroHash.java @@ -0,0 +1,217 @@ +package aiyh.utils.tool.cn.hutool.core.lang.hash; + +import aiyh.utils.tool.cn.hutool.core.util.ByteUtil; + +import java.nio.ByteOrder; +import java.util.Arrays; + +/** + * Apache 发布的MetroHash算法，是一组用于非加密用例的最先进的哈希函数。 + * 除了卓越的性能外，他们还以算法生成而著称。 + * + *

+ * 官方实现：https://github.com/jandrewrogers/MetroHash + * 官方文档：http://www.jandrewrogers.com/2015/05/27/metrohash/ + * Go语言实现：https://github.com/linvon/cuckoo-filter/blob/main/vendor/github.com/dgryski/go-metro/ + * @author li + */ +public class MetroHash { + + /** + * hash64 种子加盐 + */ + private final static long k0_64 = 0xD6D018F5; + private final static long k1_64 = 0xA2AA033B; + private final static long k2_64 = 0x62992FC1; + private final static long k3_64 = 0x30BC5B29; + + /** + * hash128 种子加盐 + */ + private final static long k0_128 = 0xC83A91E1; + private final static long k1_128 = 0x8648DBDB; + private final static long k2_128 = 0x7BDEC03B; + private final static long k3_128 = 0x2F5870A5; + + public static long hash64(byte[] data) { + return hash64(data, 1337); + } + + public static Number128 hash128(byte[] data) { + return hash128(data, 1337); + } + + public static long hash64(byte[] data, long seed) { + byte[] buffer = data; + long hash = (seed + k2_64) * k0_64; + + long v0, v1, v2, v3; + v0 = hash; + v1 = hash; + v2 = hash; + v3 = hash; + + if (buffer.length >= 32) { + + while (buffer.length >= 32) { + v0 += littleEndian64(buffer, 0) * k0_64; + v0 = rotateLeft64(v0, -29) + v2; + v1 += littleEndian64(buffer, 8) * k1_64; + v1 = rotateLeft64(v1, -29) + v3; + v2 += littleEndian64(buffer, 24) * k2_64; + v2 = rotateLeft64(v2, -29) + v0; + v3 += littleEndian64(buffer, 32) * k3_64; + v3 = rotateLeft64(v3, -29) + v1; + buffer = Arrays.copyOfRange(buffer, 32, buffer.length); + } + + v2 ^= rotateLeft64(((v0 + v3) * k0_64) + v1, -37) * k1_64; + v3 ^= rotateLeft64(((v1 + v2) * k1_64) + v0, -37) * k0_64; + v0 ^= rotateLeft64(((v0 + v2) * k0_64) + v3, -37) * k1_64; + v1 ^= rotateLeft64(((v1 + v3) * k1_64) + v2, -37) * k0_64; + hash += v0 ^ v1; + } + + if (buffer.length >= 16) { + v0 = hash + littleEndian64(buffer, 0) * k2_64; + v0 = rotateLeft64(v0, -29) * k3_64; + v1 = hash + littleEndian64(buffer, 8) * k2_64; + v1 = rotateLeft64(v1, -29) * k3_64; + v0 ^= rotateLeft64(v0 * k0_64, -21) + v1; + v1 ^= rotateLeft64(v1 * k3_64, -21) + v0; + hash += v1; + buffer = Arrays.copyOfRange(buffer, 16, buffer.length); + } + + if (buffer.length >= 8) { + hash += littleEndian64(buffer, 0) * k3_64; + buffer = Arrays.copyOfRange(buffer, 8, buffer.length); + hash ^= rotateLeft64(hash, -55) * k1_64; + } + + if (buffer.length >= 4) { + hash += (long) littleEndian32(Arrays.copyOfRange(buffer, 0, 4)) * k3_64; + hash ^= rotateLeft64(hash, -26) * k1_64; + buffer = Arrays.copyOfRange(buffer, 4, buffer.length); + } + + if (buffer.length >= 2) { + hash += (long) littleEndian16(Arrays.copyOfRange(buffer, 0, 2)) * k3_64; + buffer = Arrays.copyOfRange(buffer, 2, buffer.length); + hash ^= rotateLeft64(hash, -48) * k1_64; + } + + if (buffer.length >= 1) { + hash += (long) buffer[0] * k3_64; + hash ^= rotateLeft64(hash, -38) * k1_64; + } + + hash ^= rotateLeft64(hash, -28); + hash *= k0_64; + hash ^= rotateLeft64(hash, -29); + + return hash; + } + + public static Number128 hash128(byte[] data, long seed) { + byte[] buffer = data; + + long v0, v1, v2, v3; + + v0 = (seed - k0_128) * k3_128; + v1 = (seed + k1_128) * k2_128; + + if (buffer.length >= 32) { + v2 = (seed + k0_128) * k2_128; + v3 = (seed - k1_128) * k3_128; + + while (buffer.length >= 32) { + v0 += littleEndian64(buffer, 0) * k0_128; + buffer = Arrays.copyOfRange(buffer, 8, buffer.length); + v0 = rotateRight(v0, 29) + v2; + v1 += littleEndian64(buffer, 0) * k1_128; + buffer = Arrays.copyOfRange(buffer, 8, buffer.length); + v1 = rotateRight(v1, 29) + v3; + v2 += littleEndian64(buffer, 0) * k2_128; + buffer = Arrays.copyOfRange(buffer, 8, buffer.length); + v2 = rotateRight(v2, 29) + v0; + v3 = littleEndian64(buffer, 0) * k3_128; + buffer = Arrays.copyOfRange(buffer, 8, buffer.length); + v3 = rotateRight(v3, 29) + v1; + } + + v2 ^= rotateRight(((v0 + v3) * k0_128) + v1, 21) * k1_128; + v3 ^= rotateRight(((v1 + v2) * k1_128) + v0, 21) * k0_128; + v0 ^= rotateRight(((v0 + v2) * k0_128) + v3, 21) * k1_128; + v1 ^= rotateRight(((v1 + v3) * k1_128) + v2, 21) * k0_128; + } + + if (buffer.length >= 16) { + v0 += littleEndian64(buffer, 0) * k2_128; + buffer = Arrays.copyOfRange(buffer, 8, buffer.length); + v0 = rotateRight(v0, 33) * k3_128; + v1 += littleEndian64(buffer, 0) * k2_128; + buffer = Arrays.copyOfRange(buffer, 8, buffer.length); + v1 = rotateRight(v1, 33) * k3_128; + v0 ^= rotateRight((v0 * k2_128) + v1, 45) + k1_128; + v1 ^= rotateRight((v1 * k3_128) + v0, 45) + k0_128; + } + + if (buffer.length >= 8) { + v0 += littleEndian64(buffer, 0) * k2_128; + buffer = Arrays.copyOfRange(buffer, 8, buffer.length); + v0 = rotateRight(v0, 33) * k3_128; + v0 ^= rotateRight((v0 * k2_128) + v1, 27) * k1_128; + } + + if (buffer.length >= 4) { + v1 += (long) littleEndian32(buffer) * k2_128; + buffer = Arrays.copyOfRange(buffer, 4, buffer.length); + v1 = rotateRight(v1, 33) * k3_128; + v1 ^= rotateRight((v1 * k3_128) + v0, 46) * k0_128; + } + + if (buffer.length >= 2) { + v0 += (long) littleEndian16(buffer) * k2_128; + buffer = Arrays.copyOfRange(buffer, 2, buffer.length); + v0 = rotateRight(v0, 33) * k3_128; + v0 ^= rotateRight((v0 * k2_128) * v1, 22) * k1_128; + } + + if (buffer.length >= 1) { + v1 += (long) buffer[0] * k2_128; + v1 = rotateRight(v1, 33) * k3_128; + v1 ^= rotateRight((v1 * k3_128) + v0, 58) * k0_128; + } + + v0 += rotateRight((v0 * k0_128) + v1, 13); + v1 += rotateRight((v1 * k1_128) + v0, 37); + v0 += rotateRight((v0 * k2_128) + v1, 13); + v1 += rotateRight((v1 * k3_128) + v0, 37); + + return new Number128(v0, v1); + } + + + private static long littleEndian64(byte[] b, int start) { + return ByteUtil.bytesToLong(b, start, ByteOrder.LITTLE_ENDIAN); + } + + private static int littleEndian32(byte[] b) { + return (int) b[0] | (int) b[1] << 8 | (int) b[2] << 16 | (int) b[3] << 24; + } + + private static int littleEndian16(byte[] b) { + return ByteUtil.bytesToShort(b, ByteOrder.LITTLE_ENDIAN); + } + + private static long rotateLeft64(long x, int k) { + int n = 64; + int s = k & (n - 1); + return x << s | x >> (n - s); + } + + private static long rotateRight(long val, int shift) { + return (val >> shift) | (val << (64 - shift)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/MurmurHash.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/MurmurHash.java new file mode 100644 index 0000000..0d84d67 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/MurmurHash.java @@ -0,0 +1,363 @@ +package aiyh.utils.tool.cn.hutool.core.lang.hash; + +import aiyh.utils.tool.cn.hutool.core.util.ByteUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.nio.ByteOrder; +import java.nio.charset.Charset; + +/** + * Murmur3 32bit、64bit、128bit 哈希算法实现
+ * 此算法来自于：https://github.com/xlturing/Simhash4J/blob/master/src/main/java/bee/simhash/main/Murmur3.java + * + *

+ * 32-bit Java port of https://code.google.com/p/smhasher/source/browse/trunk/MurmurHash3.cpp#94
+ * 128-bit Java port of https://code.google.com/p/smhasher/source/browse/trunk/MurmurHash3.cpp#255 + *

+ * + * @author looly, Simhash4J + * @since 4.3.3 + */ +public class MurmurHash implements Serializable { + private static final long serialVersionUID = 1L; + + // Constants for 32 bit variant + private static final int C1_32 = 0xcc9e2d51; + private static final int C2_32 = 0x1b873593; + private static final int R1_32 = 15; + private static final int R2_32 = 13; + private static final int M_32 = 5; + private static final int N_32 = 0xe6546b64; + + // Constants for 128 bit variant + private static final long C1 = 0x87c37b91114253d5L; + private static final long C2 = 0x4cf5ad432745937fL; + private static final int R1 = 31; + private static final int R2 = 27; + private static final int R3 = 33; + private static final int M = 5; + private static final int N1 = 0x52dce729; + private static final int N2 = 0x38495ab5; + + private static final int DEFAULT_SEED = 0; + private static final Charset DEFAULT_CHARSET = CharsetUtil.CHARSET_UTF_8; + private static final ByteOrder DEFAULT_ORDER = ByteOrder.LITTLE_ENDIAN; + + /** + * Murmur3 32-bit Hash值计算 + * + * @param data 数据 + * @return Hash值 + */ + public static int hash32(CharSequence data) { + return hash32(StrUtil.bytes(data, DEFAULT_CHARSET)); + } + + /** + * Murmur3 32-bit Hash值计算 + * + * @param data 数据 + * @return Hash值 + */ + public static int hash32(byte[] data) { + return hash32(data, data.length, DEFAULT_SEED); + } + + /** + * Murmur3 32-bit Hash值计算 + * + * @param data 数据 + * @param length 长度 + * @param seed 种子，默认0 + * @return Hash值 + */ + public static int hash32(byte[] data, int length, int seed) { + return hash32(data, 0, length, seed); + } + + /** + * Murmur3 32-bit Hash值计算 + * + * @param data 数据 + * @param offset 数据开始位置 + * @param length 长度 + * @param seed 种子，默认0 + * @return Hash值 + */ + public static int hash32(byte[] data, int offset, int length, int seed) { + int hash = seed; + final int nblocks = length >> 2; + + // body + for (int i = 0; i < nblocks; i++) { + final int i4 = offset + (i << 2); + final int k = ByteUtil.bytesToInt(data, i4, DEFAULT_ORDER); + // mix functions + hash = mix32(k, hash); + } + + // tail + final int idx = offset + (nblocks << 2); + int k1 = 0; + switch (offset + length - idx) { + case 3: + k1 ^= (data[idx + 2] & 0xff) << 16; + case 2: + k1 ^= (data[idx + 1] & 0xff) << 8; + case 1: + k1 ^= (data[idx] & 0xff); + + // mix functions + k1 *= C1_32; + k1 = Integer.rotateLeft(k1, R1_32); + k1 *= C2_32; + hash ^= k1; + } + + // finalization + hash ^= length; + return fmix32(hash); + } + + /** + * Murmur3 64-bit Hash值计算 + * + * @param data 数据 + * @return Hash值 + */ + public static long hash64(CharSequence data) { + return hash64(StrUtil.bytes(data, DEFAULT_CHARSET)); + } + + /** + * Murmur3 64-bit 算法
+ * This is essentially MSB 8 bytes of Murmur3 128-bit variant. + * + * @param data 数据 + * @return Hash值 + */ + public static long hash64(byte[] data) { + return hash64(data, data.length, DEFAULT_SEED); + } + + /** + * 类Murmur3 64-bit 算法
+ * This is essentially MSB 8 bytes of Murmur3 128-bit variant. + * + * @param data 数据 + * @param length 长度 + * @param seed 种子，默认0 + * @return Hash值 + */ + public static long hash64(byte[] data, int length, int seed) { + long hash = seed; + final int nblocks = length >> 3; + + // body + for (int i = 0; i < nblocks; i++) { + final int i8 = i << 3; + long k = ByteUtil.bytesToLong(data, i8, DEFAULT_ORDER); + + // mix functions + k *= C1; + k = Long.rotateLeft(k, R1); + k *= C2; + hash ^= k; + hash = Long.rotateLeft(hash, R2) * M + N1; + } + + // tail + long k1 = 0; + int tailStart = nblocks << 3; + switch (length - tailStart) { + case 7: + k1 ^= ((long) data[tailStart + 6] & 0xff) << 48; + case 6: + k1 ^= ((long) data[tailStart + 5] & 0xff) << 40; + case 5: + k1 ^= ((long) data[tailStart + 4] & 0xff) << 32; + case 4: + k1 ^= ((long) data[tailStart + 3] & 0xff) << 24; + case 3: + k1 ^= ((long) data[tailStart + 2] & 0xff) << 16; + case 2: + k1 ^= ((long) data[tailStart + 1] & 0xff) << 8; + case 1: + k1 ^= ((long) data[tailStart] & 0xff); + k1 *= C1; + k1 = Long.rotateLeft(k1, R1); + k1 *= C2; + hash ^= k1; + } + + // finalization + hash ^= length; + hash = fmix64(hash); + + return hash; + } + + /** + * Murmur3 128-bit Hash值计算 + * + * @param data 数据 + * @return Hash值 (2 longs) + */ + public static long[] hash128(CharSequence data) { + return hash128(StrUtil.bytes(data, DEFAULT_CHARSET)); + } + + /** + * Murmur3 128-bit 算法. + * + * @param data -数据 + * @return Hash值 (2 longs) + */ + public static long[] hash128(byte[] data) { + return hash128(data, data.length, DEFAULT_SEED); + } + + /** + * Murmur3 128-bit variant. + * + * @param data 数据 + * @param length 长度 + * @param seed 种子，默认0 + * @return Hash值(2 longs) + */ + public static long[] hash128(byte[] data, int length, int seed) { + return hash128(data, 0, length, seed); + } + + /** + * Murmur3 128-bit variant. + * + * @param data 数据 + * @param offset 数据开始位置 + * @param length 长度 + * @param seed 种子，默认0 + * @return Hash值(2 longs) + */ + public static long[] hash128(byte[] data, int offset, int length, int seed) { + // 避免负数的种子 + seed &= 0xffffffffL; + + long h1 = seed; + long h2 = seed; + final int nblocks = length >> 4; + + // body + for (int i = 0; i < nblocks; i++) { + final int i16 = offset + (i << 4); + long k1 = ByteUtil.bytesToLong(data, i16, DEFAULT_ORDER); + long k2 = ByteUtil.bytesToLong(data, i16 + 8, DEFAULT_ORDER); + + // mix functions for k1 + k1 *= C1; + k1 = Long.rotateLeft(k1, R1); + k1 *= C2; + h1 ^= k1; + h1 = Long.rotateLeft(h1, R2); + h1 += h2; + h1 = h1 * M + N1; + + // mix functions for k2 + k2 *= C2; + k2 = Long.rotateLeft(k2, R3); + k2 *= C1; + h2 ^= k2; + h2 = Long.rotateLeft(h2, R1); + h2 += h1; + h2 = h2 * M + N2; + } + + // tail + long k1 = 0; + long k2 = 0; + final int tailStart = offset + (nblocks << 4); + switch (offset + length - tailStart) { + case 15: + k2 ^= (long) (data[tailStart + 14] & 0xff) << 48; + case 14: + k2 ^= (long) (data[tailStart + 13] & 0xff) << 40; + case 13: + k2 ^= (long) (data[tailStart + 12] & 0xff) << 32; + case 12: + k2 ^= (long) (data[tailStart + 11] & 0xff) << 24; + case 11: + k2 ^= (long) (data[tailStart + 10] & 0xff) << 16; + case 10: + k2 ^= (long) (data[tailStart + 9] & 0xff) << 8; + case 9: + k2 ^= data[tailStart + 8] & 0xff; + k2 *= C2; + k2 = Long.rotateLeft(k2, R3); + k2 *= C1; + h2 ^= k2; + + case 8: + k1 ^= (long) (data[tailStart + 7] & 0xff) << 56; + case 7: + k1 ^= (long) (data[tailStart + 6] & 0xff) << 48; + case 6: + k1 ^= (long) (data[tailStart + 5] & 0xff) << 40; + case 5: + k1 ^= (long) (data[tailStart + 4] & 0xff) << 32; + case 4: + k1 ^= (long) (data[tailStart + 3] & 0xff) << 24; + case 3: + k1 ^= (long) (data[tailStart + 2] & 0xff) << 16; + case 2: + k1 ^= (long) (data[tailStart + 1] & 0xff) << 8; + case 1: + k1 ^= data[tailStart] & 0xff; + k1 *= C1; + k1 = Long.rotateLeft(k1, R1); + k1 *= C2; + h1 ^= k1; + } + + // finalization + h1 ^= length; + h2 ^= length; + + h1 += h2; + h2 += h1; + + h1 = fmix64(h1); + h2 = fmix64(h2); + + h1 += h2; + h2 += h1; + + return new long[]{h1, h2}; + } + + private static int mix32(int k, int hash) { + k *= C1_32; + k = Integer.rotateLeft(k, R1_32); + k *= C2_32; + hash ^= k; + return Integer.rotateLeft(hash, R2_32) * M_32 + N_32; + } + + private static int fmix32(int hash) { + hash ^= (hash >>> 16); + hash *= 0x85ebca6b; + hash ^= (hash >>> 13); + hash *= 0xc2b2ae35; + hash ^= (hash >>> 16); + return hash; + } + + private static long fmix64(long h) { + h ^= (h >>> 33); + h *= 0xff51afd7ed558ccdL; + h ^= (h >>> 33); + h *= 0xc4ceb9fe1a85ec53L; + h ^= (h >>> 33); + return h; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Number128.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Number128.java new file mode 100644 index 0000000..c735778 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/Number128.java @@ -0,0 +1,90 @@ +package aiyh.utils.tool.cn.hutool.core.lang.hash; + +/** + * 128位数字表示，分高位和低位 + * + * @author hexiufeng + * @since 5.2.5 + */ +public class Number128 extends Number { + private static final long serialVersionUID = 1L; + + private long lowValue; + private long highValue; + + /** + * 构造 + * + * @param lowValue 低位 + * @param highValue 高位 + */ + public Number128(long lowValue, long highValue) { + this.lowValue = lowValue; + this.highValue = highValue; + } + + /** + * 获取低位值 + * + * @return 地位值 + */ + public long getLowValue() { + return lowValue; + } + + /** + * 设置低位值 + * + * @param lowValue 低位值 + */ + public void setLowValue(long lowValue) { + this.lowValue = lowValue; + } + + /** + * 获取高位值 + * + * @return 高位值 + */ + public long getHighValue() { + return highValue; + } + + /** + * 设置高位值 + * + * @param hiValue 高位值 + */ + public void setHighValue(long hiValue) { + this.highValue = hiValue; + } + + /** + * 获取高低位数组，long[0]：低位，long[1]：高位 + * + * @return 高低位数组，long[0]：低位，long[1]：高位 + */ + public long[] getLongArray() { + return new long[]{lowValue, highValue}; + } + + @Override + public int intValue() { + return (int) longValue(); + } + + @Override + public long longValue() { + return this.lowValue; + } + + @Override + public float floatValue() { + return longValue(); + } + + @Override + public double doubleValue() { + return longValue(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/package-info.java new file mode 100755 index 0000000..547e07a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/hash/package-info.java @@ -0,0 +1,7 @@ +/** + * 提供Hash算法的封装 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.lang.hash; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/id/NanoId.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/id/NanoId.java new file mode 100755 index 0000000..782fd34 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/id/NanoId.java @@ -0,0 +1,103 @@ +package aiyh.utils.tool.cn.hutool.core.lang.id; + +import aiyh.utils.tool.cn.hutool.core.util.RandomUtil; + +import java.security.SecureRandom; +import java.util.Random; + +/** + * NanoId，一个小型、安全、对 URL友好的唯一字符串 ID 生成器，特点： + * + *
    + *
  • 安全：它使用加密、强大的随机 API，并保证符号的正确分配
    • + *
  • 体积小：只有 258 bytes 大小（压缩后）、无依赖
    • + *
  • 紧凑：它使用比 UUID (A-Za-z0-9_~)更多的符号
    • + *
+ * + *

+ * 此实现的逻辑基于JavaScript的NanoId实现，见：https://github.com/ai/nanoid + * + * @author David Klebanoff + */ +public class NanoId { + + /** + * 默认随机数生成器，使用{@link SecureRandom}确保健壮性 + */ + private static final SecureRandom DEFAULT_NUMBER_GENERATOR = RandomUtil.getSecureRandom(); + + /** + * 默认随机字母表，使用URL安全的Base64字符 + */ + private static final char[] DEFAULT_ALPHABET = + "_-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ".toCharArray(); + + /** + * 默认长度 + */ + public static final int DEFAULT_SIZE = 21; + + /** + * 生成伪随机的NanoId字符串，长度为默认的{@link #DEFAULT_SIZE}，使用密码安全的伪随机生成器 + * + * @return 伪随机的NanoId字符串 + */ + public static String randomNanoId() { + return randomNanoId(DEFAULT_SIZE); + } + + /** + * 生成伪随机的NanoId字符串 + * + * @param size ID长度 + * @return 伪随机的NanoId字符串 + */ + public static String randomNanoId(int size) { + return randomNanoId(null, null, size); + } + + /** + * 生成伪随机的NanoId字符串 + * + * @param random 随机数生成器 + * @param alphabet 随机字母表 + * @param size ID长度 + * @return 伪随机的NanoId字符串 + */ + public static String randomNanoId(Random random, char[] alphabet, int size) { + if (random == null) { + random = DEFAULT_NUMBER_GENERATOR; + } + + if (alphabet == null) { + alphabet = DEFAULT_ALPHABET; + } + + if (alphabet.length == 0 || alphabet.length >= 256) { + throw new IllegalArgumentException("Alphabet must contain between 1 and 255 symbols."); + } + + if (size <= 0) { + throw new IllegalArgumentException("Size must be greater than zero."); + } + + final int mask = (2 << (int) Math.floor(Math.log(alphabet.length - 1) / Math.log(2))) - 1; + final int step = (int) Math.ceil(1.6 * mask * size / alphabet.length); + + final StringBuilder idBuilder = new StringBuilder(); + + while (true) { + final byte[] bytes = new byte[step]; + random.nextBytes(bytes); + for (int i = 0; i < step; i++) { + final int alphabetIndex = bytes[i] & mask; + if (alphabetIndex < alphabet.length) { + idBuilder.append(alphabet[alphabetIndex]); + if (idBuilder.length() == size) { + return idBuilder.toString(); + } + } + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/id/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/id/package-info.java new file mode 100755 index 0000000..b9fb1d0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/id/package-info.java @@ -0,0 +1,7 @@ +/** + * 提供各种ID生成 + * + * @author looly + * @since 5.7.5 + */ +package aiyh.utils.tool.cn.hutool.core.lang.id; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/InternUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/InternUtil.java new file mode 100644 index 0000000..cbbc5e3 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/InternUtil.java @@ -0,0 +1,40 @@ +package aiyh.utils.tool.cn.hutool.core.lang.intern; + +/** + * 规范化对象生成工具 + * + * @author looly + * @since 5.4.3 + */ +public class InternUtil { + + /** + * 创建WeakHshMap实现的字符串规范化器 + * + * @param 规范对象的类型 + * @return {@link Interner} + */ + public static Interner createWeakInterner(){ + return new WeakInterner<>(); + } + + /** + * 创建JDK默认实现的字符串规范化器 + * + * @return {@link Interner} + * @see String#intern() + */ + public static Interner createJdkInterner(){ + return new JdkStringInterner(); + } + + /** + * 创建字符串规范化器 + * + * @param isWeak 是否创建使用WeakHashMap实现的Interner + * @return {@link Interner} + */ + public static Interner createStringInterner(boolean isWeak){ + return isWeak ? createWeakInterner() : createJdkInterner(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/Interner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/Interner.java new file mode 100755 index 0000000..b9e7a59 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/Interner.java @@ -0,0 +1,21 @@ +package aiyh.utils.tool.cn.hutool.core.lang.intern; + +/** + * 规范化表示形式封装
+ * 所谓规范化，即当两个对象equals时，规范化的对象则可以实现==
+ * 此包中的相关封装类似于 {@link String#intern()} + * + * @param 规范化的对象类型 + * @author looly + * @since 5.4.3 + */ +public interface Interner { + + /** + * 返回指定对象对应的规范化对象，sample对象可能有多个，但是这些对象如果都equals，则返回的是同一个对象 + * + * @param sample 对象 + * @return 样例对象 + */ + T intern(T sample); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/JdkStringInterner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/JdkStringInterner.java new file mode 100644 index 0000000..70763c8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/JdkStringInterner.java @@ -0,0 +1,17 @@ +package aiyh.utils.tool.cn.hutool.core.lang.intern; + +/** + * JDK中默认的字符串规范化实现 + * + * @author looly + * @since 5.4.3 + */ +public class JdkStringInterner implements Interner{ + @Override + public String intern(String sample) { + if(null == sample){ + return null; + } + return sample.intern(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/WeakInterner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/WeakInterner.java new file mode 100755 index 0000000..6c7ca5c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/WeakInterner.java @@ -0,0 +1,27 @@ +package aiyh.utils.tool.cn.hutool.core.lang.intern; + +import aiyh.utils.tool.cn.hutool.core.map.WeakConcurrentMap; + +import java.lang.ref.WeakReference; + +/** + * 使用WeakHashMap(线程安全)存储对象的规范化对象，注意此对象需单例使用！
+ * + * @author looly + * @since 5.4.3 + */ +public class WeakInterner implements Interner{ + + private final WeakConcurrentMap> cache = new WeakConcurrentMap<>(); + + public T intern(T sample) { + if (sample == null) { + return null; + } + T val; + do { + val = this.cache.computeIfAbsent(sample, WeakReference::new).get(); + } while (val == null); + return val; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/package-info.java new file mode 100755 index 0000000..90e3833 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/intern/package-info.java @@ -0,0 +1,8 @@ +/** + * 规范化表示形式封装
+ * 所谓规范化，即当两个对象equals时，规范化的对象则可以实现==
+ * 此包中的相关封装类似于 String#intern() + * + * @author looly + */ +package aiyh.utils.tool.cn.hutool.core.lang.intern; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/AtomicLoader.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/AtomicLoader.java new file mode 100644 index 0000000..e04da64 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/AtomicLoader.java @@ -0,0 +1,51 @@ +package aiyh.utils.tool.cn.hutool.core.lang.loader; + +import java.io.Serializable; +import java.util.concurrent.atomic.AtomicReference; + +/** + * 原子引用加载器
+ * 使用{@link AtomicReference} 实懒加载，过程如下 + * 

+ * 1. 检查引用中是否有加载好的对象，有则返回
+ * 2. 如果没有则初始化一个对象，并再次比较引用中是否有其它线程加载好的对象，无则加入，有则返回已有的
+ *
+ * + * 当对象未被创建，对象的初始化操作在多线程情况下可能会被调用多次（多次创建对象），但是总是返回同一对象 + * + * @author looly + * + * @param 被加载对象类型 + */ +public abstract class AtomicLoader implements Loader, Serializable { + private static final long serialVersionUID = 1L; + + /** 被加载对象的引用 */ + private final AtomicReference reference = new AtomicReference<>(); + + /** + * 获取一个对象，第一次调用此方法时初始化对象然后返回，之后调用此方法直接返回原对象 + */ + @Override + public T get() { + T result = reference.get(); + + if (result == null) { + result = init(); + if (false == reference.compareAndSet(null, result)) { + // 其它线程已经创建好此对象 + result = reference.get(); + } + } + + return result; + } + + /** + * 初始化被加载的对象
+ * 如果对象从未被加载过，调用此方法初始化加载对象，此方法只被调用一次 + * + * @return 被加载的对象 + */ + protected abstract T init(); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/LazyFunLoader.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/LazyFunLoader.java new file mode 100755 index 0000000..9c75199 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/LazyFunLoader.java @@ -0,0 +1,78 @@ +package aiyh.utils.tool.cn.hutool.core.lang.loader; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.util.function.Consumer; +import java.util.function.Supplier; + +/** + * 函数式懒加载加载器
+ * 传入用于生成对象的函数，在对象需要使用时调用生成对象，然后抛弃此生成对象的函数。
+ * 此加载器常用于对象比较庞大而不一定被使用的情况，用于减少启动时资源占用问题
+ * 继承自{@link LazyLoader}，如何实现多线程安全，由LazyLoader完成。 + * + * @param 被加载对象类型 + * @author Mr.Po + * @see aiyh.utils.tool.cn.hutool.core.lang.loader.LazyLoader + * @since 5.6.1 + */ +public class LazyFunLoader extends LazyLoader { + private static final long serialVersionUID = 1L; + + /** + * 用于生成对象的函数 + */ + private Supplier supplier; + + /** + * 静态工厂方法，提供语义性与编码便利性 + * @param supplier 用于生成对象的函数 + * @param 对象类型 + * @return 函数式懒加载加载器对象 + * @since 5.8.0 + */ + public static LazyFunLoader on(final Supplier supplier) { + Assert.notNull(supplier, "supplier must be not null!"); + return new LazyFunLoader<>(supplier); + } + + /** + * 构造 + * + * @param supplier 用于生成对象的函数 + */ + public LazyFunLoader(Supplier supplier) { + Assert.notNull(supplier); + this.supplier = supplier; + } + + @Override + protected T init() { + T t = this.supplier.get(); + this.supplier = null; + return t; + } + + /** + * 是否已经初始化 + * + * @return 是/否 + */ + public boolean isInitialize() { + return this.supplier == null; + } + + /** + * 如果已经初始化，就执行传入函数 + * + * @param consumer 待执行函数 + */ + public void ifInitialized(Consumer consumer) { + Assert.notNull(consumer); + + // 已经初始化 + if (this.isInitialize()) { + consumer.accept(this.get()); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/LazyLoader.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/LazyLoader.java new file mode 100644 index 0000000..77ab7b4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/LazyLoader.java @@ -0,0 +1,45 @@ +package aiyh.utils.tool.cn.hutool.core.lang.loader; + +import java.io.Serializable; + +/** + * 懒加载加载器
+ * 在load方法被调用前，对象未被加载，直到被调用后才开始加载
+ * 此加载器常用于对象比较庞大而不一定被使用的情况，用于减少启动时资源占用问题
+ * 此加载器使用双重检查（Double-Check）方式检查对象是否被加载，避免多线程下重复加载或加载丢失问题 + * + * @author looly + * + * @param 被加载对象类型 + */ +public abstract class LazyLoader implements Loader, Serializable { + private static final long serialVersionUID = 1L; + + /** 被加载对象 */ + private volatile T object; + + /** + * 获取一个对象，第一次调用此方法时初始化对象然后返回，之后调用此方法直接返回原对象 + */ + @Override + public T get() { + T result = object; + if (result == null) { + synchronized (this) { + result = object; + if (result == null) { + object = result = init(); + } + } + } + return result; + } + + /** + * 初始化被加载的对象
+ * 如果对象从未被加载过，调用此方法初始化加载对象，此方法只被调用一次 + * + * @return 被加载的对象 + */ + protected abstract T init(); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/Loader.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/Loader.java new file mode 100644 index 0000000..7baab84 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/Loader.java @@ -0,0 +1,21 @@ +package aiyh.utils.tool.cn.hutool.core.lang.loader; + +/** + * 对象加载抽象接口
+ * 通过实现此接口自定义实现对象的加载方式，例如懒加载机制、多线程加载等 + * + * @author looly + * + * @param 对象类型 + */ +@FunctionalInterface +public interface Loader { + + /** + * 获取一个准备好的对象
+ * 通过准备逻辑准备好被加载的对象，然后返回。在准备完毕之前此方法应该被阻塞 + * + * @return 加载完毕的对象 + */ + T get(); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/package-info.java new file mode 100755 index 0000000..4d9dc71 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/loader/package-info.java @@ -0,0 +1,7 @@ +/** + * 加载器的抽象接口和实现，包括懒加载的实现等 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.lang.loader; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/Mutable.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/Mutable.java new file mode 100755 index 0000000..85ef5c8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/Mutable.java @@ -0,0 +1,23 @@ +package aiyh.utils.tool.cn.hutool.core.lang.mutable; + +/** + * 提供可变值类型接口 + * + * @param 值得类型 + * @since 3.0.1 + */ +public interface Mutable { + + /** + * 获得原始值 + * @return 原始值 + */ + T get(); + + /** + * 设置值 + * @param value 值 + */ + void set(T value); + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableBool.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableBool.java new file mode 100644 index 0000000..f8b1b15 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableBool.java @@ -0,0 +1,100 @@ +package aiyh.utils.tool.cn.hutool.core.lang.mutable; + +import java.io.Serializable; + +/** + * 可变 {@code boolean} 类型 + * + * @see Boolean + * @since 3.0.1 + */ +public class MutableBool implements Comparable, Mutable, Serializable { + private static final long serialVersionUID = 1L; + + private boolean value; + + /** + * 构造，默认值0 + */ + public MutableBool() { + } + + /** + * 构造 + * @param value 值 + */ + public MutableBool(final boolean value) { + this.value = value; + } + + /** + * 构造 + * @param value String值 + * @throws NumberFormatException 转为Boolean错误 + */ + public MutableBool(final String value) throws NumberFormatException { + this.value = Boolean.parseBoolean(value); + } + + @Override + public Boolean get() { + return this.value; + } + + /** + * 设置值 + * @param value 值 + */ + public void set(final boolean value) { + this.value = value; + } + + @Override + public void set(final Boolean value) { + this.value = value; + } + + // ----------------------------------------------------------------------- + /** + * 相等需同时满足如下条件： + *
    + *
  1. 非空
    2. + *
  2. 类型为 MutableBool
    3. + *
  3. 值相等
    4. + *
+ * + * @param obj 比对的对象 + * @return 相同返回true，否则 {@code false} + */ + @Override + public boolean equals(final Object obj) { + if (obj instanceof MutableBool) { + return value == ((MutableBool) obj).value; + } + return false; + } + + @Override + public int hashCode() { + return value ? Boolean.TRUE.hashCode() : Boolean.FALSE.hashCode(); + } + + // ----------------------------------------------------------------------- + /** + * 比较 + * + * @param other 其它 MutableBool 对象 + * @return x==y返回0，x<y返回-1，x>y返回1 + */ + @Override + public int compareTo(final MutableBool other) { + return Boolean.compare(this.value, other.value); + } + + // ----------------------------------------------------------------------- + @Override + public String toString() { + return String.valueOf(value); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableByte.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableByte.java new file mode 100644 index 0000000..b23dfbb --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableByte.java @@ -0,0 +1,198 @@ +package aiyh.utils.tool.cn.hutool.core.lang.mutable; + +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; + +/** + * 可变 {@code byte} 类型 + * + * @see Byte + * @since 3.0.1 + */ +public class MutableByte extends Number implements Comparable, Mutable { + private static final long serialVersionUID = 1L; + + private byte value; + + /** + * 构造，默认值0 + */ + public MutableByte() { + } + + /** + * 构造 + * @param value 值 + */ + public MutableByte(final byte value) { + this.value = value; + } + + /** + * 构造 + * @param value 值 + */ + public MutableByte(final Number value) { + this(value.byteValue()); + } + + /** + * 构造 + * @param value String值 + * @throws NumberFormatException 转为Byte错误 + */ + public MutableByte(final String value) throws NumberFormatException { + this.value = Byte.parseByte(value); + } + + @Override + public Byte get() { + return this.value; + } + + /** + * 设置值 + * @param value 值 + */ + public void set(final byte value) { + this.value = value; + } + + @Override + public void set(final Number value) { + this.value = value.byteValue(); + } + + // ----------------------------------------------------------------------- + /** + * 值+1 + * @return this + */ + public MutableByte increment() { + value++; + return this; + } + + /** + * 值减一 + * @return this + */ + public MutableByte decrement() { + value--; + return this; + } + + // ----------------------------------------------------------------------- + /** + * 增加值 + * @param operand 被增加的值 + * @return this + */ + public MutableByte add(final byte operand) { + this.value += operand; + return this; + } + + /** + * 增加值 + * @param operand 被增加的值，非空 + * @return this + * @throws NullPointerException if the object is null + */ + public MutableByte add(final Number operand) { + this.value += operand.byteValue(); + return this; + } + + /** + * 减去值 + * + * @param operand 被减的值 + * @return this + */ + public MutableByte subtract(final byte operand) { + this.value -= operand; + return this; + } + + /** + * 减去值 + * + * @param operand 被减的值，非空 + * @return this + * @throws NullPointerException if the object is null + */ + public MutableByte subtract(final Number operand) { + this.value -= operand.byteValue(); + return this; + } + + // ----------------------------------------------------------------------- + @Override + public byte byteValue() { + return value; + } + + @Override + public int intValue() { + return value; + } + + @Override + public long longValue() { + return value; + } + + @Override + public float floatValue() { + return value; + } + + @Override + public double doubleValue() { + return value; + } + + // ----------------------------------------------------------------------- + /** + * 相等需同时满足如下条件： + *
    + *
  1. 非空
    2. + *
  2. 类型为 MutableByte
    3. + *
  3. 值相等
    4. + *
+ * + * @param obj 比对的对象 + * @return 相同返回true，否则 {@code false} + */ + @Override + public boolean equals(final Object obj) { + if (obj instanceof MutableByte) { + return value == ((MutableByte) obj).byteValue(); + } + return false; + } + + @Override + public int hashCode() { + return value; + } + + // ----------------------------------------------------------------------- + /** + * 比较 + * + * @param other 其它 MutableByte 对象 + * @return x==y返回0，x<y返回-1，x>y返回1 + */ + @Override + public int compareTo(final MutableByte other) { + return NumberUtil.compare(this.value, other.value); + } + + // ----------------------------------------------------------------------- + @Override + public String toString() { + return String.valueOf(value); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableDouble.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableDouble.java new file mode 100644 index 0000000..469ac23 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableDouble.java @@ -0,0 +1,192 @@ +package aiyh.utils.tool.cn.hutool.core.lang.mutable; + +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; + +/** + * 可变 {@code double} 类型 + * + * @see Double + * @since 3.0.1 + */ +public class MutableDouble extends Number implements Comparable, Mutable { + private static final long serialVersionUID = 1L; + + private double value; + + /** + * 构造，默认值0 + */ + public MutableDouble() { + } + + /** + * 构造 + * @param value 值 + */ + public MutableDouble(final double value) { + this.value = value; + } + + /** + * 构造 + * @param value 值 + */ + public MutableDouble(final Number value) { + this(value.doubleValue()); + } + + /** + * 构造 + * @param value String值 + * @throws NumberFormatException 数字转换错误 + */ + public MutableDouble(final String value) throws NumberFormatException { + this.value = Double.parseDouble(value); + } + + @Override + public Double get() { + return this.value; + } + + /** + * 设置值 + * @param value 值 + */ + public void set(final double value) { + this.value = value; + } + + @Override + public void set(final Number value) { + this.value = value.doubleValue(); + } + + // ----------------------------------------------------------------------- + /** + * 值+1 + * @return this + */ + public MutableDouble increment() { + value++; + return this; + } + + /** + * 值减一 + * @return this + */ + public MutableDouble decrement() { + value--; + return this; + } + + // ----------------------------------------------------------------------- + /** + * 增加值 + * @param operand 被增加的值 + * @return this + */ + public MutableDouble add(final double operand) { + this.value += operand; + return this; + } + + /** + * 增加值 + * @param operand 被增加的值，非空 + * @return this + */ + public MutableDouble add(final Number operand) { + this.value += operand.doubleValue(); + return this; + } + + /** + * 减去值 + * + * @param operand 被减的值 + * @return this + */ + public MutableDouble subtract(final double operand) { + this.value -= operand; + return this; + } + + /** + * 减去值 + * + * @param operand 被减的值，非空 + * @return this + */ + public MutableDouble subtract(final Number operand) { + this.value -= operand.doubleValue(); + return this; + } + + // ----------------------------------------------------------------------- + @Override + public int intValue() { + return (int) value; + } + + @Override + public long longValue() { + return (long) value; + } + + @Override + public float floatValue() { + return (float) value; + } + + @Override + public double doubleValue() { + return value; + } + + // ----------------------------------------------------------------------- + /** + * 相等需同时满足如下条件： + *
    + *
  1. 非空
    2. + *
  2. 类型为 {@code MutableDouble}
    3. + *
  3. 值相等
    4. + *
+ * + * @param obj 比对的对象 + * @return 相同返回true，否则 {@code false} + */ + @Override + public boolean equals(final Object obj) { + if (obj instanceof MutableDouble) { + return (Double.doubleToLongBits(((MutableDouble)obj).value) == Double.doubleToLongBits(value)); + } + return false; + } + + @Override + public int hashCode() { + final long bits = Double.doubleToLongBits(value); + return (int) (bits ^ bits >>> 32); + } + + // ----------------------------------------------------------------------- + /** + * 比较 + * + * @param other 其它 {@code MutableDouble} 对象 + * @return x==y返回0，x<y返回-1，x>y返回1 + */ + @Override + public int compareTo(final MutableDouble other) { + return NumberUtil.compare(this.value, other.value); + } + + // ----------------------------------------------------------------------- + @Override + public String toString() { + return String.valueOf(value); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableFloat.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableFloat.java new file mode 100644 index 0000000..d1b4b85 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableFloat.java @@ -0,0 +1,193 @@ +package aiyh.utils.tool.cn.hutool.core.lang.mutable; + +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; + +/** + * 可变 float 类型 + * + * @see Float + * @since 3.0.1 + */ +public class MutableFloat extends Number implements Comparable, Mutable { + private static final long serialVersionUID = 1L; + + private float value; + + /** + * 构造，默认值0 + */ + public MutableFloat() { + } + + /** + * 构造 + * @param value 值 + */ + public MutableFloat(final float value) { + this.value = value; + } + + /** + * 构造 + * @param value 值 + */ + public MutableFloat(final Number value) { + this(value.floatValue()); + } + + /** + * 构造 + * @param value String值 + * @throws NumberFormatException 数字转换错误 + */ + public MutableFloat(final String value) throws NumberFormatException { + this.value = Float.parseFloat(value); + } + + @Override + public Float get() { + return this.value; + } + + /** + * 设置值 + * @param value 值 + */ + public void set(final float value) { + this.value = value; + } + + @Override + public void set(final Number value) { + this.value = value.floatValue(); + } + + // ----------------------------------------------------------------------- + /** + * 值+1 + * @return this + */ + public MutableFloat increment() { + value++; + return this; + } + + /** + * 值减一 + * @return this + */ + public MutableFloat decrement() { + value--; + return this; + } + + // ----------------------------------------------------------------------- + /** + * 增加值 + * @param operand 被增加的值 + * @return this + */ + public MutableFloat add(final float operand) { + this.value += operand; + return this; + } + + /** + * 增加值 + * @param operand 被增加的值，非空 + * @return this + * @throws NullPointerException if the object is null + */ + public MutableFloat add(final Number operand) { + this.value += operand.floatValue(); + return this; + } + + /** + * 减去值 + * + * @param operand 被减的值 + * @return this + */ + public MutableFloat subtract(final float operand) { + this.value -= operand; + return this; + } + + /** + * 减去值 + * + * @param operand 被减的值，非空 + * @return this + * @throws NullPointerException if the object is null + */ + public MutableFloat subtract(final Number operand) { + this.value -= operand.floatValue(); + return this; + } + + // ----------------------------------------------------------------------- + @Override + public int intValue() { + return (int) value; + } + + @Override + public long longValue() { + return (long) value; + } + + @Override + public float floatValue() { + return value; + } + + @Override + public double doubleValue() { + return value; + } + + // ----------------------------------------------------------------------- + /** + * 相等需同时满足如下条件： + *
    + *
  1. 非空
    2. + *
  2. 类型为 {@link MutableFloat}
    3. + *
  3. 值相等
    4. + *
+ * + * @param obj 比对的对象 + * @return 相同返回true，否则 false + */ + @Override + public boolean equals(final Object obj) { + if (obj instanceof MutableFloat) { + return (Float.floatToIntBits(((MutableFloat)obj).value) == Float.floatToIntBits(value)); + } + return false; + } + + @Override + public int hashCode() { + return Float.floatToIntBits(value); + } + + // ----------------------------------------------------------------------- + /** + * 比较 + * + * @param other 其它 {@link MutableFloat} 对象 + * @return x==y返回0，x<y返回-1，x>y返回1 + */ + @Override + public int compareTo(final MutableFloat other) { + return NumberUtil.compare(this.value, other.value); + } + + // ----------------------------------------------------------------------- + @Override + public String toString() { + return String.valueOf(value); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableInt.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableInt.java new file mode 100644 index 0000000..0f6595b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableInt.java @@ -0,0 +1,193 @@ +package aiyh.utils.tool.cn.hutool.core.lang.mutable; + +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; + +/** + * 可变 int 类型 + * + * @see Integer + * @since 3.0.1 + */ +public class MutableInt extends Number implements Comparable, Mutable { + private static final long serialVersionUID = 1L; + + private int value; + + /** + * 构造，默认值0 + */ + public MutableInt() { + } + + /** + * 构造 + * @param value 值 + */ + public MutableInt(final int value) { + this.value = value; + } + + /** + * 构造 + * @param value 值 + */ + public MutableInt(final Number value) { + this(value.intValue()); + } + + /** + * 构造 + * @param value String值 + * @throws NumberFormatException 数字转换错误 + */ + public MutableInt(final String value) throws NumberFormatException { + this.value = Integer.parseInt(value); + } + + @Override + public Integer get() { + return this.value; + } + + /** + * 设置值 + * @param value 值 + */ + public void set(final int value) { + this.value = value; + } + + @Override + public void set(final Number value) { + this.value = value.intValue(); + } + + // ----------------------------------------------------------------------- + /** + * 值+1 + * @return this + */ + public MutableInt increment() { + value++; + return this; + } + + /** + * 值减一 + * @return this + */ + public MutableInt decrement() { + value--; + return this; + } + + // ----------------------------------------------------------------------- + /** + * 增加值 + * @param operand 被增加的值 + * @return this + */ + public MutableInt add(final int operand) { + this.value += operand; + return this; + } + + /** + * 增加值 + * @param operand 被增加的值，非空 + * @return this + * @throws NullPointerException if the object is null + */ + public MutableInt add(final Number operand) { + this.value += operand.intValue(); + return this; + } + + /** + * 减去值 + * + * @param operand 被减的值 + * @return this + */ + public MutableInt subtract(final int operand) { + this.value -= operand; + return this; + } + + /** + * 减去值 + * + * @param operand 被减的值，非空 + * @return this + * @throws NullPointerException if the object is null + */ + public MutableInt subtract(final Number operand) { + this.value -= operand.intValue(); + return this; + } + + // ----------------------------------------------------------------------- + @Override + public int intValue() { + return value; + } + + @Override + public long longValue() { + return value; + } + + @Override + public float floatValue() { + return value; + } + + @Override + public double doubleValue() { + return value; + } + + // ----------------------------------------------------------------------- + /** + * 相等需同时满足如下条件： + *
    + *
  1. 非空
    2. + *
  2. 类型为 MutableInt
    3. + *
  3. 值相等
    4. + *
+ * + * @param obj 比对的对象 + * @return 相同返回true，否则 {@code false} + */ + @Override + public boolean equals(final Object obj) { + if (obj instanceof MutableInt) { + return value == ((MutableInt) obj).intValue(); + } + return false; + } + + @Override + public int hashCode() { + return this.value; + } + + // ----------------------------------------------------------------------- + /** + * 比较 + * + * @param other 其它 MutableInt 对象 + * @return x==y返回0，x<y返回-1，x>y返回1 + */ + @Override + public int compareTo(final MutableInt other) { + return NumberUtil.compare(this.value, other.value); + } + + // ----------------------------------------------------------------------- + @Override + public String toString() { + return String.valueOf(value); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableLong.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableLong.java new file mode 100644 index 0000000..67e5f11 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableLong.java @@ -0,0 +1,205 @@ +package aiyh.utils.tool.cn.hutool.core.lang.mutable; + +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; + +/** + * 可变 {@code long} 类型 + * + * @see Long + * @since 3.0.1 + */ +public class MutableLong extends Number implements Comparable, Mutable { + private static final long serialVersionUID = 1L; + + private long value; + + /** + * 构造，默认值0 + */ + public MutableLong() { + } + + /** + * 构造 + * + * @param value 值 + */ + public MutableLong(final long value) { + this.value = value; + } + + /** + * 构造 + * + * @param value 值 + */ + public MutableLong(final Number value) { + this(value.longValue()); + } + + /** + * 构造 + * + * @param value String值 + * @throws NumberFormatException 数字转换错误 + */ + public MutableLong(final String value) throws NumberFormatException { + this.value = Long.parseLong(value); + } + + @Override + public Long get() { + return this.value; + } + + /** + * 设置值 + * + * @param value 值 + */ + public void set(final long value) { + this.value = value; + } + + @Override + public void set(final Number value) { + this.value = value.longValue(); + } + + // ----------------------------------------------------------------------- + + /** + * 值+1 + * + * @return this + */ + public MutableLong increment() { + value++; + return this; + } + + /** + * 值减一 + * + * @return this + */ + public MutableLong decrement() { + value--; + return this; + } + + // ----------------------------------------------------------------------- + + /** + * 增加值 + * + * @param operand 被增加的值 + * @return this + */ + public MutableLong add(final long operand) { + this.value += operand; + return this; + } + + /** + * 增加值 + * + * @param operand 被增加的值，非空 + * @return this + * @throws NullPointerException if the object is null + */ + public MutableLong add(final Number operand) { + this.value += operand.longValue(); + return this; + } + + /** + * 减去值 + * + * @param operand 被减的值 + * @return this + */ + public MutableLong subtract(final long operand) { + this.value -= operand; + return this; + } + + /** + * 减去值 + * + * @param operand 被减的值，非空 + * @return this + * @throws NullPointerException if the object is null + */ + public MutableLong subtract(final Number operand) { + this.value -= operand.longValue(); + return this; + } + + // ----------------------------------------------------------------------- + @Override + public int intValue() { + return (int) value; + } + + @Override + public long longValue() { + return value; + } + + @Override + public float floatValue() { + return value; + } + + @Override + public double doubleValue() { + return value; + } + + // ----------------------------------------------------------------------- + + /** + * 相等需同时满足如下条件： + *
    + *
  1. 非空
    2. + *
  2. 类型为 MutableLong
    3. + *
  3. 值相等
    4. + *
+ * + * @param obj 比对的对象 + * @return 相同返回true，否则 {@code false} + */ + @Override + public boolean equals(final Object obj) { + if (obj instanceof MutableLong) { + return value == ((MutableLong) obj).longValue(); + } + return false; + } + + @Override + public int hashCode() { + return (int) (value ^ (value >>> 32)); + } + + // ----------------------------------------------------------------------- + + /** + * 比较 + * + * @param other 其它 MutableLong 对象 + * @return x==y返回0，x<y返回-1，x>y返回1 + */ + @Override + public int compareTo(final MutableLong other) { + return NumberUtil.compare(this.value, other.value); + } + + // ----------------------------------------------------------------------- + @Override + public String toString() { + return String.valueOf(value); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableObj.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableObj.java new file mode 100644 index 0000000..45cd68a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableObj.java @@ -0,0 +1,80 @@ +package aiyh.utils.tool.cn.hutool.core.lang.mutable; + +import java.io.Serializable; + +/** + * 可变{@code Object} + * + * @param 可变的类型 + * @since 3.0.1 + */ +public class MutableObj implements Mutable, Serializable { + private static final long serialVersionUID = 1L; + + /** + * 构建MutableObj + * @param value 被包装的值 + * @param 值类型 + * @return MutableObj + * @since 5.8.0 + */ + public static MutableObj of(T value){ + return new MutableObj<>(value); + } + + private T value; + + /** + * 构造，空值 + */ + public MutableObj() { + } + + /** + * 构造 + * + * @param value 值 + */ + public MutableObj(final T value) { + this.value = value; + } + + // ----------------------------------------------------------------------- + @Override + public T get() { + return this.value; + } + + @Override + public void set(final T value) { + this.value = value; + } + + // ----------------------------------------------------------------------- + @Override + public boolean equals(final Object obj) { + if (obj == null) { + return false; + } + if (this == obj) { + return true; + } + if (this.getClass() == obj.getClass()) { + final MutableObj that = (MutableObj) obj; + return this.value.equals(that.value); + } + return false; + } + + @Override + public int hashCode() { + return value == null ? 0 : value.hashCode(); + } + + // ----------------------------------------------------------------------- + @Override + public String toString() { + return value == null ? "null" : value.toString(); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutablePair.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutablePair.java new file mode 100644 index 0000000..db95802 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutablePair.java @@ -0,0 +1,57 @@ +package aiyh.utils.tool.cn.hutool.core.lang.mutable; + +import aiyh.utils.tool.cn.hutool.core.lang.Pair; + +/** + * 可变{@link Pair}实现，可以修改键和值 + * + * @param 键类型 + * @param 值类型 + * @since 5.7.16 + */ +public class MutablePair extends Pair implements Mutable>{ + private static final long serialVersionUID = 1L; + + /** + * 构造 + * + * @param key 键 + * @param value 值 + */ + public MutablePair(K key, V value) { + super(key, value); + } + + /** + * 设置键 + * + * @param key 新键 + * @return this + */ + public MutablePair setKey(K key) { + this.key = key; + return this; + } + + /** + * 设置值 + * + * @param value 新值 + * @return this + */ + public MutablePair setValue(V value) { + this.value = value; + return this; + } + + @Override + public Pair get() { + return this; + } + + @Override + public void set(Pair pair) { + this.key = pair.getKey(); + this.value = pair.getValue(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableShort.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableShort.java new file mode 100644 index 0000000..c0bda37 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/MutableShort.java @@ -0,0 +1,198 @@ +package aiyh.utils.tool.cn.hutool.core.lang.mutable; + +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; + +/** + * 可变 short 类型 + * + * @see Short + * @since 3.0.1 + */ +public class MutableShort extends Number implements Comparable, Mutable { + private static final long serialVersionUID = 1L; + + private short value; + + /** + * 构造，默认值0 + */ + public MutableShort() { + } + + /** + * 构造 + * @param value 值 + */ + public MutableShort(final short value) { + this.value = value; + } + + /** + * 构造 + * @param value 值 + */ + public MutableShort(final Number value) { + this(value.shortValue()); + } + + /** + * 构造 + * @param value String值 + * @throws NumberFormatException 转为Short错误 + */ + public MutableShort(final String value) throws NumberFormatException { + this.value = Short.parseShort(value); + } + + @Override + public Short get() { + return this.value; + } + + /** + * 设置值 + * @param value 值 + */ + public void set(final short value) { + this.value = value; + } + + @Override + public void set(final Number value) { + this.value = value.shortValue(); + } + + // ----------------------------------------------------------------------- + /** + * 值+1 + * @return this + */ + public MutableShort increment() { + value++; + return this; + } + + /** + * 值减一 + * @return this + */ + public MutableShort decrement() { + value--; + return this; + } + + // ----------------------------------------------------------------------- + /** + * 增加值 + * @param operand 被增加的值 + * @return this + */ + public MutableShort add(final short operand) { + this.value += operand; + return this; + } + + /** + * 增加值 + * @param operand 被增加的值，非空 + * @return this + * @throws NullPointerException if the object is null + */ + public MutableShort add(final Number operand) { + this.value += operand.shortValue(); + return this; + } + + /** + * 减去值 + * + * @param operand 被减的值 + * @return this + */ + public MutableShort subtract(final short operand) { + this.value -= operand; + return this; + } + + /** + * 减去值 + * + * @param operand 被减的值，非空 + * @return this + * @throws NullPointerException if the object is null + */ + public MutableShort subtract(final Number operand) { + this.value -= operand.shortValue(); + return this; + } + + // ----------------------------------------------------------------------- + @Override + public short shortValue() { + return value; + } + + @Override + public int intValue() { + return value; + } + + @Override + public long longValue() { + return value; + } + + @Override + public float floatValue() { + return value; + } + + @Override + public double doubleValue() { + return value; + } + + // ----------------------------------------------------------------------- + /** + * 相等需同时满足如下条件： + *
    + *
  1. 非空
    2. + *
  2. 类型为 {@link MutableShort}
    3. + *
  3. 值相等
    4. + *
+ * + * @param obj 比对的对象 + * @return 相同返回true，否则 false + */ + @Override + public boolean equals(final Object obj) { + if (obj instanceof MutableShort) { + return value == ((MutableShort) obj).shortValue(); + } + return false; + } + + @Override + public int hashCode() { + return value; + } + + // ----------------------------------------------------------------------- + /** + * 比较 + * + * @param other 其它 {@link MutableShort} 对象 + * @return x==y返回0，x<y返回-1，x>y返回1 + */ + @Override + public int compareTo(final MutableShort other) { + return NumberUtil.compare(this.value, other.value); + } + + // ----------------------------------------------------------------------- + @Override + public String toString() { + return String.valueOf(value); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/package-info.java new file mode 100755 index 0000000..c899c5e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/mutable/package-info.java @@ -0,0 +1,7 @@ +/** + * 提供可变值对象的封装，用于封装int、long等不可变值，使其可变 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.lang.mutable; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/package-info.java new file mode 100755 index 0000000..5553f04 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/package-info.java @@ -0,0 +1,7 @@ +/** + * 语言特性包，包括大量便捷的数据结构，例如验证器Validator，分布式ID生成器Snowflake等 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.lang; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/reflect/ActualTypeMapperPool.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/reflect/ActualTypeMapperPool.java new file mode 100755 index 0000000..01524ba --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/reflect/ActualTypeMapperPool.java @@ -0,0 +1,118 @@ +package aiyh.utils.tool.cn.hutool.core.lang.reflect; + +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.map.WeakConcurrentMap; +import aiyh.utils.tool.cn.hutool.core.util.TypeUtil; + +import java.lang.reflect.ParameterizedType; +import java.lang.reflect.Type; +import java.lang.reflect.TypeVariable; +import java.util.HashMap; +import java.util.Map; + +/** + * 泛型变量和泛型实际类型映射关系缓存 + * + * @author looly + * @since 5.4.2 + */ +public class ActualTypeMapperPool { + + private static final WeakConcurrentMap> CACHE = new WeakConcurrentMap<>(); + + /** + * 获取泛型变量和泛型实际类型的对应关系Map + * + * @param type 被解析的包含泛型参数的类 + * @return 泛型对应关系Map + */ + public static Map get(Type type) { + return CACHE.computeIfAbsent(type, (key) -> createTypeMap(type)); + } + + /** + * 获取泛型变量名（字符串）和泛型实际类型的对应关系Map + * + * @param type 被解析的包含泛型参数的类 + * @return 泛型对应关系Map + * @since 5.7.16 + */ + public static Map getStrKeyMap(Type type){ + return Convert.toMap(String.class, Type.class, get(type)); + } + + /** + * 获得泛型变量对应的泛型实际类型，如果此变量没有对应的实际类型，返回null + * + * @param type 类 + * @param typeVariable 泛型变量，例如T等 + * @return 实际类型，可能为Class等 + */ + public static Type getActualType(Type type, TypeVariable typeVariable) { + final Map typeTypeMap = get(type); + Type result = typeTypeMap.get(typeVariable); + while (result instanceof TypeVariable) { + result = typeTypeMap.get(result); + } + return result; + } + + /** + * 获取指定泛型变量对应的真实类型
+ * 由于子类中泛型参数实现和父类（接口）中泛型定义位置是一一对应的，因此可以通过对应关系找到泛型实现类型
+ * + * @param type 真实类型所在类，此类中记录了泛型参数对应的实际类型 + * @param typeVariables 泛型变量，需要的实际类型对应的泛型参数 + * @return 给定泛型参数对应的实际类型，如果无对应类型，对应位置返回null + */ + public static Type[] getActualTypes(Type type, Type... typeVariables) { + // 查找方法定义所在类或接口中此泛型参数的位置 + final Type[] result = new Type[typeVariables.length]; + for (int i = 0; i < typeVariables.length; i++) { + result[i] = (typeVariables[i] instanceof TypeVariable) + ? getActualType(type, (TypeVariable) typeVariables[i]) + : typeVariables[i]; + } + return result; + } + + /** + * 创建类中所有的泛型变量和泛型实际类型的对应关系Map + * + * @param type 被解析的包含泛型参数的类 + * @return 泛型对应关系Map + */ + private static Map createTypeMap(Type type) { + final Map typeMap = new HashMap<>(); + + // 按继承层级寻找泛型变量和实际类型的对应关系 + // 在类中，对应关系分为两类： + // 1. 父类定义变量，子类标注实际类型 + // 2. 父类定义变量，子类继承这个变量，让子类的子类去标注，以此类推 + // 此方法中我们将每一层级的对应关系全部加入到Map中，查找实际类型的时候，根据传入的泛型变量， + // 找到对应关系，如果对应的是继承的泛型变量，则递归继续找，直到找到实际或返回null为止。 + // 如果传入的非Class，例如TypeReference，获取到泛型参数中实际的泛型对象类，继续按照类处理 + while (null != type) { + final ParameterizedType parameterizedType = TypeUtil.toParameterizedType(type); + if(null == parameterizedType){ + break; + } + final Type[] typeArguments = parameterizedType.getActualTypeArguments(); + final Class rawType = (Class) parameterizedType.getRawType(); + final Type[] typeParameters = rawType.getTypeParameters(); + + Type value; + for (int i = 0; i < typeParameters.length; i++) { + value = typeArguments[i]; + // 跳过泛型变量对应泛型变量的情况 + if(false == value instanceof TypeVariable){ + typeMap.put(typeParameters[i], value); + } + } + + type = rawType; + } + + return typeMap; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/reflect/LookupFactory.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/reflect/LookupFactory.java new file mode 100755 index 0000000..e8b9700 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/reflect/LookupFactory.java @@ -0,0 +1,76 @@ +package aiyh.utils.tool.cn.hutool.core.lang.reflect; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; + +import java.lang.invoke.MethodHandles; +import java.lang.reflect.Constructor; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; + +/** + * {@link MethodHandles.Lookup}工厂，用于创建{@link MethodHandles.Lookup}对象
+ * jdk8中如果直接调用{@link MethodHandles#lookup()}获取到的{@link MethodHandles.Lookup}在调用findSpecial和unreflectSpecial + * 时会出现权限不够问题，抛出"no private access for invokespecial"异常，因此针对JDK8及JDK9+分别封装lookup方法。 + * + * 参考： + *

https://blog.csdn.net/u013202238/article/details/108687086

+ * + * @author looly + * @since 5.7.7 + */ +public class LookupFactory { + + private static final int ALLOWED_MODES = MethodHandles.Lookup.PRIVATE | MethodHandles.Lookup.PROTECTED + | MethodHandles.Lookup.PACKAGE | MethodHandles.Lookup.PUBLIC; + + private static Constructor java8LookupConstructor; + private static Method privateLookupInMethod; + + static { + //先查询jdk9 开始提供的java.lang.invoke.MethodHandles.privateLookupIn方法, + //如果没有说明是jdk8的版本.(不考虑jdk8以下版本) + try { + //noinspection JavaReflectionMemberAccess + privateLookupInMethod = MethodHandles.class.getMethod("privateLookupIn", Class.class, MethodHandles.Lookup.class); + } catch (NoSuchMethodException ignore) { + //ignore + } + + //jdk8 + //这种方式其实也适用于jdk9及以上的版本,但是上面优先,可以避免 jdk9 反射警告 + if (privateLookupInMethod == null) { + try { + java8LookupConstructor = MethodHandles.Lookup.class.getDeclaredConstructor(Class.class, int.class); + java8LookupConstructor.setAccessible(true); + } catch (NoSuchMethodException e) { + //可能是jdk8 以下版本 + throw new IllegalStateException( + "There is neither 'privateLookupIn(Class, Lookup)' nor 'Lookup(Class, int)' method in java.lang.invoke.MethodHandles.", e); + } + } + } + + /** + * jdk8中如果直接调用{@link MethodHandles#lookup()}获取到的{@link MethodHandles.Lookup}在调用findSpecial和unreflectSpecial + * 时会出现权限不够问题，抛出"no private access for invokespecial"异常，因此针对JDK8及JDK9+分别封装lookup方法。 + * + * @param callerClass 被调用的类或接口 + * @return {@link MethodHandles.Lookup} + */ + public static MethodHandles.Lookup lookup(Class callerClass) { + //使用反射,因为当前jdk可能不是java9或以上版本 + if (privateLookupInMethod != null) { + try { + return (MethodHandles.Lookup) privateLookupInMethod.invoke(MethodHandles.class, callerClass, MethodHandles.lookup()); + } catch (IllegalAccessException | InvocationTargetException e) { + throw new UtilException(e); + } + } + //jdk 8 + try { + return java8LookupConstructor.newInstance(callerClass, ALLOWED_MODES); + } catch (Exception e) { + throw new IllegalStateException("no 'Lookup(Class, int)' method in java.lang.invoke.MethodHandles.", e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/reflect/MethodHandleUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/reflect/MethodHandleUtil.java new file mode 100755 index 0000000..d23d7ff --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/reflect/MethodHandleUtil.java @@ -0,0 +1,227 @@ +package aiyh.utils.tool.cn.hutool.core.lang.reflect; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.lang.invoke.MethodHandle; +import java.lang.invoke.MethodHandles; +import java.lang.invoke.MethodType; +import java.lang.reflect.Method; + +/** + * 方法句柄{@link MethodHandle}封装工具类
+ * 方法句柄是一个有类型的，可以直接执行的指向底层方法、构造器、field等的引用，可以简单理解为函数指针，它是一种更加底层的查找、调整和调用方法的机制。 + * 参考： + *
    + *
  • https://stackoverflow.com/questions/22614746/how-do-i-invoke-java-8-default-methods-reflectively
    • + *
+ * + * @author looly + * @since 5.7.7 + */ +public class MethodHandleUtil { + + /** + * jdk8中如果直接调用{@link MethodHandles#lookup()}获取到的{@link MethodHandles.Lookup}在调用findSpecial和unreflectSpecial + * 时会出现权限不够问题，抛出"no private access for invokespecial"异常，因此针对JDK8及JDK9+分别封装lookup方法。 + * + * @param callerClass 被调用的类或接口 + * @return {@link MethodHandles.Lookup} + */ + public static MethodHandles.Lookup lookup(Class callerClass) { + return LookupFactory.lookup(callerClass); + } + + /** + * 查找指定方法的方法句柄
+ * 此方法只会查找： + *
    + *
  • 当前类的方法（包括构造方法和private方法）
    • + *
  • 父类的方法（包括构造方法和private方法）
    • + *
  • 当前类的static方法
    • + *
+ * + * @param callerClass 方法所在类或接口 + * @param name 方法名称，{@code null}或者空则查找构造方法 + * @param type 返回类型和参数类型 + * @return 方法句柄 {@link MethodHandle}，{@code null}表示未找到方法 + */ + public static MethodHandle findMethod(Class callerClass, String name, MethodType type) { + if (StrUtil.isBlank(name)) { + return findConstructor(callerClass, type); + } + + MethodHandle handle = null; + final MethodHandles.Lookup lookup = lookup(callerClass); + try { + handle = lookup.findVirtual(callerClass, name, type); + } catch (IllegalAccessException | NoSuchMethodException ignore) { + //ignore + } + + // static方法 + if (null == handle) { + try { + handle = lookup.findStatic(callerClass, name, type); + } catch (IllegalAccessException | NoSuchMethodException ignore) { + //ignore + } + } + + // 特殊方法，包括构造方法、私有方法等 + if (null == handle) { + try { + handle = lookup.findSpecial(callerClass, name, type, callerClass); + } catch (NoSuchMethodException ignore) { + //ignore + } catch (IllegalAccessException e) { + throw new UtilException(e); + } + } + + return handle; + } + + /** + * 查找指定的构造方法 + * + * @param callerClass 类 + * @param args 参数 + * @return 构造方法句柄 + */ + public static MethodHandle findConstructor(Class callerClass, Class... args) { + return findConstructor(callerClass, MethodType.methodType(void.class, args)); + } + + /** + * 查找指定的构造方法 + * + * @param callerClass 类 + * @param type 参数类型，此处返回类型应为void.class + * @return 构造方法句柄 + */ + public static MethodHandle findConstructor(Class callerClass, MethodType type) { + final MethodHandles.Lookup lookup = lookup(callerClass); + try { + return lookup.findConstructor(callerClass, type); + } catch (NoSuchMethodException e) { + return null; + } catch (IllegalAccessException e) { + throw new UtilException(e); + } + } + + /** + * 执行接口或对象中的特殊方法（private、static等）
+ * + * 
+	 *     interface Duck {
+	 *         default String quack() {
+	 *             return "Quack";
+	 *         }
+	 *     }
+	 *
+	 *     Duck duck = (Duck) Proxy.newProxyInstance(
+	 *         ClassLoaderUtil.getClassLoader(),
+	 *         new Class[] { Duck.class },
+	 *         MethodHandleUtil::invokeDefault);
+	 *
+ * + * @param 返回结果类型 + * @param obj 接口的子对象或代理对象 + * @param methodName 方法名称 + * @param args 参数 + * @return 结果 + */ + public static T invokeSpecial(Object obj, String methodName, Object... args) { + Assert.notNull(obj, "Object to get method must be not null!"); + Assert.notBlank(methodName, "Method name must be not blank!"); + + final Method method = ReflectUtil.getMethodOfObj(obj, methodName, args); + if (null == method) { + throw new UtilException("No such method: [{}] from [{}]", methodName, obj.getClass()); + } + return invokeSpecial(obj, method, args); + } + + /** + * 执行接口或对象中的方法 + * + * @param 返回结果类型 + * @param obj 接口的子对象或代理对象 + * @param method 方法 + * @param args 参数 + * @return 结果 + */ + public static T invoke(Object obj, Method method, Object... args) { + return invoke(false, obj, method, args); + } + + /** + * 执行接口或对象中的特殊方法（private、static等）
+ * + * 
+	 *     interface Duck {
+	 *         default String quack() {
+	 *             return "Quack";
+	 *         }
+	 *     }
+	 *
+	 *     Duck duck = (Duck) Proxy.newProxyInstance(
+	 *         ClassLoaderUtil.getClassLoader(),
+	 *         new Class[] { Duck.class },
+	 *         MethodHandleUtil::invoke);
+	 *
+ * + * @param 返回结果类型 + * @param obj 接口的子对象或代理对象 + * @param method 方法 + * @param args 参数 + * @return 结果 + */ + public static T invokeSpecial(Object obj, Method method, Object... args) { + return invoke(true, obj, method, args); + } + + /** + * 执行接口或对象中的方法
+ * + * 
+	 *     interface Duck {
+	 *         default String quack() {
+	 *             return "Quack";
+	 *         }
+	 *     }
+	 *
+	 *     Duck duck = (Duck) Proxy.newProxyInstance(
+	 *         ClassLoaderUtil.getClassLoader(),
+	 *         new Class[] { Duck.class },
+	 *         MethodHandleUtil::invoke);
+	 *
+ * + * @param 返回结果类型 + * @param isSpecial 是否为特殊方法（private、static等） + * @param obj 接口的子对象或代理对象 + * @param method 方法 + * @param args 参数 + * @return 结果 + */ + @SuppressWarnings("unchecked") + public static T invoke(boolean isSpecial, Object obj, Method method, Object... args) { + Assert.notNull(method, "Method must be not null!"); + final Class declaringClass = method.getDeclaringClass(); + final MethodHandles.Lookup lookup = lookup(declaringClass); + try { + MethodHandle handle = isSpecial ? lookup.unreflectSpecial(method, declaringClass) + : lookup.unreflect(method); + if (null != obj) { + handle = handle.bindTo(obj); + } + return (T) handle.invokeWithArguments(args); + } catch (Throwable e) { + throw new UtilException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/reflect/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/reflect/package-info.java new file mode 100755 index 0000000..bd8de25 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/reflect/package-info.java @@ -0,0 +1,7 @@ +/** + * 提供反射相关功能对象和类 + * + * @author looly + * @since 5.4.2 + */ +package aiyh.utils.tool.cn.hutool.core.lang.reflect; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/Node.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/Node.java new file mode 100755 index 0000000..1adb9ee --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/Node.java @@ -0,0 +1,86 @@ +package aiyh.utils.tool.cn.hutool.core.lang.tree; + +import aiyh.utils.tool.cn.hutool.core.comparator.CompareUtil; + +import java.io.Serializable; + +/** + * 节点接口，提供节点相关的的方法定义 + * + * @param ID类型 + * @author looly + * @since 5.2.4 + */ +public interface Node extends Comparable>, Serializable { + + /** + * 获取ID + * + * @return ID + */ + T getId(); + + /** + * 设置ID + * + * @param id ID + * @return this + */ + Node setId(T id); + + /** + * 获取父节点ID + * + * @return 父节点ID + */ + T getParentId(); + + /** + * 设置父节点ID + * + * @param parentId 父节点ID + * @return this + */ + Node setParentId(T parentId); + + /** + * 获取节点标签名称 + * + * @return 节点标签名称 + */ + CharSequence getName(); + + /** + * 设置节点标签名称 + * + * @param name 节点标签名称 + * @return this + */ + Node setName(CharSequence name); + + /** + * 获取权重 + * + * @return 权重 + */ + Comparable getWeight(); + + /** + * 设置权重 + * + * @param weight 权重 + * @return this + */ + Node setWeight(Comparable weight); + + @SuppressWarnings({"unchecked", "rawtypes", "NullableProblems"}) + @Override + default int compareTo(Node node) { + if(null == node){ + return 1; + } + final Comparable weight = this.getWeight(); + final Comparable weightOther = node.getWeight(); + return CompareUtil.compare(weight, weightOther); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/Tree.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/Tree.java new file mode 100755 index 0000000..022babf --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/Tree.java @@ -0,0 +1,355 @@ +package aiyh.utils.tool.cn.hutool.core.lang.tree; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Filter; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.PrintWriter; +import java.io.StringWriter; +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.function.Consumer; + +/** + * 通过转换器将你的实体转化为TreeNodeMap节点实体 属性都存在此处,属性有序，可支持排序 + * + * @param ID类型 + * @author liangbaikai + * @since 5.2.1 + */ +public class Tree extends LinkedHashMap implements Node { + private static final long serialVersionUID = 1L; + + private final TreeNodeConfig treeNodeConfig; + private Tree parent; + + public Tree() { + this(null); + } + + /** + * 构造 + * + * @param treeNodeConfig TreeNode配置 + */ + public Tree(TreeNodeConfig treeNodeConfig) { + this.treeNodeConfig = ObjectUtil.defaultIfNull( + treeNodeConfig, TreeNodeConfig.DEFAULT_CONFIG); + } + + /** + * 获取节点配置 + * + * @return 节点配置 + * @since 5.7.2 + */ + public TreeNodeConfig getConfig() { + return this.treeNodeConfig; + } + + /** + * 获取父节点 + * + * @return 父节点 + * @since 5.2.4 + */ + public Tree getParent() { + return parent; + } + + /** + * 获取ID对应的节点，如果有多个ID相同的节点，只返回第一个。
+ * 此方法只查找此节点及子节点，采用广度优先遍历。 + * + * @param id ID + * @return 节点 + * @since 5.2.4 + */ + public Tree getNode(T id) { + return TreeUtil.getNode(this, id); + } + + /** + * 获取所有父节点名称列表 + * + *

+ * 比如有个人在研发1部，他上面有研发部，接着上面有技术中心
+ * 返回结果就是：[研发一部, 研发中心, 技术中心] + * + * @param id 节点ID + * @param includeCurrentNode 是否包含当前节点的名称 + * @return 所有父节点名称列表 + * @since 5.2.4 + */ + public List getParentsName(T id, boolean includeCurrentNode) { + return TreeUtil.getParentsName(getNode(id), includeCurrentNode); + } + + /** + * 获取所有父节点名称列表 + * + *

+ * 比如有个人在研发1部，他上面有研发部，接着上面有技术中心
+ * 返回结果就是：[研发一部, 研发中心, 技术中心] + * + * @param includeCurrentNode 是否包含当前节点的名称 + * @return 所有父节点名称列表 + * @since 5.2.4 + */ + public List getParentsName(boolean includeCurrentNode) { + return TreeUtil.getParentsName(this, includeCurrentNode); + } + + /** + * 设置父节点 + * + * @param parent 父节点 + * @return this + * @since 5.2.4 + */ + public Tree setParent(Tree parent) { + this.parent = parent; + if (null != parent) { + this.setParentId(parent.getId()); + } + return this; + } + + @Override + @SuppressWarnings("unchecked") + public T getId() { + return (T) this.get(treeNodeConfig.getIdKey()); + } + + @Override + public Tree setId(T id) { + this.put(treeNodeConfig.getIdKey(), id); + return this; + } + + @Override + @SuppressWarnings("unchecked") + public T getParentId() { + return (T) this.get(treeNodeConfig.getParentIdKey()); + } + + @Override + public Tree setParentId(T parentId) { + this.put(treeNodeConfig.getParentIdKey(), parentId); + return this; + } + + @Override + public CharSequence getName() { + return (CharSequence) this.get(treeNodeConfig.getNameKey()); + } + + @Override + public Tree setName(CharSequence name) { + this.put(treeNodeConfig.getNameKey(), name); + return this; + } + + @Override + public Comparable getWeight() { + return (Comparable) this.get(treeNodeConfig.getWeightKey()); + } + + @Override + public Tree setWeight(Comparable weight) { + this.put(treeNodeConfig.getWeightKey(), weight); + return this; + } + + /** + * 获取所有子节点 + * + * @return 所有子节点 + */ + @SuppressWarnings("unchecked") + public List> getChildren() { + return (List>) this.get(treeNodeConfig.getChildrenKey()); + } + + /** + * 是否有子节点，无子节点则此为叶子节点 + * + * @return 是否有子节点 + * @since 5.7.17 + */ + public boolean hasChild() { + return CollUtil.isNotEmpty(getChildren()); + } + + /** + * 递归树并处理子树下的节点： + * + * @param consumer 节点处理器 + * @since 5.7.16 + */ + public void walk(Consumer> consumer) { + consumer.accept(this); + final List> children = getChildren(); + if (CollUtil.isNotEmpty(children)) { + children.forEach((tree) -> tree.walk(consumer)); + } + } + + /** + * 递归过滤并生成新的树
+ * 通过{@link Filter}指定的过滤规则，本节点或子节点满足过滤条件，则保留当前节点，否则抛弃节点及其子节点 + * + * @param filter 节点过滤规则函数，只需处理本级节点本身即可 + * @return 过滤后的节点，{@code null} 表示不满足过滤要求，丢弃之 + * @see #filter(Filter) + * @since 5.7.17 + */ + public Tree filterNew(Filter> filter) { + return cloneTree().filter(filter); + } + + /** + * 递归过滤当前树，注意此方法会修改当前树
+ * 通过{@link Filter}指定的过滤规则，本节点或子节点满足过滤条件，则保留当前节点及其所有子节点，否则抛弃节点及其子节点 + * + * @param filter 节点过滤规则函数，只需处理本级节点本身即可 + * @return 过滤后的节点，{@code null} 表示不满足过滤要求，丢弃之 + * @see #filterNew(Filter) + * @since 5.7.17 + */ + public Tree filter(Filter> filter) { + if(filter.accept(this)){ + // 本节点满足，则包括所有子节点都保留 + return this; + } + + final List> children = getChildren(); + if (CollUtil.isNotEmpty(children)) { + // 递归过滤子节点 + final List> filteredChildren = new ArrayList<>(children.size()); + Tree filteredChild; + for (Tree child : children) { + filteredChild = child.filter(filter); + if (null != filteredChild) { + filteredChildren.add(filteredChild); + } + } + if(CollUtil.isNotEmpty(filteredChildren)){ + // 子节点有符合过滤条件的节点，则本节点保留 + return this.setChildren(filteredChildren); + } else { + this.setChildren(null); + } + } + + // 子节点都不符合过滤条件，检查本节点 + return null; + } + + /** + * 设置子节点，设置后会覆盖所有原有子节点 + * + * @param children 子节点列表，如果为{@code null}表示移除子节点 + * @return this + */ + public Tree setChildren(List> children) { + if(null == children){ + this.remove(treeNodeConfig.getChildrenKey()); + } + this.put(treeNodeConfig.getChildrenKey(), children); + return this; + } + + /** + * 增加子节点，同时关联子节点的父节点为当前节点 + * + * @param children 子节点列表 + * @return this + * @since 5.6.7 + */ + @SafeVarargs + public final Tree addChildren(Tree... children) { + if (ArrayUtil.isNotEmpty(children)) { + List> childrenList = this.getChildren(); + if (null == childrenList) { + childrenList = new ArrayList<>(); + setChildren(childrenList); + } + for (Tree child : children) { + child.setParent(this); + childrenList.add(child); + } + } + return this; + } + + /** + * 扩展属性 + * + * @param key 键 + * @param value 扩展值 + */ + public void putExtra(String key, Object value) { + Assert.notEmpty(key, "Key must be not empty !"); + this.put(key, value); + } + + @Override + public String toString() { + final StringWriter stringWriter = new StringWriter(); + printTree(this, new PrintWriter(stringWriter), 0); + return stringWriter.toString(); + } + + /** + * 递归克隆当前节点（即克隆整个树，保留字段值）
+ * 注意，此方法只会克隆节点，节点属性如果是引用类型，不会克隆 + * + * @return 新的节点 + * @since 5.7.17 + */ + public Tree cloneTree() { + final Tree result = ObjectUtil.clone(this); + result.setChildren(cloneChildren()); + return result; + } + + /** + * 递归复制子节点 + * + * @return 新的子节点列表 + */ + private List> cloneChildren() { + final List> children = getChildren(); + if (null == children) { + return null; + } + final List> newChildren = new ArrayList<>(children.size()); + children.forEach((t) -> newChildren.add(t.cloneTree())); + return newChildren; + } + + /** + * 打印 + * + * @param tree 树 + * @param writer Writer + * @param intent 缩进量 + */ + private static void printTree(Tree tree, PrintWriter writer, int intent) { + writer.println(StrUtil.format("{}{}[{}]", StrUtil.repeat(CharUtil.SPACE, intent), tree.getName(), tree.getId())); + writer.flush(); + + final List> children = tree.getChildren(); + if (CollUtil.isNotEmpty(children)) { + for (Tree child : children) { + printTree(child, writer, intent + 2); + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/TreeBuilder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/TreeBuilder.java new file mode 100755 index 0000000..6858ab4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/TreeBuilder.java @@ -0,0 +1,307 @@ +package aiyh.utils.tool.cn.hutool.core.lang.tree; + +import aiyh.utils.tool.cn.hutool.core.builder.Builder; +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.tree.parser.NodeParser; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +/** + * 树构建器 + * + * @param ID类型 + */ +public class TreeBuilder implements Builder> { + private static final long serialVersionUID = 1L; + + private final Tree root; + private final Map> idTreeMap; + private boolean isBuild; + + /** + * 创建Tree构建器 + * + * @param rootId 根节点ID + * @param ID类型 + * @return TreeBuilder + */ + public static TreeBuilder of(T rootId) { + return of(rootId, null); + } + + /** + * 创建Tree构建器 + * + * @param rootId 根节点ID + * @param config 配置 + * @param ID类型 + * @return TreeBuilder + */ + public static TreeBuilder of(T rootId, TreeNodeConfig config) { + return new TreeBuilder<>(rootId, config); + } + + /** + * 构造 + * + * @param rootId 根节点ID + * @param config 配置 + */ + public TreeBuilder(E rootId, TreeNodeConfig config) { + root = new Tree<>(config); + root.setId(rootId); + this.idTreeMap = new LinkedHashMap<>(); + } + + /** + * 设置ID + * + * @param id ID + * @return this + * @since 5.7.14 + */ + public TreeBuilder setId(E id) { + this.root.setId(id); + return this; + } + + /** + * 设置父节点ID + * + * @param parentId 父节点ID + * @return this + * @since 5.7.14 + */ + public TreeBuilder setParentId(E parentId) { + this.root.setParentId(parentId); + return this; + } + + /** + * 设置节点标签名称 + * + * @param name 节点标签名称 + * @return this + * @since 5.7.14 + */ + public TreeBuilder setName(CharSequence name) { + this.root.setName(name); + return this; + } + + /** + * 设置权重 + * + * @param weight 权重 + * @return this + * @since 5.7.14 + */ + public TreeBuilder setWeight(Comparable weight) { + this.root.setWeight(weight); + return this; + } + + /** + * 扩展属性 + * + * @param key 键 + * @param value 扩展值 + * @return this + * @since 5.7.14 + */ + public TreeBuilder putExtra(String key, Object value) { + Assert.notEmpty(key, "Key must be not empty !"); + this.root.put(key, value); + return this; + } + + /** + * 增加节点列表，增加的节点是不带子节点的 + * + * @param map 节点列表 + * @return this + */ + public TreeBuilder append(Map> map) { + checkBuilt(); + + this.idTreeMap.putAll(map); + return this; + } + + /** + * 增加节点列表，增加的节点是不带子节点的 + * + * @param trees 节点列表 + * @return this + */ + public TreeBuilder append(Iterable> trees) { + checkBuilt(); + + for (Tree tree : trees) { + this.idTreeMap.put(tree.getId(), tree); + } + return this; + } + + /** + * 增加节点列表，增加的节点是不带子节点的 + * + * @param list Bean列表 + * @param Bean类型 + * @param nodeParser 节点转换器，用于定义一个Bean如何转换为Tree节点 + * @return this + */ + public TreeBuilder append(List list, NodeParser nodeParser) { + return append(list, null, nodeParser); + } + + /** + * 增加节点列表，增加的节点是不带子节点的 + * + * @param Bean类型 + * @param list Bean列表 + * @param rootId 根ID + * @param nodeParser 节点转换器，用于定义一个Bean如何转换为Tree节点 + * @return this + * @since 5.8.6 + */ + public TreeBuilder append(List list, E rootId, NodeParser nodeParser) { + checkBuilt(); + + final TreeNodeConfig config = this.root.getConfig(); + final Map> map = new LinkedHashMap<>(list.size(), 1); + Tree node; + for (T t : list) { + node = new Tree<>(config); + nodeParser.parse(t, node); + if (null != rootId && false == rootId.getClass().equals(node.getId().getClass())) { + throw new IllegalArgumentException("rootId type is node.getId().getClass()!"); + } + map.put(node.getId(), node); + } + return append(map); + } + + /** + * 重置Builder，实现复用 + * + * @return this + */ + public TreeBuilder reset() { + this.idTreeMap.clear(); + this.root.setChildren(null); + this.isBuild = false; + return this; + } + + @Override + public Tree build() { + checkBuilt(); + + buildFromMap(); + cutTree(); + + this.isBuild = true; + this.idTreeMap.clear(); + + return root; + } + + /** + * 构建树列表，没有顶层节点，例如： + * + * 

+	 * -用户管理
+	 *  -用户管理
+	 *    +用户添加
+	 * - 部门管理
+	 *  -部门管理
+	 *    +部门添加
+	 *
+ * + * @return 树列表 + */ + public List> buildList() { + if (isBuild) { + // 已经构建过了 + return this.root.getChildren(); + } + return build().getChildren(); + } + + /** + * 开始构建 + */ + private void buildFromMap() { + if (MapUtil.isEmpty(this.idTreeMap)) { + return; + } + + final Map> eTreeMap = MapUtil.sortByValue(this.idTreeMap, false); + E parentId; + for (Tree node : eTreeMap.values()) { + if (null == node) { + continue; + } + parentId = node.getParentId(); + if (ObjectUtil.equals(this.root.getId(), parentId)) { + this.root.addChildren(node); + continue; + } + + final Tree parentNode = eTreeMap.get(parentId); + if (null != parentNode) { + parentNode.addChildren(node); + } + } + } + + /** + * 树剪枝 + */ + private void cutTree() { + final TreeNodeConfig config = this.root.getConfig(); + final Integer deep = config.getDeep(); + if (null == deep || deep < 0) { + return; + } + cutTree(this.root, 0, deep); + } + + /** + * 树剪枝叶 + * + * @param tree 节点 + * @param currentDepp 当前层级 + * @param maxDeep 最大层级 + */ + private void cutTree(Tree tree, int currentDepp, int maxDeep) { + if (null == tree) { + return; + } + if (currentDepp == maxDeep) { + // 剪枝 + tree.setChildren(null); + return; + } + + final List> children = tree.getChildren(); + if (CollUtil.isNotEmpty(children)) { + for (Tree child : children) { + cutTree(child, currentDepp + 1, maxDeep); + } + } + } + + /** + * 检查是否已经构建 + */ + private void checkBuilt() { + Assert.isFalse(isBuild, "Current tree has been built."); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/TreeNode.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/TreeNode.java new file mode 100755 index 0000000..568c347 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/TreeNode.java @@ -0,0 +1,150 @@ +package aiyh.utils.tool.cn.hutool.core.lang.tree; + + +import java.util.Map; +import java.util.Objects; + +/** + * 树节点 每个属性都可以在{@link TreeNodeConfig}中被重命名
+ * 在你的项目里它可以是部门实体、地区实体等任意类树节点实体 + * 类树节点实体: 包含key，父Key.不限于这些属性的可以构造成一颗树的实体对象 + * + * @param ID类型 + * @author liangbaikai + */ +public class TreeNode implements Node { + private static final long serialVersionUID = 1L; + + /** + * ID + */ + private T id; + + /** + * 父节点ID + */ + private T parentId; + + /** + * 名称 + */ + private CharSequence name; + + /** + * 顺序 越小优先级越高 默认0 + */ + private Comparable weight = 0; + + /** + * 扩展字段 + */ + private Map extra; + + + /** + * 空构造 + */ + public TreeNode() { + } + + /** + * 构造 + * + * @param id ID + * @param parentId 父节点ID + * @param name 名称 + * @param weight 权重 + */ + public TreeNode(T id, T parentId, String name, Comparable weight) { + this.id = id; + this.parentId = parentId; + this.name = name; + if (weight != null) { + this.weight = weight; + } + + } + + @Override + public T getId() { + return id; + } + + @Override + public TreeNode setId(T id) { + this.id = id; + return this; + } + + @Override + public T getParentId() { + return this.parentId; + } + + @Override + public TreeNode setParentId(T parentId) { + this.parentId = parentId; + return this; + } + + @Override + public CharSequence getName() { + return name; + } + + @Override + public TreeNode setName(CharSequence name) { + this.name = name; + return this; + } + + @Override + public Comparable getWeight() { + return weight; + } + + @Override + public TreeNode setWeight(Comparable weight) { + this.weight = weight; + return this; + } + + /** + * 获取扩展字段 + * + * @return 扩展字段Map + * @since 5.2.5 + */ + public Map getExtra() { + return extra; + } + + /** + * 设置扩展字段 + * + * @param extra 扩展字段 + * @return this + * @since 5.2.5 + */ + public TreeNode setExtra(Map extra) { + this.extra = extra; + return this; + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TreeNode treeNode = (TreeNode) o; + return Objects.equals(id, treeNode.id); + } + + @Override + public int hashCode() { + return Objects.hash(id); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/TreeNodeConfig.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/TreeNodeConfig.java new file mode 100755 index 0000000..10315b9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/TreeNodeConfig.java @@ -0,0 +1,148 @@ +package aiyh.utils.tool.cn.hutool.core.lang.tree; + +import java.io.Serializable; + +/** + * 树配置属性相关 + * + * @author liangbaikai + */ +public class TreeNodeConfig implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * 默认属性配置对象 + */ + public static TreeNodeConfig DEFAULT_CONFIG = new TreeNodeConfig(); + + // 属性名配置字段 + private String idKey = "id"; + private String parentIdKey = "parentId"; + private String weightKey = "weight"; + private String nameKey = "name"; + private String childrenKey = "children"; + // 可以配置递归深度 从0开始计算 默认此配置为空,即不限制 + private Integer deep; + + + /** + * 获取ID对应的名称 + * + * @return ID对应的名称 + */ + public String getIdKey() { + return this.idKey; + } + + /** + * 设置ID对应的名称 + * + * @param idKey ID对应的名称 + * @return this + */ + public TreeNodeConfig setIdKey(String idKey) { + this.idKey = idKey; + return this; + } + + /** + * 获取权重对应的名称 + * + * @return 权重对应的名称 + */ + public String getWeightKey() { + return this.weightKey; + } + + /** + * 设置权重对应的名称 + * + * @param weightKey 权重对应的名称 + * @return this + */ + public TreeNodeConfig setWeightKey(String weightKey) { + this.weightKey = weightKey; + return this; + } + + /** + * 获取节点名对应的名称 + * + * @return 节点名对应的名称 + */ + public String getNameKey() { + return this.nameKey; + } + + /** + * 设置节点名对应的名称 + * + * @param nameKey 节点名对应的名称 + * @return this + */ + public TreeNodeConfig setNameKey(String nameKey) { + this.nameKey = nameKey; + return this; + } + + /** + * 获取子点对应的名称 + * + * @return 子点对应的名称 + */ + public String getChildrenKey() { + return this.childrenKey; + } + + /** + * 设置子点对应的名称 + * + * @param childrenKey 子点对应的名称 + * @return this + */ + public TreeNodeConfig setChildrenKey(String childrenKey) { + this.childrenKey = childrenKey; + return this; + } + + /** + * 获取父节点ID对应的名称 + * + * @return 父点对应的名称 + */ + public String getParentIdKey() { + return this.parentIdKey; + } + + + /** + * 设置父点对应的名称 + * + * @param parentIdKey 父点对应的名称 + * @return this + */ + public TreeNodeConfig setParentIdKey(String parentIdKey) { + this.parentIdKey = parentIdKey; + return this; + } + + /** + * 获取递归深度 + * + * @return 递归深度 + */ + public Integer getDeep() { + return this.deep; + } + + /** + * 设置递归深度 + * + * @param deep 递归深度 + * @return this + */ + public TreeNodeConfig setDeep(Integer deep) { + this.deep = deep; + return this; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/TreeUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/TreeUtil.java new file mode 100755 index 0000000..dc9581e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/TreeUtil.java @@ -0,0 +1,239 @@ +package aiyh.utils.tool.cn.hutool.core.lang.tree; + +import aiyh.utils.tool.cn.hutool.core.collection.IterUtil; +import aiyh.utils.tool.cn.hutool.core.lang.tree.parser.DefaultNodeParser; +import aiyh.utils.tool.cn.hutool.core.lang.tree.parser.NodeParser; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +/** + * 树工具类 + * + * @author liangbaikai + */ +public class TreeUtil { + + /** + * 构建单root节点树 + * + * @param list 源数据集合 + * @return {@link Tree} + * @since 5.7.2 + */ + public static Tree buildSingle(List> list) { + return buildSingle(list, 0); + } + + /** + * 树构建 + * + * @param list 源数据集合 + * @return List + */ + public static List> build(List> list) { + return build(list, 0); + } + + /** + * 构建单root节点树
+ * 它会生成一个以指定ID为ID的空的节点，然后逐级增加子节点。 + * + * @param ID类型 + * @param list 源数据集合 + * @param parentId 最顶层父id值 一般为 0 之类 + * @return {@link Tree} + * @since 5.7.2 + */ + public static Tree buildSingle(List> list, E parentId) { + return buildSingle(list, parentId, TreeNodeConfig.DEFAULT_CONFIG, new DefaultNodeParser<>()); + } + + /** + * 树构建 + * + * @param ID类型 + * @param list 源数据集合 + * @param parentId 最顶层父id值 一般为 0 之类 + * @return List + */ + public static List> build(List> list, E parentId) { + return build(list, parentId, TreeNodeConfig.DEFAULT_CONFIG, new DefaultNodeParser<>()); + } + + /** + * 构建单root节点树
+ * 它会生成一个以指定ID为ID的空的节点，然后逐级增加子节点。 + * + * @param 转换的实体 为数据源里的对象类型 + * @param ID类型 + * @param list 源数据集合 + * @param parentId 最顶层父id值 一般为 0 之类 + * @param nodeParser 转换器 + * @return {@link Tree} + * @since 5.7.2 + */ + public static Tree buildSingle(List list, E parentId, NodeParser nodeParser) { + return buildSingle(list, parentId, TreeNodeConfig.DEFAULT_CONFIG, nodeParser); + } + + /** + * 树构建 + * + * @param 转换的实体 为数据源里的对象类型 + * @param ID类型 + * @param list 源数据集合 + * @param parentId 最顶层父id值 一般为 0 之类 + * @param nodeParser 转换器 + * @return List + */ + public static List> build(List list, E parentId, NodeParser nodeParser) { + return build(list, parentId, TreeNodeConfig.DEFAULT_CONFIG, nodeParser); + } + + /** + * 树构建 + * + * @param 转换的实体 为数据源里的对象类型 + * @param ID类型 + * @param list 源数据集合 + * @param rootId 最顶层父id值 一般为 0 之类 + * @param treeNodeConfig 配置 + * @param nodeParser 转换器 + * @return List + */ + public static List> build(List list, E rootId, TreeNodeConfig treeNodeConfig, NodeParser nodeParser) { + return buildSingle(list, rootId, treeNodeConfig, nodeParser).getChildren(); + } + + /** + * 构建单root节点树
+ * 它会生成一个以指定ID为ID的空的节点，然后逐级增加子节点。 + * + * @param 转换的实体 为数据源里的对象类型 + * @param ID类型 + * @param list 源数据集合 + * @param rootId 最顶层父id值 一般为 0 之类 + * @param treeNodeConfig 配置 + * @param nodeParser 转换器 + * @return {@link Tree} + * @since 5.7.2 + */ + public static Tree buildSingle(List list, E rootId, TreeNodeConfig treeNodeConfig, NodeParser nodeParser) { + return TreeBuilder.of(rootId, treeNodeConfig) + .append(list, rootId, nodeParser).build(); + } + + /** + * 树构建，按照权重排序 + * + * @param ID类型 + * @param map 源数据Map + * @param rootId 最顶层父id值 一般为 0 之类 + * @return List + * @since 5.6.7 + */ + public static List> build(Map> map, E rootId) { + return buildSingle(map, rootId).getChildren(); + } + + /** + * 单点树构建，按照权重排序
+ * 它会生成一个以指定ID为ID的空的节点，然后逐级增加子节点。 + * + * @param ID类型 + * @param map 源数据Map + * @param rootId 根节点id值 一般为 0 之类 + * @return {@link Tree} + * @since 5.7.2 + */ + public static Tree buildSingle(Map> map, E rootId) { + final Tree tree = IterUtil.getFirstNoneNull(map.values()); + if (null != tree) { + final TreeNodeConfig config = tree.getConfig(); + return TreeBuilder.of(rootId, config) + .append(map) + .build(); + } + + return createEmptyNode(rootId); + } + + /** + * 获取ID对应的节点，如果有多个ID相同的节点，只返回第一个。
+ * 此方法只查找此节点及子节点，采用递归深度优先遍历。 + * + * @param ID类型 + * @param node 节点 + * @param id ID + * @return 节点 + * @since 5.2.4 + */ + public static Tree getNode(Tree node, T id) { + if (ObjectUtil.equal(id, node.getId())) { + return node; + } + + final List> children = node.getChildren(); + if (null == children) { + return null; + } + + // 查找子节点 + Tree childNode; + for (Tree child : children) { + childNode = child.getNode(id); + if (null != childNode) { + return childNode; + } + } + + // 未找到节点 + return null; + } + + /** + * 获取所有父节点名称列表 + * + *

+ * 比如有个人在研发1部，他上面有研发部，接着上面有技术中心
+ * 返回结果就是：[研发一部, 研发中心, 技术中心] + * + * @param 节点ID类型 + * @param node 节点 + * @param includeCurrentNode 是否包含当前节点的名称 + * @return 所有父节点名称列表，node为null返回空List + * @since 5.2.4 + */ + public static List getParentsName(Tree node, boolean includeCurrentNode) { + final List result = new ArrayList<>(); + if (null == node) { + return result; + } + + if (includeCurrentNode) { + result.add(node.getName()); + } + + Tree parent = node.getParent(); + while (null != parent) { + result.add(parent.getName()); + parent = parent.getParent(); + } + return result; + } + + /** + * 创建空Tree的节点 + * + * @param id 节点ID + * @param 节点ID类型 + * @return {@link Tree} + * @since 5.7.2 + */ + public static Tree createEmptyNode(E id) { + return new Tree().setId(id); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/package-info.java new file mode 100755 index 0000000..a9e88ff --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/package-info.java @@ -0,0 +1,14 @@ +/** + * 提供通用树生成，特点：

+ * 1、每个字段可自定义
+ * 2、支持排序 树深度配置,自定义转换器等
+ * 3、支持额外属性扩展
+ * 4、贴心 许多属性,特性都有默认值处理
+ * 5、使用简单 可一行代码生成树
+ * 6、代码简洁轻量无额外依赖 + *

+ * + * @author liangbaikai（https://gitee.com/liangbaikai00/） + * @since 5.2.1 + */ +package aiyh.utils.tool.cn.hutool.core.lang.tree; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/parser/DefaultNodeParser.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/parser/DefaultNodeParser.java new file mode 100755 index 0000000..ffc15cb --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/parser/DefaultNodeParser.java @@ -0,0 +1,30 @@ +package aiyh.utils.tool.cn.hutool.core.lang.tree.parser; + +import aiyh.utils.tool.cn.hutool.core.lang.tree.TreeNode; +import aiyh.utils.tool.cn.hutool.core.lang.tree.Tree; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; + +import java.util.Map; + +/** + * 默认的简单转换器 + * + * @param ID类型 + * @author liangbaikai + */ +public class DefaultNodeParser implements NodeParser, T> { + + @Override + public void parse(TreeNode treeNode, Tree tree) { + tree.setId(treeNode.getId()); + tree.setParentId(treeNode.getParentId()); + tree.setWeight(treeNode.getWeight()); + tree.setName(treeNode.getName()); + + //扩展字段 + final Map extra = treeNode.getExtra(); + if(MapUtil.isNotEmpty(extra)){ + extra.forEach(tree::putExtra); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/parser/NodeParser.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/parser/NodeParser.java new file mode 100755 index 0000000..0ba2c04 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/lang/tree/parser/NodeParser.java @@ -0,0 +1,19 @@ +package aiyh.utils.tool.cn.hutool.core.lang.tree.parser; + +import aiyh.utils.tool.cn.hutool.core.lang.tree.Tree; + +/** + * 树节点解析器 可以参考{@link DefaultNodeParser} + * + * @param 转换的实体 为数据源里的对象类型 + * @author liangbaikai + */ +@FunctionalInterface +public interface NodeParser { + /** + * @param object 源数据实体 + * @param treeNode 树节点实体 + */ + void parse(T object, Tree treeNode); +} + diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/AbsEntry.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/AbsEntry.java new file mode 100644 index 0000000..14fb8e7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/AbsEntry.java @@ -0,0 +1,46 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.util.Map; + +/** + * 抽象的{@link Map.Entry}实现，来自Guava
+ * 实现了默认的{@link #equals(Object)}、{@link #hashCode()}、{@link #toString()}方法。
+ * 默认{@link #setValue(Object)}抛出异常。 + * + * @param 键类型 + * @param 值类型 + * @author Guava + * @since 5.7.23 + */ +public abstract class AbsEntry implements Map.Entry { + + @Override + public V setValue(V value) { + throw new UnsupportedOperationException("Entry is read only."); + } + + @Override + public boolean equals(Object object) { + if (object instanceof Map.Entry) { + final Map.Entry that = (Map.Entry) object; + return ObjectUtil.equals(this.getKey(), that.getKey()) + && ObjectUtil.equals(this.getValue(), that.getValue()); + } + return false; + } + + @Override + public int hashCode() { + //copy from 1.8 HashMap.Node + K k = getKey(); + V v = getValue(); + return ((k == null) ? 0 : k.hashCode()) ^ ((v == null) ? 0 : v.hashCode()); + } + + @Override + public String toString() { + return getKey() + "=" + getValue(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/BiMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/BiMap.java new file mode 100644 index 0000000..05c78b7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/BiMap.java @@ -0,0 +1,133 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import java.util.Map; +import java.util.function.BiFunction; +import java.util.function.Function; + +/** + * 双向Map
+ * 互换键值对不检查值是否有重复，如果有则后加入的元素替换先加入的元素
+ * 值的顺序在HashMap中不确定，所以谁覆盖谁也不确定，在有序的Map中按照先后顺序覆盖，保留最后的值
+ * 它与TableMap的区别是，BiMap维护两个Map实现高效的正向和反向查找 + * + * @param 键类型 + * @param 值类型 + * @since 5.2.6 + */ +public class BiMap extends MapWrapper { + private static final long serialVersionUID = 1L; + + private Map inverse; + + /** + * 构造 + * + * @param raw 被包装的Map + */ + public BiMap(Map raw) { + super(raw); + } + + @Override + public V put(K key, V value) { + if (null != this.inverse) { + this.inverse.put(value, key); + } + return super.put(key, value); + } + + @Override + public void putAll(Map m) { + super.putAll(m); + if (null != this.inverse) { + m.forEach((key, value) -> this.inverse.put(value, key)); + } + } + + @Override + public V remove(Object key) { + final V v = super.remove(key); + if (null != this.inverse && null != v) { + this.inverse.remove(v); + } + return v; + } + + @Override + public boolean remove(Object key, Object value) { + return super.remove(key, value) && null != this.inverse && this.inverse.remove(value, key); + } + + @Override + public void clear() { + super.clear(); + this.inverse = null; + } + + /** + * 获取反向Map + * + * @return 反向Map + */ + public Map getInverse() { + if (null == this.inverse) { + inverse = MapUtil.inverse(getRaw()); + } + return this.inverse; + } + + /** + * 根据值获得键 + * + * @param value 值 + * @return 键 + */ + public K getKey(V value) { + return getInverse().get(value); + } + + @Override + public V putIfAbsent(K key, V value) { + if (null != this.inverse) { + this.inverse.putIfAbsent(value, key); + } + return super.putIfAbsent(key, value); + } + + @Override + public V computeIfAbsent(K key, Function mappingFunction) { + final V result = super.computeIfAbsent(key, mappingFunction); + resetInverseMap(); + return result; + } + + @Override + public V computeIfPresent(K key, BiFunction remappingFunction) { + final V result = super.computeIfPresent(key, remappingFunction); + resetInverseMap(); + return result; + } + + @Override + public V compute(K key, BiFunction remappingFunction) { + final V result = super.compute(key, remappingFunction); + resetInverseMap(); + return result; + } + + @Override + public V merge(K key, V value, BiFunction remappingFunction) { + final V result = super.merge(key, value, remappingFunction); + resetInverseMap(); + return result; + } + + /** + * 重置反转的Map，如果反转map为空，则不操作。 + */ + private void resetInverseMap() { + if (null != this.inverse) { + inverse = null; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CamelCaseLinkedMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CamelCaseLinkedMap.java new file mode 100644 index 0000000..b7f73c9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CamelCaseLinkedMap.java @@ -0,0 +1,66 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import java.util.LinkedHashMap; +import java.util.Map; + +/** + * 驼峰Key风格的LinkedHashMap
+ * 对KEY转换为驼峰，get("int_value")和get("intValue")获得的值相同，put进入的值也会被覆盖 + * + * @author Looly + * + * @param 键类型 + * @param 值类型 + * @since 4.0.7 + */ +public class CamelCaseLinkedMap extends CamelCaseMap { + private static final long serialVersionUID = 4043263744224569870L; + + // ------------------------------------------------------------------------- Constructor start + /** + * 构造 + */ + public CamelCaseLinkedMap() { + this(DEFAULT_INITIAL_CAPACITY); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + */ + public CamelCaseLinkedMap(int initialCapacity) { + this(initialCapacity, DEFAULT_LOAD_FACTOR); + } + + /** + * 构造 + * + * @param m Map + */ + public CamelCaseLinkedMap(Map m) { + this(DEFAULT_LOAD_FACTOR, m); + } + + /** + * 构造 + * + * @param loadFactor 加载因子 + * @param m Map，数据会被默认拷贝到一个新的LinkedHashMap中 + */ + public CamelCaseLinkedMap(float loadFactor, Map m) { + this(m.size(), loadFactor); + this.putAll(m); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + * @param loadFactor 加载因子 + */ + public CamelCaseLinkedMap(int initialCapacity, float loadFactor) { + super(new LinkedHashMap<>(initialCapacity, loadFactor)); + } + // ------------------------------------------------------------------------- Constructor end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CamelCaseMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CamelCaseMap.java new file mode 100644 index 0000000..015c199 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CamelCaseMap.java @@ -0,0 +1,87 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.util.HashMap; +import java.util.Map; +import java.util.function.Function; + +/** + * 驼峰Key风格的Map
+ * 对KEY转换为驼峰，get("int_value")和get("intValue")获得的值相同，put进入的值也会被覆盖 + * + * @param 键类型 + * @param 值类型 + * @author Looly + * @since 4.0.7 + */ +public class CamelCaseMap extends FuncKeyMap { + private static final long serialVersionUID = 4043263744224569870L; + + // ------------------------------------------------------------------------- Constructor start + + /** + * 构造 + */ + public CamelCaseMap() { + this(DEFAULT_INITIAL_CAPACITY); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + */ + public CamelCaseMap(int initialCapacity) { + this(initialCapacity, DEFAULT_LOAD_FACTOR); + } + + /** + * 构造 + * + * @param m Map + */ + public CamelCaseMap(Map m) { + this(DEFAULT_LOAD_FACTOR, m); + } + + /** + * 构造 + * + * @param loadFactor 加载因子 + * @param m 初始Map，数据会被默认拷贝到一个新的HashMap中 + */ + public CamelCaseMap(float loadFactor, Map m) { + this(m.size(), loadFactor); + this.putAll(m); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + * @param loadFactor 加载因子 + */ + public CamelCaseMap(int initialCapacity, float loadFactor) { + this(MapBuilder.create(new HashMap<>(initialCapacity, loadFactor))); + } + + /** + * 构造
+ * 注意此构造将传入的Map作为被包装的Map，针对任何修改，传入的Map都会被同样修改。 + * + * @param emptyMapBuilder Map构造器，必须构造空的Map + */ + CamelCaseMap(MapBuilder emptyMapBuilder) { + // issue#I5VRHW@Gitee 使Function可以被序列化 + super(emptyMapBuilder.build(), (Function & Serializable)(key) -> { + if (key instanceof CharSequence) { + key = StrUtil.toCamelCase(key.toString()); + } + //noinspection unchecked + return (K) key; + }); + } + // ------------------------------------------------------------------------- Constructor end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CaseInsensitiveLinkedMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CaseInsensitiveLinkedMap.java new file mode 100644 index 0000000..e9a24ef --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CaseInsensitiveLinkedMap.java @@ -0,0 +1,67 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import java.util.LinkedHashMap; +import java.util.Map; + +/** + * 忽略大小写的LinkedHashMap
+ * 对KEY忽略大小写，get("Value")和get("value")获得的值相同，put进入的值也会被覆盖 + * + * @author Looly + * + * @param 键类型 + * @param 值类型 + * @since 3.3.1 + */ +public class CaseInsensitiveLinkedMap extends CaseInsensitiveMap { + private static final long serialVersionUID = 4043263744224569870L; + + // ------------------------------------------------------------------------- Constructor start + /** + * 构造 + */ + public CaseInsensitiveLinkedMap() { + this(DEFAULT_INITIAL_CAPACITY); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + */ + public CaseInsensitiveLinkedMap(int initialCapacity) { + this(initialCapacity, DEFAULT_LOAD_FACTOR); + } + + /** + * 构造 + * + * @param m Map + */ + public CaseInsensitiveLinkedMap(Map m) { + this(DEFAULT_LOAD_FACTOR, m); + } + + /** + * 构造 + * + * @param loadFactor 加载因子 + * @param m Map + * @since 3.1.2 + */ + public CaseInsensitiveLinkedMap(float loadFactor, Map m) { + this(m.size(), loadFactor); + this.putAll(m); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + * @param loadFactor 加载因子 + */ + public CaseInsensitiveLinkedMap(int initialCapacity, float loadFactor) { + super(new LinkedHashMap<>(initialCapacity, loadFactor)); + } + // ------------------------------------------------------------------------- Constructor end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CaseInsensitiveMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CaseInsensitiveMap.java new file mode 100644 index 0000000..d40ed4a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CaseInsensitiveMap.java @@ -0,0 +1,87 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import java.io.Serializable; +import java.util.HashMap; +import java.util.Map; +import java.util.function.Function; + +/** + * 忽略大小写的Map
+ * 对KEY忽略大小写，get("Value")和get("value")获得的值相同，put进入的值也会被覆盖 + * + * @author Looly + * + * @param 键类型 + * @param 值类型 + * @since 3.0.2 + */ +public class CaseInsensitiveMap extends FuncKeyMap { + private static final long serialVersionUID = 4043263744224569870L; + + //------------------------------------------------------------------------- Constructor start + /** + * 构造 + */ + public CaseInsensitiveMap() { + this(DEFAULT_INITIAL_CAPACITY); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + */ + public CaseInsensitiveMap(int initialCapacity) { + this(initialCapacity, DEFAULT_LOAD_FACTOR); + } + + /** + * 构造
+ * 注意此构造将传入的Map作为被包装的Map，针对任何修改，传入的Map都会被同样修改。 + * + * @param m 被包装的自定义Map创建器 + */ + public CaseInsensitiveMap(Map m) { + this(DEFAULT_LOAD_FACTOR, m); + } + + /** + * 构造 + * + * @param loadFactor 加载因子 + * @param m Map + * @since 3.1.2 + */ + public CaseInsensitiveMap(float loadFactor, Map m) { + this(m.size(), loadFactor); + this.putAll(m); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + * @param loadFactor 加载因子 + */ + public CaseInsensitiveMap(int initialCapacity, float loadFactor) { + this(MapBuilder.create(new HashMap<>(initialCapacity, loadFactor))); + } + + /** + * 构造
+ * 注意此构造将传入的Map作为被包装的Map，针对任何修改，传入的Map都会被同样修改。 + * + * @param emptyMapBuilder 被包装的自定义Map创建器 + */ + CaseInsensitiveMap(MapBuilder emptyMapBuilder) { + // issue#I5VRHW@Gitee 使Function可以被序列化 + super(emptyMapBuilder.build(), (Function & Serializable)(key)->{ + if (key instanceof CharSequence) { + key = key.toString().toLowerCase(); + } + //noinspection unchecked + return (K) key; + }); + } + //------------------------------------------------------------------------- Constructor end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CaseInsensitiveTreeMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CaseInsensitiveTreeMap.java new file mode 100755 index 0000000..f93200e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CaseInsensitiveTreeMap.java @@ -0,0 +1,59 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import java.util.Comparator; +import java.util.Map; +import java.util.SortedMap; +import java.util.TreeMap; + +/** + * 忽略大小写的{@link TreeMap}
+ * 对KEY忽略大小写，get("Value")和get("value")获得的值相同，put进入的值也会被覆盖 + * + * @author Looly + * + * @param 键类型 + * @param 值类型 + * @since 3.3.1 + */ +public class CaseInsensitiveTreeMap extends CaseInsensitiveMap { + private static final long serialVersionUID = 4043263744224569870L; + + // ------------------------------------------------------------------------- Constructor start + /** + * 构造 + */ + public CaseInsensitiveTreeMap() { + this((Comparator) null); + } + + /** + * 构造 + * + * @param m Map + * @since 3.1.2 + */ + public CaseInsensitiveTreeMap(Map m) { + this(); + this.putAll(m); + } + + /** + * 构造 + * + * @param m Map，初始Map，键值对会被复制到新的TreeMap中 + * @since 3.1.2 + */ + public CaseInsensitiveTreeMap(SortedMap m) { + super(new TreeMap(m)); + } + + /** + * 构造 + * + * @param comparator 比较器，{@code null}表示使用默认比较器 + */ + public CaseInsensitiveTreeMap(Comparator comparator) { + super(new TreeMap<>(comparator)); + } + // ------------------------------------------------------------------------- Constructor end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CustomKeyMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CustomKeyMap.java new file mode 100755 index 0000000..5b4facd --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/CustomKeyMap.java @@ -0,0 +1,32 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import java.util.Map; + +/** + * 自定义键的Map，默认HashMap实现 + * + * @param 键类型 + * @param 值类型 + * @author Looly + * @since 4.0.7 + */ +public abstract class CustomKeyMap extends TransMap { + private static final long serialVersionUID = 4043263744224569870L; + + /** + * 构造
+ * 通过传入一个Map从而确定Map的类型，子类需创建一个空的Map，而非传入一个已有Map，否则值可能会被修改 + * + * @param emptyMap Map 被包装的Map，必须为空Map，否则自定义key会无效 + * @since 3.1.2 + */ + public CustomKeyMap(Map emptyMap) { + super(emptyMap); + } + + @Override + protected V customValue(Object value) { + //noinspection unchecked + return (V)value; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/FixedLinkedHashMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/FixedLinkedHashMap.java new file mode 100644 index 0000000..fbfe1bd --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/FixedLinkedHashMap.java @@ -0,0 +1,77 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.function.Consumer; + +/** + * 固定大小的{@link LinkedHashMap} 实现
+ * 注意此类非线程安全，由于{@link #get(Object)}操作会修改链表的顺序结构，因此也不可以使用读写锁。 + * + * @param 键类型 + * @param 值类型 + * @author looly + */ +public class FixedLinkedHashMap extends LinkedHashMap { + private static final long serialVersionUID = -629171177321416095L; + + /** + * 容量，超过此容量自动删除末尾元素 + */ + private int capacity; + /** + * 移除监听 + */ + private Consumer> removeListener; + + /** + * 构造 + * + * @param capacity 容量，实际初始容量比容量大1 + */ + public FixedLinkedHashMap(int capacity) { + super(capacity + 1, 1.0f, true); + this.capacity = capacity; + } + + /** + * 获取容量 + * + * @return 容量 + */ + public int getCapacity() { + return this.capacity; + } + + /** + * 设置容量 + * + * @param capacity 容量 + */ + public void setCapacity(int capacity) { + this.capacity = capacity; + } + + /** + * 设置自定义移除监听 + * + * @param removeListener 移除监听 + */ + public void setRemoveListener(final Consumer> removeListener) { + this.removeListener = removeListener; + } + + @Override + protected boolean removeEldestEntry(java.util.Map.Entry eldest) { + //当链表元素大于容量时，移除最老（最久未被使用）的元素 + if (size() > this.capacity) { + if (null != removeListener) { + // 自定义监听 + removeListener.accept(eldest); + } + return true; + } + return false; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/ForestMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/ForestMap.java new file mode 100644 index 0000000..adde438 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/ForestMap.java @@ -0,0 +1,333 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Opt; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.util.Collection; +import java.util.Collections; +import java.util.Map; +import java.util.Set; +import java.util.function.BiConsumer; +import java.util.function.Function; + +/** + * 基于多个{@link TreeEntry}构成的、彼此平行的树结构构成的森林集合。 + * + * @param key类型 + * @param value类型 + * @author huangchengxing + * @see TreeEntry + */ +public interface ForestMap extends Map> { + + // ===================== Map接口方法的重定义 ===================== + + /** + * 添加一个节点，效果等同于 {@code putNode(key, node.getValue())} + *
    + *
  • 若key对应节点不存在，则以传入的键值创建一个新的节点；
    • + *
  • 若key对应节点存在，则将该节点的值替换为{@code node}指定的值；
    • + *
+ * + * @param key 节点的key值 + * @param node 节点 + * @return 节点，若key已有对应节点，则返回具有旧值的节点，否则返回null + * @see #putNode(Object, Object) + */ + @Override + default TreeEntry put(K key, TreeEntry node) { + return putNode(key, node.getValue()); + } + + /** + * 批量添加节点，若节点具有父节点或者子节点，则一并在当前实例中引入该关系 + * + * @param treeEntryMap 节点集合 + */ + @Override + default void putAll(Map> treeEntryMap) { + if (CollUtil.isEmpty(treeEntryMap)) { + return; + } + treeEntryMap.forEach((k, v) -> { + if (v.hasParent()) { + final TreeEntry parent = v.getDeclaredParent(); + putLinkedNodes(parent.getKey(), parent.getValue(), v.getKey(), v.getValue()); + } else { + putNode(v.getKey(), v.getValue()); + } + }); + } + + /** + * 将指定节点从当前{@link Map}中删除 + *
    + *
  • 若存在父节点或子节点，则将其断开其与父节点或子节点的引用关系；
    • + *
  • + * 若同时存在父节点或子节点，则会在删除后将让子节点直接成为父节点的子节点，比如：
    + * 现有引用关系 a -> b -> c，删除 b 后，将有 a -> c + *
    • + *
+ * + * @param key 节点的key + * @return 删除的节点，若key没有对应节点，则返回null + */ + @Override + TreeEntry remove(Object key); + + /** + * 将当前集合清空，并清除全部节点间的引用关系 + */ + @Override + void clear(); + + // ===================== 节点操作 ===================== + + /** + * 批量添加节点 + * + * @param 集合类型 + * @param values 要添加的值 + * @param keyGenerator 从值中获取key的方法 + * @param parentKeyGenerator 从值中获取父节点key的方法 + * @param ignoreNullNode 是否获取到的key为null的子节点/父节点 + */ + default > void putAllNode( + C values, Function keyGenerator, Function parentKeyGenerator, boolean ignoreNullNode) { + if (CollUtil.isEmpty(values)) { + return; + } + values.forEach(v -> { + final K key = keyGenerator.apply(v); + final K parentKey = parentKeyGenerator.apply(v); + + // 不忽略keu为null节点 + final boolean hasKey = ObjectUtil.isNotNull(key); + final boolean hasParentKey = ObjectUtil.isNotNull(parentKey); + if (!ignoreNullNode || (hasKey && hasParentKey)) { + linkNodes(parentKey, key); + get(key).setValue(v); + return; + } + + // 父子节点的key都为null + if (!hasKey && !hasParentKey) { + return; + } + + // 父节点key为null + if (hasKey) { + putNode(key, v); + return; + } + + // 子节点key为null + putNode(parentKey, null); + }); + } + + /** + * 添加一个节点 + *
    + *
  • 若key对应节点不存在，则以传入的键值创建一个新的节点；
    • + *
  • 若key对应节点存在，则将该节点的值替换为{@code node}指定的值；
    • + *
+ * + * @param key 节点的key + * @param value 节点的value + * @return 节点，若key已有对应节点，则返回具有旧值的节点，否则返回null + */ + TreeEntry putNode(K key, V value); + + /** + * 同时添加父子节点： + *
    + *
  • 若{@code parentKey}或{@code childKey}对应的节点不存在，则会根据键值创建一个对应的节点；
    • + *
  • 若{@code parentKey}或{@code childKey}对应的节点存在，则会更新对应节点的值；
    • + *
+ * 该操作等同于： + * 
{@code
+	 *     putNode(parentKey, parentValue);
+	 *     putNode(childKey, childValue);
+	 *     linkNodes(parentKey, childKey);
+	 * }
+ * + * @param parentKey 父节点的key + * @param parentValue 父节点的value + * @param childKey 子节点的key + * @param childValue 子节点的值 + */ + default void putLinkedNodes(K parentKey, V parentValue, K childKey, V childValue) { + putNode(parentKey, parentValue); + putNode(childKey, childValue); + linkNodes(parentKey, childKey); + } + + /** + * 添加子节点，并为子节点指定父节点： + *
    + *
  • 若{@code parentKey}或{@code childKey}对应的节点不存在，则会根据键值创建一个对应的节点；
    • + *
  • 若{@code parentKey}或{@code childKey}对应的节点存在，则会更新对应节点的值；
    • + *
+ * + * @param parentKey 父节点的key + * @param childKey 子节点的key + * @param childValue 子节点的值 + */ + void putLinkedNodes(K parentKey, K childKey, V childValue); + + /** + * 为集合中的指定的节点建立父子关系 + * + * @param parentKey 父节点的key + * @param childKey 子节点的key + */ + default void linkNodes(K parentKey, K childKey) { + linkNodes(parentKey, childKey, null); + } + + /** + * 为集合中的指定的节点建立父子关系 + * + * @param parentKey 父节点的key + * @param childKey 子节点的key + * @param consumer 对父节点和子节点的操作，允许为null + */ + void linkNodes(K parentKey, K childKey, BiConsumer, TreeEntry> consumer); + + /** + * 若{@code parentKey}或{@code childKey}对应节点都存在，则移除指定该父节点与其直接关联的指定子节点间的引用关系 + * + * @param parentKey 父节点的key + * @param childKey 子节点 + */ + void unlinkNode(K parentKey, K childKey); + + // ===================== 父节点相关方法 ===================== + + /** + * 获取指定节点所在树结构的全部树节点
+ * 比如：存在 a -> b -> c 的关系，则输入 a/b/c 都将返回 a, b, c + * + * @param key 指定节点的key + * @return 节点 + */ + default Set> getTreeNodes(K key) { + final TreeEntry target = get(key); + if (ObjectUtil.isNull(target)) { + return Collections.emptySet(); + } + final Set> results = CollUtil.newLinkedHashSet(target.getRoot()); + CollUtil.addAll(results, target.getRoot().getChildren().values()); + return results; + } + + /** + * 获取以指定节点作为叶子节点的树结构，然后获取该树结构的根节点
+ * 比如：存在 a -> b -> c 的关系，则输入 a/b/c 都将返回 a + * + * @param key 指定节点的key + * @return 节点 + */ + default TreeEntry getRootNode(K key) { + return Opt.ofNullable(get(key)) + .map(TreeEntry::getRoot) + .orElse(null); + } + + /** + * 获取指定节点的直接父节点
+ * 比如：若存在 a -> b -> c 的关系，此时输入 a 将返回 null，输入 b 将返回 a，输入 c 将返回 b + * + * @param key 指定节点的key + * @return 节点 + */ + default TreeEntry getDeclaredParentNode(K key) { + return Opt.ofNullable(get(key)) + .map(TreeEntry::getDeclaredParent) + .orElse(null); + } + + /** + * 获取以指定节点作为叶子节点的树结构，然后获取该树结构中指定节点的指定父节点 + * + * @param key 指定节点的key + * @param parentKey 指定父节点key + * @return 节点 + */ + default TreeEntry getParentNode(K key, K parentKey) { + return Opt.ofNullable(get(key)) + .map(t -> t.getParent(parentKey)) + .orElse(null); + } + + /** + * 获取以指定节点作为叶子节点的树结构，然后确认该树结构中当前节点是否存在指定父节点 + * + * @param key 指定节点的key + * @param parentKey 指定父节点的key + * @return 是否 + */ + default boolean containsParentNode(K key, K parentKey) { + return Opt.ofNullable(get(key)) + .map(m -> m.containsParent(parentKey)) + .orElse(false); + } + + /** + * 获取指定节点的值 + * + * @param key 节点的key + * @return 节点值，若节点不存在，或节点值为null都将返回null + */ + default V getNodeValue(K key) { + return Opt.ofNullable(get(key)) + .map(TreeEntry::getValue) + .get(); + } + + // ===================== 子节点相关方法 ===================== + + /** + * 判断以该父节点作为根节点的树结构中是否具有指定子节点 + * + * @param parentKey 父节点 + * @param childKey 子节点 + * @return 是否 + */ + default boolean containsChildNode(K parentKey, K childKey) { + return Opt.ofNullable(get(parentKey)) + .map(m -> m.containsChild(childKey)) + .orElse(false); + } + + /** + * 获取指定父节点直接关联的子节点
+ * 比如：若存在 a -> b -> c 的关系，此时输入 b 将返回 c，输入 a 将返回 b + * + * @param key key + * @return 节点 + */ + default Collection> getDeclaredChildNodes(K key) { + return Opt.ofNullable(get(key)) + .map(TreeEntry::getDeclaredChildren) + .map(Map::values) + .orElseGet(Collections::emptyList); + } + + /** + * 获取指定父节点的全部子节点
+ * 比如：若存在 a -> b -> c 的关系，此时输入 b 将返回 c，输入 a 将返回 b，c + * + * @param key key + * @return 该节点的全部子节点 + */ + default Collection> getChildNodes(K key) { + return Opt.ofNullable(get(key)) + .map(TreeEntry::getChildren) + .map(Map::values) + .orElseGet(Collections::emptyList); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/FuncKeyMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/FuncKeyMap.java new file mode 100755 index 0000000..b18a23e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/FuncKeyMap.java @@ -0,0 +1,48 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import java.util.Map; +import java.util.function.Function; + +/** + * 自定义函数Key风格的Map + * + * @param 键类型 + * @param 值类型 + * @author Looly + * @since 5.6.0 + */ +public class FuncKeyMap extends CustomKeyMap { + private static final long serialVersionUID = 1L; + + private final Function keyFunc; + + // ------------------------------------------------------------------------- Constructor start + + /** + * 构造
+ * 注意提供的Map中不能有键值对，否则可能导致自定义key失效 + * + * @param emptyMap Map，提供的空map + * @param keyFunc 自定义KEY的函数 + */ + public FuncKeyMap(Map emptyMap, Function keyFunc) { + super(emptyMap); + this.keyFunc = keyFunc; + } + // ------------------------------------------------------------------------- Constructor end + + /** + * 根据函数自定义键 + * + * @param key KEY + * @return 驼峰Key + */ + @Override + protected K customKey(Object key) { + if (null != this.keyFunc) { + return keyFunc.apply(key); + } + //noinspection unchecked + return (K)key; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/FuncMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/FuncMap.java new file mode 100755 index 0000000..ea53168 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/FuncMap.java @@ -0,0 +1,73 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import java.util.Map; +import java.util.function.Function; +import java.util.function.Supplier; + +/** + * 自定义键值函数风格的Map + * + * @param 键类型 + * @param 值类型 + * @author Looly + * @since 5.8.0 + */ +public class FuncMap extends TransMap { + private static final long serialVersionUID = 1L; + + private final Function keyFunc; + private final Function valueFunc; + + // ------------------------------------------------------------------------- Constructor start + + /** + * 构造
+ * 注意提供的Map中不能有键值对，否则可能导致自定义key失效 + * + * @param mapFactory Map，提供的空map + * @param keyFunc 自定义KEY的函数 + * @param valueFunc 自定义value函数 + */ + public FuncMap(Supplier> mapFactory, Function keyFunc, Function valueFunc) { + this(mapFactory.get(), keyFunc, valueFunc); + } + + /** + * 构造
+ * 注意提供的Map中不能有键值对，否则可能导致自定义key失效 + * + * @param emptyMap Map，提供的空map + * @param keyFunc 自定义KEY的函数 + * @param valueFunc 自定义value函数 + */ + public FuncMap(Map emptyMap, Function keyFunc, Function valueFunc) { + super(emptyMap); + this.keyFunc = keyFunc; + this.valueFunc = valueFunc; + } + // ------------------------------------------------------------------------- Constructor end + + /** + * 根据函数自定义键 + * + * @param key KEY + * @return 驼峰Key + */ + @Override + protected K customKey(Object key) { + if (null != this.keyFunc) { + return keyFunc.apply(key); + } + //noinspection unchecked + return (K) key; + } + + @Override + protected V customValue(Object value) { + if (null != this.valueFunc) { + return valueFunc.apply(value); + } + //noinspection unchecked + return (V) value; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/LinkedForestMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/LinkedForestMap.java new file mode 100644 index 0000000..eff0dbb --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/LinkedForestMap.java @@ -0,0 +1,736 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.ClassUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.*; +import java.util.function.BiConsumer; +import java.util.function.BiPredicate; +import java.util.function.Consumer; +import java.util.function.Predicate; +import java.util.stream.Collectors; + +/** + * {@link ForestMap}的基本实现。 + * + *

该集合可以被视为以{@link TreeEntryNode#getKey()}作为key，{@link TreeEntryNode}实例作为value的{@link LinkedHashMap}。
+ * 使用时，将每一对键与值对视为一个{@link TreeEntryNode}节点，节点的id即为{@link TreeEntryNode#getKey()}， + * 任何情况下使用相同的key都将会访问到同一个节点。
+ * + *

节点通过key形成父子关系，并最终构成多叉树结构，多组平行的多叉树将在当前集合中构成森林。 + * 使用者可以通过{@link ForestMap}本身的方法来对森林进行操作或访问， + * 也可以在获取到{@link TreeEntry}后，使用节点本身的方法对数进行操作或访问。 + * + * @param key类型 + * @author huangchengxing + */ +public class LinkedForestMap implements ForestMap { + + /** + * 节点集合 + */ + private final Map> nodes; + + /** + * 当指定节点已经与其他节点构成了父子关系，是否允许将该节点的父节点强制替换为指定节点 + */ + private final boolean allowOverrideParent; + + /** + * 构建{@link LinkedForestMap} + * + * @param allowOverrideParent 当指定节点已经与其他节点构成了父子关系，是否允许将该节点的父节点强制替换为指定节点 + */ + public LinkedForestMap(boolean allowOverrideParent) { + this.allowOverrideParent = allowOverrideParent; + this.nodes = new LinkedHashMap<>(); + } + + // ====================== Map接口实现 ====================== + + /** + * 获取当前实例中的节点个数 + * + * @return 节点个数 + */ + @Override + public int size() { + return nodes.size(); + } + + /** + * 当前实例是否为空 + * + * @return 是否 + */ + @Override + public boolean isEmpty() { + return nodes.isEmpty(); + } + + /** + * 当前实例中是否存在key对应的节点 + * + * @param key key + * @return 是否 + */ + @Override + public boolean containsKey(Object key) { + return nodes.containsKey(key); + } + + /** + * 当前实例中是否存在对应的{@link TreeEntry}实例 + * + * @param value {@link TreeEntry}实例 + * @return 是否 + */ + @Override + public boolean containsValue(Object value) { + return nodes.containsValue(value); + } + + /** + * 获取key对应的节点 + * + * @param key key + * @return 节点 + */ + @Override + public TreeEntry get(Object key) { + return nodes.get(key); + } + + /** + * 将指定节点从当前{@link Map}中删除 + *

    + *
  • 若存在父节点或子节点，则将其断开其与父节点或子节点的引用关系；
    • + *
  • + * 若同时存在父节点或子节点，则会在删除后将让子节点直接成为父节点的子节点，比如：
    + * 现有引用关系 a -> b -> c，删除 b 后，将有 a -> c + *
    • + *
+ * + * @param key 节点的key + * @return 删除的且引用关系已经改变的节点，若key没有对应节点，则返回null + */ + @Override + public TreeEntry remove(Object key) { + final TreeEntryNode target = nodes.remove(key); + if (ObjectUtil.isNull(target)) { + return null; + } + // 若存在父节点： + // 1.将该目标从父节点的子节点中移除 + // 2.将目标的子节点直接将目标的父节点作为父节点 + if (target.hasParent()) { + final TreeEntryNode parent = target.getDeclaredParent(); + final Map> targetChildren = target.getChildren(); + parent.removeDeclaredChild(target.getKey()); + target.clear(); + targetChildren.forEach((k, c) -> parent.addChild((TreeEntryNode) c)); + } + return target; + } + + /** + * 将当前集合清空，并清除全部节点间的引用关系 + */ + @Override + public void clear() { + nodes.values().forEach(TreeEntryNode::clear); + nodes.clear(); + } + + /** + * 返回当前实例中全部的key组成的{@link Set}集合 + * + * @return 集合 + */ + @Override + public Set keySet() { + return nodes.keySet(); + } + + /** + * 返回当前实例中全部{@link TreeEntry}组成的{@link Collection}集合 + * + * @return 集合 + */ + @Override + public Collection> values() { + return new ArrayList<>(nodes.values()); + } + + /** + * 由key与{@link TreeEntry}组成的键值对实体的{@link Set}集合。 + * 注意，返回集合中{@link Map.Entry#setValue(Object)}不支持调用。 + * + * @return 集合 + */ + @Override + public Set>> entrySet() { + return nodes.entrySet().stream() + .map(this::wrap) + .collect(Collectors.toSet()); + } + + /** + * 将{@link TreeEntryNode}包装为{@link EntryNodeWrapper} + */ + private Map.Entry> wrap(Map.Entry> nodeEntry) { + return new EntryNodeWrapper<>(nodeEntry.getValue()); + } + + // ====================== ForestMap接口实现 ====================== + + /** + * 添加一个节点 + *
    + *
  • 若key对应节点不存在，则以传入的键值创建一个新的节点；
    • + *
  • 若key对应节点存在，则将该节点的值替换为{@code node}指定的值；
    • + *
+ * + * @param key 节点的key + * @param value 节点的value + * @return 节点，若key已有对应节点，则返回具有旧值的节点，否则返回null + */ + @Override + public TreeEntryNode putNode(K key, V value) { + TreeEntryNode target = nodes.get(key); + if (ObjectUtil.isNotNull(target)) { + final V oldVal = target.getValue(); + target.setValue(value); + return target.copy(oldVal); + } + target = new TreeEntryNode<>(null, key, value); + nodes.put(key, target); + return null; + } + + /** + * 同时添加父子节点： + *
    + *
  • 若{@code parentKey}或{@code childKey}对应的节点不存在，则会根据键值创建一个对应的节点；
    • + *
  • 若{@code parentKey}或{@code childKey}对应的节点存在，则会更新对应节点的值；
    • + *
+ * 该操作等同于： + * 
+	 *     TreeEntry<K, V>  parent = putNode(parentKey, parentValue);
+	 *     TreeEntry<K, V>  child = putNode(childKey, childValue);
+	 *     linkNodes(parentKey, childKey);
+	 *
+ * + * @param parentKey 父节点的key + * @param parentValue 父节点的value + * @param childKey 子节点的key + * @param childValue 子节点的值 + */ + @Override + public void putLinkedNodes(K parentKey, V parentValue, K childKey, V childValue) { + linkNodes(parentKey, childKey, (parent, child) -> { + parent.setValue(parentValue); + child.setValue(childValue); + }); + } + + /** + * 添加子节点，并为子节点指定父节点： + *
    + *
  • 若{@code parentKey}或{@code childKey}对应的节点不存在，则会根据键值创建一个对应的节点；
    • + *
  • 若{@code parentKey}或{@code childKey}对应的节点存在，则会更新对应节点的值；
    • + *
+ * + * @param parentKey 父节点的key + * @param childKey 子节点的key + * @param childValue 子节点的值 + */ + @Override + public void putLinkedNodes(K parentKey, K childKey, V childValue) { + linkNodes(parentKey, childKey, (parent, child) -> child.setValue(childValue)); + } + + /** + * 为指定的节点建立父子关系，若{@code parentKey}或{@code childKey}对应节点不存在，则会创建一个对应的值为null的空节点 + * + * @param parentKey 父节点的key + * @param childKey 子节点的key + * @param consumer 对父节点和子节点的操作，允许为null + */ + @Override + public void linkNodes(K parentKey, K childKey, BiConsumer, TreeEntry> consumer) { + consumer = ObjectUtil.defaultIfNull(consumer, (parent, child) -> { + }); + final TreeEntryNode parentNode = nodes.computeIfAbsent(parentKey, t -> new TreeEntryNode<>(null, t)); + TreeEntryNode childNode = nodes.get(childKey); + + // 1.子节点不存在 + if (ObjectUtil.isNull(childNode)) { + childNode = new TreeEntryNode<>(parentNode, childKey); + consumer.accept(parentNode, childNode); + nodes.put(childKey, childNode); + return; + } + + // 2.子节点存在，且已经是该父节点的子节点了 + if (ObjectUtil.equals(parentNode, childNode.getDeclaredParent())) { + consumer.accept(parentNode, childNode); + return; + } + + // 3.子节点存在，但是未与其他节点构成父子关系 + if (false == childNode.hasParent()) { + parentNode.addChild(childNode); + } + // 4.子节点存在，且已经与其他节点构成父子关系，但是允许子节点直接修改其父节点 + else if (allowOverrideParent) { + childNode.getDeclaredParent().removeDeclaredChild(childNode.getKey()); + parentNode.addChild(childNode); + } + // 5.子节点存在，且已经与其他节点构成父子关系，但是不允许子节点直接修改其父节点 + else { + throw new IllegalArgumentException(StrUtil.format( + "[{}] has been used as child of [{}], can not be overwrite as child of [{}]", + childNode.getKey(), childNode.getDeclaredParent().getKey(), parentKey + )); + } + consumer.accept(parentNode, childNode); + } + + /** + * 移除指定父节点与其直接关联的子节点间的引用关系，但是不会将该节点从集合中删除 + * + * @param parentKey 父节点的key + * @param childKey 子节点 + */ + @Override + public void unlinkNode(K parentKey, K childKey) { + final TreeEntryNode childNode = nodes.get(childKey); + if (ObjectUtil.isNull(childNode)) { + return; + } + if (childNode.hasParent()) { + childNode.getDeclaredParent().removeDeclaredChild(childNode.getKey()); + } + } + + /** + * 树节点 + * + * @param key类型 + * @author huangchengxing + */ + public static class TreeEntryNode implements TreeEntry { + + /** + * 根节点 + */ + private TreeEntryNode root; + + /** + * 父节点 + */ + private TreeEntryNode parent; + + /** + * 权重，表示到根节点的距离 + */ + private int weight; + + /** + * 子节点 + */ + private final Map> children; + + /** + * key + */ + private final K key; + + /** + * 值 + */ + private V value; + + /** + * 创建一个节点 + * + * @param parent 节点的父节点 + * @param key 节点的key + */ + public TreeEntryNode(TreeEntryNode parent, K key) { + this(parent, key, null); + } + + /** + * 创建一个节点 + * + * @param parent 节点的父节点 + * @param key 节点的key + * @param value 节点的value + */ + public TreeEntryNode(TreeEntryNode parent, K key, V value) { + this.parent = parent; + this.key = key; + this.value = value; + this.children = new LinkedHashMap<>(); + if (ObjectUtil.isNull(parent)) { + this.root = this; + this.weight = 0; + } else { + parent.addChild(this); + this.weight = parent.weight + 1; + this.root = parent.root; + } + } + + /** + * 获取当前节点的key + * + * @return 节点的key + */ + @Override + public K getKey() { + return key; + } + + /** + * 获取当前节点与根节点的距离 + * + * @return 当前节点与根节点的距离 + */ + @Override + public int getWeight() { + return weight; + } + + /** + * 获取节点的value + * + * @return 节点的value + */ + @Override + public V getValue() { + return value; + } + + /** + * 设置节点的value + * + * @param value 节点的value + * @return 节点的旧value + */ + @Override + public V setValue(V value) { + final V oldVal = getValue(); + this.value = value; + return oldVal; + } + + // ================== 父节点的操作 ================== + + /** + * 从当前节点开始，向上递归当前节点的父节点 + * + * @param includeCurrent 是否处理当前节点 + * @param consumer 对节点的操作 + * @param breakTraverse 是否终止遍历 + * @return 遍历到的最后一个节点 + */ + TreeEntryNode traverseParentNodes( + boolean includeCurrent, Consumer> consumer, Predicate> breakTraverse) { + breakTraverse = ObjectUtil.defaultIfNull(breakTraverse, a -> n -> false); + TreeEntryNode curr = includeCurrent ? this : this.parent; + while (ObjectUtil.isNotNull(curr)) { + consumer.accept(curr); + if (breakTraverse.test(curr)) { + break; + } + curr = curr.parent; + } + return curr; + } + + /** + * 当前节点是否为根节点 + * + * @return 当前节点是否为根节点 + */ + public boolean isRoot() { + return getRoot() == this; + } + + /** + * 获取以当前节点作为叶子节点的树结构，然后获取该树结构的根节点 + * + * @return 根节点 + */ + @Override + public TreeEntryNode getRoot() { + if (ObjectUtil.isNotNull(this.root)) { + return this.root; + } else { + this.root = traverseParentNodes(true, p -> { + }, p -> !p.hasParent()); + } + return this.root; + } + + /** + * 获取当前节点直接关联的父节点 + * + * @return 父节点，当节点不存在对应父节点时返回null + */ + @Override + public TreeEntryNode getDeclaredParent() { + return parent; + } + + /** + * 获取以当前节点作为叶子节点的树结构，然后获取该树结构中当前节点的指定父节点 + * + * @param key 指定父节点的key + * @return 指定父节点，当不存在时返回null + */ + @Override + public TreeEntryNode getParent(K key) { + return traverseParentNodes(false, p -> { + }, p -> p.equalsKey(key)); + } + + /** + * 获取以当前节点作为根节点的树结构，然后遍历所有节点 + * + * @param includeSelf 是否处理当前节点 + * @param nodeConsumer 对节点的处理 + */ + @Override + public void forEachChild(boolean includeSelf, Consumer> nodeConsumer) { + traverseChildNodes(includeSelf, (index, child) -> nodeConsumer.accept(child), null); + } + + /** + * 指定key与当前节点的key是否相等 + * + * @param key 要比较的key + * @return 是否key一致 + */ + public boolean equalsKey(K key) { + return ObjectUtil.equal(getKey(), key); + } + + // ================== 子节点的操作 ================== + + /** + * 从当前节点开始，按广度优先向下遍历当前节点的所有子节点 + * + * @param includeCurrent 是否包含当前节点 + * @param consumer 对节点与节点和当前节点的距离的操作，当{code includeCurrent}为false时下标从1开始，否则从0开始 + * @param breakTraverse 是否终止遍历，为null时默认总是返回{@code true} + * @return 遍历到的最后一个节点 + */ + TreeEntryNode traverseChildNodes( + boolean includeCurrent, BiConsumer> consumer, BiPredicate> breakTraverse) { + breakTraverse = ObjectUtil.defaultIfNull(breakTraverse, (i, n) -> false); + final Deque>> keyNodeDeque = CollUtil.newLinkedList(CollUtil.newArrayList(this)); + boolean needProcess = includeCurrent; + int index = includeCurrent ? 0 : 1; + TreeEntryNode lastNode = null; + while (!keyNodeDeque.isEmpty()) { + final List> curr = keyNodeDeque.removeFirst(); + final List> next = new ArrayList<>(); + for (final TreeEntryNode node : curr) { + if (needProcess) { + consumer.accept(index, node); + if (breakTraverse.test(index, node)) { + return node; + } + } else { + needProcess = true; + } + CollUtil.addAll(next, node.children.values()); + } + if (!next.isEmpty()) { + keyNodeDeque.addLast(next); + } + lastNode = CollUtil.getLast(next); + index++; + } + return lastNode; + } + + + /** + * 添加子节点 + * + * @param child 子节点 + * @throws IllegalArgumentException 当要添加的子节点已经是其自身父节点时抛出 + */ + void addChild(TreeEntryNode child) { + if (containsChild(child.key)) { + return; + } + + // 检查循环引用 + traverseParentNodes(true, s -> Assert.notEquals( + s.key, child.key, + "circular reference between [{}] and [{}]!", + s.key, this.key + ), null); + + // 调整该节点的信息 + child.parent = this; + child.traverseChildNodes(true, (i, c) -> { + c.root = getRoot(); + c.weight = i + getWeight() + 1; + }, null); + + // 将该节点添加为当前节点的子节点 + children.put(child.key, child); + } + + /** + * 移除子节点 + * + * @param key 子节点 + */ + void removeDeclaredChild(K key) { + final TreeEntryNode child = children.get(key); + if (ObjectUtil.isNull(child)) { + return; + } + + // 断开该节点与其父节点的关系 + this.children.remove(key); + + // 重置子节点及其下属节点的相关属性 + child.parent = null; + child.traverseChildNodes(true, (i, c) -> { + c.root = child; + c.weight = i; + }, null); + } + + /** + * 获取以当前节点作为根节点的树结构，然后获取该树结构中的当前节点的指定子节点 + * + * @param key 指定子节点的key + * @return 节点 + */ + @Override + public TreeEntryNode getChild(K key) { + return traverseChildNodes(false, (i, c) -> { + }, (i, c) -> c.equalsKey(key)); + } + + /** + * 获取当前节点直接关联的子节点 + * + * @return 节点 + */ + @Override + public Map> getDeclaredChildren() { + return new LinkedHashMap<>(this.children); + } + + /** + * 获取以当前节点作为根节点的树结构，然后按广度优先获取该树结构中的当前节点的全部子节点 + * + * @return 节点 + */ + @Override + public Map> getChildren() { + final Map> childrenMap = new LinkedHashMap<>(); + traverseChildNodes(false, (i, c) -> childrenMap.put(c.getKey(), c), null); + return childrenMap; + } + + /** + * 移除对子节点、父节点与根节点的全部引用 + */ + void clear() { + this.root = null; + this.children.clear(); + this.parent = null; + } + + /** + * 比较目标对象与当前{@link TreeEntry}是否相等。
+ * 默认只要{@link TreeEntry#getKey()}的返回值相同，即认为两者相等 + * + * @param o 目标对象 + * @return 是否 + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || this.getClass().equals(o.getClass()) || ClassUtil.isAssignable(this.getClass(), o.getClass())) { + return false; + } + final TreeEntry treeEntry = (TreeEntry) o; + return ObjectUtil.equals(this.getKey(), treeEntry.getKey()); + } + + /** + * 返回当前{@link TreeEntry}的哈希值。
+ * 默认总是返回{@link TreeEntry#getKey()}的哈希值 + * + * @return 哈希值 + */ + @Override + public int hashCode() { + return Objects.hash(getKey()); + } + + /** + * 复制一个当前节点 + * + * @param value 复制的节点的值 + * @return 节点 + */ + TreeEntryNode copy(V value) { + TreeEntryNode copiedNode = new TreeEntryNode<>(this.parent, this.key, ObjectUtil.defaultIfNull(value, this.value)); + copiedNode.children.putAll(children); + return copiedNode; + } + + } + + /** + * {@link java.util.Map.Entry}包装类 + * + * @param key类型 + * @param value类型 + * @param 包装的{@link TreeEntry}类型 + * @see #entrySet() + * @see #values() + */ + public static class EntryNodeWrapper> implements Map.Entry> { + private final N entryNode; + + EntryNodeWrapper(N entryNode) { + this.entryNode = entryNode; + } + + @Override + public K getKey() { + return entryNode.getKey(); + } + + @Override + public TreeEntry getValue() { + return entryNode; + } + + @Override + public TreeEntry setValue(TreeEntry value) { + throw new UnsupportedOperationException(); + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/MapBuilder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/MapBuilder.java new file mode 100644 index 0000000..5449e8e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/MapBuilder.java @@ -0,0 +1,188 @@ +package aiyh.utils.tool.cn.hutool.core.map; + + +import aiyh.utils.tool.cn.hutool.core.builder.Builder; + +import java.util.Map; +import java.util.function.Supplier; + +/** + * Map创建类 + * + * @param Key类型 + * @param Value类型 + * @since 3.1.1 + */ +public class MapBuilder implements Builder> { + private static final long serialVersionUID = 1L; + + private final Map map; + + /** + * 创建Builder，默认HashMap实现 + * + * @param Key类型 + * @param Value类型 + * @return MapBuilder + * @since 5.3.0 + */ + public static MapBuilder create() { + return create(false); + } + + /** + * 创建Builder + * + * @param Key类型 + * @param Value类型 + * @param isLinked true创建LinkedHashMap，false创建HashMap + * @return MapBuilder + * @since 5.3.0 + */ + public static MapBuilder create(boolean isLinked) { + return create(MapUtil.newHashMap(isLinked)); + } + + /** + * 创建Builder + * + * @param Key类型 + * @param Value类型 + * @param map Map实体类 + * @return MapBuilder + * @since 3.2.3 + */ + public static MapBuilder create(Map map) { + return new MapBuilder<>(map); + } + + /** + * 链式Map创建类 + * + * @param map 要使用的Map实现类 + */ + public MapBuilder(Map map) { + this.map = map; + } + + /** + * 链式Map创建 + * + * @param k Key类型 + * @param v Value类型 + * @return 当前类 + */ + public MapBuilder put(K k, V v) { + map.put(k, v); + return this; + } + + /** + * 链式Map创建 + * + * @param condition put条件 + * @param k Key类型 + * @param v Value类型 + * @return 当前类 + * @since 5.7.5 + */ + public MapBuilder put(boolean condition, K k, V v) { + if (condition) { + put(k, v); + } + return this; + } + + /** + * 链式Map创建 + * + * @param condition put条件 + * @param k Key类型 + * @param supplier Value类型结果提供方 + * @return 当前类 + * @since 5.7.5 + */ + public MapBuilder put(boolean condition, K k, Supplier supplier) { + if (condition) { + put(k, supplier.get()); + } + return this; + } + + /** + * 链式Map创建 + * + * @param map 合并map + * @return 当前类 + */ + public MapBuilder putAll(Map map) { + this.map.putAll(map); + return this; + } + + /** + * 清空Map + * + * @return this + * @since 5.7.23 + */ + public MapBuilder clear() { + this.map.clear(); + return this; + } + + /** + * 创建后的map + * + * @return 创建后的map + */ + public Map map() { + return map; + } + + /** + * 创建后的map + * + * @return 创建后的map + * @since 3.3.0 + */ + @Override + public Map build() { + return map(); + } + + /** + * 将map转成字符串 + * + * @param separator entry之间的连接符 + * @param keyValueSeparator kv之间的连接符 + * @return 连接字符串 + */ + public String join(String separator, final String keyValueSeparator) { + return MapUtil.join(this.map, separator, keyValueSeparator); + } + + /** + * 将map转成字符串 + * + * @param separator entry之间的连接符 + * @param keyValueSeparator kv之间的连接符 + * @return 连接后的字符串 + */ + public String joinIgnoreNull(String separator, final String keyValueSeparator) { + return MapUtil.joinIgnoreNull(this.map, separator, keyValueSeparator); + } + + /** + * 将map转成字符串 + * + * @param separator entry之间的连接符 + * @param keyValueSeparator kv之间的连接符 + * @param isIgnoreNull 是否忽略null的键和值 + * @return 连接后的字符串 + */ + public String join(String separator, final String keyValueSeparator, boolean isIgnoreNull) { + return MapUtil.join(this.map, separator, keyValueSeparator, isIgnoreNull); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/MapProxy.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/MapProxy.java new file mode 100644 index 0000000..772cd8d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/MapProxy.java @@ -0,0 +1,183 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.getter.OptNullBasicTypeFromObjectGetter; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.BooleanUtil; +import aiyh.utils.tool.cn.hutool.core.util.ClassLoaderUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.lang.reflect.InvocationHandler; +import java.lang.reflect.Method; +import java.lang.reflect.Proxy; +import java.util.Collection; +import java.util.Map; +import java.util.Set; + +/** + * Map代理，提供各种getXXX方法，并提供默认值支持 + * + * @author looly + * @since 3.2.0 + */ +public class MapProxy implements Map, OptNullBasicTypeFromObjectGetter, InvocationHandler, Serializable { + private static final long serialVersionUID = 1L; + + @SuppressWarnings("rawtypes") + Map map; + + /** + * 创建代理Map
+ * 此类对Map做一次包装，提供各种getXXX方法 + * + * @param map 被代理的Map + * @return {@link MapProxy} + */ + public static MapProxy create(Map map) { + return (map instanceof MapProxy) ? (MapProxy) map : new MapProxy(map); + } + + /** + * 构造 + * + * @param map 被代理的Map + */ + public MapProxy(Map map) { + this.map = map; + } + + @Override + public Object getObj(Object key, Object defaultValue) { + final Object value = map.get(key); + return null != value ? value : defaultValue; + } + + @Override + public int size() { + return map.size(); + } + + @Override + public boolean isEmpty() { + return map.isEmpty(); + } + + @Override + public boolean containsKey(Object key) { + return map.containsKey(key); + } + + @Override + public boolean containsValue(Object value) { + return map.containsValue(value); + } + + @Override + public Object get(Object key) { + return map.get(key); + } + + @SuppressWarnings("unchecked") + @Override + public Object put(Object key, Object value) { + return map.put(key, value); + } + + @Override + public Object remove(Object key) { + return map.remove(key); + } + + @SuppressWarnings({"unchecked", "NullableProblems"}) + @Override + public void putAll(Map m) { + map.putAll(m); + } + + @Override + public void clear() { + map.clear(); + } + + @SuppressWarnings({"unchecked", "NullableProblems"}) + @Override + public Set keySet() { + return map.keySet(); + } + + @SuppressWarnings({"unchecked", "NullableProblems"}) + @Override + public Collection values() { + return map.values(); + } + + @SuppressWarnings({"unchecked", "NullableProblems"}) + @Override + public Set> entrySet() { + return map.entrySet(); + } + + @Override + public Object invoke(Object proxy, Method method, Object[] args) { + final Class[] parameterTypes = method.getParameterTypes(); + if (ArrayUtil.isEmpty(parameterTypes)) { + final Class returnType = method.getReturnType(); + if (void.class != returnType) { + // 匹配Getter + final String methodName = method.getName(); + String fieldName = null; + if (methodName.startsWith("get")) { + // 匹配getXXX + fieldName = StrUtil.removePreAndLowerFirst(methodName, 3); + } else if (BooleanUtil.isBoolean(returnType) && methodName.startsWith("is")) { + // 匹配isXXX + fieldName = StrUtil.removePreAndLowerFirst(methodName, 2); + }else if ("hashCode".equals(methodName)) { + return this.hashCode(); + } else if ("toString".equals(methodName)) { + return this.toString(); + } + + if (StrUtil.isNotBlank(fieldName)) { + if (false == this.containsKey(fieldName)) { + // 驼峰不存在转下划线尝试 + fieldName = StrUtil.toUnderlineCase(fieldName); + } + return Convert.convert(method.getGenericReturnType(), this.get(fieldName)); + } + } + + } else if (1 == parameterTypes.length) { + // 匹配Setter + final String methodName = method.getName(); + if (methodName.startsWith("set")) { + final String fieldName = StrUtil.removePreAndLowerFirst(methodName, 3); + if (StrUtil.isNotBlank(fieldName)) { + this.put(fieldName, args[0]); + final Class returnType = method.getReturnType(); + if(returnType.isInstance(proxy)){ + return proxy; + } + } + } else if ("equals".equals(methodName)) { + return this.equals(args[0]); + } + } + + throw new UnsupportedOperationException(method.toGenericString()); + } + + /** + * 将Map代理为指定接口的动态代理对象 + * + * @param 代理的Bean类型 + * @param interfaceClass 接口 + * @return 代理对象 + * @since 4.5.2 + */ + @SuppressWarnings("unchecked") + public T toProxyBean(Class interfaceClass) { + return (T) Proxy.newProxyInstance(ClassLoaderUtil.getClassLoader(), new Class[]{interfaceClass}, this); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/MapUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/MapUtil.java new file mode 100755 index 0000000..35bfd76 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/MapUtil.java @@ -0,0 +1,1488 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.lang.Editor; +import aiyh.utils.tool.cn.hutool.core.lang.Filter; +import aiyh.utils.tool.cn.hutool.core.lang.Pair; +import aiyh.utils.tool.cn.hutool.core.lang.TypeReference; +import aiyh.utils.tool.cn.hutool.core.stream.CollectorUtil; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReflectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.AbstractMap; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Comparator; +import java.util.Date; +import java.util.HashMap; +import java.util.IdentityHashMap; +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.NavigableMap; +import java.util.Set; +import java.util.SortedMap; +import java.util.TreeMap; +import java.util.concurrent.ConcurrentHashMap; +import java.util.function.BiFunction; +import java.util.function.Function; + +/** + * Map相关工具类 + * + * @author Looly + * @since 3.1.1 + */ +public class MapUtil { + + /** + * 默认初始大小 + */ + public static final int DEFAULT_INITIAL_CAPACITY = 16; + /** + * 默认增长因子，当Map的size达到 容量*增长因子时，开始扩充Map + */ + public static final float DEFAULT_LOAD_FACTOR = 0.75f; + + /** + * Map是否为空 + * + * @param map 集合 + * @return 是否为空 + */ + public static boolean isEmpty(Map map) { + return null == map || map.isEmpty(); + } + + /** + * Map是否为非空 + * + * @param map 集合 + * @return 是否为非空 + */ + public static boolean isNotEmpty(Map map) { + return null != map && false == map.isEmpty(); + } + + /** + * 如果提供的集合为{@code null}，返回一个不可变的默认空集合，否则返回原集合
+ * 空集合使用{@link Collections#emptyMap()} + * + * @param 键类型 + * @param 值类型 + * @param set 提供的集合，可能为null + * @return 原集合，若为null返回空集合 + * @since 4.6.3 + */ + public static Map emptyIfNull(Map set) { + return (null == set) ? Collections.emptyMap() : set; + } + + /** + * 如果给定Map为空，返回默认Map + * + * @param 集合类型 + * @param 键类型 + * @param 值类型 + * @param map Map + * @param defaultMap 默认Map + * @return 非空（empty）的原Map或默认Map + * @since 4.6.9 + */ + public static , K, V> T defaultIfEmpty(T map, T defaultMap) { + return isEmpty(map) ? defaultMap : map; + } + + // ----------------------------------------------------------------------------------------------- new HashMap + + /** + * 新建一个HashMap + * + * @param Key类型 + * @param Value类型 + * @return HashMap对象 + */ + public static HashMap newHashMap() { + return new HashMap<>(); + } + + /** + * 新建一个HashMap + * + * @param Key类型 + * @param Value类型 + * @param size 初始大小，由于默认负载因子0.75，传入的size会实际初始大小为size / 0.75 + 1 + * @param isLinked Map的Key是否有序，有序返回 {@link LinkedHashMap}，否则返回 {@link HashMap} + * @return HashMap对象 + * @since 3.0.4 + */ + public static HashMap newHashMap(int size, boolean isLinked) { + final int initialCapacity = (int) (size / DEFAULT_LOAD_FACTOR) + 1; + return isLinked ? new LinkedHashMap<>(initialCapacity) : new HashMap<>(initialCapacity); + } + + /** + * 新建一个HashMap + * + * @param Key类型 + * @param Value类型 + * @param size 初始大小，由于默认负载因子0.75，传入的size会实际初始大小为size / 0.75 + 1 + * @return HashMap对象 + */ + public static HashMap newHashMap(int size) { + return newHashMap(size, false); + } + + /** + * 新建一个HashMap + * + * @param Key类型 + * @param Value类型 + * @param isLinked Map的Key是否有序，有序返回 {@link LinkedHashMap}，否则返回 {@link HashMap} + * @return HashMap对象 + */ + public static HashMap newHashMap(boolean isLinked) { + return newHashMap(DEFAULT_INITIAL_CAPACITY, isLinked); + } + + /** + * 新建TreeMap，Key有序的Map + * + * @param key的类型 + * @param value的类型 + * @param comparator Key比较器 + * @return TreeMap + * @since 3.2.3 + */ + public static TreeMap newTreeMap(Comparator comparator) { + return new TreeMap<>(comparator); + } + + /** + * 新建TreeMap，Key有序的Map + * + * @param key的类型 + * @param value的类型 + * @param map Map + * @param comparator Key比较器 + * @return TreeMap + * @since 3.2.3 + */ + public static TreeMap newTreeMap(Map map, Comparator comparator) { + final TreeMap treeMap = new TreeMap<>(comparator); + if (false == isEmpty(map)) { + treeMap.putAll(map); + } + return treeMap; + } + + /** + * 创建键不重复Map + * + * @param key的类型 + * @param value的类型 + * @param size 初始容量 + * @return {@link IdentityHashMap} + * @since 4.5.7 + */ + public static Map newIdentityMap(int size) { + return new IdentityHashMap<>(size); + } + + /** + * 新建一个初始容量为{@link MapUtil#DEFAULT_INITIAL_CAPACITY} 的ConcurrentHashMap + * + * @param key的类型 + * @param value的类型 + * @return ConcurrentHashMap + */ + public static ConcurrentHashMap newConcurrentHashMap() { + return new ConcurrentHashMap<>(DEFAULT_INITIAL_CAPACITY); + } + + /** + * 新建一个ConcurrentHashMap + * + * @param size 初始容量，当传入的容量小于等于0时，容量为{@link MapUtil#DEFAULT_INITIAL_CAPACITY} + * @param key的类型 + * @param value的类型 + * @return ConcurrentHashMap + */ + public static ConcurrentHashMap newConcurrentHashMap(int size) { + final int initCapacity = size <= 0 ? DEFAULT_INITIAL_CAPACITY : size; + return new ConcurrentHashMap<>(initCapacity); + } + + /** + * 传入一个Map将其转化为ConcurrentHashMap类型 + * + * @param map map + * @param key的类型 + * @param value的类型 + * @return ConcurrentHashMap + */ + public static ConcurrentHashMap newConcurrentHashMap(Map map) { + if (isEmpty(map)) { + return new ConcurrentHashMap<>(DEFAULT_INITIAL_CAPACITY); + } + return new ConcurrentHashMap<>(map); + } + + /** + * 创建Map
+ * 传入抽象Map{@link AbstractMap}和{@link Map}类将默认创建{@link HashMap} + * + * @param map键类型 + * @param map值类型 + * @param mapType map类型 + * @return {@link Map}实例 + */ + @SuppressWarnings("unchecked") + public static Map createMap(Class mapType) { + if (null == mapType || mapType.isAssignableFrom(AbstractMap.class)) { + return new HashMap<>(); + } else { + try { + return (Map) ReflectUtil.newInstance(mapType); + } catch (UtilException e) { + // 不支持的map类型，返回默认的HashMap + return new HashMap<>(); + } + } + } + + // ----------------------------------------------------------------------------------------------- value of + + /** + * 将单一键值对转换为Map + * + * @param 键类型 + * @param 值类型 + * @param key 键 + * @param value 值 + * @return {@link HashMap} + */ + public static HashMap of(K key, V value) { + return of(key, value, false); + } + + /** + * 将单一键值对转换为Map + * + * @param 键类型 + * @param 值类型 + * @param key 键 + * @param value 值 + * @param isOrder 是否有序 + * @return {@link HashMap} + */ + public static HashMap of(K key, V value, boolean isOrder) { + final HashMap map = newHashMap(isOrder); + map.put(key, value); + return map; + } + + /** + * 根据给定的Pair数组创建Map对象 + * + * @param 键类型 + * @param 值类型 + * @param pairs 键值对 + * @return Map + * @since 5.4.1 + * @deprecated 方法容易歧义，请使用 {@code #ofEntries(Entry[])} + */ + @SafeVarargs + @Deprecated + public static Map of(Pair... pairs) { + final Map map = new HashMap<>(); + for (Pair pair : pairs) { + map.put(pair.getKey(), pair.getValue()); + } + return map; + } + + /** + * 根据给定的Pair数组创建Map对象 + * + * @param 键类型 + * @param 值类型 + * @param entries 键值对 + * @return Map + * @see #entry(Object, Object) + * @since 5.8.0 + */ + @SafeVarargs + public static Map ofEntries(Map.Entry... entries) { + final Map map = new HashMap<>(); + for (Map.Entry pair : entries) { + map.put(pair.getKey(), pair.getValue()); + } + return map; + } + + /** + * 将数组转换为Map（HashMap），支持数组元素类型为： + * + * 
+	 * Map.Entry
+	 * 长度大于1的数组（取前两个值），如果不满足跳过此元素
+	 * Iterable 长度也必须大于1（取前两个值），如果不满足跳过此元素
+	 * Iterator 长度也必须大于1（取前两个值），如果不满足跳过此元素
+	 *
+ * + * 
+	 * Map<Object, Object> colorMap = MapUtil.of(new String[][] {
+	 *    { "RED", "#FF0000" },
+	 *    { "GREEN", "#00FF00" },
+	 *    { "BLUE", "#0000FF" }
+	 * });
+	 *
+ *

+ * 参考：commons-lang + * + * @param array 数组。元素类型为Map.Entry、数组、Iterable、Iterator + * @return {@link HashMap} + * @since 3.0.8 + */ + @SuppressWarnings("rawtypes") + public static HashMap of(Object[] array) { + if (array == null) { + return null; + } + final HashMap map = new HashMap<>((int) (array.length * 1.5)); + for (int i = 0; i < array.length; i++) { + final Object object = array[i]; + if (object instanceof Map.Entry) { + Map.Entry entry = (Map.Entry) object; + map.put(entry.getKey(), entry.getValue()); + } else if (object instanceof Object[]) { + final Object[] entry = (Object[]) object; + if (entry.length > 1) { + map.put(entry[0], entry[1]); + } + } else if (object instanceof Iterable) { + final Iterator iter = ((Iterable) object).iterator(); + if (iter.hasNext()) { + final Object key = iter.next(); + if (iter.hasNext()) { + final Object value = iter.next(); + map.put(key, value); + } + } + } else if (object instanceof Iterator) { + final Iterator iter = ((Iterator) object); + if (iter.hasNext()) { + final Object key = iter.next(); + if (iter.hasNext()) { + final Object value = iter.next(); + map.put(key, value); + } + } + } else { + throw new IllegalArgumentException(StrUtil.format("Array element {}, '{}', is not type of Map.Entry or Array or Iterable or Iterator", i, object)); + } + } + return map; + } + + /** + * 行转列，合并相同的键，值合并为列表
+ * 将Map列表中相同key的值组成列表做为Map的value
+ * 是{@link #toMapList(Map)}的逆方法
+ * 比如传入数据： + * + * 

+	 * [
+	 *  {a: 1, b: 1, c: 1}
+	 *  {a: 2, b: 2}
+	 *  {a: 3, b: 3}
+	 *  {a: 4}
+	 * ]
+	 *
+ *

+ * 结果是： + * + * 

+	 * {
+	 *   a: [1,2,3,4]
+	 *   b: [1,2,3,]
+	 *   c: [1]
+	 * }
+	 *
+ * + * @param 键类型 + * @param 值类型 + * @param mapList Map列表 + * @return Map + */ + public static Map> toListMap(Iterable> mapList) { + final HashMap> resultMap = new HashMap<>(); + if (CollUtil.isEmpty(mapList)) { + return resultMap; + } + + Set> entrySet; + for (Map map : mapList) { + entrySet = map.entrySet(); + K key; + List valueList; + for (Entry entry : entrySet) { + key = entry.getKey(); + valueList = resultMap.get(key); + if (null == valueList) { + valueList = CollUtil.newArrayList(entry.getValue()); + resultMap.put(key, valueList); + } else { + valueList.add(entry.getValue()); + } + } + } + + return resultMap; + } + + /** + * 列转行。将Map中值列表分别按照其位置与key组成新的map。
+ * 是{@link #toListMap(Iterable)}的逆方法
+ * 比如传入数据： + * + * 
+	 * {
+	 *   a: [1,2,3,4]
+	 *   b: [1,2,3,]
+	 *   c: [1]
+	 * }
+	 *
+ *

+ * 结果是： + * + * 

+	 * [
+	 *  {a: 1, b: 1, c: 1}
+	 *  {a: 2, b: 2}
+	 *  {a: 3, b: 3}
+	 *  {a: 4}
+	 * ]
+	 *
+ * + * @param 键类型 + * @param 值类型 + * @param listMap 列表Map + * @return Map列表 + */ + public static List> toMapList(Map> listMap) { + final List> resultList = new ArrayList<>(); + if (isEmpty(listMap)) { + return resultList; + } + + boolean isEnd;// 是否结束。标准是元素列表已耗尽 + int index = 0;// 值索引 + Map map; + do { + isEnd = true; + map = new HashMap<>(); + List vList; + int vListSize; + for (Entry> entry : listMap.entrySet()) { + vList = CollUtil.newArrayList(entry.getValue()); + vListSize = vList.size(); + if (index < vListSize) { + map.put(entry.getKey(), vList.get(index)); + if (index != vListSize - 1) { + // 当值列表中还有更多值（非最后一个），继续循环 + isEnd = false; + } + } + } + if (false == map.isEmpty()) { + resultList.add(map); + } + index++; + } while (false == isEnd); + + return resultList; + } + + /** + * 根据给定的entry列表，根据entry的key进行分组; + * + * @param 键类型 + * @param 值类型 + * @param entries entry列表 + * @return entries + */ + public static Map> grouping(Iterable> entries) { + final Map> map = new HashMap<>(); + if (CollUtil.isEmpty(entries)) { + return map; + } + for (final Map.Entry pair : entries) { + final List values = map.computeIfAbsent(pair.getKey(), k -> new ArrayList<>()); + values.add(pair.getValue()); + } + return map; + } + + /** + * 将已知Map转换为key为驼峰风格的Map
+ * 如果KEY为非String类型，保留原值 + * + * @param key的类型 + * @param value的类型 + * @param map 原Map + * @return 驼峰风格Map + * @since 3.3.1 + */ + public static Map toCamelCaseMap(Map map) { + return (map instanceof LinkedHashMap) ? new CamelCaseLinkedMap<>(map) : new CamelCaseMap<>(map); + } + + /** + * 将键值对转换为二维数组，第一维是key，第二纬是value + * + * @param map map + * @return 数组 + * @since 4.1.9 + */ + public static Object[][] toObjectArray(Map map) { + if (map == null) { + return null; + } + final Object[][] result = new Object[map.size()][2]; + if (map.isEmpty()) { + return result; + } + int index = 0; + for (Entry entry : map.entrySet()) { + result[index][0] = entry.getKey(); + result[index][1] = entry.getValue(); + index++; + } + return result; + } + + // ----------------------------------------------------------------------------------------------- join + + /** + * 将map转成字符串 + * + * @param 键类型 + * @param 值类型 + * @param map Map + * @param separator entry之间的连接符 + * @param keyValueSeparator kv之间的连接符 + * @param otherParams 其它附加参数字符串（例如密钥） + * @return 连接字符串 + * @since 3.1.1 + */ + public static String join(Map map, String separator, String keyValueSeparator, String... otherParams) { + return join(map, separator, keyValueSeparator, false, otherParams); + } + + /** + * 根据参数排序后拼接为字符串，常用于签名 + * + * @param params 参数 + * @param separator entry之间的连接符 + * @param keyValueSeparator kv之间的连接符 + * @param isIgnoreNull 是否忽略null的键和值 + * @param otherParams 其它附加参数字符串（例如密钥） + * @return 签名字符串 + * @since 5.0.4 + */ + public static String sortJoin(Map params, String separator, String keyValueSeparator, boolean isIgnoreNull, + String... otherParams) { + return join(sort(params), separator, keyValueSeparator, isIgnoreNull, otherParams); + } + + /** + * 将map转成字符串，忽略null的键和值 + * + * @param 键类型 + * @param 值类型 + * @param map Map + * @param separator entry之间的连接符 + * @param keyValueSeparator kv之间的连接符 + * @param otherParams 其它附加参数字符串（例如密钥） + * @return 连接后的字符串 + * @since 3.1.1 + */ + public static String joinIgnoreNull(Map map, String separator, String keyValueSeparator, String... otherParams) { + return join(map, separator, keyValueSeparator, true, otherParams); + } + + /** + * 将map转成字符串 + * + * @param 键类型 + * @param 值类型 + * @param map Map，为空返回otherParams拼接 + * @param separator entry之间的连接符 + * @param keyValueSeparator kv之间的连接符 + * @param isIgnoreNull 是否忽略null的键和值 + * @param otherParams 其它附加参数字符串（例如密钥） + * @return 连接后的字符串，map和otherParams为空返回"" + * @since 3.1.1 + */ + public static String join(Map map, String separator, String keyValueSeparator, boolean isIgnoreNull, String... otherParams) { + final StringBuilder strBuilder = StrUtil.builder(); + boolean isFirst = true; + if (isNotEmpty(map)) { + for (Entry entry : map.entrySet()) { + if (false == isIgnoreNull || entry.getKey() != null && entry.getValue() != null) { + if (isFirst) { + isFirst = false; + } else { + strBuilder.append(separator); + } + strBuilder.append(Convert.toStr(entry.getKey())).append(keyValueSeparator).append(Convert.toStr(entry.getValue())); + } + } + } + // 补充其它字符串到末尾，默认无分隔符 + if (ArrayUtil.isNotEmpty(otherParams)) { + for (String otherParam : otherParams) { + strBuilder.append(otherParam); + } + } + return strBuilder.toString(); + } + + // ----------------------------------------------------------------------------------------------- filter + + /** + * 编辑Map
+ * 编辑过程通过传入的Editor实现来返回需要的元素内容，这个Editor实现可以实现以下功能： + * + * 
+	 * 1、过滤出需要的对象，如果返回{@code null}表示这个元素对象抛弃
+	 * 2、修改元素对象，返回集合中为修改后的对象
+	 *
+ * + * @param Key类型 + * @param Value类型 + * @param map Map + * @param editor 编辑器接口 + * @return 编辑后的Map + */ + @SuppressWarnings("unchecked") + public static Map edit(Map map, Editor> editor) { + if (null == map || null == editor) { + return map; + } + + Map map2 = ReflectUtil.newInstanceIfPossible(map.getClass()); + if (null == map2) { + map2 = new HashMap<>(map.size(), 1f); + } + if (isEmpty(map)) { + return map2; + } + + Entry modified; + for (Entry entry : map.entrySet()) { + modified = editor.edit(entry); + if (null != modified) { + map2.put(modified.getKey(), modified.getValue()); + } + } + return map2; + } + + /** + * 过滤
+ * 过滤过程通过传入的Editor实现来返回需要的元素内容，这个Filter实现可以实现以下功能： + * + * 
+	 * 1、过滤出需要的对象，如果返回null表示这个元素对象抛弃
+	 *
+ * + * @param Key类型 + * @param Value类型 + * @param map Map + * @param filter 过滤器接口，{@code null}返回原Map + * @return 过滤后的Map + * @since 3.1.0 + */ + public static Map filter(Map map, Filter> filter) { + if (null == map || null == filter) { + return map; + } + return edit(map, t -> filter.accept(t) ? t : null); + } + + + /** + * 通过biFunction自定义一个规则，此规则将原Map中的元素转换成新的元素，生成新的Map返回
+ * 变更过程通过传入的 {@link BiFunction} 实现来返回一个值可以为不同类型的 {@link Map} + * + * @param map 原有的map + * @param biFunction {@code lambda}，参数包含{@code key},{@code value}，返回值会作为新的{@code value} + * @param {@code key}的类型 + * @param {@code value}的类型 + * @param 新的，修改后的{@code value}的类型 + * @return 值可以为不同类型的 {@link Map} + * @since 5.8.0 + */ + public static Map map(Map map, BiFunction biFunction) { + if (null == map || null == biFunction) { + return MapUtil.newHashMap(); + } + return map.entrySet().stream().collect(CollectorUtil.toMap(Map.Entry::getKey, m -> biFunction.apply(m.getKey(), m.getValue()), (l, r) -> l)); + } + + /** + * 过滤Map保留指定键值对，如果键不存在跳过 + * + * @param Key类型 + * @param Value类型 + * @param map 原始Map + * @param keys 键列表，{@code null}返回原Map + * @return Map 结果，结果的Map类型与原Map保持一致 + * @since 4.0.10 + */ + @SuppressWarnings("unchecked") + public static Map filter(Map map, K... keys) { + if (null == map || null == keys) { + return map; + } + + Map map2 = ReflectUtil.newInstanceIfPossible(map.getClass()); + if (null == map2) { + map2 = new HashMap<>(map.size(), 1f); + } + if (isEmpty(map)) { + return map2; + } + + for (K key : keys) { + if (map.containsKey(key)) { + map2.put(key, map.get(key)); + } + } + return map2; + } + + /** + * Map的键和值互换 + * 互换键值对不检查值是否有重复，如果有则后加入的元素替换先加入的元素
+ * 值的顺序在HashMap中不确定，所以谁覆盖谁也不确定，在有序的Map中按照先后顺序覆盖，保留最后的值 + * + * @param 键和值类型 + * @param map Map对象，键值类型必须一致 + * @return 互换后的Map + * @see #inverse(Map) + * @since 3.2.2 + */ + public static Map reverse(Map map) { + return edit(map, t -> new Entry() { + + @Override + public T getKey() { + return t.getValue(); + } + + @Override + public T getValue() { + return t.getKey(); + } + + @Override + public T setValue(T value) { + throw new UnsupportedOperationException("Unsupported setValue method !"); + } + }); + } + + /** + * Map的键和值互换
+ * 互换键值对不检查值是否有重复，如果有则后加入的元素替换先加入的元素
+ * 值的顺序在HashMap中不确定，所以谁覆盖谁也不确定，在有序的Map中按照先后顺序覆盖，保留最后的值 + * + * @param 键和值类型 + * @param 键和值类型 + * @param map Map对象，键值类型必须一致 + * @return 互换后的Map + * @since 5.2.6 + */ + public static Map inverse(Map map) { + final Map result = createMap(map.getClass()); + map.forEach((key, value) -> result.put(value, key)); + return result; + } + + /** + * 排序已有Map，Key有序的Map，使用默认Key排序方式（字母顺序） + * + * @param key的类型 + * @param value的类型 + * @param map Map + * @return TreeMap + * @see #newTreeMap(Map, Comparator) + * @since 4.0.1 + */ + public static TreeMap sort(Map map) { + return sort(map, null); + } + + /** + * 排序已有Map，Key有序的Map + * + * @param key的类型 + * @param value的类型 + * @param map Map，为null返回null + * @param comparator Key比较器 + * @return TreeMap，map为null返回null + * @see #newTreeMap(Map, Comparator) + * @since 4.0.1 + */ + public static TreeMap sort(Map map, Comparator comparator) { + if (null == map) { + return null; + } + + if (map instanceof TreeMap) { + // 已经是可排序Map，此时只有比较器一致才返回原map + TreeMap result = (TreeMap) map; + if (null == comparator || comparator.equals(result.comparator())) { + return result; + } + } + + return newTreeMap(map, comparator); + } + + /** + * 按照值排序，可选是否倒序 + * + * @param map 需要对值排序的map + * @param 键类型 + * @param 值类型 + * @param isDesc 是否倒序 + * @return 排序后新的Map + * @since 5.5.8 + */ + public static > Map sortByValue(Map map, boolean isDesc) { + Map result = new LinkedHashMap<>(); + Comparator> entryComparator = Entry.comparingByValue(); + if (isDesc) { + entryComparator = entryComparator.reversed(); + } + map.entrySet().stream().sorted(entryComparator).forEachOrdered(e -> result.put(e.getKey(), e.getValue())); + return result; + } + + /** + * 创建代理Map
+ * {@link MapProxy}对Map做一次包装，提供各种getXXX方法 + * + * @param map 被代理的Map + * @return {@link MapProxy} + * @since 3.2.0 + */ + public static MapProxy createProxy(Map map) { + return MapProxy.create(map); + } + + /** + * 创建Map包装类MapWrapper
+ * {@link MapWrapper}对Map做一次包装 + * + * @param key的类型 + * @param value的类型 + * @param map 被代理的Map + * @return {@link MapWrapper} + * @since 4.5.4 + */ + public static MapWrapper wrap(Map map) { + return new MapWrapper<>(map); + } + + /** + * 将对应Map转换为不可修改的Map + * + * @param map Map + * @param 键类型 + * @param 值类型 + * @return 不修改Map + * @since 5.2.6 + */ + public static Map unmodifiable(Map map) { + return Collections.unmodifiableMap(map); + } + + // ----------------------------------------------------------------------------------------------- builder + + /** + * 创建链接调用map + * + * @param Key类型 + * @param Value类型 + * @return map创建类 + */ + public static MapBuilder builder() { + return builder(new HashMap<>()); + } + + /** + * 创建链接调用map + * + * @param Key类型 + * @param Value类型 + * @param map 实际使用的map + * @return map创建类 + */ + public static MapBuilder builder(Map map) { + return new MapBuilder<>(map); + } + + /** + * 创建链接调用map + * + * @param Key类型 + * @param Value类型 + * @param k key + * @param v value + * @return map创建类 + */ + public static MapBuilder builder(K k, V v) { + return (builder(new HashMap())).put(k, v); + } + + /** + * 获取Map的部分key生成新的Map + * + * @param Key类型 + * @param Value类型 + * @param map Map + * @param keys 键列表 + * @return 新Map，只包含指定的key + * @since 4.0.6 + */ + @SuppressWarnings("unchecked") + public static Map getAny(Map map, final K... keys) { + return filter(map, entry -> ArrayUtil.contains(keys, entry.getKey())); + } + + /** + * 去掉Map中指定key的键值对，修改原Map + * + * @param Key类型 + * @param Value类型 + * @param map Map + * @param keys 键列表 + * @return 修改后的key + * @since 5.0.5 + */ + @SuppressWarnings("unchecked") + public static Map removeAny(Map map, final K... keys) { + for (K key : keys) { + map.remove(key); + } + return map; + } + + /** + * 获取Map指定key的值，并转换为字符串 + * + * @param map Map + * @param key 键 + * @return 值 + * @since 4.0.6 + */ + public static String getStr(Map map, Object key) { + return get(map, key, String.class); + } + + /** + * 获取Map指定key的值，并转换为字符串 + * + * @param map Map + * @param key 键 + * @param defaultValue 默认值 + * @return 值 + * @since 5.3.11 + */ + public static String getStr(Map map, Object key, String defaultValue) { + return get(map, key, String.class, defaultValue); + } + + /** + * 获取Map指定key的值，并转换为Integer + * + * @param map Map + * @param key 键 + * @return 值 + * @since 4.0.6 + */ + public static Integer getInt(Map map, Object key) { + return get(map, key, Integer.class); + } + + /** + * 获取Map指定key的值，并转换为Integer + * + * @param map Map + * @param key 键 + * @param defaultValue 默认值 + * @return 值 + * @since 5.3.11 + */ + public static Integer getInt(Map map, Object key, Integer defaultValue) { + return get(map, key, Integer.class, defaultValue); + } + + /** + * 获取Map指定key的值，并转换为Double + * + * @param map Map + * @param key 键 + * @return 值 + * @since 4.0.6 + */ + public static Double getDouble(Map map, Object key) { + return get(map, key, Double.class); + } + + /** + * 获取Map指定key的值，并转换为Double + * + * @param map Map + * @param key 键 + * @param defaultValue 默认值 + * @return 值 + * @since 5.3.11 + */ + public static Double getDouble(Map map, Object key, Double defaultValue) { + return get(map, key, Double.class, defaultValue); + } + + /** + * 获取Map指定key的值，并转换为Float + * + * @param map Map + * @param key 键 + * @return 值 + * @since 4.0.6 + */ + public static Float getFloat(Map map, Object key) { + return get(map, key, Float.class); + } + + /** + * 获取Map指定key的值，并转换为Float + * + * @param map Map + * @param key 键 + * @param defaultValue 默认值 + * @return 值 + * @since 5.3.11 + */ + public static Float getFloat(Map map, Object key, Float defaultValue) { + return get(map, key, Float.class, defaultValue); + } + + /** + * 获取Map指定key的值，并转换为Short + * + * @param map Map + * @param key 键 + * @return 值 + * @since 4.0.6 + */ + public static Short getShort(Map map, Object key) { + return get(map, key, Short.class); + } + + /** + * 获取Map指定key的值，并转换为Short + * + * @param map Map + * @param key 键 + * @param defaultValue 默认值 + * @return 值 + * @since 5.3.11 + */ + public static Short getShort(Map map, Object key, Short defaultValue) { + return get(map, key, Short.class, defaultValue); + } + + /** + * 获取Map指定key的值，并转换为Bool + * + * @param map Map + * @param key 键 + * @return 值 + * @since 4.0.6 + */ + public static Boolean getBool(Map map, Object key) { + return get(map, key, Boolean.class); + } + + /** + * 获取Map指定key的值，并转换为Bool + * + * @param map Map + * @param key 键 + * @param defaultValue 默认值 + * @return 值 + * @since 5.3.11 + */ + public static Boolean getBool(Map map, Object key, Boolean defaultValue) { + return get(map, key, Boolean.class, defaultValue); + } + + /** + * 获取Map指定key的值，并转换为Character + * + * @param map Map + * @param key 键 + * @return 值 + * @since 4.0.6 + */ + public static Character getChar(Map map, Object key) { + return get(map, key, Character.class); + } + + /** + * 获取Map指定key的值，并转换为Character + * + * @param map Map + * @param key 键 + * @param defaultValue 默认值 + * @return 值 + * @since 5.3.11 + */ + public static Character getChar(Map map, Object key, Character defaultValue) { + return get(map, key, Character.class, defaultValue); + } + + /** + * 获取Map指定key的值，并转换为Long + * + * @param map Map + * @param key 键 + * @return 值 + * @since 4.0.6 + */ + public static Long getLong(Map map, Object key) { + return get(map, key, Long.class); + } + + /** + * 获取Map指定key的值，并转换为Long + * + * @param map Map + * @param key 键 + * @param defaultValue 默认值 + * @return 值 + * @since 5.3.11 + */ + public static Long getLong(Map map, Object key, Long defaultValue) { + return get(map, key, Long.class, defaultValue); + } + + /** + * 获取Map指定key的值，并转换为{@link Date} + * + * @param map Map + * @param key 键 + * @return 值 + * @since 4.1.2 + */ + public static Date getDate(Map map, Object key) { + return get(map, key, Date.class); + } + + /** + * 获取Map指定key的值，并转换为{@link Date} + * + * @param map Map + * @param key 键 + * @param defaultValue 默认值 + * @return 值 + * @since 4.1.2 + */ + public static Date getDate(Map map, Object key, Date defaultValue) { + return get(map, key, Date.class, defaultValue); + } + + /** + * 获取Map指定key的值，并转换为指定类型 + * + * @param 目标值类型 + * @param map Map + * @param key 键 + * @param type 值类型 + * @return 值 + * @since 4.0.6 + */ + public static T get(Map map, Object key, Class type) { + return get(map, key, type, null); + } + + /** + * 获取Map指定key的值，并转换为指定类型 + * + * @param 目标值类型 + * @param map Map + * @param key 键 + * @param type 值类型 + * @param defaultValue 默认值 + * @return 值 + * @since 5.3.11 + */ + public static T get(Map map, Object key, Class type, T defaultValue) { + return null == map ? defaultValue : Convert.convert(type, map.get(key), defaultValue); + } + + /** + * 获取Map指定key的值，并转换为指定类型，此方法在转换失败后不抛异常，返回null。 + * + * @param 目标值类型 + * @param map Map + * @param key 键 + * @param type 值类型 + * @param defaultValue 默认值 + * @return 值 + * @since 5.5.3 + */ + public static T getQuietly(Map map, Object key, Class type, T defaultValue) { + return null == map ? defaultValue : Convert.convertQuietly(type, map.get(key), defaultValue); + } + + /** + * 获取Map指定key的值，并转换为指定类型 + * + * @param 目标值类型 + * @param map Map + * @param key 键 + * @param type 值类型 + * @return 值 + * @since 4.5.12 + */ + public static T get(Map map, Object key, TypeReference type) { + return get(map, key, type, null); + } + + /** + * 获取Map指定key的值，并转换为指定类型 + * + * @param 目标值类型 + * @param map Map + * @param key 键 + * @param type 值类型 + * @param defaultValue 默认值 + * @return 值 + * @since 5.3.11 + */ + public static T get(Map map, Object key, TypeReference type, T defaultValue) { + return null == map ? defaultValue : Convert.convert(type, map.get(key), defaultValue); + } + + /** + * 获取Map指定key的值，并转换为指定类型，转换失败后返回null，不抛异常 + * + * @param 目标值类型 + * @param map Map + * @param key 键 + * @param type 值类型 + * @param defaultValue 默认值 + * @return 值 + * @since 5.5.3 + */ + public static T getQuietly(Map map, Object key, TypeReference type, T defaultValue) { + return null == map ? defaultValue : Convert.convertQuietly(type, map.get(key), defaultValue); + } + + /** + * 重命名键
+ * 实现方式为一处然后重新put，当旧的key不存在直接返回
+ * 当新的key存在，抛出{@link IllegalArgumentException} 异常 + * + * @param key的类型 + * @param value的类型 + * @param map Map + * @param oldKey 原键 + * @param newKey 新键 + * @return map + * @throws IllegalArgumentException 新key存在抛出此异常 + * @since 4.5.16 + */ + public static Map renameKey(Map map, K oldKey, K newKey) { + if (isNotEmpty(map) && map.containsKey(oldKey)) { + if (map.containsKey(newKey)) { + throw new IllegalArgumentException(StrUtil.format("The key '{}' exist !", newKey)); + } + map.put(newKey, map.remove(oldKey)); + } + return map; + } + + /** + * 去除Map中值为{@code null}的键值对
+ * 注意：此方法在传入的Map上直接修改。 + * + * @param key的类型 + * @param value的类型 + * @param map Map + * @return map + * @since 4.6.5 + */ + public static Map removeNullValue(Map map) { + if (isEmpty(map)) { + return map; + } + + final Iterator> iter = map.entrySet().iterator(); + Entry entry; + while (iter.hasNext()) { + entry = iter.next(); + if (null == entry.getValue()) { + iter.remove(); + } + } + + return map; + } + + /** + * 返回一个空Map + * + * @param 键类型 + * @param 值类型 + * @return 空Map + * @see Collections#emptyMap() + * @since 5.3.1 + */ + public static Map empty() { + return Collections.emptyMap(); + } + + /** + * 根据传入的Map类型不同，返回对应类型的空Map，支持类型包括： + * + * 
+	 *     1. NavigableMap
+	 *     2. SortedMap
+	 *     3. Map
+	 *
+ * + * @param 键类型 + * @param 值类型 + * @param Map类型 + * @param mapClass Map类型，null返回默认的Map + * @return 空Map + * @since 5.3.1 + */ + @SuppressWarnings("unchecked") + public static > T empty(Class mapClass) { + if (null == mapClass) { + return (T) Collections.emptyMap(); + } + if (NavigableMap.class == mapClass) { + return (T) Collections.emptyNavigableMap(); + } else if (SortedMap.class == mapClass) { + return (T) Collections.emptySortedMap(); + } else if (Map.class == mapClass) { + return (T) Collections.emptyMap(); + } + + // 不支持空集合的集合类型 + throw new IllegalArgumentException(StrUtil.format("[{}] is not support to get empty!", mapClass)); + } + + /** + * 清除一个或多个Map集合内的元素，每个Map调用clear()方法 + * + * @param maps 一个或多个Map + */ + public static void clear(Map... maps) { + for (Map map : maps) { + if (isNotEmpty(map)) { + map.clear(); + } + } + } + + /** + * 从Map中获取指定键列表对应的值列表
+ * 如果key在map中不存在或key对应值为null，则返回值列表对应位置的值也为null + * + * @param 键类型 + * @param 值类型 + * @param map {@link Map} + * @param keys 键列表 + * @return 值列表 + * @since 5.7.20 + */ + public static ArrayList valuesOfKeys(Map map, Iterator keys) { + final ArrayList values = new ArrayList<>(); + while (keys.hasNext()) { + values.add(map.get(keys.next())); + } + return values; + } + + /** + * 将键和值转换为{@link AbstractMap.SimpleImmutableEntry}
+ * 返回的Entry不可变 + * + * @param key 键 + * @param value 值 + * @param 键类型 + * @param 值类型 + * @return {@link AbstractMap.SimpleImmutableEntry} + * @since 5.8.0 + */ + public static Map.Entry entry(K key, V value) { + return entry(key, value, true); + } + + /** + * 将键和值转换为{@link AbstractMap.SimpleEntry} 或者 {@link AbstractMap.SimpleImmutableEntry} + * + * @param key 键 + * @param value 值 + * @param 键类型 + * @param 值类型 + * @param isImmutable 是否不可变Entry + * @return {@link AbstractMap.SimpleEntry} 或者 {@link AbstractMap.SimpleImmutableEntry} + * @since 5.8.0 + */ + public static Map.Entry entry(K key, V value, boolean isImmutable) { + return isImmutable ? + new AbstractMap.SimpleImmutableEntry<>(key, value) : + new AbstractMap.SimpleEntry<>(key, value); + } + + /** + * 如果 key 对应的 value 不存在，则使用获取 mappingFunction 重新计算后的值，并保存为该 key 的 value，否则返回 value。
+ * 方法来自Dubbo，解决使用ConcurrentHashMap.computeIfAbsent导致的死循环问题。（issues#2349）
+ * A temporary workaround for Java 8 specific performance issue JDK-8161372 .
+ * This class should be removed once we drop Java 8 support. + * + * @param 键类型 + * @param 值类型 + * @param map Map + * @param key 键 + * @param mappingFunction 值不存在时值的生成函数 + * @see https://bugs.openjdk.java.net/browse/JDK-8161372 + * @return 值 + */ + public static V computeIfAbsent(Map map, K key, Function mappingFunction) { + V value = map.get(key); + if (null == value) { + map.putIfAbsent(key, mappingFunction.apply(key)); + value = map.get(key); + } + return value; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/MapWrapper.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/MapWrapper.java new file mode 100755 index 0000000..30fb768 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/MapWrapper.java @@ -0,0 +1,236 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.io.IOException; +import java.io.ObjectInputStream; +import java.io.ObjectOutputStream; +import java.io.Serializable; +import java.util.Collection; +import java.util.Iterator; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.function.BiConsumer; +import java.util.function.BiFunction; +import java.util.function.Function; +import java.util.function.Supplier; + +/** + * Map包装类，通过包装一个已有Map实现特定功能。例如自定义Key的规则或Value规则 + * + * @param 键类型 + * @param 值类型 + * @author looly + * @since 4.3.3 + */ +public class MapWrapper implements Map, Iterable>, Serializable, Cloneable { + private static final long serialVersionUID = -7524578042008586382L; + + /** + * 默认增长因子 + */ + protected static final float DEFAULT_LOAD_FACTOR = 0.75f; + /** + * 默认初始大小 + */ + protected static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16 + + private Map raw; + + /** + * 构造
+ * 通过传入一个Map从而确定Map的类型，子类需创建一个空的Map，而非传入一个已有Map，否则值可能会被修改 + * + * @param mapFactory 空Map创建工厂 + * @since 5.8.0 + */ + public MapWrapper(Supplier> mapFactory) { + this(mapFactory.get()); + } + + /** + * 构造 + * + * @param raw 被包装的Map + */ + public MapWrapper(Map raw) { + this.raw = raw; + } + + /** + * 获取原始的Map + * + * @return Map + */ + public Map getRaw() { + return this.raw; + } + + @Override + public int size() { + return raw.size(); + } + + @Override + public boolean isEmpty() { + return raw.isEmpty(); + } + + @Override + public boolean containsKey(Object key) { + return raw.containsKey(key); + } + + @Override + public boolean containsValue(Object value) { + return raw.containsValue(value); + } + + @Override + public V get(Object key) { + return raw.get(key); + } + + @Override + public V put(K key, V value) { + return raw.put(key, value); + } + + @Override + public V remove(Object key) { + return raw.remove(key); + } + + @Override + public void putAll(Map m) { + raw.putAll(m); + } + + @Override + public void clear() { + raw.clear(); + } + + @Override + public Collection values() { + return raw.values(); + } + + @Override + public Set keySet() { + return raw.keySet(); + } + + @Override + public Set> entrySet() { + return raw.entrySet(); + } + + @Override + public Iterator> iterator() { + return this.entrySet().iterator(); + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + MapWrapper that = (MapWrapper) o; + return Objects.equals(raw, that.raw); + } + + @Override + public int hashCode() { + return Objects.hash(raw); + } + + @Override + public String toString() { + return raw.toString(); + } + + + @Override + public void forEach(BiConsumer action) { + raw.forEach(action); + } + + @Override + public void replaceAll(BiFunction function) { + raw.replaceAll(function); + } + + @Override + public V putIfAbsent(K key, V value) { + return raw.putIfAbsent(key, value); + } + + @Override + public boolean remove(Object key, Object value) { + return raw.remove(key, value); + } + + @Override + public boolean replace(K key, V oldValue, V newValue) { + return raw.replace(key, oldValue, newValue); + } + + @Override + public V replace(K key, V value) { + return raw.replace(key, value); + } + + @Override + public V computeIfAbsent(K key, Function mappingFunction) { + return raw.computeIfAbsent(key, mappingFunction); + } + + // 重写默认方法的意义在于，如果被包装的Map自定义了这些默认方法，包装类就可以保持这些行为的一致性 + //---------------------------------------------------------------------------- Override default methods start + @Override + public V getOrDefault(Object key, V defaultValue) { + return raw.getOrDefault(key, defaultValue); + } + + @Override + public V computeIfPresent(K key, BiFunction remappingFunction) { + return raw.computeIfPresent(key, remappingFunction); + } + + @Override + public V compute(K key, BiFunction remappingFunction) { + return raw.compute(key, remappingFunction); + } + + @Override + public V merge(K key, V value, BiFunction remappingFunction) { + return raw.merge(key, value, remappingFunction); + } + + @Override + public MapWrapper clone() throws CloneNotSupportedException { + @SuppressWarnings("unchecked") final MapWrapper clone = (MapWrapper) super.clone(); + clone.raw = ObjectUtil.clone(raw); + return clone; + } + + //---------------------------------------------------------------------------- Override default methods end + + // region 序列化与反序列化重写 + private void writeObject(final ObjectOutputStream out) throws IOException { + out.defaultWriteObject(); + out.writeObject(this.raw); + } + + @SuppressWarnings("unchecked") + private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException { + in.defaultReadObject(); + raw = (Map) in.readObject(); + } + // endregion +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/ReferenceConcurrentMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/ReferenceConcurrentMap.java new file mode 100755 index 0000000..9079e20 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/ReferenceConcurrentMap.java @@ -0,0 +1,322 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.lang.func.Func0; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReferenceUtil; + +import java.io.Serializable; +import java.lang.ref.Reference; +import java.lang.ref.ReferenceQueue; +import java.lang.ref.SoftReference; +import java.lang.ref.WeakReference; +import java.util.AbstractMap; +import java.util.Collection; +import java.util.HashSet; +import java.util.Iterator; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.ConcurrentMap; +import java.util.function.BiConsumer; +import java.util.function.BiFunction; +import java.util.function.Function; +import java.util.stream.Collectors; + +/** + * 线程安全的ReferenceMap实现
+ * 参考：jdk.management.resource.internal.WeakKeyConcurrentHashMap + * + * @param 键类型 + * @param 值类型 + * @author looly + * @since 5.8.0 + */ +public class ReferenceConcurrentMap implements ConcurrentMap, Iterable>, Serializable { + + final ConcurrentMap, V> raw; + private final ReferenceQueue lastQueue; + private final ReferenceUtil.ReferenceType keyType; + /** + * 回收监听 + */ + private BiConsumer, V> purgeListener; + + // region 构造 + + /** + * 构造 + * + * @param raw {@link ConcurrentMap}实现 + * @param referenceType Reference类型 + */ + public ReferenceConcurrentMap(ConcurrentMap, V> raw, ReferenceUtil.ReferenceType referenceType) { + this.raw = raw; + this.keyType = referenceType; + lastQueue = new ReferenceQueue<>(); + } + // endregion + + /** + * 设置对象回收清除监听 + * + * @param purgeListener 监听函数 + */ + public void setPurgeListener(BiConsumer, V> purgeListener) { + this.purgeListener = purgeListener; + } + + @Override + public int size() { + this.purgeStaleKeys(); + return this.raw.size(); + } + + @Override + public boolean isEmpty() { + return 0 == size(); + } + + @Override + public V get(Object key) { + this.purgeStaleKeys(); + //noinspection unchecked + return this.raw.get(ofKey((K) key, null)); + } + + @Override + public boolean containsKey(Object key) { + this.purgeStaleKeys(); + //noinspection unchecked + return this.raw.containsKey(ofKey((K) key, null)); + } + + @Override + public boolean containsValue(Object value) { + this.purgeStaleKeys(); + return this.raw.containsValue(value); + } + + @Override + public V put(K key, V value) { + this.purgeStaleKeys(); + return this.raw.put(ofKey(key, this.lastQueue), value); + } + + @Override + public V putIfAbsent(K key, V value) { + this.purgeStaleKeys(); + return this.raw.putIfAbsent(ofKey(key, this.lastQueue), value); + } + + @Override + public void putAll(Map m) { + m.forEach(this::put); + } + + @Override + public V replace(K key, V value) { + this.purgeStaleKeys(); + return this.raw.replace(ofKey(key, this.lastQueue), value); + } + + @Override + public boolean replace(K key, V oldValue, V newValue) { + this.purgeStaleKeys(); + return this.raw.replace(ofKey(key, this.lastQueue), oldValue, newValue); + } + + @Override + public void replaceAll(BiFunction function) { + this.purgeStaleKeys(); + this.raw.replaceAll((kWeakKey, value) -> function.apply(kWeakKey.get(), value)); + } + + @Override + public V computeIfAbsent(K key, Function mappingFunction) { + this.purgeStaleKeys(); + return this.raw.computeIfAbsent(ofKey(key, this.lastQueue), kWeakKey -> mappingFunction.apply(key)); + } + + @Override + public V computeIfPresent(K key, BiFunction remappingFunction) { + this.purgeStaleKeys(); + return this.raw.computeIfPresent(ofKey(key, this.lastQueue), (kWeakKey, value) -> remappingFunction.apply(key, value)); + } + + /** + * 从缓存中获得对象，当对象不在缓存中或已经过期返回Func0回调产生的对象 + * + * @param key 键 + * @param supplier 如果不存在回调方法，用于生产值对象 + * @return 值对象 + */ + public V computeIfAbsent(K key, Func0 supplier) { + return computeIfAbsent(key, (keyParam) -> supplier.callWithRuntimeException()); + } + + @Override + public V remove(Object key) { + this.purgeStaleKeys(); + //noinspection unchecked + return this.raw.remove(ofKey((K) key, null)); + } + + @Override + public boolean remove(Object key, Object value) { + this.purgeStaleKeys(); + //noinspection unchecked + return this.raw.remove(ofKey((K) key, null), value); + } + + @Override + public void clear() { + this.raw.clear(); + //noinspection StatementWithEmptyBody + while (lastQueue.poll() != null) ; + } + + @Override + public Set keySet() { + // TODO 非高效方式的set转换，应该返回一个view + final Collection trans = CollUtil.trans(this.raw.keySet(), (reference) -> null == reference ? null : reference.get()); + return new HashSet<>(trans); + } + + @Override + public Collection values() { + this.purgeStaleKeys(); + return this.raw.values(); + } + + @Override + public Set> entrySet() { + this.purgeStaleKeys(); + return this.raw.entrySet().stream() + .map(entry -> new AbstractMap.SimpleImmutableEntry<>(entry.getKey().get(), entry.getValue())) + .collect(Collectors.toSet()); + } + + @Override + public void forEach(BiConsumer action) { + this.purgeStaleKeys(); + this.raw.forEach((key, value)-> action.accept(key.get(), value)); + } + + @Override + public Iterator> iterator() { + return entrySet().iterator(); + } + + @Override + public V compute(K key, BiFunction remappingFunction) { + this.purgeStaleKeys(); + return this.raw.compute(ofKey(key, this.lastQueue), (kWeakKey, value) -> remappingFunction.apply(key, value)); + } + + @Override + public V merge(K key, V value, BiFunction remappingFunction) { + this.purgeStaleKeys(); + return this.raw.merge(ofKey(key, this.lastQueue), value, remappingFunction); + } + + /** + * 清除被回收的键 + */ + private void purgeStaleKeys() { + Reference reference; + V value; + while ((reference = this.lastQueue.poll()) != null) { + value = this.raw.remove(reference); + if (null != purgeListener) { + purgeListener.accept(reference, value); + } + } + } + + /** + * 根据Reference类型构建key对应的{@link Reference} + * + * @param key 键 + * @param queue {@link ReferenceQueue} + * @return {@link Reference} + */ + private Reference ofKey(K key, ReferenceQueue queue) { + switch (keyType) { + case WEAK: + return new WeakKey<>(key, queue); + case SOFT: + return new SoftKey<>(key, queue); + } + throw new IllegalArgumentException("Unsupported key type: " + keyType); + } + + /** + * 弱键 + * + * @param 键类型 + */ + private static class WeakKey extends WeakReference { + private final int hashCode; + + /** + * 构造 + * + * @param key 原始Key，不能为{@code null} + * @param queue {@link ReferenceQueue} + */ + WeakKey(K key, ReferenceQueue queue) { + super(key, queue); + hashCode = key.hashCode(); + } + + @Override + public int hashCode() { + return hashCode; + } + + @Override + public boolean equals(Object other) { + if (other == this) { + return true; + } else if (other instanceof WeakKey) { + return ObjectUtil.equals(((WeakKey) other).get(), get()); + } + return false; + } + } + + /** + * 弱键 + * + * @param 键类型 + */ + private static class SoftKey extends SoftReference { + private final int hashCode; + + /** + * 构造 + * + * @param key 原始Key，不能为{@code null} + * @param queue {@link ReferenceQueue} + */ + SoftKey(K key, ReferenceQueue queue) { + super(key, queue); + hashCode = key.hashCode(); + } + + @Override + public int hashCode() { + return hashCode; + } + + @Override + public boolean equals(Object other) { + if (other == this) { + return true; + } else if (other instanceof SoftKey) { + return ObjectUtil.equals(((SoftKey) other).get(), get()); + } + return false; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/SafeConcurrentHashMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/SafeConcurrentHashMap.java new file mode 100644 index 0000000..86e8299 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/SafeConcurrentHashMap.java @@ -0,0 +1,74 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.function.Function; + +/** + * 安全的ConcurrentHashMap实现
+ * 此类用于解决在JDK8中调用{@link ConcurrentHashMap#computeIfAbsent(Object, Function)}可能造成的死循环问题。
+ * 方法来自Dubbo，见：issues#2349
+ *

+ * 相关bug见：@see https://bugs.openjdk.java.net/browse/JDK-8161372 + * + * @param 键类型 + * @param 值类型 + */ +public class SafeConcurrentHashMap extends ConcurrentHashMap { + private static final long serialVersionUID = 1L; + + // region == 构造 == + + /** + * 构造，默认初始大小（16） + */ + public SafeConcurrentHashMap() { + super(); + } + + /** + * 构造 + * + * @param initialCapacity 预估初始大小 + */ + public SafeConcurrentHashMap(int initialCapacity) { + super(initialCapacity); + } + + /** + * 构造 + * + * @param m 初始键值对 + */ + public SafeConcurrentHashMap(Map m) { + super(m); + } + + /** + * 构造 + * + * @param initialCapacity 初始容量 + * @param loadFactor 增长系数 + */ + public SafeConcurrentHashMap(int initialCapacity, float loadFactor) { + super(initialCapacity, loadFactor); + } + + /** + * 构造 + * + * @param initialCapacity 初始容量 + * @param loadFactor 增长系数 + * @param concurrencyLevel 并发级别，即Segment的个数 + */ + public SafeConcurrentHashMap(int initialCapacity, + float loadFactor, int concurrencyLevel) { + super(initialCapacity, loadFactor, concurrencyLevel); + } + // endregion == 构造 == + + @Override + public V computeIfAbsent(K key, Function mappingFunction) { + return MapUtil.computeIfAbsent(this, key, mappingFunction); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/TableMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/TableMap.java new file mode 100755 index 0000000..d98c956 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/TableMap.java @@ -0,0 +1,330 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.collection.ListUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.HashSet; +import java.util.Iterator; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.function.BiConsumer; +import java.util.function.BiFunction; + +/** + * 可重复键和值的Map
+ * 通过键值单独建立List方式，使键值对一一对应，实现正向和反向两种查找
+ * 无论是正向还是反向，都是遍历列表查找过程，相比标准的HashMap要慢，数据越多越慢 + * + * @param 键类型 + * @param 值类型 + * @author looly + */ +public class TableMap implements Map, Iterable>, Serializable { + private static final long serialVersionUID = 1L; + + private static final int DEFAULT_CAPACITY = 10; + + private final List keys; + private final List values; + + /** + * 构造 + */ + public TableMap() { + this(DEFAULT_CAPACITY); + } + + /** + * 构造 + * + * @param size 初始容量 + */ + public TableMap(int size) { + this.keys = new ArrayList<>(size); + this.values = new ArrayList<>(size); + } + + /** + * 构造 + * + * @param keys 键列表 + * @param values 值列表 + */ + public TableMap(K[] keys, V[] values) { + this.keys = CollUtil.toList(keys); + this.values = CollUtil.toList(values); + } + + @Override + public int size() { + return keys.size(); + } + + @Override + public boolean isEmpty() { + return CollUtil.isEmpty(keys); + } + + @Override + public boolean containsKey(Object key) { + //noinspection SuspiciousMethodCalls + return keys.contains(key); + } + + @Override + public boolean containsValue(Object value) { + //noinspection SuspiciousMethodCalls + return values.contains(value); + } + + @Override + public V get(Object key) { + //noinspection SuspiciousMethodCalls + final int index = keys.indexOf(key); + if (index > -1) { + return values.get(index); + } + return null; + } + + /** + * 根据value获得对应的key，只返回找到的第一个value对应的key值 + * + * @param value 值 + * @return 键 + * @since 5.3.3 + */ + public K getKey(V value) { + final int index = values.indexOf(value); + if (index > -1) { + return keys.get(index); + } + return null; + } + + /** + * 获取指定key对应的所有值 + * + * @param key 键 + * @return 值列表 + * @since 5.2.5 + */ + public List getValues(K key) { + return CollUtil.getAny( + this.values, + ListUtil.indexOfAll(this.keys, (ele) -> ObjectUtil.equal(ele, key)) + ); + } + + /** + * 获取指定value对应的所有key + * + * @param value 值 + * @return 值列表 + * @since 5.2.5 + */ + public List getKeys(V value) { + return CollUtil.getAny( + this.keys, + ListUtil.indexOfAll(this.values, (ele) -> ObjectUtil.equal(ele, value)) + ); + } + + @Override + public V put(K key, V value) { + keys.add(key); + values.add(value); + return null; + } + + /** + * 移除指定的所有键和对应的所有值 + * + * @param key 键 + * @return 最后一个移除的值 + */ + @Override + public V remove(Object key) { + V lastValue = null; + int index; + //noinspection SuspiciousMethodCalls + while ((index = keys.indexOf(key)) > -1) { + lastValue = removeByIndex(index); + } + return lastValue; + } + + /** + * 移除指定位置的键值对 + * + * @param index 位置，不能越界 + * @return 移除的值 + */ + public V removeByIndex(final int index) { + keys.remove(index); + return values.remove(index); + } + + @Override + public void putAll(Map m) { + for (Map.Entry entry : m.entrySet()) { + this.put(entry.getKey(), entry.getValue()); + } + } + + @Override + public void clear() { + keys.clear(); + values.clear(); + } + + @Override + public Set keySet() { + return new HashSet<>(this.keys); + } + + /** + * 获取所有键，可重复，不可修改 + * + * @return 键列表 + * @since 5.8.0 + */ + public List keys() { + return Collections.unmodifiableList(this.keys); + } + + @Override + public Collection values() { + return Collections.unmodifiableList(this.values); + } + + @Override + public Set> entrySet() { + final Set> hashSet = new LinkedHashSet<>(); + for (int i = 0; i < size(); i++) { + hashSet.add(MapUtil.entry(keys.get(i), values.get(i))); + } + return hashSet; + } + + @Override + public Iterator> iterator() { + return new Iterator>() { + private final Iterator keysIter = keys.iterator(); + private final Iterator valuesIter = values.iterator(); + + @Override + public boolean hasNext() { + return keysIter.hasNext() && valuesIter.hasNext(); + } + + @Override + public Map.Entry next() { + return MapUtil.entry(keysIter.next(), valuesIter.next()); + } + + @Override + public void remove() { + keysIter.remove(); + valuesIter.remove(); + } + }; + } + + @Override + public String toString() { + return "TableMap{" + + "keys=" + keys + + ", values=" + values + + '}'; + } + + @Override + public void forEach(final BiConsumer action) { + for (int i = 0; i < size(); i++) { + action.accept(keys.get(i), values.get(i)); + } + } + + @Override + public boolean remove(final Object key, final Object value) { + boolean removed = false; + for (int i = 0; i < size(); i++) { + if (ObjUtil.equals(key, keys.get(i)) && ObjUtil.equals(value, values.get(i))) { + removeByIndex(i); + removed = true; + // 移除当前元素，下个元素前移 + i--; + } + } + return removed; + } + + @Override + public void replaceAll(final BiFunction function) { + for (int i = 0; i < size(); i++) { + final V newValue = function.apply(keys.get(i), values.get(i)); + values.set(i, newValue); + } + } + + @Override + public boolean replace(final K key, final V oldValue, final V newValue) { + for (int i = 0; i < size(); i++) { + if (ObjUtil.equals(key, keys.get(i)) && ObjUtil.equals(oldValue, values.get(i))) { + values.set(i, newValue); + return true; + } + } + return false; + } + + /** + * 替换指定key的所有值为指定值 + * + * @param key 指定的key + * @param value 替换的值 + * @return 最后替换的值 + */ + @Override + public V replace(final K key, final V value) { + V lastValue = null; + for (int i = 0; i < size(); i++) { + if (ObjUtil.equals(key, keys.get(i))) { + lastValue = values.set(i, value); + } + } + return lastValue; + } + + @SuppressWarnings("NullableProblems") + @Override + public V computeIfPresent(final K key, final BiFunction remappingFunction) { + if(null == remappingFunction){ + return null; + } + + V lastValue = null; + for (int i = 0; i < size(); i++) { + if (ObjUtil.equals(key, keys.get(i))) { + final V newValue = remappingFunction.apply(key, values.get(i)); + if(null != newValue){ + lastValue = values.set(i, newValue); + } else{ + removeByIndex(i); + // 移除当前元素，下个元素前移 + i--; + } + } + } + return lastValue; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/TolerantMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/TolerantMap.java new file mode 100644 index 0000000..d61a956 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/TolerantMap.java @@ -0,0 +1,103 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +/** + * 一个可以提供默认值的Map + * + * @param 键类型 + * @param 值类型 + * @author pantao, looly + */ +public class TolerantMap extends MapWrapper { + private static final long serialVersionUID = -4158133823263496197L; + + private final V defaultValue; + + /** + * 构造 + * + * @param defaultValue 默认值 + */ + public TolerantMap(V defaultValue) { + this(new HashMap<>(), defaultValue); + } + + /** + * 构造 + * + * @param initialCapacity 初始容量 + * @param loadFactor 增长因子 + * @param defaultValue 默认值 + */ + public TolerantMap(int initialCapacity, float loadFactor, V defaultValue) { + this(new HashMap<>(initialCapacity, loadFactor), defaultValue); + } + + /** + * 构造 + * + * @param initialCapacity 初始容量 + * @param defaultValue 默认值 + */ + public TolerantMap(int initialCapacity, V defaultValue) { + this(new HashMap<>(initialCapacity), defaultValue); + } + + /** + * 构造 + * + * @param map Map实现 + * @param defaultValue 默认值 + */ + public TolerantMap(Map map, V defaultValue) { + super(map); + this.defaultValue = defaultValue; + } + + /** + * 构建TolerantMap + * + * @param map map实现 + * @param defaultValue 默认值 + * @param 键类型 + * @param 值类型 + * @return TolerantMap + */ + public static TolerantMap of(Map map, V defaultValue) { + return new TolerantMap<>(map, defaultValue); + } + + @Override + public V get(Object key) { + return getOrDefault(key, defaultValue); + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + if (false == super.equals(o)) { + return false; + } + final TolerantMap that = (TolerantMap) o; + return getRaw().equals(that.getRaw()) + && Objects.equals(defaultValue, that.defaultValue); + } + + @Override + public int hashCode() { + return Objects.hash(getRaw(), defaultValue); + } + + @Override + public String toString() { + return "TolerantMap{" + "map=" + getRaw() + ", defaultValue=" + defaultValue + '}'; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/TransMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/TransMap.java new file mode 100755 index 0000000..c61f324 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/TransMap.java @@ -0,0 +1,129 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import java.util.Map; +import java.util.function.BiFunction; +import java.util.function.Function; +import java.util.function.Supplier; + +/** + * 自定义键和值转换的的Map
+ * 继承此类后，通过实现{@link #customKey(Object)}和{@link #customValue(Object)}，按照给定规则加入到map或获取值。 + * + * @param 键类型 + * @param 值类型 + * @author Looly + * @since 5.8.0 + */ +public abstract class TransMap extends MapWrapper { + private static final long serialVersionUID = 1L; + + /** + * 构造
+ * 通过传入一个Map从而确定Map的类型，子类需创建一个空的Map，而非传入一个已有Map，否则值可能会被修改 + * + * @param mapFactory 空Map创建工厂 + * @since 5.8.0 + */ + public TransMap(Supplier> mapFactory) { + super(mapFactory); + } + + /** + * 构造
+ * 通过传入一个Map从而确定Map的类型，子类需创建一个空的Map，而非传入一个已有Map，否则值可能会被修改 + * + * @param emptyMap Map 被包装的Map，必须为空Map，否则自定义key会无效 + * @since 3.1.2 + */ + public TransMap(Map emptyMap) { + super(emptyMap); + } + + @Override + public V get(Object key) { + return super.get(customKey(key)); + } + + @Override + public V put(K key, V value) { + return super.put(customKey(key), customValue(value)); + } + + @Override + public void putAll(Map m) { + m.forEach(this::put); + } + + @Override + public boolean containsKey(Object key) { + return super.containsKey(customKey(key)); + } + + @Override + public V remove(Object key) { + return super.remove(customKey(key)); + } + + @Override + public boolean remove(Object key, Object value) { + return super.remove(customKey(key), customValue(value)); + } + + @Override + public boolean replace(K key, V oldValue, V newValue) { + return super.replace(customKey(key), customValue(oldValue), customValue(newValue)); + } + + @Override + public V replace(K key, V value) { + return super.replace(customKey(key), customValue(value)); + } + + //---------------------------------------------------------------------------- Override default methods start + @Override + public V getOrDefault(Object key, V defaultValue) { + return super.getOrDefault(customKey(key), customValue(defaultValue)); + } + + @Override + public V computeIfPresent(K key, BiFunction remappingFunction) { + return super.computeIfPresent(customKey(key), (k, v) -> remappingFunction.apply(customKey(k), customValue(v))); + } + + @Override + public V compute(K key, BiFunction remappingFunction) { + return super.compute(customKey(key), (k, v) -> remappingFunction.apply(customKey(k), customValue(v))); + } + + @Override + public V merge(K key, V value, BiFunction remappingFunction) { + return super.merge(customKey(key), customValue(value), (v1, v2) -> remappingFunction.apply(customValue(v1), customValue(v2))); + } + + @Override + public V putIfAbsent(K key, V value) { + return super.putIfAbsent(customKey(key), customValue(value)); + } + + @Override + public V computeIfAbsent(final K key, final Function mappingFunction) { + return super.computeIfAbsent(customKey(key), mappingFunction); + } + //---------------------------------------------------------------------------- Override default methods end + + /** + * 自定义键 + * + * @param key KEY + * @return 自定义KEY + */ + protected abstract K customKey(Object key); + + /** + * 自定义值 + * + * @param value 值 + * @return 自定义值 + */ + protected abstract V customValue(Object value); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/TreeEntry.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/TreeEntry.java new file mode 100644 index 0000000..5f0689e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/TreeEntry.java @@ -0,0 +1,143 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.util.Map; +import java.util.function.Consumer; + +/** + * 允许拥有一个父节点与多个子节点的{@link Map.Entry}实现， + * 表示一个以key作为唯一标识，并且可以挂载一个对应值的树节点， + * 提供一些基于该节点对其所在树结构进行访问的方法 + * + * @param 节点的key类型 + * @param 节点的value类型 + * @author huangchengxing + * @see ForestMap + */ +public interface TreeEntry extends Map.Entry { + + // ===================== Entry方法的重定义 ===================== + + /** + * 比较目标对象与当前{@link TreeEntry}是否相等。
+ * 默认只要{@link TreeEntry#getKey()}的返回值相同，即认为两者相等 + * + * @param o 目标对象 + * @return 是否 + */ + @Override + boolean equals(Object o); + + /** + * 返回当前{@link TreeEntry}的哈希值。
+ * 默认总是返回{@link TreeEntry#getKey()}的哈希值 + * + * @return 哈希值 + */ + @Override + int hashCode(); + + // ===================== 父节点相关方法 ===================== + + /** + * 获取以当前节点作为叶子节点的树结构，然后获取当前节点与根节点的距离 + * + * @return 当前节点与根节点的距离 + */ + int getWeight(); + + /** + * 获取以当前节点作为叶子节点的树结构，然后获取该树结构的根节点 + * + * @return 根节点 + */ + TreeEntry getRoot(); + + /** + * 当前节点是否存在直接关联的父节点 + * + * @return 是否 + */ + default boolean hasParent() { + return ObjectUtil.isNotNull(getDeclaredParent()); + } + + /** + * 获取当前节点直接关联的父节点 + * + * @return 父节点，当节点不存在对应父节点时返回null + */ + TreeEntry getDeclaredParent(); + + /** + * 获取以当前节点作为叶子节点的树结构，然后获取该树结构中当前节点的指定父节点 + * + * @param key 指定父节点的key + * @return 指定父节点，当不存在时返回null + */ + TreeEntry getParent(K key); + + /** + * 获取以当前节点作为叶子节点的树结构，然后确认该树结构中当前节点是否存在指定父节点 + * + * @param key 指定父节点的key + * @return 是否 + */ + default boolean containsParent(K key) { + return ObjectUtil.isNotNull(getParent(key)); + } + + // ===================== 子节点相关方法 ===================== + + /** + * 获取以当前节点作为根节点的树结构，然后遍历所有节点 + * + * @param includeSelf 是否处理当前节点 + * @param nodeConsumer 对节点的处理 + */ + void forEachChild(boolean includeSelf, Consumer> nodeConsumer); + + /** + * 获取当前节点直接关联的子节点 + * + * @return 节点 + */ + Map> getDeclaredChildren(); + + /** + * 获取以当前节点作为根节点的树结构，然后获取该树结构中的当前节点的全部子节点 + * + * @return 节点 + */ + Map> getChildren(); + + /** + * 当前节点是否有子节点 + * + * @return 是否 + */ + default boolean hasChildren() { + return CollUtil.isNotEmpty(getDeclaredChildren()); + } + + /** + * 获取以当前节点作为根节点的树结构，然后获取该树结构中的当前节点的指定子节点 + * + * @param key 指定子节点的key + * @return 节点 + */ + TreeEntry getChild(K key); + + /** + * 获取以当前节点作为根节点的树结构，然后确认该树结构中当前节点是否存在指定子节点 + * + * @param key 指定子节点的key + * @return 是否 + */ + default boolean containsChild(K key) { + return ObjectUtil.isNotNull(getChild(key)); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/WeakConcurrentMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/WeakConcurrentMap.java new file mode 100755 index 0000000..b19dd44 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/WeakConcurrentMap.java @@ -0,0 +1,34 @@ +package aiyh.utils.tool.cn.hutool.core.map; + +import aiyh.utils.tool.cn.hutool.core.util.ReferenceUtil; + +import java.lang.ref.Reference; +import java.util.concurrent.ConcurrentMap; + +/** + * 线程安全的WeakMap实现
+ * 参考：jdk.management.resource.internal.WeakKeyConcurrentHashMap + * + * @param 键类型 + * @param 值类型 + * @author looly + * @since 5.8.0 + */ +public class WeakConcurrentMap extends ReferenceConcurrentMap { + + /** + * 构造 + */ + public WeakConcurrentMap() { + this(new SafeConcurrentHashMap<>()); + } + + /** + * 构造 + * + * @param raw {@link ConcurrentMap}实现 + */ + public WeakConcurrentMap(ConcurrentMap, V> raw) { + super(raw, ReferenceUtil.ReferenceType.WEAK); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/AbsCollValueMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/AbsCollValueMap.java new file mode 100644 index 0000000..c3e63ca --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/AbsCollValueMap.java @@ -0,0 +1,151 @@ +package aiyh.utils.tool.cn.hutool.core.map.multi; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.map.MapWrapper; + +import java.util.Collection; +import java.util.HashMap; +import java.util.Map; + +/** + * 值作为集合的Map实现，通过调用putValue可以在相同key时加入多个值，多个值用集合表示 + * + * @param 键类型 + * @param 值类型 + * @param 集合类型 + * @author looly + * @since 5.7.4 + */ +public abstract class AbsCollValueMap> extends MapWrapper { + private static final long serialVersionUID = 1L; + + /** + * 默认集合初始大小 + */ + protected static final int DEFAULT_COLLECTION_INITIAL_CAPACITY = 3; + + // ------------------------------------------------------------------------- Constructor start + + /** + * 构造 + */ + public AbsCollValueMap() { + this(DEFAULT_INITIAL_CAPACITY); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + */ + public AbsCollValueMap(int initialCapacity) { + this(initialCapacity, DEFAULT_LOAD_FACTOR); + } + + /** + * 构造 + * + * @param m Map + */ + public AbsCollValueMap(Map m) { + this(DEFAULT_LOAD_FACTOR, m); + } + + /** + * 构造 + * + * @param loadFactor 加载因子 + * @param m Map + */ + public AbsCollValueMap(float loadFactor, Map m) { + this(m.size(), loadFactor); + this.putAll(m); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + * @param loadFactor 加载因子 + */ + public AbsCollValueMap(int initialCapacity, float loadFactor) { + super(new HashMap<>(initialCapacity, loadFactor)); + } + // ------------------------------------------------------------------------- Constructor end + + /** + * 放入所有value + * + * @param m valueMap + * @since 5.7.4 + */ + public void putAllValues(Map> m) { + if (null != m) { + m.forEach((key, valueColl) -> { + if (null != valueColl) { + valueColl.forEach((value) -> putValue(key, value)); + } + }); + } + } + + /** + * 放入Value
+ * 如果键对应值列表有值，加入，否则创建一个新列表后加入 + * + * @param key 键 + * @param value 值 + */ + public void putValue(K key, V value) { + C collection = this.get(key); + if (null == collection) { + collection = createCollection(); + this.put(key, collection); + } + collection.add(value); + } + + /** + * 获取值 + * + * @param key 键 + * @param index 第几个值的索引，越界返回null + * @return 值或null + */ + public V get(K key, int index) { + final Collection collection = get(key); + return CollUtil.get(collection, index); + } + + /** + * 移除value集合中的某个值 + * + * @param key 键 + * @param value 集合中的某个值 + * @return 是否删除成功 + */ + public boolean removeValue(K key, V value) { + C collection = this.get(key); + return null != collection && collection.remove(value); + } + + /** + * 移除value集合中的某些值 + * + * @param key 键 + * @param values 集合中的某些值 + * @return 是否删除成功 + */ + public boolean removeValues(K key, Collection values) { + C collection = this.get(key); + return null != collection && collection.removeAll(values); + } + + /** + * 创建集合
+ * 此方法用于创建在putValue后追加值所在的集合，子类实现此方法创建不同类型的集合 + * + * @return {@link Collection} + */ + protected abstract C createCollection(); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/AbsTable.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/AbsTable.java new file mode 100644 index 0000000..56ad75e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/AbsTable.java @@ -0,0 +1,236 @@ +package aiyh.utils.tool.cn.hutool.core.map.multi; + +import aiyh.utils.tool.cn.hutool.core.collection.IterUtil; +import aiyh.utils.tool.cn.hutool.core.collection.TransIter; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.io.Serializable; +import java.util.AbstractCollection; +import java.util.AbstractSet; +import java.util.Collection; +import java.util.Iterator; +import java.util.Map; +import java.util.Objects; +import java.util.Set; + +/** + * 抽象{@link Table}接口实现
+ * 默认实现了： + *

    + *
  • {@link #equals(Object)}
    • + *
  • {@link #hashCode()}
    • + *
  • {@link #toString()}
    • + *
  • {@link #values()}
    • + *
  • {@link #cellSet()}
    • + *
  • {@link #iterator()}
    • + *
+ * + * @param 行类型 + * @param 列类型 + * @param 值类型 + * @author Guava, Looly + * @since 5.7.23 + */ +public abstract class AbsTable implements Table { + + @Override + public boolean equals(Object obj) { + if (obj == this) { + return true; + } else if (obj instanceof Table) { + final Table that = (Table) obj; + return this.cellSet().equals(that.cellSet()); + } else { + return false; + } + } + + @Override + public int hashCode() { + return cellSet().hashCode(); + } + + @Override + public String toString() { + return rowMap().toString(); + } + + //region values + @Override + public Collection values() { + Collection result = values; + return (result == null) ? values = new Values() : result; + } + + private Collection values; + private class Values extends AbstractCollection { + @Override + public Iterator iterator() { + return new TransIter<>(cellSet().iterator(), Cell::getValue); + } + + @Override + public boolean contains(Object o) { + //noinspection unchecked + return containsValue((V) o); + } + + @Override + public void clear() { + AbsTable.this.clear(); + } + + @Override + public int size() { + return AbsTable.this.size(); + } + } + //endregion + + //region cellSet + @Override + public Set> cellSet() { + Set> result = cellSet; + return (result == null) ? cellSet = new CellSet() : result; + } + + private Set> cellSet; + + private class CellSet extends AbstractSet> { + @Override + public boolean contains(Object o) { + if (o instanceof Cell) { + @SuppressWarnings("unchecked") final Cell cell = (Cell) o; + Map row = getRow(cell.getRowKey()); + if (null != row) { + return ObjectUtil.equals(row.get(cell.getColumnKey()), cell.getValue()); + } + } + return false; + } + + @Override + public boolean remove(Object o) { + if (contains(o)) { + @SuppressWarnings("unchecked") final Cell cell = (Cell) o; + AbsTable.this.remove(cell.getRowKey(), cell.getColumnKey()); + } + return false; + } + + @Override + public void clear() { + AbsTable.this.clear(); + } + + @Override + public Iterator> iterator() { + return new AbsTable.CellIterator(); + } + + @Override + public int size() { + return AbsTable.this.size(); + } + } + //endregion + + //region iterator + @Override + public Iterator> iterator() { + return new CellIterator(); + } + + /** + * 基于{@link Cell}的{@link Iterator}实现 + */ + private class CellIterator implements Iterator> { + final Iterator>> rowIterator = rowMap().entrySet().iterator(); + Map.Entry> rowEntry; + Iterator> columnIterator = IterUtil.empty(); + + @Override + public boolean hasNext() { + return rowIterator.hasNext() || columnIterator.hasNext(); + } + + @Override + public Cell next() { + if (false == columnIterator.hasNext()) { + rowEntry = rowIterator.next(); + columnIterator = rowEntry.getValue().entrySet().iterator(); + } + final Map.Entry columnEntry = columnIterator.next(); + return new SimpleCell<>(rowEntry.getKey(), columnEntry.getKey(), columnEntry.getValue()); + } + + @Override + public void remove() { + columnIterator.remove(); + if (rowEntry.getValue().isEmpty()) { + rowIterator.remove(); + } + } + } + //endregion + + /** + * 简单{@link Cell} 实现 + * + * @param 行类型 + * @param 列类型 + * @param 值类型 + */ + private static class SimpleCell implements Cell, Serializable { + private static final long serialVersionUID = 1L; + + private final R rowKey; + private final C columnKey; + private final V value; + + SimpleCell(R rowKey, C columnKey, V value) { + this.rowKey = rowKey; + this.columnKey = columnKey; + this.value = value; + } + + @Override + public R getRowKey() { + return rowKey; + } + + @Override + public C getColumnKey() { + return columnKey; + } + + @Override + public V getValue() { + return value; + } + + @Override + public boolean equals(Object obj) { + if (obj == this) { + return true; + } + if (obj instanceof Cell) { + Cell other = (Cell) obj; + return ObjectUtil.equal(rowKey, other.getRowKey()) + && ObjectUtil.equal(columnKey, other.getColumnKey()) + && ObjectUtil.equal(value, other.getValue()); + } + return false; + } + + @Override + public int hashCode() { + return Objects.hash(rowKey, columnKey, value); + } + + @Override + public String toString() { + return "(" + rowKey + "," + columnKey + ")=" + value; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/CollectionValueMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/CollectionValueMap.java new file mode 100644 index 0000000..a9c6155 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/CollectionValueMap.java @@ -0,0 +1,102 @@ +package aiyh.utils.tool.cn.hutool.core.map.multi; + +import aiyh.utils.tool.cn.hutool.core.lang.func.Func0; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.Map; + +/** + * 值作为集合的Map实现，通过调用putValue可以在相同key时加入多个值，多个值用集合表示
+ * 此类可以通过传入函数自定义集合类型的创建规则 + * + * @param 键类型 + * @param 值类型 + * @author looly + * @since 4.3.3 + */ +public class CollectionValueMap extends AbsCollValueMap> { + private static final long serialVersionUID = 9012989578038102983L; + + private final Func0> collectionCreateFunc; + + // ------------------------------------------------------------------------- Constructor start + + /** + * 构造 + */ + public CollectionValueMap() { + this(DEFAULT_INITIAL_CAPACITY); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + */ + public CollectionValueMap(int initialCapacity) { + this(initialCapacity, DEFAULT_LOAD_FACTOR); + } + + /** + * 构造 + * + * @param m Map + */ + public CollectionValueMap(Map> m) { + this(DEFAULT_LOAD_FACTOR, m); + } + + /** + * 构造 + * + * @param loadFactor 加载因子 + * @param m Map + */ + public CollectionValueMap(float loadFactor, Map> m) { + this(loadFactor, m, ArrayList::new); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + * @param loadFactor 加载因子 + */ + public CollectionValueMap(int initialCapacity, float loadFactor) { + this(initialCapacity, loadFactor, ArrayList::new); + } + + /** + * 构造 + * + * @param loadFactor 加载因子 + * @param m Map + * @param collectionCreateFunc Map中值的集合创建函数 + * @since 5.7.4 + */ + public CollectionValueMap(float loadFactor, Map> m, Func0> collectionCreateFunc) { + this(m.size(), loadFactor, collectionCreateFunc); + this.putAll(m); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + * @param loadFactor 加载因子 + * @param collectionCreateFunc Map中值的集合创建函数 + * @since 5.7.4 + */ + public CollectionValueMap(int initialCapacity, float loadFactor, Func0> collectionCreateFunc) { + super(new HashMap<>(initialCapacity, loadFactor)); + this.collectionCreateFunc = collectionCreateFunc; + } + // ------------------------------------------------------------------------- Constructor end + + @Override + protected Collection createCollection() { + return collectionCreateFunc.callWithRuntimeException(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/ListValueMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/ListValueMap.java new file mode 100644 index 0000000..8b1f8a4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/ListValueMap.java @@ -0,0 +1,73 @@ +package aiyh.utils.tool.cn.hutool.core.map.multi; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * 值作为集合List的Map实现，通过调用putValue可以在相同key时加入多个值，多个值用集合表示 + * + * @author looly + * + * @param 键类型 + * @param 值类型 + * @since 4.3.3 + */ +public class ListValueMap extends AbsCollValueMap> { + private static final long serialVersionUID = 6044017508487827899L; + + // ------------------------------------------------------------------------- Constructor start + /** + * 构造 + */ + public ListValueMap() { + this(DEFAULT_INITIAL_CAPACITY); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + */ + public ListValueMap(int initialCapacity) { + this(initialCapacity, DEFAULT_LOAD_FACTOR); + } + + /** + * 构造 + * + * @param m Map + */ + public ListValueMap(Map> m) { + this(DEFAULT_LOAD_FACTOR, m); + } + + /** + * 构造 + * + * @param loadFactor 加载因子 + * @param m Map + */ + public ListValueMap(float loadFactor, Map> m) { + this(m.size(), loadFactor); + this.putAllValues(m); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + * @param loadFactor 加载因子 + */ + public ListValueMap(int initialCapacity, float loadFactor) { + super(new HashMap<>(initialCapacity, loadFactor)); + } + // ------------------------------------------------------------------------- Constructor end + + @Override + protected List createCollection() { + return new ArrayList<>(DEFAULT_COLLECTION_INITIAL_CAPACITY); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/RowKeyTable.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/RowKeyTable.java new file mode 100755 index 0000000..54dc8e9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/RowKeyTable.java @@ -0,0 +1,281 @@ +package aiyh.utils.tool.cn.hutool.core.map.multi; + +import aiyh.utils.tool.cn.hutool.core.builder.Builder; +import aiyh.utils.tool.cn.hutool.core.collection.ComputeIter; +import aiyh.utils.tool.cn.hutool.core.collection.IterUtil; +import aiyh.utils.tool.cn.hutool.core.collection.TransIter; +import aiyh.utils.tool.cn.hutool.core.map.AbsEntry; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; + +import java.util.AbstractMap; +import java.util.AbstractSet; +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Set; + +/** + * 将行的键作为主键的{@link Table}实现
+ * 此结构为: 行=(列=值) + * + * @param 行类型 + * @param 列类型 + * @param 值类型 + * @author Guava, Looly + * @since 5.7.23 + */ +public class RowKeyTable extends AbsTable { + + final Map> raw; + /** + * 列的Map创建器，用于定义Table中Value对应Map类型 + */ + final Builder> columnBuilder; + + //region 构造 + + /** + * 构造 + */ + public RowKeyTable() { + this(new HashMap<>()); + } + + /** + * 构造 + * + * @param isLinked 是否有序，有序则使用{@link java.util.LinkedHashMap}作为原始Map + * @since 5.8.0 + */ + public RowKeyTable(boolean isLinked) { + this(MapUtil.newHashMap(isLinked), () -> MapUtil.newHashMap(isLinked)); + } + + /** + * 构造 + * + * @param raw 原始Map + */ + public RowKeyTable(Map> raw) { + this(raw, HashMap::new); + } + + /** + * 构造 + * + * @param raw 原始Map + * @param columnMapBuilder 列的map创建器 + */ + public RowKeyTable(Map> raw, Builder> columnMapBuilder) { + this.raw = raw; + this.columnBuilder = null == columnMapBuilder ? HashMap::new : columnMapBuilder; + } + //endregion + + @Override + public Map> rowMap() { + return raw; + } + + @Override + public V put(R rowKey, C columnKey, V value) { + return raw.computeIfAbsent(rowKey, (key) -> columnBuilder.build()).put(columnKey, value); + } + + @Override + public V remove(R rowKey, C columnKey) { + final Map map = getRow(rowKey); + if (null == map) { + return null; + } + final V value = map.remove(columnKey); + if (map.isEmpty()) { + raw.remove(rowKey); + } + return value; + } + + @Override + public boolean isEmpty() { + return raw.isEmpty(); + } + + @Override + public void clear() { + this.raw.clear(); + } + + @Override + public boolean containsColumn(C columnKey) { + if (columnKey == null) { + return false; + } + for (Map map : raw.values()) { + if (null != map && map.containsKey(columnKey)) { + return true; + } + } + return false; + } + + //region columnMap + @Override + public Map> columnMap() { + Map> result = columnMap; + return (result == null) ? columnMap = new ColumnMap() : result; + } + + private Map> columnMap; + + private class ColumnMap extends AbstractMap> { + @Override + public Set>> entrySet() { + return new ColumnMapEntrySet(); + } + } + + private class ColumnMapEntrySet extends AbstractSet>> { + private final Set columnKeySet = columnKeySet(); + + @Override + public Iterator>> iterator() { + return new TransIter<>(columnKeySet.iterator(), + c -> MapUtil.entry(c, getColumn(c))); + } + + @Override + public int size() { + return columnKeySet.size(); + } + } + //endregion + + + //region columnKeySet + @Override + public Set columnKeySet() { + Set result = columnKeySet; + return (result == null) ? columnKeySet = new ColumnKeySet() : result; + } + + private Set columnKeySet; + + private class ColumnKeySet extends AbstractSet { + + @Override + public Iterator iterator() { + return new ColumnKeyIterator(); + } + + @Override + public int size() { + return IterUtil.size(iterator()); + } + } + + private class ColumnKeyIterator extends ComputeIter { + final Map seen = columnBuilder.build(); + final Iterator> mapIterator = raw.values().iterator(); + Iterator> entryIterator = IterUtil.empty(); + + @Override + protected C computeNext() { + while (true) { + if (entryIterator.hasNext()) { + Map.Entry entry = entryIterator.next(); + if (false == seen.containsKey(entry.getKey())) { + seen.put(entry.getKey(), entry.getValue()); + return entry.getKey(); + } + } else if (mapIterator.hasNext()) { + entryIterator = mapIterator.next().entrySet().iterator(); + } else { + return null; + } + } + } + } + //endregion + + //region getColumn + @Override + public List columnKeys() { + final Collection> values = this.raw.values(); + final List result = new ArrayList<>(values.size() * 16); + for (Map map : values) { + map.forEach((key, value)->{result.add(key);}); + } + return result; + } + + @Override + public Map getColumn(C columnKey) { + return new Column(columnKey); + } + + private class Column extends AbstractMap { + final C columnKey; + + Column(C columnKey) { + this.columnKey = columnKey; + } + + @Override + public Set> entrySet() { + return new EntrySet(); + } + + private class EntrySet extends AbstractSet> { + + @Override + public Iterator> iterator() { + return new EntrySetIterator(); + } + + @Override + public int size() { + int size = 0; + for (Map map : raw.values()) { + if (map.containsKey(columnKey)) { + size++; + } + } + return size; + } + } + + private class EntrySetIterator extends ComputeIter> { + final Iterator>> iterator = raw.entrySet().iterator(); + + @Override + protected Entry computeNext() { + while (iterator.hasNext()) { + final Entry> entry = iterator.next(); + if (entry.getValue().containsKey(columnKey)) { + return new AbsEntry() { + @Override + public R getKey() { + return entry.getKey(); + } + + @Override + public V getValue() { + return entry.getValue().get(columnKey); + } + + @Override + public V setValue(V value) { + return entry.getValue().put(columnKey, value); + } + }; + } + } + return null; + } + } + } + //endregion +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/SetValueMap.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/SetValueMap.java new file mode 100644 index 0000000..bf6aef4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/SetValueMap.java @@ -0,0 +1,73 @@ +package aiyh.utils.tool.cn.hutool.core.map.multi; + +import java.util.Collection; +import java.util.HashMap; +import java.util.LinkedHashSet; +import java.util.Map; +import java.util.Set; + +/** + * 值作为集合Set（LinkedHashSet）的Map实现，通过调用putValue可以在相同key时加入多个值，多个值用集合表示 + * + * @author looly + * + * @param 键类型 + * @param 值类型 + * @since 4.3.3 + */ +public class SetValueMap extends AbsCollValueMap> { + private static final long serialVersionUID = 6044017508487827899L; + + // ------------------------------------------------------------------------- Constructor start + /** + * 构造 + */ + public SetValueMap() { + this(DEFAULT_INITIAL_CAPACITY); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + */ + public SetValueMap(int initialCapacity) { + this(initialCapacity, DEFAULT_LOAD_FACTOR); + } + + /** + * 构造 + * + * @param m Map + */ + public SetValueMap(Map> m) { + this(DEFAULT_LOAD_FACTOR, m); + } + + /** + * 构造 + * + * @param loadFactor 加载因子 + * @param m Map + */ + public SetValueMap(float loadFactor, Map> m) { + this(m.size(), loadFactor); + this.putAllValues(m); + } + + /** + * 构造 + * + * @param initialCapacity 初始大小 + * @param loadFactor 加载因子 + */ + public SetValueMap(int initialCapacity, float loadFactor) { + super(new HashMap<>(initialCapacity, loadFactor)); + } + // ------------------------------------------------------------------------- Constructor end + + @Override + protected Set createCollection() { + return new LinkedHashSet<>(DEFAULT_COLLECTION_INITIAL_CAPACITY); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/Table.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/Table.java new file mode 100755 index 0000000..08cfeac --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/Table.java @@ -0,0 +1,281 @@ +package aiyh.utils.tool.cn.hutool.core.map.multi; + +import aiyh.utils.tool.cn.hutool.core.collection.ListUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Opt; +import aiyh.utils.tool.cn.hutool.core.lang.func.Consumer3; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.Map; +import java.util.Set; + +/** + * 表格数据结构定义
+ * 此结构类似于Guava的Table接口，使用两个键映射到一个值，类似于表格结构。 + * + * @param 行键类型 + * @param 列键类型 + * @param 值类型 + * @since 5.7.23 + */ +public interface Table extends Iterable> { + + /** + * 是否包含指定行列的映射
+ * 行和列任意一个不存在都会返回{@code false}，如果行和列都存在，值为{@code null}，也会返回{@code true} + * + * @param rowKey 行键 + * @param columnKey 列键 + * @return 是否包含映射 + */ + default boolean contains(R rowKey, C columnKey) { + return Opt.ofNullable(getRow(rowKey)).map((map) -> map.containsKey(columnKey)).get(); + } + + //region Row + + /** + * 行是否存在 + * + * @param rowKey 行键 + * @return 行是否存在 + */ + default boolean containsRow(R rowKey) { + return Opt.ofNullable(rowMap()).map((map) -> map.containsKey(rowKey)).get(); + } + + /** + * 获取行 + * + * @param rowKey 行键 + * @return 行映射，返回的键为列键，值为表格的值 + */ + default Map getRow(R rowKey) { + return Opt.ofNullable(rowMap()).map((map) -> map.get(rowKey)).get(); + } + + /** + * 返回所有行的key，行的key不可重复 + * + * @return 行键 + */ + default Set rowKeySet() { + return Opt.ofNullable(rowMap()).map(Map::keySet).get(); + } + + /** + * 返回行列对应的Map + * + * @return map，键为行键，值为列和值的对应map + */ + Map> rowMap(); + //endregion + + //region Column + + /** + * 列是否存在 + * + * @param columnKey 列键 + * @return 列是否存在 + */ + default boolean containsColumn(C columnKey) { + return Opt.ofNullable(columnMap()).map((map) -> map.containsKey(columnKey)).get(); + } + + /** + * 获取列 + * + * @param columnKey 列键 + * @return 列映射，返回的键为行键，值为表格的值 + */ + default Map getColumn(C columnKey) { + return Opt.ofNullable(columnMap()).map((map) -> map.get(columnKey)).get(); + } + + /** + * 返回所有列的key，列的key不可重复 + * + * @return 列set + */ + default Set columnKeySet() { + return Opt.ofNullable(columnMap()).map(Map::keySet).get(); + } + + /** + * 返回所有列的key，列的key如果实现Map是可重复key，则返回对应不去重的List。 + * + * @return 列set + * @since 5.8.0 + */ + default List columnKeys() { + final Map> columnMap = columnMap(); + if(MapUtil.isEmpty(columnMap)){ + return ListUtil.empty(); + } + + final List result = new ArrayList<>(columnMap.size()); + for (Map.Entry> cMapEntry : columnMap.entrySet()) { + result.add(cMapEntry.getKey()); + } + return result; + } + + /** + * 返回列-行对应的map + * + * @return map，键为列键，值为行和值的对应map + */ + Map> columnMap(); + //endregion + + //region value + + /** + * 指定值是否存在 + * + * @param value 值 + * @return 值 + */ + default boolean containsValue(V value){ + final Collection> rows = Opt.ofNullable(rowMap()).map(Map::values).get(); + if(null != rows){ + for (Map row : rows) { + if (row.containsValue(value)) { + return true; + } + } + } + return false; + } + + /** + * 获取指定值 + * + * @param rowKey 行键 + * @param columnKey 列键 + * @return 值，如果值不存在，返回{@code null} + */ + default V get(R rowKey, C columnKey) { + return Opt.ofNullable(getRow(rowKey)).map((map) -> map.get(columnKey)).get(); + } + + /** + * 所有行列值的集合 + * + * @return 值的集合 + */ + Collection values(); + //endregion + + /** + * 所有单元格集合 + * + * @return 单元格集合 + */ + Set> cellSet(); + + /** + * 为表格指定行列赋值，如果不存在，创建之，存在则替换之，返回原值 + * + * @param rowKey 行键 + * @param columnKey 列键 + * @param value 值 + * @return 原值，不存在返回{@code null} + */ + V put(R rowKey, C columnKey, V value); + + /** + * 批量加入 + * + * @param table 其他table + */ + default void putAll(Table table){ + if (null != table) { + for (Table.Cell cell : table.cellSet()) { + put(cell.getRowKey(), cell.getColumnKey(), cell.getValue()); + } + } + } + + /** + * 移除指定值 + * + * @param rowKey 行键 + * @param columnKey 列键 + * @return 移除的值，如果值不存在，返回{@code null} + */ + V remove(R rowKey, C columnKey); + + /** + * 表格是否为空 + * + * @return 是否为空 + */ + boolean isEmpty(); + + /** + * 表格大小，一般为单元格的个数 + * + * @return 表格大小 + */ + default int size(){ + final Map> rowMap = rowMap(); + if(MapUtil.isEmpty(rowMap)){ + return 0; + } + int size = 0; + for (Map map : rowMap.values()) { + size += map.size(); + } + return size; + } + + /** + * 清空表格 + */ + void clear(); + + /** + * 遍历表格的单元格，处理值 + * + * @param consumer 单元格值处理器 + */ + default void forEach(Consumer3 consumer) { + for (Cell cell : this) { + consumer.accept(cell.getRowKey(), cell.getColumnKey(), cell.getValue()); + } + } + + /** + * 单元格，用于表示一个单元格的行、列和值 + * + * @param 行键类型 + * @param 列键类型 + * @param 值类型 + */ + interface Cell { + /** + * 获取行键 + * + * @return 行键 + */ + R getRowKey(); + + /** + * 获取列键 + * + * @return 列键 + */ + C getColumnKey(); + + /** + * 获取值 + * + * @return 值 + */ + V getValue(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/package-info.java new file mode 100644 index 0000000..b38fc35 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/multi/package-info.java @@ -0,0 +1,7 @@ +/** + * 多参数类型的Map实现，包括集合类型值的Map和Table + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.map.multi; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/map/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/package-info.java new file mode 100644 index 0000000..e0a943f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/map/package-info.java @@ -0,0 +1,7 @@ +/** + * Map相关封装，提供特殊Map实现以及Map工具MapUtil + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.map; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/math/Arrangement.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/Arrangement.java new file mode 100644 index 0000000..7525815 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/Arrangement.java @@ -0,0 +1,127 @@ +package aiyh.utils.tool.cn.hutool.core.math; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; + +/** + * 排列A(n, m)
+ * 排列组合相关类 参考：http://cgs1999.iteye.com/blog/2327664 + * + * @author looly + * @since 4.0.7 + */ +public class Arrangement implements Serializable { + private static final long serialVersionUID = 1L; + + private final String[] datas; + + /** + * 构造 + * + * @param datas 用于排列的数据 + */ + public Arrangement(String[] datas) { + this.datas = datas; + } + + /** + * 计算排列数，即A(n, n) = n! + * + * @param n 总数 + * @return 排列数 + */ + public static long count(int n) { + return count(n, n); + } + + /** + * 计算排列数，即A(n, m) = n!/(n-m)! + * + * @param n 总数 + * @param m 选择的个数 + * @return 排列数 + */ + public static long count(int n, int m) { + if (n == m) { + return NumberUtil.factorial(n); + } + return (n > m) ? NumberUtil.factorial(n, n - m) : 0; + } + + /** + * 计算排列总数，即A(n, 1) + A(n, 2) + A(n, 3)... + * + * @param n 总数 + * @return 排列数 + */ + public static long countAll(int n) { + long total = 0; + for (int i = 1; i <= n; i++) { + total += count(n, i); + } + return total; + } + + /** + * 全排列选择（列表全部参与排列） + * + * @return 所有排列列表 + */ + public List select() { + return select(this.datas.length); + } + + /** + * 排列选择（从列表中选择m个排列） + * + * @param m 选择个数 + * @return 所有排列列表 + */ + public List select(int m) { + final List result = new ArrayList<>((int) count(this.datas.length, m)); + select(this.datas, new String[m], 0, result); + return result; + } + + /** + * 排列所有组合，即A(n, 1) + A(n, 2) + A(n, 3)... + * + * @return 全排列结果 + */ + public List selectAll() { + final List result = new ArrayList<>((int) countAll(this.datas.length)); + for (int i = 1; i <= this.datas.length; i++) { + result.addAll(select(i)); + } + return result; + } + + /** + * 排列选择
+ * 排列方式为先从数据数组中取出一个元素，再把剩余的元素作为新的基数，依次列推，直到选择到足够的元素 + * + * @param datas 选择的基数 + * @param resultList 前面（resultIndex-1）个的排列结果 + * @param resultIndex 选择索引，从0开始 + * @param result 最终结果 + */ + private void select(String[] datas, String[] resultList, int resultIndex, List result) { + if (resultIndex >= resultList.length) { // 全部选择完时，输出排列结果 + if (false == result.contains(resultList)) { + result.add(Arrays.copyOf(resultList, resultList.length)); + } + return; + } + + // 递归选择下一个 + for (int i = 0; i < datas.length; i++) { + resultList[resultIndex] = datas[i]; + select(ArrayUtil.remove(datas, i), resultList, resultIndex + 1, result); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/math/BitStatusUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/BitStatusUtil.java new file mode 100644 index 0000000..994495a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/BitStatusUtil.java @@ -0,0 +1,81 @@ +package aiyh.utils.tool.cn.hutool.core.math; + +/** + * 通过位运算表示状态的工具类
+ * 参数必须是 `偶数` 且 `大于等于0`！ + * + * 工具实现见博客：https://blog.starxg.com/2020/11/bit-status/ + * + * @author huangxingguang，senssic + * @since 5.6.6 + */ +public class BitStatusUtil { + + /** + * 增加状态 + * + * @param states 原状态 + * @param stat 要添加的状态 + * @return 新的状态值 + */ + public static int add(int states, int stat) { + check(states, stat); + return states | stat; + } + + /** + * 判断是否含有状态 + * + * @param states 原状态 + * @param stat 要判断的状态 + * @return true：有 + */ + public static boolean has(int states, int stat) { + check(states, stat); + return (states & stat) == stat; + } + + /** + * 删除一个状态 + * + * @param states 原状态 + * @param stat 要删除的状态 + * @return 新的状态值 + */ + public static int remove(int states, int stat) { + check(states, stat); + if (has(states, stat)) { + return states ^ stat; + } + return states; + } + + /** + * 清空状态就是0 + * + * @return 0 + */ + public static int clear() { + return 0; + } + + /** + * 检查 + *
    + *
  • 必须大于0
    • + *
  • 必须为偶数
    • + *
+ * + * @param args 被检查的状态 + */ + private static void check(int... args) { + for (int arg : args) { + if (arg < 0) { + throw new IllegalArgumentException(arg + " 必须大于等于0"); + } + if ((arg & 1) == 1) { + throw new IllegalArgumentException(arg + " 不是偶数"); + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/math/Calculator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/Calculator.java new file mode 100644 index 0000000..09abf4b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/Calculator.java @@ -0,0 +1,201 @@ +package aiyh.utils.tool.cn.hutool.core.math; + +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.math.BigDecimal; +import java.util.Collections; +import java.util.Stack; + +/** + * 数学表达式计算工具类
+ * 见：https://github.com/dromara/hutool/issues/1090#issuecomment-693750140 + * + * @author trainliang, looly + * @since 5.4.3 + */ +public class Calculator { + private final Stack postfixStack = new Stack<>();// 后缀式栈 + private final int[] operatPriority = new int[]{0, 3, 2, 1, -1, 1, 0, 2};// 运用运算符ASCII码-40做索引的运算符优先级 + + /** + * 计算表达式的值 + * + * @param expression 表达式 + * @return 计算结果 + */ + public static double conversion(String expression) { + return (new Calculator()).calculate(expression); + } + + /** + * 按照给定的表达式计算 + * + * @param expression 要计算的表达式例如:5+12*(3+5)/7 + * @return 计算结果 + */ + public double calculate(String expression) { + prepare(transform(expression)); + + Stack resultStack = new Stack<>(); + Collections.reverse(postfixStack);// 将后缀式栈反转 + String firstValue, secondValue, currentOp;// 参与计算的第一个值，第二个值和算术运算符 + while (false == postfixStack.isEmpty()) { + currentOp = postfixStack.pop(); + if (false == isOperator(currentOp.charAt(0))) {// 如果不是运算符则存入操作数栈中 + currentOp = currentOp.replace("~", "-"); + resultStack.push(currentOp); + } else {// 如果是运算符则从操作数栈中取两个值和该数值一起参与运算 + secondValue = resultStack.pop(); + firstValue = resultStack.pop(); + + // 将负数标记符改为负号 + firstValue = firstValue.replace("~", "-"); + secondValue = secondValue.replace("~", "-"); + + BigDecimal tempResult = calculate(firstValue, secondValue, currentOp.charAt(0)); + resultStack.push(tempResult.toString()); + } + } + return Double.parseDouble(resultStack.pop()); + } + + /** + * 数据准备阶段将表达式转换成为后缀式栈 + * + * @param expression 表达式 + */ + private void prepare(String expression) { + final Stack opStack = new Stack<>(); + opStack.push(',');// 运算符放入栈底元素逗号，此符号优先级最低 + char[] arr = expression.toCharArray(); + int currentIndex = 0;// 当前字符的位置 + int count = 0;// 上次算术运算符到本次算术运算符的字符的长度便于或者之间的数值 + char currentOp, peekOp;// 当前操作符和栈顶操作符 + for (int i = 0; i < arr.length; i++) { + currentOp = arr[i]; + if (isOperator(currentOp)) {// 如果当前字符是运算符 + if (count > 0) { + postfixStack.push(new String(arr, currentIndex, count));// 取两个运算符之间的数字 + } + peekOp = opStack.peek(); + if (currentOp == ')') {// 遇到反括号则将运算符栈中的元素移除到后缀式栈中直到遇到左括号 + while (opStack.peek() != '(') { + postfixStack.push(String.valueOf(opStack.pop())); + } + opStack.pop(); + } else { + while (currentOp != '(' && peekOp != ',' && compare(currentOp, peekOp)) { + postfixStack.push(String.valueOf(opStack.pop())); + peekOp = opStack.peek(); + } + opStack.push(currentOp); + } + count = 0; + currentIndex = i + 1; + } else { + count++; + } + } + if (count > 1 || (count == 1 && !isOperator(arr[currentIndex]))) {// 最后一个字符不是括号或者其他运算符的则加入后缀式栈中 + postfixStack.push(new String(arr, currentIndex, count)); + } + + while (opStack.peek() != ',') { + postfixStack.push(String.valueOf(opStack.pop()));// 将操作符栈中的剩余的元素添加到后缀式栈中 + } + } + + /** + * 判断是否为算术符号 + * + * @param c 字符 + * @return 是否为算术符号 + */ + private boolean isOperator(char c) { + return c == '+' || c == '-' || c == '*' || c == '/' || c == '(' || c == ')' || c == '%'; + } + + /** + * 利用ASCII码-40做下标去算术符号优先级 + * + * @param cur 下标 + * @param peek peek + * @return 优先级，如果cur高或相等，返回true，否则false + */ + private boolean compare(char cur, char peek) {// 如果是peek优先级高于cur，返回true，默认都是peek优先级要低 + final int offset = 40; + if(cur == '%'){ + // %优先级最高 + cur = 47; + } + if(peek == '%'){ + // %优先级最高 + peek = 47; + } + + return operatPriority[peek - offset] >= operatPriority[cur - offset]; + } + + /** + * 按照给定的算术运算符做计算 + * + * @param firstValue 第一个值 + * @param secondValue 第二个值 + * @param currentOp 算数符，只支持'+'、'-'、'*'、'/'、'%' + * @return 结果 + */ + private BigDecimal calculate(String firstValue, String secondValue, char currentOp) { + BigDecimal result; + switch (currentOp) { + case '+': + result = NumberUtil.add(firstValue, secondValue); + break; + case '-': + result = NumberUtil.sub(firstValue, secondValue); + break; + case '*': + result = NumberUtil.mul(firstValue, secondValue); + break; + case '/': + result = NumberUtil.div(firstValue, secondValue); + break; + case '%': + result = NumberUtil.toBigDecimal(firstValue).remainder(NumberUtil.toBigDecimal(secondValue)); + break; + default: + throw new IllegalStateException("Unexpected value: " + currentOp); + } + return result; + } + + /** + * 将表达式中负数的符号更改 + * + * @param expression 例如-2+-1*(-3E-2)-(-1) 被转为 ~2+~1*(~3E~2)-(~1) + * @return 转换后的字符串 + */ + private static String transform(String expression) { + expression = StrUtil.cleanBlank(expression); + expression = StrUtil.removeSuffix(expression, "="); + final char[] arr = expression.toCharArray(); + for (int i = 0; i < arr.length; i++) { + if (arr[i] == '-') { + if (i == 0) { + arr[i] = '~'; + } else { + char c = arr[i - 1]; + if (c == '+' || c == '-' || c == '*' || c == '/' || c == '(' || c == 'E' || c == 'e') { + arr[i] = '~'; + } + } + } + } + if (arr[0] == '~' && (arr.length > 1 && arr[1] == '(')) { + arr[0] = '-'; + return "0" + new String(arr); + } else { + return new String(arr); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/math/Combination.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/Combination.java new file mode 100644 index 0000000..13fba73 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/Combination.java @@ -0,0 +1,107 @@ +package aiyh.utils.tool.cn.hutool.core.math; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 组合，即C(n, m)
+ * 排列组合相关类 参考：http://cgs1999.iteye.com/blog/2327664 + * + * @author looly + * @since 4.0.6 + */ +public class Combination implements Serializable { + private static final long serialVersionUID = 1L; + + private final String[] datas; + + /** + * 组合，即C(n, m)
+ * 排列组合相关类 参考：http://cgs1999.iteye.com/blog/2327664 + * + * @param datas 用于组合的数据 + */ + public Combination(String[] datas) { + this.datas = datas; + } + + /** + * 计算组合数，即C(n, m) = n!/((n-m)! * m!) + * + * @param n 总数 + * @param m 选择的个数 + * @return 组合数 + */ + public static long count(int n, int m) { + if (0 == m || n == m) { + return 1; + } + return (n > m) ? NumberUtil.factorial(n, n - m) / NumberUtil.factorial(m) : 0; + } + + /** + * 计算组合总数，即C(n, 1) + C(n, 2) + C(n, 3)... + * + * @param n 总数 + * @return 组合数 + */ + public static long countAll(int n) { + if (n < 0 || n > 63) { + throw new IllegalArgumentException(StrUtil.format("countAll must have n >= 0 and n <= 63, but got n={}", n)); + } + return n == 63 ? Long.MAX_VALUE : (1L << n) - 1; + } + + /** + * 组合选择（从列表中选择m个组合） + * + * @param m 选择个数 + * @return 组合结果 + */ + public List select(int m) { + final List result = new ArrayList<>((int) count(this.datas.length, m)); + select(0, new String[m], 0, result); + return result; + } + + /** + * 全组合 + * + * @return 全排列结果 + */ + public List selectAll() { + final List result = new ArrayList<>((int) countAll(this.datas.length)); + for (int i = 1; i <= this.datas.length; i++) { + result.addAll(select(i)); + } + return result; + } + + /** + * 组合选择 + * + * @param dataIndex 待选开始索引 + * @param resultList 前面（resultIndex-1）个的组合结果 + * @param resultIndex 选择索引，从0开始 + * @param result 结果集 + */ + private void select(int dataIndex, String[] resultList, int resultIndex, List result) { + int resultLen = resultList.length; + int resultCount = resultIndex + 1; + if (resultCount > resultLen) { // 全部选择完时，输出组合结果 + result.add(Arrays.copyOf(resultList, resultList.length)); + return; + } + + // 递归选择下一个 + for (int i = dataIndex; i < datas.length + resultCount - resultLen; i++) { + resultList[resultIndex] = datas[i]; + select(i + 1, resultList, resultIndex + 1, result); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/math/MathUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/MathUtil.java new file mode 100644 index 0000000..c0ad766 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/MathUtil.java @@ -0,0 +1,103 @@ +package aiyh.utils.tool.cn.hutool.core.math; + +import java.util.List; + +/** + * 数学相关方法工具类
+ * 此工具类与{@link aiyh.utils.tool.cn.hutool.core.util.NumberUtil}属于一类工具，NumberUtil偏向于简单数学计算的封装，MathUtil偏向复杂数学计算 + * + * @author looly + * @since 4.0.7 + */ +public class MathUtil { + + //--------------------------------------------------------------------------------------------- Arrangement + /** + * 计算排列数，即A(n, m) = n!/(n-m)! + * + * @param n 总数 + * @param m 选择的个数 + * @return 排列数 + */ + public static long arrangementCount(int n, int m) { + return Arrangement.count(n, m); + } + + /** + * 计算排列数，即A(n, n) = n! + * + * @param n 总数 + * @return 排列数 + */ + public static long arrangementCount(int n) { + return Arrangement.count(n); + } + + /** + * 排列选择（从列表中选择n个排列） + * + * @param datas 待选列表 + * @param m 选择个数 + * @return 所有排列列表 + */ + public static List arrangementSelect(String[] datas, int m) { + return new Arrangement(datas).select(m); + } + + /** + * 全排列选择（列表全部参与排列） + * + * @param datas 待选列表 + * @return 所有排列列表 + */ + public static List arrangementSelect(String[] datas) { + return new Arrangement(datas).select(); + } + + //--------------------------------------------------------------------------------------------- Combination + /** + * 计算组合数，即C(n, m) = n!/((n-m)! * m!) + * + * @param n 总数 + * @param m 选择的个数 + * @return 组合数 + */ + public static long combinationCount(int n, int m) { + return Combination.count(n, m); + } + + /** + * 组合选择（从列表中选择n个组合） + * + * @param datas 待选列表 + * @param m 选择个数 + * @return 所有组合列表 + */ + public static List combinationSelect(String[] datas, int m) { + return new Combination(datas).select(m); + } + + /** + * 金额元转换为分 + * + * @param yuan 金额，单位元 + * @return 金额，单位分 + * @since 5.7.11 + */ + public static long yuanToCent(double yuan) { + return new Money(yuan).getCent(); + } + + /** + * 金额分转换为元 + * + * @param cent 金额，单位分 + * @return 金额，单位元 + * @since 5.7.11 + */ + public static double centToYuan(long cent) { + long yuan = cent / 100; + int centPart = (int) (cent % 100); + return new Money(yuan, centPart).getAmount().doubleValue(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/math/Money.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/Money.java new file mode 100644 index 0000000..1fbeaa6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/Money.java @@ -0,0 +1,854 @@ +package aiyh.utils.tool.cn.hutool.core.math; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.File; +import java.io.Serializable; +import java.math.BigDecimal; +import java.math.RoundingMode; +import java.util.Currency; + +/** + * 单币种货币类，处理货币算术、币种和取整。 + *

+ * 感谢提供此方法的用户：https://github.com/dromara/hutool/issues/605 + * + *

+ * 货币类中封装了货币金额和币种。目前金额在内部是long类型表示， + * 单位是所属币种的最小货币单位（对人民币是分）。 + * + *

+ * 目前，货币实现了以下主要功能：
+ *

    + *
  • 支持货币对象与double(float)/long(int)/String/BigDecimal之间相互转换。 + *
  • 货币类在运算中提供与JDK中的BigDecimal类似的运算接口， + * BigDecimal的运算接口支持任意指定精度的运算功能，能够支持各种 + * 可能的财务规则。 + *
  • 货币类在运算中也提供一组简单运算接口，使用这组运算接口，则在 + * 精度处理上使用缺省的处理规则。 + *
  • 推荐使用Money，不建议直接使用BigDecimal的原因之一在于， + * 使用BigDecimal，同样金额和币种的货币使用BigDecimal存在多种可能 + * 的表示，例如：new BigDecimal("10.5")与new BigDecimal("10.50") + * 不相等，因为scale不等。使得Money类，同样金额和币种的货币只有 + * 一种表示方式，new Money("10.5")和new Money("10.50")应该是相等的。 + *
  • 不推荐直接使用BigDecimal的另一原因在于， BigDecimal是Immutable， + * 一旦创建就不可更改，对BigDecimal进行任意运算都会生成一个新的 + * BigDecimal对象，因此对于大批量统计的性能不够满意。Money类是 + * mutable的，对大批量统计提供较好的支持。 + *
  • 提供基本的格式化功能。 + *
  • Money类中不包含与业务相关的统计功能和格式化功能。业务相关的功能 + * 建议使用utility类来实现。 + *
  • Money类实现了Serializable接口，支持作为远程调用的参数和返回值。 + *
  • Money类实现了equals和hashCode方法。 + *
+ * + * @author ddatsh + * @since 5.0.4 + */ + +public class Money implements Serializable, Comparable { + private static final long serialVersionUID = -1004117971993390293L; + + /** + * 缺省的币种代码，为CNY（人民币）。 + */ + public static final String DEFAULT_CURRENCY_CODE = "CNY"; + + /** + * 缺省的取整模式，为{@link RoundingMode#HALF_EVEN} + * （四舍五入，当小数为0.5时，则取最近的偶数）。 + */ + public static final RoundingMode DEFAULT_ROUNDING_MODE = RoundingMode.HALF_EVEN; + + /** + * 一组可能的元/分换算比例。 + * + *

+ * 此处，“分”是指货币的最小单位，“元”是货币的最常用单位， + * 不同的币种有不同的元/分换算比例，如人民币是100，而日元为1。 + */ + private static final int[] CENT_FACTORS = new int[]{1, 10, 100, 1000}; + + /** + * 金额，以分为单位。 + */ + private long cent; + + /** + * 币种。 + */ + private final Currency currency; + + // 构造器 ==================================================== + + /** + * 缺省构造器。 + * + *

+ * 创建一个具有缺省金额（0）和缺省币种的货币对象。 + */ + public Money() { + this(0); + } + + /** + * 构造器。 + * + *

+ * 创建一个具有金额{@code yuan}元{@code cent}分和缺省币种的货币对象。 + * + * @param yuan 金额元数，0的情况下表示元的部分从分中截取 + * @param cent 金额分数。 + */ + public Money(long yuan, int cent) { + this(yuan, cent, Currency.getInstance(DEFAULT_CURRENCY_CODE)); + } + + /** + * 构造器。 + * + *

+ * 创建一个具有金额{@code yuan}元{@code cent}分和指定币种的货币对象。 + * + * @param yuan 金额元数，0的情况下表示元的部分从分中截取 + * @param cent 金额分数。 + * @param currency 货币单位 + */ + public Money(long yuan, int cent, Currency currency) { + this.currency = currency; + + if(0 == yuan) { + this.cent = cent; + } else{ + this.cent = (yuan * getCentFactor()) + (cent % getCentFactor()); + } + } + + /** + * 构造器。 + * + *

+ * 创建一个具有金额{@code amount}元和缺省币种的货币对象。 + * + * @param amount 金额，以元为单位。 + */ + public Money(String amount) { + this(amount, Currency.getInstance(DEFAULT_CURRENCY_CODE)); + } + + /** + * 构造器。 + * + *

+ * 创建一个具有金额{@code amount}元和指定币种{@code currency}的货币对象。 + * + * @param amount 金额，以元为单位。 + * @param currency 币种。 + */ + public Money(String amount, Currency currency) { + this(new BigDecimal(amount), currency); + } + + /** + * 构造器。 + * + *

+ * 创建一个具有金额{@code amount}元和指定币种{@code currency}的货币对象。 + * 如果金额不能转换为整数分，则使用指定的取整模式{@code roundingMode}取整。 + * + * @param amount 金额，以元为单位。 + * @param currency 币种。 + * @param roundingMode 取整模式。 + */ + public Money(String amount, Currency currency, RoundingMode roundingMode) { + this(new BigDecimal(amount), currency, roundingMode); + } + + /** + * 构造器。 + * + *

+ * 创建一个具有参数{@code amount}指定金额和缺省币种的货币对象。 + * 如果金额不能转换为整数分，则使用四舍五入方式取整。 + * + *

+ * 注意：由于double类型运算中存在误差，使用四舍五入方式取整的 + * 结果并不确定，因此，应尽量避免使用double类型创建货币类型。 + * 例： + * {@code + * assertEquals(999, Math.round(9.995 * 100)); + * assertEquals(1000, Math.round(999.5)); + * money = new Money((9.995)); + * assertEquals(999, money.getCent()); + * money = new Money(10.005); + * assertEquals(1001, money.getCent()); + * } + * + * @param amount 金额，以元为单位。 + */ + public Money(double amount) { + this(amount, Currency.getInstance(DEFAULT_CURRENCY_CODE)); + } + + /** + * 构造器。 + * + *

+ * 创建一个具有金额{@code amount}和指定币种的货币对象。 + * 如果金额不能转换为整数分，则使用四舍五入方式取整。 + * + *

+ * 注意：由于double类型运算中存在误差，使用四舍五入方式取整的 + * 结果并不确定，因此，应尽量避免使用double类型创建货币类型。 + * 例： + * {@code + * assertEquals(999, Math.round(9.995 * 100)); + * assertEquals(1000, Math.round(999.5)); + * money = new Money((9.995)); + * assertEquals(999, money.getCent()); + * money = new Money(10.005); + * assertEquals(1001, money.getCent()); + * } + * + * @param amount 金额，以元为单位。 + * @param currency 币种。 + */ + public Money(double amount, Currency currency) { + this.currency = currency; + this.cent = Math.round(amount * getCentFactor()); + } + + /** + * 构造器。 + * + *

+ * 创建一个具有金额{@code amount}和缺省币种的货币对象。 + * 如果金额不能转换为整数分，则使用缺省取整模式{@code DEFAULT_ROUNDING_MODE}取整。 + * + * @param amount 金额，以元为单位。 + */ + public Money(BigDecimal amount) { + this(amount, Currency.getInstance(DEFAULT_CURRENCY_CODE)); + } + + /** + * 构造器。 + * + *

+ * 创建一个具有参数{@code amount}指定金额和缺省币种的货币对象。 + * 如果金额不能转换为整数分，则使用指定的取整模式{@code roundingMode}取整。 + * + * @param amount 金额，以元为单位。 + * @param roundingMode 取整模式 + */ + public Money(BigDecimal amount, RoundingMode roundingMode) { + this(amount, Currency.getInstance(DEFAULT_CURRENCY_CODE), roundingMode); + } + + /** + * 构造器。 + * + *

+ * 创建一个具有金额{@code amount}和指定币种的货币对象。 + * 如果金额不能转换为整数分，则使用缺省的取整模式{@code DEFAULT_ROUNDING_MODE}进行取整。 + * + * @param amount 金额，以元为单位。 + * @param currency 币种 + */ + public Money(BigDecimal amount, Currency currency) { + this(amount, currency, DEFAULT_ROUNDING_MODE); + } + + /** + * 构造器。 + * + *

+ * 创建一个具有金额{@code amount}和指定币种的货币对象。 + * 如果金额不能转换为整数分，则使用指定的取整模式{@code roundingMode}取整。 + * + * @param amount 金额，以元为单位。 + * @param currency 币种。 + * @param roundingMode 取整模式。 + */ + public Money(BigDecimal amount, Currency currency, RoundingMode roundingMode) { + this.currency = currency; + this.cent = rounding(amount.movePointRight(currency.getDefaultFractionDigits()), + roundingMode); + } + + // Bean方法 ==================================================== + + /** + * 获取本货币对象代表的金额数。 + * + * @return 金额数，以元为单位。 + */ + public BigDecimal getAmount() { + return BigDecimal.valueOf(cent, currency.getDefaultFractionDigits()); + } + + /** + * 设置本货币对象代表的金额数。 + * + * @param amount 金额数，以元为单位。 + */ + public void setAmount(BigDecimal amount) { + if (amount != null) { + cent = rounding(amount.movePointRight(2), DEFAULT_ROUNDING_MODE); + } + } + + /** + * 获取本货币对象代表的金额数。 + * + * @return 金额数，以分为单位。 + */ + public long getCent() { + return cent; + } + + /** + * 获取本货币对象代表的币种。 + * + * @return 本货币对象所代表的币种。 + */ + public Currency getCurrency() { + return currency; + } + + /** + * 获取本货币币种的元/分换算比率。 + * + * @return 本货币币种的元/分换算比率。 + */ + public int getCentFactor() { + return CENT_FACTORS[currency.getDefaultFractionDigits()]; + } + + // 基本对象方法 =================================================== + + /** + * 判断本货币对象与另一对象是否相等。 + *

+ * 货币对象与另一对象相等的充分必要条件是：
+ *

    + *
  • 另一对象也属货币对象类。 + *
  • 金额相同。 + *
  • 币种相同。 + *
+ * + * @param other 待比较的另一对象。 + * @return {@code true}表示相等，{@code false}表示不相等。 + */ + @Override + public boolean equals(Object other) { + return (other instanceof Money) && equals((Money) other); + } + + /** + * 判断本货币对象与另一货币对象是否相等。 + *

+ * 货币对象与另一货币对象相等的充分必要条件是：
+ *

    + *
  • 金额相同。 + *
  • 币种相同。 + *
+ * + * @param other 待比较的另一货币对象。 + * @return {@code true}表示相等，{@code false}表示不相等。 + */ + public boolean equals(Money other) { + return currency.equals(other.currency) && (cent == other.cent); + } + + /** + * 计算本货币对象的杂凑值。 + * + * @return 本货币对象的杂凑值。 + */ + @Override + public int hashCode() { + return (int) (cent ^ (cent >>> 32)); + } + + /** + * 货币比较。 + * + *

+ * 比较本货币对象与另一货币对象的大小。 + * 如果待比较的两个货币对象的币种不同，则抛出{@code java.lang.IllegalArgumentException}。 + * 如果本货币对象的金额少于待比较货币对象，则返回-1。 + * 如果本货币对象的金额等于待比较货币对象，则返回0。 + * 如果本货币对象的金额大于待比较货币对象，则返回1。 + * + * @param other 另一对象。 + * @return -1表示小于，0表示等于，1表示大于。 + * @throws IllegalArgumentException 待比较货币对象与本货币对象的币种不同。 + */ + @Override + public int compareTo(Money other) { + assertSameCurrencyAs(other); + return Long.compare(cent, other.cent); + } + + /** + * 货币比较。 + * + *

+ * 判断本货币对象是否大于另一货币对象。 + * 如果待比较的两个货币对象的币种不同，则抛出{@code java.lang.IllegalArgumentException}。 + * 如果本货币对象的金额大于待比较货币对象，则返回true，否则返回false。 + * + * @param other 另一对象。 + * @return true表示大于，false表示不大于（小于等于）。 + * @throws IllegalArgumentException 待比较货币对象与本货币对象的币种不同。 + */ + public boolean greaterThan(Money other) { + return compareTo(other) > 0; + } + + // 货币算术 ========================================== + + /** + * 货币加法。 + * + *

+ * 如果两货币币种相同，则返回一个新的相同币种的货币对象，其金额为 + * 两货币对象金额之和，本货币对象的值不变。 + * 如果两货币对象币种不同，抛出{@code java.lang.IllegalArgumentException}。 + * + * @param other 作为加数的货币对象。 + * @return 相加后的结果。 + * @throws IllegalArgumentException 如果本货币对象与另一货币对象币种不同。 + */ + public Money add(Money other) { + assertSameCurrencyAs(other); + + return newMoneyWithSameCurrency(cent + other.cent); + } + + /** + * 货币累加。 + * + *

+ * 如果两货币币种相同，则本货币对象的金额等于两货币对象金额之和，并返回本货币对象的引用。 + * 如果两货币对象币种不同，抛出{@code java.lang.IllegalArgumentException}。 + * + * @param other 作为加数的货币对象。 + * @return 累加后的本货币对象。 + * @throws IllegalArgumentException 如果本货币对象与另一货币对象币种不同。 + */ + public Money addTo(Money other) { + assertSameCurrencyAs(other); + + this.cent += other.cent; + + return this; + } + + /** + * 货币减法。 + * + *

+ * 如果两货币币种相同，则返回一个新的相同币种的货币对象，其金额为 + * 本货币对象的金额减去参数货币对象的金额。本货币对象的值不变。 + * 如果两货币币种不同，抛出{@code java.lang.IllegalArgumentException}。 + * + * @param other 作为减数的货币对象。 + * @return 相减后的结果。 + * @throws IllegalArgumentException 如果本货币对象与另一货币对象币种不同。 + */ + public Money subtract(Money other) { + assertSameCurrencyAs(other); + + return newMoneyWithSameCurrency(cent - other.cent); + } + + /** + * 货币累减。 + * + *

+ * 如果两货币币种相同，则本货币对象的金额等于两货币对象金额之差，并返回本货币对象的引用。 + * 如果两货币币种不同，抛出{@code java.lang.IllegalArgumentException}。 + * + * @param other 作为减数的货币对象。 + * @return 累减后的本货币对象。 + * @throws IllegalArgumentException 如果本货币对象与另一货币对象币种不同。 + */ + public Money subtractFrom(Money other) { + assertSameCurrencyAs(other); + + this.cent -= other.cent; + + return this; + } + + /** + * 货币乘法。 + * + *

+ * 返回一个新的货币对象，币种与本货币对象相同，金额为本货币对象的金额乘以乘数。 + * 本货币对象的值不变。 + * + * @param val 乘数 + * @return 乘法后的结果。 + */ + public Money multiply(long val) { + return newMoneyWithSameCurrency(cent * val); + } + + /** + * 货币累乘。 + * + *

+ * 本货币对象金额乘以乘数，并返回本货币对象。 + * + * @param val 乘数 + * @return 累乘后的本货币对象。 + */ + public Money multiplyBy(long val) { + this.cent *= val; + + return this; + } + + /** + * 货币乘法。 + * + *

+ * 返回一个新的货币对象，币种与本货币对象相同，金额为本货币对象的金额乘以乘数。 + * 本货币对象的值不变。如果相乘后的金额不能转换为整数分，则四舍五入。 + * + * @param val 乘数 + * @return 相乘后的结果。 + */ + public Money multiply(double val) { + return newMoneyWithSameCurrency(Math.round(cent * val)); + } + + /** + * 货币累乘。 + * + *

+ * 本货币对象金额乘以乘数，并返回本货币对象。 + * 如果相乘后的金额不能转换为整数分，则使用四舍五入。 + * + * @param val 乘数 + * @return 累乘后的本货币对象。 + */ + public Money multiplyBy(double val) { + this.cent = Math.round(this.cent * val); + + return this; + } + + /** + * 货币乘法。 + * + *

+ * 返回一个新的货币对象，币种与本货币对象相同，金额为本货币对象的金额乘以乘数。 + * 本货币对象的值不变。如果相乘后的金额不能转换为整数分，使用缺省的取整模式 + * {@code DEFUALT_ROUNDING_MODE}进行取整。 + * + * @param val 乘数 + * @return 相乘后的结果。 + */ + public Money multiply(BigDecimal val) { + return multiply(val, DEFAULT_ROUNDING_MODE); + } + + /** + * 货币累乘。 + * + *

+ * 本货币对象金额乘以乘数，并返回本货币对象。 + * 如果相乘后的金额不能转换为整数分，使用缺省的取整方式 + * {@code DEFUALT_ROUNDING_MODE}进行取整。 + * + * @param val 乘数 + * @return 累乘后的结果。 + */ + public Money multiplyBy(BigDecimal val) { + return multiplyBy(val, DEFAULT_ROUNDING_MODE); + } + + /** + * 货币乘法。 + * + *

+ * 返回一个新的货币对象，币种与本货币对象相同，金额为本货币对象的金额乘以乘数。 + * 本货币对象的值不变。如果相乘后的金额不能转换为整数分，使用指定的取整方式 + * {@code roundingMode}进行取整。 + * + * @param val 乘数 + * @param roundingMode 取整方式 + * @return 相乘后的结果。 + */ + public Money multiply(BigDecimal val, RoundingMode roundingMode) { + BigDecimal newCent = BigDecimal.valueOf(cent).multiply(val); + + return newMoneyWithSameCurrency(rounding(newCent, roundingMode)); + } + + /** + * 货币累乘。 + * + *

+ * 本货币对象金额乘以乘数，并返回本货币对象。 + * 如果相乘后的金额不能转换为整数分，使用指定的取整方式 + * {@code roundingMode}进行取整。 + * + * @param val 乘数 + * @param roundingMode 取整方式 + * @return 累乘后的结果。 + */ + public Money multiplyBy(BigDecimal val, RoundingMode roundingMode) { + BigDecimal newCent = BigDecimal.valueOf(cent).multiply(val); + + this.cent = rounding(newCent, roundingMode); + + return this; + } + + /** + * 货币除法。 + * + *

+ * 返回一个新的货币对象，币种与本货币对象相同，金额为本货币对象的金额除以除数。 + * 本货币对象的值不变。如果相除后的金额不能转换为整数分，使用四舍五入方式取整。 + * + * @param val 除数 + * @return 相除后的结果。 + */ + public Money divide(double val) { + return newMoneyWithSameCurrency(Math.round(cent / val)); + } + + /** + * 货币累除。 + * + *

+ * 本货币对象金额除以除数，并返回本货币对象。 + * 如果相除后的金额不能转换为整数分，使用四舍五入方式取整。 + * + * @param val 除数 + * @return 累除后的结果。 + */ + public Money divideBy(double val) { + this.cent = Math.round(this.cent / val); + + return this; + } + + /** + * 货币除法。 + * + *

+ * 返回一个新的货币对象，币种与本货币对象相同，金额为本货币对象的金额除以除数。 + * 本货币对象的值不变。如果相除后的金额不能转换为整数分，使用缺省的取整模式 + * {@code DEFAULT_ROUNDING_MODE}进行取整。 + * + * @param val 除数 + * @return 相除后的结果。 + */ + public Money divide(BigDecimal val) { + return divide(val, DEFAULT_ROUNDING_MODE); + } + + /** + * 货币除法。 + * + *

+ * 返回一个新的货币对象，币种与本货币对象相同，金额为本货币对象的金额除以除数。 + * 本货币对象的值不变。如果相除后的金额不能转换为整数分，使用指定的取整模式 + * {@code roundingMode}进行取整。 + * + * @param val 除数 + * @param roundingMode 取整 + * @return 相除后的结果。 + */ + public Money divide(BigDecimal val, RoundingMode roundingMode) { + BigDecimal newCent = BigDecimal.valueOf(cent).divide(val, roundingMode); + + return newMoneyWithSameCurrency(newCent.longValue()); + } + + /** + * 货币累除。 + * + *

+ * 本货币对象金额除以除数，并返回本货币对象。 + * 如果相除后的金额不能转换为整数分，使用缺省的取整模式 + * {@code DEFAULT_ROUNDING_MODE}进行取整。 + * + * @param val 除数 + * @return 累除后的结果。 + */ + public Money divideBy(BigDecimal val) { + return divideBy(val, DEFAULT_ROUNDING_MODE); + } + + /** + * 货币累除。 + * + *

+ * 本货币对象金额除以除数，并返回本货币对象。 + * 如果相除后的金额不能转换为整数分，使用指定的取整模式 + * {@code roundingMode}进行取整。 + * + * @param val 除数 + * @param roundingMode 保留小数方式 + * @return 累除后的结果。 + */ + public Money divideBy(BigDecimal val, RoundingMode roundingMode) { + BigDecimal newCent = BigDecimal.valueOf(cent).divide(val, roundingMode); + + this.cent = newCent.longValue(); + + return this; + } + + /** + * 货币分配。 + * + *

+ * 将本货币对象尽可能平均分配成{@code targets}份。 + * 如果不能平均分配尽，则将零头放到开始的若干份中。分配 + * 运算能够确保不会丢失金额零头。 + * + * @param targets 待分配的份数 + * @return 货币对象数组，数组的长度与分配份数相同，数组元素 + * 从大到小排列，所有货币对象的金额最多只相差1分。 + */ + public Money[] allocate(int targets) { + Money[] results = new Money[targets]; + + Money lowResult = newMoneyWithSameCurrency(cent / targets); + Money highResult = newMoneyWithSameCurrency(lowResult.cent + 1); + + int remainder = (int) cent % targets; + + for (int i = 0; i < remainder; i++) { + results[i] = highResult; + } + + for (int i = remainder; i < targets; i++) { + results[i] = lowResult; + } + + return results; + } + + /** + * 货币分配。 + * + *

+ * 将本货币对象按照规定的比例分配成若干份。分配所剩的零头 + * 从第一份开始顺序分配。分配运算确保不会丢失金额零头。 + * + * @param ratios 分配比例数组，每一个比例是一个长整型，代表 + * 相对于总数的相对数。 + * @return 货币对象数组，数组的长度与分配比例数组的长度相同。 + */ + public Money[] allocate(long[] ratios) { + Money[] results = new Money[ratios.length]; + + long total = 0; + + for (long element : ratios) { + total += element; + } + + long remainder = cent; + + for (int i = 0; i < results.length; i++) { + results[i] = newMoneyWithSameCurrency((cent * ratios[i]) / total); + remainder -= results[i].cent; + } + + for (int i = 0; i < remainder; i++) { + results[i].cent++; + } + + return results; + } + + // 格式化方法 ================================================= + + /** + * 生成本对象的缺省字符串表示 + */ + @Override + public String toString() { + return getAmount().toString(); + } + + // 内部方法 =================================================== + + /** + * 断言本货币对象与另一货币对象是否具有相同的币种。 + * + *

+ * 如果本货币对象与另一货币对象具有相同的币种，则方法返回。 + * 否则抛出运行时异常{@code java.lang.IllegalArgumentException}。 + * + * @param other 另一货币对象 + * @throws IllegalArgumentException 如果本货币对象与另一货币对象币种不同。 + */ + protected void assertSameCurrencyAs(Money other) { + if (!currency.equals(other.currency)) { + throw new IllegalArgumentException("Money math currency mismatch."); + } + } + + /** + * 对BigDecimal型的值按指定取整方式取整。 + * + * @param val 待取整的BigDecimal值 + * @param roundingMode 取整方式 + * @return 取整后的long型值 + */ + protected long rounding(BigDecimal val, RoundingMode roundingMode) { + return val.setScale(0, roundingMode).longValue(); + } + + /** + * 创建一个币种相同，具有指定金额的货币对象。 + * + * @param cent 金额，以分为单位 + * @return 一个新建的币种相同，具有指定金额的货币对象 + */ + protected Money newMoneyWithSameCurrency(long cent) { + Money money = new Money(0, currency); + + money.cent = cent; + + return money; + } + + // 调试方式 ================================================== + + /** + * 生成本对象内部变量的字符串表示，用于调试。 + * + * @return 本对象内部变量的字符串表示。 + */ + public String dump() { + return StrUtil.builder() + .append("cent = ") + .append(this.cent) + .append(File.separatorChar) + .append("currency = ") + .append(this.currency) + .toString(); + } + + /** + * 设置货币的分值。 + * + * @param cent 分值 + */ + public void setCent(long cent) { + this.cent = cent; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/math/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/package-info.java new file mode 100644 index 0000000..b45666a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/math/package-info.java @@ -0,0 +1,7 @@ +/** + * 提供数学计算相关封装，包括排列组合等，入口为MathUtil + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.math; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/DefaultTrustManager.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/DefaultTrustManager.java new file mode 100644 index 0000000..0dd418f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/DefaultTrustManager.java @@ -0,0 +1,51 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import javax.net.ssl.SSLEngine; +import javax.net.ssl.X509ExtendedTrustManager; +import java.net.Socket; +import java.security.cert.X509Certificate; + +/** + * 默认信任管理器，默认信任所有客户端和服务端证书
+ * 继承{@link X509ExtendedTrustManager}的原因见：https://blog.csdn.net/ghaohao/article/details/79454913 + * + * @author Looly + * @since 5.5.7 + */ +public class DefaultTrustManager extends X509ExtendedTrustManager { + + /** + * 默认的全局单例默认信任管理器，默认信任所有客户端和服务端证书 + * @since 5.7.8 + */ + public static DefaultTrustManager INSTANCE = new DefaultTrustManager(); + + @Override + public X509Certificate[] getAcceptedIssuers() { + return new X509Certificate[0]; + } + + @Override + public void checkClientTrusted(X509Certificate[] chain, String authType) { + } + + @Override + public void checkServerTrusted(X509Certificate[] chain, String authType) { + } + + @Override + public void checkClientTrusted(X509Certificate[] x509Certificates, String s, Socket socket) { + } + + @Override + public void checkServerTrusted(X509Certificate[] x509Certificates, String s, Socket socket) { + } + + @Override + public void checkClientTrusted(X509Certificate[] x509Certificates, String s, SSLEngine sslEngine) { + } + + @Override + public void checkServerTrusted(X509Certificate[] x509Certificates, String s, SSLEngine sslEngine) { + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/FormUrlencoded.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/FormUrlencoded.java new file mode 100644 index 0000000..d4be7aa --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/FormUrlencoded.java @@ -0,0 +1,19 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import aiyh.utils.tool.cn.hutool.core.codec.PercentCodec; + +/** + * application/x-www-form-urlencoded，遵循W3C HTML Form content types规范，如空格须转+，+须被编码
+ * 规范见：https://url.spec.whatwg.org/#urlencoded-serializing + * + * @since 5.7.16 + */ +public class FormUrlencoded { + + /** + * query中的value，默认除"-", "_", ".", "*"外都编码
+ * 这个类似于JDK提供的{@link java.net.URLEncoder} + */ + public static final PercentCodec ALL = PercentCodec.of(RFC3986.UNRESERVED) + .removeSafe('~').addSafe('*').setEncodeSpaceAsPlus(true); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/Ipv4Util.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/Ipv4Util.java new file mode 100755 index 0000000..c9f3fc9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/Ipv4Util.java @@ -0,0 +1,410 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import aiyh.utils.tool.cn.hutool.core.collection.ListUtil; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.PatternPool; +import aiyh.utils.tool.cn.hutool.core.lang.Validator; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.regex.Matcher; + +/** + * IPV4地址工具类 + * + *

pr自：https://gitee.com/loolly/hutool/pulls/161

+ * + * @author ZhuKun + * @since 5.4.1 + */ +public class Ipv4Util { + + public static final String LOCAL_IP = "127.0.0.1"; + + /** + * IP段的分割符 + */ + public static final String IP_SPLIT_MARK = "-"; + + /** + * IP与掩码的分割符 + */ + public static final String IP_MASK_SPLIT_MARK = StrUtil.SLASH; + + /** + * 最大掩码位 + */ + public static final int IP_MASK_MAX = 32; + + /** + * 格式化IP段 + * + * @param ip IP地址 + * @param mask 掩码 + * @return 返回xxx.xxx.xxx.xxx/mask的格式 + */ + public static String formatIpBlock(String ip, String mask) { + return ip + IP_MASK_SPLIT_MARK + getMaskBitByMask(mask); + } + + /** + * 智能转换IP地址集合 + * + * @param ipRange IP段，支持X.X.X.X-X.X.X.X或X.X.X.X/X + * @param isAll true:全量地址，false:可用地址；仅在ipRange为X.X.X.X/X时才生效 + * @return IP集 + */ + public static List list(String ipRange, boolean isAll) { + if (ipRange.contains(IP_SPLIT_MARK)) { + // X.X.X.X-X.X.X.X + final String[] range = StrUtil.splitToArray(ipRange, IP_SPLIT_MARK); + return list(range[0], range[1]); + } else if (ipRange.contains(IP_MASK_SPLIT_MARK)) { + // X.X.X.X/X + final String[] param = StrUtil.splitToArray(ipRange, IP_MASK_SPLIT_MARK); + return list(param[0], Integer.parseInt(param[1]), isAll); + } else { + return ListUtil.toList(ipRange); + } + } + + /** + * 根据IP地址、子网掩码获取IP地址区间 + * + * @param ip IP地址 + * @param maskBit 掩码位，例如24、32 + * @param isAll true:全量地址，false:可用地址 + * @return 区间地址 + */ + public static List list(String ip, int maskBit, boolean isAll) { + if (maskBit == IP_MASK_MAX) { + final List list = new ArrayList<>(); + if (isAll) { + list.add(ip); + } + return list; + } + + String startIp = getBeginIpStr(ip, maskBit); + String endIp = getEndIpStr(ip, maskBit); + if (isAll) { + return list(startIp, endIp); + } + + int lastDotIndex = startIp.lastIndexOf(CharUtil.DOT) + 1; + startIp = StrUtil.subPre(startIp, lastDotIndex) + + (Integer.parseInt(Objects.requireNonNull(StrUtil.subSuf(startIp, lastDotIndex))) + 1); + lastDotIndex = endIp.lastIndexOf(CharUtil.DOT) + 1; + endIp = StrUtil.subPre(endIp, lastDotIndex) + + (Integer.parseInt(Objects.requireNonNull(StrUtil.subSuf(endIp, lastDotIndex))) - 1); + return list(startIp, endIp); + } + + /** + * 得到IP地址区间 + * + * @param ipFrom 开始IP + * @param ipTo 结束IP + * @return 区间地址 + */ + public static List list(String ipFrom, String ipTo) { + // 确定ip数量 + final int count = countByIpRange(ipFrom, ipTo); + final int[] from = Convert.convert(int[].class, StrUtil.splitToArray(ipFrom, CharUtil.DOT)); + final int[] to = Convert.convert(int[].class, StrUtil.splitToArray(ipTo, CharUtil.DOT)); + + final List ips = new ArrayList<>(count); + // 是否是循环的第一个值 + boolean aIsStart = true, bIsStart = true, cIsStart = true; + // 是否是循环的最后一个值 + boolean aIsEnd, bIsEnd, cIsEnd; + // 循环的结束值 + int aEnd = to[0], bEnd, cEnd, dEnd; + for (int a = from[0]; a <= aEnd; a++) { + aIsEnd = (a == aEnd); + // 本次循环的结束结束值 + bEnd = aIsEnd ? to[1] : 255; + for (int b = (aIsStart ? from[1] : 0); b <= bEnd; b++) { + // 在上一个循环是最后值的基础上进行判断 + bIsEnd = aIsEnd && (b == bEnd); + cEnd = bIsEnd ? to[2] : 255; + for (int c = (bIsStart ? from[2] : 0); c <= cEnd; c++) { + // 在之前循环是最后值的基础上进行判断 + cIsEnd = bIsEnd && (c == cEnd); + dEnd = cIsEnd ? to[3] : 255; + for (int d = (cIsStart ? from[3] : 0); d <= dEnd; d++) { + ips.add(a + "." + b + "." + c + "." + d); + } + cIsStart = false; + } + bIsStart = false; + } + aIsStart = false; + } + return ips; + } + + /** + * 根据long值获取ip v4地址：xx.xx.xx.xx + * + * @param longIP IP的long表示形式 + * @return IP V4 地址 + */ + public static String longToIpv4(long longIP) { + final StringBuilder sb = StrUtil.builder(); + // 直接右移24位 + sb.append(longIP >> 24 & 0xFF); + sb.append(CharUtil.DOT); + // 将高8位置0，然后右移16位 + sb.append(longIP >> 16 & 0xFF); + sb.append(CharUtil.DOT); + sb.append(longIP >> 8 & 0xFF); + sb.append(CharUtil.DOT); + sb.append(longIP & 0xFF); + return sb.toString(); + } + + /** + * 根据ip地址(xxx.xxx.xxx.xxx)计算出long型的数据 + * 方法别名：inet_aton + * + * @param strIP IP V4 地址 + * @return long值 + */ + public static long ipv4ToLong(String strIP) { + final Matcher matcher = PatternPool.IPV4.matcher(strIP); + if (matcher.matches()) { + return matchAddress(matcher); + } +// Validator.validateIpv4(strIP, "Invalid IPv4 address!"); +// final long[] ip = Convert.convert(long[].class, StrUtil.split(strIP, CharUtil.DOT)); +// return (ip[0] << 24) + (ip[1] << 16) + (ip[2] << 8) + ip[3]; + throw new IllegalArgumentException("Invalid IPv4 address!"); + } + + /** + * 根据ip地址(xxx.xxx.xxx.xxx)计算出long型的数据, 如果格式不正确返回 defaultValue + * @param strIP IP V4 地址 + * @param defaultValue 默认值 + * @return long值 + */ + public static long ipv4ToLong(String strIP, long defaultValue) { + return Validator.isIpv4(strIP) ? ipv4ToLong(strIP) : defaultValue; + } + + /** + * 根据 ip/掩码位 计算IP段的起始IP（字符串型） + * 方法别名：inet_ntoa + * + * @param ip 给定的IP，如218.240.38.69 + * @param maskBit 给定的掩码位，如30 + * @return 起始IP的字符串表示 + */ + public static String getBeginIpStr(String ip, int maskBit) { + return longToIpv4(getBeginIpLong(ip, maskBit)); + } + + /** + * 根据 ip/掩码位 计算IP段的起始IP（Long型） + * + * @param ip 给定的IP，如218.240.38.69 + * @param maskBit 给定的掩码位，如30 + * @return 起始IP的长整型表示 + */ + public static Long getBeginIpLong(String ip, int maskBit) { + return ipv4ToLong(ip) & ipv4ToLong(getMaskByMaskBit(maskBit)); + } + + /** + * 根据 ip/掩码位 计算IP段的终止IP（字符串型） + * + * @param ip 给定的IP，如218.240.38.69 + * @param maskBit 给定的掩码位，如30 + * @return 终止IP的字符串表示 + */ + public static String getEndIpStr(String ip, int maskBit) { + return longToIpv4(getEndIpLong(ip, maskBit)); + } + + /** + * 根据子网掩码转换为掩码位 + * + * @param mask 掩码的点分十进制表示，例如 255.255.255.0 + * @return 掩码位，例如 24 + * @throws IllegalArgumentException 子网掩码非法 + */ + public static int getMaskBitByMask(String mask) { + Integer maskBit = MaskBit.getMaskBit(mask); + if (maskBit == null) { + throw new IllegalArgumentException("Invalid netmask " + mask); + } + return maskBit; + } + + /** + * 计算子网大小 + * + * @param maskBit 掩码位 + * @param isAll true:全量地址，false:可用地址 + * @return 地址总数 + */ + public static int countByMaskBit(int maskBit, boolean isAll) { + //如果是可用地址的情况，掩码位小于等于0或大于等于32，则可用地址为0 + if ((false == isAll) && (maskBit <= 0 || maskBit >= 32)) { + return 0; + } + + final int count = (int) Math.pow(2, 32 - maskBit); + return isAll ? count : count - 2; + } + + /** + * 根据掩码位获取掩码 + * + * @param maskBit 掩码位 + * @return 掩码 + */ + public static String getMaskByMaskBit(int maskBit) { + return MaskBit.get(maskBit); + } + + /** + * 根据开始IP与结束IP计算掩码 + * + * @param fromIp 开始IP + * @param toIp 结束IP + * @return 掩码x.x.x.x + */ + public static String getMaskByIpRange(String fromIp, String toIp) { + long toIpLong = ipv4ToLong(toIp); + long fromIpLong = ipv4ToLong(fromIp); + Assert.isTrue(fromIpLong < toIpLong, "to IP must be greater than from IP!"); + + String[] fromIpSplit = StrUtil.splitToArray(fromIp, CharUtil.DOT); + String[] toIpSplit = StrUtil.splitToArray(toIp, CharUtil.DOT); + StringBuilder mask = new StringBuilder(); + for (int i = 0; i < toIpSplit.length; i++) { + mask.append(255 - Integer.parseInt(toIpSplit[i]) + Integer.parseInt(fromIpSplit[i])).append(CharUtil.DOT); + } + return mask.substring(0, mask.length() - 1); + } + + /** + * 计算IP区间有多少个IP + * + * @param fromIp 开始IP + * @param toIp 结束IP + * @return IP数量 + */ + public static int countByIpRange(String fromIp, String toIp) { + long toIpLong = ipv4ToLong(toIp); + long fromIpLong = ipv4ToLong(fromIp); + if (fromIpLong > toIpLong) { + throw new IllegalArgumentException("to IP must be greater than from IP!"); + } + int count = 1; + int[] fromIpSplit = StrUtil.split(fromIp, CharUtil.DOT).stream().mapToInt(Integer::parseInt).toArray(); + int[] toIpSplit = StrUtil.split(toIp, CharUtil.DOT).stream().mapToInt(Integer::parseInt).toArray(); + for (int i = fromIpSplit.length - 1; i >= 0; i--) { + count += (toIpSplit[i] - fromIpSplit[i]) * Math.pow(256, fromIpSplit.length - i - 1); + } + return count; + } + + /** + * 判断掩码是否合法 + * + * @param mask 掩码的点分十进制表示，例如 255.255.255.0 + * @return true：掩码合法；false：掩码不合法 + */ + public static boolean isMaskValid(String mask) { + return MaskBit.getMaskBit(mask) != null; + } + + /** + * 判断掩码位是否合法 + * + * @param maskBit 掩码位，例如 24 + * @return true：掩码位合法；false：掩码位不合法 + */ + public static boolean isMaskBitValid(int maskBit) { + return MaskBit.get(maskBit) != null; + } + + /** + * 判定是否为内网IPv4
+ * 私有IP： + * 
+	 * A类 10.0.0.0-10.255.255.255
+	 * B类 172.16.0.0-172.31.255.255
+	 * C类 192.168.0.0-192.168.255.255
+	 *
+ * 当然，还有127这个网段是环回地址 + * + * @param ipAddress IP地址 + * @return 是否为内网IP + * @since 5.7.18 + */ + public static boolean isInnerIP(String ipAddress) { + boolean isInnerIp; + long ipNum = ipv4ToLong(ipAddress); + + long aBegin = ipv4ToLong("10.0.0.0"); + long aEnd = ipv4ToLong("10.255.255.255"); + + long bBegin = ipv4ToLong("172.16.0.0"); + long bEnd = ipv4ToLong("172.31.255.255"); + + long cBegin = ipv4ToLong("192.168.0.0"); + long cEnd = ipv4ToLong("192.168.255.255"); + + isInnerIp = isInner(ipNum, aBegin, aEnd) || isInner(ipNum, bBegin, bEnd) || isInner(ipNum, cBegin, cEnd) || LOCAL_IP.equals(ipAddress); + return isInnerIp; + } + + //-------------------------------------------------------------------------------- Private method start + + /** + * 根据 ip/掩码位 计算IP段的终止IP（Long型） + * 注：此接口返回负数，请使用转成字符串后再转Long型 + * + * @param ip 给定的IP，如218.240.38.69 + * @param maskBit 给定的掩码位，如30 + * @return 终止IP的长整型表示 + */ + public static Long getEndIpLong(String ip, int maskBit) { + return getBeginIpLong(ip, maskBit) + + ~ipv4ToLong(getMaskByMaskBit(maskBit)); + } + + /** + * 将匹配到的Ipv4地址的4个分组分别处理 + * + * @param matcher 匹配到的Ipv4正则 + * @return ipv4对应long + */ + private static long matchAddress(Matcher matcher) { + long addr = 0; + for (int i = 1; i <= 4; ++i) { + addr |= Long.parseLong(matcher.group(i)) << 8 * (4 - i); + } + return addr; + } + + /** + * 指定IP的long是否在指定范围内 + * + * @param userIp 用户IP + * @param begin 开始IP + * @param end 结束IP + * @return 是否在范围内 + */ + private static boolean isInner(long userIp, long begin, long end) { + return (userIp >= begin) && (userIp <= end); + } + //-------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/LocalPortGenerater.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/LocalPortGenerater.java new file mode 100644 index 0000000..b536426 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/LocalPortGenerater.java @@ -0,0 +1,43 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import java.io.Serializable; +import java.util.concurrent.atomic.AtomicInteger; + +/** + * 本地端口生成器
+ * 用于生成本地可用（未被占用）的端口号
+ * 注意：多线程甚至单线程访问时可能会返回同一端口（例如获取了端口但是没有使用） + * + * @author looly + * @since 4.0.3 + * + */ +public class LocalPortGenerater implements Serializable{ + private static final long serialVersionUID = 1L; + + /** 备选的本地端口 */ + private final AtomicInteger alternativePort; + + /** + * 构造 + * + * @param beginPort 起始端口号 + */ + public LocalPortGenerater(int beginPort) { + alternativePort = new AtomicInteger(beginPort); + } + + /** + * 生成一个本地端口，用于远程端口映射 + * + * @return 未被使用的本地端口 + */ + public int generate() { + int validPort = alternativePort.get(); + // 获取可用端口 + while (false == NetUtil.isUsableLocalPort(validPort)) { + validPort = alternativePort.incrementAndGet(); + } + return validPort; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/MaskBit.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/MaskBit.java new file mode 100644 index 0000000..ac311e0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/MaskBit.java @@ -0,0 +1,76 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import aiyh.utils.tool.cn.hutool.core.map.BiMap; +import java.util.HashMap; + +/** + * 掩码位和掩码之间的Map对应 + * + * @since 5.4.1 + * @author looly + */ +public class MaskBit { + + /** + * 掩码位与掩码的点分十进制的双向对应关系 + */ + private static final BiMap MASK_BIT_MAP; + static { + MASK_BIT_MAP = new BiMap<>(new HashMap<>(32)); + MASK_BIT_MAP.put(1, "128.0.0.0"); + MASK_BIT_MAP.put(2, "192.0.0.0"); + MASK_BIT_MAP.put(3, "224.0.0.0"); + MASK_BIT_MAP.put(4, "240.0.0.0"); + MASK_BIT_MAP.put(5, "248.0.0.0"); + MASK_BIT_MAP.put(6, "252.0.0.0"); + MASK_BIT_MAP.put(7, "254.0.0.0"); + MASK_BIT_MAP.put(8, "255.0.0.0"); + MASK_BIT_MAP.put(9, "255.128.0.0"); + MASK_BIT_MAP.put(10, "255.192.0.0"); + MASK_BIT_MAP.put(11, "255.224.0.0"); + MASK_BIT_MAP.put(12, "255.240.0.0"); + MASK_BIT_MAP.put(13, "255.248.0.0"); + MASK_BIT_MAP.put(14, "255.252.0.0"); + MASK_BIT_MAP.put(15, "255.254.0.0"); + MASK_BIT_MAP.put(16, "255.255.0.0"); + MASK_BIT_MAP.put(17, "255.255.128.0"); + MASK_BIT_MAP.put(18, "255.255.192.0"); + MASK_BIT_MAP.put(19, "255.255.224.0"); + MASK_BIT_MAP.put(20, "255.255.240.0"); + MASK_BIT_MAP.put(21, "255.255.248.0"); + MASK_BIT_MAP.put(22, "255.255.252.0"); + MASK_BIT_MAP.put(23, "255.255.254.0"); + MASK_BIT_MAP.put(24, "255.255.255.0"); + MASK_BIT_MAP.put(25, "255.255.255.128"); + MASK_BIT_MAP.put(26, "255.255.255.192"); + MASK_BIT_MAP.put(27, "255.255.255.224"); + MASK_BIT_MAP.put(28, "255.255.255.240"); + MASK_BIT_MAP.put(29, "255.255.255.248"); + MASK_BIT_MAP.put(30, "255.255.255.252"); + MASK_BIT_MAP.put(31, "255.255.255.254"); + MASK_BIT_MAP.put(32, "255.255.255.255"); + } + + /** + * 根据掩码位获取掩码 + * + * @param maskBit 掩码位 + * @return 掩码 + */ + public static String get(int maskBit) { + return MASK_BIT_MAP.get(maskBit); + } + + /** + * 根据掩码获取掩码位 + * + * @param mask 掩码的点分十进制表示，如 255.255.255.0 + * + * @return 掩码位，如 24；如果掩码不合法，则返回null + * @since 5.6.5 + */ + public static Integer getMaskBit(String mask) { + return MASK_BIT_MAP.getKey(mask); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/NetUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/NetUtil.java new file mode 100755 index 0000000..5c9b81f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/NetUtil.java @@ -0,0 +1,884 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.collection.EnumerationIter; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Filter; +import aiyh.utils.tool.cn.hutool.core.util.JNDIUtil; +import aiyh.utils.tool.cn.hutool.core.util.RandomUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import javax.naming.NamingException; +import javax.naming.directory.Attribute; +import javax.naming.directory.Attributes; +import java.io.IOException; +import java.io.OutputStream; +import java.math.BigInteger; +import java.net.Authenticator; +import java.net.DatagramSocket; +import java.net.HttpCookie; +import java.net.IDN; +import java.net.Inet4Address; +import java.net.Inet6Address; +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.net.NetworkInterface; +import java.net.ServerSocket; +import java.net.Socket; +import java.net.SocketException; +import java.net.URL; +import java.net.UnknownHostException; +import java.nio.ByteBuffer; +import java.nio.channels.SocketChannel; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.Enumeration; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Set; +import java.util.TreeSet; + +/** + * 网络相关工具 + * + * @author xiaoleilu + */ +public class NetUtil { + + public final static String LOCAL_IP = Ipv4Util.LOCAL_IP; + + public static String localhostName; + + /** + * 默认最小端口，1024 + */ + public static final int PORT_RANGE_MIN = 1024; + /** + * 默认最大端口，65535 + */ + public static final int PORT_RANGE_MAX = 0xFFFF; + + /** + * 根据long值获取ip v4地址 + * + * @param longIP IP的long表示形式 + * @return IP V4 地址 + * @see Ipv4Util#longToIpv4(long) + */ + public static String longToIpv4(long longIP) { + return Ipv4Util.longToIpv4(longIP); + } + + /** + * 根据ip地址计算出long型的数据 + * + * @param strIP IP V4 地址 + * @return long值 + * @see Ipv4Util#ipv4ToLong(String) + */ + public static long ipv4ToLong(String strIP) { + return Ipv4Util.ipv4ToLong(strIP); + } + + /** + * 将IPv6地址字符串转为大整数 + * + * @param ipv6Str 字符串 + * @return 大整数, 如发生异常返回 null + * @since 5.5.7 + * @deprecated 拼写错误，请使用{@link #ipv6ToBigInteger(String)} + */ + @Deprecated + public static BigInteger ipv6ToBitInteger(String ipv6Str) { + return ipv6ToBigInteger(ipv6Str); + } + + /** + * 将IPv6地址字符串转为大整数 + * + * @param ipv6Str 字符串 + * @return 大整数, 如发生异常返回 null + * @since 5.5.7 + */ + public static BigInteger ipv6ToBigInteger(String ipv6Str) { + try { + InetAddress address = InetAddress.getByName(ipv6Str); + if (address instanceof Inet6Address) { + return new BigInteger(1, address.getAddress()); + } + } catch (UnknownHostException ignore) { + } + return null; + } + + /** + * 将大整数转换成ipv6字符串 + * + * @param bigInteger 大整数 + * @return IPv6字符串, 如发生异常返回 null + * @since 5.5.7 + */ + public static String bigIntegerToIPv6(BigInteger bigInteger) { + try { + return InetAddress.getByAddress(bigInteger.toByteArray()).toString().substring(1); + } catch (UnknownHostException ignore) { + return null; + } + } + + /** + * 检测本地端口可用性
+ * 来自org.springframework.util.SocketUtils + * + * @param port 被检测的端口 + * @return 是否可用 + */ + public static boolean isUsableLocalPort(int port) { + if (false == isValidPort(port)) { + // 给定的IP未在指定端口范围中 + return false; + } + + // issue#765@Github, 某些绑定非127.0.0.1的端口无法被检测到 + try (ServerSocket ss = new ServerSocket(port)) { + ss.setReuseAddress(true); + } catch (IOException ignored) { + return false; + } + + try (DatagramSocket ds = new DatagramSocket(port)) { + ds.setReuseAddress(true); + } catch (IOException ignored) { + return false; + } + + return true; + } + + /** + * 是否为有效的端口
+ * 此方法并不检查端口是否被占用 + * + * @param port 端口号 + * @return 是否有效 + */ + public static boolean isValidPort(int port) { + // 有效端口是0～65535 + return port >= 0 && port <= PORT_RANGE_MAX; + } + + /** + * 查找1024~65535范围内的可用端口
+ * 此方法只检测给定范围内的随机一个端口，检测65535-1024次
+ * 来自org.springframework.util.SocketUtils + * + * @return 可用的端口 + * @since 4.5.4 + */ + public static int getUsableLocalPort() { + return getUsableLocalPort(PORT_RANGE_MIN); + } + + /** + * 查找指定范围内的可用端口，最大值为65535
+ * 此方法只检测给定范围内的随机一个端口，检测65535-minPort次
+ * 来自org.springframework.util.SocketUtils + * + * @param minPort 端口最小值（包含） + * @return 可用的端口 + * @since 4.5.4 + */ + public static int getUsableLocalPort(int minPort) { + return getUsableLocalPort(minPort, PORT_RANGE_MAX); + } + + /** + * 查找指定范围内的可用端口
+ * 此方法只检测给定范围内的随机一个端口，检测maxPort-minPort次
+ * 来自org.springframework.util.SocketUtils + * + * @param minPort 端口最小值（包含） + * @param maxPort 端口最大值（包含） + * @return 可用的端口 + * @since 4.5.4 + */ + public static int getUsableLocalPort(int minPort, int maxPort) { + final int maxPortExclude = maxPort + 1; + int randomPort; + for (int i = minPort; i < maxPortExclude; i++) { + randomPort = RandomUtil.randomInt(minPort, maxPortExclude); + if (isUsableLocalPort(randomPort)) { + return randomPort; + } + } + + throw new UtilException("Could not find an available port in the range [{}, {}] after {} attempts", minPort, maxPort, maxPort - minPort); + } + + /** + * 获取多个本地可用端口
+ * 来自org.springframework.util.SocketUtils + * + * @param numRequested 尝试次数 + * @param minPort 端口最小值（包含） + * @param maxPort 端口最大值（包含） + * @return 可用的端口 + * @since 4.5.4 + */ + public static TreeSet getUsableLocalPorts(int numRequested, int minPort, int maxPort) { + final TreeSet availablePorts = new TreeSet<>(); + int attemptCount = 0; + while ((++attemptCount <= numRequested + 100) && availablePorts.size() < numRequested) { + availablePorts.add(getUsableLocalPort(minPort, maxPort)); + } + + if (availablePorts.size() != numRequested) { + throw new UtilException("Could not find {} available ports in the range [{}, {}]", numRequested, minPort, maxPort); + } + + return availablePorts; + } + + /** + * 判定是否为内网IPv4
+ * 私有IP： + * 
+	 * A类 10.0.0.0-10.255.255.255
+	 * B类 172.16.0.0-172.31.255.255
+	 * C类 192.168.0.0-192.168.255.255
+	 *
+ * 当然，还有127这个网段是环回地址 + * + * @param ipAddress IP地址 + * @return 是否为内网IP + * @see Ipv4Util#isInnerIP(String) + */ + public static boolean isInnerIP(String ipAddress) { + return Ipv4Util.isInnerIP(ipAddress); + } + + /** + * 相对URL转换为绝对URL + * + * @param absoluteBasePath 基准路径，绝对 + * @param relativePath 相对路径 + * @return 绝对URL + */ + public static String toAbsoluteUrl(String absoluteBasePath, String relativePath) { + try { + URL absoluteUrl = new URL(absoluteBasePath); + return new URL(absoluteUrl, relativePath).toString(); + } catch (Exception e) { + throw new UtilException(e, "To absolute url [{}] base [{}] error!", relativePath, absoluteBasePath); + } + } + + /** + * 隐藏掉IP地址的最后一部分为 * 代替 + * + * @param ip IP地址 + * @return 隐藏部分后的IP + */ + public static String hideIpPart(String ip) { + return StrUtil.builder(ip.length()).append(ip, 0, ip.lastIndexOf(".") + 1).append("*").toString(); + } + + /** + * 隐藏掉IP地址的最后一部分为 * 代替 + * + * @param ip IP地址 + * @return 隐藏部分后的IP + */ + public static String hideIpPart(long ip) { + return hideIpPart(longToIpv4(ip)); + } + + /** + * 构建InetSocketAddress
+ * 当host中包含端口时（用“：”隔开），使用host中的端口，否则使用默认端口
+ * 给定host为空时使用本地host（127.0.0.1） + * + * @param host Host + * @param defaultPort 默认端口 + * @return InetSocketAddress + */ + public static InetSocketAddress buildInetSocketAddress(String host, int defaultPort) { + if (StrUtil.isBlank(host)) { + host = LOCAL_IP; + } + + String destHost; + int port; + int index = host.indexOf(":"); + if (index != -1) { + // host:port形式 + destHost = host.substring(0, index); + port = Integer.parseInt(host.substring(index + 1)); + } else { + destHost = host; + port = defaultPort; + } + + return new InetSocketAddress(destHost, port); + } + + /** + * 通过域名得到IP + * + * @param hostName HOST + * @return ip address or hostName if UnknownHostException + */ + public static String getIpByHost(String hostName) { + try { + return InetAddress.getByName(hostName).getHostAddress(); + } catch (UnknownHostException e) { + return hostName; + } + } + + /** + * 获取指定名称的网卡信息 + * + * @param name 网络接口名，例如Linux下默认是eth0 + * @return 网卡，未找到返回{@code null} + * @since 5.0.7 + */ + public static NetworkInterface getNetworkInterface(String name) { + Enumeration networkInterfaces; + try { + networkInterfaces = NetworkInterface.getNetworkInterfaces(); + } catch (SocketException e) { + return null; + } + + NetworkInterface netInterface; + while (networkInterfaces.hasMoreElements()) { + netInterface = networkInterfaces.nextElement(); + if (null != netInterface && name.equals(netInterface.getName())) { + return netInterface; + } + } + + return null; + } + + /** + * 获取本机所有网卡 + * + * @return 所有网卡，异常返回{@code null} + * @since 3.0.1 + */ + public static Collection getNetworkInterfaces() { + Enumeration networkInterfaces; + try { + networkInterfaces = NetworkInterface.getNetworkInterfaces(); + } catch (SocketException e) { + return null; + } + + return CollUtil.addAll(new ArrayList<>(), networkInterfaces); + } + + /** + * 获得本机的IPv4地址列表
+ * 返回的IP列表有序，按照系统设备顺序 + * + * @return IP地址列表 {@link LinkedHashSet} + */ + public static LinkedHashSet localIpv4s() { + final LinkedHashSet localAddressList = localAddressList(t -> t instanceof Inet4Address); + + return toIpList(localAddressList); + } + + /** + * 获得本机的IPv6地址列表
+ * 返回的IP列表有序，按照系统设备顺序 + * + * @return IP地址列表 {@link LinkedHashSet} + * @since 4.5.17 + */ + public static LinkedHashSet localIpv6s() { + final LinkedHashSet localAddressList = localAddressList(t -> t instanceof Inet6Address); + + return toIpList(localAddressList); + } + + /** + * 地址列表转换为IP地址列表 + * + * @param addressList 地址{@link Inet4Address} 列表 + * @return IP地址字符串列表 + * @since 4.5.17 + */ + public static LinkedHashSet toIpList(Set addressList) { + final LinkedHashSet ipSet = new LinkedHashSet<>(); + for (InetAddress address : addressList) { + ipSet.add(address.getHostAddress()); + } + + return ipSet; + } + + /** + * 获得本机的IP地址列表（包括Ipv4和Ipv6）
+ * 返回的IP列表有序，按照系统设备顺序 + * + * @return IP地址列表 {@link LinkedHashSet} + */ + public static LinkedHashSet localIps() { + final LinkedHashSet localAddressList = localAddressList(null); + return toIpList(localAddressList); + } + + /** + * 获取所有满足过滤条件的本地IP地址对象 + * + * @param addressFilter 过滤器，null表示不过滤，获取所有地址 + * @return 过滤后的地址对象列表 + * @since 4.5.17 + */ + public static LinkedHashSet localAddressList(Filter addressFilter) { + return localAddressList(null, addressFilter); + } + + /** + * 获取所有满足过滤条件的本地IP地址对象 + * + * @param addressFilter 过滤器，null表示不过滤，获取所有地址 + * @param networkInterfaceFilter 过滤器，null表示不过滤，获取所有网卡 + * @return 过滤后的地址对象列表 + */ + public static LinkedHashSet localAddressList(Filter networkInterfaceFilter, Filter addressFilter) { + Enumeration networkInterfaces; + try { + networkInterfaces = NetworkInterface.getNetworkInterfaces(); + } catch (SocketException e) { + throw new UtilException(e); + } + + if (networkInterfaces == null) { + throw new UtilException("Get network interface error!"); + } + + final LinkedHashSet ipSet = new LinkedHashSet<>(); + + while (networkInterfaces.hasMoreElements()) { + final NetworkInterface networkInterface = networkInterfaces.nextElement(); + if (networkInterfaceFilter != null && false == networkInterfaceFilter.accept(networkInterface)) { + continue; + } + final Enumeration inetAddresses = networkInterface.getInetAddresses(); + while (inetAddresses.hasMoreElements()) { + final InetAddress inetAddress = inetAddresses.nextElement(); + if (inetAddress != null && (null == addressFilter || addressFilter.accept(inetAddress))) { + ipSet.add(inetAddress); + } + } + } + + return ipSet; + } + + /** + * 获取本机网卡IP地址，这个地址为所有网卡中非回路地址的第一个
+ * 如果获取失败调用 {@link InetAddress#getLocalHost()}方法获取。
+ * 此方法不会抛出异常，获取失败将返回{@code null}
+ *

+ * 参考：http://stackoverflow.com/questions/9481865/getting-the-ip-address-of-the-current-machine-using-java + * + * @return 本机网卡IP地址，获取失败返回{@code null} + * @since 3.0.7 + */ + public static String getLocalhostStr() { + InetAddress localhost = getLocalhost(); + if (null != localhost) { + return localhost.getHostAddress(); + } + return null; + } + + /** + * 获取本机网卡IP地址，规则如下： + * + * 

+	 * 1. 查找所有网卡地址，必须非回路（loopback）地址、非局域网地址（siteLocal）、IPv4地址
+	 * 2. 如果无满足要求的地址，调用 {@link InetAddress#getLocalHost()} 获取地址
+	 *
+ *

+ * 此方法不会抛出异常，获取失败将返回{@code null}
+ *

+ * 见：https://github.com/dromara/hutool/issues/428 + * + * @return 本机网卡IP地址，获取失败返回{@code null} + * @since 3.0.1 + */ + public static InetAddress getLocalhost() { + final LinkedHashSet localAddressList = localAddressList(address -> { + // 非loopback地址，指127.*.*.*的地址 + return false == address.isLoopbackAddress() + // 需为IPV4地址 + && address instanceof Inet4Address; + }); + + if (CollUtil.isNotEmpty(localAddressList)) { + InetAddress address2 = null; + for (InetAddress inetAddress : localAddressList) { + if (false == inetAddress.isSiteLocalAddress()) { + // 非地区本地地址，指10.0.0.0 ~ 10.255.255.255、172.16.0.0 ~ 172.31.255.255、192.168.0.0 ~ 192.168.255.255 + return inetAddress; + } else if (null == address2) { + address2 = inetAddress; + } + } + + if (null != address2) { + return address2; + } + } + + try { + return InetAddress.getLocalHost(); + } catch (UnknownHostException e) { + // ignore + } + + return null; + } + + /** + * 获得本机MAC地址 + * + * @return 本机MAC地址 + */ + public static String getLocalMacAddress() { + return getMacAddress(getLocalhost()); + } + + /** + * 获得指定地址信息中的MAC地址，使用分隔符“-” + * + * @param inetAddress {@link InetAddress} + * @return MAC地址，用-分隔 + */ + public static String getMacAddress(InetAddress inetAddress) { + return getMacAddress(inetAddress, "-"); + } + + /** + * 获得指定地址信息中的MAC地址 + * + * @param inetAddress {@link InetAddress} + * @param separator 分隔符，推荐使用“-”或者“:” + * @return MAC地址，用-分隔 + */ + public static String getMacAddress(InetAddress inetAddress, String separator) { + if (null == inetAddress) { + return null; + } + + final byte[] mac = getHardwareAddress(inetAddress); + if (null != mac) { + final StringBuilder sb = new StringBuilder(); + String s; + for (int i = 0; i < mac.length; i++) { + if (i != 0) { + sb.append(separator); + } + // 字节转换为整数 + s = Integer.toHexString(mac[i] & 0xFF); + sb.append(s.length() == 1 ? 0 + s : s); + } + return sb.toString(); + } + + return null; + } + + /** + * 获得指定地址信息中的硬件地址 + * + * @param inetAddress {@link InetAddress} + * @return 硬件地址 + * @since 5.7.3 + */ + public static byte[] getHardwareAddress(InetAddress inetAddress) { + if (null == inetAddress) { + return null; + } + + try { + final NetworkInterface networkInterface = NetworkInterface.getByInetAddress(inetAddress); + if (null != networkInterface) { + return networkInterface.getHardwareAddress(); + } + } catch (SocketException e) { + throw new UtilException(e); + } + return null; + } + + /** + * 获得本机物理地址 + * + * @return 本机物理地址 + * @since 5.7.3 + */ + public static byte[] getLocalHardwareAddress() { + return getHardwareAddress(getLocalhost()); + } + + /** + * 获取主机名称，一次获取会缓存名称 + * + * @return 主机名称 + * @since 5.4.4 + */ + public static String getLocalHostName() { + if (StrUtil.isNotBlank(localhostName)) { + return localhostName; + } + + final InetAddress localhost = getLocalhost(); + if (null != localhost) { + String name = localhost.getHostName(); + if (StrUtil.isEmpty(name)) { + name = localhost.getHostAddress(); + } + localhostName = name; + } + + return localhostName; + } + + /** + * 创建 {@link InetSocketAddress} + * + * @param host 域名或IP地址，空表示任意地址 + * @param port 端口，0表示系统分配临时端口 + * @return {@link InetSocketAddress} + * @since 3.3.0 + */ + public static InetSocketAddress createAddress(String host, int port) { + if (StrUtil.isBlank(host)) { + return new InetSocketAddress(port); + } + return new InetSocketAddress(host, port); + } + + /** + * 简易的使用Socket发送数据 + * + * @param host Server主机 + * @param port Server端口 + * @param isBlock 是否阻塞方式 + * @param data 需要发送的数据 + * @throws IORuntimeException IO异常 + * @since 3.3.0 + */ + public static void netCat(String host, int port, boolean isBlock, ByteBuffer data) throws IORuntimeException { + try (SocketChannel channel = SocketChannel.open(createAddress(host, port))) { + channel.configureBlocking(isBlock); + channel.write(data); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 使用普通Socket发送数据 + * + * @param host Server主机 + * @param port Server端口 + * @param data 数据 + * @throws IORuntimeException IO异常 + * @since 3.3.0 + */ + public static void netCat(String host, int port, byte[] data) throws IORuntimeException { + OutputStream out = null; + try (Socket socket = new Socket(host, port)) { + out = socket.getOutputStream(); + out.write(data); + out.flush(); + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + IoUtil.close(out); + } + } + + /** + * 是否在CIDR规则配置范围内
+ * 方法来自：【成都】小邓 + * + * @param ip 需要验证的IP + * @param cidr CIDR规则 + * @return 是否在范围内 + * @since 4.0.6 + */ + public static boolean isInRange(String ip, String cidr) { + final int maskSplitMarkIndex = cidr.lastIndexOf(Ipv4Util.IP_MASK_SPLIT_MARK); + if (maskSplitMarkIndex < 0) { + throw new IllegalArgumentException("Invalid cidr: " + cidr); + } + + final long mask = (-1L << 32 - Integer.parseInt(cidr.substring(maskSplitMarkIndex + 1))); + long cidrIpAddr = ipv4ToLong(cidr.substring(0, maskSplitMarkIndex)); + + return (ipv4ToLong(ip) & mask) == (cidrIpAddr & mask); + } + + /** + * Unicode域名转puny code + * + * @param unicode Unicode域名 + * @return puny code + * @since 4.1.22 + */ + public static String idnToASCII(String unicode) { + return IDN.toASCII(unicode); + } + + /** + * 从多级反向代理中获得第一个非unknown IP地址 + * + * @param ip 获得的IP地址 + * @return 第一个非unknown IP地址 + * @since 4.4.1 + */ + public static String getMultistageReverseProxyIp(String ip) { + // 多级反向代理检测 + if (ip != null && StrUtil.indexOf(ip, ',') > 0) { + final List ips = StrUtil.splitTrim(ip, ','); + for (final String subIp : ips) { + if (false == isUnknown(subIp)) { + ip = subIp; + break; + } + } + } + return ip; + } + + /** + * 检测给定字符串是否为未知，多用于检测HTTP请求相关
+ * + * @param checkString 被检测的字符串 + * @return 是否未知 + * @since 5.2.6 + */ + public static boolean isUnknown(String checkString) { + return StrUtil.isBlank(checkString) || "unknown".equalsIgnoreCase(checkString); + } + + /** + * 检测IP地址是否能ping通 + * + * @param ip IP地址 + * @return 返回是否ping通 + */ + public static boolean ping(String ip) { + return ping(ip, 200); + } + + /** + * 检测IP地址是否能ping通 + * + * @param ip IP地址 + * @param timeout 检测超时（毫秒） + * @return 是否ping通 + */ + public static boolean ping(String ip, int timeout) { + try { + return InetAddress.getByName(ip).isReachable(timeout); // 当返回值是true时，说明host是可用的，false则不可。 + } catch (Exception ex) { + return false; + } + } + + /** + * 解析Cookie信息 + * + * @param cookieStr Cookie字符串 + * @return cookie字符串 + * @since 5.2.6 + */ + public static List parseCookies(String cookieStr) { + if (StrUtil.isBlank(cookieStr)) { + return Collections.emptyList(); + } + return HttpCookie.parse(cookieStr); + } + + /** + * 检查远程端口是否开启 + * + * @param address 远程地址 + * @param timeout 检测超时 + * @return 远程端口是否开启 + * @since 5.3.2 + */ + public static boolean isOpen(InetSocketAddress address, int timeout) { + try (Socket sc = new Socket()) { + sc.connect(address, timeout); + return true; + } catch (Exception e) { + return false; + } + } + + /** + * 设置全局验证 + * + * @param user 用户名 + * @param pass 密码，考虑安全，此处不使用String + * @since 5.7.2 + */ + public static void setGlobalAuthenticator(String user, char[] pass) { + setGlobalAuthenticator(new UserPassAuthenticator(user, pass)); + } + + /** + * 设置全局验证 + * + * @param authenticator 验证器 + * @since 5.7.2 + */ + public static void setGlobalAuthenticator(Authenticator authenticator) { + Authenticator.setDefault(authenticator); + } + + /** + * 获取DNS信息，如TXT信息： + * + * 

+	 *     NetUtil.attrNames("hutool.cn", "TXT")
+	 *
+ * + * @param hostName 主机域名 + * @param attrNames 属性 + * @return DNS信息 + * @since 5.7.7 + */ + public static List getDnsInfo(String hostName, String... attrNames) { + final String uri = StrUtil.addPrefixIfNot(hostName, "dns:"); + final Attributes attributes = JNDIUtil.getAttributes(uri, attrNames); + + final List infos = new ArrayList<>(); + for (Attribute attribute : new EnumerationIter<>(attributes.getAll())) { + try { + infos.add((String) attribute.get()); + } catch (NamingException ignore) { + //ignore + } + } + return infos; + } + + // ----------------------------------------------------------------------------------------- Private method start + + // ----------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/PassAuth.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/PassAuth.java new file mode 100644 index 0000000..8d372f7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/PassAuth.java @@ -0,0 +1,41 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import java.net.Authenticator; +import java.net.PasswordAuthentication; + +/** + * 账号密码形式的{@link Authenticator} 实现。 + * + * @author looly + * @since 5.5.3 + */ +public class PassAuth extends Authenticator { + + /** + * 创建账号密码形式的{@link Authenticator} 实现。 + * + * @param user 用户名 + * @param pass 密码 + * @return PassAuth + */ + public static PassAuth of(String user, char[] pass) { + return new PassAuth(user, pass); + } + + private final PasswordAuthentication auth; + + /** + * 构造 + * + * @param user 用户名 + * @param pass 密码 + */ + public PassAuth(String user, char[] pass) { + auth = new PasswordAuthentication(user, pass); + } + + @Override + protected PasswordAuthentication getPasswordAuthentication() { + return auth; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/RFC3986.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/RFC3986.java new file mode 100755 index 0000000..5c05aee --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/RFC3986.java @@ -0,0 +1,104 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import aiyh.utils.tool.cn.hutool.core.codec.PercentCodec; + +/** + * RFC3986 编码实现
+ * 定义见：https://www.ietf.org/rfc/rfc3986.html#appendix-A + * + * @author looly + * @since 5.7.16 + */ +public class RFC3986 { + + /** + * gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@" + */ + public static final PercentCodec GEN_DELIMS = PercentCodec.of(":/?#[]@"); + + /** + * sub-delims = "!" / "$" / "{@code &}" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" + */ + public static final PercentCodec SUB_DELIMS = PercentCodec.of("!$&'()*+,;="); + + /** + * reserved = gen-delims / sub-delims
+ * see：https://www.ietf.org/rfc/rfc3986.html#section-2.2 + */ + public static final PercentCodec RESERVED = GEN_DELIMS.orNew(SUB_DELIMS); + + /** + * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
+ * see: https://www.ietf.org/rfc/rfc3986.html#section-2.3 + */ + public static final PercentCodec UNRESERVED = PercentCodec.of(unreservedChars()); + + /** + * pchar = unreserved / pct-encoded / sub-delims / ":" / "@" + */ + public static final PercentCodec PCHAR = UNRESERVED.orNew(SUB_DELIMS).or(PercentCodec.of(":@")); + + /** + * segment = pchar
+ * see: https://www.ietf.org/rfc/rfc3986.html#section-3.3 + */ + public static final PercentCodec SEGMENT = PCHAR; + /** + * segment-nz-nc = SEGMENT ; non-zero-length segment without any colon ":" + */ + public static final PercentCodec SEGMENT_NZ_NC = PercentCodec.of(SEGMENT).removeSafe(':'); + + /** + * path = segment / "/" + */ + public static final PercentCodec PATH = SEGMENT.orNew(PercentCodec.of("/")); + + /** + * query = pchar / "/" / "?" + */ + public static final PercentCodec QUERY = PCHAR.orNew(PercentCodec.of("/?")); + + /** + * fragment = pchar / "/" / "?" + */ + public static final PercentCodec FRAGMENT = QUERY; + + /** + * query中的value
+ * value不能包含"{@code &}"，可以包含 "=" + */ + public static final PercentCodec QUERY_PARAM_VALUE = PercentCodec.of(QUERY).removeSafe('&'); + + /** + * query中的key
+ * key不能包含"{@code &}" 和 "=" + */ + public static final PercentCodec QUERY_PARAM_NAME = PercentCodec.of(QUERY_PARAM_VALUE).removeSafe('='); + + /** + * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" + * + * @return unreserved字符 + */ + private static StringBuilder unreservedChars() { + StringBuilder sb = new StringBuilder(); + + // ALPHA + for (char c = 'A'; c <= 'Z'; c++) { + sb.append(c); + } + for (char c = 'a'; c <= 'z'; c++) { + sb.append(c); + } + + // DIGIT + for (char c = '0'; c <= '9'; c++) { + sb.append(c); + } + + // "-" / "." / "_" / "~" + sb.append("_.-~"); + + return sb; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/SSLContextBuilder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/SSLContextBuilder.java new file mode 100644 index 0000000..b76e81f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/SSLContextBuilder.java @@ -0,0 +1,137 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import aiyh.utils.tool.cn.hutool.core.builder.Builder; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import javax.net.ssl.KeyManager; +import javax.net.ssl.SSLContext; +import javax.net.ssl.TrustManager; +import java.security.GeneralSecurityException; +import java.security.KeyManagementException; +import java.security.NoSuchAlgorithmException; +import java.security.SecureRandom; + +/** + * {@link SSLContext}构建器，可以自定义：
+ *
    + *
  • 协议（protocol），默认TLS
    • + *
  • {@link KeyManager}，默认空
    • + *
  • {@link TrustManager}，默认{@link DefaultTrustManager}，即信任全部
    • + *
  • {@link SecureRandom}
    • + *
+ *

+ * 构建后可获得{@link SSLContext}，通过调用{@link SSLContext#getSocketFactory()}获取{@link javax.net.ssl.SSLSocketFactory} + * + * @author Looly + * @since 5.5.2 + */ +public class SSLContextBuilder implements SSLProtocols, Builder { + private static final long serialVersionUID = 1L; + + private String protocol = TLS; + private KeyManager[] keyManagers; + private TrustManager[] trustManagers = {DefaultTrustManager.INSTANCE}; + private SecureRandom secureRandom = new SecureRandom(); + + + /** + * 创建 SSLContextBuilder + * + * @return SSLContextBuilder + */ + public static SSLContextBuilder create() { + return new SSLContextBuilder(); + } + + /** + * 设置协议。例如TLS等 + * + * @param protocol 协议 + * @return 自身 + */ + public SSLContextBuilder setProtocol(String protocol) { + if (StrUtil.isNotBlank(protocol)) { + this.protocol = protocol; + } + return this; + } + + /** + * 设置信任信息 + * + * @param trustManagers TrustManager列表 + * @return 自身 + */ + public SSLContextBuilder setTrustManagers(TrustManager... trustManagers) { + if (ArrayUtil.isNotEmpty(trustManagers)) { + this.trustManagers = trustManagers; + } + return this; + } + + /** + * 设置 JSSE key managers + * + * @param keyManagers JSSE key managers + * @return 自身 + */ + public SSLContextBuilder setKeyManagers(KeyManager... keyManagers) { + if (ArrayUtil.isNotEmpty(keyManagers)) { + this.keyManagers = keyManagers; + } + return this; + } + + /** + * 设置 SecureRandom + * + * @param secureRandom SecureRandom + * @return 自己 + */ + public SSLContextBuilder setSecureRandom(SecureRandom secureRandom) { + if (null != secureRandom) { + this.secureRandom = secureRandom; + } + return this; + } + + /** + * 构建{@link SSLContext} + * + * @return {@link SSLContext} + */ + @Override + public SSLContext build() { + return buildQuietly(); + } + + /** + * 构建{@link SSLContext}需要处理异常 + * + * @return {@link SSLContext} + * @throws NoSuchAlgorithmException 无此算法异常 + * @throws KeyManagementException 密钥管理异常 + * @since 5.7.22 + */ + public SSLContext buildChecked() throws NoSuchAlgorithmException, KeyManagementException { + SSLContext sslContext = SSLContext.getInstance(protocol); + sslContext.init(this.keyManagers, this.trustManagers, this.secureRandom); + return sslContext; + } + + /** + * 构建{@link SSLContext} + * + * @return {@link SSLContext} + * @throws IORuntimeException 包装 GeneralSecurityException异常 + */ + public SSLContext buildQuietly() throws IORuntimeException { + try { + return buildChecked(); + } catch (GeneralSecurityException e) { + throw new IORuntimeException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/SSLProtocols.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/SSLProtocols.java new file mode 100755 index 0000000..1e56ef7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/SSLProtocols.java @@ -0,0 +1,40 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +/** + * SSL或TLS协议 + * + * @author looly + * @since 5.7.8 + */ +public interface SSLProtocols { + + /** + * Supports some version of SSL; may support other versions + */ + String SSL = "SSL"; + /** + * Supports SSL version 2 or later; may support other versions + */ + String SSLv2 = "SSLv2"; + /** + * Supports SSL version 3; may support other versions + */ + String SSLv3 = "SSLv3"; + + /** + * Supports some version of TLS; may support other versions + */ + String TLS = "TLS"; + /** + * Supports RFC 2246: TLS version 1.0 ; may support other versions + */ + String TLSv1 = "TLSv1"; + /** + * Supports RFC 4346: TLS version 1.1 ; may support other versions + */ + String TLSv11 = "TLSv1.1"; + /** + * Supports RFC 5246: TLS version 1.2 ; may support other versions + */ + String TLSv12 = "TLSv1.2"; +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/SSLUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/SSLUtil.java new file mode 100644 index 0000000..563745a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/SSLUtil.java @@ -0,0 +1,60 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; + +import javax.net.ssl.KeyManager; +import javax.net.ssl.SSLContext; +import javax.net.ssl.TrustManager; + +/** + * SSL(Secure Sockets Layer 安全套接字协议)相关工具封装 + * + * @author looly + * @since 5.5.2 + */ +public class SSLUtil { + + /** + * 创建{@link SSLContext}，默认新人全部 + * + * @param protocol SSL协议，例如TLS等 + * @return {@link SSLContext} + * @throws IORuntimeException 包装 GeneralSecurityException异常 + * @since 5.7.8 + */ + public static SSLContext createSSLContext(String protocol) throws IORuntimeException{ + return SSLContextBuilder.create().setProtocol(protocol).build(); + } + + /** + * 创建{@link SSLContext} + * + * @param protocol SSL协议，例如TLS等 + * @param keyManager 密钥管理器,{@code null}表示无 + * @param trustManager 信任管理器, {@code null}表示无 + * @return {@link SSLContext} + * @throws IORuntimeException 包装 GeneralSecurityException异常 + */ + public static SSLContext createSSLContext(String protocol, KeyManager keyManager, TrustManager trustManager) + throws IORuntimeException { + return createSSLContext(protocol, + keyManager == null ? null : new KeyManager[]{keyManager}, + trustManager == null ? null : new TrustManager[]{trustManager}); + } + + /** + * 创建和初始化{@link SSLContext} + * + * @param protocol SSL协议，例如TLS等 + * @param keyManagers 密钥管理器,{@code null}表示无 + * @param trustManagers 信任管理器, {@code null}表示无 + * @return {@link SSLContext} + * @throws IORuntimeException 包装 GeneralSecurityException异常 + */ + public static SSLContext createSSLContext(String protocol, KeyManager[] keyManagers, TrustManager[] trustManagers) throws IORuntimeException { + return SSLContextBuilder.create() + .setProtocol(protocol) + .setKeyManagers(keyManagers) + .setTrustManagers(trustManagers).build(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/URLDecoder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/URLDecoder.java new file mode 100644 index 0000000..2781766 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/URLDecoder.java @@ -0,0 +1,138 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.ByteArrayOutputStream; +import java.io.Serializable; +import java.nio.charset.Charset; + +/** + * URL解码，数据内容的类型是 application/x-www-form-urlencoded。 + * + * 

+ * 1. 将%20转换为空格 ;
+ * 2. 将"%xy"转换为文本形式,xy是两位16进制的数值;
+ * 3. 跳过不符合规范的%形式，直接输出
+ *
+ * + * @author looly + */ +public class URLDecoder implements Serializable { + private static final long serialVersionUID = 1L; + + private static final byte ESCAPE_CHAR = '%'; + + /** + * 解码，不对+解码 + * + *
    + *
  1. 将%20转换为空格
    2. + *
  2. 将 "%xy"转换为文本形式,xy是两位16进制的数值
    3. + *
  3. 跳过不符合规范的%形式，直接输出
    4. + *
+ * + * @param str 包含URL编码后的字符串 + * @param charset 编码 + * @return 解码后的字符串 + */ + public static String decodeForPath(String str, Charset charset) { + return decode(str, charset, false); + } + + /** + * 解码
+ * 规则见：https://url.spec.whatwg.org/#urlencoded-parsing + * 
+	 *   1. 将+和%20转换为空格(" ");
+	 *   2. 将"%xy"转换为文本形式,xy是两位16进制的数值;
+	 *   3. 跳过不符合规范的%形式，直接输出
+	 *
+ * + * @param str 包含URL编码后的字符串 + * @param charset 编码 + * @return 解码后的字符串 + */ + public static String decode(String str, Charset charset) { + return decode(str, charset, true); + } + + /** + * 解码 + * 
+	 *   1. 将%20转换为空格 ;
+	 *   2. 将"%xy"转换为文本形式,xy是两位16进制的数值;
+	 *   3. 跳过不符合规范的%形式，直接输出
+	 *
+ * + * @param str 包含URL编码后的字符串 + * @param isPlusToSpace 是否+转换为空格 + * @param charset 编码，{@code null}表示不做编码 + * @return 解码后的字符串 + */ + public static String decode(String str, Charset charset, boolean isPlusToSpace) { + if(null == charset){ + return str; + } + return StrUtil.str(decode(StrUtil.bytes(str, charset), isPlusToSpace), charset); + } + + /** + * 解码 + * 
+	 *   1. 将+和%20转换为空格 ;
+	 *   2. 将"%xy"转换为文本形式,xy是两位16进制的数值;
+	 *   3. 跳过不符合规范的%形式，直接输出
+	 *
+ * + * @param bytes url编码的bytes + * @return 解码后的bytes + */ + public static byte[] decode(byte[] bytes) { + return decode(bytes, true); + } + + /** + * 解码 + * 
+	 *   1. 将%20转换为空格 ;
+	 *   2. 将"%xy"转换为文本形式,xy是两位16进制的数值;
+	 *   3. 跳过不符合规范的%形式，直接输出
+	 *
+ * + * @param bytes url编码的bytes + * @param isPlusToSpace 是否+转换为空格 + * @return 解码后的bytes + * @since 5.6.3 + */ + public static byte[] decode(byte[] bytes, boolean isPlusToSpace) { + if (bytes == null) { + return null; + } + final ByteArrayOutputStream buffer = new ByteArrayOutputStream(bytes.length); + int b; + for (int i = 0; i < bytes.length; i++) { + b = bytes[i]; + if (b == '+') { + buffer.write(isPlusToSpace ? CharUtil.SPACE : b); + } else if (b == ESCAPE_CHAR) { + if (i + 1 < bytes.length) { + final int u = CharUtil.digit16(bytes[i + 1]); + if (u >= 0 && i + 2 < bytes.length) { + final int l = CharUtil.digit16(bytes[i + 2]); + if (l >= 0) { + buffer.write((char) ((u << 4) + l)); + i += 2; + continue; + } + } + } + // 跳过不符合规范的%形式 + buffer.write(b); + } else { + buffer.write(b); + } + } + return buffer.toByteArray(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/URLEncodeUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/URLEncodeUtil.java new file mode 100644 index 0000000..c8dbf52 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/URLEncodeUtil.java @@ -0,0 +1,187 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.nio.charset.Charset; + +/** + * URL编码工具
+ * TODO 在6.x中移除此工具（无法很好区分URL编码和www-form编码） + * + * @since 5.7.13 + * @author looly + */ +public class URLEncodeUtil { + /** + * 编码URL，默认使用UTF-8编码
+ * 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。 + * + * @param url URL + * @return 编码后的URL + * @throws UtilException UnsupportedEncodingException + */ + public static String encodeAll(String url) { + return encodeAll(url, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 编码URL
+ * 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。 + * + * @param url URL + * @param charset 编码，为null表示不编码 + * @return 编码后的URL + * @throws UtilException UnsupportedEncodingException + */ + public static String encodeAll(String url, Charset charset) throws UtilException { + return RFC3986.UNRESERVED.encode(url, charset); + } + + /** + * 编码URL，默认使用UTF-8编码
+ * 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
+ * 此方法用于URL自动编码，类似于浏览器中键入地址自动编码，对于像类似于“/”的字符不再编码 + * + * @param url URL + * @return 编码后的URL + * @throws UtilException UnsupportedEncodingException + * @since 3.1.2 + */ + public static String encode(String url) throws UtilException { + return encode(url, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 编码字符为 application/x-www-form-urlencoded
+ * 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
+ * 此方法用于URL自动编码，类似于浏览器中键入地址自动编码，对于像类似于“/”的字符不再编码 + * + * @param url 被编码内容 + * @param charset 编码 + * @return 编码后的字符 + * @since 4.4.1 + */ + public static String encode(String url, Charset charset) { + return RFC3986.PATH.encode(url, charset); + } + + /** + * 编码URL，默认使用UTF-8编码
+ * 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
+ * 此方法用于POST请求中的请求体自动编码，转义大部分特殊字符 + * + * @param url URL + * @return 编码后的URL + * @throws UtilException UnsupportedEncodingException + * @since 3.1.2 + */ + public static String encodeQuery(String url) throws UtilException { + return encodeQuery(url, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 编码字符为URL中查询语句
+ * 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
+ * 此方法用于POST请求中的请求体自动编码，转义大部分特殊字符 + * + * @param url 被编码内容 + * @param charset 编码 + * @return 编码后的字符 + * @since 4.4.1 + */ + public static String encodeQuery(String url, Charset charset) { + return RFC3986.QUERY.encode(url, charset); + } + + /** + * 编码URL，默认使用UTF-8编码
+ * 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
+ * 此方法用于URL的Segment中自动编码，转义大部分特殊字符 + * + * 
+	 * pchar = unreserved（不处理） / pct-encoded / sub-delims（子分隔符） / "@"
+	 * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
+	 * sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+	 *
+ * + * @param url URL + * @return 编码后的URL + * @throws UtilException UnsupportedEncodingException + * @since 5.6.5 + */ + public static String encodePathSegment(String url) throws UtilException { + return encodePathSegment(url, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 编码字符为URL中查询语句
+ * 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
+ * 此方法用于URL的Segment中自动编码，转义大部分特殊字符 + * + * 
+	 * pchar = unreserved / pct-encoded / sub-delims / ":" / "@"
+	 * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
+	 * sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+	 *
+ * + * @param url 被编码内容 + * @param charset 编码 + * @return 编码后的字符 + * @since 5.6.5 + */ + public static String encodePathSegment(String url, Charset charset) { + if (StrUtil.isEmpty(url)) { + return url; + } + return RFC3986.SEGMENT.encode(url, charset); + } + + /** + * 编码URL，默认使用UTF-8编码
+ * URL的Fragment URLEncoder
+ * 默认的编码器针对Fragment，定义如下： + * + * 
+	 * fragment    = *( pchar / "/" / "?" )
+	 * pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
+	 * unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
+	 * sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+	 *
+ * + * 具体见：https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 + * + * @param url 被编码内容 + * @return 编码后的字符 + * @since 5.7.13 + */ + public static String encodeFragment(String url) throws UtilException { + return encodeFragment(url, CharsetUtil.CHARSET_UTF_8); + } + + /** + * URL的Fragment URLEncoder
+ * 默认的编码器针对Fragment，定义如下： + * + * 
+	 * fragment    = *( pchar / "/" / "?" )
+	 * pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
+	 * unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
+	 * sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+	 *
+ * + * 具体见：https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 + * + * @param url 被编码内容 + * @param charset 编码 + * @return 编码后的字符 + * @since 5.7.13 + */ + public static String encodeFragment(String url, Charset charset) { + if (StrUtil.isEmpty(url)) { + return url; + } + return RFC3986.FRAGMENT.encode(url, charset); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/URLEncoder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/URLEncoder.java new file mode 100755 index 0000000..b73afda --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/URLEncoder.java @@ -0,0 +1,407 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.HexUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.OutputStreamWriter; +import java.io.Serializable; +import java.nio.charset.Charset; +import java.util.BitSet; + +/** + * URL编码，数据内容的类型是 application/x-www-form-urlencoded。 + * TODO 6.x移除此类，使用PercentCodec代替（无法很好区分URL编码和www-form编码） + * + * 
+ * 1.字符"a"-"z"，"A"-"Z"，"0"-"9"，"."，"-"，"*"，和"_" 都不会被编码;
+ * 2.将空格转换为%20 ;
+ * 3.将非文本内容转换成"%xy"的形式,xy是两位16进制的数值;
+ *
+ * + * @author looly + * @see aiyh.utils.tool.cn.hutool.core.codec.PercentCodec + * @deprecated 此类中的方法并不规范，请使用 {@link RFC3986} + */ +@Deprecated +public class URLEncoder implements Serializable { + private static final long serialVersionUID = 1L; + + // --------------------------------------------------------------------------------------------- Static method start + /** + * 默认URLEncoder
+ * 默认的编码器针对URI路径编码，定义如下： + * + * 
+	 * default = pchar / "/"
+	 * pchar = unreserved（不处理） / pct-encoded / sub-delims（子分隔符） / ":" / "@"
+	 * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
+	 * sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+	 *
+ */ + public static final URLEncoder DEFAULT = createDefault(); + + /** + * URL的Path的每一个Segment URLEncoder
+ * 默认的编码器针对URI路径编码，定义如下： + * + * 
+	 * pchar = unreserved / pct-encoded / sub-delims / ":"（非空segment不包含:） / "@"
+	 * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
+	 * sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+	 *
+ * + * 定义见：https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3 + */ + public static final URLEncoder PATH_SEGMENT = createPathSegment(); + + /** + * URL的Fragment URLEncoder
+ * 默认的编码器针对Fragment，定义如下： + * + * 
+	 * fragment    = *( pchar / "/" / "?" )
+	 * pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
+	 * unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
+	 * sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+	 *
+ * + * 具体见：https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 + * @since 5.7.13 + */ + public static final URLEncoder FRAGMENT = createFragment(); + + /** + * 用于查询语句的URLEncoder
+ * 编码器针对URI路径编码，定义如下： + * + * 
+	 * 0x20 ' ' =》 '+'
+	 * 0x2A, 0x2D, 0x2E, 0x30 to 0x39, 0x41 to 0x5A, 0x5F, 0x61 to 0x7A as-is
+	 * '*', '-', '.', '0' to '9', 'A' to 'Z', '_', 'a' to 'z' Also '=' and '&' 不编码
+	 * 其它编码为 %nn 形式
+	 *
+ *

+ * 详细见：https://www.w3.org/TR/html5/forms.html#application/x-www-form-urlencoded-encoding-algorithm + */ + public static final URLEncoder QUERY = createQuery(); + + /** + * 全编码的URLEncoder
+ * 

+	 *  0x2A, 0x2D, 0x2E, 0x30 to 0x39, 0x41 to 0x5A, 0x5F, 0x61 to 0x7A as-is
+	 *  '*', '-', '.', '0' to '9', 'A' to 'Z', '_', 'a' to 'z' 不编码
+	 *  其它编码为 %nn 形式
+	 *
+ */ + public static final URLEncoder ALL = createAll(); + + /** + * 创建默认URLEncoder
+ * 默认的编码器针对URI路径编码，定义如下： + * + * 
+	 * default = pchar / "/"
+	 * pchar = unreserved（不处理） / pct-encoded / sub-delims（子分隔符） / ":" / "@"
+	 * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
+	 * sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+	 *
+ * + * @return URLEncoder + */ + public static URLEncoder createDefault() { + final URLEncoder encoder = new URLEncoder(); + encoder.addSafeCharacter('-'); + encoder.addSafeCharacter('.'); + encoder.addSafeCharacter('_'); + encoder.addSafeCharacter('~'); + + // Add the sub-delims + addSubDelims(encoder); + + // Add the remaining literals + encoder.addSafeCharacter(':'); + encoder.addSafeCharacter('@'); + + // Add '/' so it isn't encoded when we encode a path + encoder.addSafeCharacter('/'); + + return encoder; + } + + /** + * URL的Path的每一个Segment URLEncoder
+ * 默认的编码器针对URI路径的每一段编码，定义如下： + * + * 
+	 * pchar = unreserved / pct-encoded / sub-delims / ":"（非空segment不包含:） / "@"
+	 * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
+	 * sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+	 *
+ * + * 定义见：https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3 + * + * @return URLEncoder + */ + public static URLEncoder createPathSegment() { + final URLEncoder encoder = new URLEncoder(); + + // unreserved + encoder.addSafeCharacter('-'); + encoder.addSafeCharacter('.'); + encoder.addSafeCharacter('_'); + encoder.addSafeCharacter('~'); + + // Add the sub-delims + addSubDelims(encoder); + + // Add the remaining literals + //non-zero-length segment without any colon ":" + //encoder.addSafeCharacter(':'); + encoder.addSafeCharacter('@'); + + return encoder; + } + + /** + * URL的Fragment URLEncoder
+ * 默认的编码器针对Fragment，定义如下： + * + * 
+	 * fragment    = *( pchar / "/" / "?" )
+	 * pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
+	 * unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
+	 * sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
+	 *
+ * + * 具体见：https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 + * + * @return URLEncoder + * @since 5.7.13 + */ + public static URLEncoder createFragment() { + final URLEncoder encoder = new URLEncoder(); + encoder.addSafeCharacter('-'); + encoder.addSafeCharacter('.'); + encoder.addSafeCharacter('_'); + encoder.addSafeCharacter('~'); + + // Add the sub-delims + addSubDelims(encoder); + + // Add the remaining literals + encoder.addSafeCharacter(':'); + encoder.addSafeCharacter('@'); + + encoder.addSafeCharacter('/'); + encoder.addSafeCharacter('?'); + + return encoder; + } + + /** + * 创建用于查询语句的URLEncoder
+ * 编码器针对URI路径编码，定义如下： + * + * 
+	 * 0x20 ' ' =》 '+'
+	 * 0x2A, 0x2D, 0x2E, 0x30 to 0x39, 0x41 to 0x5A, 0x5F, 0x61 to 0x7A as-is
+	 * '*', '-', '.', '0' to '9', 'A' to 'Z', '_', 'a' to 'z' Also '=' and '&' 不编码
+	 * 其它编码为 %nn 形式
+	 *
+ *

+ * 详细见：https://www.w3.org/TR/html5/forms.html#application/x-www-form-urlencoded-encoding-algorithm + * + * @return URLEncoder + */ + public static URLEncoder createQuery() { + final URLEncoder encoder = new URLEncoder(); + // Special encoding for space + encoder.setEncodeSpaceAsPlus(true); + // Alpha and digit are safe by default + // Add the other permitted characters + encoder.addSafeCharacter('*'); + encoder.addSafeCharacter('-'); + encoder.addSafeCharacter('.'); + encoder.addSafeCharacter('_'); + + encoder.addSafeCharacter('='); + encoder.addSafeCharacter('&'); + + return encoder; + } + + /** + * 创建URLEncoder
+ * 编码器针对URI路径编码，定义如下： + * + * 

+	 * 0x2A, 0x2D, 0x2E, 0x30 to 0x39, 0x41 to 0x5A, 0x5F, 0x61 to 0x7A as-is
+	 * '*', '-', '.', '0' to '9', 'A' to 'Z', '_', 'a' to 'z' 不编码
+	 * 其它编码为 %nn 形式
+	 *
+ *

+ * 详细见：https://www.w3.org/TR/html5/forms.html#application/x-www-form-urlencoded-encoding-algorithm + * + * @return URLEncoder + */ + public static URLEncoder createAll() { + final URLEncoder encoder = new URLEncoder(); + encoder.addSafeCharacter('*'); + encoder.addSafeCharacter('-'); + encoder.addSafeCharacter('.'); + encoder.addSafeCharacter('_'); + + return encoder; + } + // --------------------------------------------------------------------------------------------- Static method end + + /** + * 存放安全编码 + */ + private final BitSet safeCharacters; + /** + * 是否编码空格为+ + */ + private boolean encodeSpaceAsPlus = false; + + /** + * 构造
+ * [a-zA-Z0-9]默认不被编码 + */ + public URLEncoder() { + this(new BitSet(256)); + + // unreserved + addAlpha(); + addDigit(); + } + + /** + * 构造 + * + * @param safeCharacters 安全字符，安全字符不被编码 + */ + private URLEncoder(BitSet safeCharacters) { + this.safeCharacters = safeCharacters; + } + + /** + * 增加安全字符
+ * 安全字符不被编码 + * + * @param c 字符 + */ + public void addSafeCharacter(char c) { + safeCharacters.set(c); + } + + /** + * 移除安全字符
+ * 安全字符不被编码 + * + * @param c 字符 + */ + public void removeSafeCharacter(char c) { + safeCharacters.clear(c); + } + + /** + * 是否将空格编码为+ + * + * @param encodeSpaceAsPlus 是否将空格编码为+ + */ + public void setEncodeSpaceAsPlus(boolean encodeSpaceAsPlus) { + this.encodeSpaceAsPlus = encodeSpaceAsPlus; + } + + /** + * 将URL中的字符串编码为%形式 + * + * @param path 需要编码的字符串 + * @param charset 编码, {@code null}返回原字符串，表示不编码 + * @return 编码后的字符串 + */ + public String encode(String path, Charset charset) { + if (null == charset || StrUtil.isEmpty(path)) { + return path; + } + + final StringBuilder rewrittenPath = new StringBuilder(path.length()); + ByteArrayOutputStream buf = new ByteArrayOutputStream(); + OutputStreamWriter writer = new OutputStreamWriter(buf, charset); + + int c; + for (int i = 0; i < path.length(); i++) { + c = path.charAt(i); + if (safeCharacters.get(c)) { + rewrittenPath.append((char) c); + } else if (encodeSpaceAsPlus && c == CharUtil.SPACE) { + // 对于空格单独处理 + rewrittenPath.append('+'); + } else { + // convert to external encoding before hex conversion + try { + writer.write((char) c); + writer.flush(); + } catch (IOException e) { + buf.reset(); + continue; + } + + byte[] ba = buf.toByteArray(); + for (byte toEncode : ba) { + // Converting each byte in the buffer + rewrittenPath.append('%'); + HexUtil.appendHex(rewrittenPath, toEncode, false); + } + buf.reset(); + } + } + return rewrittenPath.toString(); + } + + /** + * 增加安全字符[a-z][A-Z] + */ + private void addAlpha() { + for (char i = 'a'; i <= 'z'; i++) { + addSafeCharacter(i); + } + for (char i = 'A'; i <= 'Z'; i++) { + addSafeCharacter(i); + } + } + + /** + * 增加数字1-9 + */ + private void addDigit() { + for (char i = '0'; i <= '9'; i++) { + addSafeCharacter(i); + } + } + + + /** + * 增加sub-delims
+ * sub-delims = "!" / "$" / "&" / "'" / "(" / ") / "*" / "+" / "," / ";" / "=" + * 定义见：https://datatracker.ietf.org/doc/html/rfc3986#section-2.2 + */ + private static void addSubDelims(URLEncoder encoder){ + // Add the sub-delims + encoder.addSafeCharacter('!'); + encoder.addSafeCharacter('$'); + encoder.addSafeCharacter('&'); + encoder.addSafeCharacter('\''); + encoder.addSafeCharacter('('); + encoder.addSafeCharacter(')'); + encoder.addSafeCharacter('*'); + encoder.addSafeCharacter('+'); + encoder.addSafeCharacter(','); + encoder.addSafeCharacter(';'); + encoder.addSafeCharacter('='); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/UserPassAuthenticator.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/UserPassAuthenticator.java new file mode 100644 index 0000000..e456396 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/UserPassAuthenticator.java @@ -0,0 +1,33 @@ +package aiyh.utils.tool.cn.hutool.core.net; + +import java.net.Authenticator; +import java.net.PasswordAuthentication; + +/** + * 账号密码形式的{@link Authenticator} + * + * @author looly + * @since 5.7.2 + */ +public class UserPassAuthenticator extends Authenticator { + + private final String user; + private final char[] pass; + + /** + * 构造 + * + * @param user 用户名 + * @param pass 密码 + */ + public UserPassAuthenticator(String user, char[] pass) { + this.user = user; + this.pass = pass; + } + + @Override + protected PasswordAuthentication getPasswordAuthentication() { + return new PasswordAuthentication(this.user, this.pass); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/MultipartFormData.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/MultipartFormData.java new file mode 100644 index 0000000..ac5a6cf --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/MultipartFormData.java @@ -0,0 +1,273 @@ +package aiyh.utils.tool.cn.hutool.core.net.multipart; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.map.multi.ListValueMap; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.Charset; +import java.util.List; +import java.util.Map; +import java.util.Set; + +/** + * HttpRequest解析器
+ * 来自Jodd + * + * @author jodd.org + */ +public class MultipartFormData { + + /** 请求参数 */ + private final ListValueMap requestParameters = new ListValueMap<>(); + /** 请求文件 */ + private final ListValueMap requestFiles = new ListValueMap<>(); + /** 上传选项 */ + private final UploadSetting setting; + + /** 是否解析完毕 */ + private boolean loaded; + + // --------------------------------------------------------------------- Constructor start + /** + * 构造 + */ + public MultipartFormData() { + this(null); + } + + /** + * 构造 + * + * @param uploadSetting 上传设定 + */ + public MultipartFormData(UploadSetting uploadSetting) { + this.setting = uploadSetting == null ? new UploadSetting() : uploadSetting; + } + // --------------------------------------------------------------------- Constructor end + + /** + * 提取上传的文件和表单数据 + * + * @param inputStream HttpRequest流 + * @param charset 编码 + * @throws IOException IO异常 + */ + public void parseRequestStream(InputStream inputStream, Charset charset) throws IOException { + setLoaded(); + + MultipartRequestInputStream input = new MultipartRequestInputStream(inputStream); + input.readBoundary(); + while (true) { + UploadFileHeader header = input.readDataHeader(charset); + if (header == null) { + break; + } + + if (header.isFile == true) { + // 文件类型的表单项 + String fileName = header.fileName; + if (fileName.length() > 0 && header.contentType.contains("application/x-macbinary")) { + input.skipBytes(128); + } + final UploadFile newFile = new UploadFile(header, setting); + if(newFile.processStream(input)){ + putFile(header.formFieldName, newFile); + } + } else { + // 标准表单项 + putParameter(header.formFieldName, input.readString(charset)); + } + + input.skipBytes(1); + input.mark(1); + + // read byte, but may be end of stream + int nextByte = input.read(); + if (nextByte == -1 || nextByte == '-') { + input.reset(); + break; + } + input.reset(); + } + } + + // ---------------------------------------------------------------- parameters + /** + * 返回单一参数值，如果有多个只返回第一个 + * + * @param paramName 参数名 + * @return null未找到，否则返回值 + */ + public String getParam(String paramName) { + final List values = getListParam(paramName); + if (CollUtil.isNotEmpty(values)) { + return values.get(0); + } + return null; + } + + /** + * @return 获得参数名集合 + */ + public Set getParamNames() { + return requestParameters.keySet(); + } + + /** + * 获得数组表单值 + * + * @param paramName 参数名 + * @return 数组表单值 + */ + public String[] getArrayParam(String paramName) { + final List listParam = getListParam(paramName); + if(null != listParam){ + return listParam.toArray(new String[0]); + } + return null; + } + + /** + * 获得集合表单值 + * + * @param paramName 参数名 + * @return 数组表单值 + * @since 5.3.0 + */ + public List getListParam(String paramName) { + return requestParameters.get(paramName); + } + + /** + * 获取所有属性的集合 + * + * @return 所有属性的集合 + */ + public Map getParamMap() { + return Convert.toMap(String.class, String[].class, getParamListMap()); + } + + /** + * 获取所有属性的集合 + * + * @return 所有属性的集合 + */ + public ListValueMap getParamListMap() { + return this.requestParameters; + } + + // --------------------------------------------------------------------------- Files parameters + /** + * 获取上传的文件 + * + * @param paramName 文件参数名称 + * @return 上传的文件， 如果无为null + */ + public UploadFile getFile(String paramName) { + UploadFile[] values = getFiles(paramName); + if ((values != null) && (values.length > 0)) { + return values[0]; + } + return null; + } + + /** + * 获得某个属性名的所有文件
+ * 当表单中两个文件使用同一个name的时候 + * + * @param paramName 属性名 + * @return 上传的文件列表 + */ + public UploadFile[] getFiles(String paramName) { + final List fileList = getFileList(paramName); + if(null != fileList){ + return fileList.toArray(new UploadFile[0]); + } + return null; + } + + /** + * 获得某个属性名的所有文件
+ * 当表单中两个文件使用同一个name的时候 + * + * @param paramName 属性名 + * @return 上传的文件列表 + * @since 5.3.0 + */ + public List getFileList(String paramName) { + return requestFiles.get(paramName); + } + + /** + * 获取上传的文件属性名集合 + * + * @return 上传的文件属性名集合 + */ + public Set getFileParamNames() { + return requestFiles.keySet(); + } + + /** + * 获取文件映射 + * + * @return 文件映射 + */ + public Map getFileMap() { + return Convert.toMap(String.class, UploadFile[].class, getFileListValueMap()); + } + + /** + * 获取文件映射 + * + * @return 文件映射 + */ + public ListValueMap getFileListValueMap() { + return this.requestFiles; + } + + // --------------------------------------------------------------------------- Load + /** + * 是否已被解析 + * + * @return 如果流已被解析返回true + */ + public boolean isLoaded() { + return loaded; + } + + // ---------------------------------------------------------------- Private method start + /** + * 加入上传文件 + * + * @param name 参数名 + * @param uploadFile 文件 + */ + private void putFile(String name, UploadFile uploadFile) { + this.requestFiles.putValue(name, uploadFile); + } + + /** + * 加入普通参数 + * + * @param name 参数名 + * @param value 参数值 + */ + private void putParameter(String name, String value) { + this.requestParameters.putValue(name, value); + } + + /** + * 设置使输入流为解析状态，如果已解析，则抛出异常 + * + * @throws IOException IO异常 + */ + private void setLoaded() throws IOException { + if (loaded == true) { + throw new IOException("Multi-part request already parsed."); + } + loaded = true; + } + // ---------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/MultipartRequestInputStream.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/MultipartRequestInputStream.java new file mode 100644 index 0000000..833906d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/MultipartRequestInputStream.java @@ -0,0 +1,242 @@ +package aiyh.utils.tool.cn.hutool.core.net.multipart; + +import aiyh.utils.tool.cn.hutool.core.io.FastByteArrayOutputStream; + +import java.io.BufferedInputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.charset.Charset; + +/** + * Http请求解析流，提供了专门针对带文件的form表单的解析
+ * 来自Jodd + * + * @author jodd.org + */ +public class MultipartRequestInputStream extends BufferedInputStream { + + public MultipartRequestInputStream(InputStream in) { + super(in); + } + + /** + * 读取byte字节流，在末尾抛出异常 + * + * @return byte + * @throws IOException 读取异常 + */ + public byte readByte() throws IOException { + int i = super.read(); + if (i == -1) { + throw new IOException("End of HTTP request stream reached"); + } + return (byte) i; + } + + /** + * 跳过指定位数的 bytes. + * + * @param i 跳过的byte数 + * @throws IOException IO异常 + */ + public void skipBytes(long i) throws IOException { + long len = super.skip(i); + if (len != i) { + throw new IOException("Unable to skip data in HTTP request"); + } + } + + // ---------------------------------------------------------------- boundary + + /** + * part部分边界 + */ + protected byte[] boundary; + + /** + * 输入流中读取边界 + * + * @return 边界 + * @throws IOException 读取异常 + */ + public byte[] readBoundary() throws IOException { + ByteArrayOutputStream boundaryOutput = new ByteArrayOutputStream(1024); + byte b; + // skip optional whitespaces + //noinspection StatementWithEmptyBody + while ((b = readByte()) <= ' ') { + } + boundaryOutput.write(b); + + // now read boundary chars + while ((b = readByte()) != '\r') { + boundaryOutput.write(b); + } + if (boundaryOutput.size() == 0) { + throw new IOException("Problems with parsing request: invalid boundary"); + } + skipBytes(1); + boundary = new byte[boundaryOutput.size() + 2]; + System.arraycopy(boundaryOutput.toByteArray(), 0, boundary, 2, boundary.length - 2); + boundary[0] = '\r'; + boundary[1] = '\n'; + return boundary; + } + + // ---------------------------------------------------------------- data header + + protected UploadFileHeader lastHeader; + + public UploadFileHeader getLastHeader() { + return lastHeader; + } + + /** + * 从流中读取文件头部信息， 如果达到末尾则返回null + * + * @param encoding 字符集 + * @return 头部信息， 如果达到末尾则返回null + * @throws IOException 读取异常 + */ + public UploadFileHeader readDataHeader(Charset encoding) throws IOException { + String dataHeader = readDataHeaderString(encoding); + if (dataHeader != null) { + lastHeader = new UploadFileHeader(dataHeader); + } else { + lastHeader = null; + } + return lastHeader; + } + + /** + * 读取数据头信息字符串 + * + * @param charset 编码 + * @return 数据头信息字符串 + * @throws IOException IO异常 + */ + protected String readDataHeaderString(Charset charset) throws IOException { + ByteArrayOutputStream data = new ByteArrayOutputStream(); + byte b; + while (true) { + // end marker byte on offset +0 and +2 must be 13 + if ((b = readByte()) != '\r') { + data.write(b); + continue; + } + mark(4); + skipBytes(1); + int i = read(); + if (i == -1) { + // reached end of stream + return null; + } + if (i == '\r') { + reset(); + break; + } + reset(); + data.write(b); + } + skipBytes(3); + return charset == null ? data.toString() : data.toString(charset.name()); + } + // ---------------------------------------------------------------- copy + + /** + * 读取字节流，直到下一个boundary + * + * @param charset 编码，null表示系统默认编码 + * @return 读取的字符串 + * @throws IOException 读取异常 + */ + public String readString(Charset charset) throws IOException { + final FastByteArrayOutputStream out = new FastByteArrayOutputStream(); + copy(out); + return out.toString(charset); + } + + /** + * 字节流复制到out，直到下一个boundary + * + * @param out 输出流 + * @return 复制的字节数 + * @throws IOException 读取异常 + */ + public long copy(OutputStream out) throws IOException { + long count = 0; + while (true) { + byte b = readByte(); + if (isBoundary(b)) { + break; + } + out.write(b); + count++; + } + return count; + } + + /** + * 复制字节流到out， 大于maxBytes或者文件末尾停止 + * + * @param out 输出流 + * @param limit 最大字节数 + * @return 复制的字节数 + * @throws IOException 读取异常 + */ + public long copy(OutputStream out, long limit) throws IOException { + long count = 0; + while (true) { + byte b = readByte(); + if (isBoundary(b)) { + break; + } + out.write(b); + count++; + if (count > limit) { + break; + } + } + return count; + } + + /** + * 跳过边界表示 + * + * @return 跳过的字节数 + * @throws IOException 读取异常 + */ + public long skipToBoundary() throws IOException { + long count = 0; + while (true) { + byte b = readByte(); + count++; + if (isBoundary(b)) { + break; + } + } + return count; + } + + /** + * @param b byte + * @return 是否为边界的标志 + * @throws IOException 读取异常 + */ + public boolean isBoundary(byte b) throws IOException { + int boundaryLen = boundary.length; + mark(boundaryLen + 1); + int bpos = 0; + while (b == boundary[bpos]) { + b = readByte(); + bpos++; + if (bpos == boundaryLen) { + return true; // boundary found! + } + } + reset(); + return false; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/UploadFile.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/UploadFile.java new file mode 100644 index 0000000..602517f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/UploadFile.java @@ -0,0 +1,272 @@ +package aiyh.utils.tool.cn.hutool.core.net.multipart; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.BufferedOutputStream; +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.nio.file.NoSuchFileException; + +/** + * 上传的文件对象 + * + * @author xiaoleilu + */ +public class UploadFile { + + private static final String TMP_FILE_PREFIX = "hutool-"; + private static final String TMP_FILE_SUFFIX = ".upload.tmp"; + + private final UploadFileHeader header; + private final UploadSetting setting; + + private long size = -1; + + // 文件流（小文件位于内存中） + private byte[] data; + // 临时文件（大文件位于临时文件夹中） + private File tempFile; + + /** + * 构造 + * + * @param header 头部信息 + * @param setting 上传设置 + */ + public UploadFile(UploadFileHeader header, UploadSetting setting) { + this.header = header; + this.setting = setting; + } + + // ---------------------------------------------------------------- operations + + /** + * 从磁盘或者内存中删除这个文件 + */ + public void delete() { + if (tempFile != null) { + //noinspection ResultOfMethodCallIgnored + tempFile.delete(); + } + if (data != null) { + data = null; + } + } + + /** + * 将上传的文件写入指定的目标文件路径，自动创建文件
+ * 写入后原临时文件会被删除 + * + * @param destPath 目标文件路径 + * @return 目标文件 + * @throws IOException IO异常 + */ + public File write(String destPath) throws IOException { + if (data != null || tempFile != null) { + return write(FileUtil.file(destPath)); + } + return null; + } + + /** + * 将上传的文件写入目标文件
+ * 写入后原临时文件会被删除 + * + * @param destination 目标文件 + * @return 目标文件 + * @throws IOException IO异常 + */ + public File write(File destination) throws IOException { + assertValid(); + + if (destination.isDirectory() == true) { + destination = new File(destination, this.header.getFileName()); + } + if (data != null) { + // 内存中 + FileUtil.writeBytes(data, destination); + data = null; + } else { + // 临时文件 + if(null == this.tempFile){ + throw new NullPointerException("Temp file is null !"); + } + if(false == this.tempFile.exists()){ + throw new NoSuchFileException("Temp file: [" + this.tempFile.getAbsolutePath() + "] not exist!"); + } + + FileUtil.move(tempFile, destination, true); + } + return destination; + } + + /** + * @return 获得文件字节流 + * @throws IOException IO异常 + */ + public byte[] getFileContent() throws IOException { + assertValid(); + + if (data != null) { + return data; + } + if (tempFile != null) { + return FileUtil.readBytes(tempFile); + } + return null; + } + + /** + * @return 获得文件流 + * @throws IOException IO异常 + */ + public InputStream getFileInputStream() throws IOException { + assertValid(); + + if (data != null) { + return IoUtil.toBuffered(IoUtil.toStream(this.data)); + } + if (tempFile != null) { + return IoUtil.toBuffered(IoUtil.toStream(this.tempFile)); + } + return null; + } + + // ---------------------------------------------------------------- header + + /** + * @return 上传文件头部信息 + */ + public UploadFileHeader getHeader() { + return header; + } + + /** + * @return 文件名 + */ + public String getFileName() { + return header == null ? null : header.getFileName(); + } + + // ---------------------------------------------------------------- properties + + /** + * @return 上传文件的大小，> 0 表示未上传 + */ + public long size() { + return size; + } + + /** + * @return 是否上传成功 + */ + public boolean isUploaded() { + return size > 0; + } + + /** + * @return 文件是否在内存中 + */ + public boolean isInMemory() { + return data != null; + } + + // ---------------------------------------------------------------- process + + /** + * 处理上传表单流，提取出文件 + * + * @param input 上传表单的流 + * @return 是否成功 + * @throws IOException IO异常 + */ + protected boolean processStream(MultipartRequestInputStream input) throws IOException { + if (!isAllowedExtension()) { + // 非允许的扩展名 + size = input.skipToBoundary(); + return false; + } + size = 0; + + // 处理内存文件 + int memoryThreshold = setting.memoryThreshold; + if (memoryThreshold > 0) { + final ByteArrayOutputStream baos = new ByteArrayOutputStream(memoryThreshold); + final long written = input.copy(baos, memoryThreshold); + data = baos.toByteArray(); + if (written <= memoryThreshold) { + // 文件存放于内存 + size = data.length; + return true; + } + } + + // 处理硬盘文件 + tempFile = FileUtil.createTempFile(TMP_FILE_PREFIX, TMP_FILE_SUFFIX, FileUtil.touch(setting.tmpUploadPath), false); + final BufferedOutputStream out = FileUtil.getOutputStream(this.tempFile); + if (data != null) { + size = data.length; + out.write(data); + data = null; // not needed anymore + } + final long maxFileSize = setting.maxFileSize; + try { + if (maxFileSize == -1) { + size += input.copy(out); + return true; + } + size += input.copy(out, maxFileSize - size + 1); // one more byte to detect larger files + if (size > maxFileSize) { + // 超出上传大小限制 + //noinspection ResultOfMethodCallIgnored + tempFile.delete(); + tempFile = null; + input.skipToBoundary(); + return false; + } + } finally { + IoUtil.close(out); + } + return true; + } + + // ---------------------------------------------------------------------------- Private method start + + /** + * @return 是否为允许的扩展名 + */ + private boolean isAllowedExtension() { + final String[] exts = setting.fileExts; + boolean isAllow = setting.isAllowFileExts; + if (exts == null || exts.length == 0) { + // 如果给定扩展名列表为空，当允许扩展名时全部允许，否则全部禁止 + return isAllow; + } + + final String fileNameExt = FileUtil.extName(this.getFileName()); + for (String fileExtension : setting.fileExts) { + if (fileNameExt.equalsIgnoreCase(fileExtension)) { + return isAllow; + } + } + + // 未匹配到扩展名，如果为允许列表，返回false， 否则true + return !isAllow; + } + + /** + * 断言是否文件流可用 + * + * @throws IOException IO异常 + */ + private void assertValid() throws IOException { + if (false == isUploaded()) { + throw new IOException(StrUtil.format("File [{}] upload fail", getFileName())); + } + } + // ---------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/UploadFileHeader.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/UploadFileHeader.java new file mode 100644 index 0000000..09cc62d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/UploadFileHeader.java @@ -0,0 +1,204 @@ +package aiyh.utils.tool.cn.hutool.core.net.multipart; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 上传的文件的头部信息
+ * 来自Jodd + * + * @author jodd.org + */ +public class UploadFileHeader { + + // String dataHeader; + String formFieldName; + + String formFileName; + String path; + String fileName; + + boolean isFile; + String contentType; + String mimeType; + String mimeSubtype; + String contentDisposition; + + UploadFileHeader(String dataHeader) { + processHeaderString(dataHeader); + } + + // ---------------------------------------------------------------- public interface + + /** + * Returns {@code true} if uploaded data are correctly marked as a file.
+ * This is true if header contains string 'filename'. + * + * @return 是否为文件 + */ + public boolean isFile() { + return isFile; + } + + /** + * 返回表单字段名 + * + * @return 表单字段名 + */ + public String getFormFieldName() { + return formFieldName; + } + + /** + * 返回表单中的文件名，来自客户端传入 + * + * @return 表单文件名 + */ + public String getFormFileName() { + return formFileName; + } + + /** + * 获取文件名，不包括路径 + * + * @return 文件名 + */ + public String getFileName() { + return fileName; + } + + /** + * Returns uploaded content type. It is usually in the following form:
+ * mime_type/mime_subtype. + * + * @return content type + * @see #getMimeType() + * @see #getMimeSubtype() + */ + public String getContentType() { + return contentType; + } + + /** + * Returns file types MIME. + * + * @return types MIME + */ + public String getMimeType() { + return mimeType; + } + + /** + * Returns file sub type MIME. + * + * @return sub type MIME + */ + public String getMimeSubtype() { + return mimeSubtype; + } + + /** + * Returns content disposition. Usually it is 'form-data'. + * + * @return content disposition + */ + public String getContentDisposition() { + return contentDisposition; + } + + // ---------------------------------------------------------------- Private Method + + /** + * 获得头信息字符串字符串中指定的值 + * + * @param dataHeader 头信息 + * @param fieldName 字段名 + * @return 字段值 + */ + private String getDataFieldValue(String dataHeader, String fieldName) { + String value = null; + String token = StrUtil.format("{}=\"", fieldName); + int pos = dataHeader.indexOf(token); + if (pos > 0) { + int start = pos + token.length(); + int end = dataHeader.indexOf('"', start); + if ((start > 0) && (end > 0)) { + value = dataHeader.substring(start, end); + } + } + return value; + } + + /** + * 头信息中获得content type + * + * @param dataHeader data header string + * @return content type or an empty string if no content type defined + */ + private String getContentType(String dataHeader) { + String token = "Content-Type:"; + int start = dataHeader.indexOf(token); + if (start == -1) { + return StrUtil.EMPTY; + } + start += token.length(); + return dataHeader.substring(start); + } + + private String getContentDisposition(String dataHeader) { + int start = dataHeader.indexOf(':') + 1; + int end = dataHeader.indexOf(';'); + return dataHeader.substring(start, end); + } + + private String getMimeType(String ContentType) { + int pos = ContentType.indexOf('/'); + if (pos == -1) { + return ContentType; + } + return ContentType.substring(1, pos); + } + + private String getMimeSubtype(String ContentType) { + int start = ContentType.indexOf('/'); + if (start == -1) { + return ContentType; + } + start++; + return ContentType.substring(start); + } + + /** + * 处理头字符串，使之转化为字段 + * + * @param dataHeader 头字符串 + */ + private void processHeaderString(String dataHeader) { + isFile = dataHeader.indexOf("filename") > 0; + formFieldName = getDataFieldValue(dataHeader, "name"); + if (isFile) { + formFileName = getDataFieldValue(dataHeader, "filename"); + if (formFileName == null) { + return; + } + if (formFileName.length() == 0) { + path = StrUtil.EMPTY; + fileName = StrUtil.EMPTY; + } + int ls = FileUtil.lastIndexOfSeparator(formFileName); + if (ls == -1) { + path = StrUtil.EMPTY; + fileName = formFileName; + } else { + path = formFileName.substring(0, ls); + fileName = formFileName.substring(ls); + } + if (fileName.length() > 0) { + this.contentType = getContentType(dataHeader); + mimeType = getMimeType(contentType); + mimeSubtype = getMimeSubtype(contentType); + contentDisposition = getContentDisposition(dataHeader); + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/UploadSetting.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/UploadSetting.java new file mode 100644 index 0000000..4fa9d86 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/UploadSetting.java @@ -0,0 +1,110 @@ +package aiyh.utils.tool.cn.hutool.core.net.multipart; + +/** + * 上传文件设定文件 + * + * @author xiaoleilu + * + */ +public class UploadSetting { + + /** 最大文件大小，默认无限制 */ + protected long maxFileSize = -1; + /** 文件保存到内存的边界 */ + protected int memoryThreshold = 8192; + /** 临时文件目录 */ + protected String tmpUploadPath; + /** 文件扩展名限定 */ + protected String[] fileExts; + /** 扩展名是允许列表还是禁止列表 */ + protected boolean isAllowFileExts = true; + + public UploadSetting() { + } + + // ---------------------------------------------------------------------- Setters and Getters start + /** + * @return 获得最大文件大小，-1表示无限制 + */ + public long getMaxFileSize() { + return maxFileSize; + } + + /** + * 设定最大文件大小，-1表示无限制 + * + * @param maxFileSize 最大文件大小 + */ + public void setMaxFileSize(long maxFileSize) { + this.maxFileSize = maxFileSize; + } + + /** + * @return 文件保存到内存的边界 + */ + public int getMemoryThreshold() { + return memoryThreshold; + } + + /** + * 设定文件保存到内存的边界
+ * 如果文件大小小于这个边界，将保存于内存中，否则保存至临时目录中 + * + * @param memoryThreshold 文件保存到内存的边界 + */ + public void setMemoryThreshold(int memoryThreshold) { + this.memoryThreshold = memoryThreshold; + } + + /** + * @return 上传文件的临时目录，若为空，使用系统目录 + */ + public String getTmpUploadPath() { + return tmpUploadPath; + } + + /** + * 设定上传文件的临时目录，null表示使用系统临时目录 + * + * @param tmpUploadPath 临时目录，绝对路径 + */ + public void setTmpUploadPath(String tmpUploadPath) { + this.tmpUploadPath = tmpUploadPath; + } + + /** + * @return 文件扩展名限定列表 + */ + public String[] getFileExts() { + return fileExts; + } + + /** + * 设定文件扩展名限定里列表
+ * 禁止列表还是允许列表取决于isAllowFileExts + * + * @param fileExts 文件扩展名列表 + */ + public void setFileExts(String[] fileExts) { + this.fileExts = fileExts; + } + + /** + * 是否允许文件扩展名
+ * + * @return 若true表示只允许列表里的扩展名，否则是禁止列表里的扩展名 + */ + public boolean isAllowFileExts() { + return isAllowFileExts; + } + + /** + * 设定是否允许扩展名 + * + * @param isAllowFileExts 若true表示只允许列表里的扩展名，否则是禁止列表里的扩展名 + */ + public void setAllowFileExts(boolean isAllowFileExts) { + this.isAllowFileExts = isAllowFileExts; + } + // ---------------------------------------------------------------------- Setters and Getters end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/package-info.java new file mode 100644 index 0000000..f47fc00 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/multipart/package-info.java @@ -0,0 +1,7 @@ +/** + * 文件上传封装 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.net.multipart; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/package-info.java new file mode 100644 index 0000000..bb21d8a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/package-info.java @@ -0,0 +1,7 @@ +/** + * 网络相关工具 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.net; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/url/UrlBuilder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/url/UrlBuilder.java new file mode 100755 index 0000000..73d328c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/url/UrlBuilder.java @@ -0,0 +1,583 @@ +package aiyh.utils.tool.cn.hutool.core.net.url; + +import aiyh.utils.tool.cn.hutool.core.builder.Builder; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.net.RFC3986; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; + +import java.net.MalformedURLException; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; +import java.net.URLStreamHandler; +import java.nio.charset.Charset; + +/** + * URL 生成器，格式形如： + * 

+ * [scheme:]scheme-specific-part[#fragment]
+ * [scheme:][//authority][path][?query][#fragment]
+ * [scheme:][//host:port][path][?query][#fragment]
+ *
+ * + * @author looly + * @see Uniform Resource Identifier + * @since 5.3.1 + */ +public final class UrlBuilder implements Builder { + private static final long serialVersionUID = 1L; + private static final String DEFAULT_SCHEME = "http"; + + /** + * 协议，例如http + */ + private String scheme; + /** + * 主机，例如127.0.0.1 + */ + private String host; + /** + * 端口，默认-1 + */ + private int port = -1; + /** + * 路径，例如/aa/bb/cc + */ + private UrlPath path; + /** + * 查询语句，例如a=1&b=2 + */ + private UrlQuery query; + /** + * 标识符，例如#后边的部分 + */ + private String fragment; + + /** + * 编码，用于URLEncode和URLDecode + */ + private Charset charset; + /** + * 是否需要编码`%`
+ * 区别对待，如果是，则生成URL时需要重新全部编码，否则跳过所有`%` + */ + private boolean needEncodePercent; + + /** + * 使用URI构建UrlBuilder + * + * @param uri URI + * @param charset 编码，用于URLEncode和URLDecode + * @return UrlBuilder + */ + public static UrlBuilder of(URI uri, Charset charset) { + return of(uri.getScheme(), uri.getHost(), uri.getPort(), uri.getPath(), uri.getRawQuery(), uri.getFragment(), charset); + } + + /** + * 使用URL字符串构建UrlBuilder，当传入的URL没有协议时，按照http协议对待
+ * 此方法不对URL编码 + * + * @param httpUrl URL字符串 + * @return UrlBuilder + * @since 5.4.3 + */ + public static UrlBuilder ofHttpWithoutEncode(String httpUrl) { + return ofHttp(httpUrl, null); + } + + /** + * 使用URL字符串构建UrlBuilder，当传入的URL没有协议时，按照http协议对待，编码默认使用UTF-8 + * + * @param httpUrl URL字符串 + * @return UrlBuilder + * @since 5.6.3 + */ + public static UrlBuilder ofHttp(String httpUrl) { + return ofHttp(httpUrl, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 使用URL字符串构建UrlBuilder，当传入的URL没有协议时，按照http协议对待。 + * + * @param httpUrl URL字符串 + * @param charset 编码，用于URLEncode和URLDecode + * @return UrlBuilder + */ + public static UrlBuilder ofHttp(String httpUrl, Charset charset) { + Assert.notBlank(httpUrl, "Http url must be not blank!"); + httpUrl = StrUtil.trimStart(httpUrl); + // issue#I66CIR + if(false == StrUtil.startWithAnyIgnoreCase(httpUrl, "http://", "https://")){ + httpUrl = "http://" + httpUrl; + } + return of(httpUrl, charset); + } + + /** + * 使用URL字符串构建UrlBuilder，默认使用UTF-8编码 + * + * @param url URL字符串 + * @return UrlBuilder + */ + public static UrlBuilder of(String url) { + return of(url, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 使用URL字符串构建UrlBuilder + * + * @param url URL字符串 + * @param charset 编码，用于URLEncode和URLDecode + * @return UrlBuilder + */ + public static UrlBuilder of(String url, Charset charset) { + Assert.notBlank(url, "Url must be not blank!"); + return of(URLUtil.url(StrUtil.trim(url)), charset); + } + + /** + * 使用URL构建UrlBuilder + * + * @param url URL + * @param charset 编码，用于URLEncode和URLDecode + * @return UrlBuilder + */ + public static UrlBuilder of(URL url, Charset charset) { + return of(url.getProtocol(), url.getHost(), url.getPort(), url.getPath(), url.getQuery(), url.getRef(), charset); + } + + /** + * 构建UrlBuilder + * + * @param scheme 协议，默认http + * @param host 主机，例如127.0.0.1 + * @param port 端口，-1表示默认端口 + * @param path 路径，例如/aa/bb/cc + * @param query 查询，例如a=1&b=2 + * @param fragment 标识符例如#后边的部分 + * @param charset 编码，用于URLEncode和URLDecode + * @return UrlBuilder + */ + public static UrlBuilder of(String scheme, String host, int port, String path, String query, String fragment, Charset charset) { + return of(scheme, host, port, + UrlPath.of(path, charset), + UrlQuery.of(query, charset, false), fragment, charset); + } + + /** + * 构建UrlBuilder + * + * @param scheme 协议，默认http + * @param host 主机，例如127.0.0.1 + * @param port 端口，-1表示默认端口 + * @param path 路径，例如/aa/bb/cc + * @param query 查询，例如a=1&b=2 + * @param fragment 标识符例如#后边的部分 + * @param charset 编码，用于URLEncode和URLDecode + * @return UrlBuilder + */ + public static UrlBuilder of(String scheme, String host, int port, UrlPath path, UrlQuery query, String fragment, Charset charset) { + return new UrlBuilder(scheme, host, port, path, query, fragment, charset); + } + + /** + * 创建空的UrlBuilder + * + * @return UrlBuilder + * @deprecated 请使用 {@link #of()} + */ + @Deprecated + public static UrlBuilder create() { + return new UrlBuilder(); + } + + /** + * 创建空的UrlBuilder + * + * @return UrlBuilder + */ + public static UrlBuilder of() { + return new UrlBuilder(); + } + + /** + * 构造 + */ + public UrlBuilder() { + this.charset = CharsetUtil.CHARSET_UTF_8; + } + + /** + * 构造 + * + * @param scheme 协议，默认http + * @param host 主机，例如127.0.0.1 + * @param port 端口，-1表示默认端口 + * @param path 路径，例如/aa/bb/cc + * @param query 查询，例如a=1&b=2 + * @param fragment 标识符例如#后边的部分 + * @param charset 编码，用于URLEncode和URLDecode，{@code null}表示不编码 + */ + public UrlBuilder(String scheme, String host, int port, UrlPath path, UrlQuery query, String fragment, Charset charset) { + this.charset = charset; + this.scheme = scheme; + this.host = host; + this.port = port; + this.path = path; + this.query = query; + this.setFragment(fragment); + // 编码非空情况下做解码 + this.needEncodePercent = null != charset; + } + + /** + * 获取协议，例如http + * + * @return 协议，例如http + */ + public String getScheme() { + return scheme; + } + + /** + * 获取协议，例如http，如果用户未定义协议，使用默认的http协议 + * + * @return 协议，例如http + */ + public String getSchemeWithDefault() { + return StrUtil.emptyToDefault(this.scheme, DEFAULT_SCHEME); + } + + /** + * 设置协议，例如http + * + * @param scheme 协议，例如http + * @return this + */ + public UrlBuilder setScheme(String scheme) { + this.scheme = scheme; + return this; + } + + /** + * 获取 主机，例如127.0.0.1 + * + * @return 主机，例如127.0.0.1 + */ + public String getHost() { + return host; + } + + /** + * 设置主机，例如127.0.0.1 + * + * @param host 主机，例如127.0.0.1 + * @return this + */ + public UrlBuilder setHost(String host) { + this.host = host; + return this; + } + + /** + * 获取端口，默认-1 + * + * @return 端口，默认-1 + */ + public int getPort() { + return port; + } + + /** + * 获取端口，如果未自定义返回协议默认端口 + * + * @return 端口 + */ + public int getPortWithDefault() { + int port = getPort(); + if (port > 0) { + return port; + } + URL url = this.toURL(); + return url.getDefaultPort(); + } + + /** + * 设置端口，默认-1 + * + * @param port 端口，默认-1 + * @return this + */ + public UrlBuilder setPort(int port) { + this.port = port; + return this; + } + + /** + * 获得authority部分 + * + * @return authority部分 + */ + public String getAuthority() { + return (port < 0) ? host : host + ":" + port; + } + + /** + * 获取路径，例如/aa/bb/cc + * + * @return 路径，例如/aa/bb/cc + */ + public UrlPath getPath() { + return path; + } + + /** + * 获得路径，例如/aa/bb/cc + * + * @return 路径，例如/aa/bb/cc + */ + public String getPathStr() { + return null == this.path ? StrUtil.SLASH : this.path.build(charset, this.needEncodePercent); + } + + /** + * 是否path的末尾加 / + * + * @param withEngTag 是否path的末尾加 / + * @return this + * @since 5.8.5 + */ + public UrlBuilder setWithEndTag(boolean withEngTag) { + if (null == this.path) { + this.path = new UrlPath(); + } + + this.path.setWithEndTag(withEngTag); + return this; + } + + /** + * 设置路径，例如/aa/bb/cc，将覆盖之前所有的path相关设置 + * + * @param path 路径，例如/aa/bb/cc + * @return this + */ + public UrlBuilder setPath(UrlPath path) { + this.path = path; + return this; + } + + /** + * 增加路径，在现有路径基础上追加路径 + * + * @param path 路径，例如aaa/bbb/ccc + * @return this + */ + public UrlBuilder addPath(CharSequence path) { + UrlPath.of(path, this.charset).getSegments().forEach(this::addPathSegment); + return this; + } + + /** + * 增加路径节点，路径节点中的"/"会被转义为"%2F" + * + * @param segment 路径节点 + * @return this + * @since 5.7.16 + */ + public UrlBuilder addPathSegment(CharSequence segment) { + if (StrUtil.isEmpty(segment)) { + return this; + } + if (null == this.path) { + this.path = new UrlPath(); + } + this.path.add(segment); + return this; + } + + /** + * 追加path节点 + * + * @param path path节点 + * @return this + * @deprecated 方法重复，请使用{@link #addPath(CharSequence)} + */ + @Deprecated + public UrlBuilder appendPath(CharSequence path) { + return addPath(path); + } + + /** + * 获取查询语句，例如a=1&b=2
+ * 可能为{@code null} + * + * @return 查询语句，例如a=1&b=2，可能为{@code null} + */ + public UrlQuery getQuery() { + return query; + } + + /** + * 获取查询语句，例如a=1&b=2 + * + * @return 查询语句，例如a=1&b=2 + */ + public String getQueryStr() { + return null == this.query ? null : this.query.build(this.charset, this.needEncodePercent); + } + + /** + * 设置查询语句，例如a=1&b=2，将覆盖之前所有的query相关设置 + * + * @param query 查询语句，例如a=1&b=2 + * @return this + */ + public UrlBuilder setQuery(UrlQuery query) { + this.query = query; + return this; + } + + /** + * 添加查询项，支持重复键 + * + * @param key 键 + * @param value 值 + * @return this + */ + public UrlBuilder addQuery(String key, Object value) { + if (StrUtil.isEmpty(key)) { + return this; + } + + if (this.query == null) { + this.query = new UrlQuery(); + } + this.query.add(key, value); + return this; + } + + /** + * 获取标识符，#后边的部分 + * + * @return 标识符，例如#后边的部分 + */ + public String getFragment() { + return fragment; + } + + /** + * 获取标识符，#后边的部分 + * + * @return 标识符，例如#后边的部分 + */ + public String getFragmentEncoded() { + final char[] safeChars = this.needEncodePercent ? null : new char[]{'%'}; + return RFC3986.FRAGMENT.encode(this.fragment, this.charset, safeChars); + } + + /** + * 设置标识符，例如#后边的部分 + * + * @param fragment 标识符，例如#后边的部分 + * @return this + */ + public UrlBuilder setFragment(String fragment) { + if (StrUtil.isEmpty(fragment)) { + this.fragment = null; + } + this.fragment = StrUtil.removePrefix(fragment, "#"); + return this; + } + + /** + * 获取编码，用于URLEncode和URLDecode + * + * @return 编码 + */ + public Charset getCharset() { + return charset; + } + + /** + * 设置编码，用于URLEncode和URLDecode + * + * @param charset 编码 + * @return this + */ + public UrlBuilder setCharset(Charset charset) { + this.charset = charset; + return this; + } + + /** + * 创建URL字符串 + * + * @return URL字符串 + */ + @Override + public String build() { + return toURL().toString(); + } + + /** + * 转换为{@link URL} 对象 + * + * @return {@link URL} + */ + public URL toURL() { + return toURL(null); + } + + /** + * 转换为{@link URL} 对象 + * + * @param handler {@link URLStreamHandler}，null表示默认 + * @return {@link URL} + */ + public URL toURL(URLStreamHandler handler) { + final StringBuilder fileBuilder = new StringBuilder(); + + // path + fileBuilder.append(getPathStr()); + + // query + final String query = getQueryStr(); + if (StrUtil.isNotBlank(query)) { + fileBuilder.append('?').append(query); + } + + // fragment + if (StrUtil.isNotBlank(this.fragment)) { + fileBuilder.append('#').append(getFragmentEncoded()); + } + + try { + return new URL(getSchemeWithDefault(), host, port, fileBuilder.toString(), handler); + } catch (MalformedURLException e) { + return null; + } + } + + /** + * 转换为URI + * + * @return URI + */ + public URI toURI() { + try { + return toURL().toURI(); + } catch (URISyntaxException e) { + return null; + } + } + + @Override + public String toString() { + return build(); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/url/UrlPath.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/url/UrlPath.java new file mode 100644 index 0000000..d8f9df5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/url/UrlPath.java @@ -0,0 +1,219 @@ +package aiyh.utils.tool.cn.hutool.core.net.url; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.collection.ListUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.net.RFC3986; +import aiyh.utils.tool.cn.hutool.core.net.URLDecoder; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.nio.charset.Charset; +import java.util.LinkedList; +import java.util.List; + +/** + * URL中Path部分的封装 + * + * @author looly + * @since 5.3.1 + */ +public class UrlPath { + + private List segments; + private boolean withEngTag; + + /** + * 构建UrlPath + * + * @param pathStr 初始化的路径字符串 + * @param charset decode用的编码，null表示不做decode + * @return UrlPath + */ + public static UrlPath of(CharSequence pathStr, Charset charset) { + final UrlPath urlPath = new UrlPath(); + urlPath.parse(pathStr, charset); + return urlPath; + } + + /** + * 是否path的末尾加 / + * + * @param withEngTag 是否path的末尾加 / + * @return this + */ + public UrlPath setWithEndTag(boolean withEngTag) { + this.withEngTag = withEngTag; + return this; + } + + /** + * 获取path的节点列表 + * + * @return 节点列表 + */ + public List getSegments() { + return ObjectUtil.defaultIfNull(this.segments, ListUtil.empty()); + } + + /** + * 获得指定节点 + * + * @param index 节点位置 + * @return 节点，无节点或者越界返回null + */ + public String getSegment(int index) { + if (null == this.segments || index >= this.segments.size()) { + return null; + } + return this.segments.get(index); + } + + /** + * 添加到path最后面 + * + * @param segment Path节点 + * @return this + */ + public UrlPath add(CharSequence segment) { + addInternal(fixPath(segment), false); + return this; + } + + /** + * 添加到path最前面 + * + * @param segment Path节点 + * @return this + */ + public UrlPath addBefore(CharSequence segment) { + addInternal(fixPath(segment), true); + return this; + } + + /** + * 解析path + * + * @param path 路径，类似于aaa/bb/ccc或/aaa/bbb/ccc + * @param charset decode编码，null表示不解码 + * @return this + */ + public UrlPath parse(CharSequence path, Charset charset) { + if (StrUtil.isNotEmpty(path)) { + // 原URL中以/结尾，则这个规则需保留，issue#I1G44J@Gitee + if(StrUtil.endWith(path, CharUtil.SLASH)){ + this.withEngTag = true; + } + + path = fixPath(path); + if(StrUtil.isNotEmpty(path)){ + final List split = StrUtil.split(path, '/'); + for (String seg : split) { + addInternal(URLDecoder.decodeForPath(seg, charset), false); + } + } + } + + return this; + } + + /** + * 构建path，前面带'/'
+ * 
+	 *     path = path-abempty / path-absolute / path-noscheme / path-rootless / path-empty
+	 *
+ * + * @param charset encode编码，null表示不做encode + * @return 如果没有任何内容，则返回空字符串"" + */ + public String build(Charset charset) { + return build(charset, true); + } + + /** + * 构建path，前面带'/'
+ * 
+	 *     path = path-abempty / path-absolute / path-noscheme / path-rootless / path-empty
+	 *
+ * + * @param charset encode编码，null表示不做encode + * @param encodePercent 是否编码`%` + * @return 如果没有任何内容，则返回空字符串"" + * @since 5.8.0 + */ + public String build(Charset charset, boolean encodePercent) { + if (CollUtil.isEmpty(this.segments)) { + // 没有节点的path取决于是否末尾追加/，如果不追加返回空串，否则返回/ + return withEngTag ? StrUtil.SLASH : StrUtil.EMPTY; + } + + final char[] safeChars = encodePercent ? null : new char[]{'%'}; + final StringBuilder builder = new StringBuilder(); + for (final String segment : segments) { + if(builder.length() == 0){ + // 根据https://www.ietf.org/rfc/rfc3986.html#section-3.3定义 + // path的第一部分不允许有":"，其余部分允许 + // 在此处的Path部分特指host之后的部分，即不包含第一部分 + builder.append(CharUtil.SLASH).append(RFC3986.SEGMENT_NZ_NC.encode(segment, charset, safeChars)); + } else { + builder.append(CharUtil.SLASH).append(RFC3986.SEGMENT.encode(segment, charset, safeChars)); + } + } + + if(withEngTag){ + if (StrUtil.isEmpty(builder)) { + // 空白追加是保证以/开头 + builder.append(CharUtil.SLASH); + }else if (false == StrUtil.endWith(builder, CharUtil.SLASH)) { + // 尾部没有/则追加，否则不追加 + builder.append(CharUtil.SLASH); + } + } + + return builder.toString(); + } + + @Override + public String toString() { + return build(null); + } + + /** + * 增加节点 + * + * @param segment 节点 + * @param before 是否在前面添加 + */ + private void addInternal(CharSequence segment, boolean before) { + if (this.segments == null) { + this.segments = new LinkedList<>(); + } + + final String seg = StrUtil.str(segment); + if (before) { + this.segments.add(0, seg); + } else { + this.segments.add(seg); + } + } + + /** + * 修正路径，包括去掉前后的/，去掉空白符 + * + * @param path 节点或路径path + * @return 修正后的路径 + */ + private static String fixPath(CharSequence path) { + Assert.notNull(path, "Path segment must be not null!"); + if ("/".contentEquals(path)) { + return StrUtil.EMPTY; + } + + String segmentStr = StrUtil.trim(path); + segmentStr = StrUtil.removePrefix(segmentStr, StrUtil.SLASH); + segmentStr = StrUtil.removeSuffix(segmentStr, StrUtil.SLASH); + segmentStr = StrUtil.trim(segmentStr); + return segmentStr; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/url/UrlQuery.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/url/UrlQuery.java new file mode 100644 index 0000000..4c34cf2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/url/UrlQuery.java @@ -0,0 +1,415 @@ +package aiyh.utils.tool.cn.hutool.core.net.url; + +import aiyh.utils.tool.cn.hutool.core.codec.PercentCodec; +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.collection.IterUtil; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.map.TableMap; +import aiyh.utils.tool.cn.hutool.core.net.FormUrlencoded; +import aiyh.utils.tool.cn.hutool.core.net.RFC3986; +import aiyh.utils.tool.cn.hutool.core.net.URLDecoder; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.nio.charset.Charset; +import java.util.Iterator; +import java.util.Map; + +/** + * URL中查询字符串部分的封装，类似于： + * 
+ *   key1=v1&key2=&key3=v3
+ *
+ * 查询封装分为解析查询字符串和构建查询字符串，解析可通过charset为null来自定义是否decode编码后的内容，
+ * 构建则通过charset是否为null是否encode参数键值对 + * + * @author looly + * @since 5.3.1 + */ +public class UrlQuery { + + private final TableMap query; + /** + * 是否为x-www-form-urlencoded模式，此模式下空格会编码为'+' + */ + private final boolean isFormUrlEncoded; + + /** + * 构建UrlQuery + * + * @param queryMap 初始化的查询键值对 + * @return UrlQuery + */ + public static UrlQuery of(Map queryMap) { + return new UrlQuery(queryMap); + } + + /** + * 构建UrlQuery + * + * @param queryMap 初始化的查询键值对 + * @param isFormUrlEncoded 是否为x-www-form-urlencoded模式，此模式下空格会编码为'+' + * @return UrlQuery + */ + public static UrlQuery of(Map queryMap, boolean isFormUrlEncoded) { + return new UrlQuery(queryMap, isFormUrlEncoded); + } + + /** + * 构建UrlQuery + * + * @param queryStr 初始化的查询字符串 + * @param charset decode用的编码，null表示不做decode + * @return UrlQuery + */ + public static UrlQuery of(String queryStr, Charset charset) { + return of(queryStr, charset, true); + } + + /** + * 构建UrlQuery + * + * @param queryStr 初始化的查询字符串 + * @param charset decode用的编码，null表示不做decode + * @param autoRemovePath 是否自动去除path部分，{@code true}则自动去除第一个?前的内容 + * @return UrlQuery + * @since 5.5.8 + */ + public static UrlQuery of(String queryStr, Charset charset, boolean autoRemovePath) { + return of(queryStr, charset, autoRemovePath, false); + } + + /** + * 构建UrlQuery + * + * @param queryStr 初始化的查询字符串 + * @param charset decode用的编码，null表示不做decode + * @param autoRemovePath 是否自动去除path部分，{@code true}则自动去除第一个?前的内容 + * @param isFormUrlEncoded 是否为x-www-form-urlencoded模式，此模式下空格会编码为'+' + * @return UrlQuery + * @since 5.7.16 + */ + public static UrlQuery of(String queryStr, Charset charset, boolean autoRemovePath, boolean isFormUrlEncoded) { + return new UrlQuery(isFormUrlEncoded).parse(queryStr, charset, autoRemovePath); + } + + /** + * 构造 + */ + public UrlQuery() { + this(null); + } + + /** + * 构造 + * + * @param isFormUrlEncoded 是否为x-www-form-urlencoded模式，此模式下空格会编码为'+' + * @since 5.7.16 + */ + public UrlQuery(boolean isFormUrlEncoded) { + this(null, isFormUrlEncoded); + } + + /** + * 构造 + * + * @param queryMap 初始化的查询键值对 + */ + public UrlQuery(Map queryMap) { + this(queryMap, false); + } + + /** + * 构造 + * + * @param queryMap 初始化的查询键值对 + * @param isFormUrlEncoded 是否为x-www-form-urlencoded模式，此模式下空格会编码为'+' + * @since 5.7.16 + */ + public UrlQuery(Map queryMap, boolean isFormUrlEncoded) { + if (MapUtil.isNotEmpty(queryMap)) { + query = new TableMap<>(queryMap.size()); + addAll(queryMap); + } else { + query = new TableMap<>(MapUtil.DEFAULT_INITIAL_CAPACITY); + } + this.isFormUrlEncoded = isFormUrlEncoded; + } + + /** + * 增加键值对 + * + * @param key 键 + * @param value 值，集合和数组转换为逗号分隔形式 + * @return this + */ + public UrlQuery add(CharSequence key, Object value) { + this.query.put(key, toStr(value)); + return this; + } + + /** + * 批量增加键值对 + * + * @param queryMap query中的键值对 + * @return this + */ + public UrlQuery addAll(Map queryMap) { + if (MapUtil.isNotEmpty(queryMap)) { + queryMap.forEach(this::add); + } + return this; + } + + /** + * 解析URL中的查询字符串 + * + * @param queryStr 查询字符串，类似于key1=v1&key2=&key3=v3 + * @param charset decode编码，null表示不做decode + * @return this + */ + public UrlQuery parse(String queryStr, Charset charset) { + return parse(queryStr, charset, true); + } + + /** + * 解析URL中的查询字符串 + * + * @param queryStr 查询字符串，类似于key1=v1&key2=&key3=v3 + * @param charset decode编码，null表示不做decode + * @param autoRemovePath 是否自动去除path部分，{@code true}则自动去除第一个?前的内容 + * @return this + * @since 5.5.8 + */ + public UrlQuery parse(String queryStr, Charset charset, boolean autoRemovePath) { + if (StrUtil.isBlank(queryStr)) { + return this; + } + + if (autoRemovePath) { + // 去掉Path部分 + int pathEndPos = queryStr.indexOf('?'); + if (pathEndPos > -1) { + queryStr = StrUtil.subSuf(queryStr, pathEndPos + 1); + if (StrUtil.isBlank(queryStr)) { + return this; + } + } + } + + return doParse(queryStr, charset); + } + + /** + * 获得查询的Map + * + * @return 查询的Map，只读 + */ + public Map getQueryMap() { + return MapUtil.unmodifiable(this.query); + } + + /** + * 获取查询值 + * + * @param key 键 + * @return 值 + */ + public CharSequence get(CharSequence key) { + if (MapUtil.isEmpty(this.query)) { + return null; + } + return this.query.get(key); + } + + /** + * 构建URL查询字符串，即将key-value键值对转换为{@code key1=v1&key2=v2&key3=v3}形式。
+ * 对于{@code null}处理规则如下： + *
    + *
  • 如果key为{@code null}，则这个键值对忽略
    • + *
  • 如果value为{@code null}，只保留key，如key1对应value为{@code null}生成类似于{@code key1&key2=v2}形式
    • + *
+ * + * @param charset encode编码，null表示不做encode编码 + * @return URL查询字符串 + */ + public String build(Charset charset) { + return build(charset, true); + } + + /** + * 构建URL查询字符串，即将key-value键值对转换为{@code key1=v1&key2=v2&key3=v3}形式。
+ * 对于{@code null}处理规则如下： + *
    + *
  • 如果key为{@code null}，则这个键值对忽略
    • + *
  • 如果value为{@code null}，只保留key，如key1对应value为{@code null}生成类似于{@code key1&key2=v2}形式
    • + *
+ * + * @param charset encode编码，null表示不做encode编码 + * @param encodePercent 是否编码`%` + * @return URL查询字符串 + */ + public String build(Charset charset, boolean encodePercent) { + if (isFormUrlEncoded) { + return build(FormUrlencoded.ALL, FormUrlencoded.ALL, charset, encodePercent); + } + + return build(RFC3986.QUERY_PARAM_NAME, RFC3986.QUERY_PARAM_VALUE, charset, encodePercent); + } + + /** + * 构建URL查询字符串，即将key-value键值对转换为{@code key1=v1&key2=v2&key3=v3}形式。
+ * 对于{@code null}处理规则如下： + *
    + *
  • 如果key为{@code null}，则这个键值对忽略
    • + *
  • 如果value为{@code null}，只保留key，如key1对应value为{@code null}生成类似于{@code key1&key2=v2}形式
    • + *
+ * + * @param keyCoder 键值对中键的编码器 + * @param valueCoder 键值对中值的编码器 + * @param charset encode编码，null表示不做encode编码 + * @return URL查询字符串 + * @since 5.7.16 + */ + public String build(PercentCodec keyCoder, PercentCodec valueCoder, Charset charset) { + return build(keyCoder, valueCoder, charset, true); + } + + /** + * 构建URL查询字符串，即将key-value键值对转换为{@code key1=v1&key2=v2&key3=v3}形式。
+ * 对于{@code null}处理规则如下： + *
    + *
  • 如果key为{@code null}，则这个键值对忽略
    • + *
  • 如果value为{@code null}，只保留key，如key1对应value为{@code null}生成类似于{@code key1&key2=v2}形式
    • + *
+ * + * @param keyCoder 键值对中键的编码器 + * @param valueCoder 键值对中值的编码器 + * @param charset encode编码，null表示不做encode编码 + * @param encodePercent 是否编码`%` + * @return URL查询字符串 + * @since 5.8.0 + */ + public String build(PercentCodec keyCoder, PercentCodec valueCoder, Charset charset, boolean encodePercent) { + if (MapUtil.isEmpty(this.query)) { + return StrUtil.EMPTY; + } + + final char[] safeChars = encodePercent ? null : new char[]{'%'}; + final StringBuilder sb = new StringBuilder(); + CharSequence name; + CharSequence value; + for (Map.Entry entry : this.query) { + name = entry.getKey(); + if (null != name) { + if (sb.length() > 0) { + sb.append("&"); + } + sb.append(keyCoder.encode(name, charset, safeChars)); + value = entry.getValue(); + if (null != value) { + sb.append("=").append(valueCoder.encode(value, charset, safeChars)); + } + } + } + return sb.toString(); + } + + /** + * 生成查询字符串，类似于aaa=111&bbb=222
+ * 此方法不对任何特殊字符编码，仅用于输出显示 + * + * @return 查询字符串 + */ + @Override + public String toString() { + return build(null); + } + + /** + * 解析URL中的查询字符串
+ * 规则见：https://url.spec.whatwg.org/#urlencoded-parsing + * + * @param queryStr 查询字符串，类似于key1=v1&key2=&key3=v3 + * @param charset decode编码，null表示不做decode + * @return this + * @since 5.5.8 + */ + private UrlQuery doParse(String queryStr, Charset charset) { + final int len = queryStr.length(); + String name = null; + int pos = 0; // 未处理字符开始位置 + int i; // 未处理字符结束位置 + char c; // 当前字符 + for (i = 0; i < len; i++) { + c = queryStr.charAt(i); + switch (c) { + case '='://键和值的分界符 + if (null == name) { + // name可以是"" + name = queryStr.substring(pos, i); + // 开始位置从分节符后开始 + pos = i + 1; + } + // 当=不作为分界符时，按照普通字符对待 + break; + case '&'://键值对之间的分界符 + addParam(name, queryStr.substring(pos, i), charset); + name = null; + if (i + 4 < len && "amp;".equals(queryStr.substring(i + 1, i + 5))) { + // issue#850@Github，"&"转义为"&" + i += 4; + } + // 开始位置从分节符后开始 + pos = i + 1; + break; + } + } + + // 处理结尾 + addParam(name, queryStr.substring(pos, i), charset); + + return this; + } + + /** + * 对象转换为字符串，用于URL的Query中 + * + * @param value 值 + * @return 字符串 + */ + private static String toStr(Object value) { + String result; + if (value instanceof Iterable) { + result = CollUtil.join((Iterable) value, ","); + } else if (value instanceof Iterator) { + result = IterUtil.join((Iterator) value, ","); + } else { + result = Convert.toStr(value); + } + return result; + } + + /** + * 将键值对加入到值为List类型的Map中,，情况如下： + * 
+	 *     1、key和value都不为null，类似于 "a=1"或者"=1"，直接put
+	 *     2、key不为null，value为null，类似于 "a="，值传""
+	 *     3、key为null，value不为null，类似于 "1"
+	 *     4、key和value都为null，忽略之，比如&&
+	 *
+ * + * @param key key，为null则value作为key + * @param value value，为null且key不为null时传入"" + * @param charset 编码 + */ + private void addParam(String key, String value, Charset charset) { + if (null != key) { + final String actualKey = URLDecoder.decode(key, charset, isFormUrlEncoded); + this.query.put(actualKey, StrUtil.nullToEmpty(URLDecoder.decode(value, charset, isFormUrlEncoded))); + } else if (null != value) { + // name为空，value作为name，value赋值null + this.query.put(URLDecoder.decode(value, charset, isFormUrlEncoded), null); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/net/url/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/url/package-info.java new file mode 100644 index 0000000..a3073d1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/net/url/package-info.java @@ -0,0 +1,7 @@ +/** + * URL相关工具 + * + * @author looly + * @since 5.3.1 + */ +package aiyh.utils.tool.cn.hutool.core.net.url; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/package-info.java new file mode 100644 index 0000000..4440e7a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/package-info.java @@ -0,0 +1,7 @@ +/** + * Hutool核心方法及数据结构包 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/stream/CollectorUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/stream/CollectorUtil.java new file mode 100644 index 0000000..49fe73e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/stream/CollectorUtil.java @@ -0,0 +1,314 @@ +package aiyh.utils.tool.cn.hutool.core.stream; + +import aiyh.utils.tool.cn.hutool.core.lang.Opt; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.EnumSet; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.StringJoiner; +import java.util.function.BiConsumer; +import java.util.function.BinaryOperator; +import java.util.function.Function; +import java.util.function.Supplier; +import java.util.stream.Collector; +import java.util.stream.Collectors; + +/** + * 可变的汇聚操作{@link Collector} 相关工具封装 + * + * @author looly, VampireAchao + * @since 5.6.7 + */ +public class CollectorUtil { + + /** + * 说明已包含IDENTITY_FINISH特征 为 Characteristics.IDENTITY_FINISH 的缩写 + */ + public static final Set CH_ID + = Collections.unmodifiableSet(EnumSet.of(Collector.Characteristics.IDENTITY_FINISH)); + /** + * 说明不包含IDENTITY_FINISH特征 + */ + public static final Set CH_NOID = Collections.emptySet(); + + /** + * 提供任意对象的Join操作的{@link Collector}实现，对象默认调用toString方法 + * + * @param delimiter 分隔符 + * @param 对象类型 + * @return {@link Collector} + */ + public static Collector joining(CharSequence delimiter) { + return joining(delimiter, Object::toString); + } + + /** + * 提供任意对象的Join操作的{@link Collector}实现 + * + * @param delimiter 分隔符 + * @param toStringFunc 自定义指定对象转换为字符串的方法 + * @param 对象类型 + * @return {@link Collector} + */ + public static Collector joining(CharSequence delimiter, + Function toStringFunc) { + return joining(delimiter, StrUtil.EMPTY, StrUtil.EMPTY, toStringFunc); + } + + /** + * 提供任意对象的Join操作的{@link Collector}实现 + * + * @param delimiter 分隔符 + * @param prefix 前缀 + * @param suffix 后缀 + * @param toStringFunc 自定义指定对象转换为字符串的方法 + * @param 对象类型 + * @return {@link Collector} + */ + public static Collector joining(CharSequence delimiter, + CharSequence prefix, + CharSequence suffix, + Function toStringFunc) { + return new SimpleCollector<>( + () -> new StringJoiner(delimiter, prefix, suffix), + (joiner, ele) -> joiner.add(toStringFunc.apply(ele)), + StringJoiner::merge, + StringJoiner::toString, + Collections.emptySet() + ); + } + + + /** + * 提供对null值友好的groupingBy操作的{@link Collector}实现，可指定map类型 + * + * @param classifier 分组依据 + * @param mapFactory 提供的map + * @param downstream 下游操作 + * @param 实体类型 + * @param 实体中的分组依据对应类型，也是Map中key的类型 + * @param 下游操作对应返回类型，也是Map中value的类型 + * @param 下游操作在进行中间操作时对应类型 + * @param 最后返回结果Map类型 + * @return {@link Collector} + */ + public static > Collector groupingBy(Function classifier, + Supplier mapFactory, + Collector downstream) { + final Supplier downstreamSupplier = downstream.supplier(); + final BiConsumer downstreamAccumulator = downstream.accumulator(); + final BiConsumer, T> accumulator = (m, t) -> { + final K key = Opt.ofNullable(t).map(classifier).orElse(null); + final A container = m.computeIfAbsent(key, k -> downstreamSupplier.get()); + downstreamAccumulator.accept(container, t); + }; + final BinaryOperator> merger = mapMerger(downstream.combiner()); + @SuppressWarnings("unchecked") final Supplier> mangledFactory = (Supplier>) mapFactory; + + if (downstream.characteristics().contains(Collector.Characteristics.IDENTITY_FINISH)) { + return new SimpleCollector<>(mangledFactory, accumulator, merger, CH_ID); + } else { + @SuppressWarnings("unchecked") final Function downstreamFinisher = (Function) downstream.finisher(); + final Function, M> finisher = intermediate -> { + intermediate.replaceAll((k, v) -> downstreamFinisher.apply(v)); + @SuppressWarnings("unchecked") final M castResult = (M) intermediate; + return castResult; + }; + return new SimpleCollector<>(mangledFactory, accumulator, merger, finisher, CH_NOID); + } + } + + /** + * 提供对null值友好的groupingBy操作的{@link Collector}实现 + * + * @param classifier 分组依据 + * @param downstream 下游操作 + * @param 实体类型 + * @param 实体中的分组依据对应类型，也是Map中key的类型 + * @param 下游操作对应返回类型，也是Map中value的类型 + * @param 下游操作在进行中间操作时对应类型 + * @return {@link Collector} + */ + public static + Collector> groupingBy(Function classifier, + Collector downstream) { + return groupingBy(classifier, HashMap::new, downstream); + } + + /** + * 提供对null值友好的groupingBy操作的{@link Collector}实现 + * + * @param classifier 分组依据 + * @param 实体类型 + * @param 实体中的分组依据对应类型，也是Map中key的类型 + * @return {@link Collector} + */ + public static Collector>> + groupingBy(Function classifier) { + return groupingBy(classifier, Collectors.toList()); + } + + /** + * 对null友好的 toMap 操作的 {@link Collector}实现，默认使用HashMap + * + * @param keyMapper 指定map中的key + * @param valueMapper 指定map中的value + * @param mergeFunction 合并前对value进行的操作 + * @param 实体类型 + * @param map中key的类型 + * @param map中value的类型 + * @return 对null友好的 toMap 操作的 {@link Collector}实现 + */ + public static + Collector> toMap(Function keyMapper, + Function valueMapper, + BinaryOperator mergeFunction) { + return toMap(keyMapper, valueMapper, mergeFunction, HashMap::new); + } + + /** + * 对null友好的 toMap 操作的 {@link Collector}实现 + * + * @param keyMapper 指定map中的key + * @param valueMapper 指定map中的value + * @param mergeFunction 合并前对value进行的操作 + * @param mapSupplier 最终需要的map类型 + * @param 实体类型 + * @param map中key的类型 + * @param map中value的类型 + * @param map的类型 + * @return 对null友好的 toMap 操作的 {@link Collector}实现 + */ + public static > + Collector toMap(Function keyMapper, + Function valueMapper, + BinaryOperator mergeFunction, + Supplier mapSupplier) { + BiConsumer accumulator + = (map, element) -> map.put(Opt.ofNullable(element).map(keyMapper).get(), Opt.ofNullable(element).map(valueMapper).get()); + return new SimpleCollector<>(mapSupplier, accumulator, mapMerger(mergeFunction), CH_ID); + } + + /** + * 用户合并map的BinaryOperator，传入合并前需要对value进行的操作 + * + * @param mergeFunction 合并前需要对value进行的操作 + * @param key的类型 + * @param value的类型 + * @param map + * @return 用户合并map的BinaryOperator + */ + public static > BinaryOperator mapMerger(BinaryOperator mergeFunction) { + return (m1, m2) -> { + for (Map.Entry e : m2.entrySet()) { + m1.merge(e.getKey(), e.getValue(), mergeFunction); + } + return m1; + }; + } + + /** + * 聚合这种数据类型:{@code Collection> => Map>} + * 其中key相同的value，会累加到List中 + * + * @param key的类型 + * @param value的类型 + * @return 聚合后的map + * @since 5.8.5 + */ + public static Collector, ?, Map>> reduceListMap() { + return reduceListMap(HashMap::new); + } + + /** + * 聚合这种数据类型:{@code Collection> => Map>} + * 其中key相同的value，会累加到List中 + * + * @param mapSupplier 可自定义map的类型如concurrentHashMap等 + * @param key的类型 + * @param value的类型 + * @param 返回值的类型 + * @return 聚合后的map + * @since 5.8.5 + */ + public static >> Collector, ?, R> reduceListMap(final Supplier mapSupplier) { + return Collectors.reducing(mapSupplier.get(), value -> { + final R result = mapSupplier.get(); + value.forEach((k, v) -> result.computeIfAbsent(k, i -> new ArrayList<>()).add(v)); + return result; + }, (l, r) -> { + r.forEach((k, v) -> l.computeIfAbsent(k, i -> new ArrayList<>()).addAll(v)); + return l; + } + ); + } + + /** + * 提供对null值友好的groupingBy操作的{@link Collector}实现， + * 对集合分组，然后对分组后的值集合进行映射 + * + * @param classifier 分组依据 + * @param valueMapper 值映射方法 + * @param valueCollFactory 值集合的工厂方法 + * @param mapFactory Map集合的工厂方法 + * @param 元素类型 + * @param 键类型 + * @param 值类型 + * @param 值集合类型 + * @param 返回的Map集合类型 + * @return {@link Collector} + */ + public static , M extends Map> Collector groupingBy( + final Function classifier, + final Function valueMapper, + final Supplier valueCollFactory, + final Supplier mapFactory) { + return groupingBy(classifier, mapFactory, Collectors.mapping( + valueMapper, Collectors.toCollection(valueCollFactory) + )); + } + + /** + * 提供对null值友好的groupingBy操作的{@link Collector}实现， + * 对集合分组，然后对分组后的值集合进行映射 + * + * @param classifier 分组依据 + * @param valueMapper 值映射方法 + * @param valueCollFactory 值集合的工厂方法 + * @param 元素类型 + * @param 键类型 + * @param 值类型 + * @param 值集合类型 + * @return {@link Collector} + */ + public static > Collector> groupingBy( + final Function classifier, + final Function valueMapper, + final Supplier valueCollFactory) { + return groupingBy(classifier, valueMapper, valueCollFactory, HashMap::new); + } + + /** + * 提供对null值友好的groupingBy操作的{@link Collector}实现， + * 对集合分组，然后对分组后的值集合进行映射 + * + * @param classifier 分组依据 + * @param valueMapper 值映射方法 + * @param 元素类型 + * @param 键类型 + * @param 值类型 + * @return {@link Collector} + */ + public static Collector>> groupingBy( + final Function classifier, + final Function valueMapper) { + return groupingBy(classifier, valueMapper, ArrayList::new, HashMap::new); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/stream/SimpleCollector.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/stream/SimpleCollector.java new file mode 100644 index 0000000..d5b97eb --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/stream/SimpleCollector.java @@ -0,0 +1,109 @@ +package aiyh.utils.tool.cn.hutool.core.stream; + +import java.util.Set; +import java.util.function.BiConsumer; +import java.util.function.BinaryOperator; +import java.util.function.Function; +import java.util.function.Supplier; +import java.util.stream.Collector; + +/** + * 简单{@link Collector}接口实现 + * + * @param 输入数据类型 + * @param 累积结果的容器类型 + * @param 数据结果类型 + * @since 5.6.7 + */ +public class SimpleCollector implements Collector { + /** + * 创建新的结果容器，容器类型为A + */ + private final Supplier supplier; + /** + * 将输入元素合并到结果容器中 + */ + private final BiConsumer accumulator; + /** + * 合并两个结果容器（并行流使用，将多个线程产生的结果容器合并） + */ + private final BinaryOperator combiner; + /** + * 将结果容器转换成最终的表示 + */ + private final Function finisher; + /** + * 特征值枚举，见{@link Characteristics} + *
    + *
  • CONCURRENT： 表示结果容器只有一个（即使是在并行流的情况下）。 + * 只有在并行流且收集器不具备此特性的情况下，combiner()返回的lambda表达式才会执行（中间结果容器只有一个就无需合并）。 + * 设置此特性时意味着多个线程可以对同一个结果容器调用，因此结果容器必须是线程安全的。
    • + *
  • UNORDERED： 表示流中的元素无序
    • + *
  • IDENTITY_FINISH：表示中间结果容器类型与最终结果类型一致。设置此特性时finisher()方法不会被调用
    • + *
+ */ + private final Set characteristics; + + /** + * 构造 + * + * @param supplier 创建新的结果容器函数 + * @param accumulator 将输入元素合并到结果容器中函数 + * @param combiner 合并两个结果容器函数（并行流使用，将多个线程产生的结果容器合并） + * @param finisher 将结果容器转换成最终的表示函数 + * @param characteristics 特征值枚举 + */ + public SimpleCollector(Supplier supplier, + BiConsumer accumulator, + BinaryOperator combiner, + Function finisher, + Set characteristics) { + this.supplier = supplier; + this.accumulator = accumulator; + this.combiner = combiner; + this.finisher = finisher; + this.characteristics = characteristics; + } + + /** + * 构造 + * + * @param supplier 创建新的结果容器函数 + * @param accumulator 将输入元素合并到结果容器中函数 + * @param combiner 合并两个结果容器函数（并行流使用，将多个线程产生的结果容器合并） + * @param characteristics 特征值枚举 + */ + @SuppressWarnings("unchecked") + public SimpleCollector(Supplier supplier, + BiConsumer accumulator, + BinaryOperator combiner, + Set characteristics) { + this(supplier, accumulator, combiner, i -> (R) i, characteristics); + } + + @Override + public BiConsumer accumulator() { + return accumulator; + } + + @Override + public Supplier supplier() { + return supplier; + } + + @Override + public BinaryOperator combiner() { + return combiner; + } + + @Override + public Function finisher() { + return finisher; + } + + @Override + public Set characteristics() { + return characteristics; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/stream/StreamUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/stream/StreamUtil.java new file mode 100644 index 0000000..1c8db5f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/stream/StreamUtil.java @@ -0,0 +1,170 @@ +package aiyh.utils.tool.cn.hutool.core.stream; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; + +import java.io.File; +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Collection; +import java.util.Iterator; +import java.util.Spliterators; +import java.util.function.Function; +import java.util.function.UnaryOperator; +import java.util.stream.Stream; +import java.util.stream.StreamSupport; + +/** + * {@link Stream} 工具类 + * + * @author looly + * @since 5.6.7 + */ +public class StreamUtil { + + @SafeVarargs + public static Stream of(T... array) { + Assert.notNull(array, "Array must be not null!"); + return Stream.of(array); + } + + /** + * {@link Iterable}转换为{@link Stream}，默认非并行 + * + * @param iterable 集合 + * @param 集合元素类型 + * @return {@link Stream} + */ + public static Stream of(Iterable iterable) { + return of(iterable, false); + } + + /** + * {@link Iterable}转换为{@link Stream} + * + * @param iterable 集合 + * @param parallel 是否并行 + * @param 集合元素类型 + * @return {@link Stream} + */ + public static Stream of(Iterable iterable, boolean parallel) { + Assert.notNull(iterable, "Iterable must be not null!"); + + return iterable instanceof Collection ? + parallel ? ((Collection) iterable).parallelStream() : ((Collection) iterable).stream() : + StreamSupport.stream(iterable.spliterator(), parallel); + } + + /** + * {@link Iterator} 转换为 {@link Stream} + * @param iterator 迭代器 + * @param 集合元素类型 + * @return {@link Stream} + * @throws IllegalArgumentException 如果iterator为null，抛出该异常 + */ + public static Stream of(Iterator iterator) { + return of(iterator, false); + } + + /** + * {@link Iterator} 转换为 {@link Stream} + * @param iterator 迭代器 + * @param parallel 是否并行 + * @param 集合元素类型 + * @return {@link Stream} + * @throws IllegalArgumentException 如果iterator为null，抛出该异常 + */ + public static Stream of(Iterator iterator, boolean parallel) { + Assert.notNull(iterator, "iterator must not be null!"); + return StreamSupport.stream(Spliterators.spliteratorUnknownSize(iterator, 0), parallel); + } + + /** + * 按行读取文件为{@link Stream} + * + * @param file 文件 + * @return {@link Stream} + */ + public static Stream of(File file) { + return of(file, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 按行读取文件为{@link Stream} + * + * @param path 路径 + * @return {@link Stream} + */ + public static Stream of(Path path) { + return of(path, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 按行读取文件为{@link Stream} + * + * @param file 文件 + * @param charset 编码 + * @return {@link Stream} + */ + public static Stream of(File file, Charset charset) { + Assert.notNull(file, "File must be not null!"); + return of(file.toPath(), charset); + } + + /** + * 按行读取文件为{@link Stream} + * + * @param path 路径 + * @param charset 编码 + * @return {@link Stream} + */ + public static Stream of(Path path, Charset charset) { + try { + return Files.lines(path, charset); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 通过函数创建Stream + * + * @param seed 初始值 + * @param elementCreator 递进函数，每次调用此函数获取下一个值 + * @param limit 限制个数 + * @param 创建元素类型 + * @return {@link Stream} + */ + public static Stream of(T seed, UnaryOperator elementCreator, int limit) { + return Stream.iterate(seed, elementCreator).limit(limit); + } + + /** + * 将Stream中所有元素以指定分隔符，合并为一个字符串，对象默认调用toString方法 + * + * @param stream {@link Stream} + * @param delimiter 分隔符 + * @param 元素类型 + * @return 字符串 + */ + public static String join(Stream stream, CharSequence delimiter) { + return stream.collect(CollectorUtil.joining(delimiter)); + } + + /** + * 将Stream中所有元素以指定分隔符，合并为一个字符串 + * + * @param stream {@link Stream} + * @param delimiter 分隔符 + * @param toStringFunc 元素转换为字符串的函数 + * @param 元素类型 + * @return 字符串 + */ + public static String join(Stream stream, CharSequence delimiter, + Function toStringFunc) { + return stream.collect(CollectorUtil.joining(delimiter, toStringFunc)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/stream/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/stream/package-info.java new file mode 100644 index 0000000..e86063e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/stream/package-info.java @@ -0,0 +1,7 @@ +/** + * Java8的stream相关封装 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.stream; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/DesktopUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/DesktopUtil.java new file mode 100755 index 0000000..fdbfdb9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/DesktopUtil.java @@ -0,0 +1,108 @@ +package aiyh.utils.tool.cn.hutool.core.swing; + +import java.awt.Desktop; +import java.io.File; +import java.io.IOException; +import java.net.URI; + +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.util.URLUtil; + +/** + * 桌面相关工具（平台相关）
+ * Desktop 类允许 Java 应用程序启动已在本机桌面上注册的关联应用程序，以处理 URI 或文件。 + * + * @author looly + * @since 4.5.7 + */ +public class DesktopUtil { + + /** + * 获得{@link Desktop} + * + * @return {@link Desktop} + */ + public static Desktop getDsktop() { + return Desktop.getDesktop(); + } + + /** + * 使用平台默认浏览器打开指定URL地址 + * + * @param url URL地址 + */ + public static void browse(String url) { + browse(URLUtil.toURI(url)); + } + + /** + * 使用平台默认浏览器打开指定URI地址 + * + * @param uri URI地址 + * @since 4.6.3 + */ + public static void browse(URI uri) { + final Desktop dsktop = getDsktop(); + try { + dsktop.browse(uri); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 启动关联应用程序来打开文件 + * + * @param file URL地址 + */ + public static void open(File file) { + final Desktop dsktop = getDsktop(); + try { + dsktop.open(file); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 启动关联编辑器应用程序并打开用于编辑的文件 + * + * @param file 文件 + */ + public static void edit(File file) { + final Desktop dsktop = getDsktop(); + try { + dsktop.edit(file); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 使用关联应用程序的打印命令, 用本机桌面打印设备来打印文件 + * + * @param file 文件 + */ + public static void print(File file) { + final Desktop dsktop = getDsktop(); + try { + dsktop.print(file); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 使用平台默认浏览器打开指定URL地址 + * + * @param mailAddress 邮件地址 + */ + public static void mail(String mailAddress) { + final Desktop dsktop = getDsktop(); + try { + dsktop.mail(URLUtil.toURI(mailAddress)); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/RobotUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/RobotUtil.java new file mode 100755 index 0000000..41f2823 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/RobotUtil.java @@ -0,0 +1,226 @@ +package aiyh.utils.tool.cn.hutool.core.swing; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.img.ImgUtil; +import aiyh.utils.tool.cn.hutool.core.swing.clipboard.ClipboardUtil; + +import java.awt.AWTException; +import java.awt.Rectangle; +import java.awt.Robot; +import java.awt.event.InputEvent; +import java.awt.event.KeyEvent; +import java.awt.image.BufferedImage; +import java.io.File; + +/** + * {@link Robot} 封装工具类，提供截屏等工具 + * + * @author looly + * @since 4.1.14 + */ +public class RobotUtil { + + private static final Robot ROBOT; + private static int delay; + + static { + try { + ROBOT = new Robot(); + } catch (AWTException e) { + throw new UtilException(e); + } + } + + /** + * 获取 Robot 单例实例 + * + * @return {@link Robot}单例对象 + * @since 5.7.6 + */ + public static Robot getRobot() { + return ROBOT; + } + + /** + * 设置默认的延迟时间
+ * 当按键执行完后的等待时间，也可以用ThreadUtil.sleep方法代替 + * + * @param delayMillis 等待毫秒数 + * @since 4.5.7 + */ + public static void setDelay(int delayMillis) { + delay = delayMillis; + } + + /** + * 获取全局默认的延迟时间 + * + * @return 全局默认的延迟时间 + * @since 5.7.6 + */ + public static int getDelay() { + return delay; + } + + /** + * 模拟鼠标移动 + * + * @param x 移动到的x坐标 + * @param y 移动到的y坐标 + * @since 4.5.7 + */ + public static void mouseMove(int x, int y) { + ROBOT.mouseMove(x, y); + } + + /** + * 模拟单击
+ * 鼠标单击包括鼠标左键的按下和释放 + * + * @since 4.5.7 + */ + public static void click() { + ROBOT.mousePress(InputEvent.BUTTON1_MASK); + ROBOT.mouseRelease(InputEvent.BUTTON1_MASK); + delay(); + } + + /** + * 模拟右键单击
+ * 鼠标单击包括鼠标右键的按下和释放 + * + * @since 4.5.7 + */ + public static void rightClick() { + ROBOT.mousePress(InputEvent.BUTTON3_MASK); + ROBOT.mouseRelease(InputEvent.BUTTON3_MASK); + delay(); + } + + /** + * 模拟鼠标滚轮滚动 + * + * @param wheelAmt 滚动数，负数表示向前滚动，正数向后滚动 + * @since 4.5.7 + */ + public static void mouseWheel(int wheelAmt) { + ROBOT.mouseWheel(wheelAmt); + delay(); + } + + /** + * 模拟键盘点击
+ * 包括键盘的按下和释放 + * + * @param keyCodes 按键码列表，见{@link java.awt.event.KeyEvent} + * @since 4.5.7 + */ + public static void keyClick(int... keyCodes) { + for (int keyCode : keyCodes) { + ROBOT.keyPress(keyCode); + ROBOT.keyRelease(keyCode); + } + delay(); + } + + /** + * 打印输出指定字符串（借助剪贴板） + * + * @param str 字符串 + */ + public static void keyPressString(String str) { + ClipboardUtil.setStr(str); + keyPressWithCtrl(KeyEvent.VK_V);// 粘贴 + delay(); + } + + /** + * shift+ 按键 + * + * @param key 按键 + */ + public static void keyPressWithShift(int key) { + ROBOT.keyPress(KeyEvent.VK_SHIFT); + ROBOT.keyPress(key); + ROBOT.keyRelease(key); + ROBOT.keyRelease(KeyEvent.VK_SHIFT); + delay(); + } + + /** + * ctrl+ 按键 + * + * @param key 按键 + */ + public static void keyPressWithCtrl(int key) { + ROBOT.keyPress(KeyEvent.VK_CONTROL); + ROBOT.keyPress(key); + ROBOT.keyRelease(key); + ROBOT.keyRelease(KeyEvent.VK_CONTROL); + delay(); + } + + /** + * alt+ 按键 + * + * @param key 按键 + */ + public static void keyPressWithAlt(int key) { + ROBOT.keyPress(KeyEvent.VK_ALT); + ROBOT.keyPress(key); + ROBOT.keyRelease(key); + ROBOT.keyRelease(KeyEvent.VK_ALT); + delay(); + } + + /** + * 截取全屏 + * + * @return 截屏的图片 + */ + public static BufferedImage captureScreen() { + return captureScreen(ScreenUtil.getRectangle()); + } + + /** + * 截取全屏到文件 + * + * @param outFile 写出到的文件 + * @return 写出到的文件 + */ + public static File captureScreen(File outFile) { + ImgUtil.write(captureScreen(), outFile); + return outFile; + } + + /** + * 截屏 + * + * @param screenRect 截屏的矩形区域 + * @return 截屏的图片 + */ + public static BufferedImage captureScreen(Rectangle screenRect) { + return ROBOT.createScreenCapture(screenRect); + } + + /** + * 截屏 + * + * @param screenRect 截屏的矩形区域 + * @param outFile 写出到的文件 + * @return 写出到的文件 + */ + public static File captureScreen(Rectangle screenRect, File outFile) { + ImgUtil.write(captureScreen(screenRect), outFile); + return outFile; + } + + /** + * 等待指定毫秒数 + */ + public static void delay() { + if (delay > 0) { + ROBOT.delay(delay); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/ScreenUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/ScreenUtil.java new file mode 100755 index 0000000..2b07d57 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/ScreenUtil.java @@ -0,0 +1,88 @@ +package aiyh.utils.tool.cn.hutool.core.swing; + +import java.awt.Dimension; +import java.awt.Rectangle; +import java.awt.Toolkit; +import java.awt.image.BufferedImage; +import java.io.File; + +/** + * 屏幕相关（当前显示设置）工具类 + * + * @author looly + * @since 4.1.14 + */ +public class ScreenUtil { + public static Dimension dimension = Toolkit.getDefaultToolkit().getScreenSize(); + + /** + * 获取屏幕宽度 + * + * @return 屏幕宽度 + */ + public static int getWidth() { + return (int) dimension.getWidth(); + } + + /** + * 获取屏幕高度 + * + * @return 屏幕高度 + */ + public static int getHeight() { + return (int) dimension.getHeight(); + } + + /** + * 获取屏幕的矩形 + * @return 屏幕的矩形 + */ + public static Rectangle getRectangle() { + return new Rectangle(getWidth(), getHeight()); + } + + //-------------------------------------------------------------------------------------------- 截屏 + /** + * 截取全屏 + * + * @return 截屏的图片 + * @see RobotUtil#captureScreen() + */ + public static BufferedImage captureScreen() { + return RobotUtil.captureScreen(); + } + + /** + * 截取全屏到文件 + * + * @param outFile 写出到的文件 + * @return 写出到的文件 + * @see RobotUtil#captureScreen(File) + */ + public static File captureScreen(File outFile) { + return RobotUtil.captureScreen(outFile); + } + + /** + * 截屏 + * + * @param screenRect 截屏的矩形区域 + * @return 截屏的图片 + * @see RobotUtil#captureScreen(Rectangle) + */ + public static BufferedImage captureScreen(Rectangle screenRect) { + return RobotUtil.captureScreen(screenRect); + } + + /** + * 截屏 + * + * @param screenRect 截屏的矩形区域 + * @param outFile 写出到的文件 + * @return 写出到的文件 + * @see RobotUtil#captureScreen(Rectangle, File) + */ + public static File captureScreen(Rectangle screenRect, File outFile) { + return RobotUtil.captureScreen(screenRect, outFile); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/ClipboardListener.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/ClipboardListener.java new file mode 100755 index 0000000..98f9695 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/ClipboardListener.java @@ -0,0 +1,23 @@ +package aiyh.utils.tool.cn.hutool.core.swing.clipboard; + +import java.awt.datatransfer.Clipboard; +import java.awt.datatransfer.Transferable; + +/** + * 剪贴板监听事件处理接口
+ * 用户通过实现此接口，实现监听剪贴板内容变化 + * + * @author looly + *@since 4.5.6 + */ +public interface ClipboardListener { + /** + * 剪贴板变动触发的事件方法
+ * 在此事件中对剪贴板设置值无效，如若修改，需返回修改内容 + * + * @param clipboard 剪贴板对象 + * @param contents 内容 + * @return 如果对剪贴板内容做修改，则返回修改的内容，{@code null}表示保留原内容 + */ + Transferable onChange(Clipboard clipboard, Transferable contents); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/ClipboardMonitor.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/ClipboardMonitor.java new file mode 100755 index 0000000..1cb5e42 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/ClipboardMonitor.java @@ -0,0 +1,208 @@ +package aiyh.utils.tool.cn.hutool.core.swing.clipboard; + +import aiyh.utils.tool.cn.hutool.core.thread.ThreadUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.awt.datatransfer.Clipboard; +import java.awt.datatransfer.ClipboardOwner; +import java.awt.datatransfer.Transferable; +import java.io.Closeable; +import java.util.LinkedHashSet; +import java.util.Set; + +/** + * 剪贴板监听 + * + * @author looly + * @since 4.5.6 + */ +public enum ClipboardMonitor implements ClipboardOwner, Runnable, Closeable { + INSTANCE; + + /** 默认重试此时：10 */ + public static final int DEFAULT_TRY_COUNT = 10; + /** 默认重试等待：100 */ + public static final long DEFAULT_DELAY = 100; + + /** 重试次数 */ + private int tryCount; + /** 重试等待 */ + private long delay; + /** 系统剪贴板对象 */ + private final Clipboard clipboard; + /** 监听事件处理 */ + private final Set listenerSet = new LinkedHashSet<>(); + /** 是否正在监听 */ + private boolean isRunning; + + // ---------------------------------------------------------------------------------------------------------- Constructor start + /** + * 构造，尝试获取剪贴板内容的次数为10，第二次之后延迟100毫秒 + */ + ClipboardMonitor() { + this(DEFAULT_TRY_COUNT, DEFAULT_DELAY); + } + + /** + * 构造 + * + * @param tryCount 尝试获取剪贴板内容的次数 + * @param delay 响应延迟，当从第二次开始，延迟一定毫秒数等待剪贴板可以获取，当tryCount小于2时无效 + */ + ClipboardMonitor(int tryCount, long delay) { + this(tryCount, delay, ClipboardUtil.getClipboard()); + } + + /** + * 构造 + * + * @param tryCount 尝试获取剪贴板内容的次数 + * @param delay 响应延迟，当从第二次开始，延迟一定毫秒数等待剪贴板可以获取，当tryCount小于2时无效 + * @param clipboard 剪贴板对象 + */ + ClipboardMonitor(int tryCount, long delay, Clipboard clipboard) { + this.tryCount = tryCount; + this.delay = delay; + this.clipboard = clipboard; + } + // ---------------------------------------------------------------------------------------------------------- Constructor end + + /** + * 设置重试次数 + * + * @param tryCount 重试次数 + * @return this + */ + public ClipboardMonitor setTryCount(int tryCount) { + this.tryCount = tryCount; + return this; + } + + /** + * 设置重试等待 + * + * @param delay 重试等待 + * @return this + */ + public ClipboardMonitor setDelay(long delay) { + this.delay = delay; + return this; + } + + /** + * 设置 监听事件处理 + * + * @param listener 监听事件处理 + * @return this + */ + public ClipboardMonitor addListener(ClipboardListener listener) { + this.listenerSet.add(listener); + return this; + } + + /** + * 去除指定监听 + * + * @param listener 监听 + * @return this + */ + public ClipboardMonitor removeListener(ClipboardListener listener) { + this.listenerSet.remove(listener); + return this; + } + + /** + * 清空监听 + * + * @return this + */ + public ClipboardMonitor clearListener() { + this.listenerSet.clear(); + return this; + } + + @Override + public void lostOwnership(Clipboard clipboard, Transferable contents) { + Transferable newContents; + try { + newContents = tryGetContent(clipboard); + } catch (InterruptedException e) { + // 中断后结束简体 + return; + } + + Transferable transferable = null; + for (ClipboardListener listener : listenerSet) { + try { + transferable = listener.onChange(clipboard, ObjectUtil.defaultIfNull(transferable, newContents)); + } catch (Throwable e) { + // 忽略事件处理异常，保证所有监听正常执行 + } + } + + if (isRunning) { + // 继续监听 + clipboard.setContents(ObjectUtil.defaultIfNull(transferable, ObjectUtil.defaultIfNull(newContents, contents)), this); + } + } + + @Override + public synchronized void run() { + if(false == isRunning) { + final Clipboard clipboard = this.clipboard; + clipboard.setContents(clipboard.getContents(null), this); + isRunning = true; + } + } + + /** + * 开始监听 + * + * @param sync 是否阻塞 + */ + public void listen(boolean sync) { + run(); + + if (sync) { + ThreadUtil.sync(this); + } + } + + /** + * 关闭（停止）监听 + */ + @Override + public void close() { + this.isRunning = false; + } + + // ------------------------------------------------------------------------------------------------------------------------- Private method start + /** + * 尝试获取剪贴板内容 + * + * @param clipboard 剪贴板 + * @return 剪贴板内容，{@code null} 表示未获取到 + * @throws InterruptedException 线程中断 + */ + private Transferable tryGetContent(Clipboard clipboard) throws InterruptedException { + Transferable newContents = null; + for (int i = 0; i < this.tryCount; i++) { + if (this.delay > 0 && i > 0) { + // 第一次获取不等待，只有从第二次获取时才开始等待 + //noinspection BusyWait + Thread.sleep(this.delay); + } + + try { + newContents = clipboard.getContents(null); + } catch (IllegalStateException e) { + // ignore + } + if (null != newContents) { + return newContents; + } + } + return null; + } + // ------------------------------------------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/ClipboardUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/ClipboardUtil.java new file mode 100755 index 0000000..8d5eb27 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/ClipboardUtil.java @@ -0,0 +1,177 @@ +package aiyh.utils.tool.cn.hutool.core.swing.clipboard; + +import java.awt.Image; +import java.awt.Toolkit; +import java.awt.datatransfer.Clipboard; +import java.awt.datatransfer.ClipboardOwner; +import java.awt.datatransfer.DataFlavor; +import java.awt.datatransfer.StringSelection; +import java.awt.datatransfer.Transferable; +import java.awt.datatransfer.UnsupportedFlavorException; +import java.io.IOException; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; + +/** + * 系统剪贴板工具类 + * + * @author looly + * @since 3.2.0 + */ +public class ClipboardUtil { + + /** + * 获取系统剪贴板 + * + * @return {@link Clipboard} + */ + public static Clipboard getClipboard() { + return Toolkit.getDefaultToolkit().getSystemClipboard(); + } + + /** + * 设置内容到剪贴板 + * + * @param contents 内容 + */ + public static void set(Transferable contents) { + set(contents, null); + } + + /** + * 设置内容到剪贴板 + * + * @param contents 内容 + * @param owner 所有者 + */ + public static void set(Transferable contents, ClipboardOwner owner) { + getClipboard().setContents(contents, owner); + } + + /** + * 获取剪贴板内容 + * + * @param flavor 数据元信息，标识数据类型 + * @return 剪贴板内容，类型根据flavor不同而不同 + */ + public static Object get(DataFlavor flavor) { + return get(getClipboard().getContents(null), flavor); + } + + /** + * 获取剪贴板内容 + * + * @param content {@link Transferable} + * @param flavor 数据元信息，标识数据类型 + * @return 剪贴板内容，类型根据flavor不同而不同 + */ + public static Object get(Transferable content, DataFlavor flavor) { + if (null != content && content.isDataFlavorSupported(flavor)) { + try { + return content.getTransferData(flavor); + } catch (UnsupportedFlavorException | IOException e) { + throw new UtilException(e); + } + } + return null; + } + + /** + * 设置字符串文本到剪贴板 + * + * @param text 字符串文本 + */ + public static void setStr(String text) { + set(new StringSelection(text)); + } + + /** + * 从剪贴板获取文本 + * + * @return 文本 + */ + public static String getStr() { + return (String) get(DataFlavor.stringFlavor); + } + + /** + * 从剪贴板的{@link Transferable}获取文本 + * + * @param content {@link Transferable} + * @return 文本 + * @since 4.5.6 + */ + public static String getStr(Transferable content) { + return (String) get(content, DataFlavor.stringFlavor); + } + + /** + * 设置图片到剪贴板 + * + * @param image 图像 + */ + public static void setImage(Image image) { + set(new ImageSelection(image), null); + } + + /** + * 从剪贴板获取图片 + * + * @return 图片{@link Image} + */ + public static Image getImage() { + return (Image) get(DataFlavor.imageFlavor); + } + + /** + * 从剪贴板的{@link Transferable}获取图片 + * + * @param content {@link Transferable} + * @return 图片 + * @since 4.5.6 + */ + public static Image getImage(Transferable content) { + return (Image) get(content, DataFlavor.imageFlavor); + } + + /** + * 监听剪贴板修改事件 + * + * @param listener 监听处理接口 + * @since 4.5.6 + * @see ClipboardMonitor#listen(boolean) + */ + public static void listen(ClipboardListener listener) { + listen(listener, true); + } + + /** + * 监听剪贴板修改事件 + * + * @param listener 监听处理接口 + * @param sync 是否同步阻塞 + * @since 4.5.6 + * @see ClipboardMonitor#listen(boolean) + */ + public static void listen(ClipboardListener listener, boolean sync) { + listen(ClipboardMonitor.DEFAULT_TRY_COUNT, ClipboardMonitor.DEFAULT_DELAY, listener, sync); + } + + /** + * 监听剪贴板修改事件 + * + * @param tryCount 尝试获取剪贴板内容的次数 + * @param delay 响应延迟，当从第二次开始，延迟一定毫秒数等待剪贴板可以获取 + * @param listener 监听处理接口 + * @param sync 是否同步阻塞 + * @since 4.5.6 + * @see ClipboardMonitor#listen(boolean) + */ + public static void listen(int tryCount, long delay, ClipboardListener listener, boolean sync) { + ClipboardMonitor.INSTANCE// + .setTryCount(tryCount)// + .setDelay(delay)// + .addListener(listener)// + .listen(sync); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/ImageSelection.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/ImageSelection.java new file mode 100755 index 0000000..72024bd --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/ImageSelection.java @@ -0,0 +1,64 @@ +package aiyh.utils.tool.cn.hutool.core.swing.clipboard; + +import java.awt.Image; +import java.awt.datatransfer.DataFlavor; +import java.awt.datatransfer.Transferable; +import java.awt.datatransfer.UnsupportedFlavorException; +import java.io.Serializable; + +/** + * 图片转换器，用于将图片对象转换为剪贴板支持的对象
+ * 此对象也用于将图像文件和{@link DataFlavor#imageFlavor} 元信息对应 + * + * @author looly + * @since 4.5.6 + */ +public class ImageSelection implements Transferable, Serializable { + private static final long serialVersionUID = 1L; + + private final Image image; + + /** + * 构造 + * + * @param image 图片 + */ + public ImageSelection(Image image) { + this.image = image; + } + + /** + * 获取元数据类型信息 + * + * @return 元数据类型列表 + */ + @Override + public DataFlavor[] getTransferDataFlavors() { + return new DataFlavor[] { DataFlavor.imageFlavor }; + } + + /** + * 是否支持指定元数据类型 + * + * @param flavor 元数据类型 + * @return 是否支持 + */ + @Override + public boolean isDataFlavorSupported(DataFlavor flavor) { + return DataFlavor.imageFlavor.equals(flavor); + } + + /** + * 获取图片 + * + * @param flavor 元数据类型 + * @return 转换后的对象 + */ + @Override + public Object getTransferData(DataFlavor flavor) throws UnsupportedFlavorException { + if (false == DataFlavor.imageFlavor.equals(flavor)) { + throw new UnsupportedFlavorException(flavor); + } + return image; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/StrClipboardListener.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/StrClipboardListener.java new file mode 100755 index 0000000..7fe37b9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/StrClipboardListener.java @@ -0,0 +1,34 @@ +package aiyh.utils.tool.cn.hutool.core.swing.clipboard; + +import java.awt.datatransfer.Clipboard; +import java.awt.datatransfer.DataFlavor; +import java.awt.datatransfer.Transferable; +import java.io.Serializable; + +/** + * 剪贴板字符串内容监听 + * + * @author looly + * @since 4.5.7 + */ +public abstract class StrClipboardListener implements ClipboardListener, Serializable { + private static final long serialVersionUID = 1L; + + @Override + public Transferable onChange(Clipboard clipboard, Transferable contents) { + if (contents.isDataFlavorSupported(DataFlavor.stringFlavor)) { + return onChange(clipboard, ClipboardUtil.getStr(contents)); + } + return null; + } + + /** + * 剪贴板变动触发的事件方法
+ * 在此事件中对剪贴板设置值无效，如若修改，需返回修改内容 + * + * @param clipboard 剪贴板对象 + * @param contents 内容 + * @return 如果对剪贴板内容做修改，则返回修改的内容，{@code null}表示保留原内容 + */ + public abstract Transferable onChange(Clipboard clipboard, String contents); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/package-info.java new file mode 100755 index 0000000..11c34d3 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/clipboard/package-info.java @@ -0,0 +1,7 @@ +/** + * 剪贴板相关的工具，包括剪贴板监听等 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.swing.clipboard; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/package-info.java new file mode 100755 index 0000000..5977672 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/swing/package-info.java @@ -0,0 +1,7 @@ +/** + * Swing和awt相关封装 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.swing; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/ASCIIStrCache.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/ASCIIStrCache.java new file mode 100644 index 0000000..233e566 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/ASCIIStrCache.java @@ -0,0 +1,30 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +/** + * ASCII字符对应的字符串缓存 + * + * @author looly + * @since 4.0.1 + * + */ +public class ASCIIStrCache { + + private static final int ASCII_LENGTH = 128; + private static final String[] CACHE = new String[ASCII_LENGTH]; + static { + for (char c = 0; c < ASCII_LENGTH; c++) { + CACHE[c] = String.valueOf(c); + } + } + + /** + * 字符转为字符串
+ * 如果为ASCII字符，使用缓存 + * + * @param c 字符 + * @return 字符串 + */ + public static String toString(char c) { + return c < ASCII_LENGTH ? CACHE[c] : String.valueOf(c); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/AntPathMatcher.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/AntPathMatcher.java new file mode 100755 index 0000000..a0601b1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/AntPathMatcher.java @@ -0,0 +1,945 @@ +package aiyh.utils.tool.cn.hutool.core.text; + + +import aiyh.utils.tool.cn.hutool.core.map.SafeConcurrentHashMap; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.ArrayList; +import java.util.Comparator; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * Ant风格的路径匹配器。
+ * 来自Spring-core和Ant + * + *

匹配URL的规则如下：
+ *

    + *
  • {@code ?} 匹配单个字符
    • + *
  • {@code *} 匹配0个或多个字符
    • + *
  • {@code **} 0个或多个路径中的目录节点
    • + *
  • {@code {hutool:[a-z]+}} 匹配以"hutool"命名的正则 {@code [a-z]+}
    • + *
+ * + *

例子:

+ *
    + *
  • {@code com/t?st.jsp} — 匹配 {@code com/test.jsp} 或 {@code com/tast.jsp} 或 {@code com/txst.jsp}
    • + *
  • {@code com/*.jsp} — 匹配{@code com}目录下全部 {@code .jsp}文件
    • + *
  • {@code com/**/test.jsp} — 匹配{@code com}目录下全部 {@code test.jsp}文件
    • + *
  • {@code cn/hutool/**/*.jsp} — 匹配{@code cn/hutool}路径下全部{@code .jsp} 文件
    • + *
  • {@code org/**/servlet/bla.jsp} — 匹配{@code cn/hutool/servlet/bla.jsp} 或{@code cn/hutool/testing/servlet/bla.jsp} 或 {@code org/servlet/bla.jsp}
    • + *
  • {@code com/{filename:\\w+}.jsp} 匹配 {@code com/test.jsp} 并将 {@code test} 关联到 {@code filename} 变量
    • + *
+ * + *

注意: 表达式和路径必须都为绝对路径或都为相对路径。 + * + * @author Alef Arendsen, Juergen Hoeller, Rob Harrop, Arjen Poutsma, Rossen Stoyanchev, Sam Brannen, Vladislav Kisel + * @since 5.7.22 + */ +public class AntPathMatcher { + + /** + * Default path separator: "/". + */ + public static final String DEFAULT_PATH_SEPARATOR = StrUtil.SLASH; + + private static final int CACHE_TURNOFF_THRESHOLD = 65536; + + private static final Pattern VARIABLE_PATTERN = Pattern.compile("\\{[^/]+?}"); + + private static final char[] WILDCARD_CHARS = {'*', '?', '{'}; + + private String pathSeparator; + + private PathSeparatorPatternCache pathSeparatorPatternCache; + + private boolean caseSensitive = true; + + private boolean trimTokens = false; + + private volatile Boolean cachePatterns; + + private final Map tokenizedPatternCache = new SafeConcurrentHashMap<>(256); + + private final Map stringMatcherCache = new SafeConcurrentHashMap<>(256); + + + /** + * 使用 {@link #DEFAULT_PATH_SEPARATOR} 作为分隔符构造 + */ + public AntPathMatcher() { + this(DEFAULT_PATH_SEPARATOR); + } + + /** + * 使用自定义的分隔符构造 + * + * @param pathSeparator the path separator to use, must not be {@code null}. + * @since 4.1 + */ + public AntPathMatcher(String pathSeparator) { + if (null == pathSeparator) { + pathSeparator = DEFAULT_PATH_SEPARATOR; + } + setPathSeparator(pathSeparator); + } + + + /** + * 设置路径分隔符 + * + * @param pathSeparator 分隔符，{@code null}表示使用默认分隔符{@link #DEFAULT_PATH_SEPARATOR} + * @return this + */ + public AntPathMatcher setPathSeparator(String pathSeparator) { + if (null == pathSeparator) { + pathSeparator = DEFAULT_PATH_SEPARATOR; + } + this.pathSeparator = pathSeparator; + this.pathSeparatorPatternCache = new PathSeparatorPatternCache(this.pathSeparator); + return this; + } + + /** + * 设置是否大小写敏感，默认为{@code true} + * + * @param caseSensitive 是否大小写敏感 + * @return this + */ + public AntPathMatcher setCaseSensitive(boolean caseSensitive) { + this.caseSensitive = caseSensitive; + return this; + } + + /** + * 设置是否去除路径节点两边的空白符，默认为{@code false} + * + * @param trimTokens 是否去除路径节点两边的空白符 + * @return this + */ + public AntPathMatcher setTrimTokens(boolean trimTokens) { + this.trimTokens = trimTokens; + return this; + } + + /** + * Specify whether to cache parsed pattern metadata for patterns passed + * into this matcher's {@link #match} method. A value of {@code true} + * activates an unlimited pattern cache; a value of {@code false} turns + * the pattern cache off completely. + *

Default is for the cache to be on, but with the variant to automatically + * turn it off when encountering too many patterns to cache at runtime + * (the threshold is 65536), assuming that arbitrary permutations of patterns + * are coming in, with little chance for encountering a recurring pattern. + * + * @param cachePatterns 是否缓存表达式 + * @return this + * @see #getStringMatcher(String) + */ + public AntPathMatcher setCachePatterns(boolean cachePatterns) { + this.cachePatterns = cachePatterns; + return this; + } + + /** + * 判断给定路径是否是表达式 + * + * @param path 路径 + * @return 是否为表达式 + */ + public boolean isPattern(String path) { + if (path == null) { + return false; + } + boolean uriVar = false; + final int length = path.length(); + char c; + for (int i = 0; i < length; i++) { + c = path.charAt(i); + // 含有通配符 + if (c == '*' || c == '?') { + return true; + } + if (c == CharPool.DELIM_START) { + uriVar = true; + continue; + } + if (c == CharPool.DELIM_END && uriVar) { + return true; + } + } + return false; + } + + /** + * 给定路径是否匹配表达式 + * + * @param pattern 表达式 + * @param path 路径 + * @return 是否匹配 + */ + public boolean match(String pattern, String path) { + return doMatch(pattern, path, true, null); + } + + /** + * 前置部分匹配 + * + * @param pattern 表达式 + * @param path 路径 + * @return 是否匹配 + */ + public boolean matchStart(String pattern, String path) { + return doMatch(pattern, path, false, null); + } + + /** + * 执行匹配，判断给定的{@code path}是否匹配{@code pattern} + * + * @param pattern 表达式 + * @param path 路径 + * @param fullMatch 是否全匹配。{@code true} 表示全路径匹配，{@code false}表示只匹配开始 + * @param uriTemplateVariables 变量映射 + * @return {@code true} 表示提供的 {@code path} 匹配, {@code false} 表示不匹配 + */ + protected boolean doMatch(String pattern, String path, boolean fullMatch, Map uriTemplateVariables) { + if (path == null || path.startsWith(this.pathSeparator) != pattern.startsWith(this.pathSeparator)) { + return false; + } + + final String[] pattDirs = tokenizePattern(pattern); + if (fullMatch && this.caseSensitive && false == isPotentialMatch(path, pattDirs)) { + return false; + } + + final String[] pathDirs = tokenizePath(path); + int pattIdxStart = 0; + int pattIdxEnd = pattDirs.length - 1; + int pathIdxStart = 0; + int pathIdxEnd = pathDirs.length - 1; + + // Match all elements up to the first ** + while (pattIdxStart <= pattIdxEnd && pathIdxStart <= pathIdxEnd) { + String pattDir = pattDirs[pattIdxStart]; + if ("**".equals(pattDir)) { + break; + } + if (notMatchStrings(pattDir, pathDirs[pathIdxStart], uriTemplateVariables)) { + return false; + } + pattIdxStart++; + pathIdxStart++; + } + + if (pathIdxStart > pathIdxEnd) { + // Path is exhausted, only match if rest of pattern is * or **'s + if (pattIdxStart > pattIdxEnd) { + return (pattern.endsWith(this.pathSeparator) == path.endsWith(this.pathSeparator)); + } + if (false == fullMatch) { + return true; + } + if (pattIdxStart == pattIdxEnd && pattDirs[pattIdxStart].equals("*") && path.endsWith(this.pathSeparator)) { + return true; + } + for (int i = pattIdxStart; i <= pattIdxEnd; i++) { + if (false == pattDirs[i].equals("**")) { + return false; + } + } + return true; + } else if (pattIdxStart > pattIdxEnd) { + // String not exhausted, but pattern is. Failure. + return false; + } else if (false == fullMatch && "**".equals(pattDirs[pattIdxStart])) { + // Path start definitely matches due to "**" part in pattern. + return true; + } + + // up to last '**' + while (pattIdxStart <= pattIdxEnd && pathIdxStart <= pathIdxEnd) { + String pattDir = pattDirs[pattIdxEnd]; + if (pattDir.equals("**")) { + break; + } + if (notMatchStrings(pattDir, pathDirs[pathIdxEnd], uriTemplateVariables)) { + return false; + } + pattIdxEnd--; + pathIdxEnd--; + } + if (pathIdxStart > pathIdxEnd) { + // String is exhausted + for (int i = pattIdxStart; i <= pattIdxEnd; i++) { + if (false == pattDirs[i].equals("**")) { + return false; + } + } + return true; + } + + while (pattIdxStart != pattIdxEnd && pathIdxStart <= pathIdxEnd) { + int patIdxTmp = -1; + for (int i = pattIdxStart + 1; i <= pattIdxEnd; i++) { + if (pattDirs[i].equals("**")) { + patIdxTmp = i; + break; + } + } + if (patIdxTmp == pattIdxStart + 1) { + // '**/**' situation, so skip one + pattIdxStart++; + continue; + } + // Find the pattern between padIdxStart & padIdxTmp in str between + // strIdxStart & strIdxEnd + int patLength = (patIdxTmp - pattIdxStart - 1); + int strLength = (pathIdxEnd - pathIdxStart + 1); + int foundIdx = -1; + + strLoop: + for (int i = 0; i <= strLength - patLength; i++) { + for (int j = 0; j < patLength; j++) { + String subPat = pattDirs[pattIdxStart + j + 1]; + String subStr = pathDirs[pathIdxStart + i + j]; + if (notMatchStrings(subPat, subStr, uriTemplateVariables)) { + continue strLoop; + } + } + foundIdx = pathIdxStart + i; + break; + } + + if (foundIdx == -1) { + return false; + } + + pattIdxStart = patIdxTmp; + pathIdxStart = foundIdx + patLength; + } + + for (int i = pattIdxStart; i <= pattIdxEnd; i++) { + if (false == pattDirs[i].equals("**")) { + return false; + } + } + + return true; + } + + private boolean isPotentialMatch(String path, String[] pattDirs) { + if (!this.trimTokens) { + int pos = 0; + for (String pattDir : pattDirs) { + int skipped = skipSeparator(path, pos, this.pathSeparator); + pos += skipped; + skipped = skipSegment(path, pos, pattDir); + if (skipped < pattDir.length()) { + return (skipped > 0 || (pattDir.length() > 0 && isWildcardChar(pattDir.charAt(0)))); + } + pos += skipped; + } + } + return true; + } + + private int skipSegment(String path, int pos, String prefix) { + int skipped = 0; + for (int i = 0; i < prefix.length(); i++) { + char c = prefix.charAt(i); + if (isWildcardChar(c)) { + return skipped; + } + int currPos = pos + skipped; + if (currPos >= path.length()) { + return 0; + } + if (c == path.charAt(currPos)) { + skipped++; + } + } + return skipped; + } + + private int skipSeparator(String path, int pos, String separator) { + int skipped = 0; + while (path.startsWith(separator, pos + skipped)) { + skipped += separator.length(); + } + return skipped; + } + + private boolean isWildcardChar(char c) { + for (char candidate : WILDCARD_CHARS) { + if (c == candidate) { + return true; + } + } + return false; + } + + /** + * Tokenize the given path pattern into parts, based on this matcher's settings. + *

Performs caching based on {@link #setCachePatterns}, delegating to + * {@link #tokenizePath(String)} for the actual tokenization algorithm. + * + * @param pattern the pattern to tokenize + * @return the tokenized pattern parts + */ + protected String[] tokenizePattern(String pattern) { + String[] tokenized = null; + Boolean cachePatterns = this.cachePatterns; + if (cachePatterns == null || cachePatterns) { + tokenized = this.tokenizedPatternCache.get(pattern); + } + if (tokenized == null) { + tokenized = tokenizePath(pattern); + if (cachePatterns == null && this.tokenizedPatternCache.size() >= CACHE_TURNOFF_THRESHOLD) { + // Try to adapt to the runtime situation that we're encountering: + // There are obviously too many different patterns coming in here... + // So let's turn off the cache since the patterns are unlikely to be reoccurring. + deactivatePatternCache(); + return tokenized; + } + if (cachePatterns == null || cachePatterns) { + this.tokenizedPatternCache.put(pattern, tokenized); + } + } + return tokenized; + } + + private void deactivatePatternCache() { + this.cachePatterns = false; + this.tokenizedPatternCache.clear(); + this.stringMatcherCache.clear(); + } + + /** + * Tokenize the given path into parts, based on this matcher's settings. + * + * @param path the path to tokenize + * @return the tokenized path parts + */ + protected String[] tokenizePath(String path) { + return StrSplitter.splitToArray(path, this.pathSeparator, 0, this.trimTokens, true); + } + + /** + * Test whether or not a string matches against a pattern. + * + * @param pattern the pattern to match against (never {@code null}) + * @param str the String which must be matched against the pattern (never {@code null}) + * @return {@code true} if the string matches against the pattern, or {@code false} otherwise + */ + private boolean notMatchStrings(String pattern, String str, Map uriTemplateVariables) { + return false == getStringMatcher(pattern).matchStrings(str, uriTemplateVariables); + } + + /** + * Build or retrieve an {@link AntPathStringMatcher} for the given pattern. + *

The default implementation checks this AntPathMatcher's internal cache + * (see {@link #setCachePatterns}), creating a new AntPathStringMatcher instance + * if no cached copy is found. + *

When encountering too many patterns to cache at runtime (the threshold is 65536), + * it turns the default cache off, assuming that arbitrary permutations of patterns + * are coming in, with little chance for encountering a recurring pattern. + *

This method may be overridden to implement a custom cache strategy. + * + * @param pattern the pattern to match against (never {@code null}) + * @return a corresponding AntPathStringMatcher (never {@code null}) + * @see #setCachePatterns + */ + protected AntPathStringMatcher getStringMatcher(String pattern) { + AntPathStringMatcher matcher = null; + Boolean cachePatterns = this.cachePatterns; + if (cachePatterns == null || cachePatterns) { + matcher = this.stringMatcherCache.get(pattern); + } + if (matcher == null) { + matcher = new AntPathStringMatcher(pattern, this.caseSensitive); + if (cachePatterns == null && this.stringMatcherCache.size() >= CACHE_TURNOFF_THRESHOLD) { + // Try to adapt to the runtime situation that we're encountering: + // There are obviously too many different patterns coming in here... + // So let's turn off the cache since the patterns are unlikely to be reoccurring. + deactivatePatternCache(); + return matcher; + } + if (cachePatterns == null || cachePatterns) { + this.stringMatcherCache.put(pattern, matcher); + } + } + return matcher; + } + + /** + * Given a pattern and a full path, determine the pattern-mapped part.

For example:

    + *
  • '{@code /docs/cvs/commit.html}' and '{@code /docs/cvs/commit.html} → ''
    • + *
  • '{@code /docs/*}' and '{@code /docs/cvs/commit} → '{@code cvs/commit}'
    • + *
  • '{@code /docs/cvs/*.html}' and '{@code /docs/cvs/commit.html} → '{@code commit.html}'
    • + *
  • '{@code /docs/**}' and '{@code /docs/cvs/commit} → '{@code cvs/commit}'
    • + *
  • '{@code /docs/**\/*.html}' and '{@code /docs/cvs/commit.html} → '{@code cvs/commit.html}'
    • + *
  • '{@code /*.html}' and '{@code /docs/cvs/commit.html} → '{@code docs/cvs/commit.html}'
    • + *
  • '{@code *.html}' and '{@code /docs/cvs/commit.html} → '{@code /docs/cvs/commit.html}'
    • + *
  • '{@code *}' and '{@code /docs/cvs/commit.html} → '{@code /docs/cvs/commit.html}'
+ *

Assumes that {@link #match} returns {@code true} for '{@code pattern}' and '{@code path}', but + * does not enforce this. + * + * @param pattern 表达式 + * @param path 路径 + * @return 表达式匹配到的部分 + */ + public String extractPathWithinPattern(String pattern, String path) { + String[] patternParts = tokenizePath(pattern); + String[] pathParts = tokenizePath(path); + StringBuilder builder = new StringBuilder(); + boolean pathStarted = false; + + for (int segment = 0; segment < patternParts.length; segment++) { + String patternPart = patternParts[segment]; + if (patternPart.indexOf('*') > -1 || patternPart.indexOf('?') > -1) { + for (; segment < pathParts.length; segment++) { + if (pathStarted || (segment == 0 && !pattern.startsWith(this.pathSeparator))) { + builder.append(this.pathSeparator); + } + builder.append(pathParts[segment]); + pathStarted = true; + } + } + } + + return builder.toString(); + } + + public Map extractUriTemplateVariables(String pattern, String path) { + Map variables = new LinkedHashMap<>(); + boolean result = doMatch(pattern, path, true, variables); + if (!result) { + throw new IllegalStateException("Pattern \"" + pattern + "\" is not a match for \"" + path + "\""); + } + return variables; + } + + /** + * Combine two patterns into a new pattern. + *

This implementation simply concatenates the two patterns, unless + * the first pattern contains a file extension match (e.g., {@code *.html}). + * In that case, the second pattern will be merged into the first. Otherwise, + * an {@code IllegalArgumentException} will be thrown. + *

Examples

+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
Pattern 1Pattern 2Result
{@code null}{@code null} 
/hotels{@code null}/hotels
{@code null}/hotels/hotels
/hotels/bookings/hotels/bookings
/hotelsbookings/hotels/bookings
/hotels/*/bookings/hotels/bookings
/hotels/**/bookings/hotels/**/bookings
/hotels{hotel}/hotels/{hotel}
/hotels/*{hotel}/hotels/{hotel}
/hotels/**{hotel}/hotels/**/{hotel}
/*.html/hotels.html/hotels.html
/*.html/hotels/hotels.html
/*.html/*.txt{@code IllegalArgumentException}
+ * + * @param pattern1 the first pattern + * @param pattern2 the second pattern + * @return the combination of the two patterns + * @throws IllegalArgumentException if the two patterns cannot be combined + */ + public String combine(String pattern1, String pattern2) { + if (StrUtil.isEmpty(pattern1) && StrUtil.isEmpty(pattern2)) { + return StrUtil.EMPTY; + } + if (StrUtil.isEmpty(pattern1)) { + return pattern2; + } + if (StrUtil.isEmpty(pattern2)) { + return pattern1; + } + + boolean pattern1ContainsUriVar = (pattern1.indexOf('{') != -1); + if (!pattern1.equals(pattern2) && !pattern1ContainsUriVar && match(pattern1, pattern2)) { + // /* + /hotel -> /hotel ; "/*.*" + "/*.html" -> /*.html + // However /user + /user -> /usr/user ; /{foo} + /bar -> /{foo}/bar + return pattern2; + } + + // /hotels/* + /booking -> /hotels/booking + // /hotels/* + booking -> /hotels/booking + if (pattern1.endsWith(this.pathSeparatorPatternCache.getEndsOnWildCard())) { + return concat(pattern1.substring(0, pattern1.length() - 2), pattern2); + } + + // /hotels/** + /booking -> /hotels/**/booking + // /hotels/** + booking -> /hotels/**/booking + if (pattern1.endsWith(this.pathSeparatorPatternCache.getEndsOnDoubleWildCard())) { + return concat(pattern1, pattern2); + } + + int starDotPos1 = pattern1.indexOf("*."); + if (pattern1ContainsUriVar || starDotPos1 == -1 || this.pathSeparator.equals(".")) { + // simply concatenate the two patterns + return concat(pattern1, pattern2); + } + + String ext1 = pattern1.substring(starDotPos1 + 1); + int dotPos2 = pattern2.indexOf('.'); + String file2 = (dotPos2 == -1 ? pattern2 : pattern2.substring(0, dotPos2)); + String ext2 = (dotPos2 == -1 ? "" : pattern2.substring(dotPos2)); + boolean ext1All = (ext1.equals(".*") || ext1.isEmpty()); + boolean ext2All = (ext2.equals(".*") || ext2.isEmpty()); + if (!ext1All && !ext2All) { + throw new IllegalArgumentException("Cannot combine patterns: " + pattern1 + " vs " + pattern2); + } + String ext = (ext1All ? ext2 : ext1); + return file2 + ext; + } + + private String concat(String path1, String path2) { + boolean path1EndsWithSeparator = path1.endsWith(this.pathSeparator); + boolean path2StartsWithSeparator = path2.startsWith(this.pathSeparator); + + if (path1EndsWithSeparator && path2StartsWithSeparator) { + return path1 + path2.substring(1); + } else if (path1EndsWithSeparator || path2StartsWithSeparator) { + return path1 + path2; + } else { + return path1 + this.pathSeparator + path2; + } + } + + /** + * Given a full path, returns a {@link Comparator} suitable for sorting patterns in order of + * explicitness. + *

This {@code Comparator} will {@linkplain List#sort(Comparator) sort} + * a list so that more specific patterns (without URI templates or wild cards) come before + * generic patterns. So given a list with the following patterns, the returned comparator + * will sort this list so that the order will be as indicated. + *

    + *
  1. {@code /hotels/new}
    2. + *
  2. {@code /hotels/{hotel}}
    3. + *
  3. {@code /hotels/*}
    4. + *
+ *

The full path given as parameter is used to test for exact matches. So when the given path + * is {@code /hotels/2}, the pattern {@code /hotels/2} will be sorted before {@code /hotels/1}. + * + * @param path the full path to use for comparison + * @return a comparator capable of sorting patterns in order of explicitness + */ + public Comparator getPatternComparator(String path) { + return new AntPatternComparator(path); + } + + + /** + * Tests whether or not a string matches against a pattern via a {@link Pattern}. + *

The pattern may contain special characters: '*' means zero or more characters; '?' means one and + * only one character; '{' and '}' indicate a URI template pattern. For example /users/{user}. + */ + protected static class AntPathStringMatcher { + + private static final Pattern GLOB_PATTERN = Pattern.compile("\\?|\\*|\\{((?:\\{[^/]+?}|[^/{}]|\\\\[{}])+?)}"); + + private static final String DEFAULT_VARIABLE_PATTERN = "((?s).*)"; + + private final String rawPattern; + + private final boolean caseSensitive; + + private final boolean exactMatch; + + private final Pattern pattern; + + private final List variableNames = new ArrayList<>(); + + public AntPathStringMatcher(String pattern, boolean caseSensitive) { + this.rawPattern = pattern; + this.caseSensitive = caseSensitive; + StringBuilder patternBuilder = new StringBuilder(); + Matcher matcher = GLOB_PATTERN.matcher(pattern); + int end = 0; + while (matcher.find()) { + patternBuilder.append(quote(pattern, end, matcher.start())); + String match = matcher.group(); + if ("?".equals(match)) { + patternBuilder.append('.'); + } else if ("*".equals(match)) { + patternBuilder.append(".*"); + } else if (match.startsWith("{") && match.endsWith("}")) { + int colonIdx = match.indexOf(':'); + if (colonIdx == -1) { + patternBuilder.append(DEFAULT_VARIABLE_PATTERN); + this.variableNames.add(matcher.group(1)); + } else { + String variablePattern = match.substring(colonIdx + 1, match.length() - 1); + patternBuilder.append('('); + patternBuilder.append(variablePattern); + patternBuilder.append(')'); + String variableName = match.substring(1, colonIdx); + this.variableNames.add(variableName); + } + } + end = matcher.end(); + } + // No glob pattern was found, this is an exact String match + if (end == 0) { + this.exactMatch = true; + this.pattern = null; + } else { + this.exactMatch = false; + patternBuilder.append(quote(pattern, end, pattern.length())); + this.pattern = (this.caseSensitive ? Pattern.compile(patternBuilder.toString()) : + Pattern.compile(patternBuilder.toString(), Pattern.CASE_INSENSITIVE)); + } + } + + private String quote(String s, int start, int end) { + if (start == end) { + return ""; + } + return Pattern.quote(s.substring(start, end)); + } + + /** + * Main entry point. + * + * @param str Str + * @param uriTemplateVariables uri template vars + * @return {@code true} if the string matches against the pattern, or {@code false} otherwise. + */ + public boolean matchStrings(String str, Map uriTemplateVariables) { + if (this.exactMatch) { + return this.caseSensitive ? this.rawPattern.equals(str) : this.rawPattern.equalsIgnoreCase(str); + } else if (this.pattern != null) { + Matcher matcher = this.pattern.matcher(str); + if (matcher.matches()) { + if (uriTemplateVariables != null) { + if (this.variableNames.size() != matcher.groupCount()) { + throw new IllegalArgumentException("The number of capturing groups in the pattern segment " + + this.pattern + " does not match the number of URI template variables it defines, " + + "which can occur if capturing groups are used in a URI template regex. " + + "Use non-capturing groups instead."); + } + for (int i = 1; i <= matcher.groupCount(); i++) { + String name = this.variableNames.get(i - 1); + if (name.startsWith("*")) { + throw new IllegalArgumentException("Capturing patterns (" + name + ") are not " + + "supported by the AntPathMatcher. Use the PathPatternParser instead."); + } + String value = matcher.group(i); + uriTemplateVariables.put(name, value); + } + } + return true; + } + } + return false; + } + + } + + + /** + * The default {@link Comparator} implementation returned by + * {@link #getPatternComparator(String)}. + *

In order, the most "generic" pattern is determined by the following: + *

    + *
  • if it's null or a capture all pattern (i.e. it is equal to "/**")
    • + *
  • if the other pattern is an actual match
    • + *
  • if it's a catch-all pattern (i.e. it ends with "**"
    • + *
  • if it's got more "*" than the other pattern
    • + *
  • if it's got more "{foo}" than the other pattern
    • + *
  • if it's shorter than the other pattern
    • + *
+ */ + protected static class AntPatternComparator implements Comparator { + + private final String path; + + public AntPatternComparator(String path) { + this.path = path; + } + + /** + * Compare two patterns to determine which should match first, i.e. which + * is the most specific regarding the current path. + * + * @param pattern1 表达式1 + * @param pattern2 表达式2 + * @return a negative integer, zero, or a positive integer as pattern1 is + * more specific, equally specific, or less specific than pattern2. + */ + @Override + public int compare(String pattern1, String pattern2) { + PatternInfo info1 = new PatternInfo(pattern1); + PatternInfo info2 = new PatternInfo(pattern2); + + if (info1.isLeastSpecific() && info2.isLeastSpecific()) { + return 0; + } else if (info1.isLeastSpecific()) { + return 1; + } else if (info2.isLeastSpecific()) { + return -1; + } + + boolean pattern1EqualsPath = pattern1.equals(this.path); + boolean pattern2EqualsPath = pattern2.equals(this.path); + if (pattern1EqualsPath && pattern2EqualsPath) { + return 0; + } else if (pattern1EqualsPath) { + return -1; + } else if (pattern2EqualsPath) { + return 1; + } + + if (info1.isPrefixPattern() && info2.isPrefixPattern()) { + return info2.getLength() - info1.getLength(); + } else if (info1.isPrefixPattern() && info2.getDoubleWildcards() == 0) { + return 1; + } else if (info2.isPrefixPattern() && info1.getDoubleWildcards() == 0) { + return -1; + } + + if (info1.getTotalCount() != info2.getTotalCount()) { + return info1.getTotalCount() - info2.getTotalCount(); + } + + if (info1.getLength() != info2.getLength()) { + return info2.getLength() - info1.getLength(); + } + + if (info1.getSingleWildcards() < info2.getSingleWildcards()) { + return -1; + } else if (info2.getSingleWildcards() < info1.getSingleWildcards()) { + return 1; + } + + if (info1.getUriVars() < info2.getUriVars()) { + return -1; + } else if (info2.getUriVars() < info1.getUriVars()) { + return 1; + } + + return 0; + } + + + /** + * Value class that holds information about the pattern, e.g. number of + * occurrences of "*", "**", and "{" pattern elements. + */ + private static class PatternInfo { + + private final String pattern; + private int uriVars; + private int singleWildcards; + private int doubleWildcards; + private boolean catchAllPattern; + private boolean prefixPattern; + private Integer length; + + public PatternInfo(String pattern) { + this.pattern = pattern; + if (this.pattern != null) { + initCounters(); + this.catchAllPattern = this.pattern.equals("/**"); + this.prefixPattern = !this.catchAllPattern && this.pattern.endsWith("/**"); + } + if (this.uriVars == 0) { + this.length = (this.pattern != null ? this.pattern.length() : 0); + } + } + + protected void initCounters() { + int pos = 0; + if (this.pattern != null) { + while (pos < this.pattern.length()) { + if (this.pattern.charAt(pos) == '{') { + this.uriVars++; + pos++; + } else if (this.pattern.charAt(pos) == '*') { + if (pos + 1 < this.pattern.length() && this.pattern.charAt(pos + 1) == '*') { + this.doubleWildcards++; + pos += 2; + } else if (pos > 0 && !this.pattern.substring(pos - 1).equals(".*")) { + this.singleWildcards++; + pos++; + } else { + pos++; + } + } else { + pos++; + } + } + } + } + + public int getUriVars() { + return this.uriVars; + } + + public int getSingleWildcards() { + return this.singleWildcards; + } + + public int getDoubleWildcards() { + return this.doubleWildcards; + } + + public boolean isLeastSpecific() { + return (this.pattern == null || this.catchAllPattern); + } + + public boolean isPrefixPattern() { + return this.prefixPattern; + } + + public int getTotalCount() { + return this.uriVars + this.singleWildcards + (2 * this.doubleWildcards); + } + + /** + * Returns the length of the given pattern, where template variables are considered to be 1 long. + * + * @return 长度 + */ + public int getLength() { + if (this.length == null) { + this.length = (this.pattern != null ? + VARIABLE_PATTERN.matcher(this.pattern).replaceAll("#").length() : 0); + } + return this.length; + } + } + } + + + /** + * A simple cache for patterns that depend on the configured path separator. + */ + private static class PathSeparatorPatternCache { + + private final String endsOnWildCard; + + private final String endsOnDoubleWildCard; + + public PathSeparatorPatternCache(String pathSeparator) { + this.endsOnWildCard = pathSeparator + "*"; + this.endsOnDoubleWildCard = pathSeparator + "**"; + } + + public String getEndsOnWildCard() { + return this.endsOnWildCard; + } + + public String getEndsOnDoubleWildCard() { + return this.endsOnDoubleWildCard; + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/CharPool.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/CharPool.java new file mode 100644 index 0000000..434dd2c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/CharPool.java @@ -0,0 +1,86 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +/** + * 常用字符常量 + * @see StrPool + * @author looly + * @since 5.6.3 + */ +public interface CharPool { + /** + * 字符常量：空格符 {@code ' '} + */ + char SPACE = ' '; + /** + * 字符常量：制表符 {@code '\t'} + */ + char TAB = ' '; + /** + * 字符常量：点 {@code '.'} + */ + char DOT = '.'; + /** + * 字符常量：斜杠 {@code '/'} + */ + char SLASH = '/'; + /** + * 字符常量：反斜杠 {@code '\\'} + */ + char BACKSLASH = '\\'; + /** + * 字符常量：回车符 {@code '\r'} + */ + char CR = '\r'; + /** + * 字符常量：换行符 {@code '\n'} + */ + char LF = '\n'; + /** + * 字符常量：减号（连接符） {@code '-'} + */ + char DASHED = '-'; + /** + * 字符常量：下划线 {@code '_'} + */ + char UNDERLINE = '_'; + /** + * 字符常量：逗号 {@code ','} + */ + char COMMA = ','; + /** + * 字符常量：花括号（左） '{' + */ + char DELIM_START = '{'; + /** + * 字符常量：花括号（右） '}' + */ + char DELIM_END = '}'; + /** + * 字符常量：中括号（左） {@code '['} + */ + char BRACKET_START = '['; + /** + * 字符常量：中括号（右） {@code ']'} + */ + char BRACKET_END = ']'; + /** + * 字符常量：双引号 {@code '"'} + */ + char DOUBLE_QUOTES = '"'; + /** + * 字符常量：单引号 {@code '\''} + */ + char SINGLE_QUOTE = '\''; + /** + * 字符常量：与 {@code '&'} + */ + char AMP = '&'; + /** + * 字符常量：冒号 {@code ':'} + */ + char COLON = ':'; + /** + * 字符常量：艾特 {@code '@'} + */ + char AT = '@'; +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/CharSequenceUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/CharSequenceUtil.java new file mode 100755 index 0000000..eb88a9a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/CharSequenceUtil.java @@ -0,0 +1,4589 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.comparator.VersionComparator; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Filter; +import aiyh.utils.tool.cn.hutool.core.lang.Matcher; +import aiyh.utils.tool.cn.hutool.core.lang.func.Func1; +import aiyh.utils.tool.cn.hutool.core.text.finder.CharFinder; +import aiyh.utils.tool.cn.hutool.core.text.finder.Finder; +import aiyh.utils.tool.cn.hutool.core.text.finder.StrFinder; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.DesensitizedUtil; +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; +import aiyh.utils.tool.cn.hutool.core.util.ReUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.nio.ByteBuffer; +import java.nio.charset.Charset; +import java.text.MessageFormat; +import java.text.Normalizer; +import java.util.HashSet; +import java.util.LinkedList; +import java.util.List; +import java.util.Set; +import java.util.function.Function; +import java.util.function.Predicate; + +/** + * {@link CharSequence} 相关工具类封装 + * + * @author looly + * @since 5.5.3 + */ +public class CharSequenceUtil { + + public static final int INDEX_NOT_FOUND = Finder.INDEX_NOT_FOUND; + + /** + * 字符串常量：{@code "null"}
+ * 注意：{@code "null" != null} + */ + public static final String NULL = "null"; + + /** + * 字符串常量：空字符串 {@code ""} + */ + public static final String EMPTY = ""; + + /** + * 字符串常量：空格符 {@code " "} + */ + public static final String SPACE = " "; + + /** + *

字符串是否为空白，空白的定义如下：

+ *
    + *
  1. {@code null}
    2. + *
  2. 空字符串：{@code ""}
    3. + *
  3. 空格、全角空格、制表符、换行符，等不可见字符
    4. + *
+ * + *

例：

+ *
    + *
  • {@code StrUtil.isBlank(null) // true}
    • + *
  • {@code StrUtil.isBlank("") // true}
    • + *
  • {@code StrUtil.isBlank(" \t\n") // true}
    • + *
  • {@code StrUtil.isBlank("abc") // false}
    • + *
+ * + *

注意：该方法与 {@link #isEmpty(CharSequence)} 的区别是： + * 该方法会校验空白字符，且性能相对于 {@link #isEmpty(CharSequence)} 略慢。

+ *
+ * + *

建议：

+ *
    + *
  • 该方法建议仅对于客户端（或第三方接口）传入的参数使用该方法。
    • + *
  • 需要同时校验多个字符串时，建议采用 {@link #hasBlank(CharSequence...)} 或 {@link #isAllBlank(CharSequence...)}
    • + *
+ * + * @param str 被检测的字符串 + * @return 若为空白，则返回 true + * @see #isEmpty(CharSequence) + */ + public static boolean isBlank(CharSequence str) { + final int length; + if ((str == null) || ((length = str.length()) == 0)) { + return true; + } + + for (int i = 0; i < length; i++) { + // 只要有一个非空字符即为非空字符串 + if (false == CharUtil.isBlankChar(str.charAt(i))) { + return false; + } + } + + return true; + } + + /** + *

字符串是否为非空白，非空白的定义如下：

+ *
    + *
  1. 不为 {@code null}
    2. + *
  2. 不为空字符串：{@code ""}
    3. + *
  3. 不为空格、全角空格、制表符、换行符，等不可见字符
    4. + *
+ * + *

例：

+ *
    + *
  • {@code StrUtil.isNotBlank(null) // false}
    • + *
  • {@code StrUtil.isNotBlank("") // false}
    • + *
  • {@code StrUtil.isNotBlank(" \t\n") // false}
    • + *
  • {@code StrUtil.isNotBlank("abc") // true}
    • + *
+ * + *

注意：该方法与 {@link #isNotEmpty(CharSequence)} 的区别是： + * 该方法会校验空白字符，且性能相对于 {@link #isNotEmpty(CharSequence)} 略慢。

+ *

建议：仅对于客户端（或第三方接口）传入的参数使用该方法。

+ * + * @param str 被检测的字符串 + * @return 是否为非空 + * @see #isBlank(CharSequence) + */ + public static boolean isNotBlank(CharSequence str) { + return false == isBlank(str); + } + + /** + *

指定字符串数组中，是否包含空字符串。

+ *

如果指定的字符串数组的长度为 0，或者其中的任意一个元素是空字符串，则返回 true。

+ *
+ * + *

例：

+ *
    + *
  • {@code StrUtil.hasBlank() // true}
    • + *
  • {@code StrUtil.hasBlank("", null, " ") // true}
    • + *
  • {@code StrUtil.hasBlank("123", " ") // true}
    • + *
  • {@code StrUtil.hasBlank("123", "abc") // false}
    • + *
+ * + *

注意：该方法与 {@link #isAllBlank(CharSequence...)} 的区别在于：

+ *
    + *
  • hasBlank(CharSequence...) 等价于 {@code isBlank(...) || isBlank(...) || ...}
    • + *
  • {@link #isAllBlank(CharSequence...)} 等价于 {@code isBlank(...) && isBlank(...) && ...}
    • + *
+ * + * @param strs 字符串列表 + * @return 是否包含空字符串 + */ + public static boolean hasBlank(CharSequence... strs) { + if (ArrayUtil.isEmpty(strs)) { + return true; + } + + for (CharSequence str : strs) { + if (isBlank(str)) { + return true; + } + } + return false; + } + + /** + *

指定字符串数组中的元素，是否全部为空字符串。

+ *

如果指定的字符串数组的长度为 0，或者所有元素都是空字符串，则返回 true。

+ *
+ * + *

例：

+ *
    + *
  • {@code StrUtil.isAllBlank() // true}
    • + *
  • {@code StrUtil.isAllBlank("", null, " ") // true}
    • + *
  • {@code StrUtil.isAllBlank("123", " ") // false}
    • + *
  • {@code StrUtil.isAllBlank("123", "abc") // false}
    • + *
+ * + *

注意：该方法与 {@link #hasBlank(CharSequence...)} 的区别在于：

+ *
    + *
  • {@link #hasBlank(CharSequence...)} 等价于 {@code isBlank(...) || isBlank(...) || ...}
    • + *
  • isAllBlank(CharSequence...) 等价于 {@code isBlank(...) && isBlank(...) && ...}
    • + *
+ * + * @param strs 字符串列表 + * @return 所有字符串是否为空白 + */ + public static boolean isAllBlank(CharSequence... strs) { + if (ArrayUtil.isEmpty(strs)) { + return true; + } + + for (CharSequence str : strs) { + if (isNotBlank(str)) { + return false; + } + } + return true; + } + + /** + *

字符串是否为空，空的定义如下：

+ *
    + *
  1. {@code null}
    2. + *
  2. 空字符串：{@code ""}
    3. + *
+ * + *

例：

+ *
    + *
  • {@code StrUtil.isEmpty(null) // true}
    • + *
  • {@code StrUtil.isEmpty("") // true}
    • + *
  • {@code StrUtil.isEmpty(" \t\n") // false}
    • + *
  • {@code StrUtil.isEmpty("abc") // false}
    • + *
+ * + *

注意：该方法与 {@link #isBlank(CharSequence)} 的区别是：该方法不校验空白字符。

+ *

建议：

+ *
    + *
  • 该方法建议用于工具类或任何可以预期的方法参数的校验中。
    • + *
  • 需要同时校验多个字符串时，建议采用 {@link #hasEmpty(CharSequence...)} 或 {@link #isAllEmpty(CharSequence...)}
    • + *
+ * + * @param str 被检测的字符串 + * @return 是否为空 + * @see #isBlank(CharSequence) + */ + public static boolean isEmpty(CharSequence str) { + return str == null || str.length() == 0; + } + + /** + *

字符串是否为非空白，非空白的定义如下：

+ *
    + *
  1. 不为 {@code null}
    2. + *
  2. 不为空字符串：{@code ""}
    3. + *
+ * + *

例：

+ *
    + *
  • {@code StrUtil.isNotEmpty(null) // false}
    • + *
  • {@code StrUtil.isNotEmpty("") // false}
    • + *
  • {@code StrUtil.isNotEmpty(" \t\n") // true}
    • + *
  • {@code StrUtil.isNotEmpty("abc") // true}
    • + *
+ * + *

注意：该方法与 {@link #isNotBlank(CharSequence)} 的区别是：该方法不校验空白字符。

+ *

建议：该方法建议用于工具类或任何可以预期的方法参数的校验中。

+ * + * @param str 被检测的字符串 + * @return 是否为非空 + * @see #isEmpty(CharSequence) + */ + public static boolean isNotEmpty(CharSequence str) { + return false == isEmpty(str); + } + + /** + * 当给定字符串为null时，转换为Empty + * + * @param str 被检查的字符串 + * @return 原字符串或者空串 + * @see #nullToEmpty(CharSequence) + * @since 4.6.3 + */ + public static String emptyIfNull(CharSequence str) { + return nullToEmpty(str); + } + + /** + * 当给定字符串为null时，转换为Empty + * + * @param str 被转换的字符串 + * @return 转换后的字符串 + */ + public static String nullToEmpty(CharSequence str) { + return nullToDefault(str, EMPTY); + } + + /** + * 如果字符串是 {@code null}，则返回指定默认字符串，否则返回字符串本身。 + * + * 
+	 * nullToDefault(null, "default")  = "default"
+	 * nullToDefault("", "default")    = ""
+	 * nullToDefault("  ", "default")  = "  "
+	 * nullToDefault("bat", "default") = "bat"
+	 *
+ * + * @param str 要转换的字符串 + * @param defaultStr 默认字符串 + * @return 字符串本身或指定的默认字符串 + */ + public static String nullToDefault(CharSequence str, String defaultStr) { + return (str == null) ? defaultStr : str.toString(); + } + + /** + * 如果字符串是{@code null}或者""，则返回指定默认字符串，否则返回字符串本身。 + * + * 
+	 * emptyToDefault(null, "default")  = "default"
+	 * emptyToDefault("", "default")    = "default"
+	 * emptyToDefault("  ", "default")  = "  "
+	 * emptyToDefault("bat", "default") = "bat"
+	 *
+ * + * @param str 要转换的字符串 + * @param defaultStr 默认字符串 + * @return 字符串本身或指定的默认字符串 + * @since 4.1.0 + */ + public static String emptyToDefault(CharSequence str, String defaultStr) { + return isEmpty(str) ? defaultStr : str.toString(); + } + + /** + * 如果字符串是{@code null}或者""或者空白，则返回指定默认字符串，否则返回字符串本身。 + * + * 
+	 * blankToDefault(null, "default")  = "default"
+	 * blankToDefault("", "default")    = "default"
+	 * blankToDefault("  ", "default")  = "default"
+	 * blankToDefault("bat", "default") = "bat"
+	 *
+ * + * @param str 要转换的字符串 + * @param defaultStr 默认字符串 + * @return 字符串本身或指定的默认字符串 + * @since 4.1.0 + */ + public static String blankToDefault(CharSequence str, String defaultStr) { + return isBlank(str) ? defaultStr : str.toString(); + } + + /** + * 当给定字符串为空字符串时，转换为{@code null} + * + * @param str 被转换的字符串 + * @return 转换后的字符串 + */ + public static String emptyToNull(CharSequence str) { + return isEmpty(str) ? null : str.toString(); + } + + /** + *

是否包含空字符串。

+ *

如果指定的字符串数组的长度为 0，或者其中的任意一个元素是空字符串，则返回 true。

+ *
+ * + *

例：

+ *
    + *
  • {@code StrUtil.hasEmpty() // true}
    • + *
  • {@code StrUtil.hasEmpty("", null) // true}
    • + *
  • {@code StrUtil.hasEmpty("123", "") // true}
    • + *
  • {@code StrUtil.hasEmpty("123", "abc") // false}
    • + *
  • {@code StrUtil.hasEmpty(" ", "\t", "\n") // false}
    • + *
+ * + *

注意：该方法与 {@link #isAllEmpty(CharSequence...)} 的区别在于：

+ *
    + *
  • hasEmpty(CharSequence...) 等价于 {@code isEmpty(...) || isEmpty(...) || ...}
    • + *
  • {@link #isAllEmpty(CharSequence...)} 等价于 {@code isEmpty(...) && isEmpty(...) && ...}
    • + *
+ * + * @param strs 字符串列表 + * @return 是否包含空字符串 + */ + public static boolean hasEmpty(CharSequence... strs) { + if (ArrayUtil.isEmpty(strs)) { + return true; + } + + for (CharSequence str : strs) { + if (isEmpty(str)) { + return true; + } + } + return false; + } + + /** + *

指定字符串数组中的元素，是否全部为空字符串。

+ *

如果指定的字符串数组的长度为 0，或者所有元素都是空字符串，则返回 true。

+ *
+ * + *

例：

+ *
    + *
  • {@code StrUtil.isAllEmpty() // true}
    • + *
  • {@code StrUtil.isAllEmpty("", null) // true}
    • + *
  • {@code StrUtil.isAllEmpty("123", "") // false}
    • + *
  • {@code StrUtil.isAllEmpty("123", "abc") // false}
    • + *
  • {@code StrUtil.isAllEmpty(" ", "\t", "\n") // false}
    • + *
+ * + *

注意：该方法与 {@link #hasEmpty(CharSequence...)} 的区别在于：

+ *
    + *
  • {@link #hasEmpty(CharSequence...)} 等价于 {@code isEmpty(...) || isEmpty(...) || ...}
    • + *
  • isAllEmpty(CharSequence...) 等价于 {@code isEmpty(...) && isEmpty(...) && ...}
    • + *
+ * + * @param strs 字符串列表 + * @return 所有字符串是否为空白 + */ + public static boolean isAllEmpty(CharSequence... strs) { + if (ArrayUtil.isEmpty(strs)) { + return true; + } + + for (CharSequence str : strs) { + if (isNotEmpty(str)) { + return false; + } + } + return true; + } + + /** + *

指定字符串数组中的元素，是否都不为空字符串。

+ *

如果指定的字符串数组的长度不为 0，或者所有元素都不是空字符串，则返回 true。

+ *
+ * + *

例：

+ *
    + *
  • {@code StrUtil.isAllNotEmpty() // false}
    • + *
  • {@code StrUtil.isAllNotEmpty("", null) // false}
    • + *
  • {@code StrUtil.isAllNotEmpty("123", "") // false}
    • + *
  • {@code StrUtil.isAllNotEmpty("123", "abc") // true}
    • + *
  • {@code StrUtil.isAllNotEmpty(" ", "\t", "\n") // true}
    • + *
+ * + *

注意：该方法与 {@link #isAllEmpty(CharSequence...)} 的区别在于：

+ *
    + *
  • {@link #isAllEmpty(CharSequence...)} 等价于 {@code isEmpty(...) && isEmpty(...) && ...}
    • + *
  • isAllNotEmpty(CharSequence...) 等价于 {@code !isEmpty(...) && !isEmpty(...) && ...}
    • + *
+ * + * @param args 字符串数组 + * @return 所有字符串是否都不为为空白 + * @since 5.3.6 + */ + public static boolean isAllNotEmpty(CharSequence... args) { + return false == hasEmpty(args); + } + + /** + * 是否存都不为{@code null}或空对象或空白符的对象，通过{@link #hasBlank(CharSequence...)} 判断元素 + * + * @param args 被检查的对象,一个或者多个 + * @return 是否都不为空 + * @since 5.3.6 + */ + public static boolean isAllNotBlank(CharSequence... args) { + return false == hasBlank(args); + } + + /** + * 检查字符串是否为null、“null”、“undefined” + * + * @param str 被检查的字符串 + * @return 是否为null、“null”、“undefined” + * @since 4.0.10 + */ + public static boolean isNullOrUndefined(CharSequence str) { + if (null == str) { + return true; + } + return isNullOrUndefinedStr(str); + } + + /** + * 检查字符串是否为null、“”、“null”、“undefined” + * + * @param str 被检查的字符串 + * @return 是否为null、“”、“null”、“undefined” + * @since 4.0.10 + */ + public static boolean isEmptyOrUndefined(CharSequence str) { + if (isEmpty(str)) { + return true; + } + return isNullOrUndefinedStr(str); + } + + /** + * 检查字符串是否为null、空白串、“null”、“undefined” + * + * @param str 被检查的字符串 + * @return 是否为null、空白串、“null”、“undefined” + * @since 4.0.10 + */ + public static boolean isBlankOrUndefined(CharSequence str) { + if (isBlank(str)) { + return true; + } + return isNullOrUndefinedStr(str); + } + + /** + * 是否为“null”、“undefined”，不做空指针检查 + * + * @param str 字符串 + * @return 是否为“null”、“undefined” + */ + private static boolean isNullOrUndefinedStr(CharSequence str) { + String strString = str.toString().trim(); + return NULL.equals(strString) || "undefined".equals(strString); + } + + // ------------------------------------------------------------------------ Trim + + /** + * 除去字符串头尾部的空白，如果字符串是{@code null}，依然返回{@code null}。 + * + *

+ * 注意，和{@link String#trim()}不同，此方法使用{@link CharUtil#isBlankChar(char)} 来判定空白， 因而可以除去英文字符集之外的其它空白，如中文空格。 + * + * 

+	 * trim(null)          = null
+	 * trim("")            = ""
+	 * trim("     ")       = ""
+	 * trim("abc")         = "abc"
+	 * trim("    abc    ") = "abc"
+	 *
+ * + * @param str 要处理的字符串 + * @return 除去头尾空白的字符串，如果原字串为{@code null}，则返回{@code null} + */ + public static String trim(CharSequence str) { + return (null == str) ? null : trim(str, 0); + } + + /** + * 除去字符串头尾部的空白，如果字符串是{@code null}，返回{@code ""}。 + * + * 
+	 * StrUtil.trimToEmpty(null)          = ""
+	 * StrUtil.trimToEmpty("")            = ""
+	 * StrUtil.trimToEmpty("     ")       = ""
+	 * StrUtil.trimToEmpty("abc")         = "abc"
+	 * StrUtil.trimToEmpty("    abc    ") = "abc"
+	 *
+ * + * @param str 字符串 + * @return 去除两边空白符后的字符串, 如果为null返回"" + * @since 3.1.1 + */ + public static String trimToEmpty(CharSequence str) { + return str == null ? EMPTY : trim(str); + } + + /** + * 除去字符串头尾部的空白，如果字符串是{@code null}或者""，返回{@code null}。 + * + * 
+	 * StrUtil.trimToNull(null)          = null
+	 * StrUtil.trimToNull("")            = null
+	 * StrUtil.trimToNull("     ")       = null
+	 * StrUtil.trimToNull("abc")         = "abc"
+	 * StrUtil.trimToEmpty("    abc    ") = "abc"
+	 *
+ * + * @param str 字符串 + * @return 去除两边空白符后的字符串, 如果为空返回null + * @since 3.2.1 + */ + public static String trimToNull(CharSequence str) { + final String trimStr = trim(str); + return EMPTY.equals(trimStr) ? null : trimStr; + } + + /** + * 除去字符串头部的空白，如果字符串是{@code null}，则返回{@code null}。 + * + *

+ * 注意，和{@link String#trim()}不同，此方法使用{@link CharUtil#isBlankChar(char)} 来判定空白， 因而可以除去英文字符集之外的其它空白，如中文空格。 + * + * 

+	 * trimStart(null)         = null
+	 * trimStart("")           = ""
+	 * trimStart("abc")        = "abc"
+	 * trimStart("  abc")      = "abc"
+	 * trimStart("abc  ")      = "abc  "
+	 * trimStart(" abc ")      = "abc "
+	 *
+ * + * @param str 要处理的字符串 + * @return 除去空白的字符串，如果原字串为{@code null}或结果字符串为{@code ""}，则返回 {@code null} + */ + public static String trimStart(CharSequence str) { + return trim(str, -1); + } + + /** + * 除去字符串尾部的空白，如果字符串是{@code null}，则返回{@code null}。 + * + *

+ * 注意，和{@link String#trim()}不同，此方法使用{@link CharUtil#isBlankChar(char)} 来判定空白， 因而可以除去英文字符集之外的其它空白，如中文空格。 + * + * 

+	 * trimEnd(null)       = null
+	 * trimEnd("")         = ""
+	 * trimEnd("abc")      = "abc"
+	 * trimEnd("  abc")    = "  abc"
+	 * trimEnd("abc  ")    = "abc"
+	 * trimEnd(" abc ")    = " abc"
+	 *
+ * + * @param str 要处理的字符串 + * @return 除去空白的字符串，如果原字串为{@code null}或结果字符串为{@code ""}，则返回 {@code null} + */ + public static String trimEnd(CharSequence str) { + return trim(str, 1); + } + + /** + * 除去字符串头尾部的空白符，如果字符串是{@code null}，依然返回{@code null}。 + * + * @param str 要处理的字符串 + * @param mode {@code -1}表示trimStart，{@code 0}表示trim全部， {@code 1}表示trimEnd + * @return 除去指定字符后的的字符串，如果原字串为{@code null}，则返回{@code null} + */ + public static String trim(CharSequence str, int mode) { + return trim(str, mode, CharUtil::isBlankChar); + } + + /** + * 按照断言，除去字符串头尾部的断言为真的字符，如果字符串是{@code null}，依然返回{@code null}。 + * + * @param str 要处理的字符串 + * @param mode {@code -1}表示trimStart，{@code 0}表示trim全部， {@code 1}表示trimEnd + * @param predicate 断言是否过掉字符，返回{@code true}表述过滤掉，{@code false}表示不过滤 + * @return 除去指定字符后的的字符串，如果原字串为{@code null}，则返回{@code null} + * @since 5.7.4 + */ + public static String trim(CharSequence str, int mode, Predicate predicate) { + String result; + if (str == null) { + result = null; + } else { + int length = str.length(); + int start = 0; + int end = length;// 扫描字符串头部 + if (mode <= 0) { + while ((start < end) && (predicate.test(str.charAt(start)))) { + start++; + } + }// 扫描字符串尾部 + if (mode >= 0) { + while ((start < end) && (predicate.test(str.charAt(end - 1)))) { + end--; + } + } + if ((start > 0) || (end < length)) { + result = str.toString().substring(start, end); + } else { + result = str.toString(); + } + } + + return result; + } + + // ------------------------------------------------------------------------ startWith + + /** + * 字符串是否以给定字符开始 + * + * @param str 字符串 + * @param c 字符 + * @return 是否开始 + */ + public static boolean startWith(CharSequence str, char c) { + if (isEmpty(str)) { + return false; + } + return c == str.charAt(0); + } + + /** + * 是否以指定字符串开头
+ * 如果给定的字符串和开头字符串都为null则返回true，否则任意一个值为null返回false + * + * @param str 被监测字符串 + * @param prefix 开头字符串 + * @param ignoreCase 是否忽略大小写 + * @return 是否以指定字符串开头 + * @since 5.4.3 + */ + public static boolean startWith(CharSequence str, CharSequence prefix, boolean ignoreCase) { + return startWith(str, prefix, ignoreCase, false); + } + + /** + * 是否以指定字符串开头
+ * 如果给定的字符串和开头字符串都为null则返回true，否则任意一个值为null返回false
+ * 
+	 *     CharSequenceUtil.startWith("123", "123", false, true);   -- false
+	 *     CharSequenceUtil.startWith("ABCDEF", "abc", true, true); -- true
+	 *     CharSequenceUtil.startWith("abc", "abc", true, true);    -- false
+	 *
+ * + * @param str 被监测字符串 + * @param prefix 开头字符串 + * @param ignoreCase 是否忽略大小写 + * @param ignoreEquals 是否忽略字符串相等的情况 + * @return 是否以指定字符串开头 + * @since 5.4.3 + */ + public static boolean startWith(CharSequence str, CharSequence prefix, boolean ignoreCase, boolean ignoreEquals) { + if (null == str || null == prefix) { + if (ignoreEquals) { + return false; + } + return null == str && null == prefix; + } + + boolean isStartWith = str.toString() + .regionMatches(ignoreCase, 0, prefix.toString(), 0, prefix.length()); + + if (isStartWith) { + return (false == ignoreEquals) || (false == equals(str, prefix, ignoreCase)); + } + return false; + } + + /** + * 是否以指定字符串开头 + * + * @param str 被监测字符串 + * @param prefix 开头字符串 + * @return 是否以指定字符串开头 + */ + public static boolean startWith(CharSequence str, CharSequence prefix) { + return startWith(str, prefix, false); + } + + /** + * 是否以指定字符串开头，忽略相等字符串的情况 + * + * @param str 被监测字符串 + * @param prefix 开头字符串 + * @return 是否以指定字符串开头并且两个字符串不相等 + */ + public static boolean startWithIgnoreEquals(CharSequence str, CharSequence prefix) { + return startWith(str, prefix, false, true); + } + + /** + * 是否以指定字符串开头，忽略大小写 + * + * @param str 被监测字符串 + * @param prefix 开头字符串 + * @return 是否以指定字符串开头 + */ + public static boolean startWithIgnoreCase(CharSequence str, CharSequence prefix) { + return startWith(str, prefix, true); + } + + /** + * 给定字符串是否以任何一个字符串开始
+ * 给定字符串和数组为空都返回false + * + * @param str 给定字符串 + * @param prefixes 需要检测的开始字符串 + * @return 给定字符串是否以任何一个字符串开始 + * @since 3.0.6 + */ + public static boolean startWithAny(CharSequence str, CharSequence... prefixes) { + if (isEmpty(str) || ArrayUtil.isEmpty(prefixes)) { + return false; + } + + for (CharSequence suffix : prefixes) { + if (startWith(str, suffix, false)) { + return true; + } + } + return false; + } + + /** + * 给定字符串是否以任何一个字符串结尾（忽略大小写）
+ * 给定字符串和数组为空都返回false + * + * @param str 给定字符串 + * @param suffixes 需要检测的结尾字符串 + * @return 给定字符串是否以任何一个字符串结尾 + * @since 5.8.1 + */ + public static boolean startWithAnyIgnoreCase(final CharSequence str, final CharSequence... suffixes) { + if (isEmpty(str) || ArrayUtil.isEmpty(suffixes)) { + return false; + } + + for (final CharSequence suffix : suffixes) { + if (startWith(str, suffix, true)) { + return true; + } + } + return false; + } + + // ------------------------------------------------------------------------ endWith + + /** + * 字符串是否以给定字符结尾 + * + * @param str 字符串 + * @param c 字符 + * @return 是否结尾 + */ + public static boolean endWith(CharSequence str, char c) { + if (isEmpty(str)) { + return false; + } + return c == str.charAt(str.length() - 1); + } + + /** + * 是否以指定字符串结尾
+ * 如果给定的字符串和开头字符串都为null则返回true，否则任意一个值为null返回false + * + * @param str 被监测字符串 + * @param suffix 结尾字符串 + * @param ignoreCase 是否忽略大小写 + * @return 是否以指定字符串结尾 + */ + public static boolean endWith(CharSequence str, CharSequence suffix, boolean ignoreCase) { + return endWith(str, suffix, ignoreCase, false); + } + + /** + * 是否以指定字符串结尾
+ * 如果给定的字符串和开头字符串都为null则返回true，否则任意一个值为null返回false + * + * @param str 被监测字符串 + * @param suffix 结尾字符串 + * @param ignoreCase 是否忽略大小写 + * @param ignoreEquals 是否忽略字符串相等的情况 + * @return 是否以指定字符串结尾 + * @since 5.8.0 + */ + public static boolean endWith(CharSequence str, CharSequence suffix, boolean ignoreCase, boolean ignoreEquals) { + if (null == str || null == suffix) { + if (ignoreEquals) { + return false; + } + return null == str && null == suffix; + } + + final int strOffset = str.length() - suffix.length(); + boolean isEndWith = str.toString() + .regionMatches(ignoreCase, strOffset, suffix.toString(), 0, suffix.length()); + + if (isEndWith) { + return (false == ignoreEquals) || (false == equals(str, suffix, ignoreCase)); + } + return false; + } + + /** + * 是否以指定字符串结尾 + * + * @param str 被监测字符串 + * @param suffix 结尾字符串 + * @return 是否以指定字符串结尾 + */ + public static boolean endWith(CharSequence str, CharSequence suffix) { + return endWith(str, suffix, false); + } + + /** + * 是否以指定字符串结尾，忽略大小写 + * + * @param str 被监测字符串 + * @param suffix 结尾字符串 + * @return 是否以指定字符串结尾 + */ + public static boolean endWithIgnoreCase(CharSequence str, CharSequence suffix) { + return endWith(str, suffix, true); + } + + /** + * 给定字符串是否以任何一个字符串结尾
+ * 给定字符串和数组为空都返回false + * + * @param str 给定字符串 + * @param suffixes 需要检测的结尾字符串 + * @return 给定字符串是否以任何一个字符串结尾 + * @since 3.0.6 + */ + public static boolean endWithAny(CharSequence str, CharSequence... suffixes) { + if (isEmpty(str) || ArrayUtil.isEmpty(suffixes)) { + return false; + } + + for (CharSequence suffix : suffixes) { + if (endWith(str, suffix, false)) { + return true; + } + } + return false; + } + + /** + * 给定字符串是否以任何一个字符串结尾（忽略大小写）
+ * 给定字符串和数组为空都返回false + * + * @param str 给定字符串 + * @param suffixes 需要检测的结尾字符串 + * @return 给定字符串是否以任何一个字符串结尾 + * @since 5.5.9 + */ + public static boolean endWithAnyIgnoreCase(CharSequence str, CharSequence... suffixes) { + if (isEmpty(str) || ArrayUtil.isEmpty(suffixes)) { + return false; + } + + for (CharSequence suffix : suffixes) { + if (endWith(str, suffix, true)) { + return true; + } + } + return false; + } + + // ------------------------------------------------------------------------ contains + + /** + * 指定字符是否在字符串中出现过 + * + * @param str 字符串 + * @param searchChar 被查找的字符 + * @return 是否包含 + * @since 3.1.2 + */ + public static boolean contains(CharSequence str, char searchChar) { + return indexOf(str, searchChar) > -1; + } + + /** + * 指定字符串是否在字符串中出现过 + * + * @param str 字符串 + * @param searchStr 被查找的字符串 + * @return 是否包含 + * @since 5.1.1 + */ + public static boolean contains(CharSequence str, CharSequence searchStr) { + if (null == str || null == searchStr) { + return false; + } + return str.toString().contains(searchStr); + } + + /** + * 查找指定字符串是否包含指定字符串列表中的任意一个字符串 + * + * @param str 指定字符串 + * @param testStrs 需要检查的字符串数组 + * @return 是否包含任意一个字符串 + * @since 3.2.0 + */ + public static boolean containsAny(CharSequence str, CharSequence... testStrs) { + return null != getContainsStr(str, testStrs); + } + + /** + * 查找指定字符串是否包含指定字符列表中的任意一个字符 + * + * @param str 指定字符串 + * @param testChars 需要检查的字符数组 + * @return 是否包含任意一个字符 + * @since 4.1.11 + */ + public static boolean containsAny(CharSequence str, char... testChars) { + if (false == isEmpty(str)) { + int len = str.length(); + for (int i = 0; i < len; i++) { + if (ArrayUtil.contains(testChars, str.charAt(i))) { + return true; + } + } + } + return false; + } + + /** + * 检查指定字符串中是否只包含给定的字符 + * + * @param str 字符串 + * @param testChars 检查的字符 + * @return 字符串含有非检查的字符，返回false + * @since 4.4.1 + */ + public static boolean containsOnly(CharSequence str, char... testChars) { + if (false == isEmpty(str)) { + int len = str.length(); + for (int i = 0; i < len; i++) { + if (false == ArrayUtil.contains(testChars, str.charAt(i))) { + return false; + } + } + } + return true; + } + + /** + * 检查指定字符串中是否含给定的所有字符串 + * + * @param str 字符串 + * @param testChars 检查的字符 + * @return 字符串含有非检查的字符，返回false + * @since 4.4.1 + */ + public static boolean containsAll(CharSequence str, CharSequence... testChars) { + if (isBlank(str) || ArrayUtil.isEmpty(testChars)) { + return false; + } + for (CharSequence testChar : testChars) { + if (false == contains(str, testChar)) { + return false; + } + } + return true; + } + + /** + * 给定字符串是否包含空白符（空白符包括空格、制表符、全角空格和不间断空格）
+ * 如果给定字符串为null或者""，则返回false + * + * @param str 字符串 + * @return 是否包含空白符 + * @since 4.0.8 + */ + public static boolean containsBlank(CharSequence str) { + if (null == str) { + return false; + } + final int length = str.length(); + if (0 == length) { + return false; + } + + for (int i = 0; i < length; i += 1) { + if (CharUtil.isBlankChar(str.charAt(i))) { + return true; + } + } + return false; + } + + /** + * 查找指定字符串是否包含指定字符串列表中的任意一个字符串，如果包含返回找到的第一个字符串 + * + * @param str 指定字符串 + * @param testStrs 需要检查的字符串数组 + * @return 被包含的第一个字符串 + * @since 3.2.0 + */ + public static String getContainsStr(CharSequence str, CharSequence... testStrs) { + if (isEmpty(str) || ArrayUtil.isEmpty(testStrs)) { + return null; + } + for (CharSequence checkStr : testStrs) { + if (str.toString().contains(checkStr)) { + return checkStr.toString(); + } + } + return null; + } + + /** + * 是否包含特定字符，忽略大小写，如果给定两个参数都为{@code null}，返回true + * + * @param str 被检测字符串 + * @param testStr 被测试是否包含的字符串 + * @return 是否包含 + */ + public static boolean containsIgnoreCase(CharSequence str, CharSequence testStr) { + if (null == str) { + // 如果被监测字符串和 + return null == testStr; + } + return indexOfIgnoreCase(str, testStr) > -1; + } + + /** + * 查找指定字符串是否包含指定字符串列表中的任意一个字符串
+ * 忽略大小写 + * + * @param str 指定字符串 + * @param testStrs 需要检查的字符串数组 + * @return 是否包含任意一个字符串 + * @since 3.2.0 + */ + public static boolean containsAnyIgnoreCase(CharSequence str, CharSequence... testStrs) { + return null != getContainsStrIgnoreCase(str, testStrs); + } + + /** + * 查找指定字符串是否包含指定字符串列表中的任意一个字符串，如果包含返回找到的第一个字符串
+ * 忽略大小写 + * + * @param str 指定字符串 + * @param testStrs 需要检查的字符串数组 + * @return 被包含的第一个字符串 + * @since 3.2.0 + */ + public static String getContainsStrIgnoreCase(CharSequence str, CharSequence... testStrs) { + if (isEmpty(str) || ArrayUtil.isEmpty(testStrs)) { + return null; + } + for (CharSequence testStr : testStrs) { + if (containsIgnoreCase(str, testStr)) { + return testStr.toString(); + } + } + return null; + } + + // ------------------------------------------------------------------------ indexOf + + /** + * 指定范围内查找指定字符 + * + * @param str 字符串 + * @param searchChar 被查找的字符 + * @return 位置 + */ + public static int indexOf(CharSequence str, char searchChar) { + return indexOf(str, searchChar, 0); + } + + /** + * 指定范围内查找指定字符 + * + * @param str 字符串 + * @param searchChar 被查找的字符 + * @param start 起始位置，如果小于0，从0开始查找 + * @return 位置 + */ + public static int indexOf(CharSequence str, char searchChar, int start) { + if (str instanceof String) { + return ((String) str).indexOf(searchChar, start); + } else { + return indexOf(str, searchChar, start, -1); + } + } + + /** + * 指定范围内查找指定字符 + * + * @param text 字符串 + * @param searchChar 被查找的字符 + * @param start 起始位置，如果小于0，从0开始查找 + * @param end 终止位置，如果超过str.length()则默认查找到字符串末尾 + * @return 位置 + */ + public static int indexOf(CharSequence text, char searchChar, int start, int end) { + if (isEmpty(text)) { + return INDEX_NOT_FOUND; + } + return new CharFinder(searchChar).setText(text).setEndIndex(end).start(start); + } + + /** + * 指定范围内查找字符串，忽略大小写
+ * + * 
+	 * StrUtil.indexOfIgnoreCase(null, *, *)          = -1
+	 * StrUtil.indexOfIgnoreCase(*, null, *)          = -1
+	 * StrUtil.indexOfIgnoreCase("", "", 0)           = 0
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "A", 0)  = 0
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "B", 0)  = 2
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "AB", 0) = 1
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "B", 3)  = 5
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "B", 9)  = -1
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "B", -1) = 2
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "", 2)   = 2
+	 * StrUtil.indexOfIgnoreCase("abc", "", 9)        = -1
+	 *
+ * + * @param str 字符串 + * @param searchStr 需要查找位置的字符串 + * @return 位置 + * @since 3.2.1 + */ + public static int indexOfIgnoreCase(final CharSequence str, final CharSequence searchStr) { + return indexOfIgnoreCase(str, searchStr, 0); + } + + /** + * 指定范围内查找字符串 + * + * 
+	 * StrUtil.indexOfIgnoreCase(null, *, *)          = -1
+	 * StrUtil.indexOfIgnoreCase(*, null, *)          = -1
+	 * StrUtil.indexOfIgnoreCase("", "", 0)           = 0
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "A", 0)  = 0
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "B", 0)  = 2
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "AB", 0) = 1
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "B", 3)  = 5
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "B", 9)  = -1
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "B", -1) = 2
+	 * StrUtil.indexOfIgnoreCase("aabaabaa", "", 2)   = 2
+	 * StrUtil.indexOfIgnoreCase("abc", "", 9)        = -1
+	 *
+ * + * @param str 字符串 + * @param searchStr 需要查找位置的字符串 + * @param fromIndex 起始位置 + * @return 位置 + * @since 3.2.1 + */ + public static int indexOfIgnoreCase(final CharSequence str, final CharSequence searchStr, int fromIndex) { + return indexOf(str, searchStr, fromIndex, true); + } + + /** + * 指定范围内查找字符串 + * + * @param text 字符串，空则返回-1 + * @param searchStr 需要查找位置的字符串，空则返回-1 + * @param from 起始位置（包含） + * @param ignoreCase 是否忽略大小写 + * @return 位置 + * @since 3.2.1 + */ + public static int indexOf(CharSequence text, CharSequence searchStr, int from, boolean ignoreCase) { + if (isEmpty(text) || isEmpty(searchStr)) { + if (StrUtil.equals(text, searchStr)) { + return 0; + } else { + return INDEX_NOT_FOUND; + } + } + return new StrFinder(searchStr, ignoreCase).setText(text).start(from); + } + + /** + * 指定范围内查找字符串，忽略大小写 + * + * @param str 字符串 + * @param searchStr 需要查找位置的字符串 + * @return 位置 + * @since 3.2.1 + */ + public static int lastIndexOfIgnoreCase(CharSequence str, CharSequence searchStr) { + return lastIndexOfIgnoreCase(str, searchStr, str.length()); + } + + /** + * 指定范围内查找字符串，忽略大小写
+ * fromIndex 为搜索起始位置，从后往前计数 + * + * @param str 字符串 + * @param searchStr 需要查找位置的字符串 + * @param fromIndex 起始位置，从后往前计数 + * @return 位置 + * @since 3.2.1 + */ + public static int lastIndexOfIgnoreCase(CharSequence str, CharSequence searchStr, int fromIndex) { + return lastIndexOf(str, searchStr, fromIndex, true); + } + + /** + * 指定范围内查找字符串
+ * fromIndex 为搜索起始位置，从后往前计数 + * + * @param text 字符串 + * @param searchStr 需要查找位置的字符串 + * @param from 起始位置，从后往前计数 + * @param ignoreCase 是否忽略大小写 + * @return 位置 + * @since 3.2.1 + */ + public static int lastIndexOf(CharSequence text, CharSequence searchStr, int from, boolean ignoreCase) { + if (isEmpty(text) || isEmpty(searchStr)) { + if (StrUtil.equals(text, searchStr)) { + return 0; + } else { + return INDEX_NOT_FOUND; + } + } + return new StrFinder(searchStr, ignoreCase) + .setText(text).setNegative(true).start(from); + } + + /** + * 返回字符串 searchStr 在字符串 str 中第 ordinal 次出现的位置。 + * + *

+ * 如果 str=null 或 searchStr=null 或 ordinal≥0 则返回-1
+ * 此方法来自：Apache-Commons-Lang + *

+ * 例子（*代表任意字符）： + * + * 

+	 * StrUtil.ordinalIndexOf(null, *, *)          = -1
+	 * StrUtil.ordinalIndexOf(*, null, *)          = -1
+	 * StrUtil.ordinalIndexOf("", "", *)           = 0
+	 * StrUtil.ordinalIndexOf("aabaabaa", "a", 1)  = 0
+	 * StrUtil.ordinalIndexOf("aabaabaa", "a", 2)  = 1
+	 * StrUtil.ordinalIndexOf("aabaabaa", "b", 1)  = 2
+	 * StrUtil.ordinalIndexOf("aabaabaa", "b", 2)  = 5
+	 * StrUtil.ordinalIndexOf("aabaabaa", "ab", 1) = 1
+	 * StrUtil.ordinalIndexOf("aabaabaa", "ab", 2) = 4
+	 * StrUtil.ordinalIndexOf("aabaabaa", "", 1)   = 0
+	 * StrUtil.ordinalIndexOf("aabaabaa", "", 2)   = 0
+	 *
+ * + * @param str 被检查的字符串，可以为null + * @param searchStr 被查找的字符串，可以为null + * @param ordinal 第几次出现的位置 + * @return 查找到的位置 + * @since 3.2.3 + */ + public static int ordinalIndexOf(CharSequence str, CharSequence searchStr, int ordinal) { + if (str == null || searchStr == null || ordinal <= 0) { + return INDEX_NOT_FOUND; + } + if (searchStr.length() == 0) { + return 0; + } + int found = 0; + int index = INDEX_NOT_FOUND; + do { + index = indexOf(str, searchStr, index + 1, false); + if (index < 0) { + return index; + } + found++; + } while (found < ordinal); + return index; + } + + // ------------------------------------------------------------------------ remove + + /** + * 移除字符串中所有给定字符串
+ * 例：removeAll("aa-bb-cc-dd", "-") =》 aabbccdd + * + * @param str 字符串 + * @param strToRemove 被移除的字符串 + * @return 移除后的字符串 + */ + public static String removeAll(CharSequence str, CharSequence strToRemove) { + // strToRemove如果为空， 也不用继续后面的逻辑 + if (isEmpty(str) || isEmpty(strToRemove)) { + return str(str); + } + return str.toString().replace(strToRemove, EMPTY); + } + + /** + * 移除字符串中所有给定字符串，当某个字符串出现多次，则全部移除
+ * 例：removeAny("aa-bb-cc-dd", "a", "b") =》 --cc-dd + * + * @param str 字符串 + * @param strsToRemove 被移除的字符串 + * @return 移除后的字符串 + * @since 5.3.8 + */ + public static String removeAny(CharSequence str, CharSequence... strsToRemove) { + String result = str(str); + if (isNotEmpty(str)) { + for (CharSequence strToRemove : strsToRemove) { + result = removeAll(result, strToRemove); + } + } + return result; + } + + /** + * 去除字符串中指定的多个字符，如有多个则全部去除 + * + * @param str 字符串 + * @param chars 字符列表 + * @return 去除后的字符 + * @since 4.2.2 + */ + public static String removeAll(CharSequence str, char... chars) { + if (null == str || ArrayUtil.isEmpty(chars)) { + return str(str); + } + final int len = str.length(); + if (0 == len) { + return str(str); + } + final StringBuilder builder = new StringBuilder(len); + char c; + for (int i = 0; i < len; i++) { + c = str.charAt(i); + if (false == ArrayUtil.contains(chars, c)) { + builder.append(c); + } + } + return builder.toString(); + } + + /** + * 去除所有换行符，包括： + * + * 
+	 * 1. \r
+	 * 1. \n
+	 *
+ * + * @param str 字符串 + * @return 处理后的字符串 + * @since 4.2.2 + */ + public static String removeAllLineBreaks(CharSequence str) { + return removeAll(str, CharUtil.CR, CharUtil.LF); + } + + /** + * 去掉首部指定长度的字符串并将剩余字符串首字母小写
+ * 例如：str=setName, preLength=3 =》 return name + * + * @param str 被处理的字符串 + * @param preLength 去掉的长度 + * @return 处理后的字符串，不符合规范返回null + */ + public static String removePreAndLowerFirst(CharSequence str, int preLength) { + if (str == null) { + return null; + } + if (str.length() > preLength) { + char first = Character.toLowerCase(str.charAt(preLength)); + if (str.length() > preLength + 1) { + return first + str.toString().substring(preLength + 1); + } + return String.valueOf(first); + } else { + return str.toString(); + } + } + + /** + * 去掉首部指定长度的字符串并将剩余字符串首字母小写
+ * 例如：str=setName, prefix=set =》 return name + * + * @param str 被处理的字符串 + * @param prefix 前缀 + * @return 处理后的字符串，不符合规范返回null + */ + public static String removePreAndLowerFirst(CharSequence str, CharSequence prefix) { + return lowerFirst(removePrefix(str, prefix)); + } + + /** + * 去掉指定前缀 + * + * @param str 字符串 + * @param prefix 前缀 + * @return 切掉后的字符串，若前缀不是 preffix， 返回原字符串 + */ + public static String removePrefix(CharSequence str, CharSequence prefix) { + if (isEmpty(str) || isEmpty(prefix)) { + return str(str); + } + + final String str2 = str.toString(); + if (str2.startsWith(prefix.toString())) { + return subSuf(str2, prefix.length());// 截取后半段 + } + return str2; + } + + /** + * 忽略大小写去掉指定前缀 + * + * @param str 字符串 + * @param prefix 前缀 + * @return 切掉后的字符串，若前缀不是 prefix， 返回原字符串 + */ + public static String removePrefixIgnoreCase(CharSequence str, CharSequence prefix) { + if (isEmpty(str) || isEmpty(prefix)) { + return str(str); + } + + final String str2 = str.toString(); + if (startWithIgnoreCase(str, prefix)) { + return subSuf(str2, prefix.length());// 截取后半段 + } + return str2; + } + + /** + * 去掉指定后缀 + * + * @param str 字符串 + * @param suffix 后缀 + * @return 切掉后的字符串，若后缀不是 suffix， 返回原字符串 + */ + public static String removeSuffix(CharSequence str, CharSequence suffix) { + if (isEmpty(str) || isEmpty(suffix)) { + return str(str); + } + + final String str2 = str.toString(); + if (str2.endsWith(suffix.toString())) { + return subPre(str2, str2.length() - suffix.length());// 截取前半段 + } + return str2; + } + + /** + * 去掉指定后缀，并小写首字母 + * + * @param str 字符串 + * @param suffix 后缀 + * @return 切掉后的字符串，若后缀不是 suffix， 返回原字符串 + */ + public static String removeSufAndLowerFirst(CharSequence str, CharSequence suffix) { + return lowerFirst(removeSuffix(str, suffix)); + } + + /** + * 忽略大小写去掉指定后缀 + * + * @param str 字符串 + * @param suffix 后缀 + * @return 切掉后的字符串，若后缀不是 suffix， 返回原字符串 + */ + public static String removeSuffixIgnoreCase(CharSequence str, CharSequence suffix) { + if (isEmpty(str) || isEmpty(suffix)) { + return str(str); + } + + final String str2 = str.toString(); + if (endWithIgnoreCase(str, suffix)) { + return subPre(str2, str2.length() - suffix.length()); + } + return str2; + } + + /** + * 清理空白字符 + * + * @param str 被清理的字符串 + * @return 清理后的字符串 + */ + public static String cleanBlank(CharSequence str) { + return filter(str, c -> false == CharUtil.isBlankChar(c)); + } + + // ------------------------------------------------------------------------ strip + + /** + * 去除两边的指定字符串 + * + * @param str 被处理的字符串 + * @param prefixOrSuffix 前缀或后缀 + * @return 处理后的字符串 + * @since 3.1.2 + */ + public static String strip(CharSequence str, CharSequence prefixOrSuffix) { + if (equals(str, prefixOrSuffix)) { + // 对于去除相同字符的情况单独处理 + return EMPTY; + } + return strip(str, prefixOrSuffix, prefixOrSuffix); + } + + /** + * 去除两边的指定字符串 + * + * @param str 被处理的字符串 + * @param prefix 前缀 + * @param suffix 后缀 + * @return 处理后的字符串 + * @since 3.1.2 + */ + public static String strip(CharSequence str, CharSequence prefix, CharSequence suffix) { + if (isEmpty(str)) { + return str(str); + } + + int from = 0; + int to = str.length(); + + String str2 = str.toString(); + if (startWith(str2, prefix)) { + from = prefix.length(); + } + if (endWith(str2, suffix)) { + to -= suffix.length(); + } + + return str2.substring(Math.min(from, to), Math.max(from, to)); + } + + /** + * 去除两边的指定字符串，忽略大小写 + * + * @param str 被处理的字符串 + * @param prefixOrSuffix 前缀或后缀 + * @return 处理后的字符串 + * @since 3.1.2 + */ + public static String stripIgnoreCase(CharSequence str, CharSequence prefixOrSuffix) { + return stripIgnoreCase(str, prefixOrSuffix, prefixOrSuffix); + } + + /** + * 去除两边的指定字符串，忽略大小写 + * + * @param str 被处理的字符串 + * @param prefix 前缀 + * @param suffix 后缀 + * @return 处理后的字符串 + * @since 3.1.2 + */ + public static String stripIgnoreCase(CharSequence str, CharSequence prefix, CharSequence suffix) { + if (isEmpty(str)) { + return str(str); + } + int from = 0; + int to = str.length(); + + String str2 = str.toString(); + if (startWithIgnoreCase(str2, prefix)) { + from = prefix.length(); + } + if (endWithIgnoreCase(str2, suffix)) { + to -= suffix.length(); + } + return str2.substring(from, to); + } + + // ------------------------------------------------------------------------ add + + /** + * 如果给定字符串不是以prefix开头的，在开头补充 prefix + * + * @param str 字符串 + * @param prefix 前缀 + * @return 补充后的字符串 + * @see #prependIfMissing(CharSequence, CharSequence, CharSequence...) + */ + public static String addPrefixIfNot(CharSequence str, CharSequence prefix) { + return prependIfMissing(str, prefix, prefix); + } + + /** + * 如果给定字符串不是以suffix结尾的，在尾部补充 suffix + * + * @param str 字符串 + * @param suffix 后缀 + * @return 补充后的字符串 + * @see #appendIfMissing(CharSequence, CharSequence, CharSequence...) + */ + public static String addSuffixIfNot(CharSequence str, CharSequence suffix) { + return appendIfMissing(str, suffix, suffix); + } + + // ------------------------------------------------------------------------ split + + /** + * 切分字符串为long数组 + * + * @param str 被切分的字符串 + * @param separator 分隔符 + * @return 切分后long数组 + * @since 4.0.6 + */ + public static long[] splitToLong(CharSequence str, char separator) { + return Convert.convert(long[].class, splitTrim(str, separator)); + } + + /** + * 切分字符串为long数组 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符串 + * @return 切分后long数组 + * @since 4.0.6 + */ + public static long[] splitToLong(CharSequence str, CharSequence separator) { + return Convert.convert(long[].class, splitTrim(str, separator)); + } + + /** + * 切分字符串为int数组 + * + * @param str 被切分的字符串 + * @param separator 分隔符 + * @return 切分后long数组 + * @since 4.0.6 + */ + public static int[] splitToInt(CharSequence str, char separator) { + return Convert.convert(int[].class, splitTrim(str, separator)); + } + + /** + * 切分字符串为int数组 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符串 + * @return 切分后long数组 + * @since 4.0.6 + */ + public static int[] splitToInt(CharSequence str, CharSequence separator) { + return Convert.convert(int[].class, splitTrim(str, separator)); + } + + /** + * 切分字符串
+ * a#b#c =》 [a,b,c]
+ * a##b#c =》 [a,"",b,c] + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @return 切分后的集合 + */ + public static List split(CharSequence str, char separator) { + return split(str, separator, 0); + } + + /** + * 切分字符串，如果分隔符不存在则返回原字符串 + * + * @param str 被切分的字符串 + * @param separator 分隔符 + * @return 字符串 + * @since 5.6.7 + */ + public static String[] splitToArray(CharSequence str, CharSequence separator) { + if (str == null) { + return new String[]{}; + } + + return StrSplitter.splitToArray(str.toString(), str(separator), 0, false, false); + } + + /** + * 切分字符串 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @return 切分后的数组 + */ + public static String[] splitToArray(CharSequence str, char separator) { + return splitToArray(str, separator, 0); + } + + /** + * 切分字符串 + * + * @param text 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数 + * @return 切分后的数组 + */ + public static String[] splitToArray(CharSequence text, char separator, int limit) { + Assert.notNull(text, "Text must be not null!"); + return StrSplitter.splitToArray(text.toString(), separator, limit, false, false); + } + + /** + * 切分字符串，不去除切分后每个元素两边的空白符，不去除空白项 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数，-1不限制 + * @return 切分后的集合 + */ + public static List split(CharSequence str, char separator, int limit) { + return split(str, separator, limit, false, false); + } + + /** + * 切分字符串，去除切分后每个元素两边的空白符，去除空白项 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @return 切分后的集合 + * @since 3.1.2 + */ + public static List splitTrim(CharSequence str, char separator) { + return splitTrim(str, separator, -1); + } + + /** + * 切分字符串，去除切分后每个元素两边的空白符，去除空白项 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @return 切分后的集合 + * @since 3.2.0 + */ + public static List splitTrim(CharSequence str, CharSequence separator) { + return splitTrim(str, separator, -1); + } + + /** + * 切分字符串，去除切分后每个元素两边的空白符，去除空白项 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数，-1不限制 + * @return 切分后的集合 + * @since 3.1.0 + */ + public static List splitTrim(CharSequence str, char separator, int limit) { + return split(str, separator, limit, true, true); + } + + /** + * 切分字符串，去除切分后每个元素两边的空白符，去除空白项 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数，-1不限制 + * @return 切分后的集合 + * @since 3.2.0 + */ + public static List splitTrim(CharSequence str, CharSequence separator, int limit) { + return split(str, separator, limit, true, true); + } + + /** + * 切分字符串，不限制分片数量 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static List split(CharSequence str, char separator, boolean isTrim, boolean ignoreEmpty) { + return split(str, separator, 0, isTrim, ignoreEmpty); + } + + /** + * 切分字符串 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数，-1不限制 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static List split(CharSequence str, char separator, int limit, boolean isTrim, boolean ignoreEmpty) { + return StrSplitter.split(str, separator, limit, isTrim, ignoreEmpty); + } + + /** + * 切分字符串 + * + * @param 切分后元素类型 + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数，-1不限制 + * @param ignoreEmpty 是否忽略空串 + * @param mapping 切分后的字符串元素的转换方法 + * @return 切分后的集合，元素类型是经过 mapping 转换后的 + * @since 5.7.14 + */ + public static List split(CharSequence str, char separator, int limit, boolean ignoreEmpty, Function mapping) { + return StrSplitter.split(str, separator, limit, ignoreEmpty, mapping); + } + + /** + * 切分字符串，如果分隔符不存在则返回原字符串 + * + * @param str 被切分的字符串 + * @param separator 分隔符 + * @return 字符串 + * @since 5.7.1 + */ + public static List split(CharSequence str, CharSequence separator) { + return split(str, separator, false, false); + } + + /** + * 切分字符串 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 5.6.7 + */ + public static List split(CharSequence str, CharSequence separator, boolean isTrim, boolean ignoreEmpty) { + return split(str, separator, 0, isTrim, ignoreEmpty); + } + + /** + * 切分字符串 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数，-1不限制 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.2.0 + */ + public static List split(CharSequence str, CharSequence separator, int limit, boolean isTrim, boolean ignoreEmpty) { + final String separatorStr = (null == separator) ? null : separator.toString(); + return StrSplitter.split(str, separatorStr, limit, isTrim, ignoreEmpty); + } + + /** + * 根据给定长度，将给定字符串截取为多个部分 + * + * @param str 字符串 + * @param len 每一个小节的长度 + * @return 截取后的字符串数组 + * @see StrSplitter#splitByLength(CharSequence, int) + */ + public static String[] split(CharSequence str, int len) { + return StrSplitter.splitByLength(str, len); + } + + /** + * 将字符串切分为N等份 + * + * @param str 字符串 + * @param partLength 每等份的长度 + * @return 切分后的数组 + * @since 3.0.6 + */ + public static String[] cut(CharSequence str, int partLength) { + if (null == str) { + return null; + } + int len = str.length(); + if (len < partLength) { + return new String[]{str.toString()}; + } + int part = NumberUtil.count(len, partLength); + final String[] array = new String[part]; + + final String str2 = str.toString(); + for (int i = 0; i < part; i++) { + array[i] = str2.substring(i * partLength, (i == part - 1) ? len : (partLength + i * partLength)); + } + return array; + } + + // ------------------------------------------------------------------------ sub + + /** + * 改进JDK subString
+ * index从0开始计算，最后一个字符为-1
+ * 如果from和to位置一样，返回 ""
+ * 如果from或to为负数，则按照length从后向前数位置，如果绝对值大于字符串长度，则from归到0，to归到length
+ * 如果经过修正的index中from大于to，则互换from和to example:
+ * abcdefgh 2 3 =》 c
+ * abcdefgh 2 -3 =》 cde
+ * + * @param str String + * @param fromIndexInclude 开始的index（包括） + * @param toIndexExclude 结束的index（不包括） + * @return 字串 + */ + public static String sub(CharSequence str, int fromIndexInclude, int toIndexExclude) { + if (isEmpty(str)) { + return str(str); + } + int len = str.length(); + + if (fromIndexInclude < 0) { + fromIndexInclude = len + fromIndexInclude; + if (fromIndexInclude < 0) { + fromIndexInclude = 0; + } + } else if (fromIndexInclude > len) { + fromIndexInclude = len; + } + + if (toIndexExclude < 0) { + toIndexExclude = len + toIndexExclude; + if (toIndexExclude < 0) { + toIndexExclude = len; + } + } else if (toIndexExclude > len) { + toIndexExclude = len; + } + + if (toIndexExclude < fromIndexInclude) { + int tmp = fromIndexInclude; + fromIndexInclude = toIndexExclude; + toIndexExclude = tmp; + } + + if (fromIndexInclude == toIndexExclude) { + return EMPTY; + } + + return str.toString().substring(fromIndexInclude, toIndexExclude); + } + + /** + * 通过CodePoint截取字符串，可以截断Emoji + * + * @param str String + * @param fromIndex 开始的index（包括） + * @param toIndex 结束的index（不包括） + * @return 字串 + */ + public static String subByCodePoint(CharSequence str, int fromIndex, int toIndex) { + if (isEmpty(str)) { + return str(str); + } + + if (fromIndex < 0 || fromIndex > toIndex) { + throw new IllegalArgumentException(); + } + + if (fromIndex == toIndex) { + return EMPTY; + } + + final StringBuilder sb = new StringBuilder(); + final int subLen = toIndex - fromIndex; + str.toString().codePoints().skip(fromIndex).limit(subLen).forEach(v -> sb.append(Character.toChars(v))); + return sb.toString(); + } + + /** + * 截取部分字符串，这里一个汉字的长度认为是2 + * + * @param str 字符串 + * @param len bytes切割到的位置（包含） + * @param suffix 切割后加上后缀 + * @return 切割后的字符串 + * @since 3.1.1 + */ + public static String subPreGbk(CharSequence str, int len, CharSequence suffix) { + return subPreGbk(str, len, true) + suffix; + } + + /** + * 截取部分字符串，这里一个汉字的长度认为是2
+ * 可以自定义halfUp，如len为10，如果截取后最后一个字符是半个字符，{@code true}表示保留，则长度是11，否则长度9 + * + * @param str 字符串 + * @param len bytes切割到的位置（包含） + * @param halfUp 遇到截取一半的GBK字符，是否保留。 + * @return 切割后的字符串 + * @since 5.7.17 + */ + public static String subPreGbk(CharSequence str, int len, boolean halfUp) { + if (isEmpty(str)) { + return str(str); + } + + int counterOfDoubleByte = 0; + final byte[] b = bytes(str, CharsetUtil.CHARSET_GBK); + if (b.length <= len) { + return str.toString(); + } + for (int i = 0; i < len; i++) { + if (b[i] < 0) { + counterOfDoubleByte++; + } + } + + if (counterOfDoubleByte % 2 != 0) { + if (halfUp) { + len += 1; + } else { + len -= 1; + } + } + return new String(b, 0, len, CharsetUtil.CHARSET_GBK); + } + + /** + * 切割指定位置之前部分的字符串 + * + * @param string 字符串 + * @param toIndexExclude 切割到的位置（不包括） + * @return 切割后的剩余的前半部分字符串 + */ + public static String subPre(CharSequence string, int toIndexExclude) { + return sub(string, 0, toIndexExclude); + } + + /** + * 切割指定位置之后部分的字符串 + * + * @param string 字符串 + * @param fromIndex 切割开始的位置（包括） + * @return 切割后后剩余的后半部分字符串 + */ + public static String subSuf(CharSequence string, int fromIndex) { + if (isEmpty(string)) { + return null; + } + return sub(string, fromIndex, string.length()); + } + + /** + * 切割指定长度的后部分的字符串 + * + * 
+	 * StrUtil.subSufByLength("abcde", 3)      =    "cde"
+	 * StrUtil.subSufByLength("abcde", 0)      =    ""
+	 * StrUtil.subSufByLength("abcde", -5)     =    ""
+	 * StrUtil.subSufByLength("abcde", -1)     =    ""
+	 * StrUtil.subSufByLength("abcde", 5)       =    "abcde"
+	 * StrUtil.subSufByLength("abcde", 10)     =    "abcde"
+	 * StrUtil.subSufByLength(null, 3)               =    null
+	 *
+ * + * @param string 字符串 + * @param length 切割长度 + * @return 切割后后剩余的后半部分字符串 + * @since 4.0.1 + */ + public static String subSufByLength(CharSequence string, int length) { + if (isEmpty(string)) { + return null; + } + if (length <= 0) { + return EMPTY; + } + return sub(string, -length, string.length()); + } + + /** + * 截取字符串,从指定位置开始,截取指定长度的字符串
+ * 如果fromIndex为正数，则向后截取指定length长度，如果为负数，则向前截取length长度。 + * + * @param input 原始字符串 + * @param fromIndex 开始的index,包括 + * @param length 要截取的长度 + * @return 截取后的字符串 + * @author weibaohui + */ + public static String subWithLength(String input, int fromIndex, int length) { + final int toIndex; + if(fromIndex < 0){ + toIndex = fromIndex - length; + }else{ + toIndex = fromIndex + length; + } + return sub(input, fromIndex, toIndex); + } + + /** + * 截取分隔字符串之前的字符串，不包括分隔字符串
+ * 如果给定的字符串为空串（null或""）或者分隔字符串为null，返回原字符串
+ * 如果分隔字符串为空串""，则返回空串，如果分隔字符串未找到，返回原字符串，举例如下： + * + * 
+	 * StrUtil.subBefore(null, *, false)      = null
+	 * StrUtil.subBefore("", *, false)        = ""
+	 * StrUtil.subBefore("abc", "a", false)   = ""
+	 * StrUtil.subBefore("abcba", "b", false) = "a"
+	 * StrUtil.subBefore("abc", "c", false)   = "ab"
+	 * StrUtil.subBefore("abc", "d", false)   = "abc"
+	 * StrUtil.subBefore("abc", "", false)    = ""
+	 * StrUtil.subBefore("abc", null, false)  = "abc"
+	 *
+ * + * @param string 被查找的字符串 + * @param separator 分隔字符串（不包括） + * @param isLastSeparator 是否查找最后一个分隔字符串（多次出现分隔字符串时选取最后一个），true为选取最后一个 + * @return 切割后的字符串 + * @since 3.1.1 + */ + public static String subBefore(CharSequence string, CharSequence separator, boolean isLastSeparator) { + if (isEmpty(string) || separator == null) { + return null == string ? null : string.toString(); + } + + final String str = string.toString(); + final String sep = separator.toString(); + if (sep.isEmpty()) { + return EMPTY; + } + final int pos = isLastSeparator ? str.lastIndexOf(sep) : str.indexOf(sep); + if (INDEX_NOT_FOUND == pos) { + return str; + } + if (0 == pos) { + return EMPTY; + } + return str.substring(0, pos); + } + + /** + * 截取分隔字符串之前的字符串，不包括分隔字符串
+ * 如果给定的字符串为空串（null或""）或者分隔字符串为null，返回原字符串
+ * 如果分隔字符串未找到，返回原字符串，举例如下： + * + * 
+	 * StrUtil.subBefore(null, *, false)      = null
+	 * StrUtil.subBefore("", *, false)        = ""
+	 * StrUtil.subBefore("abc", 'a', false)   = ""
+	 * StrUtil.subBefore("abcba", 'b', false) = "a"
+	 * StrUtil.subBefore("abc", 'c', false)   = "ab"
+	 * StrUtil.subBefore("abc", 'd', false)   = "abc"
+	 *
+ * + * @param string 被查找的字符串 + * @param separator 分隔字符串（不包括） + * @param isLastSeparator 是否查找最后一个分隔字符串（多次出现分隔字符串时选取最后一个），true为选取最后一个 + * @return 切割后的字符串 + * @since 4.1.15 + */ + public static String subBefore(CharSequence string, char separator, boolean isLastSeparator) { + if (isEmpty(string)) { + return null == string ? null : EMPTY; + } + + final String str = string.toString(); + final int pos = isLastSeparator ? str.lastIndexOf(separator) : str.indexOf(separator); + if (INDEX_NOT_FOUND == pos) { + return str; + } + if (0 == pos) { + return EMPTY; + } + return str.substring(0, pos); + } + + /** + * 截取分隔字符串之后的字符串，不包括分隔字符串
+ * 如果给定的字符串为空串（null或""），返回原字符串
+ * 如果分隔字符串为空串（null或""），则返回空串，如果分隔字符串未找到，返回空串，举例如下： + * + * 
+	 * StrUtil.subAfter(null, *, false)      = null
+	 * StrUtil.subAfter("", *, false)        = ""
+	 * StrUtil.subAfter(*, null, false)      = ""
+	 * StrUtil.subAfter("abc", "a", false)   = "bc"
+	 * StrUtil.subAfter("abcba", "b", false) = "cba"
+	 * StrUtil.subAfter("abc", "c", false)   = ""
+	 * StrUtil.subAfter("abc", "d", false)   = ""
+	 * StrUtil.subAfter("abc", "", false)    = "abc"
+	 *
+ * + * @param string 被查找的字符串 + * @param separator 分隔字符串（不包括） + * @param isLastSeparator 是否查找最后一个分隔字符串（多次出现分隔字符串时选取最后一个），true为选取最后一个 + * @return 切割后的字符串 + * @since 3.1.1 + */ + public static String subAfter(CharSequence string, CharSequence separator, boolean isLastSeparator) { + if (isEmpty(string)) { + return null == string ? null : EMPTY; + } + if (separator == null) { + return EMPTY; + } + final String str = string.toString(); + final String sep = separator.toString(); + final int pos = isLastSeparator ? str.lastIndexOf(sep) : str.indexOf(sep); + if (INDEX_NOT_FOUND == pos || (string.length() - 1) == pos) { + return EMPTY; + } + return str.substring(pos + separator.length()); + } + + /** + * 截取分隔字符串之后的字符串，不包括分隔字符串
+ * 如果给定的字符串为空串（null或""），返回原字符串
+ * 如果分隔字符串为空串（null或""），则返回空串，如果分隔字符串未找到，返回空串，举例如下： + * + * 
+	 * StrUtil.subAfter(null, *, false)      = null
+	 * StrUtil.subAfter("", *, false)        = ""
+	 * StrUtil.subAfter("abc", 'a', false)   = "bc"
+	 * StrUtil.subAfter("abcba", 'b', false) = "cba"
+	 * StrUtil.subAfter("abc", 'c', false)   = ""
+	 * StrUtil.subAfter("abc", 'd', false)   = ""
+	 *
+ * + * @param string 被查找的字符串 + * @param separator 分隔字符串（不包括） + * @param isLastSeparator 是否查找最后一个分隔字符串（多次出现分隔字符串时选取最后一个），true为选取最后一个 + * @return 切割后的字符串 + * @since 4.1.15 + */ + public static String subAfter(CharSequence string, char separator, boolean isLastSeparator) { + if (isEmpty(string)) { + return null == string ? null : EMPTY; + } + final String str = string.toString(); + final int pos = isLastSeparator ? str.lastIndexOf(separator) : str.indexOf(separator); + if (INDEX_NOT_FOUND == pos) { + return EMPTY; + } + return str.substring(pos + 1); + } + + /** + * 截取指定字符串中间部分，不包括标识字符串
+ *

+ * 栗子： + * + * 

+	 * StrUtil.subBetween("wx[b]yz", "[", "]") = "b"
+	 * StrUtil.subBetween(null, *, *)          = null
+	 * StrUtil.subBetween(*, null, *)          = null
+	 * StrUtil.subBetween(*, *, null)          = null
+	 * StrUtil.subBetween("", "", "")          = ""
+	 * StrUtil.subBetween("", "", "]")         = null
+	 * StrUtil.subBetween("", "[", "]")        = null
+	 * StrUtil.subBetween("yabcz", "", "")     = ""
+	 * StrUtil.subBetween("yabcz", "y", "z")   = "abc"
+	 * StrUtil.subBetween("yabczyabcz", "y", "z")   = "abc"
+	 *
+ * + * @param str 被切割的字符串 + * @param before 截取开始的字符串标识 + * @param after 截取到的字符串标识 + * @return 截取后的字符串 + * @since 3.1.1 + */ + public static String subBetween(CharSequence str, CharSequence before, CharSequence after) { + if (str == null || before == null || after == null) { + return null; + } + + final String str2 = str.toString(); + final String before2 = before.toString(); + final String after2 = after.toString(); + + final int start = str2.indexOf(before2); + if (start != INDEX_NOT_FOUND) { + final int end = str2.indexOf(after2, start + before2.length()); + if (end != INDEX_NOT_FOUND) { + return str2.substring(start + before2.length(), end); + } + } + return null; + } + + /** + * 截取指定字符串中间部分，不包括标识字符串
+ *

+ * 栗子： + * + * 

+	 * StrUtil.subBetween(null, *)            = null
+	 * StrUtil.subBetween("", "")             = ""
+	 * StrUtil.subBetween("", "tag")          = null
+	 * StrUtil.subBetween("tagabctag", null)  = null
+	 * StrUtil.subBetween("tagabctag", "")    = ""
+	 * StrUtil.subBetween("tagabctag", "tag") = "abc"
+	 *
+ * + * @param str 被切割的字符串 + * @param beforeAndAfter 截取开始和结束的字符串标识 + * @return 截取后的字符串 + * @since 3.1.1 + */ + public static String subBetween(CharSequence str, CharSequence beforeAndAfter) { + return subBetween(str, beforeAndAfter, beforeAndAfter); + } + + /** + * 截取指定字符串多段中间部分，不包括标识字符串
+ *

+ * 栗子： + * + * 

+	 * StrUtil.subBetweenAll("wx[b]y[z]", "[", "]") 		= ["b","z"]
+	 * StrUtil.subBetweenAll(null, *, *)          			= []
+	 * StrUtil.subBetweenAll(*, null, *)          			= []
+	 * StrUtil.subBetweenAll(*, *, null)          			= []
+	 * StrUtil.subBetweenAll("", "", "")          			= []
+	 * StrUtil.subBetweenAll("", "", "]")         			= []
+	 * StrUtil.subBetweenAll("", "[", "]")        			= []
+	 * StrUtil.subBetweenAll("yabcz", "", "")     			= []
+	 * StrUtil.subBetweenAll("yabcz", "y", "z")   			= ["abc"]
+	 * StrUtil.subBetweenAll("yabczyabcz", "y", "z")   		= ["abc","abc"]
+	 * StrUtil.subBetweenAll("[yabc[zy]abcz]", "[", "]");   = ["zy"]           重叠时只截取内部，
+	 *
+ * + * @param str 被切割的字符串 + * @param prefix 截取开始的字符串标识 + * @param suffix 截取到的字符串标识 + * @return 截取后的字符串 + * @author dahuoyzs + * @since 5.2.5 + */ + public static String[] subBetweenAll(CharSequence str, CharSequence prefix, CharSequence suffix) { + if (hasEmpty(str, prefix, suffix) || + // 不包含起始字符串，则肯定没有子串 + false == contains(str, prefix)) { + return new String[0]; + } + + final List result = new LinkedList<>(); + final String[] split = splitToArray(str, prefix); + if (prefix.equals(suffix)) { + // 前后缀字符相同，单独处理 + for (int i = 1, length = split.length - 1; i < length; i += 2) { + result.add(split[i]); + } + } else { + int suffixIndex; + String fragment; + for (int i = 1; i < split.length; i++) { + fragment = split[i]; + suffixIndex = fragment.indexOf(suffix.toString()); + if (suffixIndex > 0) { + result.add(fragment.substring(0, suffixIndex)); + } + } + } + + return result.toArray(new String[0]); + } + + /** + * 截取指定字符串多段中间部分，不包括标识字符串
+ *

+ * 栗子： + * + * 

+	 * StrUtil.subBetweenAll(null, *)          			= []
+	 * StrUtil.subBetweenAll(*, null)          			= []
+	 * StrUtil.subBetweenAll(*, *)          			= []
+	 * StrUtil.subBetweenAll("", "")          			= []
+	 * StrUtil.subBetweenAll("", "#")         			= []
+	 * StrUtil.subBetweenAll("gotanks", "")     		= []
+	 * StrUtil.subBetweenAll("#gotanks#", "#")   		= ["gotanks"]
+	 * StrUtil.subBetweenAll("#hello# #world#!", "#")   = ["hello", "world"]
+	 * StrUtil.subBetweenAll("#hello# world#!", "#");   = ["hello"]
+	 *
+ * + * @param str 被切割的字符串 + * @param prefixAndSuffix 截取开始和结束的字符串标识 + * @return 截取后的字符串 + * @author gotanks + * @since 5.5.0 + */ + public static String[] subBetweenAll(CharSequence str, CharSequence prefixAndSuffix) { + return subBetweenAll(str, prefixAndSuffix, prefixAndSuffix); + } + + // ------------------------------------------------------------------------ repeat + + /** + * 重复某个字符 + * + * 
+	 * StrUtil.repeat('e', 0)  = ""
+	 * StrUtil.repeat('e', 3)  = "eee"
+	 * StrUtil.repeat('e', -2) = ""
+	 *
+ * + * @param c 被重复的字符 + * @param count 重复的数目，如果小于等于0则返回"" + * @return 重复字符字符串 + */ + public static String repeat(char c, int count) { + if (count <= 0) { + return EMPTY; + } + + char[] result = new char[count]; + for (int i = 0; i < count; i++) { + result[i] = c; + } + return new String(result); + } + + /** + * 重复某个字符串 + * + * @param str 被重复的字符 + * @param count 重复的数目 + * @return 重复字符字符串 + */ + public static String repeat(CharSequence str, int count) { + if (null == str) { + return null; + } + if (count <= 0 || str.length() == 0) { + return EMPTY; + } + if (count == 1) { + return str.toString(); + } + + // 检查 + final int len = str.length(); + final long longSize = (long) len * (long) count; + final int size = (int) longSize; + if (size != longSize) { + throw new ArrayIndexOutOfBoundsException("Required String length is too large: " + longSize); + } + + final char[] array = new char[size]; + str.toString().getChars(0, len, array, 0); + int n; + for (n = len; n < size - n; n <<= 1) {// n <<= 1相当于n *2 + System.arraycopy(array, 0, array, n, n); + } + System.arraycopy(array, 0, array, n, size - n); + return new String(array); + } + + /** + * 重复某个字符串到指定长度 + * + * @param str 被重复的字符 + * @param padLen 指定长度 + * @return 重复字符字符串 + * @since 4.3.2 + */ + public static String repeatByLength(CharSequence str, int padLen) { + if (null == str) { + return null; + } + if (padLen <= 0) { + return StrUtil.EMPTY; + } + final int strLen = str.length(); + if (strLen == padLen) { + return str.toString(); + } else if (strLen > padLen) { + return subPre(str, padLen); + } + + // 重复，直到达到指定长度 + final char[] padding = new char[padLen]; + for (int i = 0; i < padLen; i++) { + padding[i] = str.charAt(i % strLen); + } + return new String(padding); + } + + /** + * 重复某个字符串并通过分界符连接 + * + * 
+	 * StrUtil.repeatAndJoin("?", 5, ",")   = "?,?,?,?,?"
+	 * StrUtil.repeatAndJoin("?", 0, ",")   = ""
+	 * StrUtil.repeatAndJoin("?", 5, null) = "?????"
+	 *
+ * + * @param str 被重复的字符串 + * @param count 数量 + * @param delimiter 分界符 + * @return 连接后的字符串 + * @since 4.0.1 + */ + public static String repeatAndJoin(CharSequence str, int count, CharSequence delimiter) { + if (count <= 0) { + return EMPTY; + } + final StringBuilder builder = new StringBuilder(str.length() * count); + builder.append(str); + count--; + + final boolean isAppendDelimiter = isNotEmpty(delimiter); + while (count-- > 0) { + if (isAppendDelimiter) { + builder.append(delimiter); + } + builder.append(str); + } + return builder.toString(); + } + + // ------------------------------------------------------------------------ equals + + /** + * 比较两个字符串（大小写敏感）。 + * + * 
+	 * equals(null, null)   = true
+	 * equals(null, "abc")  = false
+	 * equals("abc", null)  = false
+	 * equals("abc", "abc") = true
+	 * equals("abc", "ABC") = false
+	 *
+ * + * @param str1 要比较的字符串1 + * @param str2 要比较的字符串2 + * @return 如果两个字符串相同，或者都是{@code null}，则返回{@code true} + */ + public static boolean equals(CharSequence str1, CharSequence str2) { + return equals(str1, str2, false); + } + + /** + * 比较两个字符串（大小写不敏感）。 + * + * 
+	 * equalsIgnoreCase(null, null)   = true
+	 * equalsIgnoreCase(null, "abc")  = false
+	 * equalsIgnoreCase("abc", null)  = false
+	 * equalsIgnoreCase("abc", "abc") = true
+	 * equalsIgnoreCase("abc", "ABC") = true
+	 *
+ * + * @param str1 要比较的字符串1 + * @param str2 要比较的字符串2 + * @return 如果两个字符串相同，或者都是{@code null}，则返回{@code true} + */ + public static boolean equalsIgnoreCase(CharSequence str1, CharSequence str2) { + return equals(str1, str2, true); + } + + /** + * 比较两个字符串是否相等，规则如下 + *
    + *
  • str1和str2都为{@code null}
    • + *
  • 忽略大小写使用{@link String#equalsIgnoreCase(String)}判断相等
    • + *
  • 不忽略大小写使用{@link String#contentEquals(CharSequence)}判断相等
    • + *
+ * + * @param str1 要比较的字符串1 + * @param str2 要比较的字符串2 + * @param ignoreCase 是否忽略大小写 + * @return 如果两个字符串相同，或者都是{@code null}，则返回{@code true} + * @since 3.2.0 + */ + public static boolean equals(CharSequence str1, CharSequence str2, boolean ignoreCase) { + if (null == str1) { + // 只有两个都为null才判断相等 + return str2 == null; + } + if (null == str2) { + // 字符串2空，字符串1非空，直接false + return false; + } + + if (ignoreCase) { + return str1.toString().equalsIgnoreCase(str2.toString()); + } else { + return str1.toString().contentEquals(str2); + } + } + + /** + * 给定字符串是否与提供的中任一字符串相同（忽略大小写），相同则返回{@code true}，没有相同的返回{@code false}
+ * 如果参与比对的字符串列表为空，返回{@code false} + * + * @param str1 给定需要检查的字符串 + * @param strs 需要参与比对的字符串列表 + * @return 是否相同 + * @since 4.3.2 + */ + public static boolean equalsAnyIgnoreCase(CharSequence str1, CharSequence... strs) { + return equalsAny(str1, true, strs); + } + + /** + * 给定字符串是否与提供的中任一字符串相同，相同则返回{@code true}，没有相同的返回{@code false}
+ * 如果参与比对的字符串列表为空，返回{@code false} + * + * @param str1 给定需要检查的字符串 + * @param strs 需要参与比对的字符串列表 + * @return 是否相同 + * @since 4.3.2 + */ + public static boolean equalsAny(CharSequence str1, CharSequence... strs) { + return equalsAny(str1, false, strs); + } + + /** + * 给定字符串是否与提供的中任一字符串相同，相同则返回{@code true}，没有相同的返回{@code false}
+ * 如果参与比对的字符串列表为空，返回{@code false} + * + * @param str1 给定需要检查的字符串 + * @param ignoreCase 是否忽略大小写 + * @param strs 需要参与比对的字符串列表 + * @return 是否相同 + * @since 4.3.2 + */ + public static boolean equalsAny(CharSequence str1, boolean ignoreCase, CharSequence... strs) { + if (ArrayUtil.isEmpty(strs)) { + return false; + } + + for (CharSequence str : strs) { + if (equals(str1, str, ignoreCase)) { + return true; + } + } + return false; + } + + /** + * 字符串指定位置的字符是否与给定字符相同
+ * 如果字符串为null，返回false
+ * 如果给定的位置大于字符串长度，返回false
+ * 如果给定的位置小于0，返回false + * + * @param str 字符串 + * @param position 位置 + * @param c 需要对比的字符 + * @return 字符串指定位置的字符是否与给定字符相同 + * @since 3.3.1 + */ + public static boolean equalsCharAt(CharSequence str, int position, char c) { + if (null == str || position < 0) { + return false; + } + return str.length() > position && c == str.charAt(position); + } + + /** + * 截取第一个字串的部分字符，与第二个字符串比较（长度一致），判断截取的子串是否相同
+ * 任意一个字符串为null返回false + * + * @param str1 第一个字符串 + * @param start1 第一个字符串开始的位置 + * @param str2 第二个字符串 + * @param ignoreCase 是否忽略大小写 + * @return 子串是否相同 + * @since 3.2.1 + */ + public static boolean isSubEquals(CharSequence str1, int start1, CharSequence str2, boolean ignoreCase) { + return isSubEquals(str1, start1, str2, 0, str2.length(), ignoreCase); + } + + /** + * 截取两个字符串的不同部分（长度一致），判断截取的子串是否相同
+ * 任意一个字符串为null返回false + * + * @param str1 第一个字符串 + * @param start1 第一个字符串开始的位置 + * @param str2 第二个字符串 + * @param start2 第二个字符串开始的位置 + * @param length 截取长度 + * @param ignoreCase 是否忽略大小写 + * @return 子串是否相同 + * @since 3.2.1 + */ + public static boolean isSubEquals(CharSequence str1, int start1, CharSequence str2, int start2, int length, boolean ignoreCase) { + if (null == str1 || null == str2) { + return false; + } + + return str1.toString().regionMatches(ignoreCase, start1, str2.toString(), start2, length); + } + + // ------------------------------------------------------------------------ format + + /** + * 格式化文本, {} 表示占位符
+ * 此方法只是简单将占位符 {} 按照顺序替换为参数
+ * 如果想输出 {} 使用 \\转义 { 即可，如果想输出 {} 之前的 \ 使用双转义符 \\\\ 即可
+ * 例：
+ * 通常使用：format("this is {} for {}", "a", "b") =》 this is a for b
+ * 转义{}： format("this is \\{} for {}", "a", "b") =》 this is {} for a
+ * 转义\： format("this is \\\\{} for {}", "a", "b") =》 this is \a for b
+ * + * @param template 文本模板，被替换的部分用 {} 表示，如果模板为null，返回"null" + * @param params 参数值 + * @return 格式化后的文本，如果模板为null，返回"null" + */ + public static String format(CharSequence template, Object... params) { + if (null == template) { + return NULL; + } + if (ArrayUtil.isEmpty(params) || isBlank(template)) { + return template.toString(); + } + return StrFormatter.format(template.toString(), params); + } + + /** + * 有序的格式化文本，使用{number}做为占位符
+ * 通常使用：format("this is {0} for {1}", "a", "b") =》 this is a for b
+ * + * @param pattern 文本格式 + * @param arguments 参数 + * @return 格式化后的文本 + */ + public static String indexedFormat(CharSequence pattern, Object... arguments) { + return MessageFormat.format(pattern.toString(), arguments); + } + // ------------------------------------------------------------------------ bytes + + /** + * 编码字符串，编码为UTF-8 + * + * @param str 字符串 + * @return 编码后的字节码 + */ + public static byte[] utf8Bytes(CharSequence str) { + return bytes(str, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 编码字符串
+ * 使用系统默认编码 + * + * @param str 字符串 + * @return 编码后的字节码 + */ + public static byte[] bytes(CharSequence str) { + return bytes(str, Charset.defaultCharset()); + } + + /** + * 编码字符串 + * + * @param str 字符串 + * @param charset 字符集，如果此字段为空，则解码的结果取决于平台 + * @return 编码后的字节码 + */ + public static byte[] bytes(CharSequence str, String charset) { + return bytes(str, isBlank(charset) ? Charset.defaultCharset() : Charset.forName(charset)); + } + + /** + * 编码字符串 + * + * @param str 字符串 + * @param charset 字符集，如果此字段为空，则解码的结果取决于平台 + * @return 编码后的字节码 + */ + public static byte[] bytes(CharSequence str, Charset charset) { + if (str == null) { + return null; + } + + if (null == charset) { + return str.toString().getBytes(); + } + return str.toString().getBytes(charset); + } + + /** + * 字符串转换为byteBuffer + * + * @param str 字符串 + * @param charset 编码 + * @return byteBuffer + */ + public static ByteBuffer byteBuffer(CharSequence str, String charset) { + return ByteBuffer.wrap(bytes(str, charset)); + } + + // ------------------------------------------------------------------------ wrap + + /** + * 包装指定字符串
+ * 当前缀和后缀一致时使用此方法 + * + * @param str 被包装的字符串 + * @param prefixAndSuffix 前缀和后缀 + * @return 包装后的字符串 + * @since 3.1.0 + */ + public static String wrap(CharSequence str, CharSequence prefixAndSuffix) { + return wrap(str, prefixAndSuffix, prefixAndSuffix); + } + + /** + * 包装指定字符串 + * + * @param str 被包装的字符串 + * @param prefix 前缀 + * @param suffix 后缀 + * @return 包装后的字符串 + */ + public static String wrap(CharSequence str, CharSequence prefix, CharSequence suffix) { + return nullToEmpty(prefix).concat(nullToEmpty(str)).concat(nullToEmpty(suffix)); + } + + /** + * 使用单个字符包装多个字符串 + * + * @param prefixAndSuffix 前缀和后缀 + * @param strs 多个字符串 + * @return 包装的字符串数组 + * @since 5.4.1 + */ + public static String[] wrapAllWithPair(CharSequence prefixAndSuffix, CharSequence... strs) { + return wrapAll(prefixAndSuffix, prefixAndSuffix, strs); + } + + /** + * 包装多个字符串 + * + * @param prefix 前缀 + * @param suffix 后缀 + * @param strs 多个字符串 + * @return 包装的字符串数组 + * @since 4.0.7 + */ + public static String[] wrapAll(CharSequence prefix, CharSequence suffix, CharSequence... strs) { + final String[] results = new String[strs.length]; + for (int i = 0; i < strs.length; i++) { + results[i] = wrap(strs[i], prefix, suffix); + } + return results; + } + + /** + * 包装指定字符串，如果前缀或后缀已经包含对应的字符串，则不再包装 + * + * @param str 被包装的字符串 + * @param prefix 前缀 + * @param suffix 后缀 + * @return 包装后的字符串 + */ + public static String wrapIfMissing(CharSequence str, CharSequence prefix, CharSequence suffix) { + int len = 0; + if (isNotEmpty(str)) { + len += str.length(); + } + if (isNotEmpty(prefix)) { + len += prefix.length(); + } + if (isNotEmpty(suffix)) { + len += suffix.length(); + } + StringBuilder sb = new StringBuilder(len); + if (isNotEmpty(prefix) && false == startWith(str, prefix)) { + sb.append(prefix); + } + if (isNotEmpty(str)) { + sb.append(str); + } + if (isNotEmpty(suffix) && false == endWith(str, suffix)) { + sb.append(suffix); + } + return sb.toString(); + } + + /** + * 使用成对的字符包装多个字符串，如果已经包装，则不再包装 + * + * @param prefixAndSuffix 前缀和后缀 + * @param strs 多个字符串 + * @return 包装的字符串数组 + * @since 5.4.1 + */ + public static String[] wrapAllWithPairIfMissing(CharSequence prefixAndSuffix, CharSequence... strs) { + return wrapAllIfMissing(prefixAndSuffix, prefixAndSuffix, strs); + } + + /** + * 包装多个字符串，如果已经包装，则不再包装 + * + * @param prefix 前缀 + * @param suffix 后缀 + * @param strs 多个字符串 + * @return 包装的字符串数组 + * @since 4.0.7 + */ + public static String[] wrapAllIfMissing(CharSequence prefix, CharSequence suffix, CharSequence... strs) { + final String[] results = new String[strs.length]; + for (int i = 0; i < strs.length; i++) { + results[i] = wrapIfMissing(strs[i], prefix, suffix); + } + return results; + } + + /** + * 去掉字符包装，如果未被包装则返回原字符串 + * + * @param str 字符串 + * @param prefix 前置字符串 + * @param suffix 后置字符串 + * @return 去掉包装字符的字符串 + * @since 4.0.1 + */ + public static String unWrap(CharSequence str, String prefix, String suffix) { + if (isWrap(str, prefix, suffix)) { + return sub(str, prefix.length(), str.length() - suffix.length()); + } + return str.toString(); + } + + /** + * 去掉字符包装，如果未被包装则返回原字符串 + * + * @param str 字符串 + * @param prefix 前置字符 + * @param suffix 后置字符 + * @return 去掉包装字符的字符串 + * @since 4.0.1 + */ + public static String unWrap(CharSequence str, char prefix, char suffix) { + if (isEmpty(str)) { + return str(str); + } + if (str.charAt(0) == prefix && str.charAt(str.length() - 1) == suffix) { + return sub(str, 1, str.length() - 1); + } + return str.toString(); + } + + /** + * 去掉字符包装，如果未被包装则返回原字符串 + * + * @param str 字符串 + * @param prefixAndSuffix 前置和后置字符 + * @return 去掉包装字符的字符串 + * @since 4.0.1 + */ + public static String unWrap(CharSequence str, char prefixAndSuffix) { + return unWrap(str, prefixAndSuffix, prefixAndSuffix); + } + + /** + * 指定字符串是否被包装 + * + * @param str 字符串 + * @param prefix 前缀 + * @param suffix 后缀 + * @return 是否被包装 + */ + public static boolean isWrap(CharSequence str, String prefix, String suffix) { + if (ArrayUtil.hasNull(str, prefix, suffix)) { + return false; + } + final String str2 = str.toString(); + return str2.startsWith(prefix) && str2.endsWith(suffix); + } + + /** + * 指定字符串是否被同一字符包装（前后都有这些字符串） + * + * @param str 字符串 + * @param wrapper 包装字符串 + * @return 是否被包装 + */ + public static boolean isWrap(CharSequence str, String wrapper) { + return isWrap(str, wrapper, wrapper); + } + + /** + * 指定字符串是否被同一字符包装（前后都有这些字符串） + * + * @param str 字符串 + * @param wrapper 包装字符 + * @return 是否被包装 + */ + public static boolean isWrap(CharSequence str, char wrapper) { + return isWrap(str, wrapper, wrapper); + } + + /** + * 指定字符串是否被包装 + * + * @param str 字符串 + * @param prefixChar 前缀 + * @param suffixChar 后缀 + * @return 是否被包装 + */ + public static boolean isWrap(CharSequence str, char prefixChar, char suffixChar) { + if (null == str) { + return false; + } + + return str.charAt(0) == prefixChar && str.charAt(str.length() - 1) == suffixChar; + } + + // ------------------------------------------------------------------------ pad + + /** + * 补充字符串以满足指定长度，如果提供的字符串大于指定长度，截断之 + * 同：leftPad (org.apache.commons.lang3.leftPad) + * + * 
+	 * StrUtil.padPre(null, *, *);//null
+	 * StrUtil.padPre("1", 3, "ABC");//"AB1"
+	 * StrUtil.padPre("123", 2, "ABC");//"12"
+	 * StrUtil.padPre("1039", -1, "0");//"103"
+	 *
+ * + * @param str 字符串 + * @param length 长度 + * @param padStr 补充的字符 + * @return 补充后的字符串 + */ + public static String padPre(CharSequence str, int length, CharSequence padStr) { + if (null == str) { + return null; + } + final int strLen = str.length(); + if (strLen == length) { + return str.toString(); + } else if (strLen > length) { + //如果提供的字符串大于指定长度，截断之 + return subPre(str, length); + } + + return repeatByLength(padStr, length - strLen).concat(str.toString()); + } + + /** + * 补充字符串以满足最小长度，如果提供的字符串大于指定长度，截断之 + * 同：leftPad (org.apache.commons.lang3.leftPad) + * + * 
+	 * StrUtil.padPre(null, *, *);//null
+	 * StrUtil.padPre("1", 3, '0');//"001"
+	 * StrUtil.padPre("123", 2, '0');//"12"
+	 *
+ * + * @param str 字符串 + * @param length 长度 + * @param padChar 补充的字符 + * @return 补充后的字符串 + */ + public static String padPre(CharSequence str, int length, char padChar) { + if (null == str) { + return null; + } + final int strLen = str.length(); + if (strLen == length) { + return str.toString(); + } else if (strLen > length) { + //如果提供的字符串大于指定长度，截断之 + return subPre(str, length); + } + + return repeat(padChar, length - strLen).concat(str.toString()); + } + + /** + * 补充字符串以满足最小长度，如果提供的字符串大于指定长度，截断之 + * + * 
+	 * StrUtil.padAfter(null, *, *);//null
+	 * StrUtil.padAfter("1", 3, '0');//"100"
+	 * StrUtil.padAfter("123", 2, '0');//"23"
+	 * StrUtil.padAfter("123", -1, '0')//"" 空串
+	 *
+ * + * @param str 字符串，如果为{@code null}，直接返回null + * @param length 长度 + * @param padChar 补充的字符 + * @return 补充后的字符串 + */ + public static String padAfter(CharSequence str, int length, char padChar) { + if (null == str) { + return null; + } + final int strLen = str.length(); + if (strLen == length) { + return str.toString(); + } else if (strLen > length) { + //如果提供的字符串大于指定长度，截断之 + return sub(str, strLen - length, strLen); + } + + return str.toString().concat(repeat(padChar, length - strLen)); + } + + /** + * 补充字符串以满足最小长度 + * + * 
+	 * StrUtil.padAfter(null, *, *);//null
+	 * StrUtil.padAfter("1", 3, "ABC");//"1AB"
+	 * StrUtil.padAfter("123", 2, "ABC");//"23"
+	 *
+ * + * @param str 字符串，如果为{@code null}，直接返回null + * @param length 长度 + * @param padStr 补充的字符 + * @return 补充后的字符串 + * @since 4.3.2 + */ + public static String padAfter(CharSequence str, int length, CharSequence padStr) { + if (null == str) { + return null; + } + final int strLen = str.length(); + if (strLen == length) { + return str.toString(); + } else if (strLen > length) { + //如果提供的字符串大于指定长度，截断之 + return subSufByLength(str, length); + } + + return str.toString().concat(repeatByLength(padStr, length - strLen)); + } + + // ------------------------------------------------------------------------ center + + /** + * 居中字符串，两边补充指定字符串，如果指定长度小于字符串，则返回原字符串 + * + * 
+	 * StrUtil.center(null, *)   = null
+	 * StrUtil.center("", 4)     = "    "
+	 * StrUtil.center("ab", -1)  = "ab"
+	 * StrUtil.center("ab", 4)   = " ab "
+	 * StrUtil.center("abcd", 2) = "abcd"
+	 * StrUtil.center("a", 4)    = " a  "
+	 *
+ * + * @param str 字符串 + * @param size 指定长度 + * @return 补充后的字符串 + * @since 4.3.2 + */ + public static String center(CharSequence str, final int size) { + return center(str, size, CharUtil.SPACE); + } + + /** + * 居中字符串，两边补充指定字符串，如果指定长度小于字符串，则返回原字符串 + * + * 
+	 * StrUtil.center(null, *, *)     = null
+	 * StrUtil.center("", 4, ' ')     = "    "
+	 * StrUtil.center("ab", -1, ' ')  = "ab"
+	 * StrUtil.center("ab", 4, ' ')   = " ab "
+	 * StrUtil.center("abcd", 2, ' ') = "abcd"
+	 * StrUtil.center("a", 4, ' ')    = " a  "
+	 * StrUtil.center("a", 4, 'y')   = "yayy"
+	 * StrUtil.center("abc", 7, ' ')   = "  abc  "
+	 *
+ * + * @param str 字符串 + * @param size 指定长度 + * @param padChar 两边补充的字符 + * @return 补充后的字符串 + * @since 4.3.2 + */ + public static String center(CharSequence str, final int size, char padChar) { + if (str == null || size <= 0) { + return str(str); + } + final int strLen = str.length(); + final int pads = size - strLen; + if (pads <= 0) { + return str.toString(); + } + str = padPre(str, strLen + pads / 2, padChar); + str = padAfter(str, size, padChar); + return str.toString(); + } + + /** + * 居中字符串，两边补充指定字符串，如果指定长度小于字符串，则返回原字符串 + * + * 
+	 * StrUtil.center(null, *, *)     = null
+	 * StrUtil.center("", 4, " ")     = "    "
+	 * StrUtil.center("ab", -1, " ")  = "ab"
+	 * StrUtil.center("ab", 4, " ")   = " ab "
+	 * StrUtil.center("abcd", 2, " ") = "abcd"
+	 * StrUtil.center("a", 4, " ")    = " a  "
+	 * StrUtil.center("a", 4, "yz")   = "yayz"
+	 * StrUtil.center("abc", 7, null) = "  abc  "
+	 * StrUtil.center("abc", 7, "")   = "  abc  "
+	 *
+ * + * @param str 字符串 + * @param size 指定长度 + * @param padStr 两边补充的字符串 + * @return 补充后的字符串 + */ + public static String center(CharSequence str, final int size, CharSequence padStr) { + if (str == null || size <= 0) { + return str(str); + } + if (isEmpty(padStr)) { + padStr = SPACE; + } + final int strLen = str.length(); + final int pads = size - strLen; + if (pads <= 0) { + return str.toString(); + } + str = padPre(str, strLen + pads / 2, padStr); + str = padAfter(str, size, padStr); + return str.toString(); + } + + // ------------------------------------------------------------------------ str + + /** + * {@link CharSequence} 转为字符串，null安全 + * + * @param cs {@link CharSequence} + * @return 字符串 + */ + public static String str(CharSequence cs) { + return null == cs ? null : cs.toString(); + } + + // ------------------------------------------------------------------------ count + + /** + * 统计指定内容中包含指定字符串的数量
+ * 参数为 {@code null} 或者 "" 返回 {@code 0}. + * + * 
+	 * StrUtil.count(null, *)       = 0
+	 * StrUtil.count("", *)         = 0
+	 * StrUtil.count("abba", null)  = 0
+	 * StrUtil.count("abba", "")    = 0
+	 * StrUtil.count("abba", "a")   = 2
+	 * StrUtil.count("abba", "ab")  = 1
+	 * StrUtil.count("abba", "xxx") = 0
+	 *
+ * + * @param content 被查找的字符串 + * @param strForSearch 需要查找的字符串 + * @return 查找到的个数 + */ + public static int count(CharSequence content, CharSequence strForSearch) { + if (hasEmpty(content, strForSearch) || strForSearch.length() > content.length()) { + return 0; + } + + int count = 0; + int idx = 0; + final String content2 = content.toString(); + final String strForSearch2 = strForSearch.toString(); + while ((idx = content2.indexOf(strForSearch2, idx)) > -1) { + count++; + idx += strForSearch.length(); + } + return count; + } + + /** + * 统计指定内容中包含指定字符的数量 + * + * @param content 内容 + * @param charForSearch 被统计的字符 + * @return 包含数量 + */ + public static int count(CharSequence content, char charForSearch) { + int count = 0; + if (isEmpty(content)) { + return 0; + } + int contentLength = content.length(); + for (int i = 0; i < contentLength; i++) { + if (charForSearch == content.charAt(i)) { + count++; + } + } + return count; + } + + // ------------------------------------------------------------------------ compare + + /** + * 比较两个字符串，用于排序 + * + * 
+	 * StrUtil.compare(null, null, *)     = 0
+	 * StrUtil.compare(null , "a", true)  < 0
+	 * StrUtil.compare(null , "a", false) > 0
+	 * StrUtil.compare("a", null, true)   > 0
+	 * StrUtil.compare("a", null, false)  < 0
+	 * StrUtil.compare("abc", "abc", *)   = 0
+	 * StrUtil.compare("a", "b", *)       < 0
+	 * StrUtil.compare("b", "a", *)       > 0
+	 * StrUtil.compare("a", "B", *)       > 0
+	 * StrUtil.compare("ab", "abc", *)    < 0
+	 *
+ * + * @param str1 字符串1 + * @param str2 字符串2 + * @param nullIsLess {@code null} 值是否排在前（null是否小于非空值） + * @return 排序值。负数：str1 < str2，正数：str1 > str2, 0：str1 == str2 + */ + public static int compare(final CharSequence str1, final CharSequence str2, final boolean nullIsLess) { + if (str1 == str2) { + return 0; + } + if (str1 == null) { + return nullIsLess ? -1 : 1; + } + if (str2 == null) { + return nullIsLess ? 1 : -1; + } + return str1.toString().compareTo(str2.toString()); + } + + /** + * 比较两个字符串，用于排序，大小写不敏感 + * + * 
+	 * StrUtil.compareIgnoreCase(null, null, *)     = 0
+	 * StrUtil.compareIgnoreCase(null , "a", true)  < 0
+	 * StrUtil.compareIgnoreCase(null , "a", false) > 0
+	 * StrUtil.compareIgnoreCase("a", null, true)   > 0
+	 * StrUtil.compareIgnoreCase("a", null, false)  < 0
+	 * StrUtil.compareIgnoreCase("abc", "abc", *)   = 0
+	 * StrUtil.compareIgnoreCase("abc", "ABC", *)   = 0
+	 * StrUtil.compareIgnoreCase("a", "b", *)       < 0
+	 * StrUtil.compareIgnoreCase("b", "a", *)       > 0
+	 * StrUtil.compareIgnoreCase("a", "B", *)       < 0
+	 * StrUtil.compareIgnoreCase("A", "b", *)       < 0
+	 * StrUtil.compareIgnoreCase("ab", "abc", *)    < 0
+	 *
+ * + * @param str1 字符串1 + * @param str2 字符串2 + * @param nullIsLess {@code null} 值是否排在前（null是否小于非空值） + * @return 排序值。负数：str1 < str2，正数：str1 > str2, 0：str1 == str2 + */ + public static int compareIgnoreCase(CharSequence str1, CharSequence str2, boolean nullIsLess) { + if (str1 == str2) { + return 0; + } + if (str1 == null) { + return nullIsLess ? -1 : 1; + } + if (str2 == null) { + return nullIsLess ? 1 : -1; + } + return str1.toString().compareToIgnoreCase(str2.toString()); + } + + /** + * 比较两个版本
+ * null版本排在最小：即： + * + * 
+	 * StrUtil.compareVersion(null, "v1") < 0
+	 * StrUtil.compareVersion("v1", "v1")  = 0
+	 * StrUtil.compareVersion(null, null)   = 0
+	 * StrUtil.compareVersion("v1", null) > 0
+	 * StrUtil.compareVersion("1.0.0", "1.0.2") < 0
+	 * StrUtil.compareVersion("1.0.2", "1.0.2a") < 0
+	 * StrUtil.compareVersion("1.13.0", "1.12.1c") > 0
+	 * StrUtil.compareVersion("V0.0.20170102", "V0.0.20170101") > 0
+	 *
+ * + * @param version1 版本1 + * @param version2 版本2 + * @return 排序值。负数：version1 < version2，正数：version1 > version2, 0：version1 == version2 + * @since 4.0.2 + */ + public static int compareVersion(CharSequence version1, CharSequence version2) { + return VersionComparator.INSTANCE.compare(str(version1), str(version2)); + } + + // ------------------------------------------------------------------------ append and prepend + + /** + * 如果给定字符串不是以给定的一个或多个字符串为结尾，则在尾部添加结尾字符串
+ * 不忽略大小写 + * + * @param str 被检查的字符串 + * @param suffix 需要添加到结尾的字符串 + * @param suffixes 需要额外检查的结尾字符串，如果以这些中的一个为结尾，则不再添加 + * @return 如果已经结尾，返回原字符串，否则返回添加结尾的字符串 + * @since 3.0.7 + */ + public static String appendIfMissing(CharSequence str, CharSequence suffix, CharSequence... suffixes) { + return appendIfMissing(str, suffix, false, suffixes); + } + + /** + * 如果给定字符串不是以给定的一个或多个字符串为结尾，则在尾部添加结尾字符串
+ * 忽略大小写 + * + * @param str 被检查的字符串 + * @param suffix 需要添加到结尾的字符串 + * @param suffixes 需要额外检查的结尾字符串，如果以这些中的一个为结尾，则不再添加 + * @return 如果已经结尾，返回原字符串，否则返回添加结尾的字符串 + * @since 3.0.7 + */ + public static String appendIfMissingIgnoreCase(CharSequence str, CharSequence suffix, CharSequence... suffixes) { + return appendIfMissing(str, suffix, true, suffixes); + } + + /** + * 如果给定字符串不是以给定的一个或多个字符串为结尾，则在尾部添加结尾字符串 + * + * @param str 被检查的字符串 + * @param suffix 需要添加到结尾的字符串，不参与检查匹配 + * @param ignoreCase 检查结尾时是否忽略大小写 + * @param testSuffixes 需要额外检查的结尾字符串，如果以这些中的一个为结尾，则不再添加 + * @return 如果已经结尾，返回原字符串，否则返回添加结尾的字符串 + * @since 3.0.7 + */ + public static String appendIfMissing(CharSequence str, CharSequence suffix, boolean ignoreCase, CharSequence... testSuffixes) { + if (str == null || isEmpty(suffix) || endWith(str, suffix, ignoreCase)) { + return str(str); + } + if (ArrayUtil.isNotEmpty(testSuffixes)) { + for (final CharSequence testSuffix : testSuffixes) { + if (endWith(str, testSuffix, ignoreCase)) { + return str.toString(); + } + } + } + return str.toString().concat(suffix.toString()); + } + + /** + * 如果给定字符串不是以给定的一个或多个字符串为开头，则在首部添加起始字符串
+ * 不忽略大小写 + * + * @param str 被检查的字符串 + * @param prefix 需要添加到首部的字符串 + * @param prefixes 需要额外检查的首部字符串，如果以这些中的一个为起始，则不再添加 + * @return 如果已经结尾，返回原字符串，否则返回添加结尾的字符串 + * @since 3.0.7 + */ + public static String prependIfMissing(CharSequence str, CharSequence prefix, CharSequence... prefixes) { + return prependIfMissing(str, prefix, false, prefixes); + } + + /** + * 如果给定字符串不是以给定的一个或多个字符串为开头，则在首部添加起始字符串
+ * 忽略大小写 + * + * @param str 被检查的字符串 + * @param prefix 需要添加到首部的字符串 + * @param prefixes 需要额外检查的首部字符串，如果以这些中的一个为起始，则不再添加 + * @return 如果已经结尾，返回原字符串，否则返回添加结尾的字符串 + * @since 3.0.7 + */ + public static String prependIfMissingIgnoreCase(CharSequence str, CharSequence prefix, CharSequence... prefixes) { + return prependIfMissing(str, prefix, true, prefixes); + } + + /** + * 如果给定字符串不是以给定的一个或多个字符串为开头，则在首部添加起始字符串 + * + * @param str 被检查的字符串 + * @param prefix 需要添加到首部的字符串 + * @param ignoreCase 检查结尾时是否忽略大小写 + * @param prefixes 需要额外检查的首部字符串，如果以这些中的一个为起始，则不再添加 + * @return 如果已经结尾，返回原字符串，否则返回添加结尾的字符串 + * @since 3.0.7 + */ + public static String prependIfMissing(CharSequence str, CharSequence prefix, boolean ignoreCase, CharSequence... prefixes) { + if (str == null || isEmpty(prefix) || startWith(str, prefix, ignoreCase)) { + return str(str); + } + if (prefixes != null && prefixes.length > 0) { + for (final CharSequence s : prefixes) { + if (startWith(str, s, ignoreCase)) { + return str.toString(); + } + } + } + return prefix.toString().concat(str.toString()); + } + + // ------------------------------------------------------------------------ replace + + /** + * 替换字符串中的指定字符串，忽略大小写 + * + * @param str 字符串 + * @param searchStr 被查找的字符串 + * @param replacement 被替换的字符串 + * @return 替换后的字符串 + * @since 4.0.3 + */ + public static String replaceIgnoreCase(CharSequence str, CharSequence searchStr, CharSequence replacement) { + return replace(str, 0, searchStr, replacement, true); + } + + /** + * 替换字符串中的指定字符串 + * + * @param str 字符串 + * @param searchStr 被查找的字符串 + * @param replacement 被替换的字符串 + * @return 替换后的字符串 + * @since 4.0.3 + */ + public static String replace(CharSequence str, CharSequence searchStr, CharSequence replacement) { + return replace(str, 0, searchStr, replacement, false); + } + + /** + * 替换字符串中的指定字符串 + * + * @param str 字符串 + * @param searchStr 被查找的字符串 + * @param replacement 被替换的字符串 + * @param ignoreCase 是否忽略大小写 + * @return 替换后的字符串 + * @since 4.0.3 + */ + public static String replace(CharSequence str, CharSequence searchStr, CharSequence replacement, boolean ignoreCase) { + return replace(str, 0, searchStr, replacement, ignoreCase); + } + + /** + * 替换字符串中的指定字符串 + * + * @param str 字符串 + * @param fromIndex 开始位置（包括） + * @param searchStr 被查找的字符串 + * @param replacement 被替换的字符串 + * @param ignoreCase 是否忽略大小写 + * @return 替换后的字符串 + * @since 4.0.3 + */ + public static String replace(CharSequence str, int fromIndex, CharSequence searchStr, CharSequence replacement, boolean ignoreCase) { + if (isEmpty(str) || isEmpty(searchStr)) { + return str(str); + } + if (null == replacement) { + replacement = EMPTY; + } + + final int strLength = str.length(); + final int searchStrLength = searchStr.length(); + if (strLength < searchStrLength) { + // issue#I4M16G@Gitee + return str(str); + } + + if (fromIndex > strLength) { + return str(str); + } else if (fromIndex < 0) { + fromIndex = 0; + } + + final StringBuilder result = new StringBuilder(strLength - searchStrLength + replacement.length()); + if (0 != fromIndex) { + result.append(str.subSequence(0, fromIndex)); + } + + int preIndex = fromIndex; + int index; + while ((index = indexOf(str, searchStr, preIndex, ignoreCase)) > -1) { + result.append(str.subSequence(preIndex, index)); + result.append(replacement); + preIndex = index + searchStrLength; + } + + if (preIndex < strLength) { + // 结尾部分 + result.append(str.subSequence(preIndex, strLength)); + } + return result.toString(); + } + + /** + * 替换指定字符串的指定区间内字符为固定字符
+ * 此方法使用{@link String#codePoints()}完成拆分替换 + * + * @param str 字符串 + * @param startInclude 开始位置（包含） + * @param endExclude 结束位置（不包含） + * @param replacedChar 被替换的字符 + * @return 替换后的字符串 + * @since 3.2.1 + */ + public static String replace(CharSequence str, int startInclude, int endExclude, char replacedChar) { + if (isEmpty(str)) { + return str(str); + } + final String originalStr = str(str); + int[] strCodePoints = originalStr.codePoints().toArray(); + final int strLength = strCodePoints.length; + if (startInclude > strLength) { + return originalStr; + } + if (endExclude > strLength) { + endExclude = strLength; + } + if (startInclude > endExclude) { + // 如果起始位置大于结束位置，不替换 + return originalStr; + } + + final StringBuilder stringBuilder = new StringBuilder(); + for (int i = 0; i < strLength; i++) { + if (i >= startInclude && i < endExclude) { + stringBuilder.append(replacedChar); + } else { + stringBuilder.append(new String(strCodePoints, i, 1)); + } + } + return stringBuilder.toString(); + } + + /** + * 替换指定字符串的指定区间内字符为指定字符串，字符串只重复一次
+ * 此方法使用{@link String#codePoints()}完成拆分替换 + * + * @param str 字符串 + * @param startInclude 开始位置（包含） + * @param endExclude 结束位置（不包含） + * @param replacedStr 被替换的字符串 + * @return 替换后的字符串 + * @since 3.2.1 + */ + public static String replace(CharSequence str, int startInclude, int endExclude, CharSequence replacedStr) { + if (isEmpty(str)) { + return str(str); + } + final String originalStr = str(str); + int[] strCodePoints = originalStr.codePoints().toArray(); + final int strLength = strCodePoints.length; + if (startInclude > strLength) { + return originalStr; + } + if (endExclude > strLength) { + endExclude = strLength; + } + if (startInclude > endExclude) { + // 如果起始位置大于结束位置，不替换 + return originalStr; + } + + final StringBuilder stringBuilder = new StringBuilder(); + for (int i = 0; i < startInclude; i++) { + stringBuilder.append(new String(strCodePoints, i, 1)); + } + stringBuilder.append(replacedStr); + for (int i = endExclude; i < strLength; i++) { + stringBuilder.append(new String(strCodePoints, i, 1)); + } + return stringBuilder.toString(); + } + + /** + * 替换所有正则匹配的文本，并使用自定义函数决定如何替换
+ * replaceFun可以通过{@link Matcher}提取出匹配到的内容的不同部分，然后经过重新处理、组装变成新的内容放回原位。 + * 
+	 *     replace(this.content, "(\\d+)", parameters -> "-" + parameters.group(1) + "-")
+	 *     // 结果为："ZZZaaabbbccc中文-1234-"
+	 *
+ * + * @param str 要替换的字符串 + * @param pattern 用于匹配的正则式 + * @param replaceFun 决定如何替换的函数 + * @return 替换后的字符串 + * @see ReUtil#replaceAll(CharSequence, java.util.regex.Pattern, Func1) + * @since 4.2.2 + */ + public static String replace(CharSequence str, java.util.regex.Pattern pattern, Func1 replaceFun) { + return ReUtil.replaceAll(str, pattern, replaceFun); + } + + /** + * 替换所有正则匹配的文本，并使用自定义函数决定如何替换 + * + * @param str 要替换的字符串 + * @param regex 用于匹配的正则式 + * @param replaceFun 决定如何替换的函数 + * @return 替换后的字符串 + * @see ReUtil#replaceAll(CharSequence, String, Func1) + * @since 4.2.2 + */ + public static String replace(CharSequence str, String regex, Func1 replaceFun) { + return ReUtil.replaceAll(str, regex, replaceFun); + } + + /** + * 替换字符串中最后一个指定字符串 + * + * @param str 字符串 + * @param searchStr 被查找的字符串 + * @param replacedStr 被替换的字符串 + * @return 替换后的字符串 + */ + public static String replaceLast(CharSequence str, CharSequence searchStr, CharSequence replacedStr) { + return replaceLast(str, searchStr, replacedStr, false); + } + + /** + * 替换字符串中最后一个指定字符串 + * + * @param str 字符串 + * @param searchStr 被查找的字符串 + * @param replacedStr 被替换的字符串 + * @param ignoreCase 是否忽略大小写 + * @return 替换后的字符串 + */ + public static String replaceLast(CharSequence str, CharSequence searchStr, CharSequence replacedStr, boolean ignoreCase) { + if (isEmpty(str)) { + return str(str); + } + int lastIndex = lastIndexOf(str, searchStr, str.length(), ignoreCase); + if (INDEX_NOT_FOUND == lastIndex) { + return str(str); + } + return replace(str, lastIndex, searchStr, replacedStr, ignoreCase); + } + + /** + * 替换字符串中第一个指定字符串 + * + * @param str 字符串 + * @param searchStr 被查找的字符串 + * @param replacedStr 被替换的字符串 + * @return 替换后的字符串 + */ + public static String replaceFirst(CharSequence str, CharSequence searchStr, CharSequence replacedStr) { + return replaceFirst(str, searchStr, replacedStr, false); + } + + /** + * 替换字符串中第一个指定字符串 + * + * @param str 字符串 + * @param searchStr 被查找的字符串 + * @param replacedStr 被替换的字符串 + * @param ignoreCase 是否忽略大小写 + * @return 替换后的字符串 + */ + public static String replaceFirst(CharSequence str, CharSequence searchStr, CharSequence replacedStr, boolean ignoreCase) { + if (isEmpty(str)) { + return str(str); + } + int startInclude = indexOf(str, searchStr, 0, ignoreCase); + if (INDEX_NOT_FOUND == startInclude) { + return str(str); + } + return replace(str, startInclude, startInclude + searchStr.length(), replacedStr); + } + + /** + * 替换指定字符串的指定区间内字符为"*" + * 俗称：脱敏功能，后面其他功能，可以见：DesensitizedUtil(脱敏工具类) + * + * 
+	 * StrUtil.hide(null,*,*)=null
+	 * StrUtil.hide("",0,*)=""
+	 * StrUtil.hide("jackduan@163.com",-1,4)   ****duan@163.com
+	 * StrUtil.hide("jackduan@163.com",2,3)    ja*kduan@163.com
+	 * StrUtil.hide("jackduan@163.com",3,2)    jackduan@163.com
+	 * StrUtil.hide("jackduan@163.com",16,16)  jackduan@163.com
+	 * StrUtil.hide("jackduan@163.com",16,17)  jackduan@163.com
+	 *
+ * + * @param str 字符串 + * @param startInclude 开始位置（包含） + * @param endExclude 结束位置（不包含） + * @return 替换后的字符串 + * @since 4.1.14 + */ + public static String hide(CharSequence str, int startInclude, int endExclude) { + return replace(str, startInclude, endExclude, '*'); + } + + /** + * 脱敏，使用默认的脱敏策略 + * + * 
+	 * StrUtil.desensitized("100", DesensitizedUtil.DesensitizedType.USER_ID)) =  "0"
+	 * StrUtil.desensitized("段正淳", DesensitizedUtil.DesensitizedType.CHINESE_NAME)) = "段**"
+	 * StrUtil.desensitized("51343620000320711X", DesensitizedUtil.DesensitizedType.ID_CARD)) = "5***************1X"
+	 * StrUtil.desensitized("09157518479", DesensitizedUtil.DesensitizedType.FIXED_PHONE)) = "0915*****79"
+	 * StrUtil.desensitized("18049531999", DesensitizedUtil.DesensitizedType.MOBILE_PHONE)) = "180****1999"
+	 * StrUtil.desensitized("北京市海淀区马连洼街道289号", DesensitizedUtil.DesensitizedType.ADDRESS)) = "北京市海淀区马********"
+	 * StrUtil.desensitized("duandazhi-jack@gmail.com.cn", DesensitizedUtil.DesensitizedType.EMAIL)) = "d*************@gmail.com.cn"
+	 * StrUtil.desensitized("1234567890", DesensitizedUtil.DesensitizedType.PASSWORD)) = "**********"
+	 * StrUtil.desensitized("苏D40000", DesensitizedUtil.DesensitizedType.CAR_LICENSE)) = "苏D4***0"
+	 * StrUtil.desensitized("11011111222233333256", DesensitizedType.BANK_CARD)) = "1101 **** **** **** 3256"
+	 *
+ * + * @param str 字符串 + * @param desensitizedType 脱敏类型;可以脱敏：用户id、中文名、身份证号、座机号、手机号、地址、电子邮件、密码 + * @return 脱敏之后的字符串 + * @author dazer and neusoft and qiaomu + * @see DesensitizedUtil 如果需要自定义，脱敏规则，请使用该工具类； + * @since 5.6.2 + */ + public static String desensitized(CharSequence str, DesensitizedUtil.DesensitizedType desensitizedType) { + return DesensitizedUtil.desensitized(str, desensitizedType); + } + + /** + * 替换字符字符数组中所有的字符为replacedStr
+ * 提供的chars为所有需要被替换的字符，例如："\r\n"，则"\r"和"\n"都会被替换，哪怕他们单独存在 + * + * @param str 被检查的字符串 + * @param chars 需要替换的字符列表，用一个字符串表示这个字符列表 + * @param replacedStr 替换成的字符串 + * @return 新字符串 + * @since 3.2.2 + */ + public static String replaceChars(CharSequence str, String chars, CharSequence replacedStr) { + if (isEmpty(str) || isEmpty(chars)) { + return str(str); + } + return replaceChars(str, chars.toCharArray(), replacedStr); + } + + /** + * 替换字符字符数组中所有的字符为replacedStr + * + * @param str 被检查的字符串 + * @param chars 需要替换的字符列表 + * @param replacedStr 替换成的字符串 + * @return 新字符串 + * @since 3.2.2 + */ + public static String replaceChars(CharSequence str, char[] chars, CharSequence replacedStr) { + if (isEmpty(str) || ArrayUtil.isEmpty(chars)) { + return str(str); + } + + final Set set = new HashSet<>(chars.length); + for (char c : chars) { + set.add(c); + } + int strLen = str.length(); + final StringBuilder builder = new StringBuilder(); + char c; + for (int i = 0; i < strLen; i++) { + c = str.charAt(i); + builder.append(set.contains(c) ? replacedStr : c); + } + return builder.toString(); + } + + // ------------------------------------------------------------------------ length + + /** + * 获取字符串的长度，如果为null返回0 + * + * @param cs a 字符串 + * @return 字符串的长度，如果为null返回0 + * @since 4.3.2 + */ + public static int length(CharSequence cs) { + return cs == null ? 0 : cs.length(); + } + + /** + * 给定字符串转为bytes后的byte数（byte长度） + * + * @param cs 字符串 + * @param charset 编码 + * @return byte长度 + * @since 4.5.2 + */ + public static int byteLength(CharSequence cs, Charset charset) { + return cs == null ? 0 : cs.toString().getBytes(charset).length; + } + + /** + * 给定字符串数组的总长度
+ * null字符长度定义为0 + * + * @param strs 字符串数组 + * @return 总长度 + * @since 4.0.1 + */ + public static int totalLength(CharSequence... strs) { + int totalLength = 0; + for (CharSequence str : strs) { + totalLength += (null == str ? 0 : str.length()); + } + return totalLength; + } + + /** + * 限制字符串长度，如果超过指定长度，截取指定长度并在末尾加"..." + * + * @param string 字符串 + * @param length 最大长度 + * @return 切割后的剩余的前半部分字符串+"..." + * @since 4.0.10 + */ + public static String maxLength(CharSequence string, int length) { + Assert.isTrue(length > 0); + if (null == string) { + return null; + } + if (string.length() <= length) { + return string.toString(); + } + return sub(string, 0, length) + "..."; + } + + // ------------------------------------------------------------------------ firstXXX + + /** + * 返回第一个非{@code null} 元素 + * + * @param strs 多个元素 + * @param 元素类型 + * @return 第一个非空元素，如果给定的数组为空或者都为空，返回{@code null} + * @since 5.4.1 + */ + @SuppressWarnings("unchecked") + public static T firstNonNull(T... strs) { + return ArrayUtil.firstNonNull(strs); + } + + /** + * 返回第一个非empty 元素 + * + * @param strs 多个元素 + * @param 元素类型 + * @return 第一个非空元素，如果给定的数组为空或者都为空，返回{@code null} + * @see #isNotEmpty(CharSequence) + * @since 5.4.1 + */ + @SuppressWarnings("unchecked") + public static T firstNonEmpty(T... strs) { + return ArrayUtil.firstMatch(StrUtil::isNotEmpty, strs); + } + + /** + * 返回第一个非blank 元素 + * + * @param strs 多个元素 + * @param 元素类型 + * @return 第一个非空元素，如果给定的数组为空或者都为空，返回{@code null} + * @see #isNotBlank(CharSequence) + * @since 5.4.1 + */ + @SuppressWarnings("unchecked") + public static T firstNonBlank(T... strs) { + return ArrayUtil.firstMatch(StrUtil::isNotBlank, strs); + } + + // ------------------------------------------------------------------------ lower and upper + + /** + * 原字符串首字母大写并在其首部添加指定字符串 例如：str=name, preString=get =》 return getName + * + * @param str 被处理的字符串 + * @param preString 添加的首部 + * @return 处理后的字符串 + */ + public static String upperFirstAndAddPre(CharSequence str, String preString) { + if (str == null || preString == null) { + return null; + } + return preString + upperFirst(str); + } + + /** + * 大写首字母
+ * 例如：str = name, return Name + * + * @param str 字符串 + * @return 字符串 + */ + public static String upperFirst(CharSequence str) { + if (null == str) { + return null; + } + if (str.length() > 0) { + char firstChar = str.charAt(0); + if (Character.isLowerCase(firstChar)) { + return Character.toUpperCase(firstChar) + subSuf(str, 1); + } + } + return str.toString(); + } + + /** + * 小写首字母
+ * 例如：str = Name, return name + * + * @param str 字符串 + * @return 字符串 + */ + public static String lowerFirst(CharSequence str) { + if (null == str) { + return null; + } + if (str.length() > 0) { + char firstChar = str.charAt(0); + if (Character.isUpperCase(firstChar)) { + return Character.toLowerCase(firstChar) + subSuf(str, 1); + } + } + return str.toString(); + } + + // ------------------------------------------------------------------------ filter + + /** + * 过滤字符串 + * + * @param str 字符串 + * @param filter 过滤器，{@link Filter#accept(Object)}返回为{@code true}的保留字符 + * @return 过滤后的字符串 + * @since 5.4.0 + */ + public static String filter(CharSequence str, final Filter filter) { + if (str == null || filter == null) { + return str(str); + } + + int len = str.length(); + final StringBuilder sb = new StringBuilder(len); + char c; + for (int i = 0; i < len; i++) { + c = str.charAt(i); + if (filter.accept(c)) { + sb.append(c); + } + } + return sb.toString(); + } + + // ------------------------------------------------------------------------ case + + /** + * 给定字符串中的字母是否全部为大写，判断依据如下： + * + * 
+	 * 1. 大写字母包括A-Z
+	 * 2. 其它非字母的Unicode符都算作大写
+	 *
+ * + * @param str 被检查的字符串 + * @return 是否全部为大写 + * @since 4.2.2 + */ + public static boolean isUpperCase(CharSequence str) { + if (null == str) { + return false; + } + final int len = str.length(); + for (int i = 0; i < len; i++) { + if (Character.isLowerCase(str.charAt(i))) { + return false; + } + } + return true; + } + + /** + * 给定字符串中的字母是否全部为小写，判断依据如下： + * + * 
+	 * 1. 小写字母包括a-z
+	 * 2. 其它非字母的Unicode符都算作小写
+	 *
+ * + * @param str 被检查的字符串 + * @return 是否全部为小写 + * @since 4.2.2 + */ + public static boolean isLowerCase(CharSequence str) { + if (null == str) { + return false; + } + final int len = str.length(); + for (int i = 0; i < len; i++) { + if (Character.isUpperCase(str.charAt(i))) { + return false; + } + } + return true; + } + + /** + * 切换给定字符串中的大小写。大写转小写，小写转大写。 + * + * 
+	 * StrUtil.swapCase(null)                 = null
+	 * StrUtil.swapCase("")                   = ""
+	 * StrUtil.swapCase("The dog has a BONE") = "tHE DOG HAS A bone"
+	 *
+ * + * @param str 字符串 + * @return 交换后的字符串 + * @since 4.3.2 + */ + public static String swapCase(final String str) { + if (isEmpty(str)) { + return str; + } + + final char[] buffer = str.toCharArray(); + + for (int i = 0; i < buffer.length; i++) { + final char ch = buffer[i]; + if (Character.isUpperCase(ch)) { + buffer[i] = Character.toLowerCase(ch); + } else if (Character.isTitleCase(ch)) { + buffer[i] = Character.toLowerCase(ch); + } else if (Character.isLowerCase(ch)) { + buffer[i] = Character.toUpperCase(ch); + } + } + return new String(buffer); + } + + /** + * 将驼峰式命名的字符串转换为下划线方式。如果转换前的驼峰式命名的字符串为空，则返回空字符串。
+ * 例如： + * + * 
+	 * HelloWorld=》hello_world
+	 * Hello_World=》hello_world
+	 * HelloWorld_test=》hello_world_test
+	 *
+ * + * @param str 转换前的驼峰式命名的字符串，也可以为下划线形式 + * @return 转换后下划线方式命名的字符串 + * @see NamingCase#toUnderlineCase(CharSequence) + */ + public static String toUnderlineCase(CharSequence str) { + return NamingCase.toUnderlineCase(str); + } + + /** + * 将驼峰式命名的字符串转换为使用符号连接方式。如果转换前的驼峰式命名的字符串为空，则返回空字符串。
+ * + * @param str 转换前的驼峰式命名的字符串，也可以为符号连接形式 + * @param symbol 连接符 + * @return 转换后符号连接方式命名的字符串 + * @see NamingCase#toSymbolCase(CharSequence, char) + * @since 4.0.10 + */ + public static String toSymbolCase(CharSequence str, char symbol) { + return NamingCase.toSymbolCase(str, symbol); + } + + /** + * 将下划线方式命名的字符串转换为驼峰式。如果转换前的下划线大写方式命名的字符串为空，则返回空字符串。
+ * 例如：hello_world=》helloWorld + * + * @param name 转换前的下划线大写方式命名的字符串 + * @return 转换后的驼峰式命名的字符串 + * @see NamingCase#toCamelCase(CharSequence) + */ + public static String toCamelCase(CharSequence name) { + return NamingCase.toCamelCase(name); + } + + /** + * 将连接符方式命名的字符串转换为驼峰式。如果转换前的下划线大写方式命名的字符串为空，则返回空字符串。
+ * 例如：hello_world=》helloWorld; hello-world=》helloWorld + * + * @param name 转换前的下划线大写方式命名的字符串 + * @param symbol 连接符 + * @return 转换后的驼峰式命名的字符串 + * @see NamingCase#toCamelCase(CharSequence, char) + */ + public static String toCamelCase(CharSequence name, char symbol) { + return NamingCase.toCamelCase(name, symbol); + } + + // ------------------------------------------------------------------------ isSurround + + /** + * 给定字符串是否被字符包围 + * + * @param str 字符串 + * @param prefix 前缀 + * @param suffix 后缀 + * @return 是否包围，空串不包围 + */ + public static boolean isSurround(CharSequence str, CharSequence prefix, CharSequence suffix) { + if (StrUtil.isBlank(str)) { + return false; + } + if (str.length() < (prefix.length() + suffix.length())) { + return false; + } + + final String str2 = str.toString(); + return str2.startsWith(prefix.toString()) && str2.endsWith(suffix.toString()); + } + + /** + * 给定字符串是否被字符包围 + * + * @param str 字符串 + * @param prefix 前缀 + * @param suffix 后缀 + * @return 是否包围，空串不包围 + */ + public static boolean isSurround(CharSequence str, char prefix, char suffix) { + if (StrUtil.isBlank(str)) { + return false; + } + if (str.length() < 2) { + return false; + } + + return str.charAt(0) == prefix && str.charAt(str.length() - 1) == suffix; + } + + // ------------------------------------------------------------------------ builder + + /** + * 创建StringBuilder对象 + * + * @param strs 初始字符串列表 + * @return StringBuilder对象 + */ + public static StringBuilder builder(CharSequence... strs) { + final StringBuilder sb = new StringBuilder(); + for (CharSequence str : strs) { + sb.append(str); + } + return sb; + } + + /** + * 创建StrBuilder对象 + * + * @param strs 初始字符串列表 + * @return StrBuilder对象 + */ + public static StrBuilder strBuilder(CharSequence... strs) { + return StrBuilder.create(strs); + } + + // ------------------------------------------------------------------------ getter and setter + + /** + * 获得set或get或is方法对应的标准属性名
+ * 例如：setName 返回 name + * + * 
+	 * getName =》name
+	 * setName =》name
+	 * isName  =》name
+	 *
+ * + * @param getOrSetMethodName Get或Set方法名 + * @return 如果是set或get方法名，返回field， 否则null + */ + public static String getGeneralField(CharSequence getOrSetMethodName) { + final String getOrSetMethodNameStr = getOrSetMethodName.toString(); + if (getOrSetMethodNameStr.startsWith("get") || getOrSetMethodNameStr.startsWith("set")) { + return removePreAndLowerFirst(getOrSetMethodName, 3); + } else if (getOrSetMethodNameStr.startsWith("is")) { + return removePreAndLowerFirst(getOrSetMethodName, 2); + } + return null; + } + + /** + * 生成set方法名
+ * 例如：name 返回 setName + * + * @param fieldName 属性名 + * @return setXxx + */ + public static String genSetter(CharSequence fieldName) { + return upperFirstAndAddPre(fieldName, "set"); + } + + /** + * 生成get方法名 + * + * @param fieldName 属性名 + * @return getXxx + */ + public static String genGetter(CharSequence fieldName) { + return upperFirstAndAddPre(fieldName, "get"); + } + + // ------------------------------------------------------------------------ other + + /** + * 连接多个字符串为一个 + * + * @param isNullToEmpty 是否null转为"" + * @param strs 字符串数组 + * @return 连接后的字符串 + * @since 4.1.0 + */ + public static String concat(boolean isNullToEmpty, CharSequence... strs) { + final StrBuilder sb = new StrBuilder(); + for (CharSequence str : strs) { + sb.append(isNullToEmpty ? nullToEmpty(str) : str); + } + return sb.toString(); + } + + /** + * 将给定字符串，变成 "xxx...xxx" 形式的字符串 + * + *
    + *
  • abcdefgh 9 -》 abcdefgh
    • + *
  • abcdefgh 8 -》 abcdefgh
    • + *
  • abcdefgh 7 -》 ab...gh
    • + *
  • abcdefgh 6 -》 ab...h
    • + *
  • abcdefgh 5 -》 a...h
    • + *
  • abcdefgh 4 -》 a..h
    • + *
  • abcdefgh 3 -》 a.h
    • + *
  • abcdefgh 2 -》 a.
    • + *
  • abcdefgh 1 -》 a
    • + *
  • abcdefgh 0 -》 abcdefgh
    • + *
  • abcdefgh -1 -》 abcdefgh
    • + *
+ * + * @param str 字符串 + * @param maxLength 结果的最大长度 + * @return 截取后的字符串 + */ + public static String brief(CharSequence str, int maxLength) { + if (null == str) { + return null; + } + final int strLength = str.length(); + if (maxLength <= 0 || strLength <= maxLength) { + return str.toString(); + } + + // since 5.7.5，特殊长度 + switch (maxLength) { + case 1: + return String.valueOf(str.charAt(0)); + case 2: + return str.charAt(0) + "."; + case 3: + return str.charAt(0) + "." + str.charAt(strLength - 1); + case 4: + return str.charAt(0) + ".." + str.charAt(strLength - 1); + } + + final int suffixLength = (maxLength - 3) / 2; + final int preLength = suffixLength + (maxLength - 3) % 2; // suffixLength 或 suffixLength + 1 + final String str2 = str.toString(); + return format("{}...{}", + str2.substring(0, preLength), + str2.substring(strLength - suffixLength)); + } + + /** + * 以 conjunction 为分隔符将多个对象转换为字符串 + * + * @param conjunction 分隔符 {@link StrPool#COMMA} + * @param objs 数组 + * @return 连接后的字符串 + * @see ArrayUtil#join(Object, CharSequence) + */ + public static String join(CharSequence conjunction, Object... objs) { + return ArrayUtil.join(objs, conjunction); + } + + /** + * 以 conjunction 为分隔符将多个对象转换为字符串 + * + * @param 元素类型 + * @param conjunction 分隔符 {@link StrPool#COMMA} + * @param iterable 集合 + * @return 连接后的字符串 + * @see CollUtil#join(Iterable, CharSequence) + * @since 5.6.6 + */ + public static String join(CharSequence conjunction, Iterable iterable) { + return CollUtil.join(iterable, conjunction); + } + + /** + * 字符串的每一个字符是否都与定义的匹配器匹配 + * + * @param value 字符串 + * @param matcher 匹配器 + * @return 是否全部匹配 + * @since 3.2.3 + */ + public static boolean isAllCharMatch(CharSequence value, Matcher matcher) { + if (StrUtil.isBlank(value)) { + return false; + } + for (int i = value.length(); --i >= 0; ) { + if (false == matcher.match(value.charAt(i))) { + return false; + } + } + return true; + } + + /** + * 检查字符串是否都为数字组成 + * + * @param str 字符串 + * @return 是否都为数字组成 + * @since 5.7.3 + */ + public static boolean isNumeric(CharSequence str) { + return isAllCharMatch(str, Character::isDigit); + } + + /** + * 循环位移指定位置的字符串为指定距离
+ * 当moveLength大于0向右位移，小于0向左位移，0不位移
+ * 当moveLength大于字符串长度时采取循环位移策略，即位移到头后从头（尾）位移，例如长度为10，位移13则表示位移3 + * + * @param str 字符串 + * @param startInclude 起始位置（包括） + * @param endExclude 结束位置（不包括） + * @param moveLength 移动距离，负数表示左移，正数为右移 + * @return 位移后的字符串 + * @since 4.0.7 + */ + public static String move(CharSequence str, int startInclude, int endExclude, int moveLength) { + if (isEmpty(str)) { + return str(str); + } + int len = str.length(); + if (Math.abs(moveLength) > len) { + // 循环位移，当越界时循环 + moveLength = moveLength % len; + } + final StringBuilder strBuilder = new StringBuilder(len); + if (moveLength > 0) { + int endAfterMove = Math.min(endExclude + moveLength, str.length()); + strBuilder.append(str.subSequence(0, startInclude))// + .append(str.subSequence(endExclude, endAfterMove))// + .append(str.subSequence(startInclude, endExclude))// + .append(str.subSequence(endAfterMove, str.length())); + } else if (moveLength < 0) { + int startAfterMove = Math.max(startInclude + moveLength, 0); + strBuilder.append(str.subSequence(0, startAfterMove))// + .append(str.subSequence(startInclude, endExclude))// + .append(str.subSequence(startAfterMove, startInclude))// + .append(str.subSequence(endExclude, str.length())); + } else { + return str(str); + } + return strBuilder.toString(); + } + + /** + * 检查给定字符串的所有字符是否都一样 + * + * @param str 字符出啊 + * @return 给定字符串的所有字符是否都一样 + * @since 5.7.3 + */ + public static boolean isCharEquals(CharSequence str) { + Assert.notEmpty(str, "Str to check must be not empty!"); + return count(str, str.charAt(0)) == str.length(); + } + + /** + * 对字符串归一化处理，如 "Á" 可以使用 "u00C1"或 "u0041u0301"表示，实际测试中两个字符串并不equals
+ * 因此使用此方法归一为一种表示形式，默认按照W3C通常建议的，在NFC中交换文本。 + * + * @param str 归一化的字符串 + * @return 归一化后的字符串 + * @see Normalizer#normalize(CharSequence, Normalizer.Form) + * @since 5.7.16 + */ + public static String normalize(CharSequence str) { + return Normalizer.normalize(str, Normalizer.Form.NFC); + } + + /** + * 在给定字符串末尾填充指定字符，以达到给定长度
+ * 如果字符串本身的长度大于等于length，返回原字符串 + * + * @param str 字符串 + * @param fixedChar 补充的字符 + * @param length 补充到的长度 + * @return 补充后的字符串 + * @since 5.8.0 + */ + public static String fixLength(CharSequence str, char fixedChar, int length) { + final int fixedLength = length - str.length(); + if (fixedLength <= 0) { + return str.toString(); + } + return str + repeat(fixedChar, fixedLength); + } + + /** + *

指定字符串数组中，是否包含空字符串。

+ *

如果传入参数对象不是为空,则返回false。如果字符串包含字母,不区分大小写,则返回true

+ * + * @param str 对象 + * @return 如果为字符串, 是否有字母 + */ + public static boolean hasLetter(CharSequence str) { + if (null == str) { + return false; + } + for (int i = 0; i < str.length(); i++) { + if (CharUtil.isLetter(str.charAt(i))) { + return true; + } + } + return false; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/NamingCase.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/NamingCase.java new file mode 100644 index 0000000..d937d7f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/NamingCase.java @@ -0,0 +1,192 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 命名规则封装，主要是针对驼峰风格命名、连接符命名等的封装 + * + * @author looly + * @since 5.7.10 + */ +public class NamingCase { + + /** + * 将驼峰式命名的字符串转换为下划线方式，又称SnakeCase、underScoreCase。
+ * 如果转换前的驼峰式命名的字符串为空，则返回空字符串。
+ * 规则为： + *
    + *
  • 单字之间以下划线隔开
    • + *
  • 每个单字的首字母亦用小写字母
    • + *
+ * 例如： + * + * 
+	 * HelloWorld=》hello_world
+	 * Hello_World=》hello_world
+	 * HelloWorld_test=》hello_world_test
+	 *
+ * + * @param str 转换前的驼峰式命名的字符串，也可以为下划线形式 + * @return 转换后下划线方式命名的字符串 + */ + public static String toUnderlineCase(CharSequence str) { + return toSymbolCase(str, CharUtil.UNDERLINE); + } + + /** + * 将驼峰式命名的字符串转换为短横连接方式。
+ * 如果转换前的驼峰式命名的字符串为空，则返回空字符串。
+ * 规则为： + *
    + *
  • 单字之间横线线隔开
    • + *
  • 每个单字的首字母亦用小写字母
    • + *
+ * 例如： + * + * 
+	 * HelloWorld=》hello-world
+	 * Hello_World=》hello-world
+	 * HelloWorld_test=》hello-world-test
+	 *
+ * + * @param str 转换前的驼峰式命名的字符串，也可以为下划线形式 + * @return 转换后下划线方式命名的字符串 + */ + public static String toKebabCase(CharSequence str) { + return toSymbolCase(str, CharUtil.DASHED); + } + + /** + * 将驼峰式命名的字符串转换为使用符号连接方式。如果转换前的驼峰式命名的字符串为空，则返回空字符串。 + * + * @param str 转换前的驼峰式命名的字符串，也可以为符号连接形式 + * @param symbol 连接符 + * @return 转换后符号连接方式命名的字符串 + * @since 4.0.10 + */ + public static String toSymbolCase(CharSequence str, char symbol) { + if (str == null) { + return null; + } + + final int length = str.length(); + final StrBuilder sb = new StrBuilder(); + char c; + for (int i = 0; i < length; i++) { + c = str.charAt(i); + if (Character.isUpperCase(c)) { + final Character preChar = (i > 0) ? str.charAt(i - 1) : null; + final Character nextChar = (i < str.length() - 1) ? str.charAt(i + 1) : null; + + if (null != preChar) { + if (symbol == preChar) { + // 前一个为分隔符 + if (null == nextChar || Character.isLowerCase(nextChar)) { + //普通首字母大写，如_Abb -> _abb + c = Character.toLowerCase(c); + } + //后一个为大写，按照专有名词对待，如_AB -> _AB + } else if (Character.isLowerCase(preChar)) { + // 前一个为小写 + sb.append(symbol); + if (null == nextChar || Character.isLowerCase(nextChar) || CharUtil.isNumber(nextChar)) { + //普通首字母大写，如aBcc -> a_bcc + c = Character.toLowerCase(c); + } + // 后一个为大写，按照专有名词对待，如aBC -> a_BC + } else { + //前一个为大写 + if (null != nextChar && Character.isLowerCase(nextChar)) { + // 普通首字母大写，如ABcc -> A_bcc + sb.append(symbol); + c = Character.toLowerCase(c); + } + // 后一个为大写，按照专有名词对待，如ABC -> ABC + } + } else { + // 首字母，需要根据后一个判断是否转为小写 + if (null == nextChar || Character.isLowerCase(nextChar)) { + // 普通首字母大写，如Abc -> abc + c = Character.toLowerCase(c); + } + // 后一个为大写，按照专有名词对待，如ABC -> ABC + } + } + sb.append(c); + } + return sb.toString(); + } + + /** + * 将下划线方式命名的字符串转换为帕斯卡式。
+ * 规则为： + *
    + *
  • 单字之间不以空格或任何连接符断开
    • + *
  • 第一个单字首字母采用大写字母
    • + *
  • 后续单字的首字母亦用大写字母
    • + *
+ * 如果转换前的下划线大写方式命名的字符串为空，则返回空字符串。
+ * 例如：hello_world=》HelloWorld + * + * @param name 转换前的下划线大写方式命名的字符串 + * @return 转换后的驼峰式命名的字符串 + */ + public static String toPascalCase(CharSequence name) { + return StrUtil.upperFirst(toCamelCase(name)); + } + + /** + * 将下划线方式命名的字符串转换为驼峰式。如果转换前的下划线大写方式命名的字符串为空，则返回空字符串。
+ * 规则为： + *
    + *
  • 单字之间不以空格或任何连接符断开
    • + *
  • 第一个单字首字母采用小写字母
    • + *
  • 后续单字的首字母亦用大写字母
    • + *
+ * 例如：hello_world=》helloWorld + * + * @param name 转换前的下划线大写方式命名的字符串 + * @return 转换后的驼峰式命名的字符串 + */ + public static String toCamelCase(CharSequence name) { + return toCamelCase(name, CharUtil.UNDERLINE); + } + + /** + * 将连接符方式命名的字符串转换为驼峰式。如果转换前的下划线大写方式命名的字符串为空，则返回空字符串。 + * + * @param name 转换前的自定义方式命名的字符串 + * @param symbol 原字符串中的连接符连接符 + * @return 转换后的驼峰式命名的字符串 + * @since 5.7.17 + */ + public static String toCamelCase(CharSequence name, char symbol) { + if (null == name) { + return null; + } + + final String name2 = name.toString(); + if (StrUtil.contains(name2, symbol)) { + final int length = name2.length(); + final StringBuilder sb = new StringBuilder(length); + boolean upperCase = false; + for (int i = 0; i < length; i++) { + char c = name2.charAt(i); + + if (c == symbol) { + upperCase = true; + } else if (upperCase) { + sb.append(Character.toUpperCase(c)); + upperCase = false; + } else { + sb.append(Character.toLowerCase(c)); + } + } + return sb.toString(); + } else { + return name2; + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/PasswdStrength.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/PasswdStrength.java new file mode 100755 index 0000000..cafbfbe --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/PasswdStrength.java @@ -0,0 +1,288 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 检测密码强度
+ * 来自：https://github.com/venshine/CheckPasswordStrength + * + * @author venshine + * @since 5.7.3 + */ +public class PasswdStrength { + + /** + * 密码等级枚举 + */ + public enum PASSWD_LEVEL { + EASY, MIDIUM, STRONG, VERY_STRONG, EXTREMELY_STRONG + } + + /** + * 字符类型枚举 + */ + public enum CHAR_TYPE { + NUM, SMALL_LETTER, CAPITAL_LETTER, OTHER_CHAR + } + + /** + * 简单密码字典 + */ + private final static String[] DICTIONARY = {"password", "abc123", "iloveyou", "adobe123", "123123", "sunshine", + "1314520", "a1b2c3", "123qwe", "aaa111", "qweasd", "admin", "passwd"}; + + /** + * 数字长度 + */ + private final static int[] SIZE_TABLE = {9, 99, 999, 9999, 99999, 999999, 9999999, 99999999, 999999999, + Integer.MAX_VALUE}; + + /** + * 检查密码的健壮性 + * + * @param passwd 密码 + * @return strength level + */ + public static int check(String passwd) { + if (null == passwd) { + throw new IllegalArgumentException("password is empty"); + } + int len = passwd.length(); + int level = 0; + + // increase points + if (countLetter(passwd, CHAR_TYPE.NUM) > 0) { + level++; + } + if (countLetter(passwd, CHAR_TYPE.SMALL_LETTER) > 0) { + level++; + } + if (len > 4 && countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) > 0) { + level++; + } + if (len > 6 && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) > 0) { + level++; + } + + if (len > 4 && countLetter(passwd, CHAR_TYPE.NUM) > 0 && countLetter(passwd, CHAR_TYPE.SMALL_LETTER) > 0 + || countLetter(passwd, CHAR_TYPE.NUM) > 0 && countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) > 0 + || countLetter(passwd, CHAR_TYPE.NUM) > 0 && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) > 0 + || countLetter(passwd, CHAR_TYPE.SMALL_LETTER) > 0 && countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) > 0 + || countLetter(passwd, CHAR_TYPE.SMALL_LETTER) > 0 && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) > 0 + || countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) > 0 && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) > 0) { + level++; + } + + if (len > 6 && countLetter(passwd, CHAR_TYPE.NUM) > 0 && countLetter(passwd, CHAR_TYPE.SMALL_LETTER) > 0 + && countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) > 0 || countLetter(passwd, CHAR_TYPE.NUM) > 0 + && countLetter(passwd, CHAR_TYPE.SMALL_LETTER) > 0 && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) > 0 + || countLetter(passwd, CHAR_TYPE.NUM) > 0 && countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) > 0 + && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) > 0 || countLetter(passwd, CHAR_TYPE.SMALL_LETTER) > 0 + && countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) > 0 && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) > 0) { + level++; + } + + if (len > 8 && countLetter(passwd, CHAR_TYPE.NUM) > 0 && countLetter(passwd, CHAR_TYPE.SMALL_LETTER) > 0 + && countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) > 0 && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) > 0) { + level++; + } + + if (len > 6 && countLetter(passwd, CHAR_TYPE.NUM) >= 3 && countLetter(passwd, CHAR_TYPE.SMALL_LETTER) >= 3 + || countLetter(passwd, CHAR_TYPE.NUM) >= 3 && countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) >= 3 + || countLetter(passwd, CHAR_TYPE.NUM) >= 3 && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) >= 2 + || countLetter(passwd, CHAR_TYPE.SMALL_LETTER) >= 3 && countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) >= 3 + || countLetter(passwd, CHAR_TYPE.SMALL_LETTER) >= 3 && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) >= 2 + || countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) >= 3 && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) >= 2) { + level++; + } + + if (len > 8 && countLetter(passwd, CHAR_TYPE.NUM) >= 2 && countLetter(passwd, CHAR_TYPE.SMALL_LETTER) >= 2 + && countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) >= 2 || countLetter(passwd, CHAR_TYPE.NUM) >= 2 + && countLetter(passwd, CHAR_TYPE.SMALL_LETTER) >= 2 && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) >= 2 + || countLetter(passwd, CHAR_TYPE.NUM) >= 2 && countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) >= 2 + && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) >= 2 || countLetter(passwd, CHAR_TYPE.SMALL_LETTER) >= 2 + && countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) >= 2 && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) >= 2) { + level++; + } + + if (len > 10 && countLetter(passwd, CHAR_TYPE.NUM) >= 2 && countLetter(passwd, CHAR_TYPE.SMALL_LETTER) >= 2 + && countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) >= 2 && countLetter(passwd, CHAR_TYPE.OTHER_CHAR) >= 2) { + level++; + } + + if (countLetter(passwd, CHAR_TYPE.OTHER_CHAR) >= 3) { + level++; + } + if (countLetter(passwd, CHAR_TYPE.OTHER_CHAR) >= 6) { + level++; + } + + if (len > 12) { + level++; + if (len >= 16) { + level++; + } + } + + // decrease points + if ("abcdefghijklmnopqrstuvwxyz".indexOf(passwd) > 0 || "ABCDEFGHIJKLMNOPQRSTUVWXYZ".indexOf(passwd) > 0) { + level--; + } + if ("qwertyuiop".indexOf(passwd) > 0 || "asdfghjkl".indexOf(passwd) > 0 || "zxcvbnm".indexOf(passwd) > 0) { + level--; + } + if (StrUtil.isNumeric(passwd) && ("01234567890".indexOf(passwd) > 0 || "09876543210".indexOf(passwd) > 0)) { + level--; + } + + if (countLetter(passwd, CHAR_TYPE.NUM) == len || countLetter(passwd, CHAR_TYPE.SMALL_LETTER) == len + || countLetter(passwd, CHAR_TYPE.CAPITAL_LETTER) == len) { + level--; + } + + if (len % 2 == 0) { // aaabbb + String part1 = passwd.substring(0, len / 2); + String part2 = passwd.substring(len / 2); + if (part1.equals(part2)) { + level--; + } + if (StrUtil.isCharEquals(part1) && StrUtil.isCharEquals(part2)) { + level--; + } + } + if (len % 3 == 0) { // ababab + String part1 = passwd.substring(0, len / 3); + String part2 = passwd.substring(len / 3, len / 3 * 2); + String part3 = passwd.substring(len / 3 * 2); + if (part1.equals(part2) && part2.equals(part3)) { + level--; + } + } + + if (StrUtil.isNumeric(passwd) && len >= 6 && len <= 8) { // 19881010 or 881010 + int year = 0; + if (len == 8 || len == 6) { + year = Integer.parseInt(passwd.substring(0, len - 4)); + } + int size = sizeOfInt(year); + int month = Integer.parseInt(passwd.substring(size, size + 2)); + int day = Integer.parseInt(passwd.substring(size + 2, len)); + if (year >= 1950 && year < 2050 && month >= 1 && month <= 12 && day >= 1 && day <= 31) { + level--; + } + } + + for (String s : DICTIONARY) { + if (passwd.equals(s) || s.contains(passwd)) { + level--; + break; + } + } + + if (len <= 6) { + level--; + if (len <= 4) { + level--; + if (len <= 3) { + level = 0; + } + } + } + + if (StrUtil.isCharEquals(passwd)) { + level = 0; + } + + if (level < 0) { + level = 0; + } + + return level; + } + + /** + * Get password strength level, includes easy, midium, strong, very strong, extremely strong + * + * @param passwd 密码 + * @return 密码等级枚举 + */ + public static PASSWD_LEVEL getLevel(String passwd) { + int level = check(passwd); + switch (level) { + case 0: + case 1: + case 2: + case 3: + return PASSWD_LEVEL.EASY; + case 4: + case 5: + case 6: + return PASSWD_LEVEL.MIDIUM; + case 7: + case 8: + case 9: + return PASSWD_LEVEL.STRONG; + case 10: + case 11: + case 12: + return PASSWD_LEVEL.VERY_STRONG; + default: + return PASSWD_LEVEL.EXTREMELY_STRONG; + } + } + + /** + * Check character's type, includes num, capital letter, small letter and other character. + * 检查字符类型 + * + * @param c 字符 + * @return 类型 + */ + private static CHAR_TYPE checkCharacterType(char c) { + if (c >= 48 && c <= 57) { + return CHAR_TYPE.NUM; + } + if (c >= 65 && c <= 90) { + return CHAR_TYPE.CAPITAL_LETTER; + } + if (c >= 97 && c <= 122) { + return CHAR_TYPE.SMALL_LETTER; + } + return CHAR_TYPE.OTHER_CHAR; + } + + /** + * 计算密码中指定字符类型的数量 + * + * @param passwd 密码 + * @param type 类型 + * @return 数量 + */ + private static int countLetter(String passwd, CHAR_TYPE type) { + int count = 0; + if (null != passwd) { + final int length = passwd.length(); + if (length > 0) { + for (int i = 0; i < length; i++) { + if (checkCharacterType(passwd.charAt(i)) == type) { + count++; + } + } + } + } + return count; + } + + /** + * calculate the size of an integer number + * + * @param x 值 + * @return 数字长度 + */ + private static int sizeOfInt(int x) { + for (int i = 0; ; i++) + if (x <= SIZE_TABLE[i]) { + return i + 1; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/Simhash.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/Simhash.java new file mode 100644 index 0000000..0184388 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/Simhash.java @@ -0,0 +1,195 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +import aiyh.utils.tool.cn.hutool.core.lang.hash.MurmurHash; + +import java.math.BigInteger; +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.locks.StampedLock; + +/** + *

+ * Simhash是一种局部敏感hash，用于海量文本去重。
+ * 算法实现来自：https://github.com/xlturing/Simhash4J + *

+ * + *

+ * 局部敏感hash定义：假定两个字符串具有一定的相似性，在hash之后，仍然能保持这种相似性，就称之为局部敏感hash。 + *

+ * + * @author Looly, litaoxiao + * @since 4.3.3 + */ +public class Simhash { + + private final int bitNum = 64; + /** 存储段数，默认按照4段进行simhash存储 */ + private final int fracCount; + private final int fracBitNum; + /** 汉明距离的衡量标准，小于此距离标准表示相似 */ + private final int hammingThresh; + + /** 按照分段存储simhash，查找更快速 */ + private final List>> storage; + private final StampedLock lock = new StampedLock(); + + /** + * 构造 + */ + public Simhash() { + this(4, 3); + } + + /** + * 构造 + * + * @param fracCount 存储段数 + * @param hammingThresh 汉明距离的衡量标准 + */ + public Simhash(int fracCount, int hammingThresh) { + this.fracCount = fracCount; + this.fracBitNum = bitNum / fracCount; + this.hammingThresh = hammingThresh; + this.storage = new ArrayList<>(fracCount); + for (int i = 0; i < fracCount; i++) { + storage.add(new HashMap<>()); + } + } + + /** + * 指定文本计算simhash值 + * + * @param segList 分词的词列表 + * @return Hash值 + */ + public long hash(Collection segList) { + final int bitNum = this.bitNum; + // 按照词语的hash值，计算simHashWeight(低位对齐) + final int[] weight = new int[bitNum]; + long wordHash; + for (CharSequence seg : segList) { + wordHash = MurmurHash.hash64(seg); + for (int i = 0; i < bitNum; i++) { + if (((wordHash >> i) & 1) == 1) + weight[i] += 1; + else + weight[i] -= 1; + } + } + + // 计算得到Simhash值 + final StringBuilder sb = new StringBuilder(); + for (int i = 0; i < bitNum; i++) { + sb.append((weight[i] > 0) ? 1 : 0); + } + + return new BigInteger(sb.toString(), 2).longValue(); + } + + /** + * 判断文本是否与已存储的数据重复 + * + * @param segList 文本分词后的结果 + * @return 是否重复 + */ + public boolean equals(Collection segList) { + long simhash = hash(segList); + final List fracList = splitSimhash(simhash); + final int hammingThresh = this.hammingThresh; + + String frac; + Map> fracMap; + final long stamp = this.lock.readLock(); + try { + for (int i = 0; i < fracCount; i++) { + frac = fracList.get(i); + fracMap = storage.get(i); + if (fracMap.containsKey(frac)) { + for (Long simhash2 : fracMap.get(frac)) { + // 当汉明距离小于标准时相似 + if (hamming(simhash, simhash2) < hammingThresh) { + return true; + } + } + } + } + } finally { + this.lock.unlockRead(stamp); + } + return false; + } + + /** + * 按照(frac, 《simhash, content》)索引进行存储 + * + * @param simhash Simhash值 + */ + public void store(Long simhash) { + final int fracCount = this.fracCount; + final List>> storage = this.storage; + final List lFrac = splitSimhash(simhash); + + String frac; + Map> fracMap; + final long stamp = this.lock.writeLock(); + try { + for (int i = 0; i < fracCount; i++) { + frac = lFrac.get(i); + fracMap = storage.get(i); + if (fracMap.containsKey(frac)) { + fracMap.get(frac).add(simhash); + } else { + final List ls = new ArrayList<>(); + ls.add(simhash); + fracMap.put(frac, ls); + } + } + } finally { + this.lock.unlockWrite(stamp); + } + } + + //------------------------------------------------------------------------------------------------------ Private method start + /** + * 计算汉明距离 + * + * @param s1 值1 + * @param s2 值2 + * @return 汉明距离 + */ + private int hamming(Long s1, Long s2) { + final int bitNum = this.bitNum; + int dis = 0; + for (int i = 0; i < bitNum; i++) { + if ((s1 >> i & 1) != (s2 >> i & 1)) + dis++; + } + return dis; + } + + /** + * 将simhash分成n段 + * + * @param simhash Simhash值 + * @return N段Simhash + */ + private List splitSimhash(Long simhash) { + final int bitNum = this.bitNum; + final int fracBitNum = this.fracBitNum; + + final List ls = new ArrayList<>(); + final StringBuilder sb = new StringBuilder(); + for (int i = 0; i < bitNum; i++) { + sb.append(simhash >> i & 1); + if ((i + 1) % fracBitNum == 0) { + ls.add(sb.toString()); + sb.setLength(0); + } + } + return ls; + } + //------------------------------------------------------------------------------------------------------ Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrBuilder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrBuilder.java new file mode 100644 index 0000000..24fe221 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrBuilder.java @@ -0,0 +1,587 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.util.Arrays; + +/** + * 可复用的字符串生成器，非线程安全
+ * TODO 6.x移除此类，java8的StringBuilder非常完善了，无需重写。 + * + * @author Looly + * @since 4.0.0 + */ +public class StrBuilder implements CharSequence, Appendable, Serializable { + private static final long serialVersionUID = 6341229705927508451L; + + /** + * 默认容量 + */ + public static final int DEFAULT_CAPACITY = 16; + + /** + * 存放的字符数组 + */ + private char[] value; + /** + * 当前指针位置，或者叫做已经加入的字符数，此位置总在最后一个字符之后 + */ + private int position; + + /** + * 创建字符串构建器 + * + * @return this + */ + public static StrBuilder create() { + return new StrBuilder(); + } + + /** + * 创建字符串构建器 + * + * @param initialCapacity 初始容量 + * @return this + */ + public static StrBuilder create(int initialCapacity) { + return new StrBuilder(initialCapacity); + } + + /** + * 创建字符串构建器 + * + * @param strs 初始字符串 + * @return this + * @since 4.0.1 + */ + public static StrBuilder create(CharSequence... strs) { + return new StrBuilder(strs); + } + + // ------------------------------------------------------------------------------------ Constructor start + + /** + * 构造 + */ + public StrBuilder() { + this(DEFAULT_CAPACITY); + } + + /** + * 构造 + * + * @param initialCapacity 初始容量 + */ + public StrBuilder(int initialCapacity) { + value = new char[initialCapacity]; + } + + /** + * 构造 + * + * @param strs 初始字符串 + * @since 4.0.1 + */ + public StrBuilder(CharSequence... strs) { + this(ArrayUtil.isEmpty(strs) ? DEFAULT_CAPACITY : (totalLength(strs) + DEFAULT_CAPACITY)); + for (CharSequence str : strs) { + append(str); + } + } + // ------------------------------------------------------------------------------------ Constructor end + + // ------------------------------------------------------------------------------------ Append + + /** + * 追加对象，对象会被转换为字符串 + * + * @param obj 对象 + * @return this + */ + public StrBuilder append(Object obj) { + return insert(this.position, obj); + } + + /** + * 追加一个字符 + * + * @param c 字符 + * @return this + */ + @Override + public StrBuilder append(char c) { + return insert(this.position, c); + } + + /** + * 追加一个字符数组 + * + * @param src 字符数组 + * @return this + */ + public StrBuilder append(char[] src) { + if (ArrayUtil.isEmpty(src)) { + return this; + } + return append(src, 0, src.length); + } + + /** + * 追加一个字符数组 + * + * @param src 字符数组 + * @param srcPos 开始位置（包括） + * @param length 长度 + * @return this + */ + public StrBuilder append(char[] src, int srcPos, int length) { + return insert(this.position, src, srcPos, length); + } + + @Override + public StrBuilder append(CharSequence csq) { + return insert(this.position, csq); + } + + @Override + public StrBuilder append(CharSequence csq, int start, int end) { + return insert(this.position, csq, start, end); + } + + // ------------------------------------------------------------------------------------ Insert + + /** + * 追加对象，对象会被转换为字符串 + * + * @param index 插入位置 + * @param obj 对象 + * @return this + */ + public StrBuilder insert(int index, Object obj) { + if (obj instanceof CharSequence) { + return insert(index, (CharSequence) obj); + } + return insert(index, Convert.toStr(obj)); + } + + /** + * 插入指定字符 + * + * @param index 位置 + * @param c 字符 + * @return this + */ + public StrBuilder insert(int index, char c) { + if(index < 0){ + index = this.position + index; + } + if ((index < 0)) { + throw new StringIndexOutOfBoundsException(index); + } + + moveDataAfterIndex(index, 1); + value[index] = c; + this.position = Math.max(this.position, index) + 1; + return this; + } + + /** + * 指定位置插入数据
+ * 如果插入位置为当前位置，则定义为追加
+ * 如果插入位置大于当前位置，则中间部分补充空格 + * + * @param index 插入位置 + * @param src 源数组 + * @return this + */ + public StrBuilder insert(int index, char[] src) { + if (ArrayUtil.isEmpty(src)) { + return this; + } + return insert(index, src, 0, src.length); + } + + /** + * 指定位置插入数据
+ * 如果插入位置为当前位置，则定义为追加
+ * 如果插入位置大于当前位置，则中间部分补充空格 + * + * @param index 插入位置 + * @param src 源数组 + * @param srcPos 位置 + * @param length 长度 + * @return this + */ + public StrBuilder insert(int index, char[] src, int srcPos, int length) { + if (ArrayUtil.isEmpty(src) || srcPos > src.length || length <= 0) { + return this; + } + if(index < 0){ + index = this.position + index; + } + if ((index < 0)) { + throw new StringIndexOutOfBoundsException(index); + } + + if (srcPos < 0) { + srcPos = 0; + } else if (srcPos + length > src.length) { + // 长度越界，只截取最大长度 + length = src.length - srcPos; + } + + moveDataAfterIndex(index, length); + // 插入数据 + System.arraycopy(src, srcPos, value, index, length); + this.position = Math.max(this.position, index) + length; + return this; + } + + /** + * 指定位置插入字符串的某个部分
+ * 如果插入位置为当前位置，则定义为追加
+ * 如果插入位置大于当前位置，则中间部分补充空格 + * + * @param index 位置 + * @param csq 字符串 + * @return this + */ + public StrBuilder insert(int index, CharSequence csq) { + if(index < 0){ + index = this.position + index; + } + if ((index < 0)) { + throw new StringIndexOutOfBoundsException(index); + } + + if (null == csq) { + csq = StrUtil.EMPTY; + } + int len = csq.length(); + moveDataAfterIndex(index, csq.length()); + if (csq instanceof String) { + ((String) csq).getChars(0, len, this.value, index); + } else if (csq instanceof StringBuilder) { + ((StringBuilder) csq).getChars(0, len, this.value, index); + } else if (csq instanceof StringBuffer) { + ((StringBuffer) csq).getChars(0, len, this.value, index); + } else if (csq instanceof StrBuilder) { + ((StrBuilder) csq).getChars(0, len, this.value, index); + } else { + for (int i = 0, j = this.position; i < len; i++, j++) { + this.value[j] = csq.charAt(i); + } + } + this.position = Math.max(this.position, index) + len; + return this; + } + + /** + * 指定位置插入字符串的某个部分
+ * 如果插入位置为当前位置，则定义为追加
+ * 如果插入位置大于当前位置，则中间部分补充空格 + * + * @param index 位置 + * @param csq 字符串 + * @param start 字符串开始位置（包括） + * @param end 字符串结束位置（不包括） + * @return this + */ + public StrBuilder insert(int index, CharSequence csq, int start, int end) { + if (csq == null) { + csq = "null"; + } + final int csqLen = csq.length(); + if (start > csqLen) { + return this; + } + if (start < 0) { + start = 0; + } + if (end > csqLen) { + end = csqLen; + } + if (start >= end) { + return this; + } + if(index < 0){ + index = this.position + index; + } + if ((index < 0)) { + throw new StringIndexOutOfBoundsException(index); + } + + final int length = end - start; + moveDataAfterIndex(index, length); + for (int i = start, j = this.position; i < end; i++, j++) { + value[j] = csq.charAt(i); + } + this.position = Math.max(this.position, index) + length; + return this; + } + + // ------------------------------------------------------------------------------------ Others + + /** + * 将指定段的字符列表写出到目标字符数组中 + * + * @param srcBegin 起始位置（包括） + * @param srcEnd 结束位置（不包括） + * @param dst 目标数组 + * @param dstBegin 目标起始位置（包括） + * @return this + */ + public StrBuilder getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin) { + if (srcBegin < 0) { + srcBegin = 0; + } + if (srcEnd < 0) { + srcEnd = 0; + } else if (srcEnd > this.position) { + srcEnd = this.position; + } + if (srcBegin > srcEnd) { + throw new StringIndexOutOfBoundsException("srcBegin > srcEnd"); + } + System.arraycopy(value, srcBegin, dst, dstBegin, srcEnd - srcBegin); + return this; + } + + /** + * 是否有内容 + * + * @return 是否有内容 + */ + public boolean hasContent() { + return position > 0; + } + + /** + * 是否为空 + * + * @return 是否为空 + */ + public boolean isEmpty() { + return position == 0; + } + + /** + * 删除全部字符，位置归零 + * + * @return this + */ + public StrBuilder clear() { + return reset(); + } + + /** + * 删除全部字符，位置归零 + * + * @return this + */ + public StrBuilder reset() { + this.position = 0; + return this; + } + + /** + * 删除到指定位置
+ * 如果新位置小于等于0，则删除全部 + * + * @param newPosition 新的位置，不包括这个位置 + * @return this + */ + public StrBuilder delTo(int newPosition) { + if (newPosition < 0) { + newPosition = 0; + } + return del(newPosition, this.position); + } + + /** + * 删除指定长度的字符，规则如下： + * + * 
+	 * 1、end大于等于最大长度，结束按照最大长度计算，相当于删除start之后虽有部分（性能最好）
+	 * 2、end小于start时，抛出StringIndexOutOfBoundsException
+	 * 3、start小于0 按照0处理
+	 * 4、start等于end不处理
+	 * 5、start和end都位于长度区间内，删除这段内容（内存拷贝）
+	 *
+ * + * @param start 开始位置，负数按照0处理（包括） + * @param end 结束位置，超出最大长度按照最大长度处理（不包括） + * @return this + * @throws StringIndexOutOfBoundsException 当start > end抛出此异常 + */ + public StrBuilder del(int start, int end) throws StringIndexOutOfBoundsException { + if (start < 0) { + start = 0; + } + + if (end >= this.position) { + // end在边界及以外，相当于删除后半部分 + this.position = start; + return this; + } else if (end < 0) { + // start和end都为0的情况下表示删除全部 + end = 0; + } + + int len = end - start; + // 截取中间部分，需要将后半部分复制到删除的开始位置 + if (len > 0) { + System.arraycopy(value, start + len, value, start, this.position - end); + this.position -= len; + } else if (len < 0) { + throw new StringIndexOutOfBoundsException("Start is greater than End."); + } + return this; + } + + /** + * 生成字符串 + * + * @param isReset 是否重置，重置后相当于空的构建器 + * @return 生成的字符串 + */ + public String toString(boolean isReset) { + if (position > 0) { + final String s = new String(value, 0, position); + if (isReset) { + reset(); + } + return s; + } + return StrUtil.EMPTY; + } + + /** + * 重置并返回生成的字符串 + * + * @return 字符串 + */ + public String toStringAndReset() { + return toString(true); + } + + /** + * 生成字符串 + */ + @Override + public String toString() { + return toString(false); + } + + @Override + public int length() { + return this.position; + } + + @Override + public char charAt(int index) { + if(index < 0){ + index = this.position + index; + } + if ((index < 0) || (index > this.position)) { + throw new StringIndexOutOfBoundsException(index); + } + return this.value[index]; + } + + @Override + public CharSequence subSequence(int start, int end) { + return subString(start, end); + } + + /** + * 返回自定段的字符串 + * + * @param start 开始位置（包括） + * @return this + */ + public String subString(int start) { + return subString(start, this.position); + } + + /** + * 返回自定段的字符串 + * + * @param start 开始位置（包括） + * @param end 结束位置（不包括） + * @return this + */ + public String subString(int start, int end) { + return new String(this.value, start, end - start); + } + + // ------------------------------------------------------------------------------------ Private method start + + /** + * 指定位置之后的数据后移指定长度 + * + * @param index 位置 + * @param length 位移长度 + */ + private void moveDataAfterIndex(int index, int length) { + ensureCapacity(Math.max(this.position, index) + length); + if (index < this.position) { + // 插入位置在已有数据范围内，后移插入位置之后的数据 + System.arraycopy(this.value, index, this.value, index + length, this.position - index); + } else if (index > this.position) { + // 插入位置超出范围，则当前位置到index清除为空格 + Arrays.fill(this.value, this.position, index, StrUtil.C_SPACE); + } + // 不位移 + } + + /** + * 确认容量是否够用，不够用则扩展容量 + * + * @param minimumCapacity 最小容量 + */ + private void ensureCapacity(int minimumCapacity) { + // overflow-conscious code + if (minimumCapacity - value.length > 0) { + expandCapacity(minimumCapacity); + } + } + + /** + * 扩展容量
+ * 首先对容量进行二倍扩展，如果小于最小容量，则扩展为最小容量 + * + * @param minimumCapacity 需要扩展的最小容量 + */ + private void expandCapacity(int minimumCapacity) { + int newCapacity = (value.length << 1) + 2; + // overflow-conscious code + if (newCapacity - minimumCapacity < 0) { + newCapacity = minimumCapacity; + } + if (newCapacity < 0) { + throw new OutOfMemoryError("Capacity is too long and max than Integer.MAX"); + } + value = Arrays.copyOf(value, newCapacity); + } + + /** + * 给定字符串数组的总长度
+ * null字符长度定义为0 + * + * @param strs 字符串数组 + * @return 总长度 + * @since 4.0.1 + */ + private static int totalLength(CharSequence... strs) { + int totalLength = 0; + for (CharSequence str : strs) { + totalLength += (null == str ? 0 : str.length()); + } + return totalLength; + } + // ------------------------------------------------------------------------------------ Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrFormatter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrFormatter.java new file mode 100644 index 0000000..0a81421 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrFormatter.java @@ -0,0 +1,126 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.Map; + +/** + * 字符串格式化工具 + * + * @author Looly + */ +public class StrFormatter { + + /** + * 格式化字符串
+ * 此方法只是简单将占位符 {} 按照顺序替换为参数
+ * 如果想输出 {} 使用 \\转义 { 即可，如果想输出 {} 之前的 \ 使用双转义符 \\\\ 即可
+ * 例：
+ * 通常使用：format("this is {} for {}", "a", "b") =》 this is a for b
+ * 转义{}： format("this is \\{} for {}", "a", "b") =》 this is \{} for a
+ * 转义\： format("this is \\\\{} for {}", "a", "b") =》 this is \a for b
+ * + * @param strPattern 字符串模板 + * @param argArray 参数列表 + * @return 结果 + */ + public static String format(String strPattern, Object... argArray) { + return formatWith(strPattern, StrUtil.EMPTY_JSON, argArray); + } + + /** + * 格式化字符串
+ * 此方法只是简单将指定占位符 按照顺序替换为参数
+ * 如果想输出占位符使用 \\转义即可，如果想输出占位符之前的 \ 使用双转义符 \\\\ 即可
+ * 例：
+ * 通常使用：format("this is {} for {}", "{}", "a", "b") =》 this is a for b
+ * 转义{}： format("this is \\{} for {}", "{}", "a", "b") =》 this is {} for a
+ * 转义\： format("this is \\\\{} for {}", "{}", "a", "b") =》 this is \a for b
+ * + * @param strPattern 字符串模板 + * @param placeHolder 占位符，例如{} + * @param argArray 参数列表 + * @return 结果 + * @since 5.7.14 + */ + public static String formatWith(String strPattern, String placeHolder, Object... argArray) { + if (StrUtil.isBlank(strPattern) || StrUtil.isBlank(placeHolder) || ArrayUtil.isEmpty(argArray)) { + return strPattern; + } + final int strPatternLength = strPattern.length(); + final int placeHolderLength = placeHolder.length(); + + // 初始化定义好的长度以获得更好的性能 + final StringBuilder sbuf = new StringBuilder(strPatternLength + 50); + + int handledPosition = 0;// 记录已经处理到的位置 + int delimIndex;// 占位符所在位置 + for (int argIndex = 0; argIndex < argArray.length; argIndex++) { + delimIndex = strPattern.indexOf(placeHolder, handledPosition); + if (delimIndex == -1) {// 剩余部分无占位符 + if (handledPosition == 0) { // 不带占位符的模板直接返回 + return strPattern; + } + // 字符串模板剩余部分不再包含占位符，加入剩余部分后返回结果 + sbuf.append(strPattern, handledPosition, strPatternLength); + return sbuf.toString(); + } + + // 转义符 + if (delimIndex > 0 && strPattern.charAt(delimIndex - 1) == StrUtil.C_BACKSLASH) {// 转义符 + if (delimIndex > 1 && strPattern.charAt(delimIndex - 2) == StrUtil.C_BACKSLASH) {// 双转义符 + // 转义符之前还有一个转义符，占位符依旧有效 + sbuf.append(strPattern, handledPosition, delimIndex - 1); + sbuf.append(StrUtil.utf8Str(argArray[argIndex])); + handledPosition = delimIndex + placeHolderLength; + } else { + // 占位符被转义 + argIndex--; + sbuf.append(strPattern, handledPosition, delimIndex - 1); + sbuf.append(placeHolder.charAt(0)); + handledPosition = delimIndex + 1; + } + } else {// 正常占位符 + sbuf.append(strPattern, handledPosition, delimIndex); + sbuf.append(StrUtil.utf8Str(argArray[argIndex])); + handledPosition = delimIndex + placeHolderLength; + } + } + + // 加入最后一个占位符后所有的字符 + sbuf.append(strPattern, handledPosition, strPatternLength); + + return sbuf.toString(); + } + + /** + * 格式化文本，使用 {varName} 占位
+ * map = {a: "aValue", b: "bValue"} format("{a} and {b}", map) ---=》 aValue and bValue + * + * @param template 文本模板，被替换的部分用 {key} 表示 + * @param map 参数值对 + * @param ignoreNull 是否忽略 {@code null} 值，忽略则 {@code null} 值对应的变量不被替换，否则替换为"" + * @return 格式化后的文本 + * @since 5.7.10 + */ + public static String format(CharSequence template, Map map, boolean ignoreNull) { + if (null == template) { + return null; + } + if (null == map || map.isEmpty()) { + return template.toString(); + } + + String template2 = template.toString(); + String value; + for (Map.Entry entry : map.entrySet()) { + value = StrUtil.utf8Str(entry.getValue()); + if (null == value && ignoreNull) { + continue; + } + template2 = StrUtil.replace(template2, "{" + entry.getKey() + "}", value); + } + return template2; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrJoiner.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrJoiner.java new file mode 100644 index 0000000..70c3bc6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrJoiner.java @@ -0,0 +1,434 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +import aiyh.utils.tool.cn.hutool.core.collection.ArrayIter; +import aiyh.utils.tool.cn.hutool.core.collection.IterUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.IOException; +import java.io.Serializable; +import java.util.Iterator; +import java.util.function.Function; + +/** + * 字符串连接器（拼接器），通过给定的字符串和多个元素，拼接为一个字符串
+ * 相较于{@link java.util.StringJoiner}提供更加灵活的配置，包括： + *
    + *
  • 支持任意Appendable接口实现
    • + *
  • 支持每个元素单独wrap
    • + *
  • 支持自定义null的处理逻辑
    • + *
  • 支持自定义默认结果
    • + *
+ * + * @author looly + * @since 5.7.2 + */ +public class StrJoiner implements Appendable, Serializable { + private static final long serialVersionUID = 1L; + + private Appendable appendable; + private CharSequence delimiter; + private CharSequence prefix; + private CharSequence suffix; + // 前缀和后缀是否包装每个元素，true表示包装每个元素，false包装整个字符串 + private boolean wrapElement; + // null元素处理逻辑 + private NullMode nullMode = NullMode.NULL_STRING; + // 当结果为空时默认返回的拼接结果 + private String emptyResult = StrUtil.EMPTY; + + // appendable中是否包含内容，用于判断增加内容时，是否首先加入分隔符 + private boolean hasContent; + + /** + * 根据已有StrJoiner配置新建一个新的StrJoiner + * + * @param joiner 已有StrJoiner + * @return 新的StrJoiner，配置相同 + * @since 5.7.12 + */ + public static StrJoiner of(StrJoiner joiner) { + StrJoiner joinerNew = new StrJoiner(joiner.delimiter, joiner.prefix, joiner.suffix); + joinerNew.wrapElement = joiner.wrapElement; + joinerNew.nullMode = joiner.nullMode; + joinerNew.emptyResult = joiner.emptyResult; + + return joinerNew; + } + + /** + * 使用指定分隔符创建StrJoiner + * + * @param delimiter 分隔符 + * @return StrJoiner + */ + public static StrJoiner of(CharSequence delimiter) { + return new StrJoiner(delimiter); + } + + /** + * 使用指定分隔符创建StrJoiner + * + * @param delimiter 分隔符 + * @param prefix 前缀 + * @param suffix 后缀 + * @return StrJoiner + */ + public static StrJoiner of(CharSequence delimiter, CharSequence prefix, CharSequence suffix) { + return new StrJoiner(delimiter, prefix, suffix); + } + + /** + * 构造 + * + * @param delimiter 分隔符，{@code null}表示无连接符，直接拼接 + */ + public StrJoiner(CharSequence delimiter) { + this(null, delimiter); + } + + /** + * 构造 + * + * @param appendable 字符串追加器，拼接的字符串都将加入到此，{@code null}使用默认{@link StringBuilder} + * @param delimiter 分隔符，{@code null}表示无连接符，直接拼接 + */ + public StrJoiner(Appendable appendable, CharSequence delimiter) { + this(appendable, delimiter, null, null); + } + + /** + * 构造 + * + * @param delimiter 分隔符，{@code null}表示无连接符，直接拼接 + * @param prefix 前缀 + * @param suffix 后缀 + */ + public StrJoiner(CharSequence delimiter, CharSequence prefix, CharSequence suffix) { + this(null, delimiter, prefix, suffix); + } + + /** + * 构造 + * + * @param appendable 字符串追加器，拼接的字符串都将加入到此，{@code null}使用默认{@link StringBuilder} + * @param delimiter 分隔符，{@code null}表示无连接符，直接拼接 + * @param prefix 前缀 + * @param suffix 后缀 + */ + public StrJoiner(Appendable appendable, CharSequence delimiter, + CharSequence prefix, CharSequence suffix) { + if (null != appendable) { + this.appendable = appendable; + checkHasContent(appendable); + } + + this.delimiter = delimiter; + this.prefix = prefix; + this.suffix = suffix; + } + + /** + * 设置分隔符 + * + * @param delimiter 分隔符 + * @return this + */ + public StrJoiner setDelimiter(CharSequence delimiter) { + this.delimiter = delimiter; + return this; + } + + /** + * 设置前缀 + * + * @param prefix 前缀 + * @return this + */ + public StrJoiner setPrefix(CharSequence prefix) { + this.prefix = prefix; + return this; + } + + /** + * 设置后缀 + * + * @param suffix 后缀 + * @return this + */ + public StrJoiner setSuffix(CharSequence suffix) { + this.suffix = suffix; + return this; + } + + /** + * 设置前缀和后缀是否包装每个元素 + * + * @param wrapElement true表示包装每个元素，false包装整个字符串 + * @return this + */ + public StrJoiner setWrapElement(boolean wrapElement) { + this.wrapElement = wrapElement; + return this; + } + + /** + * 设置{@code null}元素处理逻辑 + * + * @param nullMode 逻辑枚举，可选忽略、转换为""或转换为null字符串 + * @return this + */ + public StrJoiner setNullMode(NullMode nullMode) { + this.nullMode = nullMode; + return this; + } + + /** + * 设置当没有任何元素加入时，默认返回的字符串，默认"" + * + * @param emptyResult 默认字符串 + * @return this + */ + public StrJoiner setEmptyResult(String emptyResult) { + this.emptyResult = emptyResult; + return this; + } + + /** + * 追加对象到拼接器中 + * + * @param obj 对象，支持数组、集合等 + * @return this + */ + public StrJoiner append(Object obj) { + if (null == obj) { + append((CharSequence) null); + } else if (ArrayUtil.isArray(obj)) { + append(new ArrayIter<>(obj)); + } else if (obj instanceof Iterator) { + append((Iterator) obj); + } else if (obj instanceof Iterable) { + append(((Iterable) obj).iterator()); + } else { + append(ObjectUtil.toString(obj)); + } + return this; + } + + /** + * 追加数组中的元素到拼接器中 + * + * @param 元素类型 + * @param array 元素数组 + * @return this + */ + public StrJoiner append(T[] array) { + if (null == array) { + return this; + } + return append(new ArrayIter<>(array)); + } + + /** + * 追加{@link Iterator}中的元素到拼接器中 + * + * @param 元素类型 + * @param iterator 元素列表 + * @return this + */ + public StrJoiner append(Iterator iterator) { + if (null != iterator) { + while (iterator.hasNext()) { + append(iterator.next()); + } + } + return this; + } + + /** + * 追加数组中的元素到拼接器中 + * + * @param 元素类型 + * @param array 元素数组 + * @param toStrFunc 元素对象转换为字符串的函数 + * @return this + */ + public StrJoiner append(T[] array, Function toStrFunc) { + return append((Iterator) new ArrayIter<>(array), toStrFunc); + } + + /** + * 追加{@link Iterator}中的元素到拼接器中 + * + * @param 元素类型 + * @param iterable 元素列表 + * @param toStrFunc 元素对象转换为字符串的函数 + * @return this + */ + public StrJoiner append(Iterable iterable, Function toStrFunc) { + return append(IterUtil.getIter(iterable), toStrFunc); + } + + /** + * 追加{@link Iterator}中的元素到拼接器中 + * + * @param 元素类型 + * @param iterator 元素列表 + * @param toStrFunc 元素对象转换为字符串的函数 + * @return this + */ + public StrJoiner append(Iterator iterator, Function toStrFunc) { + if (null != iterator) { + while (iterator.hasNext()) { + append(toStrFunc.apply(iterator.next())); + } + } + return this; + } + + @Override + public StrJoiner append(CharSequence csq) { + return append(csq, 0, StrUtil.length(csq)); + } + + @Override + public StrJoiner append(CharSequence csq, int startInclude, int endExclude) { + if (null == csq) { + switch (this.nullMode) { + case IGNORE: + return this; + case TO_EMPTY: + csq = StrUtil.EMPTY; + break; + case NULL_STRING: + csq = StrUtil.NULL; + endExclude = StrUtil.NULL.length(); + break; + } + } + try { + final Appendable appendable = prepare(); + if (wrapElement && StrUtil.isNotEmpty(this.prefix)) { + appendable.append(prefix); + } + appendable.append(csq, startInclude, endExclude); + if (wrapElement && StrUtil.isNotEmpty(this.suffix)) { + appendable.append(suffix); + } + } catch (IOException e) { + throw new IORuntimeException(e); + } + return this; + } + + @Override + public StrJoiner append(char c) { + return append(String.valueOf(c)); + } + + /** + * 合并一个StrJoiner 到当前的StrJoiner
+ * 合并规则为，在尾部直接追加，当存在{@link #prefix}时，如果{@link #wrapElement}为{@code false}，则去除之。 + * + * @param strJoiner 其他的StrJoiner + * @return this + * @since 5.7.22 + */ + public StrJoiner merge(StrJoiner strJoiner){ + if(null != strJoiner && null != strJoiner.appendable){ + final String otherStr = strJoiner.toString(); + if(strJoiner.wrapElement){ + this.append(otherStr); + }else{ + this.append(otherStr, this.prefix.length(), otherStr.length()); + } + } + return this; + } + + /** + * 长度
+ * 长度计算方式为prefix + suffix + content
+ * 此方法结果与toString().length()一致。 + * + * @return 长度，如果结果为{@code null}，返回-1 + * @since 5.7.22 + */ + public int length() { + return (this.appendable != null ? this.appendable.toString().length() + suffix.length() : + null == this.emptyResult ? -1 : emptyResult.length()); + } + + @Override + public String toString() { + if (null == this.appendable) { + return emptyResult; + } + + String result = this.appendable.toString(); + if (false == wrapElement && StrUtil.isNotEmpty(this.suffix)) { + result += this.suffix; + } + return result; + } + + /** + * {@code null}处理的模式 + */ + public enum NullMode { + /** + * 忽略{@code null}，即null元素不加入拼接的字符串 + */ + IGNORE, + /** + * {@code null}转为"" + */ + TO_EMPTY, + /** + * {@code null}转为null字符串 + */ + NULL_STRING + } + + /** + * 准备连接器，如果连接器非空，追加元素，否则初始化前缀 + * + * @return {@link Appendable} + * @throws IOException IO异常 + */ + private Appendable prepare() throws IOException { + if (hasContent) { + this.appendable.append(delimiter); + } else { + if (null == this.appendable) { + this.appendable = new StringBuilder(); + } + if (false == wrapElement && StrUtil.isNotEmpty(this.prefix)) { + this.appendable.append(this.prefix); + } + this.hasContent = true; + } + return this.appendable; + } + + /** + * 检查用户传入的{@link Appendable} 是否已经存在内容，而且不能以分隔符结尾 + * + * @param appendable {@link Appendable} + */ + private void checkHasContent(Appendable appendable) { + if (appendable instanceof CharSequence) { + final CharSequence charSequence = (CharSequence) appendable; + if (charSequence.length() > 0 && StrUtil.endWith(charSequence, delimiter)) { + this.hasContent = true; + } + } else { + final String initStr = appendable.toString(); + if (StrUtil.isNotEmpty(initStr) && false == StrUtil.endWith(initStr, delimiter)) { + this.hasContent = true; + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrMatcher.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrMatcher.java new file mode 100755 index 0000000..2180155 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrMatcher.java @@ -0,0 +1,119 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * 字符串模式匹配，使用${XXXXX}作为变量，例如： + * + * 
+ *     pattern: ${name}-${age}-${gender}-${country}-${province}-${city}-${status}
+ *     text:    "小明-19-男-中国-河南-郑州-已婚"
+ *     result:  {name=小明, age=19, gender=男, country=中国, province=河南, city=郑州, status=已婚}
+ *
+ * + * @author looly + * @since 5.6.0 + */ +public class StrMatcher { + + List patterns; + + /** + * 构造 + * + * @param pattern 模式，变量用${XXX}占位 + */ + public StrMatcher(String pattern) { + this.patterns = parse(pattern); + } + + /** + * 匹配并提取匹配到的内容 + * + * @param text 被匹配的文本 + * @return 匹配的map，key为变量名，value为匹配到的值 + */ + public Map match(String text) { + final HashMap result = MapUtil.newHashMap(true); + int from = 0; + String key = null; + int to; + for (String part : patterns) { + if (StrUtil.isWrap(part, "${", "}")) { + // 变量 + key = StrUtil.sub(part, 2, part.length() - 1); + } else { + to = text.indexOf(part, from); + if (to < 0) { + //普通字符串未匹配到，说明整个模式不能匹配，返回空 + return MapUtil.empty(); + } + if (null != key && to > from) { + // 变量对应部分有内容 + result.put(key, text.substring(from, to)); + } + // 下一个起始点是普通字符串的末尾 + from = to + part.length(); + key = null; + } + } + + if (null != key && from < text.length()) { + // 变量对应部分有内容 + result.put(key, text.substring(from)); + } + + return result; + } + + /** + * 解析表达式 + * + * @param pattern 表达式，使用${XXXX}作为变量占位符 + * @return 表达式 + */ + private static List parse(String pattern) { + List patterns = new ArrayList<>(); + final int length = pattern.length(); + char c = 0; + char pre; + boolean inVar = false; + StringBuilder part = StrUtil.builder(); + for (int i = 0; i < length; i++) { + pre = c; + c = pattern.charAt(i); + if (inVar) { + part.append(c); + if ('}' == c) { + // 变量结束 + inVar = false; + patterns.add(part.toString()); + part.setLength(0); + } + } else if ('{' == c && '$' == pre) { + // 变量开始 + inVar = true; + final String preText = part.substring(0, part.length() - 1); + if (StrUtil.isNotEmpty(preText)) { + patterns.add(preText); + } + part.setLength(0); + part.append(pre).append(c); + } else { + // 普通字符 + part.append(c); + } + } + + if (part.length() > 0) { + patterns.add(part.toString()); + } + return patterns; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrPool.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrPool.java new file mode 100644 index 0000000..b25bce3 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrPool.java @@ -0,0 +1,212 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +import aiyh.utils.tool.cn.hutool.core.util.XmlUtil; + +/** + * 常用字符串常量定义 + * @see CharPool + * + * @author looly + * @since 5.6.3 + */ +public interface StrPool { + + /** + * 字符常量：空格符 {@code ' '} + */ + char C_SPACE = CharPool.SPACE; + + /** + * 字符常量：制表符 {@code '\t'} + */ + char C_TAB = CharPool.TAB; + + /** + * 字符常量：点 {@code '.'} + */ + char C_DOT = CharPool.DOT; + + /** + * 字符常量：斜杠 {@code '/'} + */ + char C_SLASH = CharPool.SLASH; + + /** + * 字符常量：反斜杠 {@code '\\'} + */ + char C_BACKSLASH = CharPool.BACKSLASH; + + /** + * 字符常量：回车符 {@code '\r'} + */ + char C_CR = CharPool.CR; + + /** + * 字符常量：换行符 {@code '\n'} + */ + char C_LF = CharPool.LF; + + /** + * 字符常量：下划线 {@code '_'} + */ + char C_UNDERLINE = CharPool.UNDERLINE; + + /** + * 字符常量：逗号 {@code ','} + */ + char C_COMMA = CharPool.COMMA; + + /** + * 字符常量：花括号（左） '{' + */ + char C_DELIM_START = CharPool.DELIM_START; + + /** + * 字符常量：花括号（右） '}' + */ + char C_DELIM_END = CharPool.DELIM_END; + + /** + * 字符常量：中括号（左） {@code '['} + */ + char C_BRACKET_START = CharPool.BRACKET_START; + + /** + * 字符常量：中括号（右） {@code ']'} + */ + char C_BRACKET_END = CharPool.BRACKET_END; + + /** + * 字符常量：冒号 {@code ':'} + */ + char C_COLON = CharPool.COLON; + + /** + * 字符常量：艾特 {@code '@'} + */ + char C_AT = CharPool.AT; + + /** + * 字符串常量：制表符 {@code "\t"} + */ + String TAB = " "; + + /** + * 字符串常量：点 {@code "."} + */ + String DOT = "."; + + /** + * 字符串常量：双点 {@code ".."}
+ * 用途：作为指向上级文件夹的路径，如：{@code "../path"} + */ + String DOUBLE_DOT = ".."; + + /** + * 字符串常量：斜杠 {@code "/"} + */ + String SLASH = "/"; + + /** + * 字符串常量：反斜杠 {@code "\\"} + */ + String BACKSLASH = "\\"; + + /** + * 字符串常量：回车符 {@code "\r"}
+ * 解释：该字符常用于表示 Linux 系统和 MacOS 系统下的文本换行 + */ + String CR = "\r"; + + /** + * 字符串常量：换行符 {@code "\n"} + */ + String LF = "\n"; + + /** + * 字符串常量：Windows 换行 {@code "\r\n"}
+ * 解释：该字符串常用于表示 Windows 系统下的文本换行 + */ + String CRLF = "\r\n"; + + /** + * 字符串常量：下划线 {@code "_"} + */ + String UNDERLINE = "_"; + + /** + * 字符串常量：减号（连接符） {@code "-"} + */ + String DASHED = "-"; + + /** + * 字符串常量：逗号 {@code ","} + */ + String COMMA = ","; + + /** + * 字符串常量：花括号（左） "{" + */ + String DELIM_START = "{"; + + /** + * 字符串常量：花括号（右） "}" + */ + String DELIM_END = "}"; + + /** + * 字符串常量：中括号（左） {@code "["} + */ + String BRACKET_START = "["; + + /** + * 字符串常量：中括号（右） {@code "]"} + */ + String BRACKET_END = "]"; + + /** + * 字符串常量：冒号 {@code ":"} + */ + String COLON = ":"; + + /** + * 字符串常量：艾特 {@code "@"} + */ + String AT = "@"; + + + /** + * 字符串常量：HTML 不间断空格转义 {@code " " -> " "} + */ + String HTML_NBSP = XmlUtil.NBSP; + + /** + * 字符串常量：HTML And 符转义 {@code "&" -> "&"} + */ + String HTML_AMP = XmlUtil.AMP; + + /** + * 字符串常量：HTML 双引号转义 {@code """ -> "\""} + */ + String HTML_QUOTE = XmlUtil.QUOTE; + + /** + * 字符串常量：HTML 单引号转义 {@code "&apos" -> "'"} + */ + String HTML_APOS = XmlUtil.APOS; + + /** + * 字符串常量：HTML 小于号转义 {@code "<" -> "<"} + */ + String HTML_LT = XmlUtil.LT; + + /** + * 字符串常量：HTML 大于号转义 {@code ">" -> ">"} + */ + String HTML_GT = XmlUtil.GT; + + /** + * 字符串常量：空 JSON {@code "{}"} + */ + String EMPTY_JSON = "{}"; +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrSplitter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrSplitter.java new file mode 100755 index 0000000..8888681 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/StrSplitter.java @@ -0,0 +1,457 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +import aiyh.utils.tool.cn.hutool.core.lang.PatternPool; +import aiyh.utils.tool.cn.hutool.core.text.finder.CharFinder; +import aiyh.utils.tool.cn.hutool.core.text.finder.CharMatcherFinder; +import aiyh.utils.tool.cn.hutool.core.text.finder.LengthFinder; +import aiyh.utils.tool.cn.hutool.core.text.finder.PatternFinder; +import aiyh.utils.tool.cn.hutool.core.text.finder.StrFinder; +import aiyh.utils.tool.cn.hutool.core.text.split.SplitIter; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.util.ArrayList; +import java.util.List; +import java.util.function.Function; +import java.util.regex.Pattern; + +/** + * 字符串切分器，封装统一的字符串分割静态方法 + * @author Looly + * @since 5.7.0 + */ +public class StrSplitter { + + //---------------------------------------------------------------------------------------------- Split by char + + /** + * 切分字符串路径，仅支持Unix分界符：/ + * + * @param str 被切分的字符串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static List splitPath(CharSequence str) { + return splitPath(str, 0); + } + + /** + * 切分字符串路径，仅支持Unix分界符：/ + * + * @param str 被切分的字符串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static String[] splitPathToArray(CharSequence str) { + return toArray(splitPath(str)); + } + + /** + * 切分字符串路径，仅支持Unix分界符：/ + * + * @param str 被切分的字符串 + * @param limit 限制分片数 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static List splitPath(CharSequence str, int limit) { + return split(str, StrUtil.C_SLASH, limit, true, true); + } + + /** + * 切分字符串路径，仅支持Unix分界符：/ + * + * @param str 被切分的字符串 + * @param limit 限制分片数 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static String[] splitPathToArray(CharSequence str, int limit) { + return toArray(splitPath(str, limit)); + } + + /** + * 切分字符串 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.2.1 + */ + public static List splitTrim(CharSequence str, char separator, boolean ignoreEmpty) { + return split(str, separator, 0, true, ignoreEmpty); + } + + /** + * 切分字符串 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static List split(CharSequence str, char separator, boolean isTrim, boolean ignoreEmpty) { + return split(str, separator, 0, isTrim, ignoreEmpty); + } + + /** + * 切分字符串，大小写敏感，去除每个元素两边空白符 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数，-1不限制 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static List splitTrim(CharSequence str, char separator, int limit, boolean ignoreEmpty) { + return split(str, separator, limit, true, ignoreEmpty, false); + } + + /** + * 切分字符串，大小写敏感 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数，-1不限制 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static List split(CharSequence str, char separator, int limit, boolean isTrim, boolean ignoreEmpty) { + return split(str, separator, limit, isTrim, ignoreEmpty, false); + } + + /** + * 切分字符串，大小写敏感 + * + * @param 切分后的元素类型 + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数，-1不限制 + * @param ignoreEmpty 是否忽略空串 + * @param mapping 切分后的字符串元素的转换方法 + * @return 切分后的集合，元素类型是经过 mapping 转换后的 + * @since 5.7.14 + */ + public static List split(CharSequence str, char separator, int limit, boolean ignoreEmpty, Function mapping) { + return split(str, separator, limit, ignoreEmpty, false, mapping); + } + + /** + * 切分字符串，忽略大小写 + * + * @param text 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数，-1不限制 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.2.1 + */ + public static List splitIgnoreCase(CharSequence text, char separator, int limit, boolean isTrim, boolean ignoreEmpty) { + return split(text, separator, limit, isTrim, ignoreEmpty, true); + } + + /** + * 切分字符串 + * + * @param text 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数，-1不限制 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @param ignoreCase 是否忽略大小写 + * @return 切分后的集合 + */ + public static List split(CharSequence text, char separator, int limit, boolean isTrim, boolean ignoreEmpty, boolean ignoreCase) { + return split(text, separator, limit, ignoreEmpty, ignoreCase, trimFunc(isTrim)); + } + + /** + * 切分字符串
+ * 如果为空字符串或者null 则返回空集合 + * + * @param 切分后的元素类型 + * @param text 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数，-1不限制 + * @param ignoreEmpty 是否忽略空串 + * @param ignoreCase 是否忽略大小写 + * @param mapping 切分后的字符串元素的转换方法 + * @return 切分后的集合，元素类型是经过 mapping 转换后的 + * @since 5.7.14 + */ + public static List split(CharSequence text, char separator, int limit, boolean ignoreEmpty, + boolean ignoreCase, Function mapping) { + if (null == text) { + return new ArrayList<>(0); + } + final SplitIter splitIter = new SplitIter(text, new CharFinder(separator, ignoreCase), limit, ignoreEmpty); + return splitIter.toList(mapping); + } + + /** + * 切分字符串为字符串数组 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static String[] splitToArray(CharSequence str, char separator, int limit, boolean isTrim, boolean ignoreEmpty) { + return toArray(split(str, separator, limit, isTrim, ignoreEmpty)); + } + + //---------------------------------------------------------------------------------------------- Split by String + + /** + * 切分字符串，不忽略大小写 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符串 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static List split(CharSequence str, String separator, boolean isTrim, boolean ignoreEmpty) { + return split(str, separator, -1, isTrim, ignoreEmpty, false); + } + + /** + * 切分字符串，去除每个元素两边空格，忽略大小写 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符串 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.2.1 + */ + public static List splitTrim(CharSequence str, String separator, boolean ignoreEmpty) { + return split(str, separator, true, ignoreEmpty); + } + + /** + * 切分字符串，不忽略大小写 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符串 + * @param limit 限制分片数，小于等于0表示无限制 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static List split(CharSequence str, String separator, int limit, boolean isTrim, boolean ignoreEmpty) { + return split(str, separator, limit, isTrim, ignoreEmpty, false); + } + + /** + * 切分字符串，去除每个元素两边空格，忽略大小写 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符串 + * @param limit 限制分片数 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.2.1 + */ + public static List splitTrim(CharSequence str, String separator, int limit, boolean ignoreEmpty) { + return split(str, separator, limit, true, ignoreEmpty); + } + + /** + * 切分字符串，忽略大小写 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符串 + * @param limit 限制分片数 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.2.1 + */ + public static List splitIgnoreCase(CharSequence str, String separator, int limit, boolean isTrim, boolean ignoreEmpty) { + return split(str, separator, limit, isTrim, ignoreEmpty, true); + } + + /** + * 切分字符串，去除每个元素两边空格，忽略大小写 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符串 + * @param limit 限制分片数 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.2.1 + */ + public static List splitTrimIgnoreCase(CharSequence str, String separator, int limit, boolean ignoreEmpty) { + return split(str, separator, limit, true, ignoreEmpty, true); + } + + /** + * 切分字符串
+ * 如果为空字符串或者null 则返回空集合 + * + * @param text 被切分的字符串 + * @param separator 分隔符字符串 + * @param limit 限制分片数，小于等于0表示无限制 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @param ignoreCase 是否忽略大小写 + * @return 切分后的集合 + * @since 3.2.1 + */ + public static List split(CharSequence text, String separator, int limit, boolean isTrim, boolean ignoreEmpty, boolean ignoreCase) { + if (null == text) { + return new ArrayList<>(0); + } + final SplitIter splitIter = new SplitIter(text, new StrFinder(separator, ignoreCase), limit, ignoreEmpty); + return splitIter.toList(isTrim); + } + + /** + * 切分字符串为字符串数组 + * + * @param str 被切分的字符串 + * @param separator 分隔符字符 + * @param limit 限制分片数，小于等于0表示无限制 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static String[] splitToArray(CharSequence str, String separator, int limit, boolean isTrim, boolean ignoreEmpty) { + return toArray(split(str, separator, limit, isTrim, ignoreEmpty)); + } + + //---------------------------------------------------------------------------------------------- Split by Whitespace + + /** + * 使用空白符切分字符串
+ * 切分后的字符串两边不包含空白符，空串或空白符串并不做为元素之一
+ * 如果为空字符串或者null 则返回空集合 + * + * @param text 被切分的字符串 + * @param limit 限制分片数 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static List split(CharSequence text, int limit) { + if (null == text) { + return new ArrayList<>(0); + } + final SplitIter splitIter = new SplitIter(text, new CharMatcherFinder(CharUtil::isBlankChar), limit, true); + return splitIter.toList(false); + } + + /** + * 切分字符串为字符串数组 + * + * @param str 被切分的字符串 + * @param limit 限制分片数 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static String[] splitToArray(String str, int limit) { + return toArray(split(str, limit)); + } + //---------------------------------------------------------------------------------------------- Split by regex + + /** + * 通过正则切分字符串 + * + * @param text 字符串 + * @param separatorRegex 分隔符正则 + * @param limit 限制分片数 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static List splitByRegex(String text, String separatorRegex, int limit, boolean isTrim, boolean ignoreEmpty) { + final Pattern pattern = PatternPool.get(separatorRegex); + return split(text, pattern, limit, isTrim, ignoreEmpty); + } + + /** + * 通过正则切分字符串
+ * 如果为空字符串或者null 则返回空集合 + * + * @param text 字符串 + * @param separatorPattern 分隔符正则{@link Pattern} + * @param limit 限制分片数 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static List split(String text, Pattern separatorPattern, int limit, boolean isTrim, boolean ignoreEmpty) { + if (null == text) { + return new ArrayList<>(0); + } + final SplitIter splitIter = new SplitIter(text, new PatternFinder(separatorPattern), limit, ignoreEmpty); + return splitIter.toList(isTrim); + } + + /** + * 通过正则切分字符串为字符串数组 + * + * @param str 被切分的字符串 + * @param separatorPattern 分隔符正则{@link Pattern} + * @param limit 限制分片数 + * @param isTrim 是否去除切分字符串后每个元素两边的空格 + * @param ignoreEmpty 是否忽略空串 + * @return 切分后的集合 + * @since 3.0.8 + */ + public static String[] splitToArray(String str, Pattern separatorPattern, int limit, boolean isTrim, boolean ignoreEmpty) { + return toArray(split(str, separatorPattern, limit, isTrim, ignoreEmpty)); + } + //---------------------------------------------------------------------------------------------- Split by length + + /** + * 根据给定长度，将给定字符串截取为多个部分 + * + * @param text 字符串 + * @param len 每一个小节的长度 + * @return 截取后的字符串数组 + */ + public static String[] splitByLength(CharSequence text, int len) { + if (null == text) { + return new String[0]; + } + SplitIter splitIter = new SplitIter(text, new LengthFinder(len), -1, false); + return splitIter.toArray(false); + } + //---------------------------------------------------------------------------------------------------------- Private method start + + /** + * List转Array + * + * @param list List + * @return Array + */ + private static String[] toArray(List list) { + return list.toArray(new String[0]); + } + + /** + * Trim函数 + * + * @param isTrim 是否trim + * @return {@link Function} + */ + private static Function trimFunc(boolean isTrim) { + return (str) -> isTrim ? StrUtil.trim(str) : str; + } + //---------------------------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/TextSimilarity.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/TextSimilarity.java new file mode 100644 index 0000000..50312bb --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/TextSimilarity.java @@ -0,0 +1,169 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 文本相似度计算
+ * 工具类提供者：【杭州】fineliving + * + * @author fanqun + * @since 3.2.3 + **/ +public class TextSimilarity { + + /** + * 利用莱文斯坦距离(Levenshtein distance)算法计算相似度，两个都是空串相似度为1，被认为是相同的串
+ * 比较方法为： + *
    + *
  • 只比较两个字符串字母、数字、汉字部分，其他符号去除
    • + *
  • 计算出两个字符串最大子串，除以最长的字符串，结果即为相似度
    • + *
+ * + * @param strA 字符串1 + * @param strB 字符串2 + * @return 相似度 + */ + public static double similar(String strA, String strB) { + String newStrA, newStrB; + if (strA.length() < strB.length()) { + newStrA = removeSign(strB); + newStrB = removeSign(strA); + } else { + newStrA = removeSign(strA); + newStrB = removeSign(strB); + } + + // 用较大的字符串长度作为分母，相似子串作为分子计算出字串相似度 + int temp = Math.max(newStrA.length(), newStrB.length()); + if(0 == temp) { + // 两个都是空串相似度为1，被认为是相同的串 + return 1; + } + + final int commonLength = longestCommonSubstringLength(newStrA, newStrB); + return NumberUtil.div(commonLength, temp); + } + + /** + * 利用莱文斯坦距离(Levenshtein distance)算法计算相似度百分比 + * + * @param strA 字符串1 + * @param strB 字符串2 + * @param scale 保留小数 + * @return 百分比 + */ + public static String similar(String strA, String strB, int scale) { + return NumberUtil.formatPercent(similar(strA, strB), scale); + } + + /** + * 最长公共子串，采用动态规划算法。 其不要求所求得的字符在所给的字符串中是连续的。
+ * 算法解析见：https://leetcode-cn.com/problems/longest-common-subsequence/solution/zui-chang-gong-gong-zi-xu-lie-by-leetcod-y7u0/ + * + * @param strA 字符串1 + * @param strB 字符串2 + * @return 最长公共子串 + */ + public static String longestCommonSubstring(String strA, String strB) { + // 初始化矩阵数据,matrix[0][0]的值为0， 如果字符数组chars_strA和chars_strB的对应位相同，则matrix[i][j]的值为左上角的值加1， + // 否则，matrix[i][j]的值等于左上方最近两个位置的较大值， 矩阵中其余各点的值为0. + final int[][] matrix = generateMatrix(strA, strB); + + int m = strA.length(); + int n = strB.length(); + // 矩阵中，如果matrix[m][n]的值不等于matrix[m-1][n]的值也不等于matrix[m][n-1]的值， + // 则matrix[m][n]对应的字符为相似字符元，并将其存入result数组中。 + char[] result = new char[matrix[m][n]]; + int currentIndex = result.length - 1; + while (matrix[m][n] != 0) { + if (matrix[m][n] == matrix[m][n - 1]) { + n--; + } else if (matrix[m][n] == matrix[m - 1][n]) { + m--; + } else { + result[currentIndex] = strA.charAt(m - 1); + currentIndex--; + n--; + m--; + } + } + return new String(result); + } + + // --------------------------------------------------------------------------------------------------- Private method start + /** + * 将字符串的所有数据依次写成一行，去除无意义字符串 + * + * @param str 字符串 + * @return 处理后的字符串 + */ + private static String removeSign(String str) { + int length = str.length(); + StringBuilder sb = StrUtil.builder(length); + // 遍历字符串str,如果是汉字数字或字母，则追加到ab上面 + char c; + for (int i = 0; i < length; i++) { + c = str.charAt(i); + if(isValidChar(c)) { + sb.append(c); + } + } + + return sb.toString(); + } + + /** + * 判断字符是否为汉字，数字和字母， 因为对符号进行相似度比较没有实际意义，故符号不加入考虑范围。 + * + * @param charValue 字符 + * @return true表示为非汉字，数字和字母，false反之 + */ + private static boolean isValidChar(char charValue) { + return (charValue >= 0x4E00 && charValue <= 0X9FFF) || // + (charValue >= 'a' && charValue <= 'z') || // + (charValue >= 'A' && charValue <= 'Z') || // + (charValue >= '0' && charValue <= '9'); + } + + /** + * 求公共子串，采用动态规划算法。 其不要求所求得的字符在所给的字符串中是连续的。 + * + * @param strA 字符串1 + * @param strB 字符串2 + * @return 公共子串 + */ + private static int longestCommonSubstringLength(String strA, String strB) { + final int m = strA.length(); + final int n = strB.length(); + return generateMatrix(strA, strB)[m][n]; + } + + /** + * 求公共子串，采用动态规划算法。 其不要求所求得的字符在所给的字符串中是连续的。 + * + * @param strA 字符串1 + * @param strB 字符串2 + * @return 公共串矩阵 + */ + private static int[][] generateMatrix(String strA, String strB) { + int m = strA.length(); + int n = strB.length(); + + // 初始化矩阵数据,matrix[0][0]的值为0， 如果字符数组chars_strA和chars_strB的对应位相同，则matrix[i][j]的值为左上角的值加1， + // 否则，matrix[i][j]的值等于左上方最近两个位置的较大值， 矩阵中其余各点的值为0. + final int[][] matrix = new int[m + 1][n + 1]; + for (int i = 1; i <= m; i++) { + for (int j = 1; j <= n; j++) { + if (strA.charAt(i - 1) == strB.charAt(j - 1)) { + matrix[i][j] = matrix[i - 1][j - 1] + 1; + } else { + matrix[i][j] = Math.max(matrix[i][j - 1], matrix[i - 1][j]); + } + } + } + + return matrix; + } + // --------------------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/UnicodeUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/UnicodeUtil.java new file mode 100755 index 0000000..baaab6b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/UnicodeUtil.java @@ -0,0 +1,116 @@ +package aiyh.utils.tool.cn.hutool.core.text; + +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.HexUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 提供Unicode字符串和普通字符串之间的转换 + * + * @author 兜兜毛毛, looly + * @since 4.0.0 + */ +public class UnicodeUtil { + + /** + * Unicode字符串转为普通字符串
+ * Unicode字符串的表现方式为：\\uXXXX + * + * @param unicode Unicode字符串 + * @return 普通字符串 + */ + public static String toString(String unicode) { + if (StrUtil.isBlank(unicode)) { + return unicode; + } + + final int len = unicode.length(); + StringBuilder sb = new StringBuilder(len); + int i; + int pos = 0; + while ((i = StrUtil.indexOfIgnoreCase(unicode, "\\u", pos)) != -1) { + sb.append(unicode, pos, i);//写入Unicode符之前的部分 + pos = i; + if (i + 5 < len) { + char c; + try { + c = (char) Integer.parseInt(unicode.substring(i + 2, i + 6), 16); + sb.append(c); + pos = i + 6;//跳过整个Unicode符 + } catch (NumberFormatException e) { + //非法Unicode符，跳过 + sb.append(unicode, pos, i + 2);//写入"\\u" + pos = i + 2; + } + } else { + //非Unicode符，结束 + break; + } + } + + if (pos < len) { + sb.append(unicode, pos, len); + } + return sb.toString(); + } + + /** + * 字符编码为Unicode形式 + * + * @param c 被编码的字符 + * @return Unicode字符串 + * @since 5.6.2 + * @see HexUtil#toUnicodeHex(char) + */ + public static String toUnicode(char c) { + return HexUtil.toUnicodeHex(c); + } + + /** + * 字符编码为Unicode形式 + * + * @param c 被编码的字符 + * @return Unicode字符串 + * @since 5.6.2 + * @see HexUtil#toUnicodeHex(int) + */ + public static String toUnicode(int c) { + return HexUtil.toUnicodeHex(c); + } + + /** + * 字符串编码为Unicode形式 + * + * @param str 被编码的字符串 + * @return Unicode字符串 + */ + public static String toUnicode(String str) { + return toUnicode(str, true); + } + + /** + * 字符串编码为Unicode形式 + * + * @param str 被编码的字符串 + * @param isSkipAscii 是否跳过ASCII字符（只跳过可见字符） + * @return Unicode字符串 + */ + public static String toUnicode(String str, boolean isSkipAscii) { + if (StrUtil.isEmpty(str)) { + return str; + } + + final int len = str.length(); + final StringBuilder unicode = new StringBuilder(str.length() * 6); + char c; + for (int i = 0; i < len; i++) { + c = str.charAt(i); + if (isSkipAscii && CharUtil.isAsciiPrintable(c)) { + unicode.append(c); + } else { + unicode.append(HexUtil.toUnicodeHex(c)); + } + } + return unicode.toString(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvBaseReader.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvBaseReader.java new file mode 100755 index 0000000..68a95f8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvBaseReader.java @@ -0,0 +1,280 @@ +package aiyh.utils.tool.cn.hutool.core.text.csv; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.io.File; +import java.io.Reader; +import java.io.Serializable; +import java.io.StringReader; +import java.nio.charset.Charset; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +/** + * CSV文件读取器基础类，提供灵活的文件、路径中的CSV读取，一次构造可多次调用读取不同数据，参考：FastCSV + * + * @author Looly + * @since 5.0.4 + */ +public class CsvBaseReader implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * 默认编码 + */ + protected static final Charset DEFAULT_CHARSET = CharsetUtil.CHARSET_UTF_8; + + private final CsvReadConfig config; + + //--------------------------------------------------------------------------------------------- Constructor start + + /** + * 构造，使用默认配置项 + */ + public CsvBaseReader() { + this(null); + } + + /** + * 构造 + * + * @param config 配置项 + */ + public CsvBaseReader(CsvReadConfig config) { + this.config = ObjectUtil.defaultIfNull(config, CsvReadConfig::defaultConfig); + } + //--------------------------------------------------------------------------------------------- Constructor end + + /** + * 设置字段分隔符，默认逗号',' + * + * @param fieldSeparator 字段分隔符，默认逗号',' + */ + public void setFieldSeparator(char fieldSeparator) { + this.config.setFieldSeparator(fieldSeparator); + } + + /** + * 设置 文本分隔符，文本包装符，默认双引号'"' + * + * @param textDelimiter 文本分隔符，文本包装符，默认双引号'"' + */ + public void setTextDelimiter(char textDelimiter) { + this.config.setTextDelimiter(textDelimiter); + } + + /** + * 设置是否首行做为标题行，默认false + * + * @param containsHeader 是否首行做为标题行，默认false + */ + public void setContainsHeader(boolean containsHeader) { + this.config.setContainsHeader(containsHeader); + } + + /** + * 设置是否跳过空白行，默认true + * + * @param skipEmptyRows 是否跳过空白行，默认true + */ + public void setSkipEmptyRows(boolean skipEmptyRows) { + this.config.setSkipEmptyRows(skipEmptyRows); + } + + /** + * 设置每行字段个数不同时是否抛出异常，默认false + * + * @param errorOnDifferentFieldCount 每行字段个数不同时是否抛出异常，默认false + */ + public void setErrorOnDifferentFieldCount(boolean errorOnDifferentFieldCount) { + this.config.setErrorOnDifferentFieldCount(errorOnDifferentFieldCount); + } + + /** + * 读取CSV文件，默认UTF-8编码 + * + * @param file CSV文件 + * @return {@link CsvData}，包含数据列表和行信息 + * @throws IORuntimeException IO异常 + */ + public CsvData read(File file) throws IORuntimeException { + return read(file, DEFAULT_CHARSET); + } + + /** + * 从字符串中读取CSV数据 + * + * @param csvStr CSV字符串 + * @return {@link CsvData}，包含数据列表和行信息 + */ + public CsvData readFromStr(String csvStr) { + return read(new StringReader(csvStr)); + } + + /** + * 从字符串中读取CSV数据 + * + * @param csvStr CSV字符串 + * @param rowHandler 行处理器，用于一行一行的处理数据 + */ + public void readFromStr(String csvStr, CsvRowHandler rowHandler) { + read(parse(new StringReader(csvStr)), rowHandler); + } + + + /** + * 读取CSV文件 + * + * @param file CSV文件 + * @param charset 文件编码，默认系统编码 + * @return {@link CsvData}，包含数据列表和行信息 + * @throws IORuntimeException IO异常 + */ + public CsvData read(File file, Charset charset) throws IORuntimeException { + return read(Objects.requireNonNull(file.toPath(), "file must not be null"), charset); + } + + /** + * 读取CSV文件，默认UTF-8编码 + * + * @param path CSV文件 + * @return {@link CsvData}，包含数据列表和行信息 + * @throws IORuntimeException IO异常 + */ + public CsvData read(Path path) throws IORuntimeException { + return read(path, DEFAULT_CHARSET); + } + + /** + * 读取CSV文件 + * + * @param path CSV文件 + * @param charset 文件编码，默认系统编码 + * @return {@link CsvData}，包含数据列表和行信息 + * @throws IORuntimeException IO异常 + */ + public CsvData read(Path path, Charset charset) throws IORuntimeException { + Assert.notNull(path, "path must not be null"); + return read(FileUtil.getReader(path, charset)); + } + + /** + * 从Reader中读取CSV数据，读取后关闭Reader + * + * @param reader Reader + * @return {@link CsvData}，包含数据列表和行信息 + * @throws IORuntimeException IO异常 + */ + public CsvData read(Reader reader) throws IORuntimeException { + final CsvParser csvParser = parse(reader); + final List rows = new ArrayList<>(); + read(csvParser, rows::add); + final List header = config.headerLineNo > -1 ? csvParser.getHeader() : null; + + return new CsvData(header, rows); + } + + /** + * 从Reader中读取CSV数据，结果为Map，读取后关闭Reader。
+ * 此方法默认识别首行为标题行。 + * + * @param reader Reader + * @return {@link CsvData}，包含数据列表和行信息 + * @throws IORuntimeException IO异常 + */ + public List> readMapList(Reader reader) throws IORuntimeException { + // 此方法必须包含标题 + this.config.setContainsHeader(true); + + final List> result = new ArrayList<>(); + read(reader, (row) -> result.add(row.getFieldMap())); + return result; + } + + /** + * 从Reader中读取CSV数据并转换为Bean列表，读取后关闭Reader。
+ * 此方法默认识别首行为标题行。 + * + * @param Bean类型 + * @param reader Reader + * @param clazz Bean类型 + * @return Bean列表 + */ + public List read(Reader reader, Class clazz) { + // 此方法必须包含标题 + this.config.setContainsHeader(true); + + final List result = new ArrayList<>(); + read(reader, (row) -> result.add(row.toBean(clazz))); + return result; + } + + /** + * 从字符串中读取CSV数据并转换为Bean列表，读取后关闭Reader。
+ * 此方法默认识别首行为标题行。 + * + * @param Bean类型 + * @param csvStr csv字符串 + * @param clazz Bean类型 + * @return Bean列表 + */ + public List read(String csvStr, Class clazz) { + // 此方法必须包含标题 + this.config.setContainsHeader(true); + + final List result = new ArrayList<>(); + read(new StringReader(csvStr), (row) -> result.add(row.toBean(clazz))); + return result; + } + + /** + * 从Reader中读取CSV数据，读取后关闭Reader + * + * @param reader Reader + * @param rowHandler 行处理器，用于一行一行的处理数据 + * @throws IORuntimeException IO异常 + */ + public void read(Reader reader, CsvRowHandler rowHandler) throws IORuntimeException { + read(parse(reader), rowHandler); + } + + //--------------------------------------------------------------------------------------------- Private method start + + /** + * 读取CSV数据，读取后关闭Parser + * + * @param csvParser CSV解析器 + * @param rowHandler 行处理器，用于一行一行的处理数据 + * @throws IORuntimeException IO异常 + * @since 5.0.4 + */ + private void read(CsvParser csvParser, CsvRowHandler rowHandler) throws IORuntimeException { + try { + while (csvParser.hasNext()){ + rowHandler.handle(csvParser.next()); + } + } finally { + IoUtil.close(csvParser); + } + } + + /** + * 构建 {@link CsvParser} + * + * @param reader Reader + * @return CsvParser + * @throws IORuntimeException IO异常 + */ + protected CsvParser parse(Reader reader) throws IORuntimeException { + return new CsvParser(reader, this.config); + } + //--------------------------------------------------------------------------------------------- Private method start +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvConfig.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvConfig.java new file mode 100755 index 0000000..9ea0d0a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvConfig.java @@ -0,0 +1,119 @@ +package aiyh.utils.tool.cn.hutool.core.text.csv; + +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; + +import java.io.Serializable; +import java.util.LinkedHashMap; +import java.util.Map; + +/** + * CSV基础配置项，此配置项可用于读取和写出CSV，定义了包括字段分隔符、文本包装符等符号 + * + * @param 继承子类类型，用于this返回 + * @author looly + * @since 4.0.5 + */ +@SuppressWarnings("unchecked") +public class CsvConfig> implements Serializable { + private static final long serialVersionUID = -8069578249066158459L; + + /** + * 字段分隔符，默认逗号',' + */ + protected char fieldSeparator = CharUtil.COMMA; + /** + * 文本包装符，默认双引号'"' + */ + protected char textDelimiter = CharUtil.DOUBLE_QUOTES; + /** + * 注释符号，用于区分注释行，默认'#' + */ + protected Character commentCharacter = '#'; + /** + * 标题别名 + */ + protected Map headerAlias = new LinkedHashMap<>(); + + /** + * 设置字段分隔符，默认逗号',' + * + * @param fieldSeparator 字段分隔符，默认逗号',' + * @return this + */ + public T setFieldSeparator(final char fieldSeparator) { + this.fieldSeparator = fieldSeparator; + return (T) this; + } + + /** + * 设置 文本分隔符，文本包装符，默认双引号'"' + * + * @param textDelimiter 文本分隔符，文本包装符，默认双引号'"' + * @return this + */ + public T setTextDelimiter(char textDelimiter) { + this.textDelimiter = textDelimiter; + return (T) this; + } + + /** + * 设置注释无效
+ * 当写出CSV时，{@link CsvWriter#writeComment(String)}将抛出异常
+ * 当读取CSV时，注释行按照正常行读取 + * + * @return this + * @since 5.7.14 + */ + public T disableComment() { + return setCommentCharacter(null); + } + + /** + * 设置 注释符号，用于区分注释行，{@code null}表示忽略注释 + * + * @param commentCharacter 注释符号，用于区分注释行 + * @return this + * @since 5.5.7 + */ + public T setCommentCharacter(Character commentCharacter) { + this.commentCharacter = commentCharacter; + return (T) this; + } + + /** + * 设置标题行的别名Map + * + * @param headerAlias 别名Map + * @return this + * @since 5.7.10 + */ + public T setHeaderAlias(Map headerAlias) { + this.headerAlias = headerAlias; + return (T) this; + } + + /** + * 增加标题别名 + * + * @param header 标题 + * @param alias 别名 + * @return this + * @since 5.7.10 + */ + public T addHeaderAlias(String header, String alias) { + this.headerAlias.put(header, alias); + return (T) this; + } + + /** + * 去除标题别名 + * + * @param header 标题 + * @return this + * @since 5.7.10 + */ + public T removeHeaderAlias(String header) { + this.headerAlias.remove(header); + return (T) this; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvData.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvData.java new file mode 100755 index 0000000..afa0f21 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvData.java @@ -0,0 +1,83 @@ +package aiyh.utils.tool.cn.hutool.core.text.csv; + +import java.io.Serializable; +import java.util.Collections; +import java.util.Iterator; +import java.util.List; + +/** + * CSV数据，包括头部信息和行数据，参考：FastCSV + * + * @author Looly + */ +public class CsvData implements Iterable, Serializable { + private static final long serialVersionUID = 1L; + + private final List header; + private final List rows; + + /** + * 构造 + * + * @param header 头信息, 可以为null + * @param rows 行 + */ + public CsvData(final List header, final List rows) { + this.header = header; + this.rows = rows; + } + + /** + * 总行数 + * + * @return 总行数 + */ + public int getRowCount() { + return this.rows.size(); + } + + /** + * 获取头信息列表，如果无头信息为{@code Null}，返回列表为只读列表 + * + * @return the header row - might be {@code null} if no header exists + */ + public List getHeader() { + if(null == this.header){ + return null; + } + return Collections.unmodifiableList(this.header); + } + + /** + * 获取指定行，从0开始 + * + * @param index 行号 + * @return 行数据 + * @throws IndexOutOfBoundsException if index is out of range + */ + public CsvRow getRow(final int index) { + return this.rows.get(index); + } + + /** + * 获取所有行 + * + * @return 所有行 + */ + public List getRows() { + return this.rows; + } + + @Override + public Iterator iterator() { + return this.rows.iterator(); + } + + @Override + public String toString() { + return "CsvData{" + + "header=" + header + + ", rows=" + rows + + '}'; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvParser.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvParser.java new file mode 100755 index 0000000..5d31add --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvParser.java @@ -0,0 +1,447 @@ +package aiyh.utils.tool.cn.hutool.core.text.csv; + +import aiyh.utils.tool.cn.hutool.core.collection.ComputeIter; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.text.StrBuilder; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Closeable; +import java.io.IOException; +import java.io.Reader; +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +/** + * CSV行解析器，参考：FastCSV + * + * @author Looly + */ +public final class CsvParser extends ComputeIter implements Closeable, Serializable { + private static final long serialVersionUID = 1L; + + private static final int DEFAULT_ROW_CAPACITY = 10; + + private final Reader reader; + private final CsvReadConfig config; + + private final Buffer buf = new Buffer(IoUtil.DEFAULT_LARGE_BUFFER_SIZE); + /** + * 前一个特殊分界字符 + */ + private int preChar = -1; + /** + * 是否在引号包装内 + */ + private boolean inQuotes; + /** + * 当前读取字段 + */ + private final StrBuilder currentField = new StrBuilder(512); + + /** + * 标题行 + */ + private CsvRow header; + /** + * 当前行号 + */ + private long lineNo = -1; + /** + * 引号内的行数 + */ + private long inQuotesLineCount; + /** + * 第一行字段数，用于检查每行字段数是否一致 + */ + private int firstLineFieldCount = -1; + /** + * 最大字段数量，用于初始化行，减少扩容 + */ + private int maxFieldCount; + /** + * 是否读取结束 + */ + private boolean finished; + + /** + * CSV解析器 + * + * @param reader Reader + * @param config 配置，null则为默认配置 + */ + public CsvParser(final Reader reader, CsvReadConfig config) { + this.reader = Objects.requireNonNull(reader, "reader must not be null"); + this.config = ObjectUtil.defaultIfNull(config, CsvReadConfig::defaultConfig); + } + + /** + * 获取头部字段列表，如果headerLineNo < 0，抛出异常 + * + * @return 头部列表 + * @throws IllegalStateException 如果不解析头部或者没有调用nextRow()方法 + */ + public List getHeader() { + if (config.headerLineNo < 0) { + throw new IllegalStateException("No header available - header parsing is disabled"); + } + if (lineNo < config.beginLineNo) { + throw new IllegalStateException("No header available - call nextRow() first"); + } + return header.fields; + } + + @Override + protected CsvRow computeNext() { + return nextRow(); + } + + /** + * 读取下一行数据 + * + * @return CsvRow + * @throws IORuntimeException IO读取异常 + */ + public CsvRow nextRow() throws IORuntimeException { + List currentFields; + int fieldCount; + while (false == finished) { + currentFields = readLine(); + fieldCount = currentFields.size(); + if (fieldCount < 1) { + // 空List表示读取结束 + break; + } + + // 读取范围校验 + if(lineNo < config.beginLineNo){ + // 未达到读取起始行，继续 + continue; + } + if(lineNo > config.endLineNo){ + // 超出结束行，读取结束 + break; + } + + // 跳过空行 + if (config.skipEmptyRows && fieldCount == 1 && currentFields.get(0).isEmpty()) { + // [""]表示空行 + continue; + } + + // 检查每行的字段数是否一致 + if (config.errorOnDifferentFieldCount) { + if (firstLineFieldCount < 0) { + firstLineFieldCount = fieldCount; + } else if (fieldCount != firstLineFieldCount) { + throw new IORuntimeException(String.format("Line %d has %d fields, but first line has %d fields", lineNo, fieldCount, firstLineFieldCount)); + } + } + + // 记录最大字段数 + if (fieldCount > maxFieldCount) { + maxFieldCount = fieldCount; + } + + //初始化标题 + if (lineNo == config.headerLineNo && null == header) { + initHeader(currentFields); + // 作为标题行后，此行跳过，下一行做为第一行 + continue; + } + + return new CsvRow(lineNo, null == header ? null : header.headerMap, currentFields); + } + + return null; + } + + /** + * 当前行做为标题行 + * + * @param currentFields 当前行字段列表 + */ + private void initHeader(final List currentFields) { + final Map localHeaderMap = new LinkedHashMap<>(currentFields.size()); + for (int i = 0; i < currentFields.size(); i++) { + String field = currentFields.get(i); + if (MapUtil.isNotEmpty(this.config.headerAlias)) { + // 自定义别名 + field = ObjectUtil.defaultIfNull(this.config.headerAlias.get(field), field); + } + if (StrUtil.isNotEmpty(field) && false == localHeaderMap.containsKey(field)) { + localHeaderMap.put(field, i); + } + } + + header = new CsvRow(this.lineNo, Collections.unmodifiableMap(localHeaderMap), Collections.unmodifiableList(currentFields)); + } + + /** + * 读取一行数据，如果读取结束，返回size为0的List
+ * 空行是size为1的List，唯一元素是"" + * + *

+ * 行号要考虑注释行和引号包装的内容中的换行 + *

+ * + * @return 一行数据 + * @throws IORuntimeException IO异常 + */ + private List readLine() throws IORuntimeException { + // 矫正行号 + // 当一行内容包含多行数据时，记录首行行号，但是读取下一行时，需要把多行内容的行数加上 + if(inQuotesLineCount > 0){ + this.lineNo += this.inQuotesLineCount; + this.inQuotesLineCount = 0; + } + + final List currentFields = new ArrayList<>(maxFieldCount > 0 ? maxFieldCount : DEFAULT_ROW_CAPACITY); + + final StrBuilder currentField = this.currentField; + final Buffer buf = this.buf; + int preChar = this.preChar;//前一个特殊分界字符 + int copyLen = 0; //拷贝长度 + boolean inComment = false; + + while (true) { + if (false == buf.hasRemaining()) { + // 此Buffer读取结束，开始读取下一段 + if (copyLen > 0) { + buf.appendTo(currentField, copyLen); + // 此处无需mark，read方法会重置mark + } + if (buf.read(this.reader) < 0) { + // CSV读取结束 + finished = true; + + if (currentField.hasContent() || preChar == config.fieldSeparator) { + //剩余部分作为一个字段 + addField(currentFields, currentField.toStringAndReset()); + } + break; + } + + //重置 + copyLen = 0; + } + + final char c = buf.get(); + + // 注释行标记 + if(preChar < 0 || preChar == CharUtil.CR || preChar == CharUtil.LF){ + // 判断行首字符为指定注释字符的注释开始，直到遇到换行符 + // 行首分两种，1是preChar < 0表示文本开始，2是换行符后紧跟就是下一行的开始 + if(null != this.config.commentCharacter && c == this.config.commentCharacter){ + inComment = true; + } + } + // 注释行处理 + if(inComment){ + if (c == CharUtil.CR || c == CharUtil.LF) { + // 注释行以换行符为结尾 + lineNo++; + inComment = false; + } + // 跳过注释行中的任何字符 + buf.mark(); + preChar = c; + continue; + } + + if (inQuotes) { + //引号内，作为内容，直到引号结束 + if (c == config.textDelimiter) { + // End of quoted text + inQuotes = false; + } else { + // 字段内容中新行 + if (isLineEnd(c, preChar)) { + inQuotesLineCount++; + } + } + // 普通字段字符 + copyLen++; + } else { + // 非引号内 + if (c == config.fieldSeparator) { + //一个字段结束 + if (copyLen > 0) { + buf.appendTo(currentField, copyLen); + copyLen = 0; + } + buf.mark(); + addField(currentFields, currentField.toStringAndReset()); + } else if (c == config.textDelimiter) { + // 引号开始 + inQuotes = true; + copyLen++; + } else if (c == CharUtil.CR) { + // \r，直接结束 + if (copyLen > 0) { + buf.appendTo(currentField, copyLen); + } + buf.mark(); + addField(currentFields, currentField.toStringAndReset()); + preChar = c; + break; + } else if (c == CharUtil.LF) { + // \n + if (preChar != CharUtil.CR) { + if (copyLen > 0) { + buf.appendTo(currentField, copyLen); + } + buf.mark(); + addField(currentFields, currentField.toStringAndReset()); + preChar = c; + break; + } + // 前一个字符是\r，已经处理过这个字段了，此处直接跳过 + buf.mark(); + } else { + // 普通字符 + copyLen++; + } + } + + preChar = c; + } + + // restore fields + this.preChar = preChar; + + lineNo++; + return currentFields; + } + + @Override + public void close() throws IOException { + reader.close(); + } + + /** + * 将字段加入字段列表并自动去包装和去转义 + * + * @param currentFields 当前的字段列表（即为行） + * @param field 字段 + */ + private void addField(List currentFields, String field) { + final char textDelimiter = this.config.textDelimiter; + + // 忽略多余引号后的换行符 + field = StrUtil.trim(field, 1, (c-> c == CharUtil.LF || c == CharUtil.CR)); + + field = StrUtil.unWrap(field, textDelimiter); + field = StrUtil.replace(field, "" + textDelimiter + textDelimiter, textDelimiter + ""); + if(this.config.trimField){ + // issue#I49M0C@Gitee + field = StrUtil.trim(field); + } + currentFields.add(field); + } + + /** + * 是否行结束符 + * + * @param c 符号 + * @param preChar 前一个字符 + * @return 是否结束 + * @since 5.7.4 + */ + private boolean isLineEnd(char c, int preChar) { + return (c == CharUtil.CR || c == CharUtil.LF) && preChar != CharUtil.CR; + } + + /** + * 内部Buffer + * + * @author looly + */ + private static class Buffer implements Serializable{ + private static final long serialVersionUID = 1L; + + final char[] buf; + + /** + * 标记位置，用于读数据 + */ + private int mark; + /** + * 当前位置 + */ + private int position; + /** + * 读取的数据长度，一般小于buf.length，-1表示无数据 + */ + private int limit; + + Buffer(int capacity) { + buf = new char[capacity]; + } + + /** + * 是否还有未读数据 + * + * @return 是否还有未读数据 + */ + public final boolean hasRemaining() { + return position < limit; + } + + /** + * 读取到缓存
+ * 全量读取，会重置Buffer中所有数据 + * + * @param reader {@link Reader} + */ + int read(Reader reader) { + int length; + try { + length = reader.read(this.buf); + } catch (IOException e) { + throw new IORuntimeException(e); + } + this.mark = 0; + this.position = 0; + this.limit = length; + return length; + } + + /** + * 先获取当前字符，再将当前位置后移一位
+ * 此方法不检查是否到了数组末尾，请自行使用{@link #hasRemaining()}判断。 + * + * @return 当前位置字符 + * @see #hasRemaining() + */ + char get() { + return this.buf[this.position++]; + } + + /** + * 标记位置记为下次读取位置 + */ + void mark() { + this.mark = this.position; + } + + /** + * 将数据追加到{@link StrBuilder}，追加结束后需手动调用{@link #mark()} 重置读取位置 + * + * @param builder {@link StrBuilder} + * @param length 追加的长度 + * @see #mark() + */ + void appendTo(StrBuilder builder, int length) { + builder.append(this.buf, this.mark, length); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvReadConfig.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvReadConfig.java new file mode 100755 index 0000000..1f10dda --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvReadConfig.java @@ -0,0 +1,118 @@ +package aiyh.utils.tool.cn.hutool.core.text.csv; + +import java.io.Serializable; + +/** + * CSV读取配置项 + * + * @author looly + * + */ +public class CsvReadConfig extends CsvConfig implements Serializable { + private static final long serialVersionUID = 5396453565371560052L; + + /** 指定标题行号，-1表示无标题行 */ + protected long headerLineNo = -1; + /** 是否跳过空白行，默认true */ + protected boolean skipEmptyRows = true; + /** 每行字段个数不同时是否抛出异常，默认false */ + protected boolean errorOnDifferentFieldCount; + /** 定义开始的行（包括），此处为原始文件行号 */ + protected long beginLineNo; + /** 结束的行（包括），此处为原始文件行号 */ + protected long endLineNo = Long.MAX_VALUE-1; + /** 每个字段是否去除两边空白符 */ + protected boolean trimField; + + /** + * 默认配置 + * + * @return 默认配置 + */ + public static CsvReadConfig defaultConfig() { + return new CsvReadConfig(); + } + + /** + * 设置是否首行做为标题行，默认false
+ * 当设置为{@code true}时，默认标题行号是{@link #beginLineNo}，{@code false}为-1，表示无行号 + * + * @param containsHeader 是否首行做为标题行，默认false + * @return this + * @see #setHeaderLineNo(long) + */ + public CsvReadConfig setContainsHeader(boolean containsHeader) { + return setHeaderLineNo(containsHeader ? beginLineNo : -1); + } + + /** + * 设置标题行行号，默认-1，表示无标题行
+ * + * @param headerLineNo 标题行行号，-1表示无标题行 + * @return this + * @since 5.7.23 + */ + public CsvReadConfig setHeaderLineNo(long headerLineNo) { + this.headerLineNo = headerLineNo; + return this; + } + + /** + * 设置是否跳过空白行，默认true + * + * @param skipEmptyRows 是否跳过空白行，默认true + * @return this + */ + public CsvReadConfig setSkipEmptyRows(boolean skipEmptyRows) { + this.skipEmptyRows = skipEmptyRows; + return this; + } + + /** + * 设置每行字段个数不同时是否抛出异常，默认false + * + * @param errorOnDifferentFieldCount 每行字段个数不同时是否抛出异常，默认false + * @return this + */ + public CsvReadConfig setErrorOnDifferentFieldCount(boolean errorOnDifferentFieldCount) { + this.errorOnDifferentFieldCount = errorOnDifferentFieldCount; + return this; + } + + /** + * 设置开始的行（包括），默认0，此处为原始文件行号 + * + * @param beginLineNo 开始的行号（包括） + * @return this + * @since 5.7.4 + */ + public CsvReadConfig setBeginLineNo(long beginLineNo) { + this.beginLineNo = beginLineNo; + return this; + } + + /** + * 设置结束的行（包括），默认不限制，此处为原始文件行号 + * + * @param endLineNo 结束的行号（包括） + * @return this + * @since 5.7.4 + */ + public CsvReadConfig setEndLineNo(long endLineNo) { + this.endLineNo = endLineNo; + return this; + } + + /** + * 设置每个字段是否去除两边空白符
+ * 如果字段以{@link #textDelimiter}包围，则保留两边空格 + * + * @param trimField 去除两边空白符 + * @return this + * @since 5.7.13 + */ + public CsvReadConfig setTrimField(boolean trimField) { + this.trimField = trimField; + return this; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvReader.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvReader.java new file mode 100755 index 0000000..f7ade5b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvReader.java @@ -0,0 +1,153 @@ +package aiyh.utils.tool.cn.hutool.core.text.csv; + +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; + +import java.io.Closeable; +import java.io.File; +import java.io.IOException; +import java.io.Reader; +import java.nio.charset.Charset; +import java.nio.file.Path; +import java.util.Iterator; +import java.util.stream.Stream; +import java.util.stream.StreamSupport; + +/** + * CSV文件读取器，参考：FastCSV + * + * @author Looly + * @since 4.0.1 + */ +public class CsvReader extends CsvBaseReader implements Iterable, Closeable { + private static final long serialVersionUID = 1L; + + private final Reader reader; + + //--------------------------------------------------------------------------------------------- Constructor start + + /** + * 构造，使用默认配置项 + */ + public CsvReader() { + this(null); + } + + /** + * 构造 + * + * @param config 配置项 + */ + public CsvReader(CsvReadConfig config) { + this((Reader) null, config); + } + + /** + * 构造，默认{@link #DEFAULT_CHARSET}编码 + * + * @param file CSV文件路径，null表示不设置路径 + * @param config 配置项，null表示默认配置 + * @since 5.0.4 + */ + public CsvReader(File file, CsvReadConfig config) { + this(file, DEFAULT_CHARSET, config); + } + + /** + * 构造，默认{@link #DEFAULT_CHARSET}编码 + * + * @param path CSV文件路径，null表示不设置路径 + * @param config 配置项，null表示默认配置 + * @since 5.0.4 + */ + public CsvReader(Path path, CsvReadConfig config) { + this(path, DEFAULT_CHARSET, config); + } + + /** + * 构造 + * + * @param file CSV文件路径，null表示不设置路径 + * @param charset 编码 + * @param config 配置项，null表示默认配置 + * @since 5.0.4 + */ + public CsvReader(File file, Charset charset, CsvReadConfig config) { + this(FileUtil.getReader(file, charset), config); + } + + /** + * 构造 + * + * @param path CSV文件路径，null表示不设置路径 + * @param charset 编码 + * @param config 配置项，null表示默认配置 + * @since 5.0.4 + */ + public CsvReader(Path path, Charset charset, CsvReadConfig config) { + this(FileUtil.getReader(path, charset), config); + } + + /** + * 构造 + * + * @param reader {@link Reader}，null表示不设置默认reader + * @param config 配置项，null表示默认配置 + * @since 5.0.4 + */ + public CsvReader(Reader reader, CsvReadConfig config) { + super(config); + this.reader = reader; + } + //--------------------------------------------------------------------------------------------- Constructor end + /** + * 读取CSV文件，此方法只能调用一次
+ * 调用此方法的前提是构造中传入文件路径或Reader + * + * @return {@link CsvData}，包含数据列表和行信息 + * @throws IORuntimeException IO异常 + */ + public CsvData read() throws IORuntimeException { + return read(this.reader); + } + + /** + * 读取CSV数据，此方法只能调用一次
+ * 调用此方法的前提是构造中传入文件路径或Reader + * + * @param rowHandler 行处理器，用于一行一行的处理数据 + * @throws IORuntimeException IO异常 + * @since 5.0.4 + */ + public void read(CsvRowHandler rowHandler) throws IORuntimeException { + read(this.reader, rowHandler); + } + + /** + * 根据Reader创建{@link Stream}，以便使用stream方式读取csv行 + * + * @return {@link Stream} + * @since 5.7.14 + */ + public Stream stream() { + return StreamSupport.stream(spliterator(), false) + .onClose(() -> { + try { + close(); + } catch (final IOException e) { + throw new IORuntimeException(e); + } + }); + } + + @Override + public Iterator iterator() { + return parse(this.reader); + } + + @Override + public void close() throws IOException { + IoUtil.close(this.reader); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvRow.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvRow.java new file mode 100755 index 0000000..9eba4ee --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvRow.java @@ -0,0 +1,267 @@ +package aiyh.utils.tool.cn.hutool.core.text.csv; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.util.Collection; +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.ListIterator; +import java.util.Map; + +/** + * CSV中一行的表示 + * + * @author Looly + */ +public final class CsvRow implements List { + + /** 原始行号 */ + private final long originalLineNumber; + + final Map headerMap; + final List fields; + + /** + * 构造 + * + * @param originalLineNumber 对应文件中的第几行 + * @param headerMap 标题Map + * @param fields 数据列表 + */ + public CsvRow(long originalLineNumber, Map headerMap, List fields) { + Assert.notNull(fields, "fields must be not null!"); + this.originalLineNumber = originalLineNumber; + this.headerMap = headerMap; + this.fields = fields; + } + + /** + * 获取原始行号，多行情况下为首行行号。忽略注释行 + * + * @return the original line number 行号 + */ + public long getOriginalLineNumber() { + return originalLineNumber; + } + + /** + * 获取标题对应的字段内容 + * + * @param name 标题名 + * @return 字段值，null表示无此字段值 + * @throws IllegalStateException CSV文件无标题行抛出此异常 + */ + public String getByName(String name) { + Assert.notNull(this.headerMap, "No header available!"); + + final Integer col = headerMap.get(name); + if (col != null) { + return get(col); + } + return null; + } + + /** + * 获取本行所有字段值列表 + * + * @return 字段值列表 + */ + public List getRawList() { + return fields; + } + + /** + * 获取标题与字段值对应的Map + * + * @return 标题与字段值对应的Map + * @throws IllegalStateException CSV文件无标题行抛出此异常 + */ + public Map getFieldMap() { + if (headerMap == null) { + throw new IllegalStateException("No header available"); + } + + final Map fieldMap = new LinkedHashMap<>(headerMap.size(), 1); + String key; + Integer col; + String val; + for (final Map.Entry header : headerMap.entrySet()) { + key = header.getKey(); + col = headerMap.get(key); + val = null == col ? null : get(col); + fieldMap.put(key, val); + } + + return fieldMap; + } + + /** + * 一行数据转换为Bean对象 + * + * @param Bean类型 + * @param clazz bean类 + * @return Bean + * @since 5.3.6 + */ + public T toBean(Class clazz){ + return BeanUtil.toBeanIgnoreError(getFieldMap(), clazz); + } + + /** + * 获取字段格式 + * + * @return 字段格式 + */ + public int getFieldCount() { + return fields.size(); + } + + @Override + public int size() { + return this.fields.size(); + } + + @Override + public boolean isEmpty() { + return this.fields.isEmpty(); + } + + @Override + public boolean contains(Object o) { + return this.fields.contains(o); + } + + @Override + public Iterator iterator() { + return this.fields.iterator(); + } + + @Override + public Object[] toArray() { + return this.fields.toArray(); + } + + @Override + public T[] toArray(T[] a) { + //noinspection SuspiciousToArrayCall + return this.fields.toArray(a); + } + + @Override + public boolean add(String e) { + return this.fields.add(e); + } + + @Override + public boolean remove(Object o) { + return this.fields.remove(o); + } + + @Override + public boolean containsAll(Collection c) { + return this.fields.containsAll(c); + } + + @Override + public boolean addAll(Collection c) { + return this.fields.addAll(c); + } + + @Override + public boolean addAll(int index, Collection c) { + return this.fields.addAll(index, c); + } + + @Override + public boolean removeAll(Collection c) { + return this.fields.removeAll(c); + } + + @Override + public boolean retainAll(Collection c) { + return this.fields.retainAll(c); + } + + @Override + public void clear() { + this.fields.clear(); + } + + @Override + public String get(int index) { + return index >= fields.size() ? null : fields.get(index); + } + + @Override + public String set(int index, String element) { + return this.fields.set(index, element); + } + + @Override + public void add(int index, String element) { + this.fields.add(index, element); + } + + @Override + public String remove(int index) { + return this.fields.remove(index); + } + + @Override + public int indexOf(Object o) { + return this.fields.indexOf(o); + } + + @Override + public int lastIndexOf(Object o) { + return this.fields.lastIndexOf(o); + } + + @Override + public ListIterator listIterator() { + return this.fields.listIterator(); + } + + @Override + public ListIterator listIterator(int index) { + return this.fields.listIterator(index); + } + + @Override + public List subList(int fromIndex, int toIndex) { + return this.fields.subList(fromIndex, toIndex); + } + + @Override + public String toString() { + final StringBuilder sb = new StringBuilder("CsvRow{"); + sb.append("originalLineNumber="); + sb.append(originalLineNumber); + sb.append(", "); + + sb.append("fields="); + if (headerMap != null) { + sb.append('{'); + for (final Iterator> it = getFieldMap().entrySet().iterator(); it.hasNext();) { + + final Map.Entry entry = it.next(); + sb.append(entry.getKey()); + sb.append('='); + if (entry.getValue() != null) { + sb.append(entry.getValue()); + } + if (it.hasNext()) { + sb.append(", "); + } + } + sb.append('}'); + } else { + sb.append(fields.toString()); + } + + sb.append('}'); + return sb.toString(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvRowHandler.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvRowHandler.java new file mode 100755 index 0000000..f113473 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvRowHandler.java @@ -0,0 +1,18 @@ +package aiyh.utils.tool.cn.hutool.core.text.csv; + +/** + * CSV的行处理器，实现此接口用于按照行处理数据 + * + * @author Looly + * @since 5.0.4 + */ +@FunctionalInterface +public interface CsvRowHandler { + + /** + * 处理行数据 + * + * @param row 行数据 + */ + void handle(CsvRow row); +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvUtil.java new file mode 100755 index 0000000..47f1b40 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvUtil.java @@ -0,0 +1,141 @@ +package aiyh.utils.tool.cn.hutool.core.text.csv; + +import java.io.File; +import java.io.Reader; +import java.io.Writer; +import java.nio.charset.Charset; + +/** + * CSV工具 + * + * @author looly + * @since 4.0.5 + */ +public class CsvUtil { + + //----------------------------------------------------------------------------------------------------------- Reader + + /** + * 获取CSV读取器，调用此方法创建的Reader须自行指定读取的资源 + * + * @param config 配置, 允许为空. + * @return {@link CsvReader} + */ + public static CsvReader getReader(CsvReadConfig config) { + return new CsvReader(config); + } + + /** + * 获取CSV读取器，调用此方法创建的Reader须自行指定读取的资源 + * + * @return {@link CsvReader} + */ + public static CsvReader getReader() { + return new CsvReader(); + } + + /** + * 获取CSV读取器 + * + * @param reader {@link Reader} + * @param config 配置, {@code null}表示默认配置 + * @return {@link CsvReader} + * @since 5.7.14 + */ + public static CsvReader getReader(Reader reader, CsvReadConfig config) { + return new CsvReader(reader, config); + } + + /** + * 获取CSV读取器 + * + * @param reader {@link Reader} + * @return {@link CsvReader} + * @since 5.7.14 + */ + public static CsvReader getReader(Reader reader) { + return getReader(reader, null); + } + + //----------------------------------------------------------------------------------------------------------- Writer + + /** + * 获取CSV生成器（写出器），使用默认配置，覆盖已有文件（如果存在） + * + * @param filePath File CSV文件路径 + * @param charset 编码 + * @return {@link CsvWriter} + */ + public static CsvWriter getWriter(String filePath, Charset charset) { + return new CsvWriter(filePath, charset); + } + + /** + * 获取CSV生成器（写出器），使用默认配置，覆盖已有文件（如果存在） + * + * @param file File CSV文件 + * @param charset 编码 + * @return {@link CsvWriter} + */ + public static CsvWriter getWriter(File file, Charset charset) { + return new CsvWriter(file, charset); + } + + /** + * 获取CSV生成器（写出器），使用默认配置 + * + * @param filePath File CSV文件路径 + * @param charset 编码 + * @param isAppend 是否追加 + * @return {@link CsvWriter} + */ + public static CsvWriter getWriter(String filePath, Charset charset, boolean isAppend) { + return new CsvWriter(filePath, charset, isAppend); + } + + /** + * 获取CSV生成器（写出器），使用默认配置 + * + * @param file File CSV文件 + * @param charset 编码 + * @param isAppend 是否追加 + * @return {@link CsvWriter} + */ + public static CsvWriter getWriter(File file, Charset charset, boolean isAppend) { + return new CsvWriter(file, charset, isAppend); + } + + /** + * 获取CSV生成器（写出器） + * + * @param file File CSV文件 + * @param charset 编码 + * @param isAppend 是否追加 + * @param config 写出配置，null则使用默认配置 + * @return {@link CsvWriter} + */ + public static CsvWriter getWriter(File file, Charset charset, boolean isAppend, CsvWriteConfig config) { + return new CsvWriter(file, charset, isAppend, config); + } + + /** + * 获取CSV生成器（写出器） + * + * @param writer Writer + * @return {@link CsvWriter} + */ + public static CsvWriter getWriter(Writer writer) { + return new CsvWriter(writer); + } + + /** + * 获取CSV生成器（写出器） + * + * @param writer Writer + * @param config 写出配置，null则使用默认配置 + * @return {@link CsvWriter} + */ + public static CsvWriter getWriter(Writer writer, CsvWriteConfig config) { + return new CsvWriter(writer, config); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvWriteConfig.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvWriteConfig.java new file mode 100755 index 0000000..2899994 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvWriteConfig.java @@ -0,0 +1,54 @@ +package aiyh.utils.tool.cn.hutool.core.text.csv; + +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; + +import java.io.Serializable; + +/** + * CSV写出配置项 + * + * @author looly + */ +public class CsvWriteConfig extends CsvConfig implements Serializable { + private static final long serialVersionUID = 5396453565371560052L; + + /** + * 是否始终使用文本分隔符，文本包装符，默认false，按需添加 + */ + protected boolean alwaysDelimitText; + /** + * 换行符 + */ + protected char[] lineDelimiter = {CharUtil.CR, CharUtil.LF}; + + /** + * 默认配置 + * + * @return 默认配置 + */ + public static CsvWriteConfig defaultConfig() { + return new CsvWriteConfig(); + } + + /** + * 设置是否始终使用文本分隔符，文本包装符，默认false，按需添加 + * + * @param alwaysDelimitText 是否始终使用文本分隔符，文本包装符，默认false，按需添加 + * @return this + */ + public CsvWriteConfig setAlwaysDelimitText(boolean alwaysDelimitText) { + this.alwaysDelimitText = alwaysDelimitText; + return this; + } + + /** + * 设置换行符 + * + * @param lineDelimiter 换行符 + * @return this + */ + public CsvWriteConfig setLineDelimiter(char[] lineDelimiter) { + this.lineDelimiter = lineDelimiter; + return this; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvWriter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvWriter.java new file mode 100755 index 0000000..a47bef2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/CsvWriter.java @@ -0,0 +1,451 @@ +package aiyh.utils.tool.cn.hutool.core.text.csv; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.collection.ArrayIter; +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.util.ArrayUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; +import aiyh.utils.tool.cn.hutool.core.util.CharsetUtil; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.io.BufferedWriter; +import java.io.Closeable; +import java.io.File; +import java.io.Flushable; +import java.io.IOException; +import java.io.Serializable; +import java.io.Writer; +import java.nio.charset.Charset; +import java.util.List; +import java.util.Map; + +/** + * CSV数据写出器 + * + * @author Looly + * @since 4.0.5 + */ +public final class CsvWriter implements Closeable, Flushable, Serializable { + private static final long serialVersionUID = 1L; + + /** + * 写出器 + */ + private final Writer writer; + /** + * 写出配置 + */ + private final CsvWriteConfig config; + /** + * 是否处于新行开始 + */ + private boolean newline = true; + /** + * 是否首行，即CSV开始的位置，当初始化时默认为true，一旦写入内容，为false + */ + private boolean isFirstLine = true; + + // --------------------------------------------------------------------------------------------------- Constructor start + + /** + * 构造，覆盖已有文件（如果存在），默认编码UTF-8 + * + * @param filePath File CSV文件路径 + */ + public CsvWriter(String filePath) { + this(FileUtil.file(filePath)); + } + + /** + * 构造，覆盖已有文件（如果存在），默认编码UTF-8 + * + * @param file File CSV文件 + */ + public CsvWriter(File file) { + this(file, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 构造，覆盖已有文件（如果存在） + * + * @param filePath File CSV文件路径 + * @param charset 编码 + */ + public CsvWriter(String filePath, Charset charset) { + this(FileUtil.file(filePath), charset); + } + + /** + * 构造，覆盖已有文件（如果存在） + * + * @param file File CSV文件 + * @param charset 编码 + */ + public CsvWriter(File file, Charset charset) { + this(file, charset, false); + } + + /** + * 构造 + * + * @param filePath File CSV文件路径 + * @param charset 编码 + * @param isAppend 是否追加 + */ + public CsvWriter(String filePath, Charset charset, boolean isAppend) { + this(FileUtil.file(filePath), charset, isAppend); + } + + /** + * 构造 + * + * @param file CSV文件 + * @param charset 编码 + * @param isAppend 是否追加 + */ + public CsvWriter(File file, Charset charset, boolean isAppend) { + this(file, charset, isAppend, null); + } + + /** + * 构造 + * + * @param filePath CSV文件路径 + * @param charset 编码 + * @param isAppend 是否追加 + * @param config 写出配置，null则使用默认配置 + */ + public CsvWriter(String filePath, Charset charset, boolean isAppend, CsvWriteConfig config) { + this(FileUtil.file(filePath), charset, isAppend, config); + } + + /** + * 构造 + * + * @param file CSV文件 + * @param charset 编码 + * @param isAppend 是否追加 + * @param config 写出配置，null则使用默认配置 + */ + public CsvWriter(File file, Charset charset, boolean isAppend, CsvWriteConfig config) { + this(FileUtil.getWriter(file, charset, isAppend), config); + } + + /** + * 构造，使用默认配置 + * + * @param writer {@link Writer} + */ + public CsvWriter(Writer writer) { + this(writer, null); + } + + /** + * 构造 + * + * @param writer Writer + * @param config 写出配置，null则使用默认配置 + */ + public CsvWriter(Writer writer, CsvWriteConfig config) { + this.writer = (writer instanceof BufferedWriter) ? writer : new BufferedWriter(writer); + this.config = ObjectUtil.defaultIfNull(config, CsvWriteConfig::defaultConfig); + } + // --------------------------------------------------------------------------------------------------- Constructor end + + /** + * 设置是否始终使用文本分隔符，文本包装符，默认false，按需添加 + * + * @param alwaysDelimitText 是否始终使用文本分隔符，文本包装符，默认false，按需添加 + * @return this + */ + public CsvWriter setAlwaysDelimitText(boolean alwaysDelimitText) { + this.config.setAlwaysDelimitText(alwaysDelimitText); + return this; + } + + /** + * 设置换行符 + * + * @param lineDelimiter 换行符 + * @return this + */ + public CsvWriter setLineDelimiter(char[] lineDelimiter) { + this.config.setLineDelimiter(lineDelimiter); + return this; + } + + /** + * 将多行写出到Writer + * + * @param lines 多行数据 + * @return this + * @throws IORuntimeException IO异常 + */ + public CsvWriter write(String[]... lines) throws IORuntimeException { + return write(new ArrayIter<>(lines)); + } + + /** + * 将多行写出到Writer + * + * @param lines 多行数据，每行数据可以是集合或者数组 + * @return this + * @throws IORuntimeException IO异常 + */ + public CsvWriter write(Iterable lines) throws IORuntimeException { + if (CollUtil.isNotEmpty(lines)) { + for (Object values : lines) { + appendLine(Convert.toStrArray(values)); + } + flush(); + } + return this; + } + + /** + * 将一个 CsvData 集合写出到Writer + * + * @param csvData CsvData + * @return this + * @since 5.7.4 + */ + public CsvWriter write(CsvData csvData) { + if (csvData != null) { + // 1、写header + final List header = csvData.getHeader(); + if (CollUtil.isNotEmpty(header)) { + this.writeHeaderLine(header.toArray(new String[0])); + } + // 2、写内容 + this.write(csvData.getRows()); + flush(); + } + return this; + } + + /** + * 将一个Bean集合写出到Writer，并自动生成表头 + * + * @param beans Bean集合 + * @return this + */ + public CsvWriter writeBeans(Iterable beans) { + if (CollUtil.isNotEmpty(beans)) { + boolean isFirst = true; + Map map; + for (Object bean : beans) { + map = BeanUtil.beanToMap(bean); + if (isFirst) { + writeHeaderLine(map.keySet().toArray(new String[0])); + isFirst = false; + } + writeLine(Convert.toStrArray(map.values())); + } + flush(); + } + return this; + } + + /** + * 写出一行头部行，支持标题别名 + * + * @param fields 字段列表 ({@code null} 值会被做为空值追加 + * @return this + * @throws IORuntimeException IO异常 + * @since 5.7.10 + */ + public CsvWriter writeHeaderLine(String... fields) throws IORuntimeException { + final Map headerAlias = this.config.headerAlias; + if (MapUtil.isNotEmpty(headerAlias)) { + // 标题别名替换 + String alias; + for (int i = 0; i < fields.length; i++) { + alias = headerAlias.get(fields[i]); + if (null != alias) { + fields[i] = alias; + } + } + } + return writeLine(fields); + } + + /** + * 写出一行 + * + * @param fields 字段列表 ({@code null} 值会被做为空值追加) + * @return this + * @throws IORuntimeException IO异常 + * @since 5.5.7 + */ + public CsvWriter writeLine(String... fields) throws IORuntimeException { + if (ArrayUtil.isEmpty(fields)) { + return writeLine(); + } + appendLine(fields); + return this; + } + + /** + * 追加新行（换行） + * + * @return this + * @throws IORuntimeException IO异常 + */ + public CsvWriter writeLine() throws IORuntimeException { + try { + writer.write(config.lineDelimiter); + } catch (IOException e) { + throw new IORuntimeException(e); + } + newline = true; + return this; + } + + /** + * 写出一行注释，注释符号可自定义
+ * 如果注释符不存在，则抛出异常 + * + * @param comment 注释内容 + * @return this + * @see CsvConfig#commentCharacter + * @since 5.5.7 + */ + public CsvWriter writeComment(String comment) { + Assert.notNull(this.config.commentCharacter, "Comment is disable!"); + try { + if(isFirstLine){ + // 首行不补换行符 + isFirstLine = false; + }else { + writer.write(config.lineDelimiter); + } + writer.write(this.config.commentCharacter); + writer.write(comment); + newline = true; + } catch (IOException e) { + throw new IORuntimeException(e); + } + return this; + } + + @Override + public void close() { + IoUtil.close(this.writer); + } + + @Override + public void flush() throws IORuntimeException { + try { + writer.flush(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + // --------------------------------------------------------------------------------------------------- Private method start + + /** + * 追加一行，末尾会自动换行，但是追加前不会换行 + * + * @param fields 字段列表 ({@code null} 值会被做为空值追加) + * @throws IORuntimeException IO异常 + */ + private void appendLine(String... fields) throws IORuntimeException { + try { + doAppendLine(fields); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 追加一行，末尾会自动换行，但是追加前不会换行 + * + * @param fields 字段列表 ({@code null} 值会被做为空值追加) + * @throws IOException IO异常 + */ + private void doAppendLine(String... fields) throws IOException { + if (null != fields) { + if(isFirstLine){ + // 首行不补换行符 + isFirstLine = false; + }else { + writer.write(config.lineDelimiter); + } + for (String field : fields) { + appendField(field); + } + newline = true; + } + } + + /** + * 在当前行追加字段值，自动添加字段分隔符，如果有必要，自动包装字段 + * + * @param value 字段值，{@code null} 会被做为空串写出 + * @throws IOException IO异常 + */ + private void appendField(final String value) throws IOException { + boolean alwaysDelimitText = config.alwaysDelimitText; + char textDelimiter = config.textDelimiter; + char fieldSeparator = config.fieldSeparator; + + if (false == newline) { + writer.write(fieldSeparator); + } else { + newline = false; + } + + if (null == value) { + if (alwaysDelimitText) { + writer.write(new char[]{textDelimiter, textDelimiter}); + } + return; + } + + final char[] valueChars = value.toCharArray(); + boolean needsTextDelimiter = alwaysDelimitText; + boolean containsTextDelimiter = false; + + for (final char c : valueChars) { + if (c == textDelimiter) { + // 字段值中存在包装符 + containsTextDelimiter = needsTextDelimiter = true; + break; + } else if (c == fieldSeparator || c == CharUtil.LF || c == CharUtil.CR) { + // 包含分隔符或换行符需要包装符包装 + needsTextDelimiter = true; + } + } + + // 包装符开始 + if (needsTextDelimiter) { + writer.write(textDelimiter); + } + + // 正文 + if (containsTextDelimiter) { + for (final char c : valueChars) { + // 转义文本包装符 + if (c == textDelimiter) { + writer.write(textDelimiter); + } + writer.write(c); + } + } else { + writer.write(valueChars); + } + + // 包装符结尾 + if (needsTextDelimiter) { + writer.write(textDelimiter); + } + } + // --------------------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/package-info.java new file mode 100755 index 0000000..2b7ece9 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/csv/package-info.java @@ -0,0 +1,8 @@ +/** + * 提供CSV文件读写的封装，入口为CsvUtil
+ * 规范见：https://datatracker.ietf.org/doc/html/rfc4180 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.text.csv; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/Html4Escape.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/Html4Escape.java new file mode 100644 index 0000000..3cbf033 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/Html4Escape.java @@ -0,0 +1,316 @@ +package aiyh.utils.tool.cn.hutool.core.text.escape; + +import aiyh.utils.tool.cn.hutool.core.text.replacer.LookupReplacer; + +/** + * HTML4的ESCAPE + * 参考：Commons Lang3 + * + * @author looly + * + */ +public class Html4Escape extends XmlEscape { + private static final long serialVersionUID = 1L; + + protected static final String[][] ISO8859_1_ESCAPE = { // + { "\u00A0", " " }, // non-breaking space + { "\u00A1", "¡" }, // inverted exclamation mark + { "\u00A2", "¢" }, // cent sign + { "\u00A3", "£" }, // pound sign + { "\u00A4", "¤" }, // currency sign + { "\u00A5", "¥" }, // yen sign = yuan sign + { "\u00A6", "¦" }, // broken bar = broken vertical bar + { "\u00A7", "§" }, // section sign + { "\u00A8", "¨" }, // diaeresis = spacing diaeresis + { "\u00A9", "©" }, // � - copyright sign + { "\u00AA", "ª" }, // feminine ordinal indicator + { "\u00AB", "«" }, // left-pointing double angle quotation mark = left pointing guillemet + { "\u00AC", "¬" }, // not sign + { "\u00AD", "­" }, // soft hyphen = discretionary hyphen + { "\u00AE", "®" }, // � - registered trademark sign + { "\u00AF", "¯" }, // macron = spacing macron = overline = APL overbar + { "\u00B0", "°" }, // degree sign + { "\u00B1", "±" }, // plus-minus sign = plus-or-minus sign + { "\u00B2", "²" }, // superscript two = superscript digit two = squared + { "\u00B3", "³" }, // superscript three = superscript digit three = cubed + { "\u00B4", "´" }, // acute accent = spacing acute + { "\u00B5", "µ" }, // micro sign + { "\u00B6", "¶" }, // pilcrow sign = paragraph sign + { "\u00B7", "·" }, // middle dot = Georgian comma = Greek middle dot + { "\u00B8", "¸" }, // cedilla = spacing cedilla + { "\u00B9", "¹" }, // superscript one = superscript digit one + { "\u00BA", "º" }, // masculine ordinal indicator + { "\u00BB", "»" }, // right-pointing double angle quotation mark = right pointing guillemet + { "\u00BC", "¼" }, // vulgar fraction one quarter = fraction one quarter + { "\u00BD", "½" }, // vulgar fraction one half = fraction one half + { "\u00BE", "¾" }, // vulgar fraction three quarters = fraction three quarters + { "\u00BF", "¿" }, // inverted question mark = turned question mark + { "\u00C0", "À" }, // � - uppercase A, grave accent + { "\u00C1", "Á" }, // � - uppercase A, acute accent + { "\u00C2", "Â" }, // � - uppercase A, circumflex accent + { "\u00C3", "Ã" }, // � - uppercase A, tilde + { "\u00C4", "Ä" }, // � - uppercase A, umlaut + { "\u00C5", "Å" }, // � - uppercase A, ring + { "\u00C6", "Æ" }, // � - uppercase AE + { "\u00C7", "Ç" }, // � - uppercase C, cedilla + { "\u00C8", "È" }, // � - uppercase E, grave accent + { "\u00C9", "É" }, // � - uppercase E, acute accent + { "\u00CA", "Ê" }, // � - uppercase E, circumflex accent + { "\u00CB", "Ë" }, // � - uppercase E, umlaut + { "\u00CC", "Ì" }, // � - uppercase I, grave accent + { "\u00CD", "Í" }, // � - uppercase I, acute accent + { "\u00CE", "Î" }, // � - uppercase I, circumflex accent + { "\u00CF", "Ï" }, // � - uppercase I, umlaut + { "\u00D0", "Ð" }, // � - uppercase Eth, Icelandic + { "\u00D1", "Ñ" }, // � - uppercase N, tilde + { "\u00D2", "Ò" }, // � - uppercase O, grave accent + { "\u00D3", "Ó" }, // � - uppercase O, acute accent + { "\u00D4", "Ô" }, // � - uppercase O, circumflex accent + { "\u00D5", "Õ" }, // � - uppercase O, tilde + { "\u00D6", "Ö" }, // � - uppercase O, umlaut + { "\u00D7", "×" }, // multiplication sign + { "\u00D8", "Ø" }, // � - uppercase O, slash + { "\u00D9", "Ù" }, // � - uppercase U, grave accent + { "\u00DA", "Ú" }, // � - uppercase U, acute accent + { "\u00DB", "Û" }, // � - uppercase U, circumflex accent + { "\u00DC", "Ü" }, // � - uppercase U, umlaut + { "\u00DD", "Ý" }, // � - uppercase Y, acute accent + { "\u00DE", "Þ" }, // � - uppercase THORN, Icelandic + { "\u00DF", "ß" }, // � - lowercase sharps, German + { "\u00E0", "à" }, // � - lowercase a, grave accent + { "\u00E1", "á" }, // � - lowercase a, acute accent + { "\u00E2", "â" }, // � - lowercase a, circumflex accent + { "\u00E3", "ã" }, // � - lowercase a, tilde + { "\u00E4", "ä" }, // � - lowercase a, umlaut + { "\u00E5", "å" }, // � - lowercase a, ring + { "\u00E6", "æ" }, // � - lowercase ae + { "\u00E7", "ç" }, // � - lowercase c, cedilla + { "\u00E8", "è" }, // � - lowercase e, grave accent + { "\u00E9", "é" }, // � - lowercase e, acute accent + { "\u00EA", "ê" }, // � - lowercase e, circumflex accent + { "\u00EB", "ë" }, // � - lowercase e, umlaut + { "\u00EC", "ì" }, // � - lowercase i, grave accent + { "\u00ED", "í" }, // � - lowercase i, acute accent + { "\u00EE", "î" }, // � - lowercase i, circumflex accent + { "\u00EF", "ï" }, // � - lowercase i, umlaut + { "\u00F0", "ð" }, // � - lowercase eth, Icelandic + { "\u00F1", "ñ" }, // � - lowercase n, tilde + { "\u00F2", "ò" }, // � - lowercase o, grave accent + { "\u00F3", "ó" }, // � - lowercase o, acute accent + { "\u00F4", "ô" }, // � - lowercase o, circumflex accent + { "\u00F5", "õ" }, // � - lowercase o, tilde + { "\u00F6", "ö" }, // � - lowercase o, umlaut + { "\u00F7", "÷" }, // division sign + { "\u00F8", "ø" }, // � - lowercase o, slash + { "\u00F9", "ù" }, // � - lowercase u, grave accent + { "\u00FA", "ú" }, // � - lowercase u, acute accent + { "\u00FB", "û" }, // � - lowercase u, circumflex accent + { "\u00FC", "ü" }, // � - lowercase u, umlaut + { "\u00FD", "ý" }, // � - lowercase y, acute accent + { "\u00FE", "þ" }, // � - lowercase thorn, Icelandic + { "\u00FF", "ÿ" }, // � - lowercase y, umlaut + }; + + protected static final String[][] HTML40_EXTENDED_ESCAPE = { + // + { "\u0192", "ƒ" }, // latin small f with hook = function= florin, U+0192 ISOtech --> + // + { "\u0391", "Α" }, // greek capital letter alpha, U+0391 --> + { "\u0392", "Β" }, // greek capital letter beta, U+0392 --> + { "\u0393", "Γ" }, // greek capital letter gamma,U+0393 ISOgrk3 --> + { "\u0394", "Δ" }, // greek capital letter delta,U+0394 ISOgrk3 --> + { "\u0395", "Ε" }, // greek capital letter epsilon, U+0395 --> + { "\u0396", "Ζ" }, // greek capital letter zeta, U+0396 --> + { "\u0397", "Η" }, // greek capital letter eta, U+0397 --> + { "\u0398", "Θ" }, // greek capital letter theta,U+0398 ISOgrk3 --> + { "\u0399", "Ι" }, // greek capital letter iota, U+0399 --> + { "\u039A", "Κ" }, // greek capital letter kappa, U+039A --> + { "\u039B", "Λ" }, // greek capital letter lambda,U+039B ISOgrk3 --> + { "\u039C", "Μ" }, // greek capital letter mu, U+039C --> + { "\u039D", "Ν" }, // greek capital letter nu, U+039D --> + { "\u039E", "Ξ" }, // greek capital letter xi, U+039E ISOgrk3 --> + { "\u039F", "Ο" }, // greek capital letter omicron, U+039F --> + { "\u03A0", "Π" }, // greek capital letter pi, U+03A0 ISOgrk3 --> + { "\u03A1", "Ρ" }, // greek capital letter rho, U+03A1 --> + // + { "\u03A3", "Σ" }, // greek capital letter sigma,U+03A3 ISOgrk3 --> + { "\u03A4", "Τ" }, // greek capital letter tau, U+03A4 --> + { "\u03A5", "Υ" }, // greek capital letter upsilon,U+03A5 ISOgrk3 --> + { "\u03A6", "Φ" }, // greek capital letter phi,U+03A6 ISOgrk3 --> + { "\u03A7", "Χ" }, // greek capital letter chi, U+03A7 --> + { "\u03A8", "Ψ" }, // greek capital letter psi,U+03A8 ISOgrk3 --> + { "\u03A9", "Ω" }, // greek capital letter omega,U+03A9 ISOgrk3 --> + { "\u03B1", "α" }, // greek small letter alpha,U+03B1 ISOgrk3 --> + { "\u03B2", "β" }, // greek small letter beta, U+03B2 ISOgrk3 --> + { "\u03B3", "γ" }, // greek small letter gamma,U+03B3 ISOgrk3 --> + { "\u03B4", "δ" }, // greek small letter delta,U+03B4 ISOgrk3 --> + { "\u03B5", "ε" }, // greek small letter epsilon,U+03B5 ISOgrk3 --> + { "\u03B6", "ζ" }, // greek small letter zeta, U+03B6 ISOgrk3 --> + { "\u03B7", "η" }, // greek small letter eta, U+03B7 ISOgrk3 --> + { "\u03B8", "θ" }, // greek small letter theta,U+03B8 ISOgrk3 --> + { "\u03B9", "ι" }, // greek small letter iota, U+03B9 ISOgrk3 --> + { "\u03BA", "κ" }, // greek small letter kappa,U+03BA ISOgrk3 --> + { "\u03BB", "λ" }, // greek small letter lambda,U+03BB ISOgrk3 --> + { "\u03BC", "μ" }, // greek small letter mu, U+03BC ISOgrk3 --> + { "\u03BD", "ν" }, // greek small letter nu, U+03BD ISOgrk3 --> + { "\u03BE", "ξ" }, // greek small letter xi, U+03BE ISOgrk3 --> + { "\u03BF", "ο" }, // greek small letter omicron, U+03BF NEW --> + { "\u03C0", "π" }, // greek small letter pi, U+03C0 ISOgrk3 --> + { "\u03C1", "ρ" }, // greek small letter rho, U+03C1 ISOgrk3 --> + { "\u03C2", "ς" }, // greek small letter final sigma,U+03C2 ISOgrk3 --> + { "\u03C3", "σ" }, // greek small letter sigma,U+03C3 ISOgrk3 --> + { "\u03C4", "τ" }, // greek small letter tau, U+03C4 ISOgrk3 --> + { "\u03C5", "υ" }, // greek small letter upsilon,U+03C5 ISOgrk3 --> + { "\u03C6", "φ" }, // greek small letter phi, U+03C6 ISOgrk3 --> + { "\u03C7", "χ" }, // greek small letter chi, U+03C7 ISOgrk3 --> + { "\u03C8", "ψ" }, // greek small letter psi, U+03C8 ISOgrk3 --> + { "\u03C9", "ω" }, // greek small letter omega,U+03C9 ISOgrk3 --> + { "\u03D1", "ϑ" }, // greek small letter theta symbol,U+03D1 NEW --> + { "\u03D2", "ϒ" }, // greek upsilon with hook symbol,U+03D2 NEW --> + { "\u03D6", "ϖ" }, // greek pi symbol, U+03D6 ISOgrk3 --> + // + { "\u2022", "•" }, // bullet = black small circle,U+2022 ISOpub --> + // + { "\u2026", "…" }, // horizontal ellipsis = three dot leader,U+2026 ISOpub --> + { "\u2032", "′" }, // prime = minutes = feet, U+2032 ISOtech --> + { "\u2033", "″" }, // double prime = seconds = inches,U+2033 ISOtech --> + { "\u203E", "‾" }, // overline = spacing overscore,U+203E NEW --> + { "\u2044", "⁄" }, // fraction slash, U+2044 NEW --> + // + { "\u2118", "℘" }, // script capital P = power set= Weierstrass p, U+2118 ISOamso --> + { "\u2111", "ℑ" }, // blackletter capital I = imaginary part,U+2111 ISOamso --> + { "\u211C", "ℜ" }, // blackletter capital R = real part symbol,U+211C ISOamso --> + { "\u2122", "™" }, // trade mark sign, U+2122 ISOnum --> + { "\u2135", "ℵ" }, // alef symbol = first transfinite cardinal,U+2135 NEW --> + // + // + { "\u2190", "←" }, // leftwards arrow, U+2190 ISOnum --> + { "\u2191", "↑" }, // upwards arrow, U+2191 ISOnum--> + { "\u2192", "→" }, // rightwards arrow, U+2192 ISOnum --> + { "\u2193", "↓" }, // downwards arrow, U+2193 ISOnum --> + { "\u2194", "↔" }, // left right arrow, U+2194 ISOamsa --> + { "\u21B5", "↵" }, // downwards arrow with corner leftwards= carriage return, U+21B5 NEW --> + { "\u21D0", "⇐" }, // leftwards double arrow, U+21D0 ISOtech --> + // + { "\u21D1", "⇑" }, // upwards double arrow, U+21D1 ISOamsa --> + { "\u21D2", "⇒" }, // rightwards double arrow,U+21D2 ISOtech --> + // + { "\u21D3", "⇓" }, // downwards double arrow, U+21D3 ISOamsa --> + { "\u21D4", "⇔" }, // left right double arrow,U+21D4 ISOamsa --> + // + { "\u2200", "∀" }, // for all, U+2200 ISOtech --> + { "\u2202", "∂" }, // partial differential, U+2202 ISOtech --> + { "\u2203", "∃" }, // there exists, U+2203 ISOtech --> + { "\u2205", "∅" }, // empty set = null set = diameter,U+2205 ISOamso --> + { "\u2207", "∇" }, // nabla = backward difference,U+2207 ISOtech --> + { "\u2208", "∈" }, // element of, U+2208 ISOtech --> + { "\u2209", "∉" }, // not an element of, U+2209 ISOtech --> + { "\u220B", "∋" }, // contains as member, U+220B ISOtech --> + // + { "\u220F", "∏" }, // n-ary product = product sign,U+220F ISOamsb --> + // + { "\u2211", "∑" }, // n-ary summation, U+2211 ISOamsb --> + // + { "\u2212", "−" }, // minus sign, U+2212 ISOtech --> + { "\u2217", "∗" }, // asterisk operator, U+2217 ISOtech --> + { "\u221A", "√" }, // square root = radical sign,U+221A ISOtech --> + { "\u221D", "∝" }, // proportional to, U+221D ISOtech --> + { "\u221E", "∞" }, // infinity, U+221E ISOtech --> + { "\u2220", "∠" }, // angle, U+2220 ISOamso --> + { "\u2227", "∧" }, // logical and = wedge, U+2227 ISOtech --> + { "\u2228", "∨" }, // logical or = vee, U+2228 ISOtech --> + { "\u2229", "∩" }, // intersection = cap, U+2229 ISOtech --> + { "\u222A", "∪" }, // union = cup, U+222A ISOtech --> + { "\u222B", "∫" }, // integral, U+222B ISOtech --> + { "\u2234", "∴" }, // therefore, U+2234 ISOtech --> + { "\u223C", "∼" }, // tilde operator = varies with = similar to,U+223C ISOtech --> + // + { "\u2245", "≅" }, // approximately equal to, U+2245 ISOtech --> + { "\u2248", "≈" }, // almost equal to = asymptotic to,U+2248 ISOamsr --> + { "\u2260", "≠" }, // not equal to, U+2260 ISOtech --> + { "\u2261", "≡" }, // identical to, U+2261 ISOtech --> + { "\u2264", "≤" }, // less-than or equal to, U+2264 ISOtech --> + { "\u2265", "≥" }, // greater-than or equal to,U+2265 ISOtech --> + { "\u2282", "⊂" }, // subset of, U+2282 ISOtech --> + { "\u2283", "⊃" }, // superset of, U+2283 ISOtech --> + // + { "\u2286", "⊆" }, // subset of or equal to, U+2286 ISOtech --> + { "\u2287", "⊇" }, // superset of or equal to,U+2287 ISOtech --> + { "\u2295", "⊕" }, // circled plus = direct sum,U+2295 ISOamsb --> + { "\u2297", "⊗" }, // circled times = vector product,U+2297 ISOamsb --> + { "\u22A5", "⊥" }, // up tack = orthogonal to = perpendicular,U+22A5 ISOtech --> + { "\u22C5", "⋅" }, // dot operator, U+22C5 ISOamsb --> + // + // + { "\u2308", "⌈" }, // left ceiling = apl upstile,U+2308 ISOamsc --> + { "\u2309", "⌉" }, // right ceiling, U+2309 ISOamsc --> + { "\u230A", "⌊" }, // left floor = apl downstile,U+230A ISOamsc --> + { "\u230B", "⌋" }, // right floor, U+230B ISOamsc --> + { "\u2329", "⟨" }, // left-pointing angle bracket = bra,U+2329 ISOtech --> + // + { "\u232A", "⟩" }, // right-pointing angle bracket = ket,U+232A ISOtech --> + // + // + { "\u25CA", "◊" }, // lozenge, U+25CA ISOpub --> + // + { "\u2660", "♠" }, // black spade suit, U+2660 ISOpub --> + // + { "\u2663", "♣" }, // black club suit = shamrock,U+2663 ISOpub --> + { "\u2665", "♥" }, // black heart suit = valentine,U+2665 ISOpub --> + { "\u2666", "♦" }, // black diamond suit, U+2666 ISOpub --> + + // + { "\u0152", "Œ" }, // -- latin capital ligature OE,U+0152 ISOlat2 --> + { "\u0153", "œ" }, // -- latin small ligature oe, U+0153 ISOlat2 --> + // + { "\u0160", "Š" }, // -- latin capital letter S with caron,U+0160 ISOlat2 --> + { "\u0161", "š" }, // -- latin small letter s with caron,U+0161 ISOlat2 --> + { "\u0178", "Ÿ" }, // -- latin capital letter Y with diaeresis,U+0178 ISOlat2 --> + // + { "\u02C6", "ˆ" }, // -- modifier letter circumflex accent,U+02C6 ISOpub --> + { "\u02DC", "˜" }, // small tilde, U+02DC ISOdia --> + // + { "\u2002", " " }, // en space, U+2002 ISOpub --> + { "\u2003", " " }, // em space, U+2003 ISOpub --> + { "\u2009", " " }, // thin space, U+2009 ISOpub --> + { "\u200C", "‌" }, // zero width non-joiner,U+200C NEW RFC 2070 --> + { "\u200D", "‍" }, // zero width joiner, U+200D NEW RFC 2070 --> + { "\u200E", "‎" }, // left-to-right mark, U+200E NEW RFC 2070 --> + { "\u200F", "‏" }, // right-to-left mark, U+200F NEW RFC 2070 --> + { "\u2013", "–" }, // en dash, U+2013 ISOpub --> + { "\u2014", "—" }, // em dash, U+2014 ISOpub --> + { "\u2018", "‘" }, // left single quotation mark,U+2018 ISOnum --> + { "\u2019", "’" }, // right single quotation mark,U+2019 ISOnum --> + { "\u201A", "‚" }, // single low-9 quotation mark, U+201A NEW --> + { "\u201C", "“" }, // left double quotation mark,U+201C ISOnum --> + { "\u201D", "”" }, // right double quotation mark,U+201D ISOnum --> + { "\u201E", "„" }, // double low-9 quotation mark, U+201E NEW --> + { "\u2020", "†" }, // dagger, U+2020 ISOpub --> + { "\u2021", "‡" }, // double dagger, U+2021 ISOpub --> + { "\u2030", "‰" }, // per mille sign, U+2030 ISOtech --> + { "\u2039", "‹" }, // single left-pointing angle quotation mark,U+2039 ISO proposed --> + // + { "\u203A", "›" }, // single right-pointing angle quotation mark,U+203A ISO proposed --> + // + { "\u20AC", "€" }, // -- euro sign, U+20AC NEW --> + }; + + public Html4Escape() { + super(); + addChain(new LookupReplacer(ISO8859_1_ESCAPE)); + addChain(new LookupReplacer(HTML40_EXTENDED_ESCAPE)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/Html4Unescape.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/Html4Unescape.java new file mode 100644 index 0000000..01b4746 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/Html4Unescape.java @@ -0,0 +1,22 @@ +package aiyh.utils.tool.cn.hutool.core.text.escape; + +import aiyh.utils.tool.cn.hutool.core.text.replacer.LookupReplacer; + +/** + * HTML4的UNESCAPE + * + * @author looly + * + */ +public class Html4Unescape extends XmlUnescape { + private static final long serialVersionUID = 1L; + + protected static final String[][] ISO8859_1_UNESCAPE = InternalEscapeUtil.invert(Html4Escape.ISO8859_1_ESCAPE); + protected static final String[][] HTML40_EXTENDED_UNESCAPE = InternalEscapeUtil.invert(Html4Escape.HTML40_EXTENDED_ESCAPE); + + public Html4Unescape() { + super(); + addChain(new LookupReplacer(ISO8859_1_UNESCAPE)); + addChain(new LookupReplacer(HTML40_EXTENDED_UNESCAPE)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/InternalEscapeUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/InternalEscapeUtil.java new file mode 100644 index 0000000..36c398d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/InternalEscapeUtil.java @@ -0,0 +1,24 @@ +package aiyh.utils.tool.cn.hutool.core.text.escape; + +/** + * 内部Escape工具类 + * @author looly + * + */ +class InternalEscapeUtil { + + /** + * 将数组中的0和1位置的值互换，即键值转换 + * + * @param array String[][] 被转换的数组 + * @return String[][] 转换后的数组 + */ + public static String[][] invert(final String[][] array) { + final String[][] newarray = new String[array.length][2]; + for (int i = 0; i < array.length; i++) { + newarray[i][0] = array[i][1]; + newarray[i][1] = array[i][0]; + } + return newarray; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/NumericEntityUnescaper.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/NumericEntityUnescaper.java new file mode 100644 index 0000000..092416c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/NumericEntityUnescaper.java @@ -0,0 +1,56 @@ +package aiyh.utils.tool.cn.hutool.core.text.escape; + +import aiyh.utils.tool.cn.hutool.core.text.StrBuilder; +import aiyh.utils.tool.cn.hutool.core.text.replacer.StrReplacer; +import aiyh.utils.tool.cn.hutool.core.util.CharUtil; + +/** + * 形如'的反转义器 + * + * @author looly + * + */ +public class NumericEntityUnescaper extends StrReplacer { + private static final long serialVersionUID = 1L; + + @Override + protected int replace(CharSequence str, int pos, StrBuilder out) { + final int len = str.length(); + // 检查以确保以&#开头 + if (str.charAt(pos) == '&' && pos < len - 2 && str.charAt(pos + 1) == '#') { + int start = pos + 2; + boolean isHex = false; + final char firstChar = str.charAt(start); + if (firstChar == 'x' || firstChar == 'X') { + start++; + isHex = true; + } + + // 确保&#后还有数字 + if (start == len) { + return 0; + } + + int end = start; + while (end < len && CharUtil.isHexChar(str.charAt(end))) { + end++; + } + final boolean isSemiNext = (end != len) && (str.charAt(end) == ';'); + if (isSemiNext) { + int entityValue; + try { + if (isHex) { + entityValue = Integer.parseInt(str.subSequence(start, end).toString(), 16); + } else { + entityValue = Integer.parseInt(str.subSequence(start, end).toString(), 10); + } + } catch (final NumberFormatException nfe) { + return 0; + } + out.append((char)entityValue); + return 2 + end - start + (isHex ? 1 : 0) + 1; + } + } + return 0; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/XmlEscape.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/XmlEscape.java new file mode 100644 index 0000000..9641642 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/XmlEscape.java @@ -0,0 +1,38 @@ +package aiyh.utils.tool.cn.hutool.core.text.escape; + +import aiyh.utils.tool.cn.hutool.core.text.replacer.LookupReplacer; +import aiyh.utils.tool.cn.hutool.core.text.replacer.ReplacerChain; + +/** + * XML特殊字符转义
+ * 见：https://stackoverflow.com/questions/1091945/what-characters-do-i-need-to-escape-in-xml-documents
+ * + * 
+ * 	 & (ampersand) 替换为 &amp;
+ * 	 < (less than) 替换为 &lt;
+ * 	 > (greater than) 替换为 &gt;
+ * 	 " (double quote) 替换为 &quot;
+ * 	 ' (single quote / apostrophe) 替换为 &apos;
+ *
+ * + * @author looly + * @since 5.7.2 + */ +public class XmlEscape extends ReplacerChain { + private static final long serialVersionUID = 1L; + + protected static final String[][] BASIC_ESCAPE = { // +// {"'", "'"}, // " - single-quote + {"\"", """}, // " - double-quote + {"&", "&"}, // & - ampersand + {"<", "<"}, // < - less-than + {">", ">"}, // > - greater-than + }; + + /** + * 构造 + */ + public XmlEscape() { + addChain(new LookupReplacer(BASIC_ESCAPE)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/XmlUnescape.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/XmlUnescape.java new file mode 100644 index 0000000..faf8b98 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/XmlUnescape.java @@ -0,0 +1,27 @@ +package aiyh.utils.tool.cn.hutool.core.text.escape; + +import aiyh.utils.tool.cn.hutool.core.text.replacer.LookupReplacer; +import aiyh.utils.tool.cn.hutool.core.text.replacer.ReplacerChain; + +/** + * XML的UNESCAPE + * + * @author looly + * @since 5.7.2 + */ +public class XmlUnescape extends ReplacerChain { + private static final long serialVersionUID = 1L; + + protected static final String[][] BASIC_UNESCAPE = InternalEscapeUtil.invert(XmlEscape.BASIC_ESCAPE); + // issue#1118 + protected static final String[][] OTHER_UNESCAPE = new String[][]{new String[]{"'", "'"}}; + + /** + * 构造 + */ + public XmlUnescape() { + addChain(new LookupReplacer(BASIC_UNESCAPE)); + addChain(new NumericEntityUnescaper()); + addChain(new LookupReplacer(OTHER_UNESCAPE)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/package-info.java new file mode 100644 index 0000000..f3c2793 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/escape/package-info.java @@ -0,0 +1,7 @@ +/** + * 提供各种转义和反转义实现 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.text.escape; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/CharFinder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/CharFinder.java new file mode 100644 index 0000000..c0fcb73 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/CharFinder.java @@ -0,0 +1,66 @@ +package aiyh.utils.tool.cn.hutool.core.text.finder; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.util.NumberUtil; + +/** + * 字符查找器
+ * 查找指定字符在字符串中的位置信息 + * + * @author looly + * @since 5.7.14 + */ +public class CharFinder extends TextFinder { + private static final long serialVersionUID = 1L; + + private final char c; + private final boolean caseInsensitive; + + /** + * 构造，不忽略字符大小写 + * + * @param c 被查找的字符 + */ + public CharFinder(char c) { + this(c, false); + } + + /** + * 构造 + * + * @param c 被查找的字符 + * @param caseInsensitive 是否忽略大小写 + */ + public CharFinder(char c, boolean caseInsensitive) { + this.c = c; + this.caseInsensitive = caseInsensitive; + } + + @Override + public int start(int from) { + Assert.notNull(this.text, "Text to find must be not null!"); + final int limit = getValidEndIndex(); + if(negative){ + for (int i = from; i > limit; i--) { + if (NumberUtil.equals(c, text.charAt(i), caseInsensitive)) { + return i; + } + } + } else{ + for (int i = from; i < limit; i++) { + if (NumberUtil.equals(c, text.charAt(i), caseInsensitive)) { + return i; + } + } + } + return -1; + } + + @Override + public int end(int start) { + if (start < 0) { + return -1; + } + return start + 1; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/CharMatcherFinder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/CharMatcherFinder.java new file mode 100755 index 0000000..e738922 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/CharMatcherFinder.java @@ -0,0 +1,53 @@ +package aiyh.utils.tool.cn.hutool.core.text.finder; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Matcher; + +/** + * 字符匹配查找器
+ * 查找满足指定{@link Matcher} 匹配的字符所在位置，此类长用于查找某一类字符，如数字等 + * + * @since 5.7.14 + * @author looly + */ +public class CharMatcherFinder extends TextFinder { + private static final long serialVersionUID = 1L; + + private final Matcher matcher; + + /** + * 构造 + * @param matcher 被查找的字符匹配器 + */ + public CharMatcherFinder(Matcher matcher) { + this.matcher = matcher; + } + + @Override + public int start(int from) { + Assert.notNull(this.text, "Text to find must be not null!"); + final int limit = getValidEndIndex(); + if(negative){ + for (int i = from; i > limit; i--) { + if(matcher.match(text.charAt(i))){ + return i; + } + } + } else { + for (int i = from; i < limit; i++) { + if(matcher.match(text.charAt(i))){ + return i; + } + } + } + return -1; + } + + @Override + public int end(int start) { + if(start < 0){ + return -1; + } + return start + 1; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/Finder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/Finder.java new file mode 100644 index 0000000..b076baf --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/Finder.java @@ -0,0 +1,36 @@ +package aiyh.utils.tool.cn.hutool.core.text.finder; + +/** + * 字符串查找接口，通过调用{@link #start(int)}查找开始位置，再调用{@link #end(int)}找结束位置 + * + * @author looly + * @since 5.7.14 + */ +public interface Finder { + + int INDEX_NOT_FOUND = -1; + + /** + * 返回开始位置，即起始字符位置（包含），未找到返回-1 + * + * @param from 查找的开始位置（包含） + * @return 起始字符位置，未找到返回-1 + */ + int start(int from); + + /** + * 返回结束位置，即最后一个字符后的位置（不包含） + * + * @param start 找到的起始位置 + * @return 结束位置，未找到返回-1 + */ + int end(int start); + + /** + * 复位查找器，用于重用对象 + * @return this + */ + default Finder reset(){ + return this; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/LengthFinder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/LengthFinder.java new file mode 100644 index 0000000..d653062 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/LengthFinder.java @@ -0,0 +1,48 @@ +package aiyh.utils.tool.cn.hutool.core.text.finder; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +/** + * 固定长度查找器
+ * 给定一个长度，查找的位置为from + length，一般用于分段截取 + * + * @since 5.7.14 + * @author looly + */ +public class LengthFinder extends TextFinder { + private static final long serialVersionUID = 1L; + + private final int length; + + /** + * 构造 + * @param length 长度 + */ + public LengthFinder(int length) { + this.length = length; + } + + @Override + public int start(int from) { + Assert.notNull(this.text, "Text to find must be not null!"); + final int limit = getValidEndIndex(); + int result; + if(negative){ + result = from - length; + if(result > limit){ + return result; + } + } else { + result = from + length; + if(result < limit){ + return result; + } + } + return -1; + } + + @Override + public int end(int start) { + return start; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/PatternFinder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/PatternFinder.java new file mode 100644 index 0000000..09d8faf --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/PatternFinder.java @@ -0,0 +1,77 @@ +package aiyh.utils.tool.cn.hutool.core.text.finder; + +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * 正则查找器
+ * 通过传入正则表达式，查找指定字符串中匹配正则的开始和结束位置 + * + * @author looly + * @since 5.7.14 + */ +public class PatternFinder extends TextFinder { + private static final long serialVersionUID = 1L; + + private final Pattern pattern; + private Matcher matcher; + + /** + * 构造 + * + * @param regex 被查找的正则表达式 + * @param caseInsensitive 是否忽略大小写 + */ + public PatternFinder(String regex, boolean caseInsensitive) { + this(Pattern.compile(regex, caseInsensitive ? Pattern.CASE_INSENSITIVE : 0)); + } + + /** + * 构造 + * + * @param pattern 被查找的正则{@link Pattern} + */ + public PatternFinder(Pattern pattern) { + this.pattern = pattern; + } + + @Override + public TextFinder setText(CharSequence text) { + this.matcher = pattern.matcher(text); + return super.setText(text); + } + + @Override + public TextFinder setNegative(boolean negative) { + throw new UnsupportedOperationException("Negative is invalid for Pattern!"); + } + + @Override + public int start(int from) { + if (matcher.find(from)) { + // 只有匹配到的字符串结尾在limit范围内，才算找到 + if(matcher.end() <= getValidEndIndex()){ + return matcher.start(); + } + } + return INDEX_NOT_FOUND; + } + + @Override + public int end(int start) { + final int end = matcher.end(); + final int limit; + if(endIndex < 0){ + limit = text.length(); + }else{ + limit = Math.min(endIndex, text.length()); + } + return end <= limit ? end : INDEX_NOT_FOUND; + } + + @Override + public PatternFinder reset() { + this.matcher.reset(); + return this; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/StrFinder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/StrFinder.java new file mode 100644 index 0000000..9aace78 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/StrFinder.java @@ -0,0 +1,64 @@ +package aiyh.utils.tool.cn.hutool.core.text.finder; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.text.CharSequenceUtil; + +/** + * 字符串查找器 + * + * @author looly + * @since 5.7.14 + */ +public class StrFinder extends TextFinder { + private static final long serialVersionUID = 1L; + + private final CharSequence strToFind; + private final boolean caseInsensitive; + + /** + * 构造 + * + * @param strToFind 被查找的字符串 + * @param caseInsensitive 是否忽略大小写 + */ + public StrFinder(CharSequence strToFind, boolean caseInsensitive) { + Assert.notEmpty(strToFind); + this.strToFind = strToFind; + this.caseInsensitive = caseInsensitive; + } + + @Override + public int start(int from) { + Assert.notNull(this.text, "Text to find must be not null!"); + final int subLen = strToFind.length(); + + if (from < 0) { + from = 0; + } + int endLimit = getValidEndIndex(); + if (negative) { + for (int i = from; i > endLimit; i--) { + if (CharSequenceUtil.isSubEquals(text, i, strToFind, 0, subLen, caseInsensitive)) { + return i; + } + } + } else { + endLimit = endLimit - subLen + 1; + for (int i = from; i < endLimit; i++) { + if (CharSequenceUtil.isSubEquals(text, i, strToFind, 0, subLen, caseInsensitive)) { + return i; + } + } + } + + return INDEX_NOT_FOUND; + } + + @Override + public int end(int start) { + if (start < 0) { + return -1; + } + return start + strToFind.length(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/TextFinder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/TextFinder.java new file mode 100644 index 0000000..dc97081 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/TextFinder.java @@ -0,0 +1,74 @@ +package aiyh.utils.tool.cn.hutool.core.text.finder; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.io.Serializable; + +/** + * 文本查找抽象类 + * + * @author looly + * @since 5.7.14 + */ +public abstract class TextFinder implements Finder, Serializable { + private static final long serialVersionUID = 1L; + + protected CharSequence text; + protected int endIndex = -1; + protected boolean negative; + + /** + * 设置被查找的文本 + * + * @param text 文本 + * @return this + */ + public TextFinder setText(CharSequence text) { + this.text = Assert.notNull(text, "Text must be not null!"); + return this; + } + + /** + * 设置查找的结束位置
+ * 如果从前向后查找，结束位置最大为text.length()
+ * 如果从后向前，结束位置为-1 + * + * @param endIndex 结束位置（不包括） + * @return this + */ + public TextFinder setEndIndex(int endIndex) { + this.endIndex = endIndex; + return this; + } + + /** + * 设置是否反向查找，{@code true}表示从后向前查找 + * + * @param negative 结束位置（不包括） + * @return this + */ + public TextFinder setNegative(boolean negative) { + this.negative = negative; + return this; + } + + /** + * 获取有效结束位置
+ * 如果{@link #endIndex}小于0，在反向模式下是开头（-1），正向模式是结尾（text.length()） + * + * @return 有效结束位置 + */ + protected int getValidEndIndex() { + if(negative && -1 == endIndex){ + // 反向查找模式下，-1表示0前面的位置，即字符串反向末尾的位置 + return -1; + } + final int limit; + if (endIndex < 0) { + limit = endIndex + text.length() + 1; + } else { + limit = Math.min(endIndex, text.length()); + } + return limit; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/package-info.java new file mode 100644 index 0000000..6f0fc06 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/finder/package-info.java @@ -0,0 +1,13 @@ +/** + * 文本查找实现，包括： + *
    + *
  • 查找文本中的字符（正向、反向）
    • + *
  • 查找文本中的匹配字符（正向、反向）
    • + *
  • 查找文本中的字符串（正向、反向）
    • + *
  • 查找文本中匹配正则的字符串（正向）
    • + *
+ * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.text.finder; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/package-info.java new file mode 100644 index 0000000..f7efade --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/package-info.java @@ -0,0 +1,7 @@ +/** + * 提供文本相关操作的封装，还包括Unicode工具UnicodeUtil + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.text; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/replacer/LookupReplacer.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/replacer/LookupReplacer.java new file mode 100644 index 0000000..eee7fa8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/replacer/LookupReplacer.java @@ -0,0 +1,74 @@ +package aiyh.utils.tool.cn.hutool.core.text.replacer; + +import aiyh.utils.tool.cn.hutool.core.text.StrBuilder; + +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; + +/** + * 查找替换器，通过查找指定关键字，替换对应的值 + * + * @author looly + * @since 4.1.5 + */ +public class LookupReplacer extends StrReplacer { + private static final long serialVersionUID = 1L; + + private final Map lookupMap; + private final Set prefixSet; + private final int minLength; + private final int maxLength; + + /** + * 构造 + * + * @param lookup 被查找的键值对 + */ + public LookupReplacer(String[]... lookup) { + this.lookupMap = new HashMap<>(); + this.prefixSet = new HashSet<>(); + + int minLength = Integer.MAX_VALUE; + int maxLength = 0; + String key; + int keySize; + for (String[] pair : lookup) { + key = pair[0]; + lookupMap.put(key, pair[1]); + this.prefixSet.add(key.charAt(0)); + keySize = key.length(); + if (keySize > maxLength) { + maxLength = keySize; + } + if (keySize < minLength) { + minLength = keySize; + } + } + this.maxLength = maxLength; + this.minLength = minLength; + } + + @Override + protected int replace(CharSequence str, int pos, StrBuilder out) { + if (prefixSet.contains(str.charAt(pos))) { + int max = this.maxLength; + if (pos + this.maxLength > str.length()) { + max = str.length() - pos; + } + CharSequence subSeq; + String result; + for (int i = max; i >= this.minLength; i--) { + subSeq = str.subSequence(pos, pos + i); + result = lookupMap.get(subSeq.toString()); + if(null != result) { + out.append(result); + return i; + } + } + } + return 0; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/replacer/ReplacerChain.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/replacer/ReplacerChain.java new file mode 100644 index 0000000..483f0e4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/replacer/ReplacerChain.java @@ -0,0 +1,56 @@ +package aiyh.utils.tool.cn.hutool.core.text.replacer; + +import aiyh.utils.tool.cn.hutool.core.lang.Chain; +import aiyh.utils.tool.cn.hutool.core.text.StrBuilder; + +import java.util.Iterator; +import java.util.LinkedList; +import java.util.List; + +/** + * 字符串替换链，用于组合多个字符串替换逻辑 + * + * @author looly + * @since 4.1.5 + */ +public class ReplacerChain extends StrReplacer implements Chain { + private static final long serialVersionUID = 1L; + + private final List replacers = new LinkedList<>(); + + /** + * 构造 + * + * @param strReplacers 字符串替换器 + */ + public ReplacerChain(StrReplacer... strReplacers) { + for (StrReplacer strReplacer : strReplacers) { + addChain(strReplacer); + } + } + + @SuppressWarnings("NullableProblems") + @Override + public Iterator iterator() { + return replacers.iterator(); + } + + @Override + public ReplacerChain addChain(StrReplacer element) { + replacers.add(element); + return this; + } + + @Override + protected int replace(CharSequence str, int pos, StrBuilder out) { + int consumed = 0; + for (StrReplacer strReplacer : replacers) { + consumed = strReplacer.replace(str, pos, out); + if (0 != consumed) { + return consumed; + } + } + return consumed; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/replacer/StrReplacer.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/replacer/StrReplacer.java new file mode 100755 index 0000000..b9752a4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/replacer/StrReplacer.java @@ -0,0 +1,45 @@ +package aiyh.utils.tool.cn.hutool.core.text.replacer; + +import aiyh.utils.tool.cn.hutool.core.lang.Replacer; +import aiyh.utils.tool.cn.hutool.core.text.StrBuilder; + +import java.io.Serializable; + +/** + * 抽象字符串替换类
+ * 通过实现replace方法实现局部替换逻辑 + * + * @author looly + * @since 4.1.5 + */ +public abstract class StrReplacer implements Replacer, Serializable { + private static final long serialVersionUID = 1L; + + /** + * 抽象的字符串替换方法，通过传入原字符串和当前位置，执行替换逻辑，返回处理或替换的字符串长度部分。 + * + * @param str 被处理的字符串 + * @param pos 当前位置 + * @param out 输出 + * @return 处理的原字符串长度，0表示跳过此字符 + */ + protected abstract int replace(CharSequence str, int pos, StrBuilder out); + + @Override + public CharSequence replace(CharSequence t) { + final int len = t.length(); + final StrBuilder builder = StrBuilder.create(len); + int pos = 0;//当前位置 + int consumed;//处理过的字符数 + while (pos < len) { + consumed = replace(t, pos, builder); + if (0 == consumed) { + //0表示未处理或替换任何字符，原样输出本字符并从下一个字符继续 + builder.append(t.charAt(pos)); + pos++; + } + pos += consumed; + } + return builder; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/replacer/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/replacer/package-info.java new file mode 100644 index 0000000..8738442 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/replacer/package-info.java @@ -0,0 +1,7 @@ +/** + * 文本替换类抽象及实现 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.text.replacer; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/text/split/SplitIter.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/split/SplitIter.java new file mode 100644 index 0000000..ec65a8c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/text/split/SplitIter.java @@ -0,0 +1,153 @@ +package aiyh.utils.tool.cn.hutool.core.text.split; + +import aiyh.utils.tool.cn.hutool.core.collection.ComputeIter; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.text.finder.TextFinder; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.List; +import java.util.function.Function; + +/** + * 字符串切分迭代器
+ * 此迭代器是字符串切分的懒模式实现，实例化后不完成切分，只有调用{@link #hasNext()}或遍历时才完成切分
+ * 此迭代器非线程安全 + * + * @author looly + * @since 5.7.14 + */ +public class SplitIter extends ComputeIter implements Serializable { + private static final long serialVersionUID = 1L; + + private final String text; + private final TextFinder finder; + private final int limit; + private final boolean ignoreEmpty; + + /** + * 上一次的结束位置 + */ + private int offset; + /** + * 计数器，用于判断是否超过limit + */ + private int count; + + /** + * 构造 + * + * @param text 文本，不能为{@code null} + * @param separatorFinder 分隔符匹配器 + * @param limit 限制数量，小于等于0表示无限制 + * @param ignoreEmpty 是否忽略"" + */ + public SplitIter(CharSequence text, TextFinder separatorFinder, int limit, boolean ignoreEmpty) { + Assert.notNull(text, "Text must be not null!"); + this.text = text.toString(); + this.finder = separatorFinder.setText(text); + this.limit = limit > 0 ? limit : Integer.MAX_VALUE; + this.ignoreEmpty = ignoreEmpty; + } + + @Override + protected String computeNext() { + // 达到数量上限或末尾，结束 + if (count >= limit || offset > text.length()) { + return null; + } + + // 达到数量上限 + if (count == (limit - 1)) { + // 当到达限制次数时，最后一个元素为剩余部分 + if (ignoreEmpty && offset == text.length()) { + // 最后一个是空串 + return null; + } + + // 结尾整个作为一个元素 + count++; + return text.substring(offset); + } + + final int start = finder.start(offset); + // 无分隔符，结束 + if (start < 0) { + // 如果不再有分隔符，但是遗留了字符，则单独作为一个段 + if (offset <= text.length()) { + final String result = text.substring(offset); + if (false == ignoreEmpty || false == result.isEmpty()) { + // 返回非空串 + offset = Integer.MAX_VALUE; + return result; + } + } + return null; + } + + // 找到新的分隔符位置 + final String result = text.substring(offset, start); + offset = finder.end(start); + + if (ignoreEmpty && result.isEmpty()) { + // 发现空串且需要忽略时，跳过之 + return computeNext(); + } + + count++; + return result; + } + + /** + * 重置 + */ + public void reset() { + this.finder.reset(); + this.offset = 0; + this.count = 0; + } + + /** + * 获取切分后的对象数组 + * + * @param trim 是否去除元素两边空格 + * @return 切分后的列表 + */ + public String[] toArray(boolean trim) { + return toList(trim).toArray(new String[0]); + } + + /** + * 获取切分后的对象列表 + * + * @param trim 是否去除元素两边空格 + * @return 切分后的列表 + */ + public List toList(boolean trim) { + return toList((str) -> trim ? StrUtil.trim(str) : str); + } + + /** + * 获取切分后的对象列表 + * + * @param 元素类型 + * @param mapping 字符串映射函数 + * @return 切分后的列表 + */ + public List toList(Function mapping) { + final List result = new ArrayList<>(); + while (this.hasNext()) { + final T apply = mapping.apply(this.next()); + if (ignoreEmpty && StrUtil.isEmptyIfStr(apply)) { + // 对于mapping之后依旧是String的情况，ignoreEmpty依旧有效 + continue; + } + result.add(apply); + } + if (result.isEmpty()) { + return new ArrayList<>(0); + } + return result; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/AsyncUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/AsyncUtil.java new file mode 100644 index 0000000..2ad3443 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/AsyncUtil.java @@ -0,0 +1,63 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import java.lang.reflect.UndeclaredThrowableException; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; + +/** + * {@link CompletableFuture}异步工具类
+ * {@link CompletableFuture} 是 Future 的改进，可以通过传入回调对象，在任务完成后调用之 + * + * @author achao1441470436@gmail.com + * @since 5.7.17 + */ +public class AsyncUtil { + + /** + * 等待所有任务执行完毕，包裹了异常 + * + * @param tasks 并行任务 + * @throws UndeclaredThrowableException 未受检异常 + */ + public static void waitAll(CompletableFuture... tasks) { + try { + CompletableFuture.allOf(tasks).get(); + } catch (InterruptedException | ExecutionException e) { + throw new ThreadException(e); + } + } + + /** + * 等待任意一个任务执行完毕，包裹了异常 + * + * @param 任务返回值类型 + * @param tasks 并行任务 + * @return 执行结束的任务返回值 + * @throws UndeclaredThrowableException 未受检异常 + */ + @SuppressWarnings("unchecked") + public static T waitAny(CompletableFuture... tasks) { + try { + return (T) CompletableFuture.anyOf(tasks).get(); + } catch (InterruptedException | ExecutionException e) { + throw new ThreadException(e); + } + } + + /** + * 获取异步任务结果，包裹了异常 + * + * @param 任务返回值类型 + * @param task 异步任务 + * @return 任务返回值 + * @throws RuntimeException 未受检异常 + */ + public static T get(CompletableFuture task) { + try { + return task.get(); + } catch (InterruptedException | ExecutionException e) { + throw new ThreadException(e); + } + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/BlockPolicy.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/BlockPolicy.java new file mode 100755 index 0000000..191d377 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/BlockPolicy.java @@ -0,0 +1,56 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import java.util.concurrent.RejectedExecutionException; +import java.util.concurrent.RejectedExecutionHandler; +import java.util.concurrent.ThreadPoolExecutor; +import java.util.function.Consumer; + +/** + * 当任务队列过长时处于阻塞状态，直到添加到队列中 + * 如果阻塞过程中被中断，就会抛出{@link InterruptedException}异常
+ * 有时候在线程池内访问第三方接口，只希望固定并发数去访问，并且不希望丢弃任务时使用此策略，队列满的时候会处于阻塞状态(例如刷库的场景) + * + * @author luozongle + * @since 5.8.0 + */ +public class BlockPolicy implements RejectedExecutionHandler { + + /** + * 线程池关闭时，为避免任务丢失，留下处理方法 + * 如果需要由调用方来运行，可以{@code new BlockPolicy(Runnable::run)} + */ + private final Consumer handlerwhenshutdown; + + /** + * 构造 + * + * @param handlerwhenshutdown 线程池关闭后的执行策略 + */ + public BlockPolicy(final Consumer handlerwhenshutdown) { + this.handlerwhenshutdown = handlerwhenshutdown; + } + + /** + * 构造 + */ + public BlockPolicy() { + this(null); + } + + @Override + public void rejectedExecution(Runnable r, ThreadPoolExecutor e) { + // 线程池未关闭时，阻塞等待 + if (false == e.isShutdown()) { + try { + e.getQueue().put(r); + } catch (InterruptedException ex) { + throw new RejectedExecutionException("Task " + r + " rejected from " + e); + } + } else if (null != handlerwhenshutdown) { + // 当设置了关闭时候的处理 + handlerwhenshutdown.accept(r); + } + + // 线程池关闭后，丢弃任务 + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ConcurrencyTester.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ConcurrencyTester.java new file mode 100644 index 0000000..15ca418 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ConcurrencyTester.java @@ -0,0 +1,89 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import aiyh.utils.tool.cn.hutool.core.date.TimeInterval; + +import java.io.Closeable; +import java.io.IOException; + +/** + * 高并发测试工具类 + * + * 
+ * ps:
+ * //模拟1000个线程并发
+ * ConcurrencyTester ct = new ConcurrencyTester(1000);
+ * ct.test(() -> {
+ *      // 需要并发测试的业务代码
+ * });
+ *
+ * Console.log(ct.getInterval());
+ * ct.close();
+ *
+ * + * @author kwer + */ +public class ConcurrencyTester implements Closeable { + private final SyncFinisher sf; + private final TimeInterval timeInterval; + private long interval; + + /** + * 构造 + * @param threadSize 线程数 + */ + public ConcurrencyTester(int threadSize) { + this.sf = new SyncFinisher(threadSize); + this.timeInterval = new TimeInterval(); + } + + /** + * 执行测试
+ * 执行测试后不会关闭线程池，可以调用{@link #close()}释放线程池 + * + * @param runnable 要测试的内容 + * @return this + */ + public ConcurrencyTester test(Runnable runnable) { + this.sf.clearWorker(); + + timeInterval.start(); + this.sf + .addRepeatWorker(runnable) + .setBeginAtSameTime(true) + .start(); + + this.interval = timeInterval.interval(); + return this; + } + + /** + * 重置测试器，重置包括： + * + *
    + *
  • 清空worker
    • + *
  • 重置计时器
    • + *
+ * + * @return this + * @since 5.7.2 + */ + public ConcurrencyTester reset(){ + this.sf.clearWorker(); + this.timeInterval.restart(); + return this; + } + + /** + * 获取执行时间 + * + * @return 执行时间，单位毫秒 + */ + public long getInterval() { + return this.interval; + } + + @Override + public void close() throws IOException { + this.sf.close(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/DelegatedExecutorService.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/DelegatedExecutorService.java new file mode 100644 index 0000000..8732384 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/DelegatedExecutorService.java @@ -0,0 +1,100 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; + +import java.util.Collection; +import java.util.List; +import java.util.concurrent.AbstractExecutorService; +import java.util.concurrent.Callable; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; + +/** + * ExecutorService代理 + * + * @author loolly + */ +public class DelegatedExecutorService extends AbstractExecutorService { + private final ExecutorService e; + + /** + * 构造 + * + * @param executor {@link ExecutorService} + */ + DelegatedExecutorService(ExecutorService executor) { + Assert.notNull(executor, "executor must be not null !"); + e = executor; + } + + @Override + public void execute(Runnable command) { + e.execute(command); + } + + @Override + public void shutdown() { + e.shutdown(); + } + + @Override + public List shutdownNow() { + return e.shutdownNow(); + } + + @Override + public boolean isShutdown() { + return e.isShutdown(); + } + + @Override + public boolean isTerminated() { + return e.isTerminated(); + } + + @Override + public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException { + return e.awaitTermination(timeout, unit); + } + + @Override + public Future submit(Runnable task) { + return e.submit(task); + } + + @Override + public Future submit(Callable task) { + return e.submit(task); + } + + @Override + public Future submit(Runnable task, T result) { + return e.submit(task, result); + } + + @Override + public List> invokeAll(Collection> tasks) throws InterruptedException { + return e.invokeAll(tasks); + } + + @Override + public List> invokeAll(Collection> tasks, long timeout, TimeUnit unit) + throws InterruptedException { + return e.invokeAll(tasks, timeout, unit); + } + + @Override + public T invokeAny(Collection> tasks) + throws InterruptedException, ExecutionException { + return e.invokeAny(tasks); + } + + @Override + public T invokeAny(Collection> tasks, long timeout, TimeUnit unit) + throws InterruptedException, ExecutionException, TimeoutException { + return e.invokeAny(tasks, timeout, unit); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ExecutorBuilder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ExecutorBuilder.java new file mode 100644 index 0000000..9d16c2e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ExecutorBuilder.java @@ -0,0 +1,260 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import aiyh.utils.tool.cn.hutool.core.builder.Builder; +import aiyh.utils.tool.cn.hutool.core.util.ObjectUtil; + +import java.util.concurrent.ArrayBlockingQueue; +import java.util.concurrent.BlockingQueue; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.LinkedBlockingQueue; +import java.util.concurrent.RejectedExecutionHandler; +import java.util.concurrent.SynchronousQueue; +import java.util.concurrent.ThreadFactory; +import java.util.concurrent.ThreadPoolExecutor; +import java.util.concurrent.TimeUnit; + +/** + * {@link ThreadPoolExecutor} 建造者 + * + * 
+ *     1. 如果池中任务数 < corePoolSize     -》 放入立即执行
+ *     2. 如果池中任务数 > corePoolSize     -》 放入队列等待
+ *     3. 队列满                              -》 新建线程立即执行
+ *     4. 执行中的线程 > maxPoolSize        -》 触发handler（RejectedExecutionHandler）异常
+ *
+ * + * @author looly + * @since 4.1.9 + */ +public class ExecutorBuilder implements Builder { + private static final long serialVersionUID = 1L; + + /** 默认的等待队列容量 */ + public static final int DEFAULT_QUEUE_CAPACITY = 1024; + + /** + * 初始池大小 + */ + private int corePoolSize; + /** + * 最大池大小（允许同时执行的最大线程数） + */ + private int maxPoolSize = Integer.MAX_VALUE; + /** + * 线程存活时间，即当池中线程多于初始大小时，多出的线程保留的时长 + */ + private long keepAliveTime = TimeUnit.SECONDS.toNanos(60); + /** + * 队列，用于存放未执行的线程 + */ + private BlockingQueue workQueue; + /** + * 线程工厂，用于自定义线程创建 + */ + private ThreadFactory threadFactory; + /** + * 当线程阻塞（block）时的异常处理器，所谓线程阻塞即线程池和等待队列已满，无法处理线程时采取的策略 + */ + private RejectedExecutionHandler handler; + /** + * 线程执行超时后是否回收线程 + */ + private Boolean allowCoreThreadTimeOut; + + /** + * 设置初始池大小，默认0 + * + * @param corePoolSize 初始池大小 + * @return this + */ + public ExecutorBuilder setCorePoolSize(int corePoolSize) { + this.corePoolSize = corePoolSize; + return this; + } + + /** + * 设置最大池大小（允许同时执行的最大线程数） + * + * @param maxPoolSize 最大池大小（允许同时执行的最大线程数） + * @return this + */ + public ExecutorBuilder setMaxPoolSize(int maxPoolSize) { + this.maxPoolSize = maxPoolSize; + return this; + } + + /** + * 设置线程存活时间，即当池中线程多于初始大小时，多出的线程保留的时长 + * + * @param keepAliveTime 线程存活时间 + * @param unit 单位 + * @return this + */ + public ExecutorBuilder setKeepAliveTime(long keepAliveTime, TimeUnit unit) { + return setKeepAliveTime(unit.toNanos(keepAliveTime)); + } + + /** + * 设置线程存活时间，即当池中线程多于初始大小时，多出的线程保留的时长，单位纳秒 + * + * @param keepAliveTime 线程存活时间，单位纳秒 + * @return this + */ + public ExecutorBuilder setKeepAliveTime(long keepAliveTime) { + this.keepAliveTime = keepAliveTime; + return this; + } + + /** + * 设置队列，用于存在未执行的线程
+ * 可选队列有： + * + * 
+	 * 1. {@link SynchronousQueue}    它将任务直接提交给线程而不保持它们。当运行线程小于maxPoolSize时会创建新线程，否则触发异常策略
+	 * 2. {@link LinkedBlockingQueue} 默认无界队列，当运行线程大于corePoolSize时始终放入此队列，此时maxPoolSize无效。
+	 *                        当构造LinkedBlockingQueue对象时传入参数，变为有界队列，队列满时，运行线程小于maxPoolSize时会创建新线程，否则触发异常策略
+	 * 3. {@link ArrayBlockingQueue}  有界队列，相对无界队列有利于控制队列大小，队列满时，运行线程小于maxPoolSize时会创建新线程，否则触发异常策略
+	 *
+ * + * @param workQueue 队列 + * @return this + */ + public ExecutorBuilder setWorkQueue(BlockingQueue workQueue) { + this.workQueue = workQueue; + return this; + } + + /** + * 使用{@link ArrayBlockingQueue} 做为等待队列
+ * 有界队列，相对无界队列有利于控制队列大小，队列满时，运行线程小于maxPoolSize时会创建新线程，否则触发异常策略 + * + * @param capacity 队列容量 + * @return this + * @since 5.1.4 + */ + public ExecutorBuilder useArrayBlockingQueue(int capacity) { + return setWorkQueue(new ArrayBlockingQueue<>(capacity)); + } + + /** + * 使用{@link SynchronousQueue} 做为等待队列（非公平策略）
+ * 它将任务直接提交给线程而不保持它们。当运行线程小于maxPoolSize时会创建新线程，否则触发异常策略 + * + * @return this + * @since 4.1.11 + */ + public ExecutorBuilder useSynchronousQueue() { + return useSynchronousQueue(false); + } + + /** + * 使用{@link SynchronousQueue} 做为等待队列
+ * 它将任务直接提交给线程而不保持它们。当运行线程小于maxPoolSize时会创建新线程，否则触发异常策略 + * + * @param fair 是否使用公平访问策略 + * @return this + * @since 4.5.0 + */ + public ExecutorBuilder useSynchronousQueue(boolean fair) { + return setWorkQueue(new SynchronousQueue<>(fair)); + } + + /** + * 设置线程工厂，用于自定义线程创建 + * + * @param threadFactory 线程工厂 + * @return this + * @see ThreadFactoryBuilder + */ + public ExecutorBuilder setThreadFactory(ThreadFactory threadFactory) { + this.threadFactory = threadFactory; + return this; + } + + /** + * 设置当线程阻塞（block）时的异常处理器，所谓线程阻塞即线程池和等待队列已满，无法处理线程时采取的策略 + *

+ * 此处可以使用JDK预定义的几种策略，见{@link RejectPolicy}枚举 + * + * @param handler {@link RejectedExecutionHandler} + * @return this + * @see RejectPolicy + */ + public ExecutorBuilder setHandler(RejectedExecutionHandler handler) { + this.handler = handler; + return this; + } + + /** + * 设置线程执行超时后是否回收线程 + * + * @param allowCoreThreadTimeOut 线程执行超时后是否回收线程 + * @return this + */ + public ExecutorBuilder setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut) { + this.allowCoreThreadTimeOut = allowCoreThreadTimeOut; + return this; + } + + /** + * 创建ExecutorBuilder，开始构建 + * + * @return this + */ + public static ExecutorBuilder create() { + return new ExecutorBuilder(); + } + + /** + * 构建ThreadPoolExecutor + */ + @Override + public ThreadPoolExecutor build() { + return build(this); + } + + /** + * 创建有回收关闭功能的ExecutorService + * + * @return 创建有回收关闭功能的ExecutorService + * @since 5.1.4 + */ + public ExecutorService buildFinalizable() { + return new FinalizableDelegatedExecutorService(build()); + } + + /** + * 构建ThreadPoolExecutor + * + * @param builder this + * @return {@link ThreadPoolExecutor} + */ + private static ThreadPoolExecutor build(ExecutorBuilder builder) { + final int corePoolSize = builder.corePoolSize; + final int maxPoolSize = builder.maxPoolSize; + final long keepAliveTime = builder.keepAliveTime; + final BlockingQueue workQueue; + if (null != builder.workQueue) { + workQueue = builder.workQueue; + } else { + // corePoolSize为0则要使用SynchronousQueue避免无限阻塞 + workQueue = (corePoolSize <= 0) ? new SynchronousQueue<>() : new LinkedBlockingQueue<>(DEFAULT_QUEUE_CAPACITY); + } + final ThreadFactory threadFactory = (null != builder.threadFactory) ? builder.threadFactory : Executors.defaultThreadFactory(); + RejectedExecutionHandler handler = ObjectUtil.defaultIfNull(builder.handler, RejectPolicy.ABORT.getValue()); + + final ThreadPoolExecutor threadPoolExecutor = new ThreadPoolExecutor(// + corePoolSize, // + maxPoolSize, // + keepAliveTime, TimeUnit.NANOSECONDS, // + workQueue, // + threadFactory, // + handler// + ); + if (null != builder.allowCoreThreadTimeOut) { + threadPoolExecutor.allowCoreThreadTimeOut(builder.allowCoreThreadTimeOut); + } + return threadPoolExecutor; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/FinalizableDelegatedExecutorService.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/FinalizableDelegatedExecutorService.java new file mode 100644 index 0000000..0ea9f71 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/FinalizableDelegatedExecutorService.java @@ -0,0 +1,25 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import java.util.concurrent.ExecutorService; + +/** + * 保证ExecutorService在对象回收时正常结束 + * + * @author loolly + */ +public class FinalizableDelegatedExecutorService extends DelegatedExecutorService { + + /** + * 构造 + * + * @param executor {@link ExecutorService} + */ + FinalizableDelegatedExecutorService(ExecutorService executor) { + super(executor); + } + + @Override + protected void finalize() { + super.shutdown(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/GlobalThreadPool.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/GlobalThreadPool.java new file mode 100644 index 0000000..3b42a0c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/GlobalThreadPool.java @@ -0,0 +1,96 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import java.util.concurrent.Callable; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Future; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; + +/** + * 全局公共线程池
+ * 此线程池是一个无限线程池，即加入的线程不等待任何线程，直接执行 + * + * @author Looly + * + */ +public class GlobalThreadPool { + private static ExecutorService executor; + + private GlobalThreadPool() { + } + + static { + init(); + } + + /** + * 初始化全局线程池 + */ + synchronized public static void init() { + if (null != executor) { + executor.shutdownNow(); + } + executor = ExecutorBuilder.create().useSynchronousQueue().build(); + } + + /** + * 关闭公共线程池 + * + * @param isNow 是否立即关闭而不等待正在执行的线程 + */ + synchronized public static void shutdown(boolean isNow) { + if (null != executor) { + if (isNow) { + executor.shutdownNow(); + } else { + executor.shutdown(); + } + } + } + + /** + * 获得 {@link ExecutorService} + * + * @return {@link ExecutorService} + */ + public static ExecutorService getExecutor() { + return executor; + } + + /** + * 直接在公共线程池中执行线程 + * + * @param runnable 可运行对象 + */ + public static void execute(Runnable runnable) { + try { + executor.execute(runnable); + } catch (Exception e) { + throw new UtilException(e, "Exception when running task!"); + } + } + + /** + * 执行有返回值的异步方法
+ * Future代表一个异步执行的操作，通过get()方法可以获得操作的结果，如果异步操作还没有完成，则，get()会使当前线程阻塞 + * + * @param 执行的Task + * @param task {@link Callable} + * @return Future + */ + public static Future submit(Callable task) { + return executor.submit(task); + } + + /** + * 执行有返回值的异步方法
+ * Future代表一个异步执行的操作，通过get()方法可以获得操作的结果，如果异步操作还没有完成，则，get()会使当前线程阻塞 + * + * @param runnable 可运行对象 + * @return {@link Future} + * @since 3.0.5 + */ + public static Future submit(Runnable runnable) { + return executor.submit(runnable); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/NamedThreadFactory.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/NamedThreadFactory.java new file mode 100644 index 0000000..210f319 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/NamedThreadFactory.java @@ -0,0 +1,98 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import java.lang.Thread.UncaughtExceptionHandler; +import java.util.concurrent.ThreadFactory; +import java.util.concurrent.atomic.AtomicInteger; + +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 线程创建工厂类，此工厂可选配置： + * + * 

+ * 1. 自定义线程命名前缀
+ * 2. 自定义是否守护线程
+ *
+ * + * @author looly + * @since 4.0.0 + */ +public class NamedThreadFactory implements ThreadFactory { + + /** 命名前缀 */ + private final String prefix; + /** 线程组 */ + private final ThreadGroup group; + /** 线程组 */ + private final AtomicInteger threadNumber = new AtomicInteger(1); + /** 是否守护线程 */ + private final boolean isDaemon; + /** 无法捕获的异常统一处理 */ + private final UncaughtExceptionHandler handler; + + /** + * 构造 + * + * @param prefix 线程名前缀 + * @param isDaemon 是否守护线程 + */ + public NamedThreadFactory(String prefix, boolean isDaemon) { + this(prefix, null, isDaemon); + } + + /** + * 构造 + * + * @param prefix 线程名前缀 + * @param threadGroup 线程组，可以为null + * @param isDaemon 是否守护线程 + */ + public NamedThreadFactory(String prefix, ThreadGroup threadGroup, boolean isDaemon) { + this(prefix, threadGroup, isDaemon, null); + } + + /** + * 构造 + * + * @param prefix 线程名前缀 + * @param threadGroup 线程组，可以为null + * @param isDaemon 是否守护线程 + * @param handler 未捕获异常处理 + */ + public NamedThreadFactory(String prefix, ThreadGroup threadGroup, boolean isDaemon, UncaughtExceptionHandler handler) { + this.prefix = StrUtil.isBlank(prefix) ? "Hutool" : prefix; + if (null == threadGroup) { + threadGroup = ThreadUtil.currentThreadGroup(); + } + this.group = threadGroup; + this.isDaemon = isDaemon; + this.handler = handler; + } + + @Override + public Thread newThread(Runnable r) { + final Thread t = new Thread(this.group, r, StrUtil.format("{}{}", prefix, threadNumber.getAndIncrement())); + + //守护线程 + if (false == t.isDaemon()) { + if (isDaemon) { + // 原线程为非守护则设置为守护 + t.setDaemon(true); + } + } else if (false == isDaemon) { + // 原线程为守护则还原为非守护 + t.setDaemon(false); + } + //异常处理 + if(null != this.handler) { + t.setUncaughtExceptionHandler(handler); + } + //优先级 + if (Thread.NORM_PRIORITY != t.getPriority()) { + // 标准优先级 + t.setPriority(Thread.NORM_PRIORITY); + } + return t; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/RejectPolicy.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/RejectPolicy.java new file mode 100644 index 0000000..4935d9f --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/RejectPolicy.java @@ -0,0 +1,42 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import java.util.concurrent.RejectedExecutionHandler; +import java.util.concurrent.ThreadPoolExecutor; + +/** + * 线程拒绝策略枚举 + * + *

+ * 如果设置了maxSize, 当总线程数达到上限, 会调用RejectedExecutionHandler进行处理，此枚举为JDK预定义的几种策略枚举表示 + * + * @author looly + * @since 4.1.13 + */ +public enum RejectPolicy { + + /** 处理程序遭到拒绝将抛出RejectedExecutionException */ + ABORT(new ThreadPoolExecutor.AbortPolicy()), + /** 放弃当前任务 */ + DISCARD(new ThreadPoolExecutor.DiscardPolicy()), + /** 如果执行程序尚未关闭，则位于工作队列头部的任务将被删除，然后重试执行程序（如果再次失败，则重复此过程） */ + DISCARD_OLDEST(new ThreadPoolExecutor.DiscardOldestPolicy()), + /** 由主线程来直接执行 */ + CALLER_RUNS(new ThreadPoolExecutor.CallerRunsPolicy()), + /** 当任务队列过长时处于阻塞状态，直到添加到队列中，固定并发数去访问，并且不希望丢弃任务时使用此策略 */ + BLOCK(new BlockPolicy()); + + private final RejectedExecutionHandler value; + + RejectPolicy(RejectedExecutionHandler handler) { + this.value = handler; + } + + /** + * 获取RejectedExecutionHandler枚举值 + * + * @return RejectedExecutionHandler + */ + public RejectedExecutionHandler getValue() { + return this.value; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/SemaphoreRunnable.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/SemaphoreRunnable.java new file mode 100644 index 0000000..410e919 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/SemaphoreRunnable.java @@ -0,0 +1,59 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import java.util.concurrent.Semaphore; + +/** + * 带有信号量控制的{@link Runnable} 接口抽象实现 + * + *

+ * 通过设置信号量，可以限制可以访问某些资源（物理或逻辑的）线程数目。
+ * 例如：设置信号量为2，表示最多有两个线程可以同时执行方法逻辑，其余线程等待，直到此线程逻辑执行完毕 + *

+ * + * @author looly + * @since 4.4.5 + */ +public class SemaphoreRunnable implements Runnable { + + /** 实际执行的逻辑 */ + private final Runnable runnable; + /** 信号量 */ + private final Semaphore semaphore; + + /** + * 构造 + * + * @param runnable 实际执行的线程逻辑 + * @param semaphore 信号量，多个线程必须共享同一信号量 + */ + public SemaphoreRunnable(Runnable runnable, Semaphore semaphore) { + this.runnable = runnable; + this.semaphore = semaphore; + } + + /** + * 获得信号量 + * + * @return {@link Semaphore} + * @since 5.3.6 + */ + public Semaphore getSemaphore(){ + return this.semaphore; + } + + @Override + public void run() { + if (null != this.semaphore) { + try{ + semaphore.acquire(); + try { + this.runnable.run(); + } finally { + semaphore.release(); + } + }catch (InterruptedException e) { + Thread.currentThread().interrupt(); + } + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/SyncFinisher.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/SyncFinisher.java new file mode 100644 index 0000000..2681ff4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/SyncFinisher.java @@ -0,0 +1,232 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; + +import java.io.Closeable; +import java.io.IOException; +import java.util.LinkedHashSet; +import java.util.Set; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutorService; + +/** + * 线程同步结束器
+ * 在完成一组正在其他线程中执行的操作之前，它允许一个或多个线程一直等待。 + * + * 
+ * ps:
+ * //模拟1000个线程并发
+ * SyncFinisher sf = new SyncFinisher(1000);
+ * sf.addWorker(() -> {
+ *      // 需要并发测试的业务代码
+ * });
+ * sf.start()
+ *
+ * + * @author Looly + * @since 4.1.15 + */ +public class SyncFinisher implements Closeable { + + private final Set workers; + private final int threadSize; + private ExecutorService executorService; + + private boolean isBeginAtSameTime; + /** + * 启动同步器，用于保证所有worker线程同时开始 + */ + private final CountDownLatch beginLatch; + /** + * 结束同步器，用于等待所有worker线程同时结束 + */ + private CountDownLatch endLatch; + + /** + * 构造 + * + * @param threadSize 线程数 + */ + public SyncFinisher(int threadSize) { + this.beginLatch = new CountDownLatch(1); + this.threadSize = threadSize; + this.workers = new LinkedHashSet<>(); + } + + /** + * 设置是否所有worker线程同时开始 + * + * @param isBeginAtSameTime 是否所有worker线程同时开始 + * @return this + */ + public SyncFinisher setBeginAtSameTime(boolean isBeginAtSameTime) { + this.isBeginAtSameTime = isBeginAtSameTime; + return this; + } + + /** + * 增加定义的线程数同等数量的worker + * + * @param runnable 工作线程 + * @return this + */ + public SyncFinisher addRepeatWorker(final Runnable runnable) { + for (int i = 0; i < this.threadSize; i++) { + addWorker(new Worker() { + @Override + public void work() { + runnable.run(); + } + }); + } + return this; + } + + /** + * 增加工作线程 + * + * @param runnable 工作线程 + * @return this + */ + public SyncFinisher addWorker(final Runnable runnable) { + return addWorker(new Worker() { + @Override + public void work() { + runnable.run(); + } + }); + } + + /** + * 增加工作线程 + * + * @param worker 工作线程 + * @return this + */ + synchronized public SyncFinisher addWorker(Worker worker) { + workers.add(worker); + return this; + } + + /** + * 开始工作
+ * 执行此方法后如果不再重复使用此对象，需调用{@link #stop()}关闭回收资源。 + */ + public void start() { + start(true); + } + + /** + * 开始工作
+ * 执行此方法后如果不再重复使用此对象，需调用{@link #stop()}关闭回收资源。 + * + * @param sync 是否阻塞等待 + * @since 4.5.8 + */ + public void start(boolean sync) { + endLatch = new CountDownLatch(workers.size()); + + if (null == this.executorService || this.executorService.isShutdown()) { + this.executorService = ThreadUtil.newExecutor(threadSize); + } + for (Worker worker : workers) { + executorService.submit(worker); + } + // 保证所有worker同时开始 + this.beginLatch.countDown(); + + if (sync) { + try { + this.endLatch.await(); + } catch (InterruptedException e) { + throw new UtilException(e); + } + } + } + + /** + * 结束线程池。此方法执行两种情况： + *
    + *
  1. 执行start(true)后，调用此方法结束线程池回收资源
    2. + *
  2. 执行start(false)后，用户自行判断结束点执行此方法
    3. + *
+ * + * @since 5.6.6 + */ + public void stop() { + if (null != this.executorService) { + this.executorService.shutdown(); + this.executorService = null; + } + + clearWorker(); + } + + /** + * 立即结束线程池所有线程。此方法执行两种情况： + *
    + *
  1. 执行start(true)后，调用此方法结束线程池回收资源
    2. + *
  2. 执行start(false)后，用户自行判断结束点执行此方法
    3. + *
+ * + * @since 5.8.11 + */ + public void stopNow() { + if (null != this.executorService) { + this.executorService.shutdownNow(); + this.executorService = null; + } + + clearWorker(); + } + + /** + * 清空工作线程对象 + */ + public void clearWorker() { + workers.clear(); + } + + /** + * 剩余任务数 + * + * @return 剩余任务数 + */ + public long count() { + return endLatch.getCount(); + } + + @Override + public void close() throws IOException { + stop(); + } + + /** + * 工作者，为一个线程 + * + * @author xiaoleilu + */ + public abstract class Worker implements Runnable { + + @Override + public void run() { + if (isBeginAtSameTime) { + try { + beginLatch.await(); + } catch (InterruptedException e) { + throw new UtilException(e); + } + } + try { + work(); + } finally { + endLatch.countDown(); + } + } + + /** + * 任务内容 + */ + public abstract void work(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ThreadException.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ThreadException.java new file mode 100644 index 0000000..55d2b6e --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ThreadException.java @@ -0,0 +1,38 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import aiyh.utils.tool.cn.hutool.core.exceptions.ExceptionUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +/** + * 工具类异常 + * + * @author looly + * @since 5.7.17 + */ +public class ThreadException extends RuntimeException { + private static final long serialVersionUID = 5253124428623713216L; + + public ThreadException(Throwable e) { + super(ExceptionUtil.getMessage(e), e); + } + + public ThreadException(String message) { + super(message); + } + + public ThreadException(String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params)); + } + + public ThreadException(String message, Throwable throwable) { + super(message, throwable); + } + + public ThreadException(String message, Throwable throwable, boolean enableSuppression, boolean writableStackTrace) { + super(message, throwable, enableSuppression, writableStackTrace); + } + + public ThreadException(Throwable throwable, String messageTemplate, Object... params) { + super(StrUtil.format(messageTemplate, params), throwable); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ThreadFactoryBuilder.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ThreadFactoryBuilder.java new file mode 100644 index 0000000..51c1dee --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ThreadFactoryBuilder.java @@ -0,0 +1,157 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import aiyh.utils.tool.cn.hutool.core.builder.Builder; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; + +import java.lang.Thread.UncaughtExceptionHandler; +import java.util.concurrent.Executors; +import java.util.concurrent.ThreadFactory; +import java.util.concurrent.atomic.AtomicLong; + +/** + * ThreadFactory创建器
+ * 参考：Guava的ThreadFactoryBuilder + * + * @author looly + * @since 4.1.9 + */ +public class ThreadFactoryBuilder implements Builder { + private static final long serialVersionUID = 1L; + + /** + * 用于线程创建的线程工厂类 + */ + private ThreadFactory backingThreadFactory; + /** + * 线程名的前缀 + */ + private String namePrefix; + /** + * 是否守护线程，默认false + */ + private Boolean daemon; + /** + * 线程优先级 + */ + private Integer priority; + /** + * 未捕获异常处理器 + */ + private UncaughtExceptionHandler uncaughtExceptionHandler; + + /** + * 创建{@code ThreadFactoryBuilder} + * + * @return {@code ThreadFactoryBuilder} + */ + public static ThreadFactoryBuilder create() { + return new ThreadFactoryBuilder(); + } + + /** + * 设置用于创建基础线程的线程工厂 + * + * @param backingThreadFactory 用于创建基础线程的线程工厂 + * @return this + */ + public ThreadFactoryBuilder setThreadFactory(ThreadFactory backingThreadFactory) { + this.backingThreadFactory = backingThreadFactory; + return this; + } + + /** + * 设置线程名前缀，例如设置前缀为hutool-thread-，则线程名为hutool-thread-1之类。 + * + * @param namePrefix 线程名前缀 + * @return this + */ + public ThreadFactoryBuilder setNamePrefix(String namePrefix) { + this.namePrefix = namePrefix; + return this; + } + + /** + * 设置是否守护线程 + * + * @param daemon 是否守护线程 + * @return this + */ + public ThreadFactoryBuilder setDaemon(boolean daemon) { + this.daemon = daemon; + return this; + } + + /** + * 设置线程优先级 + * + * @param priority 优先级 + * @return this + * @see Thread#MIN_PRIORITY + * @see Thread#NORM_PRIORITY + * @see Thread#MAX_PRIORITY + */ + public ThreadFactoryBuilder setPriority(int priority) { + if (priority < Thread.MIN_PRIORITY) { + throw new IllegalArgumentException(StrUtil.format("Thread priority ({}) must be >= {}", priority, Thread.MIN_PRIORITY)); + } + if (priority > Thread.MAX_PRIORITY) { + throw new IllegalArgumentException(StrUtil.format("Thread priority ({}) must be <= {}", priority, Thread.MAX_PRIORITY)); + } + this.priority = priority; + return this; + } + + /** + * 设置未捕获异常的处理方式 + * + * @param uncaughtExceptionHandler {@link UncaughtExceptionHandler} + * @return this + */ + public ThreadFactoryBuilder setUncaughtExceptionHandler(UncaughtExceptionHandler uncaughtExceptionHandler) { + this.uncaughtExceptionHandler = uncaughtExceptionHandler; + return this; + } + + /** + * 构建{@link ThreadFactory} + * + * @return {@link ThreadFactory} + */ + @Override + public ThreadFactory build() { + return build(this); + } + + /** + * 构建 + * + * @param builder {@code ThreadFactoryBuilder} + * @return {@link ThreadFactory} + */ + private static ThreadFactory build(ThreadFactoryBuilder builder) { + final ThreadFactory backingThreadFactory = (null != builder.backingThreadFactory)// + ? builder.backingThreadFactory // + : Executors.defaultThreadFactory(); + final String namePrefix = builder.namePrefix; + final Boolean daemon = builder.daemon; + final Integer priority = builder.priority; + final UncaughtExceptionHandler handler = builder.uncaughtExceptionHandler; + final AtomicLong count = (null == namePrefix) ? null : new AtomicLong(); + return r -> { + final Thread thread = backingThreadFactory.newThread(r); + if (null != namePrefix) { + thread.setName(namePrefix + count.getAndIncrement()); + } + if (null != daemon) { + thread.setDaemon(daemon); + } + if (null != priority) { + thread.setPriority(priority); + } + if (null != handler) { + thread.setUncaughtExceptionHandler(handler); + } + return thread; + }; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ThreadUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ThreadUtil.java new file mode 100644 index 0000000..8c99df1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/ThreadUtil.java @@ -0,0 +1,711 @@ +package aiyh.utils.tool.cn.hutool.core.thread; + +import aiyh.utils.tool.cn.hutool.core.util.RuntimeUtil; + +import java.lang.Thread.UncaughtExceptionHandler; +import java.util.concurrent.Callable; +import java.util.concurrent.CompletionService; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutorCompletionService; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Future; +import java.util.concurrent.LinkedBlockingQueue; +import java.util.concurrent.RejectedExecutionHandler; +import java.util.concurrent.ScheduledThreadPoolExecutor; +import java.util.concurrent.ThreadFactory; +import java.util.concurrent.ThreadPoolExecutor; +import java.util.concurrent.TimeUnit; +import java.util.function.Supplier; + +/** + * 线程池工具 + * + * @author luxiaolei + */ +public class ThreadUtil { + + /** + * 新建一个线程池，默认的策略如下： + * 
+	 *    1. 初始线程数为corePoolSize指定的大小
+	 *    2. 没有最大线程数限制
+	 *    3. 默认使用LinkedBlockingQueue，默认队列大小为1024
+	 *
+ * + * @param corePoolSize 同时执行的线程数大小 + * @return ExecutorService + */ + public static ExecutorService newExecutor(int corePoolSize) { + ExecutorBuilder builder = ExecutorBuilder.create(); + if (corePoolSize > 0) { + builder.setCorePoolSize(corePoolSize); + } + return builder.build(); + } + + /** + * 获得一个新的线程池，默认的策略如下： + * 
+	 *    1. 初始线程数为 0
+	 *    2. 最大线程数为Integer.MAX_VALUE
+	 *    3. 使用SynchronousQueue
+	 *    4. 任务直接提交给线程而不保持它们
+	 *
+ * + * @return ExecutorService + */ + public static ExecutorService newExecutor() { + return ExecutorBuilder.create().useSynchronousQueue().build(); + } + + /** + * 获得一个新的线程池，只有单个线程，策略如下： + * 
+	 *    1. 初始线程数为 1
+	 *    2. 最大线程数为 1
+	 *    3. 默认使用LinkedBlockingQueue，默认队列大小为1024
+	 *    4. 同时只允许一个线程工作，剩余放入队列等待，等待数超过1024报错
+	 *
+ * + * @return ExecutorService + */ + public static ExecutorService newSingleExecutor() { + return ExecutorBuilder.create()// + .setCorePoolSize(1)// + .setMaxPoolSize(1)// + .setKeepAliveTime(0)// + .buildFinalizable(); + } + + /** + * 获得一个新的线程池
+ * 如果maximumPoolSize >= corePoolSize，在没有新任务加入的情况下，多出的线程将最多保留60s + * + * @param corePoolSize 初始线程池大小 + * @param maximumPoolSize 最大线程池大小 + * @return {@link ThreadPoolExecutor} + */ + public static ThreadPoolExecutor newExecutor(int corePoolSize, int maximumPoolSize) { + return ExecutorBuilder.create() + .setCorePoolSize(corePoolSize) + .setMaxPoolSize(maximumPoolSize) + .build(); + } + + /** + * 获得一个新的线程池，并指定最大任务队列大小
+ * 如果maximumPoolSize >= corePoolSize，在没有新任务加入的情况下，多出的线程将最多保留60s + * + * @param corePoolSize 初始线程池大小 + * @param maximumPoolSize 最大线程池大小 + * @param maximumQueueSize 最大任务队列大小 + * @return {@link ThreadPoolExecutor} + * @since 5.4.1 + */ + public static ExecutorService newExecutor(int corePoolSize, int maximumPoolSize, int maximumQueueSize) { + return ExecutorBuilder.create() + .setCorePoolSize(corePoolSize) + .setMaxPoolSize(maximumPoolSize) + .setWorkQueue(new LinkedBlockingQueue<>(maximumQueueSize)) + .build(); + } + + /** + * 获得一个新的线程池
+ * 传入阻塞系数，线程池的大小计算公式为：CPU可用核心数 / (1 - 阻塞因子)
+ * Blocking Coefficient(阻塞系数) = 阻塞时间／（阻塞时间+使用CPU的时间）
+ * 计算密集型任务的阻塞系数为0，而IO密集型任务的阻塞系数则接近于1。 + *

+ * see: http://blog.csdn.net/partner4java/article/details/9417663 + * + * @param blockingCoefficient 阻塞系数，阻塞因子介于0~1之间的数，阻塞因子越大，线程池中的线程数越多。 + * @return {@link ThreadPoolExecutor} + * @since 3.0.6 + */ + public static ThreadPoolExecutor newExecutorByBlockingCoefficient(float blockingCoefficient) { + if (blockingCoefficient >= 1 || blockingCoefficient < 0) { + throw new IllegalArgumentException("[blockingCoefficient] must between 0 and 1, or equals 0."); + } + + // 最佳的线程数 = CPU可用核心数 / (1 - 阻塞系数) + int poolSize = (int) (RuntimeUtil.getProcessorCount() / (1 - blockingCoefficient)); + return ExecutorBuilder.create().setCorePoolSize(poolSize).setMaxPoolSize(poolSize).setKeepAliveTime(0L).build(); + } + + /** + * 获取一个新的线程池，默认的策略如下
+ * 

+	 *     1. 核心线程数与最大线程数为nThreads指定的大小
+	 *     2. 默认使用LinkedBlockingQueue，默认队列大小为1024
+	 *     3. 如果isBlocked为{code true}，当执行拒绝策略的时候会处于阻塞状态，直到能添加到队列中或者被{@link Thread#interrupt()}中断
+	 *
+ * + * @param nThreads 线程池大小 + * @param threadNamePrefix 线程名称前缀 + * @param isBlocked 是否使用{@link BlockPolicy}策略 + * @return ExecutorService + * @author luozongle + * @since 5.8.0 + */ + public static ExecutorService newFixedExecutor(int nThreads, String threadNamePrefix, boolean isBlocked) { + return newFixedExecutor(nThreads, 1024, threadNamePrefix, isBlocked); + } + + /** + * 获取一个新的线程池，默认的策略如下
+ * 
+	 *     1. 核心线程数与最大线程数为nThreads指定的大小
+	 *     2. 默认使用LinkedBlockingQueue
+	 *     3. 如果isBlocked为{code true}，当执行拒绝策略的时候会处于阻塞状态，直到能添加到队列中或者被{@link Thread#interrupt()}中断
+	 *
+ * + * @param nThreads 线程池大小 + * @param maximumQueueSize 队列大小 + * @param threadNamePrefix 线程名称前缀 + * @param isBlocked 是否使用{@link BlockPolicy}策略 + * @return ExecutorService + * @author luozongle + * @since 5.8.0 + */ + public static ExecutorService newFixedExecutor(int nThreads, int maximumQueueSize, String threadNamePrefix, boolean isBlocked) { + return newFixedExecutor(nThreads, maximumQueueSize, threadNamePrefix, + (isBlocked ? RejectPolicy.BLOCK : RejectPolicy.ABORT).getValue()); + } + + /** + * 获得一个新的线程池，默认策略如下
+ * 
+	 *     1. 核心线程数与最大线程数为nThreads指定的大小
+	 *     2. 默认使用LinkedBlockingQueue
+	 *
+ * + * @param nThreads 线程池大小 + * @param maximumQueueSize 队列大小 + * @param threadNamePrefix 线程名称前缀 + * @param handler 拒绝策略 + * @return ExecutorService + * @author luozongle + * @since 5.8.0 + */ + public static ExecutorService newFixedExecutor(int nThreads, + int maximumQueueSize, + String threadNamePrefix, + RejectedExecutionHandler handler) { + return ExecutorBuilder.create() + .setCorePoolSize(nThreads).setMaxPoolSize(nThreads) + .setWorkQueue(new LinkedBlockingQueue<>(maximumQueueSize)) + .setThreadFactory(createThreadFactory(threadNamePrefix)) + .setHandler(handler) + .build(); + } + + /** + * 直接在公共线程池中执行线程 + * + * @param runnable 可运行对象 + */ + public static void execute(Runnable runnable) { + GlobalThreadPool.execute(runnable); + } + + /** + * 执行异步方法 + * + * @param runnable 需要执行的方法体 + * @param isDaemon 是否守护线程。守护线程会在主线程结束后自动结束 + * @return 执行的方法体 + */ + public static Runnable execAsync(Runnable runnable, boolean isDaemon) { + Thread thread = new Thread(runnable); + thread.setDaemon(isDaemon); + thread.start(); + + return runnable; + } + + /** + * 执行有返回值的异步方法
+ * Future代表一个异步执行的操作，通过get()方法可以获得操作的结果，如果异步操作还没有完成，则，get()会使当前线程阻塞 + * + * @param 回调对象类型 + * @param task {@link Callable} + * @return Future + */ + public static Future execAsync(Callable task) { + return GlobalThreadPool.submit(task); + } + + /** + * 执行有返回值的异步方法
+ * Future代表一个异步执行的操作，通过get()方法可以获得操作的结果，如果异步操作还没有完成，则，get()会使当前线程阻塞 + * + * @param runnable 可运行对象 + * @return {@link Future} + * @since 3.0.5 + */ + public static Future execAsync(Runnable runnable) { + return GlobalThreadPool.submit(runnable); + } + + /** + * 新建一个CompletionService，调用其submit方法可以异步执行多个任务，最后调用take方法按照完成的顺序获得其结果。
+ * 若未完成，则会阻塞 + * + * @param 回调对象类型 + * @return CompletionService + */ + public static CompletionService newCompletionService() { + return new ExecutorCompletionService<>(GlobalThreadPool.getExecutor()); + } + + /** + * 新建一个CompletionService，调用其submit方法可以异步执行多个任务，最后调用take方法按照完成的顺序获得其结果。
+ * 若未完成，则会阻塞 + * + * @param 回调对象类型 + * @param executor 执行器 {@link ExecutorService} + * @return CompletionService + */ + public static CompletionService newCompletionService(ExecutorService executor) { + return new ExecutorCompletionService<>(executor); + } + + /** + * 新建一个CountDownLatch，一个同步辅助类，在完成一组正在其他线程中执行的操作之前，它允许一个或多个线程一直等待。 + * + * @param threadCount 线程数量 + * @return CountDownLatch + */ + public static CountDownLatch newCountDownLatch(int threadCount) { + return new CountDownLatch(threadCount); + } + + /** + * 创建新线程，非守护线程，正常优先级，线程组与当前线程的线程组一致 + * + * @param runnable {@link Runnable} + * @param name 线程名 + * @return {@link Thread} + * @since 3.1.2 + */ + public static Thread newThread(Runnable runnable, String name) { + final Thread t = newThread(runnable, name, false); + if (t.getPriority() != Thread.NORM_PRIORITY) { + t.setPriority(Thread.NORM_PRIORITY); + } + return t; + } + + /** + * 创建新线程 + * + * @param runnable {@link Runnable} + * @param name 线程名 + * @param isDaemon 是否守护线程 + * @return {@link Thread} + * @since 4.1.2 + */ + public static Thread newThread(Runnable runnable, String name, boolean isDaemon) { + final Thread t = new Thread(null, runnable, name); + t.setDaemon(isDaemon); + return t; + } + + /** + * 挂起当前线程 + * + * @param timeout 挂起的时长 + * @param timeUnit 时长单位 + * @return 被中断返回false，否则true + */ + public static boolean sleep(Number timeout, TimeUnit timeUnit) { + try { + timeUnit.sleep(timeout.longValue()); + } catch (InterruptedException e) { + return false; + } + return true; + } + + /** + * 挂起当前线程 + * + * @param millis 挂起的毫秒数 + * @return 被中断返回false，否则true + */ + public static boolean sleep(Number millis) { + if (millis == null) { + return true; + } + return sleep(millis.longValue()); + } + + /** + * 挂起当前线程 + * + * @param millis 挂起的毫秒数 + * @return 被中断返回false，否则true + * @since 5.3.2 + */ + public static boolean sleep(long millis) { + if (millis > 0) { + try { + Thread.sleep(millis); + } catch (InterruptedException e) { + return false; + } + } + return true; + } + + /** + * 考虑{@link Thread#sleep(long)}方法有可能时间不足给定毫秒数，此方法保证sleep时间不小于给定的毫秒数 + * + * @param millis 给定的sleep时间 + * @return 被中断返回false，否则true + * @see ThreadUtil#sleep(Number) + */ + public static boolean safeSleep(Number millis) { + if (millis == null) { + return true; + } + + return safeSleep(millis.longValue()); + } + + /** + * 考虑{@link Thread#sleep(long)}方法有可能时间不足给定毫秒数，此方法保证sleep时间不小于给定的毫秒数 + * + * @param millis 给定的sleep时间 + * @return 被中断返回false，否则true + * @see ThreadUtil#sleep(Number) + * @since 5.3.2 + */ + public static boolean safeSleep(long millis) { + long done = 0; + long before; + long spendTime; + while (done >= 0 && done < millis) { + before = System.currentTimeMillis(); + if (false == sleep(millis - done)) { + return false; + } + spendTime = System.currentTimeMillis() - before; + if (spendTime <= 0) { + // Sleep花费时间为0或者负数，说明系统时间被拨动 + break; + } + done += spendTime; + } + return true; + } + + /** + * @return 获得堆栈列表 + */ + public static StackTraceElement[] getStackTrace() { + return Thread.currentThread().getStackTrace(); + } + + /** + * 获得堆栈项 + * + * @param i 第几个堆栈项 + * @return 堆栈项 + */ + public static StackTraceElement getStackTraceElement(int i) { + StackTraceElement[] stackTrace = getStackTrace(); + if (i < 0) { + i += stackTrace.length; + } + return stackTrace[i]; + } + + /** + * 创建本地线程对象 + * + * @param 持有对象类型 + * @param isInheritable 是否为子线程提供从父线程那里继承的值 + * @return 本地线程 + */ + public static ThreadLocal createThreadLocal(boolean isInheritable) { + if (isInheritable) { + return new InheritableThreadLocal<>(); + } else { + return new ThreadLocal<>(); + } + } + + /** + * 创建本地线程对象 + * + * @param 持有对象类型 + * @param supplier 初始化线程对象函数 + * @return 本地线程 + * @see ThreadLocal#withInitial(Supplier) + * @since 5.6.7 + */ + public static ThreadLocal createThreadLocal(Supplier supplier) { + return ThreadLocal.withInitial(supplier); + } + + /** + * 创建ThreadFactoryBuilder + * + * @return ThreadFactoryBuilder + * @see ThreadFactoryBuilder#build() + * @since 4.1.13 + */ + public static ThreadFactoryBuilder createThreadFactoryBuilder() { + return ThreadFactoryBuilder.create(); + } + + /** + * 创建自定义线程名称前缀的{@link ThreadFactory} + * + * @param threadNamePrefix 线程名称前缀 + * @return {@link ThreadFactory} + * @see ThreadFactoryBuilder#build() + * @since 5.8.0 + */ + public static ThreadFactory createThreadFactory(String threadNamePrefix) { + return ThreadFactoryBuilder.create().setNamePrefix(threadNamePrefix).build(); + } + + /** + * 结束线程，调用此方法后，线程将抛出 {@link InterruptedException}异常 + * + * @param thread 线程 + * @param isJoin 是否等待结束 + */ + public static void interrupt(Thread thread, boolean isJoin) { + if (null != thread && false == thread.isInterrupted()) { + thread.interrupt(); + if (isJoin) { + waitForDie(thread); + } + } + } + + /** + * 等待当前线程结束. 调用 {@link Thread#join()} 并忽略 {@link InterruptedException} + */ + public static void waitForDie() { + waitForDie(Thread.currentThread()); + } + + /** + * 等待线程结束. 调用 {@link Thread#join()} 并忽略 {@link InterruptedException} + * + * @param thread 线程 + */ + public static void waitForDie(Thread thread) { + if (null == thread) { + return; + } + + boolean dead = false; + do { + try { + thread.join(); + dead = true; + } catch (InterruptedException e) { + // ignore + } + } while (false == dead); + } + + /** + * 获取JVM中与当前线程同组的所有线程
+ * + * @return 线程对象数组 + */ + public static Thread[] getThreads() { + return getThreads(Thread.currentThread().getThreadGroup().getParent()); + } + + /** + * 获取JVM中与当前线程同组的所有线程
+ * 使用数组二次拷贝方式，防止在线程列表获取过程中线程终止
+ * from Voovan + * + * @param group 线程组 + * @return 线程对象数组 + */ + public static Thread[] getThreads(ThreadGroup group) { + final Thread[] slackList = new Thread[group.activeCount() * 2]; + final int actualSize = group.enumerate(slackList); + final Thread[] result = new Thread[actualSize]; + System.arraycopy(slackList, 0, result, 0, actualSize); + return result; + } + + /** + * 获取进程的主线程
+ * from Voovan + * + * @return 进程的主线程 + */ + public static Thread getMainThread() { + for (Thread thread : getThreads()) { + if (thread.getId() == 1) { + return thread; + } + } + return null; + } + + /** + * 获取当前线程的线程组 + * + * @return 线程组 + * @since 3.1.2 + */ + public static ThreadGroup currentThreadGroup() { + final SecurityManager s = System.getSecurityManager(); + return (null != s) ? s.getThreadGroup() : Thread.currentThread().getThreadGroup(); + } + + /** + * 创建线程工厂 + * + * @param prefix 线程名前缀 + * @param isDaemon 是否守护线程 + * @return {@link ThreadFactory} + * @since 4.0.0 + */ + public static ThreadFactory newNamedThreadFactory(String prefix, boolean isDaemon) { + return new NamedThreadFactory(prefix, isDaemon); + } + + /** + * 创建线程工厂 + * + * @param prefix 线程名前缀 + * @param threadGroup 线程组，可以为null + * @param isDaemon 是否守护线程 + * @return {@link ThreadFactory} + * @since 4.0.0 + */ + public static ThreadFactory newNamedThreadFactory(String prefix, ThreadGroup threadGroup, boolean isDaemon) { + return new NamedThreadFactory(prefix, threadGroup, isDaemon); + } + + /** + * 创建线程工厂 + * + * @param prefix 线程名前缀 + * @param threadGroup 线程组，可以为null + * @param isDaemon 是否守护线程 + * @param handler 未捕获异常处理 + * @return {@link ThreadFactory} + * @since 4.0.0 + */ + public static ThreadFactory newNamedThreadFactory(String prefix, ThreadGroup threadGroup, boolean isDaemon, UncaughtExceptionHandler handler) { + return new NamedThreadFactory(prefix, threadGroup, isDaemon, handler); + } + + /** + * 阻塞当前线程，保证在main方法中执行不被退出 + * + * @param obj 对象所在线程 + * @since 4.5.6 + */ + @SuppressWarnings("SynchronizationOnLocalVariableOrMethodParameter") + public static void sync(Object obj) { + synchronized (obj) { + try { + obj.wait(); + } catch (InterruptedException e) { + // ignore + } + } + } + + /** + * 并发测试
+ * 此方法用于测试多线程下执行某些逻辑的并发性能
+ * 调用此方法会导致当前线程阻塞。
+ * 结束后可调用{@link ConcurrencyTester#getInterval()} 方法获取执行时间 + * + * @param threadSize 并发线程数 + * @param runnable 执行的逻辑实现 + * @return {@link ConcurrencyTester} + * @since 4.5.8 + */ + @SuppressWarnings("resource") + public static ConcurrencyTester concurrencyTest(int threadSize, Runnable runnable) { + return (new ConcurrencyTester(threadSize)).test(runnable); + } + + /** + * 创建{@link ScheduledThreadPoolExecutor} + * + * @param corePoolSize 初始线程池大小 + * @return {@link ScheduledThreadPoolExecutor} + * @since 5.5.8 + */ + public static ScheduledThreadPoolExecutor createScheduledExecutor(int corePoolSize) { + return new ScheduledThreadPoolExecutor(corePoolSize); + } + + /** + * 开始执行一个定时任务，执行方式分fixedRate模式和fixedDelay模式。
+ * 注意：此方法的延迟和周期的单位均为毫秒。 + * + *
    + *
  • fixedRate 模式：以固定的频率执行。每period的时刻检查，如果上个任务完成，启动下个任务，否则等待上个任务结束后立即启动。
    • + *
  • fixedDelay模式：以固定的延时执行。上次任务结束后等待period再执行下个任务。
    • + *
+ * + * @param executor 定时任务线程池，{@code null}新建一个默认线程池 + * @param command 需要定时执行的逻辑 + * @param initialDelay 初始延迟，单位毫秒 + * @param period 执行周期，单位毫秒 + * @param fixedRateOrFixedDelay {@code true}表示fixedRate模式，{@code false}表示fixedDelay模式 + * @return {@link ScheduledThreadPoolExecutor} + * @since 5.5.8 + */ + public static ScheduledThreadPoolExecutor schedule(ScheduledThreadPoolExecutor executor, + Runnable command, + long initialDelay, + long period, + boolean fixedRateOrFixedDelay) { + return schedule(executor, command, initialDelay, period, TimeUnit.MILLISECONDS, fixedRateOrFixedDelay); + } + + /** + * 开始执行一个定时任务，执行方式分fixedRate模式和fixedDelay模式。 + * + *
    + *
  • fixedRate 模式：以固定的频率执行。每period的时刻检查，如果上个任务完成，启动下个任务，否则等待上个任务结束后立即启动。
    • + *
  • fixedDelay模式：以固定的延时执行。上次任务结束后等待period再执行下个任务。
    • + *
+ * + * @param executor 定时任务线程池，{@code null}新建一个默认线程池 + * @param command 需要定时执行的逻辑 + * @param initialDelay 初始延迟 + * @param period 执行周期 + * @param timeUnit 时间单位 + * @param fixedRateOrFixedDelay {@code true}表示fixedRate模式，{@code false}表示fixedDelay模式 + * @return {@link ScheduledThreadPoolExecutor} + * @since 5.6.5 + */ + public static ScheduledThreadPoolExecutor schedule(ScheduledThreadPoolExecutor executor, + Runnable command, + long initialDelay, + long period, + TimeUnit timeUnit, + boolean fixedRateOrFixedDelay) { + if (null == executor) { + executor = createScheduledExecutor(2); + } + if (fixedRateOrFixedDelay) { + executor.scheduleAtFixedRate(command, initialDelay, period, timeUnit); + } else { + executor.scheduleWithFixedDelay(command, initialDelay, period, timeUnit); + } + + return executor; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/lock/LockUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/lock/LockUtil.java new file mode 100644 index 0000000..85429c5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/lock/LockUtil.java @@ -0,0 +1,43 @@ +package aiyh.utils.tool.cn.hutool.core.thread.lock; + +import java.util.concurrent.locks.ReentrantReadWriteLock; +import java.util.concurrent.locks.StampedLock; + +/** + * 锁相关工具 + * + * @author looly + * @since 5.2.5 + */ +public class LockUtil { + + private static final NoLock NO_LOCK = new NoLock(); + + /** + * 创建{@link StampedLock}锁 + * + * @return {@link StampedLock}锁 + */ + public static StampedLock createStampLock() { + return new StampedLock(); + } + + /** + * 创建{@link ReentrantReadWriteLock}锁 + * + * @param fair 是否公平锁 + * @return {@link ReentrantReadWriteLock}锁 + */ + public static ReentrantReadWriteLock createReadWriteLock(boolean fair) { + return new ReentrantReadWriteLock(fair); + } + + /** + * 获取单例的无锁对象 + * + * @return {@link NoLock} + */ + public static NoLock getNoLock(){ + return NO_LOCK; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/lock/NoLock.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/lock/NoLock.java new file mode 100755 index 0000000..fd568f6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/lock/NoLock.java @@ -0,0 +1,46 @@ +package aiyh.utils.tool.cn.hutool.core.thread.lock; + +import java.util.concurrent.TimeUnit; +import java.util.concurrent.locks.Condition; +import java.util.concurrent.locks.Lock; + +/** + * 无锁实现 + * + * @author looly + *@since 4.3.1 + */ +public class NoLock implements Lock{ + + public static NoLock INSTANCE = new NoLock(); + + @Override + public void lock() { + } + + @Override + public void lockInterruptibly() { + } + + @Override + public boolean tryLock() { + return true; + } + + @SuppressWarnings("NullableProblems") + @Override + public boolean tryLock(long time, TimeUnit unit) { + return true; + } + + @Override + public void unlock() { + } + + @SuppressWarnings("NullableProblems") + @Override + public Condition newCondition() { + throw new UnsupportedOperationException("NoLock`s newCondition method is unsupported"); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/lock/NoReadWriteLock.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/lock/NoReadWriteLock.java new file mode 100755 index 0000000..c9c226d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/lock/NoReadWriteLock.java @@ -0,0 +1,22 @@ +package aiyh.utils.tool.cn.hutool.core.thread.lock; + +import java.util.concurrent.locks.Lock; +import java.util.concurrent.locks.ReadWriteLock; + +/** + * 无锁的读写锁实现 + * + * @author looly + * @since 5.8.0 + */ +public class NoReadWriteLock implements ReadWriteLock { + @Override + public Lock readLock() { + return NoLock.INSTANCE; + } + + @Override + public Lock writeLock() { + return NoLock.INSTANCE; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/lock/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/lock/package-info.java new file mode 100644 index 0000000..5ae57ac --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/lock/package-info.java @@ -0,0 +1,7 @@ +/** + * 锁的实现 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.thread.lock; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/package-info.java new file mode 100644 index 0000000..91b07a3 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/package-info.java @@ -0,0 +1,7 @@ +/** + * 提供线程及高并发封装，入口为ThreadUtil + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.thread; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/threadlocal/NamedInheritableThreadLocal.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/threadlocal/NamedInheritableThreadLocal.java new file mode 100644 index 0000000..7c4a84a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/threadlocal/NamedInheritableThreadLocal.java @@ -0,0 +1,28 @@ +package aiyh.utils.tool.cn.hutool.core.thread.threadlocal; + +/** + * 带有Name标识的 {@link InheritableThreadLocal}，调用toString返回name + * + * @param 值类型 + * @author looly + * @since 4.1.4 + */ +public class NamedInheritableThreadLocal extends InheritableThreadLocal { + + private final String name; + + /** + * 构造 + * + * @param name 名字 + */ + public NamedInheritableThreadLocal(String name) { + this.name = name; + } + + @Override + public String toString() { + return this.name; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/threadlocal/NamedThreadLocal.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/threadlocal/NamedThreadLocal.java new file mode 100644 index 0000000..89e6ee8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/threadlocal/NamedThreadLocal.java @@ -0,0 +1,28 @@ +package aiyh.utils.tool.cn.hutool.core.thread.threadlocal; + +/** + * 带有Name标识的 {@link ThreadLocal}，调用toString返回name + * + * @param 值类型 + * @author looly + * @since 4.1.4 + */ +public class NamedThreadLocal extends ThreadLocal { + + private final String name; + + /** + * 构造 + * + * @param name 名字 + */ + public NamedThreadLocal(String name) { + this.name = name; + } + + @Override + public String toString() { + return this.name; + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/threadlocal/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/threadlocal/package-info.java new file mode 100644 index 0000000..5e57759 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/thread/threadlocal/package-info.java @@ -0,0 +1,7 @@ +/** + * + * ThreadLocal相关封装 + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.thread.threadlocal; diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ArrayUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ArrayUtil.java new file mode 100755 index 0000000..47c7940 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ArrayUtil.java @@ -0,0 +1,1993 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.collection.CollectionUtil; +import aiyh.utils.tool.cn.hutool.core.collection.UniqueKeySet; +import aiyh.utils.tool.cn.hutool.core.comparator.CompareUtil; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Editor; +import aiyh.utils.tool.cn.hutool.core.lang.Filter; +import aiyh.utils.tool.cn.hutool.core.lang.Matcher; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.text.StrJoiner; + +import java.lang.reflect.Array; +import java.nio.ByteBuffer; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.Comparator; +import java.util.Iterator; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Random; +import java.util.Set; +import java.util.function.Function; +import java.util.stream.Collectors; + +/** + * 数组工具类 + * + * @author Looly + */ +public class ArrayUtil extends PrimitiveArrayUtil { + public static final char SPACE = ' '; + public static final char TAB = ' '; + public static final char DOT = '.'; + public static final char SLASH = '/'; + public static final char BACKSLASH = '\\'; + public static final char CR = '\r'; + public static final char LF = '\n'; + public static final char UNDERLINE = '_'; + public static final char DASHED = '-'; + public static final char COMMA = ','; + public static final char DELIM_START = '{'; + public static final char DELIM_END = '}'; + public static final char BRACKET_START = '['; + public static final char BRACKET_END = ']'; + public static final char COLON = ':'; + public static final char DOUBLE_QUOTES = '"'; + public static final char SINGLE_QUOTE = '\''; + public static final char AMP = '&'; + + // ---------------------------------------------------------------------- isEmpty + + /** + * 数组是否为空 + * + * @param 数组元素类型 + * @param array 数组 + * @return 是否为空 + */ + public static boolean isEmpty(T[] array) { + return array == null || array.length == 0; + } + + /** + * 如果给定数组为空，返回默认数组 + * + * @param 数组元素类型 + * @param array 数组 + * @param defaultArray 默认数组 + * @return 非空（empty）的原数组或默认数组 + * @since 4.6.9 + */ + public static T[] defaultIfEmpty(T[] array, T[] defaultArray) { + return isEmpty(array) ? defaultArray : array; + } + + /** + * 数组是否为空
+ * 此方法会匹配单一对象，如果此对象为{@code null}则返回true
+ * 如果此对象为非数组，理解为此对象为数组的第一个元素，则返回false
+ * 如果此对象为数组对象，数组长度大于0情况下返回false，否则返回true + * + * @param array 数组 + * @return 是否为空 + */ + public static boolean isEmpty(Object array) { + if (array != null) { + if (isArray(array)) { + return 0 == Array.getLength(array); + } + return false; + } + return true; + } + + // ---------------------------------------------------------------------- isNotEmpty + + /** + * 数组是否为非空 + * + * @param 数组元素类型 + * @param array 数组 + * @return 是否为非空 + */ + public static boolean isNotEmpty(T[] array) { + return (null != array && array.length != 0); + } + + /** + * 数组是否为非空
+ * 此方法会匹配单一对象，如果此对象为{@code null}则返回false
+ * 如果此对象为非数组，理解为此对象为数组的第一个元素，则返回true
+ * 如果此对象为数组对象，数组长度大于0情况下返回true，否则返回false + * + * @param array 数组 + * @return 是否为非空 + */ + public static boolean isNotEmpty(Object array) { + return false == isEmpty(array); + } + + /** + * 是否包含{@code null}元素 + * + * @param 数组元素类型 + * @param array 被检查的数组 + * @return 是否包含{@code null}元素 + * @since 3.0.7 + */ + @SuppressWarnings("unchecked") + public static boolean hasNull(T... array) { + if (isNotEmpty(array)) { + for (T element : array) { + if (ObjectUtil.isNull(element)) { + return true; + } + } + } + return array == null; + } + + /** + * 多个字段是否全为null + * + * @param 数组元素类型 + * @param array 被检查的数组 + * @return 多个字段是否全为null + * @author dahuoyzs + * @since 5.4.0 + */ + @SuppressWarnings("unchecked") + public static boolean isAllNull(T... array) { + return null == firstNonNull(array); + } + + /** + * 返回数组中第一个非空元素 + * + * @param 数组元素类型 + * @param array 数组 + * @return 非空元素，如果不存在非空元素或数组为空，返回{@code null} + * @since 3.0.7 + */ + @SuppressWarnings("unchecked") + public static T firstNonNull(T... array) { + return firstMatch(ObjectUtil::isNotNull, array); + } + + /** + * 返回数组中第一个匹配规则的值 + * + * @param 数组元素类型 + * @param matcher 匹配接口，实现此接口自定义匹配规则 + * @param array 数组 + * @return 匹配元素，如果不存在匹配元素或数组为空，返回 {@code null} + * @since 3.0.7 + */ + @SuppressWarnings("unchecked") + public static T firstMatch(Matcher matcher, T... array) { + final int index = matchIndex(matcher, array); + if (index < 0) { + return null; + } + + return array[index]; + } + + /** + * 返回数组中第一个匹配规则的值的位置 + * + * @param 数组元素类型 + * @param matcher 匹配接口，实现此接口自定义匹配规则 + * @param array 数组 + * @return 匹配到元素的位置，-1表示未匹配到 + * @since 5.6.6 + */ + @SuppressWarnings("unchecked") + public static int matchIndex(Matcher matcher, T... array) { + return matchIndex(matcher, 0, array); + } + + /** + * 返回数组中第一个匹配规则的值的位置 + * + * @param 数组元素类型 + * @param matcher 匹配接口，实现此接口自定义匹配规则 + * @param beginIndexInclude 检索开始的位置 + * @param array 数组 + * @return 匹配到元素的位置，-1表示未匹配到 + * @since 5.7.3 + */ + @SuppressWarnings("unchecked") + public static int matchIndex(Matcher matcher, int beginIndexInclude, T... array) { + Assert.notNull(matcher, "Matcher must be not null !"); + if (isNotEmpty(array)) { + for (int i = beginIndexInclude; i < array.length; i++) { + if (matcher.match(array[i])) { + return i; + } + } + } + + return INDEX_NOT_FOUND; + } + + /** + * 新建一个空数组 + * + * @param 数组元素类型 + * @param componentType 元素类型 + * @param newSize 大小 + * @return 空数组 + */ + @SuppressWarnings("unchecked") + public static T[] newArray(Class componentType, int newSize) { + return (T[]) Array.newInstance(componentType, newSize); + } + + /** + * 新建一个空数组 + * + * @param newSize 大小 + * @return 空数组 + * @since 3.3.0 + */ + public static Object[] newArray(int newSize) { + return new Object[newSize]; + } + + /** + * 获取数组对象的元素类型 + * + * @param array 数组对象 + * @return 元素类型 + * @since 3.2.2 + */ + public static Class getComponentType(Object array) { + return null == array ? null : array.getClass().getComponentType(); + } + + /** + * 获取数组对象的元素类型 + * + * @param arrayClass 数组类 + * @return 元素类型 + * @since 3.2.2 + */ + public static Class getComponentType(Class arrayClass) { + return null == arrayClass ? null : arrayClass.getComponentType(); + } + + /** + * 根据数组元素类型，获取数组的类型
+ * 方法是通过创建一个空数组从而获取其类型 + * + * @param componentType 数组元素类型 + * @return 数组类型 + * @since 3.2.2 + */ + public static Class getArrayType(Class componentType) { + return Array.newInstance(componentType, 0).getClass(); + } + + /** + * 强转数组类型
+ * 强制转换的前提是数组元素类型可被强制转换
+ * 强制转换后会生成一个新数组 + * + * @param type 数组类型或数组元素类型 + * @param arrayObj 原数组 + * @return 转换后的数组类型 + * @throws NullPointerException 提供参数为空 + * @throws IllegalArgumentException 参数arrayObj不是数组 + * @since 3.0.6 + */ + public static Object[] cast(Class type, Object arrayObj) throws NullPointerException, IllegalArgumentException { + if (null == arrayObj) { + throw new NullPointerException("Argument [arrayObj] is null !"); + } + if (false == arrayObj.getClass().isArray()) { + throw new IllegalArgumentException("Argument [arrayObj] is not array !"); + } + if (null == type) { + return (Object[]) arrayObj; + } + + final Class componentType = type.isArray() ? type.getComponentType() : type; + final Object[] array = (Object[]) arrayObj; + final Object[] result = ArrayUtil.newArray(componentType, array.length); + System.arraycopy(array, 0, result, 0, array.length); + return result; + } + + /** + * 将新元素添加到已有数组中
+ * 添加新元素会生成一个新的数组，不影响原数组 + * + * @param 数组元素类型 + * @param buffer 已有数组 + * @param newElements 新元素 + * @return 新数组 + */ + @SafeVarargs + public static T[] append(T[] buffer, T... newElements) { + if (isEmpty(buffer)) { + return newElements; + } + return insert(buffer, buffer.length, newElements); + } + + /** + * 将新元素添加到已有数组中
+ * 添加新元素会生成一个新的数组，不影响原数组 + * + * @param 数组元素类型 + * @param array 已有数组 + * @param newElements 新元素 + * @return 新数组 + */ + @SafeVarargs + public static Object append(Object array, T... newElements) { + if (isEmpty(array)) { + return newElements; + } + return insert(array, length(array), newElements); + } + + /** + * 将元素值设置为数组的某个位置，当给定的index大于数组长度，则追加 + * + * @param 数组元素类型 + * @param buffer 已有数组 + * @param index 位置，大于长度追加，否则替换 + * @param value 新值 + * @return 新数组或原有数组 + * @since 4.1.2 + */ + public static T[] setOrAppend(T[] buffer, int index, T value) { + if (index < buffer.length) { + Array.set(buffer, index, value); + return buffer; + } else { + if(ArrayUtil.isEmpty(buffer)){ + // issue#I5APJE + // 可变长类型在buffer为空的情况下，类型会被擦除，导致报错，此处修正 + final T[] values = newArray(value.getClass(), 1); + values[0] = value; + return append(buffer, values); + } + return append(buffer, value); + } + } + + /** + * 将元素值设置为数组的某个位置，当给定的index大于数组长度，则追加 + * + * @param array 已有数组 + * @param index 位置，大于长度追加，否则替换 + * @param value 新值 + * @return 新数组或原有数组 + * @since 4.1.2 + */ + public static Object setOrAppend(Object array, int index, Object value) { + if (index < length(array)) { + Array.set(array, index, value); + return array; + } else { + return append(array, value); + } + } + + /** + * 将新元素插入到到已有数组中的某个位置
+ * 添加新元素会生成一个新数组或原有数组
+ * 如果插入位置为为负数，那么生成一个由插入元素顺序加已有数组顺序的新数组 + * + * @param 数组元素类型 + * @param buffer 已有数组 + * @param index 位置，大于长度追加，否则替换，<0表示从头部追加 + * @param values 新值 + * @return 新数组或原有数组 + * @since 5.7.23 + */ + @SuppressWarnings({"unchecked"}) + public static T[] replace(T[] buffer, int index, T... values) { + if (isEmpty(values)) { + return buffer; + } + if (isEmpty(buffer)) { + return values; + } + if (index < 0) { + // 从头部追加 + return insert(buffer, 0, values); + } + if (index >= buffer.length) { + // 超出长度，尾部追加 + return append(buffer, values); + } + + if (buffer.length >= values.length + index) { + System.arraycopy(values, 0, buffer, index, values.length); + return buffer; + } + + // 替换长度大于原数组长度，新建数组 + int newArrayLength = index + values.length; + final T[] result = newArray(buffer.getClass().getComponentType(), newArrayLength); + System.arraycopy(buffer, 0, result, 0, index); + System.arraycopy(values, 0, result, index, values.length); + return result; + } + + /** + * 将新元素插入到到已有数组中的某个位置
+ * 添加新元素会生成一个新的数组，不影响原数组
+ * 如果插入位置为为负数，从原数组从后向前计数，若大于原数组长度，则空白处用null填充 + * + * @param 数组元素类型 + * @param buffer 已有数组 + * @param index 插入位置，此位置为对应此位置元素之前的空档 + * @param newElements 新元素 + * @return 新数组 + * @since 4.0.8 + */ + @SuppressWarnings("unchecked") + public static T[] insert(T[] buffer, int index, T... newElements) { + return (T[]) insert((Object) buffer, index, newElements); + } + + /** + * 将新元素插入到到已有数组中的某个位置
+ * 添加新元素会生成一个新的数组，不影响原数组
+ * 如果插入位置为为负数，从原数组从后向前计数，若大于原数组长度，则空白处用null填充 + * + * @param 数组元素类型 + * @param array 已有数组 + * @param index 插入位置，此位置为对应此位置元素之前的空档 + * @param newElements 新元素 + * @return 新数组 + * @since 4.0.8 + */ + @SuppressWarnings({"unchecked", "SuspiciousSystemArraycopy"}) + public static Object insert(Object array, int index, T... newElements) { + if (isEmpty(newElements)) { + return array; + } + if (isEmpty(array)) { + return newElements; + } + + final int len = length(array); + if (index < 0) { + index = (index % len) + len; + } + + // 已有数组的元素类型 + final Class originComponentType = array.getClass().getComponentType(); + Object newEleArr = newElements; + // 如果 已有数组的元素类型是 原始类型，则需要转换 新元素数组 为该类型，避免ArrayStoreException + if (originComponentType.isPrimitive()) { + newEleArr = Convert.convert(array.getClass(), newElements); + } + final Object result = Array.newInstance(originComponentType, Math.max(len, index) + newElements.length); + System.arraycopy(array, 0, result, 0, Math.min(len, index)); + System.arraycopy(newEleArr, 0, result, index, newElements.length); + if (index < len) { + System.arraycopy(array, index, result, index + newElements.length, len - index); + } + return result; + } + + /** + * 生成一个新的重新设置大小的数组
+ * 调整大小后拷贝原数组到新数组下。扩大则占位前N个位置，缩小则截断 + * + * @param 数组元素类型 + * @param data 原数组 + * @param newSize 新的数组大小 + * @param componentType 数组元素类型 + * @return 调整后的新数组 + */ + public static T[] resize(T[] data, int newSize, Class componentType) { + if (newSize < 0) { + return data; + } + + final T[] newArray = newArray(componentType, newSize); + if (newSize > 0 && isNotEmpty(data)) { + System.arraycopy(data, 0, newArray, 0, Math.min(data.length, newSize)); + } + return newArray; + } + + /** + * 生成一个新的重新设置大小的数组
+ * 调整大小后拷贝原数组到新数组下。扩大则占位前N个位置，其它位置补充0，缩小则截断 + * + * @param array 原数组 + * @param newSize 新的数组大小 + * @return 调整后的新数组 + * @since 4.6.7 + */ + public static Object resize(Object array, int newSize) { + if (newSize < 0) { + return array; + } + if (null == array) { + return null; + } + final int length = length(array); + final Object newArray = Array.newInstance(array.getClass().getComponentType(), newSize); + if (newSize > 0 && isNotEmpty(array)) { + //noinspection SuspiciousSystemArraycopy + System.arraycopy(array, 0, newArray, 0, Math.min(length, newSize)); + } + return newArray; + } + + /** + * 生成一个新的重新设置大小的数组
+ * 新数组的类型为原数组的类型，调整大小后拷贝原数组到新数组下。扩大则占位前N个位置，缩小则截断 + * + * @param 数组元素类型 + * @param buffer 原数组 + * @param newSize 新的数组大小 + * @return 调整后的新数组 + */ + public static T[] resize(T[] buffer, int newSize) { + return resize(buffer, newSize, buffer.getClass().getComponentType()); + } + + /** + * 将多个数组合并在一起
+ * 忽略null的数组 + * + * @param 数组元素类型 + * @param arrays 数组集合 + * @return 合并后的数组 + */ + @SafeVarargs + public static T[] addAll(T[]... arrays) { + if (arrays.length == 1) { + return arrays[0]; + } + + int length = 0; + for (T[] array : arrays) { + if (null != array) { + length += array.length; + } + } + T[] result = newArray(arrays.getClass().getComponentType().getComponentType(), length); + + length = 0; + for (T[] array : arrays) { + if (null != array) { + System.arraycopy(array, 0, result, length, array.length); + length += array.length; + } + } + return result; + } + + /** + * 包装 {@link System#arraycopy(Object, int, Object, int, int)}
+ * 数组复制 + * + * @param src 源数组 + * @param srcPos 源数组开始位置 + * @param dest 目标数组 + * @param destPos 目标数组开始位置 + * @param length 拷贝数组长度 + * @return 目标数组 + * @since 3.0.6 + */ + public static Object copy(Object src, int srcPos, Object dest, int destPos, int length) { + //noinspection SuspiciousSystemArraycopy + System.arraycopy(src, srcPos, dest, destPos, length); + return dest; + } + + /** + * 包装 {@link System#arraycopy(Object, int, Object, int, int)}
+ * 数组复制，缘数组和目标数组都是从位置0开始复制 + * + * @param src 源数组 + * @param dest 目标数组 + * @param length 拷贝数组长度 + * @return 目标数组 + * @since 3.0.6 + */ + public static Object copy(Object src, Object dest, int length) { + //noinspection SuspiciousSystemArraycopy + System.arraycopy(src, 0, dest, 0, length); + return dest; + } + + /** + * 克隆数组 + * + * @param 数组元素类型 + * @param array 被克隆的数组 + * @return 新数组 + */ + public static T[] clone(T[] array) { + if (array == null) { + return null; + } + return array.clone(); + } + + /** + * 克隆数组，如果非数组返回{@code null} + * + * @param 数组元素类型 + * @param obj 数组对象 + * @return 克隆后的数组对象 + */ + @SuppressWarnings("unchecked") + public static T clone(final T obj) { + if (null == obj) { + return null; + } + if (isArray(obj)) { + final Object result; + final Class componentType = obj.getClass().getComponentType(); + if (componentType.isPrimitive()) {// 原始类型 + int length = Array.getLength(obj); + result = Array.newInstance(componentType, length); + while (length-- > 0) { + Array.set(result, length, Array.get(obj, length)); + } + } else { + result = ((Object[]) obj).clone(); + } + return (T) result; + } + return null; + } + + /** + * 编辑数组
+ * 编辑过程通过传入的Editor实现来返回需要的元素内容，这个Editor实现可以实现以下功能： + * + * 
+	 * 1、过滤出需要的对象，如果返回{@code null}表示这个元素对象抛弃
+	 * 2、修改元素对象，返回集合中为修改后的对象
+	 *
+ *

+ * + * @param 数组元素类型 + * @param array 数组 + * @param editor 编辑器接口，{@code null}返回原集合 + * @return 编辑后的数组 + * @since 5.3.3 + */ + public static T[] edit(T[] array, Editor editor) { + if (null == editor) { + return array; + } + + final ArrayList list = new ArrayList<>(array.length); + T modified; + for (T t : array) { + modified = editor.edit(t); + if (null != modified) { + list.add(modified); + } + } + final T[] result = newArray(array.getClass().getComponentType(), list.size()); + return list.toArray(result); + } + + /** + * 过滤
+ * 过滤过程通过传入的Filter实现来过滤返回需要的元素内容，这个Filter实现可以实现以下功能： + * + * 

+	 * 1、过滤出需要的对象，{@link Filter#accept(Object)}方法返回true的对象将被加入结果集合中
+	 *
+ * + * @param 数组元素类型 + * @param array 数组 + * @param filter 过滤器接口，用于定义过滤规则，{@code null}返回原集合 + * @return 过滤后的数组 + * @since 3.2.1 + */ + public static T[] filter(T[] array, Filter filter) { + if (null == array || null == filter) { + return array; + } + return edit(array, t -> filter.accept(t) ? t : null); + } + + /** + * 去除{@code null} 元素 + * + * @param 数组元素类型 + * @param array 数组 + * @return 处理后的数组 + * @since 3.2.2 + */ + public static T[] removeNull(T[] array) { + return edit(array, t -> { + // 返回null便不加入集合 + return t; + }); + } + + /** + * 去除{@code null}或者"" 元素 + * + * @param 数组元素类型 + * @param array 数组 + * @return 处理后的数组 + * @since 3.2.2 + */ + public static T[] removeEmpty(T[] array) { + return filter(array, StrUtil::isNotEmpty); + } + + /** + * 去除{@code null}或者""或者空白字符串 元素 + * + * @param 数组元素类型 + * @param array 数组 + * @return 处理后的数组 + * @since 3.2.2 + */ + public static T[] removeBlank(T[] array) { + return filter(array, StrUtil::isNotBlank); + } + + /** + * 数组元素中的null转换为"" + * + * @param array 数组 + * @return 新数组 + * @since 3.2.1 + */ + public static String[] nullToEmpty(String[] array) { + return edit(array, t -> null == t ? StrUtil.EMPTY : t); + } + + /** + * 映射键值（参考Python的zip()函数）
+ * 例如：
+ * keys = [a,b,c,d]
+ * values = [1,2,3,4]
+ * 则得到的Map是 {a=1, b=2, c=3, d=4}
+ * 如果两个数组长度不同，则只对应最短部分 + * + * @param Key类型 + * @param Value类型 + * @param keys 键列表 + * @param values 值列表 + * @param isOrder 是否有序 + * @return Map + * @since 3.0.4 + */ + public static Map zip(K[] keys, V[] values, boolean isOrder) { + if (isEmpty(keys) || isEmpty(values)) { + return null; + } + + final int size = Math.min(keys.length, values.length); + final Map map = MapUtil.newHashMap(size, isOrder); + for (int i = 0; i < size; i++) { + map.put(keys[i], values[i]); + } + + return map; + } + + /** + * 映射键值（参考Python的zip()函数），返回Map无序
+ * 例如：
+ * keys = [a,b,c,d]
+ * values = [1,2,3,4]
+ * 则得到的Map是 {a=1, b=2, c=3, d=4}
+ * 如果两个数组长度不同，则只对应最短部分 + * + * @param Key类型 + * @param Value类型 + * @param keys 键列表 + * @param values 值列表 + * @return Map + */ + public static Map zip(K[] keys, V[] values) { + return zip(keys, values, false); + } + + // ------------------------------------------------------------------- indexOf and lastIndexOf and contains + + /** + * 返回数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param 数组类型 + * @param array 数组 + * @param value 被检查的元素 + * @param beginIndexInclude 检索开始的位置 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int indexOf(T[] array, Object value, int beginIndexInclude) { + return matchIndex((obj) -> ObjectUtil.equal(value, obj), beginIndexInclude, array); + } + + /** + * 返回数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param 数组类型 + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int indexOf(T[] array, Object value) { + return matchIndex((obj) -> ObjectUtil.equal(value, obj), array); + } + + /** + * 返回数组中指定元素所在位置，忽略大小写，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.1.2 + */ + public static int indexOfIgnoreCase(CharSequence[] array, CharSequence value) { + if (null != array) { + for (int i = 0; i < array.length; i++) { + if (StrUtil.equalsIgnoreCase(array[i], value)) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在最后的位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param 数组类型 + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int lastIndexOf(T[] array, Object value) { + if (isEmpty(array)) { + return INDEX_NOT_FOUND; + } + return lastIndexOf(array, value, array.length - 1); + } + + /** + * 返回数组中指定元素所在最后的位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param 数组类型 + * @param array 数组 + * @param value 被检查的元素 + * @param endInclude 查找方式为从后向前查找，查找的数组结束位置，一般为array.length-1 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 5.7.3 + */ + public static int lastIndexOf(T[] array, Object value, int endInclude) { + if (isNotEmpty(array)) { + for (int i = endInclude; i >= 0; i--) { + if (ObjectUtil.equal(value, array[i])) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 数组中是否包含元素 + * + * @param 数组元素类型 + * @param array 数组 + * @param value 被检查的元素 + * @return 是否包含 + */ + public static boolean contains(T[] array, T value) { + return indexOf(array, value) > INDEX_NOT_FOUND; + } + + /** + * 数组中是否包含指定元素中的任意一个 + * + * @param 数组元素类型 + * @param array 数组 + * @param values 被检查的多个元素 + * @return 是否包含指定元素中的任意一个 + * @since 4.1.20 + */ + @SuppressWarnings("unchecked") + public static boolean containsAny(T[] array, T... values) { + for (T value : values) { + if (contains(array, value)) { + return true; + } + } + return false; + } + + /** + * 数组中是否包含指定元素中的全部 + * + * @param 数组元素类型 + * @param array 数组 + * @param values 被检查的多个元素 + * @return 是否包含指定元素中的全部 + * @since 5.4.7 + */ + @SuppressWarnings("unchecked") + public static boolean containsAll(T[] array, T... values) { + for (T value : values) { + if (false == contains(array, value)) { + return false; + } + } + return true; + } + + /** + * 数组中是否包含元素，忽略大小写 + * + * @param array 数组 + * @param value 被检查的元素 + * @return 是否包含 + * @since 3.1.2 + */ + public static boolean containsIgnoreCase(CharSequence[] array, CharSequence value) { + return indexOfIgnoreCase(array, value) > INDEX_NOT_FOUND; + } + + // ------------------------------------------------------------------- Wrap and unwrap + + /** + * 包装数组对象 + * + * @param obj 对象，可以是对象数组或者基本类型数组 + * @return 包装类型数组或对象数组 + * @throws UtilException 对象为非数组 + */ + public static Object[] wrap(Object obj) { + if (null == obj) { + return null; + } + if (isArray(obj)) { + try { + return (Object[]) obj; + } catch (Exception e) { + final String className = obj.getClass().getComponentType().getName(); + switch (className) { + case "long": + return wrap((long[]) obj); + case "int": + return wrap((int[]) obj); + case "short": + return wrap((short[]) obj); + case "char": + return wrap((char[]) obj); + case "byte": + return wrap((byte[]) obj); + case "boolean": + return wrap((boolean[]) obj); + case "float": + return wrap((float[]) obj); + case "double": + return wrap((double[]) obj); + default: + throw new UtilException(e); + } + } + } + throw new UtilException(StrUtil.format("[{}] is not Array!", obj.getClass())); + } + + /** + * 对象是否为数组对象 + * + * @param obj 对象 + * @return 是否为数组对象，如果为{@code null} 返回false + */ + public static boolean isArray(Object obj) { + return null != obj && obj.getClass().isArray(); + } + + /** + * 获取数组对象中指定index的值，支持负数，例如-1表示倒数第一个值
+ * 如果数组下标越界，返回null + * + * @param 数组元素类型 + * @param array 数组对象 + * @param index 下标，支持负数 + * @return 值 + * @since 4.0.6 + */ + @SuppressWarnings("unchecked") + public static T get(Object array, int index) { + if (null == array) { + return null; + } + + if (index < 0) { + index += Array.getLength(array); + } + try { + return (T) Array.get(array, index); + } catch (ArrayIndexOutOfBoundsException e) { + return null; + } + } + + /** + * 获取数组中指定多个下标元素值，组成新数组 + * + * @param 数组元素类型 + * @param array 数组，如果提供为{@code null}则返回{@code null} + * @param indexes 下标列表 + * @return 结果 + */ + public static T[] getAny(Object array, int... indexes) { + if (null == array) { + return null; + } + if(null == indexes){ + return newArray(array.getClass().getComponentType(), 0); + } + + final T[] result = newArray(array.getClass().getComponentType(), indexes.length); + for (int i = 0; i < indexes.length; i++) { + result[i] = ArrayUtil.get(array, indexes[i]); + } + return result; + } + + /** + * 获取子数组 + * + * @param 数组元素类型 + * @param array 数组 + * @param start 开始位置（包括） + * @param end 结束位置（不包括） + * @return 新的数组 + * @see Arrays#copyOfRange(Object[], int, int) + * @since 4.2.2 + */ + public static T[] sub(T[] array, int start, int end) { + int length = length(array); + if (start < 0) { + start += length; + } + if (end < 0) { + end += length; + } + if (start == length) { + return newArray(array.getClass().getComponentType(), 0); + } + if (start > end) { + int tmp = start; + start = end; + end = tmp; + } + if (end > length) { + if (start >= length) { + return newArray(array.getClass().getComponentType(), 0); + } + end = length; + } + return Arrays.copyOfRange(array, start, end); + } + + /** + * 获取子数组 + * + * @param array 数组 + * @param start 开始位置（包括） + * @param end 结束位置（不包括） + * @return 新的数组 + * @since 4.0.6 + */ + public static Object[] sub(Object array, int start, int end) { + return sub(array, start, end, 1); + } + + /** + * 获取子数组 + * + * @param array 数组 + * @param start 开始位置（包括） + * @param end 结束位置（不包括） + * @param step 步进 + * @return 新的数组 + * @since 4.0.6 + */ + public static Object[] sub(Object array, int start, int end, int step) { + int length = length(array); + if (start < 0) { + start += length; + } + if (end < 0) { + end += length; + } + if (start == length) { + return new Object[0]; + } + if (start > end) { + int tmp = start; + start = end; + end = tmp; + } + if (end > length) { + if (start >= length) { + return new Object[0]; + } + end = length; + } + + if (step <= 1) { + step = 1; + } + + final ArrayList list = new ArrayList<>(); + for (int i = start; i < end; i += step) { + list.add(get(array, i)); + } + + return list.toArray(); + } + + /** + * 数组或集合转String + * + * @param obj 集合或数组对象 + * @return 数组字符串，与集合转字符串格式相同 + */ + public static String toString(Object obj) { + if (null == obj) { + return null; + } + + if (obj instanceof long[]) { + return Arrays.toString((long[]) obj); + } else if (obj instanceof int[]) { + return Arrays.toString((int[]) obj); + } else if (obj instanceof short[]) { + return Arrays.toString((short[]) obj); + } else if (obj instanceof char[]) { + return Arrays.toString((char[]) obj); + } else if (obj instanceof byte[]) { + return Arrays.toString((byte[]) obj); + } else if (obj instanceof boolean[]) { + return Arrays.toString((boolean[]) obj); + } else if (obj instanceof float[]) { + return Arrays.toString((float[]) obj); + } else if (obj instanceof double[]) { + return Arrays.toString((double[]) obj); + } else if (ArrayUtil.isArray(obj)) { + // 对象数组 + try { + return Arrays.deepToString((Object[]) obj); + } catch (Exception ignore) { + //ignore + } + } + + return obj.toString(); + } + + /** + * 获取数组长度
+ * 如果参数为{@code null}，返回0 + * + * 
+	 * ArrayUtil.length(null)            = 0
+	 * ArrayUtil.length([])              = 0
+	 * ArrayUtil.length([null])          = 1
+	 * ArrayUtil.length([true, false])   = 2
+	 * ArrayUtil.length([1, 2, 3])       = 3
+	 * ArrayUtil.length(["a", "b", "c"]) = 3
+	 *
+ * + * @param array 数组对象 + * @return 数组长度 + * @throws IllegalArgumentException 如果参数不为数组，抛出此异常 + * @see Array#getLength(Object) + * @since 3.0.8 + */ + public static int length(Object array) throws IllegalArgumentException { + if (null == array) { + return 0; + } + return Array.getLength(array); + } + + /** + * 以 conjunction 为分隔符将数组转换为字符串 + * + * @param 被处理的集合 + * @param array 数组 + * @param conjunction 分隔符 + * @return 连接后的字符串 + */ + public static String join(T[] array, CharSequence conjunction) { + return join(array, conjunction, null, null); + } + + /** + * 以 conjunction 为分隔符将数组转换为字符串 + * + * @param 被处理的集合 + * @param array 数组 + * @param delimiter 分隔符 + * @param prefix 每个元素添加的前缀，null表示不添加 + * @param suffix 每个元素添加的后缀，null表示不添加 + * @return 连接后的字符串 + * @since 4.0.10 + */ + public static String join(T[] array, CharSequence delimiter, String prefix, String suffix) { + if (null == array) { + return null; + } + + return StrJoiner.of(delimiter, prefix, suffix) + // 每个元素都添加前后缀 + .setWrapElement(true) + .append(array) + .toString(); + } + + /** + * 以 conjunction 为分隔符将数组转换为字符串 + * + * @param 被处理的集合 + * @param array 数组 + * @param conjunction 分隔符 + * @param editor 每个元素的编辑器，null表示不编辑 + * @return 连接后的字符串 + * @since 5.3.3 + */ + public static String join(T[] array, CharSequence conjunction, Editor editor) { + return StrJoiner.of(conjunction).append(array, (t) -> String.valueOf(editor.edit(t))).toString(); + } + + /** + * 以 conjunction 为分隔符将数组转换为字符串 + * + * @param array 数组 + * @param conjunction 分隔符 + * @return 连接后的字符串 + */ + public static String join(Object array, CharSequence conjunction) { + if (null == array) { + return null; + } + if (false == isArray(array)) { + throw new IllegalArgumentException(StrUtil.format("[{}] is not a Array!", array.getClass())); + } + + return StrJoiner.of(conjunction).append(array).toString(); + } + + /** + * {@link ByteBuffer} 转byte数组 + * + * @param bytebuffer {@link ByteBuffer} + * @return byte数组 + * @since 3.0.1 + */ + public static byte[] toArray(ByteBuffer bytebuffer) { + if (bytebuffer.hasArray()) { + return Arrays.copyOfRange(bytebuffer.array(), bytebuffer.position(), bytebuffer.limit()); + } else { + int oldPosition = bytebuffer.position(); + bytebuffer.position(0); + int size = bytebuffer.limit(); + byte[] buffers = new byte[size]; + bytebuffer.get(buffers); + bytebuffer.position(oldPosition); + return buffers; + } + } + + /** + * 将集合转为数组 + * + * @param 数组元素类型 + * @param iterator {@link Iterator} + * @param componentType 集合元素类型 + * @return 数组 + * @since 3.0.9 + */ + public static T[] toArray(Iterator iterator, Class componentType) { + return toArray(CollUtil.newArrayList(iterator), componentType); + } + + /** + * 将集合转为数组 + * + * @param 数组元素类型 + * @param iterable {@link Iterable} + * @param componentType 集合元素类型 + * @return 数组 + * @since 3.0.9 + */ + public static T[] toArray(Iterable iterable, Class componentType) { + return toArray(CollectionUtil.toCollection(iterable), componentType); + } + + /** + * 将集合转为数组 + * + * @param 数组元素类型 + * @param collection 集合 + * @param componentType 集合元素类型 + * @return 数组 + * @since 3.0.9 + */ + public static T[] toArray(Collection collection, Class componentType) { + return collection.toArray(newArray(componentType, 0)); + } + + // ---------------------------------------------------------------------- remove + + /** + * 移除数组中对应位置的元素
+ * copy from commons-lang + * + * @param 数组元素类型 + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param index 位置，如果位置小于0或者大于长度，返回原数组 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + @SuppressWarnings("unchecked") + public static T[] remove(T[] array, int index) throws IllegalArgumentException { + return (T[]) remove((Object) array, index); + } + + // ---------------------------------------------------------------------- removeEle + + /** + * 移除数组中指定的元素
+ * 只会移除匹配到的第一个元素 copy from commons-lang + * + * @param 数组元素类型 + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param element 要移除的元素 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static T[] removeEle(T[] array, T element) throws IllegalArgumentException { + return remove(array, indexOf(array, element)); + } + + // ---------------------------------------------------------------------- Reverse array + + /** + * 反转数组，会变更原数组 + * + * @param 数组元素类型 + * @param array 数组，会变更 + * @param startIndexInclusive 开始位置（包含） + * @param endIndexExclusive 结束位置（不包含） + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static T[] reverse(T[] array, final int startIndexInclusive, final int endIndexExclusive) { + if (isEmpty(array)) { + return array; + } + int i = Math.max(startIndexInclusive, 0); + int j = Math.min(array.length, endIndexExclusive) - 1; + T tmp; + while (j > i) { + tmp = array[j]; + array[j] = array[i]; + array[i] = tmp; + j--; + i++; + } + return array; + } + + /** + * 反转数组，会变更原数组 + * + * @param 数组元素类型 + * @param array 数组，会变更 + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static T[] reverse(T[] array) { + return reverse(array, 0, array.length); + } + + // ------------------------------------------------------------------------------------------------------------ min and max + + /** + * 取最小值 + * + * @param 元素类型 + * @param numberArray 数字数组 + * @return 最小值 + * @since 3.0.9 + */ + public static > T min(T[] numberArray) { + return min(numberArray, null); + } + + /** + * 取最小值 + * + * @param 元素类型 + * @param numberArray 数字数组 + * @param comparator 比较器，null按照默认比较 + * @return 最小值 + * @since 5.3.4 + */ + public static > T min(T[] numberArray, Comparator comparator) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + T min = numberArray[0]; + for (T t : numberArray) { + if (CompareUtil.compare(min, t, comparator) > 0) { + min = t; + } + } + return min; + } + + /** + * 取最大值 + * + * @param 元素类型 + * @param numberArray 数字数组 + * @return 最大值 + * @since 3.0.9 + */ + public static > T max(T[] numberArray) { + return max(numberArray, null); + } + + /** + * 取最大值 + * + * @param 元素类型 + * @param numberArray 数字数组 + * @param comparator 比较器，null表示默认比较器 + * @return 最大值 + * @since 5.3.4 + */ + public static > T max(T[] numberArray, Comparator comparator) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + T max = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (CompareUtil.compare(max, numberArray[i], comparator) < 0) { + max = numberArray[i]; + } + } + return max; + } + + // 使用Fisher–Yates洗牌算法，以线性时间复杂度打乱数组顺序 + + /** + * 打乱数组顺序，会变更原数组 + * + * @param 元素类型 + * @param array 数组，会变更 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static T[] shuffle(T[] array) { + return shuffle(array, RandomUtil.getRandom()); + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param 元素类型 + * @param array 数组，会变更 + * @param random 随机数生成器 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static T[] shuffle(T[] array, Random random) { + if (array == null || random == null || array.length <= 1) { + return array; + } + + for (int i = array.length; i > 1; i--) { + swap(array, i - 1, random.nextInt(i)); + } + + return array; + } + + /** + * 交换数组中两个位置的值 + * + * @param 元素类型 + * @param array 数组 + * @param index1 位置1 + * @param index2 位置2 + * @return 交换后的数组，与传入数组为同一对象 + * @since 4.0.7 + */ + public static T[] swap(T[] array, int index1, int index2) { + if (isEmpty(array)) { + throw new IllegalArgumentException("Array must not empty !"); + } + T tmp = array[index1]; + array[index1] = array[index2]; + array[index2] = tmp; + return array; + } + + /** + * 交换数组中两个位置的值 + * + * @param array 数组对象 + * @param index1 位置1 + * @param index2 位置2 + * @return 交换后的数组，与传入数组为同一对象 + * @since 4.0.7 + */ + public static Object swap(Object array, int index1, int index2) { + if (isEmpty(array)) { + throw new IllegalArgumentException("Array must not empty !"); + } + Object tmp = get(array, index1); + Array.set(array, index1, Array.get(array, index2)); + Array.set(array, index2, tmp); + return array; + } + + /** + * 计算{@code null}或空元素对象的个数，通过{@link ObjectUtil#isEmpty(Object)} 判断元素 + * + * @param args 被检查的对象,一个或者多个 + * @return 存在{@code null}的数量 + * @since 4.5.18 + */ + public static int emptyCount(Object... args) { + int count = 0; + if (isNotEmpty(args)) { + for (Object element : args) { + if (ObjectUtil.isEmpty(element)) { + count++; + } + } + } + return count; + } + + /** + * 是否存在{@code null}或空对象，通过{@link ObjectUtil#isEmpty(Object)} 判断元素 + * + * @param args 被检查对象 + * @return 是否存在 + * @since 4.5.18 + */ + public static boolean hasEmpty(Object... args) { + if (isNotEmpty(args)) { + for (Object element : args) { + if (ObjectUtil.isEmpty(element)) { + return true; + } + } + } + return false; + } + + /** + * 是否存都为{@code null}或空对象，通过{@link ObjectUtil#isEmpty(Object)} 判断元素 + * + * @param args 被检查的对象,一个或者多个 + * @return 是否都为空 + * @since 4.5.18 + */ + public static boolean isAllEmpty(Object... args) { + for (Object obj : args) { + if (false == ObjectUtil.isEmpty(obj)) { + return false; + } + } + return true; + } + + /** + * 是否存都不为{@code null}或空对象，通过{@link ObjectUtil#isEmpty(Object)} 判断元素 + * + * @param args 被检查的对象,一个或者多个 + * @return 是否都不为空 + * @since 4.5.18 + */ + public static boolean isAllNotEmpty(Object... args) { + return false == hasEmpty(args); + } + + /** + * 多个字段是否全部不为null + * + * @param 数组元素类型 + * @param array 被检查的数组 + * @return 多个字段是否全部不为null + * @since 5.4.0 + */ + @SuppressWarnings("unchecked") + public static boolean isAllNotNull(T... array) { + return false == hasNull(array); + } + + /** + * 去重数组中的元素，去重后生成新的数组，原数组不变
+ * 此方法通过{@link LinkedHashSet} 去重 + * + * @param 数组元素类型 + * @param array 数组 + * @return 去重后的数组 + */ + @SuppressWarnings("unchecked") + public static T[] distinct(T[] array) { + if (isEmpty(array)) { + return array; + } + + final Set set = new LinkedHashSet<>(array.length, 1); + Collections.addAll(set, array); + return toArray(set, (Class) getComponentType(array)); + } + + /** + * 去重数组中的元素，去重后生成新的数组，原数组不变
+ * 此方法通过{@link LinkedHashSet} 去重 + * + * @param 数组元素类型 + * @param 唯一键类型 + * @param array 数组 + * @param uniqueGenerator 唯一键生成器 + * @param override 是否覆盖模式，如果为{@code true}，加入的新值会覆盖相同key的旧值，否则会忽略新加值 + * @return 去重后的数组 + * @since 5.8.0 + */ + @SuppressWarnings("unchecked") + public static T[] distinct(T[] array, Function uniqueGenerator, boolean override) { + if (isEmpty(array)) { + return array; + } + + final UniqueKeySet set = new UniqueKeySet<>(true, uniqueGenerator); + if(override){ + Collections.addAll(set, array); + } else{ + for (T t : array) { + set.addIfAbsent(t); + } + } + return toArray(set, (Class) getComponentType(array)); + } + + /** + * 按照指定规则，将一种类型的数组转换为另一种类型 + * + * @param array 被转换的数组 + * @param targetComponentType 目标的元素类型 + * @param func 转换规则函数 + * @param 原数组类型 + * @param 目标数组类型 + * @return 转换后的数组 + * @since 5.4.2 + */ + public static R[] map(T[] array, Class targetComponentType, Function func) { + final R[] result = newArray(targetComponentType, array.length); + for (int i = 0; i < array.length; i++) { + result[i] = func.apply(array[i]); + } + return result; + } + + /** + * 按照指定规则，将一种类型的数组转换为另一种类型 + * + * @param array 被转换的数组 + * @param targetComponentType 目标的元素类型 + * @param func 转换规则函数 + * @param 原数组类型 + * @param 目标数组类型 + * @return 转换后的数组 + * @since 5.5.8 + */ + public static R[] map(Object array, Class targetComponentType, Function func) { + final int length = length(array); + final R[] result = newArray(targetComponentType, length); + for (int i = 0; i < length; i++) { + result[i] = func.apply(get(array, i)); + } + return result; + } + + /** + * 按照指定规则，将一种类型的数组元素提取后转换为{@link List} + * + * @param array 被转换的数组 + * @param func 转换规则函数 + * @param 原数组类型 + * @param 目标数组类型 + * @return 转换后的数组 + * @since 5.5.7 + */ + public static List map(T[] array, Function func) { + return Arrays.stream(array).map(func).collect(Collectors.toList()); + } + + /** + * 按照指定规则，将一种类型的数组元素提取后转换为{@link Set} + * + * @param array 被转换的数组 + * @param func 转换规则函数 + * @param 原数组类型 + * @param 目标数组类型 + * @return 转换后的数组 + * @since 5.8.0 + */ + public static Set mapToSet(T[] array, Function func) { + return Arrays.stream(array).map(func).collect(Collectors.toSet()); + } + + /** + * 判断两个数组是否相等，判断依据包括数组长度和每个元素都相等。 + * + * @param array1 数组1 + * @param array2 数组2 + * @return 是否相等 + * @since 5.4.2 + */ + public static boolean equals(Object array1, Object array2) { + if (array1 == array2) { + return true; + } + if (hasNull(array1, array2)) { + return false; + } + + Assert.isTrue(isArray(array1), "First is not a Array !"); + Assert.isTrue(isArray(array2), "Second is not a Array !"); + + if (array1 instanceof long[]) { + return Arrays.equals((long[]) array1, (long[]) array2); + } else if (array1 instanceof int[]) { + return Arrays.equals((int[]) array1, (int[]) array2); + } else if (array1 instanceof short[]) { + return Arrays.equals((short[]) array1, (short[]) array2); + } else if (array1 instanceof char[]) { + return Arrays.equals((char[]) array1, (char[]) array2); + } else if (array1 instanceof byte[]) { + return Arrays.equals((byte[]) array1, (byte[]) array2); + } else if (array1 instanceof double[]) { + return Arrays.equals((double[]) array1, (double[]) array2); + } else if (array1 instanceof float[]) { + return Arrays.equals((float[]) array1, (float[]) array2); + } else if (array1 instanceof boolean[]) { + return Arrays.equals((boolean[]) array1, (boolean[]) array2); + } else { + // Not an array of primitives + return Arrays.deepEquals((Object[]) array1, (Object[]) array2); + } + } + + /** + * 查找子数组的位置 + * + * @param array 数组 + * @param subArray 子数组 + * @param 数组元素类型 + * @return 子数组的开始位置，即子数字第一个元素在数组中的位置 + * @since 5.4.8 + */ + public static boolean isSub(T[] array, T[] subArray) { + return indexOfSub(array, subArray) > INDEX_NOT_FOUND; + } + + /** + * 查找子数组的位置 + * + * @param array 数组 + * @param subArray 子数组 + * @param 数组元素类型 + * @return 子数组的开始位置，即子数字第一个元素在数组中的位置 + * @since 5.4.8 + */ + public static int indexOfSub(T[] array, T[] subArray) { + return indexOfSub(array, 0, subArray); + } + + /** + * 查找子数组的位置 + * + * @param array 数组 + * @param beginInclude 查找开始的位置（包含） + * @param subArray 子数组 + * @param 数组元素类型 + * @return 子数组的开始位置，即子数字第一个元素在数组中的位置 + * @since 5.4.8 + */ + public static int indexOfSub(T[] array, int beginInclude, T[] subArray) { + if (isEmpty(array) || isEmpty(subArray) || subArray.length > array.length) { + return INDEX_NOT_FOUND; + } + int firstIndex = indexOf(array, subArray[0], beginInclude); + if (firstIndex < 0 || firstIndex + subArray.length > array.length) { + return INDEX_NOT_FOUND; + } + + for (int i = 0; i < subArray.length; i++) { + if (false == ObjectUtil.equal(array[i + firstIndex], subArray[i])) { + return indexOfSub(array, firstIndex + 1, subArray); + } + } + + return firstIndex; + } + + /** + * 查找最后一个子数组的开始位置 + * + * @param array 数组 + * @param subArray 子数组 + * @param 数组元素类型 + * @return 最后一个子数组的开始位置，即子数字第一个元素在数组中的位置 + * @since 5.4.8 + */ + public static int lastIndexOfSub(T[] array, T[] subArray) { + if (isEmpty(array) || isEmpty(subArray)) { + return INDEX_NOT_FOUND; + } + return lastIndexOfSub(array, array.length - 1, subArray); + } + + /** + * 查找最后一个子数组的开始位置 + * + * @param array 数组 + * @param endInclude 查找结束的位置（包含） + * @param subArray 子数组 + * @param 数组元素类型 + * @return 最后一个子数组的开始位置，即子数字第一个元素在数组中的位置 + * @since 5.4.8 + */ + public static int lastIndexOfSub(T[] array, int endInclude, T[] subArray) { + if (isEmpty(array) || isEmpty(subArray) || subArray.length > array.length || endInclude < 0) { + return INDEX_NOT_FOUND; + } + + int firstIndex = lastIndexOf(array, subArray[0]); + if (firstIndex < 0 || firstIndex + subArray.length > array.length) { + return INDEX_NOT_FOUND; + } + + for (int i = 0; i < subArray.length; i++) { + if (false == ObjectUtil.equal(array[i + firstIndex], subArray[i])) { + return lastIndexOfSub(array, firstIndex - 1, subArray); + } + } + + return firstIndex; + } + + // O(n)时间复杂度检查数组是否有序 + + /** + * 检查数组是否有序，即comparator.compare(array[i], array[i + 1]) <= 0，若传入空数组或空比较器，则返回false + * + * @param array 数组 + * @param comparator 比较器 + * @param 数组元素类型 + * @return 数组是否有序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSorted(T[] array, Comparator comparator) { + if (array == null || comparator == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (comparator.compare(array[i], array[i + 1]) > 0) { + return false; + } + } + return true; + } + + /** + * 检查数组是否升序，即array[i].compareTo(array[i + 1]) <= 0，若传入空数组，则返回false + * + * @param 数组元素类型，该类型需要实现Comparable接口 + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static > boolean isSorted(T[] array) { + return isSortedASC(array); + } + + + /** + * 检查数组是否升序，即array[i].compareTo(array[i + 1]) <= 0，若传入空数组，则返回false + * + * @param 数组元素类型，该类型需要实现Comparable接口 + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static > boolean isSortedASC(T[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i].compareTo(array[i + 1]) > 0) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否降序，即array[i].compareTo(array[i + 1]) >= 0，若传入空数组，则返回false + * + * @param 数组元素类型，该类型需要实现Comparable接口 + * @param array 数组 + * @return 数组是否降序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static > boolean isSortedDESC(T[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i].compareTo(array[i + 1]) < 0) { + return false; + } + } + + return true; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/BooleanUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/BooleanUtil.java new file mode 100644 index 0000000..104275d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/BooleanUtil.java @@ -0,0 +1,504 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; + +import java.util.Set; + +/** + * Boolean类型相关工具类 + * + * @author looly + * @since 4.1.16 + */ +public class BooleanUtil { + + /** 表示为真的字符串 */ + private static final Set TRUE_SET = CollUtil.newHashSet("true", "yes", "y", "t", "ok", "1", "on", "是", "对", "真", "對", "√"); + /** 表示为假的字符串 */ + private static final Set FALSE_SET = CollUtil.newHashSet("false", "no", "n", "f", "0", "off", "否", "错", "假", "錯", "×"); + + /** + * 取相反值 + * + * @param bool Boolean值 + * @return 相反的Boolean值 + */ + public static Boolean negate(Boolean bool) { + if (bool == null) { + return null; + } + return bool ? Boolean.FALSE : Boolean.TRUE; + } + + /** + * 检查 {@code Boolean} 值是否为 {@code true} + * + * 
+	 *   BooleanUtil.isTrue(Boolean.TRUE)  = true
+	 *   BooleanUtil.isTrue(Boolean.FALSE) = false
+	 *   BooleanUtil.isTrue(null)          = false
+	 *
+ * + * @param bool 被检查的Boolean值 + * @return 当值为true且非null时返回{@code true} + */ + public static boolean isTrue(Boolean bool) { + return Boolean.TRUE.equals(bool); + } + + /** + * 检查 {@code Boolean} 值是否为 {@code false} + * + * 
+	 *   BooleanUtil.isFalse(Boolean.TRUE)  = false
+	 *   BooleanUtil.isFalse(Boolean.FALSE) = true
+	 *   BooleanUtil.isFalse(null)          = false
+	 *
+ * + * @param bool 被检查的Boolean值 + * @return 当值为false且非null时返回{@code true} + */ + public static boolean isFalse(Boolean bool) { + return Boolean.FALSE.equals(bool); + } + + /** + * 取相反值 + * + * @param bool Boolean值 + * @return 相反的Boolean值 + */ + public static boolean negate(boolean bool) { + return !bool; + } + + /** + * 转换字符串为boolean值 + * + * @param valueStr 字符串 + * @return boolean值 + */ + public static boolean toBoolean(String valueStr) { + if (StrUtil.isNotBlank(valueStr)) { + valueStr = valueStr.trim().toLowerCase(); + return TRUE_SET.contains(valueStr); + } + return false; + } + + /** + * 转换字符串为boolean值
+ * 如果为["true", "yes", "y", "t", "ok", "1", "on", "是", "对", "真", "對", "√"]，返回{@code true}
+ * 如果为["false", "no", "n", "f", "0", "off", "否", "错", "假", "錯", "×"]，返回{@code false}
+ * 其他情况返回{@code null} + * + * @param valueStr 字符串 + * @return boolean值 + * @since 5.8.1 + */ + public static Boolean toBooleanObject(String valueStr) { + if (StrUtil.isNotBlank(valueStr)) { + valueStr = valueStr.trim().toLowerCase(); + if(TRUE_SET.contains(valueStr)){ + return true; + } else if(FALSE_SET.contains(valueStr)){ + return false; + } + } + return null; + } + + /** + * boolean值转为int + * + * @param value Boolean值 + * @return int值 + */ + public static int toInt(boolean value) { + return value ? 1 : 0; + } + + /** + * boolean值转为Integer + * + * @param value Boolean值 + * @return Integer值 + */ + public static Integer toInteger(boolean value) { + return toInt(value); + } + + /** + * boolean值转为char + * + * @param value Boolean值 + * @return char值 + */ + public static char toChar(boolean value) { + return (char) toInt(value); + } + + /** + * boolean值转为Character + * + * @param value Boolean值 + * @return Character值 + */ + public static Character toCharacter(boolean value) { + return toChar(value); + } + + /** + * boolean值转为byte + * + * @param value Boolean值 + * @return byte值 + */ + public static byte toByte(boolean value) { + return (byte) toInt(value); + } + + /** + * boolean值转为Byte + * + * @param value Boolean值 + * @return Byte值 + */ + public static Byte toByteObj(boolean value) { + return toByte(value); + } + + /** + * boolean值转为long + * + * @param value Boolean值 + * @return long值 + */ + public static long toLong(boolean value) { + return toInt(value); + } + + /** + * boolean值转为Long + * + * @param value Boolean值 + * @return Long值 + */ + public static Long toLongObj(boolean value) { + return toLong(value); + } + + /** + * boolean值转为short + * + * @param value Boolean值 + * @return short值 + */ + public static short toShort(boolean value) { + return (short) toInt(value); + } + + /** + * boolean值转为Short + * + * @param value Boolean值 + * @return Short值 + */ + public static Short toShortObj(boolean value) { + return toShort(value); + } + + /** + * boolean值转为float + * + * @param value Boolean值 + * @return float值 + */ + public static float toFloat(boolean value) { + return (float) toInt(value); + } + + /** + * boolean值转为Float + * + * @param value Boolean值 + * @return float值 + */ + public static Float toFloatObj(boolean value) { + return toFloat(value); + } + + /** + * boolean值转为double + * + * @param value Boolean值 + * @return double值 + */ + public static double toDouble(boolean value) { + return toInt(value); + } + + /** + * boolean值转为double + * + * @param value Boolean值 + * @return double值 + */ + public static Double toDoubleObj(boolean value) { + return toDouble(value); + } + + /** + * 将boolean转换为字符串 {@code 'true'} 或者 {@code 'false'}. + * + * 
+	 *   BooleanUtil.toStringTrueFalse(true)   = "true"
+	 *   BooleanUtil.toStringTrueFalse(false)  = "false"
+	 *
+ * + * @param bool Boolean值 + * @return {@code 'true'}, {@code 'false'} + */ + public static String toStringTrueFalse(boolean bool) { + return toString(bool, "true", "false"); + } + + /** + * 将boolean转换为字符串 {@code 'on'} 或者 {@code 'off'}. + * + * 
+	 *   BooleanUtil.toStringOnOff(true)   = "on"
+	 *   BooleanUtil.toStringOnOff(false)  = "off"
+	 *
+ * + * @param bool Boolean值 + * @return {@code 'on'}, {@code 'off'} + */ + public static String toStringOnOff(boolean bool) { + return toString(bool, "on", "off"); + } + + /** + * 将boolean转换为字符串 {@code 'yes'} 或者 {@code 'no'}. + * + * 
+	 *   BooleanUtil.toStringYesNo(true)   = "yes"
+	 *   BooleanUtil.toStringYesNo(false)  = "no"
+	 *
+ * + * @param bool Boolean值 + * @return {@code 'yes'}, {@code 'no'} + */ + public static String toStringYesNo(boolean bool) { + return toString(bool, "yes", "no"); + } + + /** + * 将boolean转换为字符串 + * + * 
+	 *   BooleanUtil.toString(true, "true", "false")   = "true"
+	 *   BooleanUtil.toString(false, "true", "false")  = "false"
+	 *
+ * + * @param bool Boolean值 + * @param trueString 当值为 {@code true}时返回此字符串, 可能为 {@code null} + * @param falseString 当值为 {@code false}时返回此字符串, 可能为 {@code null} + * @return 结果值 + */ + public static String toString(boolean bool, String trueString, String falseString) { + return bool ? trueString : falseString; + } + + /** + * 将boolean转换为字符串 + * + * 
+	 *   BooleanUtil.toString(true, "true", "false", null) = "true"
+	 *   BooleanUtil.toString(false, "true", "false", null) = "false"
+	 *   BooleanUtil.toString(null, "true", "false", null) = null
+	 *
+ * + * @param bool Boolean值 + * @param trueString 当值为 {@code true}时返回此字符串, 可能为 {@code null} + * @param falseString 当值为 {@code false}时返回此字符串, 可能为 {@code null} + * @param nullString 当值为 {@code null}时返回此字符串, 可能为 {@code null} + * @return 结果值 + */ + public static String toString(Boolean bool, String trueString, String falseString, String nullString) { + if (bool == null) { + return nullString; + } + return bool ? trueString : falseString; + } + + /** + * 对Boolean数组取与 + * + * 
+	 *   BooleanUtil.and(true, true)         = true
+	 *   BooleanUtil.and(false, false)       = false
+	 *   BooleanUtil.and(true, false)        = false
+	 *   BooleanUtil.and(true, true, false)  = false
+	 *   BooleanUtil.and(true, true, true)   = true
+	 *
+ * + * @param array {@code Boolean}数组 + * @return 取与为真返回{@code true} + */ + public static boolean and(boolean... array) { + if (ArrayUtil.isEmpty(array)) { + throw new IllegalArgumentException("The Array must not be empty !"); + } + for (final boolean element : array) { + if (false == element) { + return false; + } + } + return true; + } + + /** + * 对Boolean数组取与 + * + * 
+	 *   BooleanUtil.and(Boolean.TRUE, Boolean.TRUE)                 = Boolean.TRUE
+	 *   BooleanUtil.and(Boolean.FALSE, Boolean.FALSE)               = Boolean.FALSE
+	 *   BooleanUtil.and(Boolean.TRUE, Boolean.FALSE)                = Boolean.FALSE
+	 *   BooleanUtil.and(Boolean.TRUE, Boolean.TRUE, Boolean.TRUE)   = Boolean.TRUE
+	 *   BooleanUtil.and(Boolean.FALSE, Boolean.FALSE, Boolean.TRUE) = Boolean.FALSE
+	 *   BooleanUtil.and(Boolean.TRUE, Boolean.FALSE, Boolean.TRUE)  = Boolean.FALSE
+	 *
+ * + * @param array {@code Boolean}数组 + * @return 取与为真返回{@code true} + */ + public static Boolean andOfWrap(Boolean... array) { + if (ArrayUtil.isEmpty(array)) { + throw new IllegalArgumentException("The Array must not be empty !"); + } + + for (final Boolean b : array) { + if(isFalse(b)){ + return false; + } + } + return true; + } + + /** + * 对Boolean数组取或 + * + * 
+	 *   BooleanUtil.or(true, true)          = true
+	 *   BooleanUtil.or(false, false)        = false
+	 *   BooleanUtil.or(true, false)         = true
+	 *   BooleanUtil.or(true, true, false)   = true
+	 *   BooleanUtil.or(true, true, true)    = true
+	 *   BooleanUtil.or(false, false, false) = false
+	 *
+ * + * @param array {@code Boolean}数组 + * @return 取或为真返回{@code true} + */ + public static boolean or(boolean... array) { + if (ArrayUtil.isEmpty(array)) { + throw new IllegalArgumentException("The Array must not be empty !"); + } + for (final boolean element : array) { + if (element) { + return true; + } + } + return false; + } + + /** + * 对Boolean数组取或 + * + * 
+	 *   BooleanUtil.or(Boolean.TRUE, Boolean.TRUE)                  = Boolean.TRUE
+	 *   BooleanUtil.or(Boolean.FALSE, Boolean.FALSE)                = Boolean.FALSE
+	 *   BooleanUtil.or(Boolean.TRUE, Boolean.FALSE)                 = Boolean.TRUE
+	 *   BooleanUtil.or(Boolean.TRUE, Boolean.TRUE, Boolean.TRUE)    = Boolean.TRUE
+	 *   BooleanUtil.or(Boolean.FALSE, Boolean.FALSE, Boolean.TRUE)  = Boolean.TRUE
+	 *   BooleanUtil.or(Boolean.TRUE, Boolean.FALSE, Boolean.TRUE)   = Boolean.TRUE
+	 *   BooleanUtil.or(Boolean.FALSE, Boolean.FALSE, Boolean.FALSE) = Boolean.FALSE
+	 *
+ * + * @param array {@code Boolean}数组 + * @return 取或为真返回{@code true} + */ + public static Boolean orOfWrap(Boolean... array) { + if (ArrayUtil.isEmpty(array)) { + throw new IllegalArgumentException("The Array must not be empty !"); + } + + for (final Boolean b : array) { + if(isTrue(b)){ + return true; + } + } + return false; + } + + /** + * 对Boolean数组取异或 + * + * 
+	 *   BooleanUtil.xor(true, true)   = false
+	 *   BooleanUtil.xor(false, false) = false
+	 *   BooleanUtil.xor(true, false)  = true
+	 *   BooleanUtil.xor(true, true)   = false
+	 *   BooleanUtil.xor(false, false) = false
+	 *   BooleanUtil.xor(true, false)  = true
+	 *
+ * + * @param array {@code boolean}数组 + * @return 如果异或计算为true返回 {@code true} + */ + public static boolean xor(boolean... array) { + if (ArrayUtil.isEmpty(array)) { + throw new IllegalArgumentException("The Array must not be empty"); + } + + boolean result = false; + for (final boolean element : array) { + result ^= element; + } + + return result; + } + + /** + * 对Boolean数组取异或 + * + * 
+	 *   BooleanUtil.xor(new Boolean[] { Boolean.TRUE, Boolean.TRUE })   = Boolean.FALSE
+	 *   BooleanUtil.xor(new Boolean[] { Boolean.FALSE, Boolean.FALSE }) = Boolean.FALSE
+	 *   BooleanUtil.xor(new Boolean[] { Boolean.TRUE, Boolean.FALSE })  = Boolean.TRUE
+	 *
+ * + * @param array {@code Boolean} 数组 + * @return 异或为真取{@code true} + */ + public static Boolean xorOfWrap(Boolean... array) { + if (ArrayUtil.isEmpty(array)) { + throw new IllegalArgumentException("The Array must not be empty !"); + } + final boolean[] primitive = Convert.convert(boolean[].class, array); + return xor(primitive); + } + + /** + * 给定类是否为Boolean或者boolean + * + * @param clazz 类 + * @return 是否为Boolean或者boolean + * @since 4.5.2 + */ + public static boolean isBoolean(Class clazz) { + return (clazz == Boolean.class || clazz == boolean.class); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ByteUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ByteUtil.java new file mode 100644 index 0000000..26d608c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ByteUtil.java @@ -0,0 +1,489 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import java.math.BigDecimal; +import java.math.BigInteger; +import java.nio.ByteOrder; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicLong; +import java.util.concurrent.atomic.DoubleAdder; +import java.util.concurrent.atomic.LongAdder; + +/** + * 对数字和字节进行转换。
+ * 假设数据存储是以大端模式存储的：
+ *
    + *
  • byte: 字节类型 占8位二进制 00000000
    • + *
  • char: 字符类型 占2个字节 16位二进制 byte[0] byte[1]
    • + *
  • int : 整数类型 占4个字节 32位二进制 byte[0] byte[1] byte[2] byte[3]
    • + *
  • long: 长整数类型 占8个字节 64位二进制 byte[0] byte[1] byte[2] byte[3] byte[4] byte[5]
    • + *
  • long: 长整数类型 占8个字节 64位二进制 byte[0] byte[1] byte[2] byte[3] byte[4] byte[5] byte[6] byte[7]
    • + *
  • float: 浮点数(小数) 占4个字节 32位二进制 byte[0] byte[1] byte[2] byte[3]
    • + *
  • double: 双精度浮点数(小数) 占8个字节 64位二进制 byte[0] byte[1] byte[2] byte[3] byte[4]byte[5] byte[6] byte[7]
    • + *
+ * 注：注释来自Hanlp，代码提供来自pr#1492@Github + * + * @author looly, hanlp, FULaBUla + * @since 5.6.3 + */ +public class ByteUtil { + + public static final ByteOrder DEFAULT_ORDER = ByteOrder.LITTLE_ENDIAN; + /** + * CPU的字节序 + */ + public static final ByteOrder CPU_ENDIAN = "little".equals(System.getProperty("sun.cpu.endian")) ? ByteOrder.LITTLE_ENDIAN : ByteOrder.BIG_ENDIAN; + + /** + * int转byte + * + * @param intValue int值 + * @return byte值 + */ + public static byte intToByte(int intValue) { + return (byte) intValue; + } + + /** + * byte转无符号int + * + * @param byteValue byte值 + * @return 无符号int值 + * @since 3.2.0 + */ + public static int byteToUnsignedInt(byte byteValue) { + // Java 总是把 byte 当做有符处理；我们可以通过将其和 0xFF 进行二进制与得到它的无符值 + return byteValue & 0xFF; + } + + /** + * byte数组转short
+ * 默认以小端序转换 + * + * @param bytes byte数组 + * @return short值 + */ + public static short bytesToShort(byte[] bytes) { + return bytesToShort(bytes, DEFAULT_ORDER); + } + + /** + * byte数组转short
+ * 自定义端序 + * + * @param bytes byte数组，长度必须为2 + * @param byteOrder 端序 + * @return short值 + */ + public static short bytesToShort(final byte[] bytes, final ByteOrder byteOrder) { + return bytesToShort(bytes, 0, byteOrder); + } + + /** + * byte数组转short
+ * 自定义端序 + * + * @param bytes byte数组，长度必须大于2 + * @param start 开始位置 + * @param byteOrder 端序 + * @return short值 + */ + public static short bytesToShort(final byte[] bytes, final int start, final ByteOrder byteOrder) { + if (ByteOrder.LITTLE_ENDIAN == byteOrder) { + //小端模式，数据的高字节保存在内存的高地址中，而数据的低字节保存在内存的低地址中 + return (short) (bytes[start] & 0xff | (bytes[start + 1] & 0xff) << Byte.SIZE); + } else { + return (short) (bytes[start + 1] & 0xff | (bytes[start] & 0xff) << Byte.SIZE); + } + } + + /** + * short转byte数组
+ * 默认以小端序转换 + * + * @param shortValue short值 + * @return byte数组 + */ + public static byte[] shortToBytes(short shortValue) { + return shortToBytes(shortValue, DEFAULT_ORDER); + } + + /** + * short转byte数组
+ * 自定义端序 + * + * @param shortValue short值 + * @param byteOrder 端序 + * @return byte数组 + */ + public static byte[] shortToBytes(short shortValue, ByteOrder byteOrder) { + byte[] b = new byte[Short.BYTES]; + if (ByteOrder.LITTLE_ENDIAN == byteOrder) { + b[0] = (byte) (shortValue & 0xff); + b[1] = (byte) ((shortValue >> Byte.SIZE) & 0xff); + } else { + b[1] = (byte) (shortValue & 0xff); + b[0] = (byte) ((shortValue >> Byte.SIZE) & 0xff); + } + return b; + } + + /** + * byte[]转int值
+ * 默认以小端序转换 + * + * @param bytes byte数组 + * @return int值 + */ + public static int bytesToInt(byte[] bytes) { + return bytesToInt(bytes, DEFAULT_ORDER); + } + + /** + * byte[]转int值
+ * 自定义端序 + * + * @param bytes byte数组 + * @param byteOrder 端序 + * @return int值 + */ + public static int bytesToInt(byte[] bytes, ByteOrder byteOrder) { + return bytesToInt(bytes, 0, byteOrder); + } + + /** + * byte[]转int值
+ * 自定义端序 + * + * @param bytes byte数组 + * @param start 开始位置（包含） + * @param byteOrder 端序 + * @return int值 + * @since 5.7.21 + */ + public static int bytesToInt(byte[] bytes, int start, ByteOrder byteOrder) { + if (ByteOrder.LITTLE_ENDIAN == byteOrder) { + return bytes[start] & 0xFF | // + (bytes[1 + start] & 0xFF) << 8 | // + (bytes[2 + start] & 0xFF) << 16 | // + (bytes[3 + start] & 0xFF) << 24; // + } else { + return bytes[3 + start] & 0xFF | // + (bytes[2 + start] & 0xFF) << 8 | // + (bytes[1 + start] & 0xFF) << 16 | // + (bytes[start] & 0xFF) << 24; // + } + + } + + /** + * int转byte数组
+ * 默认以小端序转换 + * + * @param intValue int值 + * @return byte数组 + */ + public static byte[] intToBytes(int intValue) { + return intToBytes(intValue, DEFAULT_ORDER); + } + + /** + * int转byte数组
+ * 自定义端序 + * + * @param intValue int值 + * @param byteOrder 端序 + * @return byte数组 + */ + public static byte[] intToBytes(int intValue, ByteOrder byteOrder) { + + if (ByteOrder.LITTLE_ENDIAN == byteOrder) { + return new byte[]{ // + (byte) (intValue & 0xFF), // + (byte) ((intValue >> 8) & 0xFF), // + (byte) ((intValue >> 16) & 0xFF), // + (byte) ((intValue >> 24) & 0xFF) // + }; + + } else { + return new byte[]{ // + (byte) ((intValue >> 24) & 0xFF), // + (byte) ((intValue >> 16) & 0xFF), // + (byte) ((intValue >> 8) & 0xFF), // + (byte) (intValue & 0xFF) // + }; + } + + } + + /** + * long转byte数组
+ * 默认以小端序转换
+ * from: https://stackoverflow.com/questions/4485128/how-do-i-convert-long-to-byte-and-back-in-java + * + * @param longValue long值 + * @return byte数组 + */ + public static byte[] longToBytes(long longValue) { + return longToBytes(longValue, DEFAULT_ORDER); + } + + /** + * long转byte数组
+ * 自定义端序
+ * from: https://stackoverflow.com/questions/4485128/how-do-i-convert-long-to-byte-and-back-in-java + * + * @param longValue long值 + * @param byteOrder 端序 + * @return byte数组 + */ + public static byte[] longToBytes(long longValue, ByteOrder byteOrder) { + byte[] result = new byte[Long.BYTES]; + if (ByteOrder.LITTLE_ENDIAN == byteOrder) { + for (int i = 0; i < result.length; i++) { + result[i] = (byte) (longValue & 0xFF); + longValue >>= Byte.SIZE; + } + } else { + for (int i = (result.length - 1); i >= 0; i--) { + result[i] = (byte) (longValue & 0xFF); + longValue >>= Byte.SIZE; + } + } + return result; + } + + /** + * byte数组转long
+ * 默认以小端序转换
+ * from: https://stackoverflow.com/questions/4485128/how-do-i-convert-long-to-byte-and-back-in-java + * + * @param bytes byte数组 + * @return long值 + */ + public static long bytesToLong(byte[] bytes) { + return bytesToLong(bytes, DEFAULT_ORDER); + } + + /** + * byte数组转long
+ * 自定义端序
+ * from: https://stackoverflow.com/questions/4485128/how-do-i-convert-long-to-byte-and-back-in-java + * + * @param bytes byte数组 + * @param byteOrder 端序 + * @return long值 + */ + public static long bytesToLong(byte[] bytes, ByteOrder byteOrder) { + return bytesToLong(bytes, 0, byteOrder); + } + + /** + * byte数组转long
+ * 自定义端序
+ * from: https://stackoverflow.com/questions/4485128/how-do-i-convert-long-to-byte-and-back-in-java + * + * @param bytes byte数组 + * @param start 计算数组开始位置 + * @param byteOrder 端序 + * @return long值 + * @since 5.7.21 + */ + public static long bytesToLong(byte[] bytes, int start, ByteOrder byteOrder) { + long values = 0; + if (ByteOrder.LITTLE_ENDIAN == byteOrder) { + for (int i = (Long.BYTES - 1); i >= 0; i--) { + values <<= Byte.SIZE; + values |= (bytes[i + start] & 0xff); + } + } else { + for (int i = 0; i < Long.BYTES; i++) { + values <<= Byte.SIZE; + values |= (bytes[i + start] & 0xff); + } + } + + return values; + } + + /** + * float转byte数组，默认以小端序转换
+ * + * @param floatValue float值 + * @return byte数组 + * @since 5.7.18 + */ + public static byte[] floatToBytes(float floatValue) { + return floatToBytes(floatValue, DEFAULT_ORDER); + } + + /** + * float转byte数组，自定义端序
+ * + * @param floatValue float值 + * @param byteOrder 端序 + * @return byte数组 + * @since 5.7.18 + */ + public static byte[] floatToBytes(float floatValue, ByteOrder byteOrder) { + return intToBytes(Float.floatToIntBits(floatValue), byteOrder); + } + + /** + * byte数组转float
+ * 默认以小端序转换
+ * + * @param bytes byte数组 + * @return float值 + * @since 5.7.18 + */ + public static float bytesToFloat(byte[] bytes) { + return bytesToFloat(bytes, DEFAULT_ORDER); + } + + /** + * byte数组转float
+ * 自定义端序
+ * + * @param bytes byte数组 + * @param byteOrder 端序 + * @return float值 + * @since 5.7.18 + */ + public static float bytesToFloat(byte[] bytes, ByteOrder byteOrder) { + return Float.intBitsToFloat(bytesToInt(bytes, byteOrder)); + } + + /** + * double转byte数组
+ * 默认以小端序转换
+ * + * @param doubleValue double值 + * @return byte数组 + */ + public static byte[] doubleToBytes(double doubleValue) { + return doubleToBytes(doubleValue, DEFAULT_ORDER); + } + + /** + * double转byte数组
+ * 自定义端序
+ * from: https://stackoverflow.com/questions/4485128/how-do-i-convert-long-to-byte-and-back-in-java + * + * @param doubleValue double值 + * @param byteOrder 端序 + * @return byte数组 + */ + public static byte[] doubleToBytes(double doubleValue, ByteOrder byteOrder) { + return longToBytes(Double.doubleToLongBits(doubleValue), byteOrder); + } + + /** + * byte数组转Double
+ * 默认以小端序转换
+ * + * @param bytes byte数组 + * @return long值 + */ + public static double bytesToDouble(byte[] bytes) { + return bytesToDouble(bytes, DEFAULT_ORDER); + } + + /** + * byte数组转double
+ * 自定义端序
+ * + * @param bytes byte数组 + * @param byteOrder 端序 + * @return long值 + */ + public static double bytesToDouble(byte[] bytes, ByteOrder byteOrder) { + return Double.longBitsToDouble(bytesToLong(bytes, byteOrder)); + } + + /** + * 将{@link Number}转换为 + * + * @param number 数字 + * @return bytes + */ + public static byte[] numberToBytes(Number number) { + return numberToBytes(number, DEFAULT_ORDER); + } + + /** + * 将{@link Number}转换为 + * + * @param number 数字 + * @param byteOrder 端序 + * @return bytes + */ + public static byte[] numberToBytes(Number number, ByteOrder byteOrder) { + if(number instanceof Byte){ + return new byte[]{number.byteValue()}; + }else if (number instanceof Double) { + return doubleToBytes((Double) number, byteOrder); + } else if (number instanceof Long) { + return longToBytes((Long) number, byteOrder); + } else if (number instanceof Integer) { + return intToBytes((Integer) number, byteOrder); + } else if (number instanceof Short) { + return shortToBytes((Short) number, byteOrder); + } else if (number instanceof Float) { + return floatToBytes((Float) number, byteOrder); + } else { + return doubleToBytes(number.doubleValue(), byteOrder); + } + } + + /** + * byte数组转换为指定类型数字 + * + * @param 数字类型 + * @param bytes byte数组 + * @param targetClass 目标数字类型 + * @param byteOrder 端序 + * @return 转换后的数字 + * @throws IllegalArgumentException 不支持的数字类型，如用户自定义数字类型 + */ + @SuppressWarnings("unchecked") + public static T bytesToNumber(byte[] bytes, Class targetClass, ByteOrder byteOrder) throws IllegalArgumentException { + Number number; + if (Byte.class == targetClass) { + number = bytes[0]; + } else if (Short.class == targetClass) { + number = bytesToShort(bytes, byteOrder); + } else if (Integer.class == targetClass) { + number = bytesToInt(bytes, byteOrder); + } else if (AtomicInteger.class == targetClass) { + number = new AtomicInteger(bytesToInt(bytes, byteOrder)); + } else if (Long.class == targetClass) { + number = bytesToLong(bytes, byteOrder); + } else if (AtomicLong.class == targetClass) { + number = new AtomicLong(bytesToLong(bytes, byteOrder)); + } else if (LongAdder.class == targetClass) { + final LongAdder longValue = new LongAdder(); + longValue.add(bytesToLong(bytes, byteOrder)); + number = longValue; + } else if (Float.class == targetClass) { + number = bytesToFloat(bytes, byteOrder); + } else if (Double.class == targetClass) { + number = bytesToDouble(bytes, byteOrder); + } else if (DoubleAdder.class == targetClass) { + final DoubleAdder doubleAdder = new DoubleAdder(); + doubleAdder.add(bytesToDouble(bytes, byteOrder)); + number = doubleAdder; + } else if (BigDecimal.class == targetClass) { + number = NumberUtil.toBigDecimal(bytesToDouble(bytes, byteOrder)); + } else if (BigInteger.class == targetClass) { + number = BigInteger.valueOf(bytesToLong(bytes, byteOrder)); + } else if (Number.class == targetClass) { + // 用户没有明确类型具体类型，默认Double + number = bytesToDouble(bytes, byteOrder); + } else { + // 用户自定义类型不支持 + throw new IllegalArgumentException("Unsupported Number type: " + targetClass.getName()); + } + + return (T) number; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/CharUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/CharUtil.java new file mode 100644 index 0000000..abe07d7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/CharUtil.java @@ -0,0 +1,391 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.text.ASCIIStrCache; +import aiyh.utils.tool.cn.hutool.core.text.CharPool; + +/** + * 字符工具类
+ * 部分工具来自于Apache Commons系列 + * + * @author looly + * @since 4.0.1 + */ +public class CharUtil implements CharPool { + + /** + * 是否为ASCII字符，ASCII字符位于0~127之间 + * + * 
+	 *   CharUtil.isAscii('a')  = true
+	 *   CharUtil.isAscii('A')  = true
+	 *   CharUtil.isAscii('3')  = true
+	 *   CharUtil.isAscii('-')  = true
+	 *   CharUtil.isAscii('\n') = true
+	 *   CharUtil.isAscii('©') = false
+	 *
+ * + * @param ch 被检查的字符处 + * @return true表示为ASCII字符，ASCII字符位于0~127之间 + */ + public static boolean isAscii(char ch) { + return ch < 128; + } + + /** + * 是否为可见ASCII字符，可见字符位于32~126之间 + * + * 
+	 *   CharUtil.isAsciiPrintable('a')  = true
+	 *   CharUtil.isAsciiPrintable('A')  = true
+	 *   CharUtil.isAsciiPrintable('3')  = true
+	 *   CharUtil.isAsciiPrintable('-')  = true
+	 *   CharUtil.isAsciiPrintable('\n') = false
+	 *   CharUtil.isAsciiPrintable('©') = false
+	 *
+ * + * @param ch 被检查的字符处 + * @return true表示为ASCII可见字符，可见字符位于32~126之间 + */ + public static boolean isAsciiPrintable(char ch) { + return ch >= 32 && ch < 127; + } + + /** + * 是否为ASCII控制符（不可见字符），控制符位于0~31和127 + * + * 
+	 *   CharUtil.isAsciiControl('a')  = false
+	 *   CharUtil.isAsciiControl('A')  = false
+	 *   CharUtil.isAsciiControl('3')  = false
+	 *   CharUtil.isAsciiControl('-')  = false
+	 *   CharUtil.isAsciiControl('\n') = true
+	 *   CharUtil.isAsciiControl('©') = false
+	 *
+ * + * @param ch 被检查的字符 + * @return true表示为控制符，控制符位于0~31和127 + */ + public static boolean isAsciiControl(final char ch) { + return ch < 32 || ch == 127; + } + + /** + * 判断是否为字母（包括大写字母和小写字母）
+ * 字母包括A~Z和a~z + * + * 
+	 *   CharUtil.isLetter('a')  = true
+	 *   CharUtil.isLetter('A')  = true
+	 *   CharUtil.isLetter('3')  = false
+	 *   CharUtil.isLetter('-')  = false
+	 *   CharUtil.isLetter('\n') = false
+	 *   CharUtil.isLetter('©') = false
+	 *
+ * + * @param ch 被检查的字符 + * @return true表示为字母（包括大写字母和小写字母）字母包括A~Z和a~z + */ + public static boolean isLetter(char ch) { + return isLetterUpper(ch) || isLetterLower(ch); + } + + /** + *

+ * 判断是否为大写字母，大写字母包括A~Z + *

+ * + * 
+	 *   CharUtil.isLetterUpper('a')  = false
+	 *   CharUtil.isLetterUpper('A')  = true
+	 *   CharUtil.isLetterUpper('3')  = false
+	 *   CharUtil.isLetterUpper('-')  = false
+	 *   CharUtil.isLetterUpper('\n') = false
+	 *   CharUtil.isLetterUpper('©') = false
+	 *
+ * + * @param ch 被检查的字符 + * @return true表示为大写字母，大写字母包括A~Z + */ + public static boolean isLetterUpper(final char ch) { + return ch >= 'A' && ch <= 'Z'; + } + + /** + *

+ * 检查字符是否为小写字母，小写字母指a~z + *

+ * + * 
+	 *   CharUtil.isLetterLower('a')  = true
+	 *   CharUtil.isLetterLower('A')  = false
+	 *   CharUtil.isLetterLower('3')  = false
+	 *   CharUtil.isLetterLower('-')  = false
+	 *   CharUtil.isLetterLower('\n') = false
+	 *   CharUtil.isLetterLower('©') = false
+	 *
+ * + * @param ch 被检查的字符 + * @return true表示为小写字母，小写字母指a~z + */ + public static boolean isLetterLower(final char ch) { + return ch >= 'a' && ch <= 'z'; + } + + /** + *

+ * 检查是否为数字字符，数字字符指0~9 + *

+ * + * 
+	 *   CharUtil.isNumber('a')  = false
+	 *   CharUtil.isNumber('A')  = false
+	 *   CharUtil.isNumber('3')  = true
+	 *   CharUtil.isNumber('-')  = false
+	 *   CharUtil.isNumber('\n') = false
+	 *   CharUtil.isNumber('©') = false
+	 *
+ * + * @param ch 被检查的字符 + * @return true表示为数字字符，数字字符指0~9 + */ + public static boolean isNumber(char ch) { + return ch >= '0' && ch <= '9'; + } + + /** + * 是否为16进制规范的字符，判断是否为如下字符 + * 
+	 * 1. 0~9
+	 * 2. a~f
+	 * 4. A~F
+	 *
+ * + * @param c 字符 + * @return 是否为16进制规范的字符 + * @since 4.1.5 + */ + public static boolean isHexChar(char c) { + return isNumber(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'); + } + + /** + * 是否为字母或数字，包括A~Z、a~z、0~9 + * + * 
+	 *   CharUtil.isLetterOrNumber('a')  = true
+	 *   CharUtil.isLetterOrNumber('A')  = true
+	 *   CharUtil.isLetterOrNumber('3')  = true
+	 *   CharUtil.isLetterOrNumber('-')  = false
+	 *   CharUtil.isLetterOrNumber('\n') = false
+	 *   CharUtil.isLetterOrNumber('©') = false
+	 *
+ * + * @param ch 被检查的字符 + * @return true表示为字母或数字，包括A~Z、a~z、0~9 + */ + public static boolean isLetterOrNumber(final char ch) { + return isLetter(ch) || isNumber(ch); + } + + /** + * 字符转为字符串
+ * 如果为ASCII字符，使用缓存 + * + * @param c 字符 + * @return 字符串 + * @see ASCIIStrCache#toString(char) + */ + public static String toString(char c) { + return ASCIIStrCache.toString(c); + } + + /** + * 给定类名是否为字符类，字符类包括： + * + * 
+	 * Character.class
+	 * char.class
+	 *
+ * + * @param clazz 被检查的类 + * @return true表示为字符类 + */ + public static boolean isCharClass(Class clazz) { + return clazz == Character.class || clazz == char.class; + } + + /** + * 给定对象对应的类是否为字符类，字符类包括： + * + * 
+	 * Character.class
+	 * char.class
+	 *
+ * + * @param value 被检查的对象 + * @return true表示为字符类 + */ + public static boolean isChar(Object value) { + //noinspection ConstantConditions + return value instanceof Character || value.getClass() == char.class; + } + + /** + * 是否空白符
+ * 空白符包括空格、制表符、全角空格和不间断空格
+ * + * @param c 字符 + * @return 是否空白符 + * @see Character#isWhitespace(int) + * @see Character#isSpaceChar(int) + * @since 4.0.10 + */ + public static boolean isBlankChar(char c) { + return isBlankChar((int) c); + } + + /** + * 是否空白符
+ * 空白符包括空格、制表符、全角空格和不间断空格
+ * + * @param c 字符 + * @return 是否空白符 + * @see Character#isWhitespace(int) + * @see Character#isSpaceChar(int) + * @since 4.0.10 + */ + public static boolean isBlankChar(int c) { + return Character.isWhitespace(c) + || Character.isSpaceChar(c) + || c == '\ufeff' + || c == '\u202a' + || c == '\u0000' + // issue#I5UGSQ，Hangul Filler + || c == '\u3164' + // Braille Pattern Blank + || c == '\u2800' + // MONGOLIAN VOWEL SEPARATOR + || c == '\u180e'; + } + + /** + * 判断是否为emoji表情符
+ * + * @param c 字符 + * @return 是否为emoji + * @since 4.0.8 + */ + public static boolean isEmoji(char c) { + //noinspection ConstantConditions + return false == ((c == 0x0) || // + (c == 0x9) || // + (c == 0xA) || // + (c == 0xD) || // + ((c >= 0x20) && (c <= 0xD7FF)) || // + ((c >= 0xE000) && (c <= 0xFFFD)) || // + ((c >= 0x100000) && (c <= 0x10FFFF))); + } + + /** + * 是否为Windows或者Linux（Unix）文件分隔符
+ * Windows平台下分隔符为\，Linux（Unix）为/ + * + * @param c 字符 + * @return 是否为Windows或者Linux（Unix）文件分隔符 + * @since 4.1.11 + */ + public static boolean isFileSeparator(char c) { + return SLASH == c || BACKSLASH == c; + } + + /** + * 比较两个字符是否相同 + * + * @param c1 字符1 + * @param c2 字符2 + * @param caseInsensitive 是否忽略大小写 + * @return 是否相同 + * @since 4.0.3 + */ + public static boolean equals(char c1, char c2, boolean caseInsensitive) { + if (caseInsensitive) { + return Character.toLowerCase(c1) == Character.toLowerCase(c2); + } + return c1 == c2; + } + + /** + * 获取字符类型 + * + * @param c 字符 + * @return 字符类型 + * @since 5.2.3 + */ + public static int getType(int c) { + return Character.getType(c); + } + + /** + * 获取给定字符的16进制数值 + * + * @param b 字符 + * @return 16进制字符 + * @since 5.3.1 + */ + public static int digit16(int b) { + return Character.digit(b, 16); + } + + /** + * 将字母、数字转换为带圈的字符： + * 
+	 *     '1' -》 '①'
+	 *     'A' -》 'Ⓐ'
+	 *     'a' -》 'ⓐ'
+	 *
+ *

+ * 获取带圈数字 /封闭式字母数字 ，从1-20,超过1-20报错 + * + * @param c 被转换的字符，如果字符不支持转换，返回原字符 + * @return 转换后的字符 + * @see Unicode_symbols + * @see Alphanumerics + * @since 5.6.2 + */ + public static char toCloseChar(char c) { + int result = c; + if (c >= '1' && c <= '9') { + result = '①' + c - '1'; + } else if (c >= 'A' && c <= 'Z') { + result = 'Ⓐ' + c - 'A'; + } else if (c >= 'a' && c <= 'z') { + result = 'ⓐ' + c - 'a'; + } + return (char) result; + } + + /** + * 将[1-20]数字转换为带圈的字符： + * 

+	 *     1 -》 '①'
+	 *     12 -》 '⑫'
+	 *     20 -》 '⑳'
+	 *
+ * 也称作：封闭式字符，英文：Enclosed Alphanumerics + * + * @param number 被转换的数字 + * @return 转换后的字符 + * @author dazer + * @see 维基百科wikipedia-Unicode_symbols + * @see 维基百科wikipedia-Unicode字符列表 + * @see coolsymbol + * @see 百度百科 特殊字符 + * @since 5.6.2 + */ + public static char toCloseByNumber(int number) { + if (number > 20) { + throw new IllegalArgumentException("Number must be [1-20]"); + } + return (char) ('①' + number - 1); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/CharsetUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/CharsetUtil.java new file mode 100644 index 0000000..1af95a6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/CharsetUtil.java @@ -0,0 +1,226 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.io.CharsetDetector; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; + +import java.io.File; +import java.io.InputStream; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.nio.charset.UnsupportedCharsetException; + +/** + * 字符集工具类 + * + * @author xiaoleilu + */ +public class CharsetUtil { + + /** + * ISO-8859-1 + */ + public static final String ISO_8859_1 = "ISO-8859-1"; + /** + * UTF-8 + */ + public static final String UTF_8 = "UTF-8"; + /** + * GBK + */ + public static final String GBK = "GBK"; + + /** + * ISO-8859-1 + */ + public static final Charset CHARSET_ISO_8859_1 = StandardCharsets.ISO_8859_1; + /** + * UTF-8 + */ + public static final Charset CHARSET_UTF_8 = StandardCharsets.UTF_8; + /** + * GBK + */ + public static final Charset CHARSET_GBK; + + static { + //避免不支持GBK的系统中运行报错 issue#731 + Charset _CHARSET_GBK = null; + try { + _CHARSET_GBK = Charset.forName(GBK); + } catch (UnsupportedCharsetException e) { + //ignore + } + CHARSET_GBK = _CHARSET_GBK; + } + + /** + * 转换为Charset对象 + * + * @param charsetName 字符集，为空则返回默认字符集 + * @return Charset + * @throws UnsupportedCharsetException 编码不支持 + */ + public static Charset charset(String charsetName) throws UnsupportedCharsetException { + return StrUtil.isBlank(charsetName) ? Charset.defaultCharset() : Charset.forName(charsetName); + } + + /** + * 解析字符串编码为Charset对象，解析失败返回系统默认编码 + * + * @param charsetName 字符集，为空则返回默认字符集 + * @return Charset + * @since 5.2.6 + */ + public static Charset parse(String charsetName) { + return parse(charsetName, Charset.defaultCharset()); + } + + /** + * 解析字符串编码为Charset对象，解析失败返回默认编码 + * + * @param charsetName 字符集，为空则返回默认字符集 + * @param defaultCharset 解析失败使用的默认编码 + * @return Charset + * @since 5.2.6 + */ + public static Charset parse(String charsetName, Charset defaultCharset) { + if (StrUtil.isBlank(charsetName)) { + return defaultCharset; + } + + Charset result; + try { + result = Charset.forName(charsetName); + } catch (UnsupportedCharsetException e) { + result = defaultCharset; + } + + return result; + } + + /** + * 转换字符串的字符集编码 + * + * @param source 字符串 + * @param srcCharset 源字符集，默认ISO-8859-1 + * @param destCharset 目标字符集，默认UTF-8 + * @return 转换后的字符集 + */ + public static String convert(String source, String srcCharset, String destCharset) { + return convert(source, Charset.forName(srcCharset), Charset.forName(destCharset)); + } + + /** + * 转换字符串的字符集编码
+ * 当以错误的编码读取为字符串时，打印字符串将出现乱码。
+ * 此方法用于纠正因读取使用编码错误导致的乱码问题。
+ * 例如，在Servlet请求中客户端用GBK编码了请求参数，我们使用UTF-8读取到的是乱码，此时，使用此方法即可还原原编码的内容 + * 
+	 * 客户端 -》 GBK编码 -》 Servlet容器 -》 UTF-8解码 -》 乱码
+	 * 乱码 -》 UTF-8编码 -》 GBK解码 -》 正确内容
+	 *
+ * + * @param source 字符串 + * @param srcCharset 源字符集，默认ISO-8859-1 + * @param destCharset 目标字符集，默认UTF-8 + * @return 转换后的字符集 + */ + public static String convert(String source, Charset srcCharset, Charset destCharset) { + if (null == srcCharset) { + srcCharset = StandardCharsets.ISO_8859_1; + } + + if (null == destCharset) { + destCharset = StandardCharsets.UTF_8; + } + + if (StrUtil.isBlank(source) || srcCharset.equals(destCharset)) { + return source; + } + return new String(source.getBytes(srcCharset), destCharset); + } + + /** + * 转换文件编码
+ * 此方法用于转换文件编码，读取的文件实际编码必须与指定的srcCharset编码一致，否则导致乱码 + * + * @param file 文件 + * @param srcCharset 原文件的编码，必须与文件内容的编码保持一致 + * @param destCharset 转码后的编码 + * @return 被转换编码的文件 + * @since 3.1.0 + */ + public static File convert(File file, Charset srcCharset, Charset destCharset) { + final String str = FileUtil.readString(file, srcCharset); + return FileUtil.writeString(str, file, destCharset); + } + + /** + * 系统字符集编码，如果是Windows，则默认为GBK编码，否则取 {@link CharsetUtil#defaultCharsetName()} + * + * @return 系统字符集编码 + * @see CharsetUtil#defaultCharsetName() + * @since 3.1.2 + */ + public static String systemCharsetName() { + return systemCharset().name(); + } + + /** + * 系统字符集编码，如果是Windows，则默认为GBK编码，否则取 {@link CharsetUtil#defaultCharsetName()} + * + * @return 系统字符集编码 + * @see CharsetUtil#defaultCharsetName() + * @since 3.1.2 + */ + public static Charset systemCharset() { + return FileUtil.isWindows() ? CHARSET_GBK : defaultCharset(); + } + + /** + * 系统默认字符集编码 + * + * @return 系统字符集编码 + */ + public static String defaultCharsetName() { + return defaultCharset().name(); + } + + /** + * 系统默认字符集编码 + * + * @return 系统字符集编码 + */ + public static Charset defaultCharset() { + return Charset.defaultCharset(); + } + + /** + * 探测编码
+ * 注意：此方法会读取流的一部分，然后关闭流，如重复使用流，请使用使用支持reset方法的流 + * + * @param in 流，使用后关闭此流 + * @param charsets 需要测试用的编码，null或空使用默认的编码数组 + * @return 编码 + * @see CharsetDetector#detect(InputStream, Charset...) + * @since 5.7.10 + */ + public static Charset defaultCharset(InputStream in, Charset... charsets) { + return CharsetDetector.detect(in, charsets); + } + + /** + * 探测编码
+ * 注意：此方法会读取流的一部分，然后关闭流，如重复使用流，请使用使用支持reset方法的流 + * + * @param bufferSize 自定义缓存大小，即每次检查的长度 + * @param in 流，使用后关闭此流 + * @param charsets 需要测试用的编码，null或空使用默认的编码数组 + * @return 编码 + * @see CharsetDetector#detect(int, InputStream, Charset...) + * @since 5.7.10 + */ + public static Charset defaultCharset(int bufferSize, InputStream in, Charset... charsets) { + return CharsetDetector.detect(bufferSize, in, charsets); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ClassLoaderUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ClassLoaderUtil.java new file mode 100755 index 0000000..6d438d1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ClassLoaderUtil.java @@ -0,0 +1,344 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.convert.BasicType; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.JarClassLoader; +import aiyh.utils.tool.cn.hutool.core.map.SafeConcurrentHashMap; +import aiyh.utils.tool.cn.hutool.core.text.CharPool; + +import java.io.File; +import java.lang.reflect.Array; +import java.security.AccessController; +import java.security.PrivilegedAction; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +/** + * {@link ClassLoader}工具类 + * + * @author Looly + * @since 3.0.9 + */ +public class ClassLoaderUtil { + + /** + * 数组类的结尾符: "[]" + */ + private static final String ARRAY_SUFFIX = "[]"; + /** + * 内部数组类名前缀: "[" + */ + private static final String INTERNAL_ARRAY_PREFIX = "["; + /** + * 内部非原始类型类名前缀: "[L" + */ + private static final String NON_PRIMITIVE_ARRAY_PREFIX = "[L"; + /** + * 包名分界符: '.' + */ + private static final char PACKAGE_SEPARATOR = StrUtil.C_DOT; + /** + * 内部类分界符: '$' + */ + private static final char INNER_CLASS_SEPARATOR = '$'; + + /** + * 原始类型名和其class对应表，例如：int =》 int.class + */ + private static final Map> PRIMITIVE_TYPE_NAME_MAP = new SafeConcurrentHashMap<>(32); + + static { + final List> primitiveTypes = new ArrayList<>(32); + // 加入原始类型 + primitiveTypes.addAll(BasicType.PRIMITIVE_WRAPPER_MAP.keySet()); + // 加入原始类型数组类型 + primitiveTypes.add(boolean[].class); + primitiveTypes.add(byte[].class); + primitiveTypes.add(char[].class); + primitiveTypes.add(double[].class); + primitiveTypes.add(float[].class); + primitiveTypes.add(int[].class); + primitiveTypes.add(long[].class); + primitiveTypes.add(short[].class); + primitiveTypes.add(void.class); + for (final Class primitiveType : primitiveTypes) { + PRIMITIVE_TYPE_NAME_MAP.put(primitiveType.getName(), primitiveType); + } + } + + /** + * 获取当前线程的{@link ClassLoader} + * + * @return 当前线程的class loader + * @see Thread#getContextClassLoader() + */ + public static ClassLoader getContextClassLoader() { + if (System.getSecurityManager() == null) { + return Thread.currentThread().getContextClassLoader(); + } else { + // 绕开权限检查 + return AccessController.doPrivileged( + (PrivilegedAction) () -> Thread.currentThread().getContextClassLoader()); + } + } + + /** + * 获取系统{@link ClassLoader} + * + * @return 系统{@link ClassLoader} + * @see ClassLoader#getSystemClassLoader() + * @since 5.7.0 + */ + public static ClassLoader getSystemClassLoader() { + if (System.getSecurityManager() == null) { + return ClassLoader.getSystemClassLoader(); + } else { + // 绕开权限检查 + return AccessController.doPrivileged( + (PrivilegedAction) ClassLoader::getSystemClassLoader); + } + } + + + /** + * 获取{@link ClassLoader}
+ * 获取顺序如下：
+ * + * 
+	 * 1、获取当前线程的ContextClassLoader
+	 * 2、获取当前类对应的ClassLoader
+	 * 3、获取系统ClassLoader（{@link ClassLoader#getSystemClassLoader()}）
+	 *
+ * + * @return 类加载器 + */ + public static ClassLoader getClassLoader() { + ClassLoader classLoader = getContextClassLoader(); + if (classLoader == null) { + classLoader = ClassLoaderUtil.class.getClassLoader(); + if (null == classLoader) { + classLoader = getSystemClassLoader(); + } + } + return classLoader; + } + + // ----------------------------------------------------------------------------------- loadClass + + /** + * 加载类，通过传入类的字符串，返回其对应的类名，使用默认ClassLoader并初始化类（调用static模块内容和初始化static属性）
+ * 扩展{@link Class#forName(String, boolean, ClassLoader)}方法，支持以下几类类名的加载： + * + * 
+	 * 1、原始类型，例如：int
+	 * 2、数组类型，例如：int[]、Long[]、String[]
+	 * 3、内部类，例如：java.lang.Thread.State会被转为java.lang.Thread$State加载
+	 *
+ * + * @param name 类名 + * @return 类名对应的类 + * @throws UtilException 包装{@link ClassNotFoundException}，没有类名对应的类时抛出此异常 + */ + public static Class loadClass(String name) throws UtilException { + return loadClass(name, true); + } + + /** + * 加载类，通过传入类的字符串，返回其对应的类名，使用默认ClassLoader
+ * 扩展{@link Class#forName(String, boolean, ClassLoader)}方法，支持以下几类类名的加载： + * + * 
+	 * 1、原始类型，例如：int
+	 * 2、数组类型，例如：int[]、Long[]、String[]
+	 * 3、内部类，例如：java.lang.Thread.State会被转为java.lang.Thread$State加载
+	 *
+ * + * @param name 类名 + * @param isInitialized 是否初始化类（调用static模块内容和初始化static属性） + * @return 类名对应的类 + * @throws UtilException 包装{@link ClassNotFoundException}，没有类名对应的类时抛出此异常 + */ + public static Class loadClass(String name, boolean isInitialized) throws UtilException { + return loadClass(name, null, isInitialized); + } + + /** + * 加载类，通过传入类的字符串，返回其对应的类名
+ * 此方法支持缓存，第一次被加载的类之后会读取缓存中的类
+ * 加载失败的原因可能是此类不存在或其关联引用类不存在
+ * 扩展{@link Class#forName(String, boolean, ClassLoader)}方法，支持以下几类类名的加载： + * + * 
+	 * 1、原始类型，例如：int
+	 * 2、数组类型，例如：int[]、Long[]、String[]
+	 * 3、内部类，例如：java.lang.Thread.State会被转为java.lang.Thread$State加载
+	 *
+ * + * @param name 类名 + * @param classLoader {@link ClassLoader}，{@code null} 则使用{@link #getClassLoader()}获取 + * @param isInitialized 是否初始化类（调用static模块内容和初始化static属性） + * @return 类名对应的类 + * @throws UtilException 包装{@link ClassNotFoundException}，没有类名对应的类时抛出此异常 + */ + public static Class loadClass(String name, ClassLoader classLoader, boolean isInitialized) throws UtilException { + Assert.notNull(name, "Name must not be null"); + + // 自动将包名中的"/"替换为"." + name = name.replace(CharPool.SLASH, CharPool.DOT); + if(null == classLoader){ + classLoader = getClassLoader(); + } + + // 加载原始类型和缓存中的类 + Class clazz = loadPrimitiveClass(name); + if (clazz == null) { + clazz = doLoadClass(name, classLoader, isInitialized); + } + return clazz; + } + + /** + * 加载原始类型的类。包括原始类型、原始类型数组和void + * + * @param name 原始类型名，比如 int + * @return 原始类型类 + */ + public static Class loadPrimitiveClass(String name) { + Class result = null; + if (StrUtil.isNotBlank(name)) { + name = name.trim(); + if (name.length() <= 8) { + result = PRIMITIVE_TYPE_NAME_MAP.get(name); + } + } + return result; + } + + /** + * 创建新的{@link JarClassLoader}，并使用此Classloader加载目录下的class文件和jar文件 + * + * @param jarOrDir jar文件或者包含jar和class文件的目录 + * @return {@link JarClassLoader} + * @since 4.4.2 + */ + public static JarClassLoader getJarClassLoader(File jarOrDir) { + return JarClassLoader.load(jarOrDir); + } + + /** + * 加载外部类 + * + * @param jarOrDir jar文件或者包含jar和class文件的目录 + * @param name 类名 + * @return 类 + * @since 4.4.2 + */ + public static Class loadClass(File jarOrDir, String name) { + try { + return getJarClassLoader(jarOrDir).loadClass(name); + } catch (ClassNotFoundException e) { + throw new UtilException(e); + } + } + + // ----------------------------------------------------------------------------------- isPresent + + /** + * 指定类是否被提供，使用默认ClassLoader
+ * 通过调用{@link #loadClass(String, ClassLoader, boolean)}方法尝试加载指定类名的类，如果加载失败返回false
+ * 加载失败的原因可能是此类不存在或其关联引用类不存在 + * + * @param className 类名 + * @return 是否被提供 + */ + public static boolean isPresent(String className) { + return isPresent(className, null); + } + + /** + * 指定类是否被提供
+ * 通过调用{@link #loadClass(String, ClassLoader, boolean)}方法尝试加载指定类名的类，如果加载失败返回false
+ * 加载失败的原因可能是此类不存在或其关联引用类不存在 + * + * @param className 类名 + * @param classLoader {@link ClassLoader} + * @return 是否被提供 + */ + public static boolean isPresent(String className, ClassLoader classLoader) { + try { + loadClass(className, classLoader, false); + return true; + } catch (Throwable ex) { + return false; + } + } + + // ----------------------------------------------------------------------------------- Private method start + /** + * 加载非原始类类，无缓存 + * @param name 类名 + * @param classLoader {@link ClassLoader} + * @param isInitialized 是否初始化 + * @return 类 + */ + private static Class doLoadClass(String name, ClassLoader classLoader, boolean isInitialized){ + Class clazz; + if (name.endsWith(ARRAY_SUFFIX)) { + // 对象数组"java.lang.String[]"风格 + final String elementClassName = name.substring(0, name.length() - ARRAY_SUFFIX.length()); + final Class elementClass = loadClass(elementClassName, classLoader, isInitialized); + clazz = Array.newInstance(elementClass, 0).getClass(); + } else if (name.startsWith(NON_PRIMITIVE_ARRAY_PREFIX) && name.endsWith(";")) { + // "[Ljava.lang.String;" 风格 + final String elementName = name.substring(NON_PRIMITIVE_ARRAY_PREFIX.length(), name.length() - 1); + final Class elementClass = loadClass(elementName, classLoader, isInitialized); + clazz = Array.newInstance(elementClass, 0).getClass(); + } else if (name.startsWith(INTERNAL_ARRAY_PREFIX)) { + // "[[I" 或 "[[Ljava.lang.String;" 风格 + final String elementName = name.substring(INTERNAL_ARRAY_PREFIX.length()); + final Class elementClass = loadClass(elementName, classLoader, isInitialized); + clazz = Array.newInstance(elementClass, 0).getClass(); + } else { + // 加载普通类 + if (null == classLoader) { + classLoader = getClassLoader(); + } + try { + clazz = Class.forName(name, isInitialized, classLoader); + } catch (ClassNotFoundException ex) { + // 尝试获取内部类，例如java.lang.Thread.State =》java.lang.Thread$State + clazz = tryLoadInnerClass(name, classLoader, isInitialized); + if (null == clazz) { + throw new UtilException(ex); + } + } + } + return clazz; + } + + /** + * 尝试转换并加载内部类，例如java.lang.Thread.State =》java.lang.Thread$State + * + * @param name 类名 + * @param classLoader {@link ClassLoader}，{@code null} 则使用系统默认ClassLoader + * @param isInitialized 是否初始化类（调用static模块内容和初始化static属性） + * @return 类名对应的类 + * @since 4.1.20 + */ + private static Class tryLoadInnerClass(String name, ClassLoader classLoader, boolean isInitialized) { + // 尝试获取内部类，例如java.lang.Thread.State =》java.lang.Thread$State + final int lastDotIndex = name.lastIndexOf(PACKAGE_SEPARATOR); + if (lastDotIndex > 0) {// 类与内部类的分隔符不能在第一位，因此>0 + final String innerClassName = name.substring(0, lastDotIndex) + INNER_CLASS_SEPARATOR + name.substring(lastDotIndex + 1); + try { + return Class.forName(innerClassName, isInitialized, classLoader); + } catch (ClassNotFoundException ex2) { + // 尝试获取内部类失败时，忽略之。 + } + } + return null; + } + // ----------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ClassUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ClassUtil.java new file mode 100755 index 0000000..7c0dab8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ClassUtil.java @@ -0,0 +1,1135 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.bean.NullWrapperBean; +import aiyh.utils.tool.cn.hutool.core.convert.BasicType; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.resource.ResourceUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.ClassScanner; +import aiyh.utils.tool.cn.hutool.core.lang.Filter; +import aiyh.utils.tool.cn.hutool.core.lang.Singleton; + +import java.io.IOException; +import java.lang.annotation.Annotation; +import java.lang.reflect.Field; +import java.lang.reflect.Method; +import java.lang.reflect.Modifier; +import java.lang.reflect.Type; +import java.net.URI; +import java.net.URL; +import java.time.temporal.TemporalAccessor; +import java.util.Date; +import java.util.Enumeration; +import java.util.HashSet; +import java.util.List; +import java.util.Locale; +import java.util.Set; + +/** + * 类工具类
+ * + * @author xiaoleilu + */ +public class ClassUtil { + + /** + * {@code null}安全的获取对象类型 + * + * @param 对象类型 + * @param obj 对象，如果为{@code null} 返回{@code null} + * @return 对象类型，提供对象如果为{@code null} 返回{@code null} + */ + @SuppressWarnings("unchecked") + public static Class getClass(T obj) { + return ((null == obj) ? null : (Class) obj.getClass()); + } + + /** + * 获得外围类
+ * 返回定义此类或匿名类所在的类，如果类本身是在包中定义的，返回{@code null} + * + * @param clazz 类 + * @return 外围类 + * @since 4.5.7 + */ + public static Class getEnclosingClass(Class clazz) { + return null == clazz ? null : clazz.getEnclosingClass(); + } + + /** + * 是否为顶层类，即定义在包中的类，而非定义在类中的内部类 + * + * @param clazz 类 + * @return 是否为顶层类 + * @since 4.5.7 + */ + public static boolean isTopLevelClass(Class clazz) { + if (null == clazz) { + return false; + } + return null == getEnclosingClass(clazz); + } + + /** + * 获取类名 + * + * @param obj 获取类名对象 + * @param isSimple 是否简单类名，如果为true，返回不带包名的类名 + * @return 类名 + * @since 3.0.7 + */ + public static String getClassName(Object obj, boolean isSimple) { + if (null == obj) { + return null; + } + final Class clazz = obj.getClass(); + return getClassName(clazz, isSimple); + } + + /** + * 获取类名
+ * 类名并不包含“.class”这个扩展名
+ * 例如：ClassUtil这个类
+ * + * 
+	 * isSimple为false: "com.xiaoleilu.hutool.util.ClassUtil"
+	 * isSimple为true: "ClassUtil"
+	 *
+ * + * @param clazz 类 + * @param isSimple 是否简单类名，如果为true，返回不带包名的类名 + * @return 类名 + * @since 3.0.7 + */ + public static String getClassName(Class clazz, boolean isSimple) { + if (null == clazz) { + return null; + } + return isSimple ? clazz.getSimpleName() : clazz.getName(); + } + + /** + * 获取完整类名的短格式如：
+ * aiyh.utils.tool.cn.hutool.core.util.StrUtil -》c.h.c.u.StrUtil + * + * @param className 类名 + * @return 短格式类名 + * @since 4.1.9 + */ + public static String getShortClassName(String className) { + final List packages = StrUtil.split(className, CharUtil.DOT); + if (null == packages || packages.size() < 2) { + return className; + } + + final int size = packages.size(); + final StringBuilder result = StrUtil.builder(); + result.append(packages.get(0).charAt(0)); + for (int i = 1; i < size - 1; i++) { + result.append(CharUtil.DOT).append(packages.get(i).charAt(0)); + } + result.append(CharUtil.DOT).append(packages.get(size - 1)); + return result.toString(); + } + + /** + * 获得对象数组的类数组 + * + * @param objects 对象数组，如果数组中存在{@code null}元素，则此元素被认为是Object类型 + * @return 类数组 + */ + public static Class[] getClasses(Object... objects) { + Class[] classes = new Class[objects.length]; + Object obj; + for (int i = 0; i < objects.length; i++) { + obj = objects[i]; + if (obj instanceof NullWrapperBean) { + // 自定义null值的参数类型 + classes[i] = ((NullWrapperBean) obj).getWrappedClass(); + } else if (null == obj) { + classes[i] = Object.class; + } else { + classes[i] = obj.getClass(); + } + } + return classes; + } + + /** + * 指定类是否与给定的类名相同 + * + * @param clazz 类 + * @param className 类名，可以是全类名（包含包名），也可以是简单类名（不包含包名） + * @param ignoreCase 是否忽略大小写 + * @return 指定类是否与给定的类名相同 + * @since 3.0.7 + */ + public static boolean equals(Class clazz, String className, boolean ignoreCase) { + if (null == clazz || StrUtil.isBlank(className)) { + return false; + } + if (ignoreCase) { + return className.equalsIgnoreCase(clazz.getName()) || className.equalsIgnoreCase(clazz.getSimpleName()); + } else { + return className.equals(clazz.getName()) || className.equals(clazz.getSimpleName()); + } + } + + // ----------------------------------------------------------------------------------------- Scan classes + + /** + * 扫描指定包路径下所有包含指定注解的类 + * + * @param packageName 包路径 + * @param annotationClass 注解类 + * @return 类集合 + * @see ClassScanner#scanPackageByAnnotation(String, Class) + */ + public static Set> scanPackageByAnnotation(String packageName, final Class annotationClass) { + return ClassScanner.scanPackageByAnnotation(packageName, annotationClass); + } + + /** + * 扫描指定包路径下所有指定类或接口的子类或实现类 + * + * @param packageName 包路径 + * @param superClass 父类或接口 + * @return 类集合 + * @see ClassScanner#scanPackageBySuper(String, Class) + */ + public static Set> scanPackageBySuper(String packageName, final Class superClass) { + return ClassScanner.scanPackageBySuper(packageName, superClass); + } + + /** + * 扫描该包路径下所有class文件 + * + * @return 类集合 + * @see ClassScanner#scanPackage() + */ + public static Set> scanPackage() { + return ClassScanner.scanPackage(); + } + + /** + * 扫描该包路径下所有class文件 + * + * @param packageName 包路径 com | com. | com.abs | com.abs. + * @return 类集合 + * @see ClassScanner#scanPackage(String) + */ + public static Set> scanPackage(String packageName) { + return ClassScanner.scanPackage(packageName); + } + + /** + * 扫描包路径下满足class过滤器条件的所有class文件，
+ * 如果包路径为 com.abs + A.class 但是输入 abs会产生classNotFoundException
+ * 因为className 应该为 com.abs.A 现在却成为abs.A,此工具类对该异常进行忽略处理,有可能是一个不完善的地方，以后需要进行修改
+ * + * @param packageName 包路径 com | com. | com.abs | com.abs. + * @param classFilter class过滤器，过滤掉不需要的class + * @return 类集合 + */ + public static Set> scanPackage(String packageName, Filter> classFilter) { + return ClassScanner.scanPackage(packageName, classFilter); + } + + // ----------------------------------------------------------------------------------------- Method + + /** + * 获得指定类中的Public方法名
+ * 去重重载的方法 + * + * @param clazz 类 + * @return 方法名Set + */ + public static Set getPublicMethodNames(Class clazz) { + return ReflectUtil.getPublicMethodNames(clazz); + } + + /** + * 获得本类及其父类所有Public方法 + * + * @param clazz 查找方法的类 + * @return 过滤后的方法列表 + */ + public static Method[] getPublicMethods(Class clazz) { + return ReflectUtil.getPublicMethods(clazz); + } + + /** + * 获得指定类过滤后的Public方法列表 + * + * @param clazz 查找方法的类 + * @param filter 过滤器 + * @return 过滤后的方法列表 + */ + public static List getPublicMethods(Class clazz, Filter filter) { + return ReflectUtil.getPublicMethods(clazz, filter); + } + + /** + * 获得指定类过滤后的Public方法列表 + * + * @param clazz 查找方法的类 + * @param excludeMethods 不包括的方法 + * @return 过滤后的方法列表 + */ + public static List getPublicMethods(Class clazz, Method... excludeMethods) { + return ReflectUtil.getPublicMethods(clazz, excludeMethods); + } + + /** + * 获得指定类过滤后的Public方法列表 + * + * @param clazz 查找方法的类 + * @param excludeMethodNames 不包括的方法名列表 + * @return 过滤后的方法列表 + */ + public static List getPublicMethods(Class clazz, String... excludeMethodNames) { + return ReflectUtil.getPublicMethods(clazz, excludeMethodNames); + } + + /** + * 查找指定Public方法 如果找不到对应的方法或方法不为public的则返回{@code null} + * + * @param clazz 类 + * @param methodName 方法名 + * @param paramTypes 参数类型 + * @return 方法 + * @throws SecurityException 无权访问抛出异常 + */ + public static Method getPublicMethod(Class clazz, String methodName, Class... paramTypes) throws SecurityException { + return ReflectUtil.getPublicMethod(clazz, methodName, paramTypes); + } + + /** + * 获得指定类中的Public方法名
+ * 去重重载的方法 + * + * @param clazz 类 + * @return 方法名Set + */ + public static Set getDeclaredMethodNames(Class clazz) { + return ReflectUtil.getMethodNames(clazz); + } + + /** + * 获得声明的所有方法，包括本类及其父类和接口的所有方法和Object类的方法 + * + * @param clazz 类 + * @return 方法数组 + */ + public static Method[] getDeclaredMethods(Class clazz) { + return ReflectUtil.getMethods(clazz); + } + + /** + * 查找指定对象中的所有方法（包括非public方法），也包括父对象和Object类的方法 + * + * @param obj 被查找的对象 + * @param methodName 方法名 + * @param args 参数 + * @return 方法 + * @throws SecurityException 无访问权限抛出异常 + */ + public static Method getDeclaredMethodOfObj(Object obj, String methodName, Object... args) throws SecurityException { + return getDeclaredMethod(obj.getClass(), methodName, getClasses(args)); + } + + /** + * 查找指定类中的所有方法（包括非public方法），也包括父类和Object类的方法 找不到方法会返回{@code null} + * + * @param clazz 被查找的类 + * @param methodName 方法名 + * @param parameterTypes 参数类型 + * @return 方法 + * @throws SecurityException 无访问权限抛出异常 + */ + public static Method getDeclaredMethod(Class clazz, String methodName, Class... parameterTypes) throws SecurityException { + return ReflectUtil.getMethod(clazz, methodName, parameterTypes); + } + + // ----------------------------------------------------------------------------------------- Field + + /** + * 查找指定类中的所有字段（包括非public字段）， 字段不存在则返回{@code null} + * + * @param clazz 被查找字段的类 + * @param fieldName 字段名 + * @return 字段 + * @throws SecurityException 安全异常 + */ + public static Field getDeclaredField(Class clazz, String fieldName) throws SecurityException { + if (null == clazz || StrUtil.isBlank(fieldName)) { + return null; + } + try { + return clazz.getDeclaredField(fieldName); + } catch (NoSuchFieldException e) { + // e.printStackTrace(); + } + return null; + } + + /** + * 查找指定类中的所有字段（包括非public字段) + * + * @param clazz 被查找字段的类 + * @return 字段 + * @throws SecurityException 安全异常 + */ + public static Field[] getDeclaredFields(Class clazz) throws SecurityException { + if (null == clazz) { + return null; + } + return clazz.getDeclaredFields(); + } + + // ----------------------------------------------------------------------------------------- Classpath + + /** + * 获得ClassPath，不解码路径中的特殊字符（例如空格和中文） + * + * @return ClassPath集合 + */ + public static Set getClassPathResources() { + return getClassPathResources(false); + } + + /** + * 获得ClassPath + * + * @param isDecode 是否解码路径中的特殊字符（例如空格和中文） + * @return ClassPath集合 + * @since 4.0.11 + */ + public static Set getClassPathResources(boolean isDecode) { + return getClassPaths(StrUtil.EMPTY, isDecode); + } + + /** + * 获得ClassPath，不解码路径中的特殊字符（例如空格和中文） + * + * @param packageName 包名称 + * @return ClassPath路径字符串集合 + */ + public static Set getClassPaths(String packageName) { + return getClassPaths(packageName, false); + } + + /** + * 获得ClassPath + * + * @param packageName 包名称 + * @param isDecode 是否解码路径中的特殊字符（例如空格和中文） + * @return ClassPath路径字符串集合 + * @since 4.0.11 + */ + public static Set getClassPaths(String packageName, boolean isDecode) { + String packagePath = packageName.replace(StrUtil.DOT, StrUtil.SLASH); + Enumeration resources; + try { + resources = getClassLoader().getResources(packagePath); + } catch (IOException e) { + throw new UtilException(e, "Loading classPath [{}] error!", packagePath); + } + final Set paths = new HashSet<>(); + String path; + while (resources.hasMoreElements()) { + path = resources.nextElement().getPath(); + paths.add(isDecode ? URLUtil.decode(path, CharsetUtil.systemCharsetName()) : path); + } + return paths; + } + + /** + * 获得ClassPath，将编码后的中文路径解码为原字符
+ * 这个ClassPath路径会文件路径被标准化处理 + * + * @return ClassPath + */ + public static String getClassPath() { + return getClassPath(false); + } + + /** + * 获得ClassPath，这个ClassPath路径会文件路径被标准化处理 + * + * @param isEncoded 是否编码路径中的中文 + * @return ClassPath + * @since 3.2.1 + */ + public static String getClassPath(boolean isEncoded) { + final URL classPathURL = getClassPathURL(); + String url = isEncoded ? classPathURL.getPath() : URLUtil.getDecodedPath(classPathURL); + return FileUtil.normalize(url); + } + + /** + * 获得ClassPath URL + * + * @return ClassPath URL + */ + public static URL getClassPathURL() { + return getResourceURL(StrUtil.EMPTY); + } + + /** + * 获得资源的URL
+ * 路径用/分隔，例如: + * + * 
+	 * config/a/db.config
+	 * spring/xml/test.xml
+	 *
+ * + * @param resource 资源（相对Classpath的路径） + * @return 资源URL + * @see ResourceUtil#getResource(String) + */ + public static URL getResourceURL(String resource) throws IORuntimeException { + return ResourceUtil.getResource(resource); + } + + /** + * 获取指定路径下的资源列表
+ * 路径格式必须为目录格式,用/分隔，例如: + * + * 
+	 * config/a
+	 * spring/xml
+	 *
+ * + * @param resource 资源路径 + * @return 资源列表 + * @see ResourceUtil#getResources(String) + */ + public static List getResources(String resource) { + return ResourceUtil.getResources(resource); + } + + /** + * 获得资源相对路径对应的URL + * + * @param resource 资源相对路径 + * @param baseClass 基准Class，获得的相对路径相对于此Class所在路径，如果为{@code null}则相对ClassPath + * @return {@link URL} + * @see ResourceUtil#getResource(String, Class) + */ + public static URL getResourceUrl(String resource, Class baseClass) { + return ResourceUtil.getResource(resource, baseClass); + } + + /** + * @return 获得Java ClassPath路径，不包括 jre + */ + public static String[] getJavaClassPaths() { + return System.getProperty("java.class.path").split(System.getProperty("path.separator")); + } + + /** + * 获取当前线程的{@link ClassLoader} + * + * @return 当前线程的class loader + * @see ClassLoaderUtil#getClassLoader() + */ + public static ClassLoader getContextClassLoader() { + return ClassLoaderUtil.getContextClassLoader(); + } + + /** + * 获取{@link ClassLoader}
+ * 获取顺序如下：
+ * + * 
+	 * 1、获取当前线程的ContextClassLoader
+	 * 2、获取{@link ClassLoaderUtil}类对应的ClassLoader
+	 * 3、获取系统ClassLoader（{@link ClassLoader#getSystemClassLoader()}）
+	 *
+ * + * @return 类加载器 + */ + public static ClassLoader getClassLoader() { + return ClassLoaderUtil.getClassLoader(); + } + + /** + * 比较判断types1和types2两组类，如果types1中所有的类都与types2对应位置的类相同，或者是其父类或接口，则返回{@code true} + * + * @param types1 类组1 + * @param types2 类组2 + * @return 是否相同、父类或接口 + */ + public static boolean isAllAssignableFrom(Class[] types1, Class[] types2) { + if (ArrayUtil.isEmpty(types1) && ArrayUtil.isEmpty(types2)) { + return true; + } + if (null == types1 || null == types2) { + // 任何一个为null不相等（之前已判断两个都为null的情况） + return false; + } + if (types1.length != types2.length) { + return false; + } + + Class type1; + Class type2; + for (int i = 0; i < types1.length; i++) { + type1 = types1[i]; + type2 = types2[i]; + if (isBasicType(type1) && isBasicType(type2)) { + // 原始类型和包装类型存在不一致情况 + if (BasicType.unWrap(type1) != BasicType.unWrap(type2)) { + return false; + } + } else if (false == type1.isAssignableFrom(type2)) { + return false; + } + } + return true; + } + + /** + * 加载类 + * + * @param 对象类型 + * @param className 类名 + * @param isInitialized 是否初始化 + * @return 类 + */ + @SuppressWarnings("unchecked") + public static Class loadClass(String className, boolean isInitialized) { + return (Class) ClassLoaderUtil.loadClass(className, isInitialized); + } + + /** + * 加载类并初始化 + * + * @param 对象类型 + * @param className 类名 + * @return 类 + */ + public static Class loadClass(String className) { + return loadClass(className, true); + } + + // ---------------------------------------------------------------------------------------------------- Invoke start + + /** + * 执行方法
+ * 可执行Private方法，也可执行static方法
+ * 执行非static方法时，必须满足对象有默认构造方法
+ * 非单例模式，如果是非静态方法，每次创建一个新对象 + * + * @param 对象类型 + * @param classNameWithMethodName 类名和方法名表达式，类名与方法名用{@code .}或{@code #}连接 例如：com.xiaoleilu.hutool.StrUtil.isEmpty 或 com.xiaoleilu.hutool.StrUtil#isEmpty + * @param args 参数，必须严格对应指定方法的参数类型和数量 + * @return 返回结果 + */ + public static T invoke(String classNameWithMethodName, Object[] args) { + return invoke(classNameWithMethodName, false, args); + } + + /** + * 执行方法
+ * 可执行Private方法，也可执行static方法
+ * 执行非static方法时，必须满足对象有默认构造方法
+ * + * @param 对象类型 + * @param classNameWithMethodName 类名和方法名表达式，例如：com.xiaoleilu.hutool.StrUtil#isEmpty或com.xiaoleilu.hutool.StrUtil.isEmpty + * @param isSingleton 是否为单例对象，如果此参数为false，每次执行方法时创建一个新对象 + * @param args 参数，必须严格对应指定方法的参数类型和数量 + * @return 返回结果 + */ + public static T invoke(String classNameWithMethodName, boolean isSingleton, Object... args) { + if (StrUtil.isBlank(classNameWithMethodName)) { + throw new UtilException("Blank classNameDotMethodName!"); + } + + int splitIndex = classNameWithMethodName.lastIndexOf('#'); + if (splitIndex <= 0) { + splitIndex = classNameWithMethodName.lastIndexOf('.'); + } + if (splitIndex <= 0) { + throw new UtilException("Invalid classNameWithMethodName [{}]!", classNameWithMethodName); + } + + final String className = classNameWithMethodName.substring(0, splitIndex); + final String methodName = classNameWithMethodName.substring(splitIndex + 1); + + return invoke(className, methodName, isSingleton, args); + } + + /** + * 执行方法
+ * 可执行Private方法，也可执行static方法
+ * 执行非static方法时，必须满足对象有默认构造方法
+ * 非单例模式，如果是非静态方法，每次创建一个新对象 + * + * @param 对象类型 + * @param className 类名，完整类路径 + * @param methodName 方法名 + * @param args 参数，必须严格对应指定方法的参数类型和数量 + * @return 返回结果 + */ + public static T invoke(String className, String methodName, Object[] args) { + return invoke(className, methodName, false, args); + } + + /** + * 执行方法
+ * 可执行Private方法，也可执行static方法
+ * 执行非static方法时，必须满足对象有默认构造方法
+ * + * @param 对象类型 + * @param className 类名，完整类路径 + * @param methodName 方法名 + * @param isSingleton 是否为单例对象，如果此参数为false，每次执行方法时创建一个新对象 + * @param args 参数，必须严格对应指定方法的参数类型和数量 + * @return 返回结果 + */ + public static T invoke(String className, String methodName, boolean isSingleton, Object... args) { + Class clazz = loadClass(className); + try { + final Method method = getDeclaredMethod(clazz, methodName, getClasses(args)); + if (null == method) { + throw new NoSuchMethodException(StrUtil.format("No such method: [{}]", methodName)); + } + if (isStatic(method)) { + return ReflectUtil.invoke(null, method, args); + } else { + return ReflectUtil.invoke(isSingleton ? Singleton.get(clazz) : clazz.newInstance(), method, args); + } + } catch (Exception e) { + throw new UtilException(e); + } + } + + // ---------------------------------------------------------------------------------------------------- Invoke end + + /** + * 是否为包装类型 + * + * @param clazz 类 + * @return 是否为包装类型 + */ + public static boolean isPrimitiveWrapper(Class clazz) { + if (null == clazz) { + return false; + } + return BasicType.WRAPPER_PRIMITIVE_MAP.containsKey(clazz); + } + + /** + * 是否为基本类型（包括包装类和原始类） + * + * @param clazz 类 + * @return 是否为基本类型 + */ + public static boolean isBasicType(Class clazz) { + if (null == clazz) { + return false; + } + return (clazz.isPrimitive() || isPrimitiveWrapper(clazz)); + } + + /** + * 是否简单值类型或简单值类型的数组
+ * 包括：原始类型,、String、other CharSequence, a Number, a Date, a URI, a URL, a Locale or a Class及其数组 + * + * @param clazz 属性类 + * @return 是否简单值类型或简单值类型的数组 + */ + public static boolean isSimpleTypeOrArray(Class clazz) { + if (null == clazz) { + return false; + } + return isSimpleValueType(clazz) || (clazz.isArray() && isSimpleValueType(clazz.getComponentType())); + } + + /** + * 是否为简单值类型
+ * 包括： + * 
+	 *     原始类型
+	 *     String、other CharSequence
+	 *     Number
+	 *     Date
+	 *     URI
+	 *     URL
+	 *     Locale
+	 *     Class
+	 *
+ * + * @param clazz 类 + * @return 是否为简单值类型 + */ + public static boolean isSimpleValueType(Class clazz) { + return isBasicType(clazz) // + || clazz.isEnum() // + || CharSequence.class.isAssignableFrom(clazz) // + || Number.class.isAssignableFrom(clazz) // + || Date.class.isAssignableFrom(clazz) // + || clazz.equals(URI.class) // + || clazz.equals(URL.class) // + || clazz.equals(Locale.class) // + || clazz.equals(Class.class)// + // jdk8 date object + || TemporalAccessor.class.isAssignableFrom(clazz); // + } + + /** + * 检查目标类是否可以从原类转化
+ * 转化包括：
+ * 1、原类是对象，目标类型是原类型实现的接口
+ * 2、目标类型是原类型的父类
+ * 3、两者是原始类型或者包装类型（相互转换） + * + * @param targetType 目标类型 + * @param sourceType 原类型 + * @return 是否可转化 + */ + public static boolean isAssignable(Class targetType, Class sourceType) { + if (null == targetType || null == sourceType) { + return false; + } + + // 对象类型 + if (targetType.isAssignableFrom(sourceType)) { + return true; + } + + // 基本类型 + if (targetType.isPrimitive()) { + // 原始类型 + Class resolvedPrimitive = BasicType.WRAPPER_PRIMITIVE_MAP.get(sourceType); + return targetType.equals(resolvedPrimitive); + } else { + // 包装类型 + Class resolvedWrapper = BasicType.PRIMITIVE_WRAPPER_MAP.get(sourceType); + return resolvedWrapper != null && targetType.isAssignableFrom(resolvedWrapper); + } + } + + /** + * 指定类是否为Public + * + * @param clazz 类 + * @return 是否为public + */ + public static boolean isPublic(Class clazz) { + if (null == clazz) { + throw new NullPointerException("Class to provided is null."); + } + return Modifier.isPublic(clazz.getModifiers()); + } + + /** + * 指定方法是否为Public + * + * @param method 方法 + * @return 是否为public + */ + public static boolean isPublic(Method method) { + Assert.notNull(method, "Method to provided is null."); + return Modifier.isPublic(method.getModifiers()); + } + + /** + * 指定类是否为非public + * + * @param clazz 类 + * @return 是否为非public + */ + public static boolean isNotPublic(Class clazz) { + return false == isPublic(clazz); + } + + /** + * 指定方法是否为非public + * + * @param method 方法 + * @return 是否为非public + */ + public static boolean isNotPublic(Method method) { + return false == isPublic(method); + } + + /** + * 是否为静态方法 + * + * @param method 方法 + * @return 是否为静态方法 + */ + public static boolean isStatic(Method method) { + Assert.notNull(method, "Method to provided is null."); + return Modifier.isStatic(method.getModifiers()); + } + + /** + * 设置方法为可访问 + * + * @param method 方法 + * @return 方法 + */ + public static Method setAccessible(Method method) { + if (null != method && false == method.isAccessible()) { + method.setAccessible(true); + } + return method; + } + + /** + * 是否为抽象类 + * + * @param clazz 类 + * @return 是否为抽象类 + */ + public static boolean isAbstract(Class clazz) { + return Modifier.isAbstract(clazz.getModifiers()); + } + + /** + * 是否为标准的类
+ * 这个类必须： + * + * 
+	 * 1、非接口
+	 * 2、非抽象类
+	 * 3、非Enum枚举
+	 * 4、非数组
+	 * 5、非注解
+	 * 6、非原始类型（int, long等）
+	 *
+ * + * @param clazz 类 + * @return 是否为标准类 + */ + public static boolean isNormalClass(Class clazz) { + return null != clazz // + && false == clazz.isInterface() // + && false == isAbstract(clazz) // + && false == clazz.isEnum() // + && false == clazz.isArray() // + && false == clazz.isAnnotation() // + && false == clazz.isSynthetic() // + && false == clazz.isPrimitive();// + } + + /** + * 判断类是否为枚举类型 + * + * @param clazz 类 + * @return 是否为枚举类型 + * @since 3.2.0 + */ + public static boolean isEnum(Class clazz) { + return null != clazz && clazz.isEnum(); + } + + /** + * 获得给定类的第一个泛型参数 + * + * @param clazz 被检查的类，必须是已经确定泛型类型的类 + * @return {@link Class} + */ + public static Class getTypeArgument(Class clazz) { + return getTypeArgument(clazz, 0); + } + + /** + * 获得给定类的泛型参数 + * + * @param clazz 被检查的类，必须是已经确定泛型类型的类 + * @param index 泛型类型的索引号，即第几个泛型类型 + * @return {@link Class} + */ + public static Class getTypeArgument(Class clazz, int index) { + final Type argumentType = TypeUtil.getTypeArgument(clazz, index); + return TypeUtil.getClass(argumentType); + } + + /** + * 获得给定类所在包的名称
+ * 例如：
+ * com.xiaoleilu.hutool.util.ClassUtil =》 com.xiaoleilu.hutool.util + * + * @param clazz 类 + * @return 包名 + */ + public static String getPackage(Class clazz) { + if (clazz == null) { + return StrUtil.EMPTY; + } + final String className = clazz.getName(); + int packageEndIndex = className.lastIndexOf(StrUtil.DOT); + if (packageEndIndex == -1) { + return StrUtil.EMPTY; + } + return className.substring(0, packageEndIndex); + } + + /** + * 获得给定类所在包的路径
+ * 例如：
+ * com.xiaoleilu.hutool.util.ClassUtil =》 com/xiaoleilu/hutool/util + * + * @param clazz 类 + * @return 包名 + */ + public static String getPackagePath(Class clazz) { + return getPackage(clazz).replace(StrUtil.C_DOT, StrUtil.C_SLASH); + } + + /** + * 获取指定类型分的默认值
+ * 默认值规则为： + * + * 
+	 * 1、如果为原始类型，返回0
+	 * 2、非原始类型返回{@code null}
+	 *
+ * + * @param clazz 类 + * @return 默认值 + * @since 3.0.8 + */ + public static Object getDefaultValue(Class clazz) { + // 原始类型 + if (clazz.isPrimitive()) { + return getPrimitiveDefaultValue(clazz); + } + return null; + } + + /** + * 获取指定原始类型分的默认值
+ * 默认值规则为： + * + * 
+	 * 1、如果为原始类型，返回0
+	 * 2、非原始类型返回{@code null}
+	 *
+ * + * @param clazz 类 + * @return 默认值 + * @since 5.8.0 + */ + public static Object getPrimitiveDefaultValue(Class clazz) { + if (long.class == clazz) { + return 0L; + } else if (int.class == clazz) { + return 0; + } else if (short.class == clazz) { + return (short) 0; + } else if (char.class == clazz) { + return (char) 0; + } else if (byte.class == clazz) { + return (byte) 0; + } else if (double.class == clazz) { + return 0D; + } else if (float.class == clazz) { + return 0f; + } else if (boolean.class == clazz) { + return false; + } + return null; + } + + /** + * 获得默认值列表 + * + * @param classes 值类型 + * @return 默认值列表 + * @since 3.0.9 + */ + public static Object[] getDefaultValues(Class... classes) { + final Object[] values = new Object[classes.length]; + for (int i = 0; i < classes.length; i++) { + values[i] = getDefaultValue(classes[i]); + } + return values; + } + + /** + * 是否为JDK中定义的类或接口，判断依据： + * + * 
+	 * 1、以java.、javax.开头的包名
+	 * 2、ClassLoader为null
+	 *
+ * + * @param clazz 被检查的类 + * @return 是否为JDK中定义的类或接口 + * @since 4.6.5 + */ + public static boolean isJdkClass(Class clazz) { + final Package objectPackage = clazz.getPackage(); + if (null == objectPackage) { + return false; + } + final String objectPackageName = objectPackage.getName(); + return objectPackageName.startsWith("java.") // + || objectPackageName.startsWith("javax.") // + || clazz.getClassLoader() == null; + } + + /** + * 获取class类路径URL, 不管是否在jar包中都会返回文件夹的路径
+ * class在jar包中返回jar所在文件夹,class不在jar中返回文件夹目录
+ * jdk中的类不能使用此方法 + * + * @param clazz 类 + * @return URL + * @since 5.2.4 + */ + public static URL getLocation(Class clazz) { + if (null == clazz) { + return null; + } + return clazz.getProtectionDomain().getCodeSource().getLocation(); + } + + /** + * 获取class类路径, 不管是否在jar包中都会返回文件夹的路径
+ * class在jar包中返回jar所在文件夹,class不在jar中返回文件夹目录
+ * jdk中的类不能使用此方法 + * + * @param clazz 类 + * @return class路径 + * @since 5.2.4 + */ + public static String getLocationPath(Class clazz) { + final URL location = getLocation(clazz); + if (null == location) { + return null; + } + return location.getPath(); + } + + /** + * 是否为抽象类或接口 + * + * @param clazz 类 + * @return 是否为抽象类或接口 + * @since 5.8.2 + */ + public static boolean isAbstractOrInterface(Class clazz) { + return isAbstract(clazz) || isInterface(clazz); + } + + /** + * 是否为接口 + * + * @param clazz 类 + * @return 是否为接口 + * @since 5.8.2 + */ + public static boolean isInterface(Class clazz) { + return clazz.isInterface(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/CoordinateUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/CoordinateUtil.java new file mode 100644 index 0000000..95624a8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/CoordinateUtil.java @@ -0,0 +1,330 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import java.io.Serializable; +import java.util.Objects; + +/** + * 坐标系转换相关工具类，主流坐标系包括：
+ *
    + *
  • WGS84坐标系：即地球坐标系，中国外谷歌地图
    • + *
  • GCJ02坐标系：即火星坐标系，高德、腾讯、阿里等使用
    • + *
  • BD09坐标系：即百度坐标系，GCJ02坐标系经加密后的坐标系。百度、搜狗等使用
    • + *
+ *

+ * 坐标转换相关参考: https://tool.lu/coordinate/
+ * 参考：https://github.com/JourWon/coordinate-transform + * + * @author hongzhe.qin(qin462328037at163.com), looly + * @since 5.7.16 + */ +public class CoordinateUtil { + + /** + * 坐标转换参数：(火星坐标系与百度坐标系转换的中间量) + */ + public static final double X_PI = 3.1415926535897932384626433832795 * 3000.0 / 180.0; + + /** + * 坐标转换参数：π + */ + public static final double PI = 3.1415926535897932384626433832795D; + + /** + * 地球半径（Krasovsky 1940） + */ + public static final double RADIUS = 6378245.0D; + + /** + * 修正参数（偏率ee） + */ + public static final double CORRECTION_PARAM = 0.00669342162296594323D; + + /** + * 判断坐标是否在国外
+ * 火星坐标系 (GCJ-02)只对国内有效，国外无需转换 + * + * @param lng 经度 + * @param lat 纬度 + * @return 坐标是否在国外 + */ + public static boolean outOfChina(double lng, double lat) { + return (lng < 72.004 || lng > 137.8347) || (lat < 0.8293 || lat > 55.8271); + } + + //----------------------------------------------------------------------------------- WGS84 + /** + * WGS84 转换为 火星坐标系 (GCJ-02) + * + * @param lng 经度值 + * @param lat 纬度值 + * @return 火星坐标 (GCJ-02) + */ + public static Coordinate wgs84ToGcj02(double lng, double lat) { + return new Coordinate(lng, lat).offset(offset(lng, lat, true)); + } + + /** + * WGS84 坐标转为 百度坐标系 (BD-09) 坐标 + * + * @param lng 经度值 + * @param lat 纬度值 + * @return bd09 坐标 + */ + public static Coordinate wgs84ToBd09(double lng, double lat) { + final Coordinate gcj02 = wgs84ToGcj02(lng, lat); + return gcj02ToBd09(gcj02.lng, gcj02.lat); + } + + //----------------------------------------------------------------------------------- GCJ-02 + /** + * 火星坐标系 (GCJ-02) 转换为 WGS84 + * + * @param lng 经度坐标 + * @param lat 纬度坐标 + * @return WGS84 坐标 + */ + public static Coordinate gcj02ToWgs84(double lng, double lat) { + return new Coordinate(lng, lat).offset(offset(lng, lat, false)); + } + + /** + * 火星坐标系 (GCJ-02) 与百度坐标系 (BD-09) 的转换 + * + * @param lng 经度值 + * @param lat 纬度值 + * @return BD-09 坐标 + */ + public static Coordinate gcj02ToBd09(double lng, double lat) { + double z = Math.sqrt(lng * lng + lat * lat) + 0.00002 * Math.sin(lat * X_PI); + double theta = Math.atan2(lat, lng) + 0.000003 * Math.cos(lng * X_PI); + double bd_lng = z * Math.cos(theta) + 0.0065; + double bd_lat = z * Math.sin(theta) + 0.006; + return new Coordinate(bd_lng, bd_lat); + } + + //----------------------------------------------------------------------------------- BD-09 + /** + * 百度坐标系 (BD-09) 与 火星坐标系 (GCJ-02)的转换 + * 即 百度 转 谷歌、高德 + * + * @param lng 经度值 + * @param lat 纬度值 + * @return GCJ-02 坐标 + */ + public static Coordinate bd09ToGcj02(double lng, double lat) { + double x = lng - 0.0065; + double y = lat - 0.006; + double z = Math.sqrt(x * x + y * y) - 0.00002 * Math.sin(y * X_PI); + double theta = Math.atan2(y, x) - 0.000003 * Math.cos(x * X_PI); + double gg_lng = z * Math.cos(theta); + double gg_lat = z * Math.sin(theta); + return new Coordinate(gg_lng, gg_lat); + } + + /** + * 百度坐标系 (BD-09) 与 WGS84 的转换 + * + * @param lng 经度值 + * @param lat 纬度值 + * @return WGS84坐标 + */ + public static Coordinate bd09toWgs84(double lng, double lat) { + final Coordinate gcj02 = bd09ToGcj02(lng, lat); + return gcj02ToWgs84(gcj02.lng, gcj02.lat); + } + + /** + * WGS84 坐标转为 墨卡托投影 + * + * @param lng 经度值 + * @param lat 纬度值 + * @return 墨卡托投影 + */ + public static Coordinate wgs84ToMercator(double lng, double lat) { + double x = lng * 20037508.342789244 / 180; + double y = Math.log(Math.tan((90 + lat) * Math.PI / 360)) / (Math.PI / 180); + y = y * 20037508.342789244 / 180; + return new Coordinate(x, y); + } + + /** + * 墨卡托投影 转为 WGS84 坐标 + * + * @param mercatorX 墨卡托X坐标 + * @param mercatorY 墨卡托Y坐标 + * @return WGS84 坐标 + */ + public static Coordinate mercatorToWgs84(double mercatorX, double mercatorY) { + double x = mercatorX / 20037508.342789244 * 180; + double y = mercatorY / 20037508.342789244 * 180; + y = 180 / Math.PI * (2 * Math.atan(Math.exp(y * Math.PI / 180)) - Math.PI / 2); + return new Coordinate(x, y); + } + + //----------------------------------------------------------------------------------- Private methods begin + + /** + * WGS84 与 火星坐标系 (GCJ-02)转换的偏移算法（非精确） + * + * @param lng 经度值 + * @param lat 纬度值 + * @param isPlus 是否正向偏移：WGS84转GCJ-02使用正向，否则使用反向 + * @return 偏移坐标 + */ + private static Coordinate offset(double lng, double lat, boolean isPlus) { + double dlng = transLng(lng - 105.0, lat - 35.0); + double dlat = transLat(lng - 105.0, lat - 35.0); + + double magic = Math.sin(lat / 180.0 * PI); + magic = 1 - CORRECTION_PARAM * magic * magic; + final double sqrtMagic = Math.sqrt(magic); + + dlng = (dlng * 180.0) / (RADIUS / sqrtMagic * Math.cos(lat / 180.0 * PI) * PI); + dlat = (dlat * 180.0) / ((RADIUS * (1 - CORRECTION_PARAM)) / (magic * sqrtMagic) * PI); + + if(false == isPlus){ + dlng = - dlng; + dlat = - dlat; + } + + return new Coordinate(dlng, dlat); + } + + /** + * 计算经度坐标 + * + * @param lng 经度坐标 + * @param lat 纬度坐标 + * @return ret 计算完成后的 + */ + private static double transLng(double lng, double lat) { + double ret = 300.0 + lng + 2.0 * lat + 0.1 * lng * lng + 0.1 * lng * lat + 0.1 * Math.sqrt(Math.abs(lng)); + ret += (20.0 * Math.sin(6.0 * lng * PI) + 20.0 * Math.sin(2.0 * lng * PI)) * 2.0 / 3.0; + ret += (20.0 * Math.sin(lng * PI) + 40.0 * Math.sin(lng / 3.0 * PI)) * 2.0 / 3.0; + ret += (150.0 * Math.sin(lng / 12.0 * PI) + 300.0 * Math.sin(lng / 30.0 * PI)) * 2.0 / 3.0; + return ret; + } + + /** + * 计算纬度坐标 + * + * @param lng 经度 + * @param lat 纬度 + * @return ret 计算完成后的 + */ + private static double transLat(double lng, double lat) { + double ret = -100.0 + 2.0 * lng + 3.0 * lat + 0.2 * lat * lat + 0.1 * lng * lat + + 0.2 * Math.sqrt(Math.abs(lng)); + ret += (20.0 * Math.sin(6.0 * lng * PI) + 20.0 * Math.sin(2.0 * lng * PI)) * 2.0 / 3.0; + ret += (20.0 * Math.sin(lat * PI) + 40.0 * Math.sin(lat / 3.0 * PI)) * 2.0 / 3.0; + ret += (160.0 * Math.sin(lat / 12.0 * PI) + 320 * Math.sin(lat * PI / 30.0)) * 2.0 / 3.0; + return ret; + } + //----------------------------------------------------------------------------------- Private methods end + + /** + * 坐标经纬度 + * + * @author looly + */ + public static class Coordinate implements Serializable { + private static final long serialVersionUID = 1L; + + /** + * 经度 + */ + private double lng; + /** + * 纬度 + */ + private double lat; + + /** + * 构造 + * + * @param lng 经度 + * @param lat 纬度 + */ + public Coordinate(double lng, double lat) { + this.lng = lng; + this.lat = lat; + } + + /** + * 获取经度 + * + * @return 经度 + */ + public double getLng() { + return lng; + } + + /** + * 设置经度 + * + * @param lng 经度 + * @return this + */ + public Coordinate setLng(double lng) { + this.lng = lng; + return this; + } + + /** + * 获取纬度 + * + * @return 纬度 + */ + public double getLat() { + return lat; + } + + /** + * 设置纬度 + * + * @param lat 纬度 + * @return this + */ + public Coordinate setLat(double lat) { + this.lat = lat; + return this; + } + + /** + * 当前坐标偏移指定坐标 + * + * @param offset 偏移量 + * @return this + */ + public Coordinate offset(Coordinate offset){ + this.lng += offset.lng; + this.lat += offset.lat; + return this; + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Coordinate that = (Coordinate) o; + return Double.compare(that.lng, lng) == 0 && Double.compare(that.lat, lat) == 0; + } + + @Override + public int hashCode() { + return Objects.hash(lng, lat); + } + + @Override + public String toString() { + return "Coordinate{" + + "lng=" + lng + + ", lat=" + lat + + '}'; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/CreditCodeUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/CreditCodeUtil.java new file mode 100755 index 0000000..234f0b7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/CreditCodeUtil.java @@ -0,0 +1,138 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.lang.PatternPool; +import aiyh.utils.tool.cn.hutool.core.map.SafeConcurrentHashMap; + +import java.util.Map; +import java.util.regex.Pattern; + +/** + * 统一社会信用代码（GB32100-2015）工具类
+ * 标准见：https://www.cods.org.cn/c/2020-10-29/12575.html + * + * 

+ * 第一部分：登记管理部门代码1位 (数字或大写英文字母)
+ * 第二部分：机构类别代码1位 (数字或大写英文字母)
+ * 第三部分：登记管理机关行政区划码6位 (数字)
+ * 第四部分：主体标识码（组织机构代码）9位 (数字或大写英文字母)
+ * 第五部分：校验码1位 (数字或大写英文字母)
+ *
+ * + * @author looly + * @since 5.2.4 + */ +public class CreditCodeUtil { + + public static final Pattern CREDIT_CODE_PATTERN = PatternPool.CREDIT_CODE; + + /** + * 加权因子 + */ + private static final int[] WEIGHT = {1, 3, 9, 27, 19, 26, 16, 17, 20, 29, 25, 13, 8, 24, 10, 30, 28}; + /** + * 代码字符集 + */ + private static final char[] BASE_CODE_ARRAY = "0123456789ABCDEFGHJKLMNPQRTUWXY".toCharArray(); + private static final Map CODE_INDEX_MAP; + + static { + CODE_INDEX_MAP = new SafeConcurrentHashMap<>(BASE_CODE_ARRAY.length); + for (int i = 0; i < BASE_CODE_ARRAY.length; i++) { + CODE_INDEX_MAP.put(BASE_CODE_ARRAY[i], i); + } + } + + /** + * 正则校验统一社会信用代码（18位） + * + * 
+	 * 第一部分：登记管理部门代码1位 (数字或大写英文字母)
+	 * 第二部分：机构类别代码1位 (数字或大写英文字母)
+	 * 第三部分：登记管理机关行政区划码6位 (数字)
+	 * 第四部分：主体标识码（组织机构代码）9位 (数字或大写英文字母)
+	 * 第五部分：校验码1位 (数字或大写英文字母)
+	 *
+ * + * @param creditCode 统一社会信用代码 + * @return 校验结果 + */ + public static boolean isCreditCodeSimple(CharSequence creditCode) { + if (StrUtil.isBlank(creditCode)) { + return false; + } + return ReUtil.isMatch(CREDIT_CODE_PATTERN, creditCode); + } + + /** + * 是否是有效的统一社会信用代码 + * 
+	 * 第一部分：登记管理部门代码1位 (数字或大写英文字母)
+	 * 第二部分：机构类别代码1位 (数字或大写英文字母)
+	 * 第三部分：登记管理机关行政区划码6位 (数字)
+	 * 第四部分：主体标识码（组织机构代码）9位 (数字或大写英文字母)
+	 * 第五部分：校验码1位 (数字或大写英文字母)
+	 *
+ * + * @param creditCode 统一社会信用代码 + * @return 校验结果 + */ + public static boolean isCreditCode(CharSequence creditCode) { + if (false == isCreditCodeSimple(creditCode)) { + return false; + } + + final int parityBit = getParityBit(creditCode); + if (parityBit < 0) { + return false; + } + + return creditCode.charAt(17) == BASE_CODE_ARRAY[parityBit]; + } + + /** + * 获取一个随机的统一社会信用代码 + * + * @return 统一社会信用代码 + */ + public static String randomCreditCode() { + final StringBuilder buf = new StringBuilder(18); + + + // + for (int i = 0; i < 2; i++) { + int num = RandomUtil.randomInt(BASE_CODE_ARRAY.length - 1); + buf.append(Character.toUpperCase(BASE_CODE_ARRAY[num])); + } + for (int i = 2; i < 8; i++) { + int num = RandomUtil.randomInt(10); + buf.append(BASE_CODE_ARRAY[num]); + } + for (int i = 8; i < 17; i++) { + int num = RandomUtil.randomInt(BASE_CODE_ARRAY.length - 1); + buf.append(BASE_CODE_ARRAY[num]); + } + + final String code = buf.toString(); + return code + BASE_CODE_ARRAY[getParityBit(code)]; + } + + /** + * 获取校验位的值 + * + * @param creditCode 统一社会信息代码 + * @return 获取校验位的值，-1表示获取错误 + */ + private static int getParityBit(CharSequence creditCode) { + int sum = 0; + Integer codeIndex; + for (int i = 0; i < 17; i++) { + codeIndex = CODE_INDEX_MAP.get(creditCode.charAt(i)); + if (null == codeIndex) { + return -1; + } + sum += codeIndex * WEIGHT[i]; + } + final int result = 31 - sum % 31; + return result == 31 ? 0 : result; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/DesensitizedUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/DesensitizedUtil.java new file mode 100644 index 0000000..4d0845c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/DesensitizedUtil.java @@ -0,0 +1,360 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +/** + * 脱敏工具类，支持以下类型信息的脱敏自动处理： + * + *
    + *
  • 用户ID
    • + *
  • 中文名
    • + *
  • 身份证
    • + *
  • 座机号
    • + *
  • 手机号
    • + *
  • 地址
    • + *
  • 电子邮件
    • + *
  • 密码
    • + *
  • 车牌
    • + *
  • 银行卡号
    • + *
+ * + * @author dazer and neusoft and qiaomu + * @since 5.6.2 + */ +public class DesensitizedUtil { + + /** + * 支持的脱敏类型枚举 + * + * @author dazer and neusoft and qiaomu + */ + public enum DesensitizedType { + /** + * 用户id + */ + USER_ID, + /** + * 中文名 + */ + CHINESE_NAME, + /** + * 身份证号 + */ + ID_CARD, + /** + * 座机号 + */ + FIXED_PHONE, + /** + * 手机号 + */ + MOBILE_PHONE, + /** + * 地址 + */ + ADDRESS, + /** + * 电子邮件 + */ + EMAIL, + /** + * 密码 + */ + PASSWORD, + /** + * 中国大陆车牌，包含普通车辆、新能源车辆 + */ + CAR_LICENSE, + /** + * 银行卡 + */ + BANK_CARD, + /** + * IPv4地址 + */ + IPV4, + /** + * IPv6地址 + */ + IPV6, + /** + * 定义了一个first_mask的规则，只显示第一个字符。 + */ + FIRST_MASK + } + + /** + * 脱敏，使用默认的脱敏策略 + * 
+	 * DesensitizedUtil.desensitized("100", DesensitizedUtil.DesensitizedType.USER_ID)) =  "0"
+	 * DesensitizedUtil.desensitized("段正淳", DesensitizedUtil.DesensitizedType.CHINESE_NAME)) = "段**"
+	 * DesensitizedUtil.desensitized("51343620000320711X", DesensitizedUtil.DesensitizedType.ID_CARD)) = "5***************1X"
+	 * DesensitizedUtil.desensitized("09157518479", DesensitizedUtil.DesensitizedType.FIXED_PHONE)) = "0915*****79"
+	 * DesensitizedUtil.desensitized("18049531999", DesensitizedUtil.DesensitizedType.MOBILE_PHONE)) = "180****1999"
+	 * DesensitizedUtil.desensitized("北京市海淀区马连洼街道289号", DesensitizedUtil.DesensitizedType.ADDRESS)) = "北京市海淀区马********"
+	 * DesensitizedUtil.desensitized("duandazhi-jack@gmail.com.cn", DesensitizedUtil.DesensitizedType.EMAIL)) = "d*************@gmail.com.cn"
+	 * DesensitizedUtil.desensitized("1234567890", DesensitizedUtil.DesensitizedType.PASSWORD)) = "**********"
+	 * DesensitizedUtil.desensitized("苏D40000", DesensitizedUtil.DesensitizedType.CAR_LICENSE)) = "苏D4***0"
+	 * DesensitizedUtil.desensitized("11011111222233333256", DesensitizedUtil.DesensitizedType.BANK_CARD)) = "1101 **** **** **** 3256"
+	 * DesensitizedUtil.desensitized("192.168.1.1", DesensitizedUtil.DesensitizedType.IPV4)) = "192.*.*.*"
+	 *
+ * + * @param str 字符串 + * @param desensitizedType 脱敏类型;可以脱敏：用户id、中文名、身份证号、座机号、手机号、地址、电子邮件、密码 + * @return 脱敏之后的字符串 + * @author dazer and neusoft and qiaomu + * @since 5.6.2 + */ + public static String desensitized(CharSequence str, DesensitizedUtil.DesensitizedType desensitizedType) { + if (StrUtil.isBlank(str)) { + return StrUtil.EMPTY; + } + String newStr = String.valueOf(str); + switch (desensitizedType) { + case USER_ID: + newStr = String.valueOf(userId()); + break; + case CHINESE_NAME: + newStr = chineseName(String.valueOf(str)); + break; + case ID_CARD: + newStr = idCardNum(String.valueOf(str), 1, 2); + break; + case FIXED_PHONE: + newStr = fixedPhone(String.valueOf(str)); + break; + case MOBILE_PHONE: + newStr = mobilePhone(String.valueOf(str)); + break; + case ADDRESS: + newStr = address(String.valueOf(str), 8); + break; + case EMAIL: + newStr = email(String.valueOf(str)); + break; + case PASSWORD: + newStr = password(String.valueOf(str)); + break; + case CAR_LICENSE: + newStr = carLicense(String.valueOf(str)); + break; + case BANK_CARD: + newStr = bankCard(String.valueOf(str)); + break; + case IPV4: + newStr = ipv4(String.valueOf(str)); + break; + case IPV6: + newStr = ipv6(String.valueOf(str)); + break; + case FIRST_MASK: + newStr = firstMask(String.valueOf(str)); + break; + default: + } + return newStr; + } + + /** + * 【用户id】不对外提供userId + * + * @return 脱敏后的主键 + */ + public static Long userId() { + return 0L; + } + + /** + * 定义了一个first_mask的规则，只显示第一个字符。
+ * 脱敏前：123456789；脱敏后：1********。 + * + * @param str 字符串 + * @return 脱敏后的字符串 + */ + public static String firstMask(String str) { + if (StrUtil.isBlank(str)) { + return StrUtil.EMPTY; + } + return StrUtil.hide(str, 1, str.length()); + } + + /** + * 【中文姓名】只显示第一个汉字，其他隐藏为2个星号，比如：李** + * + * @param fullName 姓名 + * @return 脱敏后的姓名 + */ + public static String chineseName(String fullName) { + return firstMask(fullName); + } + + /** + * 【身份证号】前1位 和后2位 + * + * @param idCardNum 身份证 + * @param front 保留：前面的front位数；从1开始 + * @param end 保留：后面的end位数；从1开始 + * @return 脱敏后的身份证 + */ + public static String idCardNum(String idCardNum, int front, int end) { + //身份证不能为空 + if (StrUtil.isBlank(idCardNum)) { + return StrUtil.EMPTY; + } + //需要截取的长度不能大于身份证号长度 + if ((front + end) > idCardNum.length()) { + return StrUtil.EMPTY; + } + //需要截取的不能小于0 + if (front < 0 || end < 0) { + return StrUtil.EMPTY; + } + return StrUtil.hide(idCardNum, front, idCardNum.length() - end); + } + + /** + * 【固定电话 前四位，后两位 + * + * @param num 固定电话 + * @return 脱敏后的固定电话； + */ + public static String fixedPhone(String num) { + if (StrUtil.isBlank(num)) { + return StrUtil.EMPTY; + } + return StrUtil.hide(num, 4, num.length() - 2); + } + + /** + * 【手机号码】前三位，后4位，其他隐藏，比如135****2210 + * + * @param num 移动电话； + * @return 脱敏后的移动电话； + */ + public static String mobilePhone(String num) { + if (StrUtil.isBlank(num)) { + return StrUtil.EMPTY; + } + return StrUtil.hide(num, 3, num.length() - 4); + } + + /** + * 【地址】只显示到地区，不显示详细地址，比如：北京市海淀区**** + * + * @param address 家庭住址 + * @param sensitiveSize 敏感信息长度 + * @return 脱敏后的家庭地址 + */ + public static String address(String address, int sensitiveSize) { + if (StrUtil.isBlank(address)) { + return StrUtil.EMPTY; + } + int length = address.length(); + return StrUtil.hide(address, length - sensitiveSize, length); + } + + /** + * 【电子邮箱】邮箱前缀仅显示第一个字母，前缀其他隐藏，用星号代替，@及后面的地址显示，比如：d**@126.com + * + * @param email 邮箱 + * @return 脱敏后的邮箱 + */ + public static String email(String email) { + if (StrUtil.isBlank(email)) { + return StrUtil.EMPTY; + } + int index = StrUtil.indexOf(email, '@'); + if (index <= 1) { + return email; + } + return StrUtil.hide(email, 1, index); + } + + /** + * 【密码】密码的全部字符都用*代替，比如：****** + * + * @param password 密码 + * @return 脱敏后的密码 + */ + public static String password(String password) { + if (StrUtil.isBlank(password)) { + return StrUtil.EMPTY; + } + return StrUtil.repeat('*', password.length()); + } + + /** + * 【中国车牌】车牌中间用*代替 + * eg1：null -》 "" + * eg1："" -》 "" + * eg3：苏D40000 -》 苏D4***0 + * eg4：陕A12345D -》 陕A1****D + * eg5：京A123 -》 京A123 如果是错误的车牌，不处理 + * + * @param carLicense 完整的车牌号 + * @return 脱敏后的车牌 + */ + public static String carLicense(String carLicense) { + if (StrUtil.isBlank(carLicense)) { + return StrUtil.EMPTY; + } + // 普通车牌 + if (carLicense.length() == 7) { + carLicense = StrUtil.hide(carLicense, 3, 6); + } else if (carLicense.length() == 8) { + // 新能源车牌 + carLicense = StrUtil.hide(carLicense, 3, 7); + } + return carLicense; + } + + /** + * 银行卡号脱敏 + * eg: 1101 **** **** **** 3256 + * + * @param bankCardNo 银行卡号 + * @return 脱敏之后的银行卡号 + * @since 5.6.3 + */ + public static String bankCard(String bankCardNo) { + if (StrUtil.isBlank(bankCardNo)) { + return bankCardNo; + } + bankCardNo = StrUtil.trim(bankCardNo); + if (bankCardNo.length() < 9) { + return bankCardNo; + } + + final int length = bankCardNo.length(); + final int midLength = length - 8; + final StringBuilder buf = new StringBuilder(); + + buf.append(bankCardNo, 0, 4); + for (int i = 0; i < midLength; ++i) { + if (i % 4 == 0) { + buf.append(CharUtil.SPACE); + } + buf.append('*'); + } + buf.append(CharUtil.SPACE).append(bankCardNo, length - 4, length); + return buf.toString(); + } + + /** + * IPv4脱敏，如：脱敏前：192.0.2.1；脱敏后：192.*.*.*。 + * + * @param ipv4 IPv4地址 + * @return 脱敏后的地址 + */ + public static String ipv4(String ipv4) { + return StrUtil.subBefore(ipv4, '.', false) + ".*.*.*"; + } + + /** + * IPv4脱敏，如：脱敏前：2001:0db8:86a3:08d3:1319:8a2e:0370:7344；脱敏后：2001:*:*:*:*:*:*:* + * + * @param ipv6 IPv4地址 + * @return 脱敏后的地址 + */ + public static String ipv6(String ipv6) { + return StrUtil.subBefore(ipv6, ':', false) + ":*:*:*:*:*:*:*"; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/EnumUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/EnumUtil.java new file mode 100644 index 0000000..7babe60 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/EnumUtil.java @@ -0,0 +1,371 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.func.Func1; +import aiyh.utils.tool.cn.hutool.core.lang.func.LambdaUtil; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; + +import java.lang.reflect.Field; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.function.Function; +import java.util.function.Predicate; + +/** + * 枚举工具类 + * + * @author looly + * @since 3.3.0 + */ +public class EnumUtil { + + /** + * 指定类是否为Enum类 + * + * @param clazz 类 + * @return 是否为Enum类 + */ + public static boolean isEnum(Class clazz) { + Assert.notNull(clazz); + return clazz.isEnum(); + } + + /** + * 指定类是否为Enum类 + * + * @param obj 类 + * @return 是否为Enum类 + */ + public static boolean isEnum(Object obj) { + Assert.notNull(obj); + return obj.getClass().isEnum(); + } + + /** + * Enum对象转String，调用{@link Enum#name()} 方法 + * + * @param e Enum + * @return name值 + * @since 4.1.13 + */ + public static String toString(Enum e) { + return null != e ? e.name() : null; + } + + /** + * 获取给定位置的枚举值 + * + * @param 枚举类型泛型 + * @param enumClass 枚举类 + * @param index 枚举索引 + * @return 枚举值，null表示无此对应枚举 + * @since 5.1.6 + */ + public static > E getEnumAt(Class enumClass, int index) { + final E[] enumConstants = enumClass.getEnumConstants(); + return index >= 0 && index < enumConstants.length ? enumConstants[index] : null; + } + + /** + * 字符串转枚举，调用{@link Enum#valueOf(Class, String)} + * + * @param 枚举类型泛型 + * @param enumClass 枚举类 + * @param value 值 + * @return 枚举值 + * @since 4.1.13 + */ + public static > E fromString(Class enumClass, String value) { + return Enum.valueOf(enumClass, value); + } + + /** + * 字符串转枚举，调用{@link Enum#valueOf(Class, String)}
+ * 如果无枚举值，返回默认值 + * + * @param 枚举类型泛型 + * @param enumClass 枚举类 + * @param value 值 + * @param defaultValue 无对应枚举值返回的默认值 + * @return 枚举值 + * @since 4.5.18 + */ + public static > E fromString(Class enumClass, String value, E defaultValue) { + return ObjectUtil.defaultIfNull(fromStringQuietly(enumClass, value), defaultValue); + } + + /** + * 字符串转枚举，调用{@link Enum#valueOf(Class, String)}，转换失败返回{@code null} 而非报错 + * + * @param 枚举类型泛型 + * @param enumClass 枚举类 + * @param value 值 + * @return 枚举值 + * @since 4.5.18 + */ + public static > E fromStringQuietly(Class enumClass, String value) { + if (null == enumClass || StrUtil.isBlank(value)) { + return null; + } + + try { + return fromString(enumClass, value); + } catch (IllegalArgumentException e) { + return null; + } + } + + /** + * 模糊匹配转换为枚举，给定一个值，匹配枚举中定义的所有字段名（包括name属性），一旦匹配到返回这个枚举对象，否则返回null + * + * @param 枚举类型 + * @param enumClass 枚举类 + * @param value 值 + * @return 匹配到的枚举对象，未匹配到返回null + */ + @SuppressWarnings("unchecked") + public static > E likeValueOf(Class enumClass, Object value) { + if (value instanceof CharSequence) { + value = value.toString().trim(); + } + + final Field[] fields = ReflectUtil.getFields(enumClass); + final Enum[] enums = enumClass.getEnumConstants(); + String fieldName; + for (Field field : fields) { + fieldName = field.getName(); + if (field.getType().isEnum() || "ENUM$VALUES".equals(fieldName) || "ordinal".equals(fieldName)) { + // 跳过一些特殊字段 + continue; + } + for (Enum enumObj : enums) { + if (ObjectUtil.equal(value, ReflectUtil.getFieldValue(enumObj, field))) { + return (E) enumObj; + } + } + } + return null; + } + + /** + * 枚举类中所有枚举对象的name列表 + * + * @param clazz 枚举类 + * @return name列表 + */ + public static List getNames(Class> clazz) { + final Enum[] enums = clazz.getEnumConstants(); + if (null == enums) { + return null; + } + final List list = new ArrayList<>(enums.length); + for (Enum e : enums) { + list.add(e.name()); + } + return list; + } + + /** + * 获得枚举类中各枚举对象下指定字段的值 + * + * @param clazz 枚举类 + * @param fieldName 字段名，最终调用getXXX方法 + * @return 字段值列表 + */ + public static List getFieldValues(Class> clazz, String fieldName) { + final Enum[] enums = clazz.getEnumConstants(); + if (null == enums) { + return null; + } + final List list = new ArrayList<>(enums.length); + for (Enum e : enums) { + list.add(ReflectUtil.getFieldValue(e, fieldName)); + } + return list; + } + + /** + * 获得枚举类中所有的字段名
+ * 除用户自定义的字段名，也包括“name”字段，例如： + * + * 
+	 *   EnumUtil.getFieldNames(Color.class) == ["name", "index"]
+	 *
+ * + * @param clazz 枚举类 + * @return 字段名列表 + * @since 4.1.20 + */ + public static List getFieldNames(Class> clazz) { + final List names = new ArrayList<>(); + final Field[] fields = ReflectUtil.getFields(clazz); + String name; + for (Field field : fields) { + name = field.getName(); + if (field.getType().isEnum() || name.contains("$VALUES") || "ordinal".equals(name)) { + continue; + } + if (false == names.contains(name)) { + names.add(name); + } + } + return names; + } + + /** + * 通过 某字段对应值 获取 枚举，获取不到时为 {@code null} + * + * @param enumClass 枚举类 + * @param predicate 条件 + * @param 枚举类型 + * @return 对应枚举 ，获取不到时为 {@code null} + * @since 5.8.0 + */ + public static > E getBy(Class enumClass, Predicate predicate) { + return Arrays.stream(enumClass.getEnumConstants()) + .filter(predicate).findFirst().orElse(null); + } + + /** + * 通过 某字段对应值 获取 枚举，获取不到时为 {@code null} + * + * @param condition 条件字段 + * @param value 条件字段值 + * @param 枚举类型 + * @param 字段类型 + * @return 对应枚举 ，获取不到时为 {@code null} + */ + public static , C> E getBy(Func1 condition, C value) { + Class implClass = LambdaUtil.getRealClass(condition); + if (Enum.class.equals(implClass)) { + implClass = LambdaUtil.getRealClass(condition); + } + return Arrays.stream(implClass.getEnumConstants()).filter(e -> condition.callWithRuntimeException(e).equals(value)).findAny().orElse(null); + } + + /** + * 通过 某字段对应值 获取 枚举，获取不到时为 {@code defaultEnum} + * + * @param 枚举类型 + * @param 字段类型 + * @param condition 条件字段 + * @param value 条件字段值 + * @param defaultEnum 条件找不到则返回结果使用这个 + * @return 对应枚举 ，获取不到时为 {@code null} + * @since 5.8.8 + */ + public static , C> E getBy(Func1 condition, C value, E defaultEnum) { + return ObjectUtil.defaultIfNull(getBy(condition, value), defaultEnum); + } + + /** + * 通过 某字段对应值 获取 枚举中另一字段值，获取不到时为 {@code null} + * + * @param field 你想要获取的字段 + * @param condition 条件字段 + * @param value 条件字段值 + * @param 枚举类型 + * @param 想要获取的字段类型 + * @param 条件字段类型 + * @return 对应枚举中另一字段值 ，获取不到时为 {@code null} + * @since 5.8.0 + */ + public static , F, C> F getFieldBy(Func1 field, + Function condition, C value) { + Class implClass = LambdaUtil.getRealClass(field); + if (Enum.class.equals(implClass)) { + implClass = LambdaUtil.getRealClass(field); + } + return Arrays.stream(implClass.getEnumConstants()) + // 过滤 + .filter(e -> condition.apply(e).equals(value)) + // 获取第一个并转换为结果 + .findFirst().map(field::callWithRuntimeException).orElse(null); + } + + /** + * 获取枚举字符串值和枚举对象的Map对应，使用LinkedHashMap保证有序
+ * 结果中键为枚举名，值为枚举对象 + * + * @param 枚举类型 + * @param enumClass 枚举类 + * @return 枚举字符串值和枚举对象的Map对应，使用LinkedHashMap保证有序 + * @since 4.0.2 + */ + public static > LinkedHashMap getEnumMap(final Class enumClass) { + final LinkedHashMap map = new LinkedHashMap<>(); + for (final E e : enumClass.getEnumConstants()) { + map.put(e.name(), e); + } + return map; + } + + /** + * 获得枚举名对应指定字段值的Map
+ * 键为枚举名，值为字段值 + * + * @param clazz 枚举类 + * @param fieldName 字段名，最终调用getXXX方法 + * @return 枚举名对应指定字段值的Map + */ + public static Map getNameFieldMap(Class> clazz, String fieldName) { + final Enum[] enums = clazz.getEnumConstants(); + if (null == enums) { + return null; + } + final Map map = MapUtil.newHashMap(enums.length, true); + for (Enum e : enums) { + map.put(e.name(), ReflectUtil.getFieldValue(e, fieldName)); + } + return map; + } + + /** + * 判断某个值是存在枚举中 + * + * @param 枚举类型 + * @param enumClass 枚举类 + * @param val 需要查找的值 + * @return 是否存在 + */ + public static > boolean contains(final Class enumClass, String val) { + return EnumUtil.getEnumMap(enumClass).containsKey(val); + } + + /** + * 判断某个值是不存在枚举中 + * + * @param 枚举类型 + * @param enumClass 枚举类 + * @param val 需要查找的值 + * @return 是否不存在 + */ + public static > boolean notContains(final Class enumClass, String val) { + return false == contains(enumClass, val); + } + + /** + * 忽略大小检查某个枚举值是否匹配指定值 + * + * @param e 枚举值 + * @param val 需要判断的值 + * @return 是非匹配 + */ + public static boolean equalsIgnoreCase(final Enum e, String val) { + return StrUtil.equalsIgnoreCase(toString(e), val); + } + + /** + * 检查某个枚举值是否匹配指定值 + * + * @param e 枚举值 + * @param val 需要判断的值 + * @return 是非匹配 + */ + public static boolean equals(final Enum e, String val) { + return StrUtil.equals(toString(e), val); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/EscapeUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/EscapeUtil.java new file mode 100755 index 0000000..d43a20c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/EscapeUtil.java @@ -0,0 +1,199 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.lang.Filter; +import aiyh.utils.tool.cn.hutool.core.text.escape.Html4Escape; +import aiyh.utils.tool.cn.hutool.core.text.escape.Html4Unescape; +import aiyh.utils.tool.cn.hutool.core.text.escape.XmlEscape; +import aiyh.utils.tool.cn.hutool.core.text.escape.XmlUnescape; + +/** + * 转义和反转义工具类Escape / Unescape
+ * escape采用ISO Latin字符集对指定的字符串进行编码。
+ * 所有的空格符、标点符号、特殊字符以及其他非ASCII字符都将被转化成%xx格式的字符编码(xx等于该字符在字符集表里面的编码的16进制数字)。 + * TODO 6.x迁移到core.text.escape包下 + * + * @author xiaoleilu + */ +public class EscapeUtil { + + /** + * 不转义的符号编码 + */ + private static final String NOT_ESCAPE_CHARS = "*@-_+./"; + private static final Filter JS_ESCAPE_FILTER = c -> false == ( + Character.isDigit(c) + || Character.isLowerCase(c) + || Character.isUpperCase(c) + || StrUtil.contains(NOT_ESCAPE_CHARS, c) + ); + + /** + * 转义XML中的特殊字符
+ * 
+	 * 	 & (ampersand) 替换为 &amp;
+	 * 	 < (less than) 替换为 &lt;
+	 * 	 > (greater than) 替换为 &gt;
+	 * 	 " (double quote) 替换为 &quot;
+	 * 	 ' (single quote / apostrophe) 替换为 &apos;
+	 *
+ * + * @param xml XML文本 + * @return 转义后的文本 + * @since 5.7.2 + */ + public static String escapeXml(CharSequence xml) { + XmlEscape escape = new XmlEscape(); + return escape.replace(xml).toString(); + } + + /** + * 反转义XML中的特殊字符 + * + * @param xml XML文本 + * @return 转义后的文本 + * @since 5.7.2 + */ + public static String unescapeXml(CharSequence xml) { + XmlUnescape unescape = new XmlUnescape(); + return unescape.replace(xml).toString(); + } + + /** + * 转义HTML4中的特殊字符 + * + * @param html HTML文本 + * @return 转义后的文本 + * @since 4.1.5 + */ + public static String escapeHtml4(CharSequence html) { + Html4Escape escape = new Html4Escape(); + return escape.replace(html).toString(); + } + + /** + * 反转义HTML4中的特殊字符 + * + * @param html HTML文本 + * @return 转义后的文本 + * @since 4.1.5 + */ + public static String unescapeHtml4(CharSequence html) { + Html4Unescape unescape = new Html4Unescape(); + return unescape.replace(html).toString(); + } + + /** + * Escape编码（Unicode）（等同于JS的escape()方法）
+ * 该方法不会对 ASCII 字母和数字进行编码，也不会对下面这些 ASCII 标点符号进行编码： * @ - _ + . /
+ * 其他所有的字符都会被转义序列替换。 + * + * @param content 被转义的内容 + * @return 编码后的字符串 + */ + public static String escape(CharSequence content) { + return escape(content, JS_ESCAPE_FILTER); + } + + /** + * Escape编码（Unicode）
+ * 该方法不会对 ASCII 字母和数字进行编码。其他所有的字符都会被转义序列替换。 + * + * @param content 被转义的内容 + * @return 编码后的字符串 + */ + public static String escapeAll(CharSequence content) { + return escape(content, c -> true); + } + + /** + * Escape编码（Unicode）
+ * 该方法不会对 ASCII 字母和数字进行编码。其他所有的字符都会被转义序列替换。 + * + * @param content 被转义的内容 + * @param filter 编码过滤器，对于过滤器中accept为false的字符不做编码 + * @return 编码后的字符串 + */ + public static String escape(CharSequence content, Filter filter) { + if (StrUtil.isEmpty(content)) { + return StrUtil.str(content); + } + + final StringBuilder tmp = new StringBuilder(content.length() * 6); + char c; + for (int i = 0; i < content.length(); i++) { + c = content.charAt(i); + if (false == filter.accept(c)) { + tmp.append(c); + } else if (c < 256) { + tmp.append("%"); + if (c < 16) { + tmp.append("0"); + } + tmp.append(Integer.toString(c, 16)); + } else { + tmp.append("%u"); + if(c <= 0xfff){ + // issue#I49JU8@Gitee + tmp.append("0"); + } + tmp.append(Integer.toString(c, 16)); + } + } + return tmp.toString(); + } + + /** + * Escape解码 + * + * @param content 被转义的内容 + * @return 解码后的字符串 + */ + public static String unescape(String content) { + if (StrUtil.isBlank(content)) { + return content; + } + + StringBuilder tmp = new StringBuilder(content.length()); + int lastPos = 0; + int pos; + char ch; + while (lastPos < content.length()) { + pos = content.indexOf("%", lastPos); + if (pos == lastPos) { + if (content.charAt(pos + 1) == 'u') { + ch = (char) Integer.parseInt(content.substring(pos + 2, pos + 6), 16); + tmp.append(ch); + lastPos = pos + 6; + } else { + ch = (char) Integer.parseInt(content.substring(pos + 1, pos + 3), 16); + tmp.append(ch); + lastPos = pos + 3; + } + } else { + if (pos == -1) { + tmp.append(content.substring(lastPos)); + lastPos = content.length(); + } else { + tmp.append(content, lastPos, pos); + lastPos = pos; + } + } + } + return tmp.toString(); + } + + /** + * 安全的unescape文本，当文本不是被escape的时候，返回原文。 + * + * @param content 内容 + * @return 解码后的字符串，如果解码失败返回原字符串 + */ + public static String safeUnescape(String content) { + try { + return unescape(content); + } catch (Exception e) { + // Ignore Exception + } + return content; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/HashUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/HashUtil.java new file mode 100755 index 0000000..324729b --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/HashUtil.java @@ -0,0 +1,629 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.lang.hash.CityHash; +import aiyh.utils.tool.cn.hutool.core.lang.hash.MetroHash; +import aiyh.utils.tool.cn.hutool.core.lang.hash.MurmurHash; +import aiyh.utils.tool.cn.hutool.core.lang.hash.Number128; + +/** + * Hash算法大全
+ * 推荐使用FNV1算法 + * + * @author Goodzzp, Looly + */ +public class HashUtil { + + /** + * 加法hash + * + * @param key 字符串 + * @param prime 一个质数 + * @return hash结果 + */ + public static int additiveHash(String key, int prime) { + int hash, i; + for (hash = key.length(), i = 0; i < key.length(); i++) { + hash += key.charAt(i); + } + return hash % prime; + } + + /** + * 旋转hash + * + * @param key 输入字符串 + * @param prime 质数 + * @return hash值 + */ + public static int rotatingHash(String key, int prime) { + int hash, i; + for (hash = key.length(), i = 0; i < key.length(); ++i) { + hash = (hash << 4) ^ (hash >> 28) ^ key.charAt(i); + } + + // 使用：hash = (hash ^ (hash>>10) ^ (hash>>20)) & mask; + // 替代：hash %= prime; + // return (hash ^ (hash>>10) ^ (hash>>20)); + return hash % prime; + } + + /** + * 一次一个hash + * + * @param key 输入字符串 + * @return 输出hash值 + */ + public static int oneByOneHash(String key) { + int hash, i; + for (hash = 0, i = 0; i < key.length(); ++i) { + hash += key.charAt(i); + hash += (hash << 10); + hash ^= (hash >> 6); + } + hash += (hash << 3); + hash ^= (hash >> 11); + hash += (hash << 15); + // return (hash & M_MASK); + return hash; + } + + /** + * Bernstein's hash + * + * @param key 输入字节数组 + * @return 结果hash + */ + public static int bernstein(String key) { + int hash = 0; + int i; + for (i = 0; i < key.length(); ++i) { + hash = 33 * hash + key.charAt(i); + } + return hash; + } + + /** + * Universal Hashing + * + * @param key 字节数组 + * @param mask 掩码 + * @param tab tab + * @return hash值 + */ + public static int universal(char[] key, int mask, int[] tab) { + int hash = key.length, i, len = key.length; + for (i = 0; i < (len << 3); i += 8) { + char k = key[i >> 3]; + if ((k & 0x01) == 0) { + hash ^= tab[i]; + } + if ((k & 0x02) == 0) { + hash ^= tab[i + 1]; + } + if ((k & 0x04) == 0) { + hash ^= tab[i + 2]; + } + if ((k & 0x08) == 0) { + hash ^= tab[i + 3]; + } + if ((k & 0x10) == 0) { + hash ^= tab[i + 4]; + } + if ((k & 0x20) == 0) { + hash ^= tab[i + 5]; + } + if ((k & 0x40) == 0) { + hash ^= tab[i + 6]; + } + if ((k & 0x80) == 0) { + hash ^= tab[i + 7]; + } + } + return (hash & mask); + } + + /** + * Zobrist Hashing + * + * @param key 字节数组 + * @param mask 掩码 + * @param tab tab + * @return hash值 + */ + public static int zobrist(char[] key, int mask, int[][] tab) { + int hash, i; + for (hash = key.length, i = 0; i < key.length; ++i) { + hash ^= tab[i][key[i]]; + } + return (hash & mask); + } + + /** + * 改进的32位FNV算法1 + * + * @param data 数组 + * @return hash结果 + */ + public static int fnvHash(byte[] data) { + final int p = 16777619; + int hash = (int) 2166136261L; + for (byte b : data) { + hash = (hash ^ b) * p; + } + hash += hash << 13; + hash ^= hash >> 7; + hash += hash << 3; + hash ^= hash >> 17; + hash += hash << 5; + return Math.abs(hash); + } + + /** + * 改进的32位FNV算法1 + * + * @param data 字符串 + * @return hash结果 + */ + public static int fnvHash(String data) { + final int p = 16777619; + int hash = (int) 2166136261L; + for (int i = 0; i < data.length(); i++) { + hash = (hash ^ data.charAt(i)) * p; + } + hash += hash << 13; + hash ^= hash >> 7; + hash += hash << 3; + hash ^= hash >> 17; + hash += hash << 5; + return Math.abs(hash); + } + + /** + * Thomas Wang的算法，整数hash + * + * @param key 整数 + * @return hash值 + */ + public static int intHash(int key) { + key += ~(key << 15); + key ^= (key >>> 10); + key += (key << 3); + key ^= (key >>> 6); + key += ~(key << 11); + key ^= (key >>> 16); + return key; + } + + /** + * RS算法hash + * + * @param str 字符串 + * @return hash值 + */ + public static int rsHash(String str) { + int b = 378551; + int a = 63689; + int hash = 0; + + for (int i = 0; i < str.length(); i++) { + hash = hash * a + str.charAt(i); + a = a * b; + } + + return hash & 0x7FFFFFFF; + } + + /** + * JS算法 + * + * @param str 字符串 + * @return hash值 + */ + public static int jsHash(String str) { + int hash = 1315423911; + + for (int i = 0; i < str.length(); i++) { + hash ^= ((hash << 5) + str.charAt(i) + (hash >> 2)); + } + + return Math.abs(hash) & 0x7FFFFFFF; + } + + /** + * PJW算法 + * + * @param str 字符串 + * @return hash值 + */ + public static int pjwHash(String str) { + int bitsInUnsignedInt = 32; + int threeQuarters = (bitsInUnsignedInt * 3) / 4; + int oneEighth = bitsInUnsignedInt / 8; + int highBits = 0xFFFFFFFF << (bitsInUnsignedInt - oneEighth); + int hash = 0; + int test; + + for (int i = 0; i < str.length(); i++) { + hash = (hash << oneEighth) + str.charAt(i); + + if ((test = hash & highBits) != 0) { + hash = ((hash ^ (test >> threeQuarters)) & (~highBits)); + } + } + + return hash & 0x7FFFFFFF; + } + + /** + * ELF算法 + * + * @param str 字符串 + * @return hash值 + */ + public static int elfHash(String str) { + int hash = 0; + int x; + + for (int i = 0; i < str.length(); i++) { + hash = (hash << 4) + str.charAt(i); + if ((x = (int) (hash & 0xF0000000L)) != 0) { + hash ^= (x >> 24); + hash &= ~x; + } + } + + return hash & 0x7FFFFFFF; + } + + /** + * BKDR算法 + * + * @param str 字符串 + * @return hash值 + */ + public static int bkdrHash(String str) { + int seed = 131; // 31 131 1313 13131 131313 etc.. + int hash = 0; + + for (int i = 0; i < str.length(); i++) { + hash = (hash * seed) + str.charAt(i); + } + + return hash & 0x7FFFFFFF; + } + + /** + * SDBM算法 + * + * @param str 字符串 + * @return hash值 + */ + public static int sdbmHash(String str) { + int hash = 0; + + for (int i = 0; i < str.length(); i++) { + hash = str.charAt(i) + (hash << 6) + (hash << 16) - hash; + } + + return hash & 0x7FFFFFFF; + } + + /** + * DJB算法 + * + * @param str 字符串 + * @return hash值 + */ + public static int djbHash(String str) { + int hash = 5381; + + for (int i = 0; i < str.length(); i++) { + hash = ((hash << 5) + hash) + str.charAt(i); + } + + return hash & 0x7FFFFFFF; + } + + /** + * DEK算法 + * + * @param str 字符串 + * @return hash值 + */ + public static int dekHash(String str) { + int hash = str.length(); + + for (int i = 0; i < str.length(); i++) { + hash = ((hash << 5) ^ (hash >> 27)) ^ str.charAt(i); + } + + return hash & 0x7FFFFFFF; + } + + /** + * AP算法 + * + * @param str 字符串 + * @return hash值 + */ + public static int apHash(String str) { + int hash = 0; + + for (int i = 0; i < str.length(); i++) { + hash ^= ((i & 1) == 0) ? ((hash << 7) ^ str.charAt(i) ^ (hash >> 3)) : (~((hash << 11) ^ str.charAt(i) ^ (hash >> 5))); + } + + // return (hash & 0x7FFFFFFF); + return hash; + } + + /** + * TianL Hash算法 + * + * @param str 字符串 + * @return Hash值 + */ + public static long tianlHash(String str) { + long hash; + + int iLength = str.length(); + if (iLength == 0) { + return 0; + } + + if (iLength <= 256) { + hash = 16777216L * (iLength - 1); + } else { + hash = 4278190080L; + } + + int i; + + char ucChar; + + if (iLength <= 96) { + for (i = 1; i <= iLength; i++) { + ucChar = str.charAt(i - 1); + if (ucChar <= 'Z' && ucChar >= 'A') { + ucChar = (char) (ucChar + 32); + } + hash += (3L * i * ucChar * ucChar + 5L * i * ucChar + 7L * i + 11 * ucChar) % 16777216; + } + } else { + for (i = 1; i <= 96; i++) { + ucChar = str.charAt(i + iLength - 96 - 1); + if (ucChar <= 'Z' && ucChar >= 'A') { + ucChar = (char) (ucChar + 32); + } + hash += (3L * i * ucChar * ucChar + 5L * i * ucChar + 7L * i + 11 * ucChar) % 16777216; + } + } + if (hash < 0) { + hash *= -1; + } + return hash; + } + + /** + * JAVA自己带的算法 + * + * @param str 字符串 + * @return hash值 + */ + public static int javaDefaultHash(String str) { + int h = 0; + int off = 0; + int len = str.length(); + for (int i = 0; i < len; i++) { + h = 31 * h + str.charAt(off++); + } + return h; + } + + /** + * 混合hash算法，输出64位的值 + * + * @param str 字符串 + * @return hash值 + */ + public static long mixHash(String str) { + long hash = str.hashCode(); + hash <<= 32; + hash |= fnvHash(str); + return hash; + } + + /** + * 根据对象的内存地址生成相应的Hash值 + * + * @param obj 对象 + * @return hash值 + * @since 4.2.2 + */ + public static int identityHashCode(Object obj) { + return System.identityHashCode(obj); + } + + /** + * MurmurHash算法32-bit实现 + * + * @param data 数据 + * @return hash值 + * @since 4.3.3 + */ + public static int murmur32(byte[] data) { + return MurmurHash.hash32(data); + } + + /** + * MurmurHash算法64-bit实现 + * + * @param data 数据 + * @return hash值 + * @since 4.3.3 + */ + public static long murmur64(byte[] data) { + return MurmurHash.hash64(data); + } + + /** + * MurmurHash算法128-bit实现 + * + * @param data 数据 + * @return hash值 + * @since 4.3.3 + */ + public static long[] murmur128(byte[] data) { + return MurmurHash.hash128(data); + } + + /** + * CityHash算法32-bit实现 + * + * @param data 数据 + * @return hash值 + * @since 5.2.5 + */ + public static int cityHash32(byte[] data) { + return CityHash.hash32(data); + } + + /** + * CityHash算法64-bit实现，种子1使用默认的CityHash#k2 + * + * @param data 数据 + * @param seed 种子2 + * @return hash值 + * @since 5.2.5 + */ + public static long cityHash64(byte[] data, long seed) { + return CityHash.hash64(data, seed); + } + + /** + * CityHash算法64-bit实现，种子1使用默认的CityHash#k2 + * + * @param data 数据 + * @param seed0 种子1 + * @param seed1 种子2 + * @return hash值 + * @since 5.2.5 + */ + public static long cityHash64(byte[] data, long seed0, long seed1) { + return CityHash.hash64(data, seed0, seed1); + } + + /** + * CityHash算法64-bit实现 + * + * @param data 数据 + * @return hash值 + * @since 5.2.5 + */ + public static long cityHash64(byte[] data) { + return CityHash.hash64(data); + } + + /** + * CityHash算法128-bit实现 + * + * @param data 数据 + * @return hash值 + * @since 5.2.5 + */ + public static long[] cityHash128(byte[] data) { + return CityHash.hash128(data).getLongArray(); + } + + /** + * CityHash算法128-bit实现 + * + * @param data 数据 + * @param seed 种子 + * @return hash值，long[0]：低位，long[1]：高位 + * @since 5.2.5 + */ + public static long[] cityHash128(byte[] data, Number128 seed) { + return CityHash.hash128(data, seed).getLongArray(); + } + + /** + * MetroHash 算法64-bit实现 + * + * @param data 数据 + * @param seed 种子 + * @return hash值 + */ + public static long metroHash64(byte[] data, long seed) { + return MetroHash.hash64(data, seed); + } + + /** + * MetroHash 算法64-bit实现 + * + * @param data 数据 + * @return hash值 + */ + public static long metroHash64(byte[] data) { + return MetroHash.hash64(data); + } + + /** + * MetroHash 算法128-bit实现 + * + * @param data 数据 + * @param seed 种子 + * @return hash值，long[0]：低位，long[1]：高位 + */ + public static long[] metroHash128(byte[] data, long seed) { + return MetroHash.hash128(data, seed).getLongArray(); + } + + /** + * MetroHash 算法128-bit实现 + * + * @param data 数据 + * @return hash值，long[0]：低位，long[1]：高位 + */ + public static long[] metroHash128(byte[] data) { + return MetroHash.hash128(data).getLongArray(); + } + + /** + * HF Hash算法 + * + * @param data 字符串 + * @return hash结果 + * @since 5.8.0 + */ + public static long hfHash(String data) { + int length = data.length(); + long hash = 0; + + for (int i = 0; i < length; i++) { + hash += (long) data.charAt(i) * 3 * i; + } + + if (hash < 0) { + hash = -hash; + } + + return hash; + } + + /** + * HFIP Hash算法 + * + * @param data 字符串 + * @return hash结果 + * @since 5.8.0 + */ + public static long hfIpHash(String data) { + int length = data.length(); + long hash = 0; + for (int i = 0; i < length; i++) { + hash += data.charAt(i % 4) ^ data.charAt(i); + } + return hash; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/HexUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/HexUtil.java new file mode 100755 index 0000000..a360d59 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/HexUtil.java @@ -0,0 +1,377 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.codec.Base16Codec; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; + +import java.awt.Color; +import java.math.BigInteger; +import java.nio.charset.Charset; + +/** + * 十六进制（简写为hex或下标16）在数学中是一种逢16进1的进位制，一般用数字0到9和字母A到F表示（其中:A~F即10~15）。
+ * 例如十进制数57，在二进制写作111001，在16进制写作39。
+ * 像java,c这样的语言为了区分十六进制和十进制数值,会在十六进制数的前面加上 0x,比如0x20是十进制的32,而不是十进制的20
+ *

+ * 参考：https://my.oschina.net/xinxingegeya/blog/287476 + * + * @author Looly + */ +public class HexUtil { + + /** + * 判断给定字符串是否为16进制数
+ * 如果是，需要使用对应数字类型对象的{@code decode}方法解码
+ * 例如：{@code Integer.decode}方法解码int类型的16进制数字 + * + * @param value 值 + * @return 是否为16进制 + */ + public static boolean isHexNumber(String value) { + if(StrUtil.startWith(value, '-')){ + // issue#2875 + return false; + } + int index = 0; + if (value.startsWith("0x", index) || value.startsWith("0X", index)) { + index += 2; + } else if (value.startsWith("#", index)) { + index ++; + } + try { + new BigInteger(value.substring(index), 16); + } catch (final NumberFormatException e) { + return false; + } + return true; + } + + // ---------------------------------------------------------------------------------------------------- encode + + /** + * 将字节数组转换为十六进制字符数组 + * + * @param data byte[] + * @return 十六进制char[] + */ + public static char[] encodeHex(byte[] data) { + return encodeHex(data, true); + } + + /** + * 将字节数组转换为十六进制字符数组 + * + * @param str 字符串 + * @param charset 编码 + * @return 十六进制char[] + */ + public static char[] encodeHex(String str, Charset charset) { + return encodeHex(StrUtil.bytes(str, charset), true); + } + + /** + * 将字节数组转换为十六进制字符数组 + * + * @param data byte[] + * @param toLowerCase {@code true} 传换成小写格式 ， {@code false} 传换成大写格式 + * @return 十六进制char[] + */ + public static char[] encodeHex(byte[] data, boolean toLowerCase) { + return (toLowerCase ? Base16Codec.CODEC_LOWER : Base16Codec.CODEC_UPPER).encode(data); + } + + /** + * 将字节数组转换为十六进制字符串 + * + * @param data byte[] + * @return 十六进制String + */ + public static String encodeHexStr(byte[] data) { + return encodeHexStr(data, true); + } + + /** + * 将字符串转换为十六进制字符串，结果为小写 + * + * @param data 需要被编码的字符串 + * @param charset 编码 + * @return 十六进制String + */ + public static String encodeHexStr(String data, Charset charset) { + return encodeHexStr(StrUtil.bytes(data, charset), true); + } + + /** + * 将字符串转换为十六进制字符串，结果为小写，默认编码是UTF-8 + * + * @param data 被编码的字符串 + * @return 十六进制String + */ + public static String encodeHexStr(String data) { + return encodeHexStr(data, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 将字节数组转换为十六进制字符串 + * + * @param data byte[] + * @param toLowerCase {@code true} 传换成小写格式 ， {@code false} 传换成大写格式 + * @return 十六进制String + */ + public static String encodeHexStr(byte[] data, boolean toLowerCase) { + return new String(encodeHex(data, toLowerCase)); + } + + // ---------------------------------------------------------------------------------------------------- decode + + /** + * 将十六进制字符数组转换为字符串，默认编码UTF-8 + * + * @param hexStr 十六进制String + * @return 字符串 + */ + public static String decodeHexStr(String hexStr) { + return decodeHexStr(hexStr, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 将十六进制字符数组转换为字符串 + * + * @param hexStr 十六进制String + * @param charset 编码 + * @return 字符串 + */ + public static String decodeHexStr(String hexStr, Charset charset) { + if (StrUtil.isEmpty(hexStr)) { + return hexStr; + } + return StrUtil.str(decodeHex(hexStr), charset); + } + + /** + * 将十六进制字符数组转换为字符串 + * + * @param hexData 十六进制char[] + * @param charset 编码 + * @return 字符串 + */ + public static String decodeHexStr(char[] hexData, Charset charset) { + return StrUtil.str(decodeHex(hexData), charset); + } + + /** + * 将十六进制字符串解码为byte[] + * + * @param hexStr 十六进制String + * @return byte[] + */ + public static byte[] decodeHex(String hexStr) { + return decodeHex((CharSequence) hexStr); + } + + /** + * 将十六进制字符数组转换为字节数组 + * + * @param hexData 十六进制char[] + * @return byte[] + * @throws RuntimeException 如果源十六进制字符数组是一个奇怪的长度，将抛出运行时异常 + */ + public static byte[] decodeHex(char[] hexData) { + return decodeHex(String.valueOf(hexData)); + } + + /** + * 将十六进制字符数组转换为字节数组 + * + * @param hexData 十六进制字符串 + * @return byte[] + * @throws UtilException 如果源十六进制字符数组是一个奇怪的长度，将抛出运行时异常 + * @since 5.6.6 + */ + public static byte[] decodeHex(CharSequence hexData) { + return Base16Codec.CODEC_LOWER.decode(hexData); + } + + // ---------------------------------------------------------------------------------------- Color + + /** + * 将{@link Color}编码为Hex形式 + * + * @param color {@link Color} + * @return Hex字符串 + * @since 3.0.8 + */ + public static String encodeColor(Color color) { + return encodeColor(color, "#"); + } + + /** + * 将{@link Color}编码为Hex形式 + * + * @param color {@link Color} + * @param prefix 前缀字符串，可以是#、0x等 + * @return Hex字符串 + * @since 3.0.8 + */ + public static String encodeColor(Color color, String prefix) { + final StringBuilder builder = new StringBuilder(prefix); + String colorHex; + colorHex = Integer.toHexString(color.getRed()); + if (1 == colorHex.length()) { + builder.append('0'); + } + builder.append(colorHex); + colorHex = Integer.toHexString(color.getGreen()); + if (1 == colorHex.length()) { + builder.append('0'); + } + builder.append(colorHex); + colorHex = Integer.toHexString(color.getBlue()); + if (1 == colorHex.length()) { + builder.append('0'); + } + builder.append(colorHex); + return builder.toString(); + } + + /** + * 将Hex颜色值转为 + * + * @param hexColor 16进制颜色值，可以以#开头，也可以用0x开头 + * @return {@link Color} + * @since 3.0.8 + */ + public static Color decodeColor(String hexColor) { + return Color.decode(hexColor); + } + + /** + * 将指定int值转换为Unicode字符串形式，常用于特殊字符（例如汉字）转Unicode形式
+ * 转换的字符串如果u后不足4位，则前面用0填充，例如： + * + * 

+	 * '你' =》\u4f60
+	 *
+ * + * @param value int值，也可以是char + * @return Unicode表现形式 + */ + public static String toUnicodeHex(int value) { + final StringBuilder builder = new StringBuilder(6); + + builder.append("\\u"); + String hex = toHex(value); + int len = hex.length(); + if (len < 4) { + builder.append("0000", 0, 4 - len);// 不足4位补0 + } + builder.append(hex); + + return builder.toString(); + } + + /** + * 将指定char值转换为Unicode字符串形式，常用于特殊字符（例如汉字）转Unicode形式
+ * 转换的字符串如果u后不足4位，则前面用0填充，例如： + * + * 
+	 * '你' =》'\u4f60'
+	 *
+ * + * @param ch char值 + * @return Unicode表现形式 + * @since 4.0.1 + */ + public static String toUnicodeHex(char ch) { + return Base16Codec.CODEC_LOWER.toUnicodeHex(ch); + } + + /** + * 转为16进制字符串 + * + * @param value int值 + * @return 16进制字符串 + * @since 4.4.1 + */ + public static String toHex(int value) { + return Integer.toHexString(value); + } + + /** + * 16进制字符串转为int + * + * @param value 16进制字符串 + * @return 16进制字符串int值 + * @since 5.7.4 + */ + public static int hexToInt(String value) { + return Integer.parseInt(value, 16); + } + + /** + * 转为16进制字符串 + * + * @param value int值 + * @return 16进制字符串 + * @since 4.4.1 + */ + public static String toHex(long value) { + return Long.toHexString(value); + } + + /** + * 16进制字符串转为long + * + * @param value 16进制字符串 + * @return long值 + * @since 5.7.4 + */ + public static long hexToLong(String value) { + return Long.parseLong(value, 16); + } + + /** + * 将byte值转为16进制并添加到{@link StringBuilder}中 + * + * @param builder {@link StringBuilder} + * @param b byte + * @param toLowerCase 是否使用小写 + * @since 4.4.1 + */ + public static void appendHex(StringBuilder builder, byte b, boolean toLowerCase) { + (toLowerCase ? Base16Codec.CODEC_LOWER : Base16Codec.CODEC_UPPER).appendHex(builder, b); + } + + /** + * Hex（16进制）字符串转为BigInteger + * + * @param hexStr Hex(16进制字符串) + * @return {@link BigInteger} + * @since 5.2.0 + */ + public static BigInteger toBigInteger(String hexStr) { + if (null == hexStr) { + return null; + } + return new BigInteger(hexStr, 16); + } + + /** + * 格式化Hex字符串，结果为每2位加一个空格，类似于： + * 
+	 *     e8 8c 67 03 80 cb 22 00 95 26 8f
+	 *
+ * + * @param hexStr Hex字符串 + * @return 格式化后的字符串 + */ + public static String format(String hexStr) { + final int length = hexStr.length(); + final StringBuilder builder = StrUtil.builder(length + length / 2); + builder.append(hexStr.charAt(0)).append(hexStr.charAt(1)); + for (int i = 2; i < length - 1; i += 2) { + builder.append(CharUtil.SPACE).append(hexStr.charAt(i)).append(hexStr.charAt(i + 1)); + } + return builder.toString(); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/IdUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/IdUtil.java new file mode 100755 index 0000000..c447037 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/IdUtil.java @@ -0,0 +1,299 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.ObjectId; +import aiyh.utils.tool.cn.hutool.core.lang.Singleton; +import aiyh.utils.tool.cn.hutool.core.lang.Snowflake; +import aiyh.utils.tool.cn.hutool.core.lang.UUID; +import aiyh.utils.tool.cn.hutool.core.lang.id.NanoId; +import aiyh.utils.tool.cn.hutool.core.net.NetUtil; + +/** + * ID生成器工具类，此工具类中主要封装： + * + * 
+ * 1. 唯一性ID生成器：UUID、ObjectId（MongoDB）、Snowflake
+ *
+ * + *

+ * ID相关文章见：http://calvin1978.blogcn.com/articles/uuid.html + * + * @author looly + * @since 4.1.13 + */ +public class IdUtil { + + // ------------------------------------------------------------------- UUID + + /** + * 获取随机UUID + * + * @return 随机UUID + */ + public static String randomUUID() { + return UUID.randomUUID().toString(); + } + + /** + * 简化的UUID，去掉了横线 + * + * @return 简化的UUID，去掉了横线 + */ + public static String simpleUUID() { + return UUID.randomUUID().toString(true); + } + + /** + * 获取随机UUID，使用性能更好的ThreadLocalRandom生成UUID + * + * @return 随机UUID + * @since 4.1.19 + */ + public static String fastUUID() { + return UUID.fastUUID().toString(); + } + + /** + * 简化的UUID，去掉了横线，使用性能更好的ThreadLocalRandom生成UUID + * + * @return 简化的UUID，去掉了横线 + * @since 4.1.19 + */ + public static String fastSimpleUUID() { + return UUID.fastUUID().toString(true); + } + + /** + * 创建MongoDB ID生成策略实现
+ * ObjectId由以下几部分组成： + * + * 

+	 * 1. Time 时间戳。
+	 * 2. Machine 所在主机的唯一标识符，一般是机器主机名的散列值。
+	 * 3. PID 进程ID。确保同一机器中不冲突
+	 * 4. INC 自增计数器。确保同一秒内产生objectId的唯一性。
+	 *
+ *

+ * 参考：http://blog.csdn.net/qxc1281/article/details/54021882 + * + * @return ObjectId + */ + public static String objectId() { + return ObjectId.next(); + } + + /** + * 创建Twitter的Snowflake 算法生成器。 + *

+ * 特别注意：此方法调用后会创建独立的{@link Snowflake}对象，每个独立的对象ID不互斥，会导致ID重复，请自行保证单例！ + *

+ * 分布式系统中，有一些需要使用全局唯一ID的场景，有些时候我们希望能使用一种简单一些的ID，并且希望ID能够按照时间有序生成。 + * + *

+ * snowflake的结构如下(每部分用-分开):
+ * + * 

+	 * 0 - 0000000000 0000000000 0000000000 0000000000 0 - 00000 - 00000 - 000000000000
+	 *
+ *

+ * 第一位为未使用，接下来的41位为毫秒级时间(41位的长度可以使用69年)
+ * 然后是5位datacenterId和5位workerId(10位的长度最多支持部署1024个节点）
+ * 最后12位是毫秒内的计数（12位的计数顺序号支持每个节点每毫秒产生4096个ID序号） + * + *

+ * 参考：http://www.cnblogs.com/relucent/p/4955340.html + * + * @param workerId 终端ID + * @param datacenterId 数据中心ID + * @return {@link Snowflake} + * @deprecated 此方法容易产生歧义：多个Snowflake实例产生的ID会产生重复，此对象在单台机器上必须单例，请使用{@link #getSnowflake(long, long)} + */ + @Deprecated + public static Snowflake createSnowflake(long workerId, long datacenterId) { + return new Snowflake(workerId, datacenterId); + } + + /** + * 获取单例的Twitter的Snowflake 算法生成器对象
+ * 分布式系统中，有一些需要使用全局唯一ID的场景，有些时候我们希望能使用一种简单一些的ID，并且希望ID能够按照时间有序生成。 + * + *

+ * snowflake的结构如下(每部分用-分开):
+ * + * 

+	 * 0 - 0000000000 0000000000 0000000000 0000000000 0 - 00000 - 00000 - 000000000000
+	 *
+ *

+ * 第一位为未使用，接下来的41位为毫秒级时间(41位的长度可以使用69年)
+ * 然后是5位datacenterId和5位workerId(10位的长度最多支持部署1024个节点）
+ * 最后12位是毫秒内的计数（12位的计数顺序号支持每个节点每毫秒产生4096个ID序号） + * + *

+ * 参考：http://www.cnblogs.com/relucent/p/4955340.html + * + * @param workerId 终端ID + * @param datacenterId 数据中心ID + * @return {@link Snowflake} + * @since 4.5.9 + */ + public static Snowflake getSnowflake(long workerId, long datacenterId) { + return Singleton.get(Snowflake.class, workerId, datacenterId); + } + + /** + * 获取单例的Twitter的Snowflake 算法生成器对象
+ * 分布式系统中，有一些需要使用全局唯一ID的场景，有些时候我们希望能使用一种简单一些的ID，并且希望ID能够按照时间有序生成。 + * + *

+ * snowflake的结构如下(每部分用-分开):
+ * + * 

+	 * 0 - 0000000000 0000000000 0000000000 0000000000 0 - 00000 - 00000 - 000000000000
+	 *
+ *

+ * 第一位为未使用，接下来的41位为毫秒级时间(41位的长度可以使用69年)
+ * 然后是5位datacenterId和5位workerId(10位的长度最多支持部署1024个节点）
+ * 最后12位是毫秒内的计数（12位的计数顺序号支持每个节点每毫秒产生4096个ID序号） + * + *

+ * 参考：http://www.cnblogs.com/relucent/p/4955340.html + * + * @param workerId 终端ID + * @return {@link Snowflake} + * @since 5.7.3 + */ + public static Snowflake getSnowflake(long workerId) { + return Singleton.get(Snowflake.class, workerId); + } + + /** + * 获取单例的Twitter的Snowflake 算法生成器对象
+ * 分布式系统中，有一些需要使用全局唯一ID的场景，有些时候我们希望能使用一种简单一些的ID，并且希望ID能够按照时间有序生成。 + * + *

+ * snowflake的结构如下(每部分用-分开):
+ * + * 

+	 * 0 - 0000000000 0000000000 0000000000 0000000000 0 - 00000 - 00000 - 000000000000
+	 *
+ *

+ * 第一位为未使用，接下来的41位为毫秒级时间(41位的长度可以使用69年)
+ * 然后是5位datacenterId和5位workerId(10位的长度最多支持部署1024个节点）
+ * 最后12位是毫秒内的计数（12位的计数顺序号支持每个节点每毫秒产生4096个ID序号） + * + *

+ * 参考：http://www.cnblogs.com/relucent/p/4955340.html + * + * @return {@link Snowflake} + * @since 5.7.3 + */ + public static Snowflake getSnowflake() { + return Singleton.get(Snowflake.class); + } + + /** + * 获取数据中心ID
+ * 数据中心ID依赖于本地网卡MAC地址。 + *

+ * 此算法来自于mybatis-plus#Sequence + *

+ * + * @param maxDatacenterId 最大的中心ID + * @return 数据中心ID + * @since 5.7.3 + */ + public static long getDataCenterId(long maxDatacenterId) { + Assert.isTrue(maxDatacenterId > 0, "maxDatacenterId must be > 0"); + if(maxDatacenterId == Long.MAX_VALUE){ + maxDatacenterId -= 1; + } + long id = 1L; + byte[] mac = null; + try{ + mac = NetUtil.getLocalHardwareAddress(); + }catch (UtilException ignore){ + // ignore + } + if (null != mac) { + id = ((0x000000FF & (long) mac[mac.length - 2]) + | (0x0000FF00 & (((long) mac[mac.length - 1]) << 8))) >> 6; + id = id % (maxDatacenterId + 1); + } + + return id; + } + + /** + * 获取机器ID，使用进程ID配合数据中心ID生成
+ * 机器依赖于本进程ID或进程名的Hash值。 + * + *

+ * 此算法来自于mybatis-plus#Sequence + *

+ * + * @param datacenterId 数据中心ID + * @param maxWorkerId 最大的机器节点ID + * @return ID + * @since 5.7.3 + */ + public static long getWorkerId(long datacenterId, long maxWorkerId) { + final StringBuilder mpid = new StringBuilder(); + mpid.append(datacenterId); + try { + mpid.append(RuntimeUtil.getPid()); + } catch (UtilException igonre) { + //ignore + } + /* + * MAC + PID 的 hashcode 获取16个低位 + */ + return (mpid.toString().hashCode() & 0xffff) % (maxWorkerId + 1); + } + + // ------------------------------------------------------------------- NanoId + + /** + * 获取随机NanoId + * + * @return 随机NanoId + * @since 5.7.5 + */ + public static String nanoId() { + return NanoId.randomNanoId(); + } + + /** + * 获取随机NanoId + * + * @param size ID中的字符数量 + * @return 随机NanoId + * @since 5.7.5 + */ + public static String nanoId(int size) { + return NanoId.randomNanoId(size); + } + + /** + * 简单获取Snowflake 的 nextId + * 终端ID 数据中心ID 默认为1 + * + * @return nextId + * @since 5.7.18 + */ + public static long getSnowflakeNextId() { + return getSnowflake().nextId(); + } + + /** + * 简单获取Snowflake 的 nextId + * 终端ID 数据中心ID 默认为1 + * + * @return nextIdStr + * @since 5.7.18 + */ + public static String getSnowflakeNextIdStr() { + return getSnowflake().nextIdStr(); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/IdcardUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/IdcardUtil.java new file mode 100755 index 0000000..7dc3344 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/IdcardUtil.java @@ -0,0 +1,809 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.date.DatePattern; +import aiyh.utils.tool.cn.hutool.core.date.DateTime; +import aiyh.utils.tool.cn.hutool.core.date.DateUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.PatternPool; +import aiyh.utils.tool.cn.hutool.core.lang.Validator; + +import java.io.Serializable; +import java.util.Date; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +/** + * 身份证相关工具类
+ * see https://www.oschina.net/code/snippet_1611_2881 + * + *

+ * 本工具并没有对行政区划代码做校验，如有需求，请参阅（2018年10月）： + * http://www.mca.gov.cn/article/sj/xzqh/2018/201804-12/20181011221630.html + *

+ * + * @author Looly + * @since 3.0.4 + */ +public class IdcardUtil { + + /** + * 中国公民身份证号码最小长度。 + */ + private static final int CHINA_ID_MIN_LENGTH = 15; + /** + * 中国公民身份证号码最大长度。 + */ + private static final int CHINA_ID_MAX_LENGTH = 18; + /** + * 每位加权因子 + */ + private static final int[] POWER = {7, 9, 10, 5, 8, 4, 2, 1, 6, 3, 7, 9, 10, 5, 8, 4, 2}; + /** + * 省市代码表 + */ + private static final Map CITY_CODES = new HashMap<>(); + /** + * 台湾身份首字母对应数字 + */ + private static final Map TW_FIRST_CODE = new HashMap<>(); + + static { + CITY_CODES.put("11", "北京"); + CITY_CODES.put("12", "天津"); + CITY_CODES.put("13", "河北"); + CITY_CODES.put("14", "山西"); + CITY_CODES.put("15", "内蒙古"); + CITY_CODES.put("21", "辽宁"); + CITY_CODES.put("22", "吉林"); + CITY_CODES.put("23", "黑龙江"); + CITY_CODES.put("31", "上海"); + CITY_CODES.put("32", "江苏"); + CITY_CODES.put("33", "浙江"); + CITY_CODES.put("34", "安徽"); + CITY_CODES.put("35", "福建"); + CITY_CODES.put("36", "江西"); + CITY_CODES.put("37", "山东"); + CITY_CODES.put("41", "河南"); + CITY_CODES.put("42", "湖北"); + CITY_CODES.put("43", "湖南"); + CITY_CODES.put("44", "广东"); + CITY_CODES.put("45", "广西"); + CITY_CODES.put("46", "海南"); + CITY_CODES.put("50", "重庆"); + CITY_CODES.put("51", "四川"); + CITY_CODES.put("52", "贵州"); + CITY_CODES.put("53", "云南"); + CITY_CODES.put("54", "西藏"); + CITY_CODES.put("61", "陕西"); + CITY_CODES.put("62", "甘肃"); + CITY_CODES.put("63", "青海"); + CITY_CODES.put("64", "宁夏"); + CITY_CODES.put("65", "新疆"); + CITY_CODES.put("71", "台湾"); + CITY_CODES.put("81", "香港"); + CITY_CODES.put("82", "澳门"); + //issue#1277，台湾身份证号码以83开头，但是行政区划为71 + CITY_CODES.put("83", "台湾"); + CITY_CODES.put("91", "国外"); + + TW_FIRST_CODE.put('A', 10); + TW_FIRST_CODE.put('B', 11); + TW_FIRST_CODE.put('C', 12); + TW_FIRST_CODE.put('D', 13); + TW_FIRST_CODE.put('E', 14); + TW_FIRST_CODE.put('F', 15); + TW_FIRST_CODE.put('G', 16); + TW_FIRST_CODE.put('H', 17); + TW_FIRST_CODE.put('J', 18); + TW_FIRST_CODE.put('K', 19); + TW_FIRST_CODE.put('L', 20); + TW_FIRST_CODE.put('M', 21); + TW_FIRST_CODE.put('N', 22); + TW_FIRST_CODE.put('P', 23); + TW_FIRST_CODE.put('Q', 24); + TW_FIRST_CODE.put('R', 25); + TW_FIRST_CODE.put('S', 26); + TW_FIRST_CODE.put('T', 27); + TW_FIRST_CODE.put('U', 28); + TW_FIRST_CODE.put('V', 29); + TW_FIRST_CODE.put('X', 30); + TW_FIRST_CODE.put('Y', 31); + TW_FIRST_CODE.put('W', 32); + TW_FIRST_CODE.put('Z', 33); + TW_FIRST_CODE.put('I', 34); + TW_FIRST_CODE.put('O', 35); + } + + /** + * 将15位身份证号码转换为18位 + * + * @param idCard 15位身份编码 + * @return 18位身份编码 + */ + public static String convert15To18(String idCard) { + StringBuilder idCard18; + if (idCard.length() != CHINA_ID_MIN_LENGTH) { + return null; + } + if (ReUtil.isMatch(PatternPool.NUMBERS, idCard)) { + // 获取出生年月日 + String birthday = idCard.substring(6, 12); + Date birthDate = DateUtil.parse(birthday, "yyMMdd"); + // 获取出生年(完全表现形式,如：2010) + int sYear = DateUtil.year(birthDate); + if (sYear > 2000) { + // 2000年之后不存在15位身份证号，此处用于修复此问题的判断 + sYear -= 100; + } + idCard18 = StrUtil.builder().append(idCard, 0, 6).append(sYear).append(idCard.substring(8)); + // 获取校验位 + char sVal = getCheckCode18(idCard18.toString()); + idCard18.append(sVal); + } else { + return null; + } + return idCard18.toString(); + } + + /** + * 将18位身份证号码转换为15位 + * + * @param idCard 18位身份编码 + * @return 15位身份编码 + */ + public static String convert18To15(String idCard) { + if (StrUtil.isNotBlank(idCard) && IdcardUtil.isValidCard18(idCard)) { + return idCard.substring(0, 6) + idCard.substring(8, idCard.length() - 1); + } + return idCard; + } + + /** + * 是否有效身份证号，忽略X的大小写
+ * 如果身份证号码中含有空格始终返回{@code false} + * + * @param idCard 身份证号，支持18位、15位和港澳台的10位 + * @return 是否有效 + */ + public static boolean isValidCard(String idCard) { + if (StrUtil.isBlank(idCard)) { + return false; + } + + //idCard = idCard.trim(); + int length = idCard.length(); + switch (length) { + case 18:// 18位身份证 + return isValidCard18(idCard); + case 15:// 15位身份证 + return isValidCard15(idCard); + case 10: {// 10位身份证，港澳台地区 + String[] cardVal = isValidCard10(idCard); + return null != cardVal && "true".equals(cardVal[2]); + } + default: + return false; + } + } + + /** + *

+ * 判断18位身份证的合法性 + *

+ * 根据〖中华人民共和国国家标准GB11643-1999〗中有关公民身份号码的规定，公民身份号码是特征组合码，由十七位数字本体码和一位数字校验码组成。
+ * 排列顺序从左至右依次为：六位数字地址码，八位数字出生日期码，三位数字顺序码和一位数字校验码。 + *

+ * 顺序码: 表示在同一地址码所标识的区域范围内，对同年、同月、同 日出生的人编定的顺序号，顺序码的奇数分配给男性，偶数分配 给女性。 + *

+ *
    + *
  1. 第1、2位数字表示：所在省份的代码
    2. + *
  2. 第3、4位数字表示：所在城市的代码
    3. + *
  3. 第5、6位数字表示：所在区县的代码
    4. + *
  4. 第7~14位数字表示：出生年、月、日
    5. + *
  5. 第15、16位数字表示：所在地的派出所的代码
    6. + *
  6. 第17位数字表示性别：奇数表示男性，偶数表示女性
    7. + *
  7. 第18位数字是校检码，用来检验身份证的正确性。校检码可以是0~9的数字，有时也用x表示
    8. + *
+ *

+ * 第十八位数字(校验码)的计算方法为： + *

    + *
  1. 将前面的身份证号码17位数分别乘以不同的系数。从第一位到第十七位的系数分别为：7 9 10 5 8 4 2 1 6 3 7 9 10 5 8 4 2
    2. + *
  2. 将这17位数字和系数相乘的结果相加
    3. + *
  3. 用加出来和除以11，看余数是多少
    4. + *
  4. 余数只可能有0 1 2 3 4 5 6 7 8 9 10这11个数字。其分别对应的最后一位身份证的号码为1 0 X 9 8 7 6 5 4 3 2
    5. + *
  5. 通过上面得知如果余数是2，就会在身份证的第18位数字上出现罗马数字的Ⅹ。如果余数是10，身份证的最后一位号码就是2
    6. + *
+ *
    + *
  1. 香港人在大陆的身份证，【810000】开头；同样可以直接获取到 性别、出生日期
    2. + *
  2. 81000019980902013X: 文绎循 男 1998-09-02
    3. + *
  3. 810000201011210153: 辛烨 男 2010-11-21
    4. + *
+ *
    + *
  1. 澳门人在大陆的身份证，【820000】开头；同样可以直接获取到 性别、出生日期
    2. + *
  2. 820000200009100032: 黄敬杰 男 2000-09-10
    3. + *
+ *
    + *
  1. 台湾人在大陆的身份证，【830000】开头；同样可以直接获取到 性别、出生日期
    2. + *
  2. 830000200209060065: 王宜妃 女 2002-09-06
    3. + *
  3. 830000194609150010: 苏建文 男 1946-09-14
    4. + *
  4. 83000019810715006X: 刁婉琇 女 1981-07-15
    5. + *
+ * + * @param idcard 待验证的身份证 + * @return 是否有效的18位身份证，忽略x的大小写 + */ + public static boolean isValidCard18(String idcard) { + return isValidCard18(idcard, true); + } + + /** + *

+ * 判断18位身份证的合法性 + *

+ * 根据〖中华人民共和国国家标准GB11643-1999〗中有关公民身份号码的规定，公民身份号码是特征组合码，由十七位数字本体码和一位数字校验码组成。
+ * 排列顺序从左至右依次为：六位数字地址码，八位数字出生日期码，三位数字顺序码和一位数字校验码。 + *

+ * 顺序码: 表示在同一地址码所标识的区域范围内，对同年、同月、同 日出生的人编定的顺序号，顺序码的奇数分配给男性，偶数分配 给女性。 + *

+ *
    + *
  1. 第1、2位数字表示：所在省份的代码
    2. + *
  2. 第3、4位数字表示：所在城市的代码
    3. + *
  3. 第5、6位数字表示：所在区县的代码
    4. + *
  4. 第7~14位数字表示：出生年、月、日
    5. + *
  5. 第15、16位数字表示：所在地的派出所的代码
    6. + *
  6. 第17位数字表示性别：奇数表示男性，偶数表示女性
    7. + *
  7. 第18位数字是校检码，用来检验身份证的正确性。校检码可以是0~9的数字，有时也用x表示
    8. + *
+ *

+ * 第十八位数字(校验码)的计算方法为： + *

    + *
  1. 将前面的身份证号码17位数分别乘以不同的系数。从第一位到第十七位的系数分别为：7 9 10 5 8 4 2 1 6 3 7 9 10 5 8 4 2
    2. + *
  2. 将这17位数字和系数相乘的结果相加
    3. + *
  3. 用加出来和除以11，看余数是多少
    4. + *
  4. 余数只可能有0 1 2 3 4 5 6 7 8 9 10这11个数字。其分别对应的最后一位身份证的号码为1 0 X 9 8 7 6 5 4 3 2
    5. + *
  5. 通过上面得知如果余数是2，就会在身份证的第18位数字上出现罗马数字的Ⅹ。如果余数是10，身份证的最后一位号码就是2
    6. + *
+ * + * @param idcard 待验证的身份证 + * @param ignoreCase 是否忽略大小写。{@code true}则忽略X大小写，否则严格匹配大写。 + * @return 是否有效的18位身份证 + * @since 5.5.7 + */ + public static boolean isValidCard18(String idcard, boolean ignoreCase) { + if (CHINA_ID_MAX_LENGTH != idcard.length()) { + return false; + } + + // 省份 + final String proCode = idcard.substring(0, 2); + if (null == CITY_CODES.get(proCode)) { + return false; + } + + //校验生日 + if (false == Validator.isBirthday(idcard.substring(6, 14))) { + return false; + } + + // 前17位 + final String code17 = idcard.substring(0, 17); + if (ReUtil.isMatch(PatternPool.NUMBERS, code17)) { + // 获取校验位 + char val = getCheckCode18(code17); + // 第18位 + return CharUtil.equals(val, idcard.charAt(17), ignoreCase); + } + return false; + } + + /** + * 验证15位身份编码是否合法 + * + * @param idcard 身份编码 + * @return 是否合法 + */ + public static boolean isValidCard15(String idcard) { + if (CHINA_ID_MIN_LENGTH != idcard.length()) { + return false; + } + if (ReUtil.isMatch(PatternPool.NUMBERS, idcard)) { + // 省份 + String proCode = idcard.substring(0, 2); + if (null == CITY_CODES.get(proCode)) { + return false; + } + + //校验生日（两位年份，补充为19XX） + return false != Validator.isBirthday("19" + idcard.substring(6, 12)); + } else { + return false; + } + } + + /** + * 验证10位身份编码是否合法 + * + * @param idcard 身份编码 + * @return 身份证信息数组 + *

+ * [0] - 台湾、澳门、香港 [1] - 性别(男M,女F,未知N) [2] - 是否合法(合法true,不合法false) 若不是身份证件号码则返回null + *

+ */ + public static String[] isValidCard10(String idcard) { + if (StrUtil.isBlank(idcard)) { + return null; + } + String[] info = new String[3]; + String card = idcard.replaceAll("[()]", ""); + if (card.length() != 8 && card.length() != 9 && idcard.length() != 10) { + return null; + } + if (idcard.matches("^[a-zA-Z][0-9]{9}$")) { // 台湾 + info[0] = "台湾"; + char char2 = idcard.charAt(1); + if ('1' == char2) { + info[1] = "M"; + } else if ('2' == char2) { + info[1] = "F"; + } else { + info[1] = "N"; + info[2] = "false"; + return info; + } + info[2] = isValidTWCard(idcard) ? "true" : "false"; + } else if (idcard.matches("^[157][0-9]{6}\\(?[0-9A-Z]\\)?$")) { // 澳门 + info[0] = "澳门"; + info[1] = "N"; + info[2] = "true"; + } else if (idcard.matches("^[A-Z]{1,2}[0-9]{6}\\(?[0-9A]\\)?$")) { // 香港 + info[0] = "香港"; + info[1] = "N"; + info[2] = isValidHKCard(idcard) ? "true" : "false"; + } else { + return null; + } + return info; + } + + /** + * 验证台湾身份证号码 + * + * @param idcard 身份证号码 + * @return 验证码是否符合 + */ + public static boolean isValidTWCard(String idcard) { + if (null == idcard || idcard.length() != 10) { + return false; + } + final Integer iStart = TW_FIRST_CODE.get(idcard.charAt(0)); + if (null == iStart) { + return false; + } + int sum = iStart / 10 + (iStart % 10) * 9; + + final String mid = idcard.substring(1, 9); + final char[] chars = mid.toCharArray(); + int iflag = 8; + for (char c : chars) { + sum += Integer.parseInt(String.valueOf(c)) * iflag; + iflag--; + } + + final String end = idcard.substring(9, 10); + return (sum % 10 == 0 ? 0 : (10 - sum % 10)) == Integer.parseInt(end); + } + + /** + * 验证香港身份证号码(存在Bug，部份特殊身份证无法检查) + *

+ * 身份证前2位为英文字符，如果只出现一个英文字符则表示第一位是空格，对应数字58 前2位英文字符A-Z分别对应数字10-35 最后一位校验码为0-9的数字加上字符"A"，"A"代表10 + *

+ *

+ * 将身份证号码全部转换为数字，分别对应乘9-1相加的总和，整除11则证件号码有效 + *

+ * + * @param idcard 身份证号码 + * @return 验证码是否符合 + */ + public static boolean isValidHKCard(String idcard) { + String card = idcard.replaceAll("[()]", ""); + int sum; + if (card.length() == 9) { + sum = (Character.toUpperCase(card.charAt(0)) - 55) * 9 + (Character.toUpperCase(card.charAt(1)) - 55) * 8; + card = card.substring(1, 9); + } else { + sum = 522 + (Character.toUpperCase(card.charAt(0)) - 55) * 8; + } + + // 首字母A-Z，A表示1，以此类推 + String mid = card.substring(1, 7); + String end = card.substring(7, 8); + char[] chars = mid.toCharArray(); + int iflag = 7; + for (char c : chars) { + sum = sum + Integer.parseInt(String.valueOf(c)) * iflag; + iflag--; + } + if ("A".equalsIgnoreCase(end)) { + sum += 10; + } else { + sum += Integer.parseInt(end); + } + return sum % 11 == 0; + } + + /** + * 根据身份编号获取生日，只支持15或18位身份证号码 + * + * @param idcard 身份编号 + * @return 生日(yyyyMMdd) + * @see #getBirth(String) + */ + public static String getBirthByIdCard(String idcard) { + return getBirth(idcard); + } + + /** + * 根据身份编号获取生日，只支持15或18位身份证号码 + * + * @param idCard 身份编号 + * @return 生日(yyyyMMdd) + */ + public static String getBirth(String idCard) { + Assert.notBlank(idCard, "id card must be not blank!"); + final int len = idCard.length(); + if (len < CHINA_ID_MIN_LENGTH) { + return null; + } else if (len == CHINA_ID_MIN_LENGTH) { + idCard = convert15To18(idCard); + } + + return Objects.requireNonNull(idCard).substring(6, 14); + } + + /** + * 从身份证号码中获取生日日期，只支持15或18位身份证号码 + * + * @param idCard 身份证号码 + * @return 日期 + */ + public static DateTime getBirthDate(String idCard) { + final String birthByIdCard = getBirthByIdCard(idCard); + return null == birthByIdCard ? null : DateUtil.parse(birthByIdCard, DatePattern.PURE_DATE_FORMAT); + } + + /** + * 根据身份编号获取年龄，只支持15或18位身份证号码 + * + * @param idcard 身份编号 + * @return 年龄 + */ + public static int getAgeByIdCard(String idcard) { + return getAgeByIdCard(idcard, DateUtil.date()); + } + + /** + * 根据身份编号获取指定日期当时的年龄年龄，只支持15或18位身份证号码 + * + * @param idcard 身份编号 + * @param dateToCompare 以此日期为界，计算年龄。 + * @return 年龄 + */ + public static int getAgeByIdCard(String idcard, Date dateToCompare) { + String birth = getBirthByIdCard(idcard); + return DateUtil.age(DateUtil.parse(birth, "yyyyMMdd"), dateToCompare); + } + + /** + * 根据身份编号获取生日年，只支持15或18位身份证号码 + * + * @param idcard 身份编号 + * @return 生日(yyyy) + */ + public static Short getYearByIdCard(String idcard) { + final int len = idcard.length(); + if (len < CHINA_ID_MIN_LENGTH) { + return null; + } else if (len == CHINA_ID_MIN_LENGTH) { + idcard = convert15To18(idcard); + } + return Short.valueOf(Objects.requireNonNull(idcard).substring(6, 10)); + } + + /** + * 根据身份编号获取生日月，只支持15或18位身份证号码 + * + * @param idcard 身份编号 + * @return 生日(MM) + */ + public static Short getMonthByIdCard(String idcard) { + final int len = idcard.length(); + if (len < CHINA_ID_MIN_LENGTH) { + return null; + } else if (len == CHINA_ID_MIN_LENGTH) { + idcard = convert15To18(idcard); + } + return Short.valueOf(Objects.requireNonNull(idcard).substring(10, 12)); + } + + /** + * 根据身份编号获取生日天，只支持15或18位身份证号码 + * + * @param idcard 身份编号 + * @return 生日(dd) + */ + public static Short getDayByIdCard(String idcard) { + final int len = idcard.length(); + if (len < CHINA_ID_MIN_LENGTH) { + return null; + } else if (len == CHINA_ID_MIN_LENGTH) { + idcard = convert15To18(idcard); + } + return Short.valueOf(Objects.requireNonNull(idcard).substring(12, 14)); + } + + /** + * 根据身份编号获取性别，只支持15或18位身份证号码 + * + * @param idcard 身份编号 + * @return 性别(1 : 男 ， 0 : 女) + */ + public static int getGenderByIdCard(String idcard) { + Assert.notBlank(idcard); + final int len = idcard.length(); + if (len < CHINA_ID_MIN_LENGTH) { + throw new IllegalArgumentException("ID Card length must be 15 or 18"); + } + + if (len == CHINA_ID_MIN_LENGTH) { + idcard = convert15To18(idcard); + } + char sCardChar = Objects.requireNonNull(idcard).charAt(16); + return (sCardChar % 2 != 0) ? 1 : 0; + } + + /** + * 根据身份编号获取户籍省份编码，只支持15或18位身份证号码 + * + * @param idcard 身份编码 + * @return 省份编码 + * @since 5.7.2 + */ + public static String getProvinceCodeByIdCard(String idcard) { + int len = idcard.length(); + if (len == CHINA_ID_MIN_LENGTH || len == CHINA_ID_MAX_LENGTH) { + return idcard.substring(0, 2); + } + return null; + } + + /** + * 根据身份编号获取户籍省份，只支持15或18位身份证号码 + * + * @param idcard 身份编码 + * @return 省份名称。 + */ + public static String getProvinceByIdCard(String idcard) { + final String code = getProvinceCodeByIdCard(idcard); + if (StrUtil.isNotBlank(code)) { + return CITY_CODES.get(code); + } + return null; + } + + /** + * 根据身份编号获取地市级编码，只支持15或18位身份证号码
+ * 获取编码为4位 + * + * @param idcard 身份编码 + * @return 地市级编码 + */ + public static String getCityCodeByIdCard(String idcard) { + int len = idcard.length(); + if (len == CHINA_ID_MIN_LENGTH || len == CHINA_ID_MAX_LENGTH) { + return idcard.substring(0, 4); + } + return null; + } + + /** + * 根据身份编号获取区县级编码，只支持15或18位身份证号码
+ * 获取编码为6位 + * + * @param idcard 身份编码 + * @return 地市级编码 + * @since 5.8.0 + */ + public static String getDistrictCodeByIdCard(String idcard) { + int len = idcard.length(); + if (len == CHINA_ID_MIN_LENGTH || len == CHINA_ID_MAX_LENGTH) { + return idcard.substring(0, 6); + } + return null; + } + + /** + * 隐藏指定位置的几个身份证号数字为“*” + * + * @param idcard 身份证号 + * @param startInclude 开始位置（包含） + * @param endExclude 结束位置（不包含） + * @return 隐藏后的身份证号码 + * @see StrUtil#hide(CharSequence, int, int) + * @since 3.2.2 + */ + public static String hide(String idcard, int startInclude, int endExclude) { + return StrUtil.hide(idcard, startInclude, endExclude); + } + + /** + * 获取身份证信息，包括身份、城市代码、生日、性别等 + * + * @param idcard 15或18位身份证 + * @return {@link Idcard} + * @since 5.4.3 + */ + public static Idcard getIdcardInfo(String idcard) { + return new Idcard(idcard); + } + + // ----------------------------------------------------------------------------------- Private method start + + /** + * 获得18位身份证校验码 + * + * @param code17 18位身份证号中的前17位 + * @return 第18位 + */ + private static char getCheckCode18(String code17) { + int sum = getPowerSum(code17.toCharArray()); + return getCheckCode18(sum); + } + + /** + * 将power和值与11取模获得余数进行校验码判断 + * + * @param iSum 加权和 + * @return 校验位 + */ + private static char getCheckCode18(int iSum) { + switch (iSum % 11) { + case 10: + return '2'; + case 9: + return '3'; + case 8: + return '4'; + case 7: + return '5'; + case 6: + return '6'; + case 5: + return '7'; + case 4: + return '8'; + case 3: + return '9'; + case 2: + return 'X'; + case 1: + return '0'; + case 0: + return '1'; + default: + return StrUtil.C_SPACE; + } + } + + /** + * 将身份证的每位和对应位的加权因子相乘之后，再得到和值 + * + * @param iArr 身份证号码的数组 + * @return 身份证编码 + */ + private static int getPowerSum(char[] iArr) { + int iSum = 0; + if (POWER.length == iArr.length) { + for (int i = 0; i < iArr.length; i++) { + iSum += Integer.parseInt(String.valueOf(iArr[i])) * POWER[i]; + } + } + return iSum; + } + // ----------------------------------------------------------------------------------- Private method end + + /** + * 身份证信息，包括身份、城市代码、生日、性别等 + * + * @author looly + * @since 5.4.3 + */ + public static class Idcard implements Serializable { + private static final long serialVersionUID = 1L; + + private final String provinceCode; + private final String cityCode; + private final DateTime birthDate; + private final Integer gender; + private final int age; + + /** + * 构造 + * + * @param idcard 身份证号码 + */ + public Idcard(String idcard) { + this.provinceCode = IdcardUtil.getProvinceCodeByIdCard(idcard); + this.cityCode = IdcardUtil.getCityCodeByIdCard(idcard); + this.birthDate = IdcardUtil.getBirthDate(idcard); + this.gender = IdcardUtil.getGenderByIdCard(idcard); + this.age = IdcardUtil.getAgeByIdCard(idcard); + } + + /** + * 获取省份代码 + * + * @return 省份代码 + */ + public String getProvinceCode() { + return this.provinceCode; + } + + /** + * 获取省份名称 + * + * @return 省份代码 + */ + public String getProvince() { + return CITY_CODES.get(this.provinceCode); + } + + /** + * 获取市级编码 + * + * @return 市级编码 + */ + public String getCityCode() { + return this.cityCode; + } + + /** + * 获得生日日期 + * + * @return 生日日期 + */ + public DateTime getBirthDate() { + return this.birthDate; + } + + /** + * 获取性别代号，性别(1 : 男 ， 0 : 女) + * + * @return 性别(1 : 男 ， 0 : 女) + */ + public Integer getGender() { + return this.gender; + } + + /** + * 获取年龄 + * + * @return 年龄 + */ + public int getAge() { + return age; + } + + @Override + public String toString() { + return "Idcard{" + + "provinceCode='" + provinceCode + '\'' + + ", cityCode='" + cityCode + '\'' + + ", birthDate=" + birthDate + + ", gender=" + gender + + ", age=" + age + + '}'; + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/JAXBUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/JAXBUtil.java new file mode 100644 index 0000000..e7c54f7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/JAXBUtil.java @@ -0,0 +1,118 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; + +import javax.xml.bind.JAXBContext; +import javax.xml.bind.Marshaller; +import javax.xml.bind.Unmarshaller; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlElementWrapper; +import javax.xml.bind.annotation.XmlRootElement; +import javax.xml.bind.annotation.XmlTransient; +import java.io.File; +import java.io.Reader; +import java.io.StringWriter; +import java.nio.charset.Charset; + +/** + * JAXB（Java Architecture for XML Binding），根据XML Schema产生Java对象，即实现xml和Bean互转。 + *

+ * 相关介绍： + *

    + *
  • https://www.cnblogs.com/yanghaolie/p/11110991.html
    • + *
  • https://my.oschina.net/u/4266515/blog/3330113
    • + *
+ * + * @author dazer + * @see XmlUtil + * @since 5.7.3 + */ +public class JAXBUtil { + + /** + * JavaBean转换成xml + *

+ * bean上面用的常用注解 + * + * @param bean Bean对象 + * @return 输出的XML字符串 + * @see XmlRootElement {@code @XmlRootElement(name = "school")} + * @see XmlElement {@code @XmlElement(name = "school_name", required = true)} + * @see XmlElementWrapper {@code @XmlElementWrapper(name="schools")} + * @see XmlTransient JAXB "有两个名为 "**" 的属性,类的两个属性具有相同名称 "**""解决方案 + */ + public static String beanToXml(Object bean) { + return beanToXml(bean, CharsetUtil.CHARSET_UTF_8, true); + } + + /** + * JavaBean转换成xml + * + * @param bean Bean对象 + * @param charset 编码 eg: utf-8 + * @param format 是否格式化输出eg: true + * @return 输出的XML字符串 + */ + public static String beanToXml(Object bean, Charset charset, boolean format) { + StringWriter writer; + try { + JAXBContext context = JAXBContext.newInstance(bean.getClass()); + Marshaller marshaller = context.createMarshaller(); + marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, format); + marshaller.setProperty(Marshaller.JAXB_ENCODING, charset.name()); + writer = new StringWriter(); + marshaller.marshal(bean, writer); + } catch (Exception e) { + throw new UtilException("convertToXml 错误：" + e.getMessage(), e); + } + return writer.toString(); + } + + /** + * xml转换成JavaBean + * + * @param Bean类型 + * @param xml XML字符串 + * @param c Bean类型 + * @return bean + */ + public static T xmlToBean(String xml, Class c) { + return xmlToBean(StrUtil.getReader(xml), c); + } + + /** + * XML文件转Bean + * + * @param file 文件 + * @param charset 编码 + * @param c Bean类 + * @param Bean类型 + * @return Bean + */ + public static T xmlToBean(File file, Charset charset, Class c) { + return xmlToBean(FileUtil.getReader(file, charset), c); + } + + /** + * 从{@link Reader}中读取XML字符串，并转换为Bean + * + * @param reader {@link Reader} + * @param c Bean类 + * @param Bean类型 + * @return Bean + */ + @SuppressWarnings("unchecked") + public static T xmlToBean(Reader reader, Class c) { + try { + JAXBContext context = JAXBContext.newInstance(c); + Unmarshaller unmarshaller = context.createUnmarshaller(); + return (T) unmarshaller.unmarshal(reader); + } catch (Exception e) { + throw new RuntimeException("convertToJava2 错误：" + e.getMessage(), e); + } finally { + IoUtil.close(reader); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/JNDIUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/JNDIUtil.java new file mode 100755 index 0000000..ada6afa --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/JNDIUtil.java @@ -0,0 +1,77 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; + +import javax.naming.InitialContext; +import javax.naming.NamingException; +import javax.naming.directory.Attributes; +import javax.naming.directory.InitialDirContext; +import java.util.Hashtable; +import java.util.Map; + +/** + * JNDI工具类
+ * JNDI是Java Naming and Directory Interface（JAVA命名和目录接口）的英文简写，
+ * 它是为JAVA应用程序提供命名和目录访问服务的API（Application Programing Interface，应用程序编程接口）。 + * + *

+ * 见：https://blog.csdn.net/u010430304/article/details/54601302 + *

+ * + * @author loolY + * @since 5.7.7 + */ +public class JNDIUtil { + + /** + * 创建{@link InitialDirContext} + * + * @param environment 环境参数，{code null}表示无参数 + * @return {@link InitialDirContext} + */ + public static InitialDirContext createInitialDirContext(Map environment) { + try { + if (MapUtil.isEmpty(environment)) { + return new InitialDirContext(); + } + return new InitialDirContext(Convert.convert(Hashtable.class, environment)); + } catch (NamingException e) { + throw new UtilException(e); + } + } + + /** + * 创建{@link InitialContext} + * + * @param environment 环境参数，{code null}表示无参数 + * @return {@link InitialContext} + */ + public static InitialContext createInitialContext(Map environment) { + try { + if (MapUtil.isEmpty(environment)) { + return new InitialContext(); + } + return new InitialContext(Convert.convert(Hashtable.class, environment)); + } catch (NamingException e) { + throw new UtilException(e); + } + } + + /** + * 获取指定容器环境的对象的属性
+ * 如获取DNS属性，则URI为类似：dns:hutool.cn + * + * @param uri URI字符串，格式为[scheme:][name]/[domain] + * @param attrIds 需要获取的属性ID名称 + * @return {@link Attributes} + */ + public static Attributes getAttributes(String uri, String... attrIds) { + try { + return createInitialDirContext(null).getAttributes(uri, attrIds); + } catch (NamingException e) { + throw new UtilException(e); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ModifierUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ModifierUtil.java new file mode 100644 index 0000000..312ea35 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ModifierUtil.java @@ -0,0 +1,335 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; + +import java.lang.reflect.Constructor; +import java.lang.reflect.Field; +import java.lang.reflect.Method; +import java.lang.reflect.Modifier; + +/** + * 修饰符工具类 + * + * @author looly + * @since 4.0.5 + */ +public class ModifierUtil { + + /** + * 修饰符枚举 + * + * @author looly + * @since 4.0.5 + */ + public enum ModifierType { + /** + * public修饰符，所有类都能访问 + */ + PUBLIC(Modifier.PUBLIC), + /** + * private修饰符，只能被自己访问和修改 + */ + PRIVATE(Modifier.PRIVATE), + /** + * protected修饰符，自身、子类及同一个包中类可以访问 + */ + PROTECTED(Modifier.PROTECTED), + /** + * static修饰符，（静态修饰符）指定变量被所有对象共享，即所有实例都可以使用该变量。变量属于这个类 + */ + STATIC(Modifier.STATIC), + /** + * final修饰符，最终修饰符，指定此变量的值不能变，使用在方法上表示不能被重载 + */ + FINAL(Modifier.FINAL), + /** + * synchronized，同步修饰符，在多个线程中，该修饰符用于在运行前，对他所属的方法加锁，以防止其他线程的访问，运行结束后解锁。 + */ + SYNCHRONIZED(Modifier.SYNCHRONIZED), + /** + * （易失修饰符）指定该变量可以同时被几个线程控制和修改 + */ + VOLATILE(Modifier.VOLATILE), + /** + * （过度修饰符）指定该变量是系统保留，暂无特别作用的临时性变量，序列化时忽略 + */ + TRANSIENT(Modifier.TRANSIENT), + /** + * native，本地修饰符。指定此方法的方法体是用其他语言在程序外部编写的。 + */ + NATIVE(Modifier.NATIVE), + + /** + * abstract，将一个类声明为抽象类，没有实现的方法，需要子类提供方法实现。 + */ + ABSTRACT(Modifier.ABSTRACT), + /** + * strictfp，一旦使用了关键字strictfp来声明某个类、接口或者方法时，那么在这个关键字所声明的范围内所有浮点运算都是精确的，符合IEEE-754规范的。 + */ + STRICT(Modifier.STRICT); + + /** + * 修饰符枚举对应的int修饰符值 + */ + private final int value; + + /** + * 构造 + * + * @param modifier 修饰符int表示，见{@link Modifier} + */ + ModifierType(int modifier) { + this.value = modifier; + } + + /** + * 获取修饰符枚举对应的int修饰符值，值见{@link Modifier} + * + * @return 修饰符枚举对应的int修饰符值 + */ + public int getValue() { + return this.value; + } + } + + /** + * 是否同时存在一个或多个修饰符（可能有多个修饰符，如果有指定的修饰符则返回true） + * + * @param clazz 类 + * @param modifierTypes 修饰符枚举 + * @return 是否有指定修饰符，如果有返回true，否则false，如果提供参数为null返回false + */ + public static boolean hasModifier(Class clazz, ModifierType... modifierTypes) { + if (null == clazz || ArrayUtil.isEmpty(modifierTypes)) { + return false; + } + return 0 != (clazz.getModifiers() & modifiersToInt(modifierTypes)); + } + + /** + * 是否同时存在一个或多个修饰符（可能有多个修饰符，如果有指定的修饰符则返回true） + * + * @param constructor 构造方法 + * @param modifierTypes 修饰符枚举 + * @return 是否有指定修饰符，如果有返回true，否则false，如果提供参数为null返回false + */ + public static boolean hasModifier(Constructor constructor, ModifierType... modifierTypes) { + if (null == constructor || ArrayUtil.isEmpty(modifierTypes)) { + return false; + } + return 0 != (constructor.getModifiers() & modifiersToInt(modifierTypes)); + } + + /** + * 是否同时存在一个或多个修饰符（可能有多个修饰符，如果有指定的修饰符则返回true） + * + * @param method 方法 + * @param modifierTypes 修饰符枚举 + * @return 是否有指定修饰符，如果有返回true，否则false，如果提供参数为null返回false + */ + public static boolean hasModifier(Method method, ModifierType... modifierTypes) { + if (null == method || ArrayUtil.isEmpty(modifierTypes)) { + return false; + } + return 0 != (method.getModifiers() & modifiersToInt(modifierTypes)); + } + + /** + * 是否同时存在一个或多个修饰符（可能有多个修饰符，如果有指定的修饰符则返回true） + * + * @param field 字段 + * @param modifierTypes 修饰符枚举 + * @return 是否有指定修饰符，如果有返回true，否则false，如果提供参数为null返回false + */ + public static boolean hasModifier(Field field, ModifierType... modifierTypes) { + if (null == field || ArrayUtil.isEmpty(modifierTypes)) { + return false; + } + return 0 != (field.getModifiers() & modifiersToInt(modifierTypes)); + } + + /** + * 是否是Public字段 + * + * @param field 字段 + * @return 是否是Public + */ + public static boolean isPublic(Field field) { + return hasModifier(field, ModifierType.PUBLIC); + } + + /** + * 是否是Public方法 + * + * @param method 方法 + * @return 是否是Public + */ + public static boolean isPublic(Method method) { + return hasModifier(method, ModifierType.PUBLIC); + } + + /** + * 是否是Public类 + * + * @param clazz 类 + * @return 是否是Public + */ + public static boolean isPublic(Class clazz) { + return hasModifier(clazz, ModifierType.PUBLIC); + } + + /** + * 是否是Public构造 + * + * @param constructor 构造 + * @return 是否是Public + */ + public static boolean isPublic(Constructor constructor) { + return hasModifier(constructor, ModifierType.PUBLIC); + } + + /** + * 是否是static字段 + * + * @param field 字段 + * @return 是否是static + * @since 4.0.8 + */ + public static boolean isStatic(Field field) { + return hasModifier(field, ModifierType.STATIC); + } + + /** + * 是否是static方法 + * + * @param method 方法 + * @return 是否是static + * @since 4.0.8 + */ + public static boolean isStatic(Method method) { + return hasModifier(method, ModifierType.STATIC); + } + + /** + * 是否是static类 + * + * @param clazz 类 + * @return 是否是static + * @since 4.0.8 + */ + public static boolean isStatic(Class clazz) { + return hasModifier(clazz, ModifierType.STATIC); + } + + /** + * 是否是合成字段（由java编译器生成的） + * + * @param field 字段 + * @return 是否是合成字段 + * @since 5.6.3 + */ + public static boolean isSynthetic(Field field) { + return field.isSynthetic(); + } + + /** + * 是否是合成方法（由java编译器生成的） + * + * @param method 方法 + * @return 是否是合成方法 + * @since 5.6.3 + */ + public static boolean isSynthetic(Method method) { + return method.isSynthetic(); + } + + /** + * 是否是合成类（由java编译器生成的） + * + * @param clazz 类 + * @return 是否是合成 + * @since 5.6.3 + */ + public static boolean isSynthetic(Class clazz) { + return clazz.isSynthetic(); + } + + /** + * 是否抽象方法 + * + * @param method 方法 + * @return 是否抽象方法 + * @since 5.7.23 + */ + public static boolean isAbstract(Method method) { + return hasModifier(method, ModifierType.ABSTRACT); + } + + /** + * 设置final的field字段可以被修改 + * 只要不会被编译器内联优化的 final 属性就可以通过反射有效的进行修改 -- 修改后代码中可使用到新的值; + *

以下属性，编译器会内联优化，无法通过反射修改：

+ *
    + *
  • 基本类型 byte, char, short, int, long, float, double, boolean
    • + *
  • Literal String 类型(直接双引号字符串)
    • + *
+ *

以下属性，可以通过反射修改：

+ *
    + *
  • 基本类型的包装类 Byte、Character、Short、Long、Float、Double、Boolean
    • + *
  • 字符串，通过 new String("")实例化
    • + *
  • 自定义java类
    • + *
+ * 
+	 * {@code
+	 *      //示例，移除final修饰符
+	 *      class JdbcDialects {private static final List dialects = new ArrayList<>();}
+	 *      Field field = ReflectUtil.getField(JdbcDialects.class, fieldName);
+	 * 		ReflectUtil.removeFinalModify(field);
+	 * 		ReflectUtil.setFieldValue(JdbcDialects.class, fieldName, dialects);
+	 *    }
+	 *
+ * + * @param field 被修改的field，不可以为空 + * @throws UtilException IllegalAccessException等异常包装 + * @author dazer + * @since 5.8.8 + */ + public static void removeFinalModify(Field field) { + if (field != null) { + if (hasModifier(field, ModifierUtil.ModifierType.FINAL)) { + //将字段的访问权限设为true：即去除private修饰符的影响 + if (false == field.isAccessible()) { + field.setAccessible(true); + } + try { + //去除final修饰符的影响，将字段设为可修改的 + final Field modifiersField = Field.class.getDeclaredField("modifiers"); + //Field 的 modifiers 是私有的 + modifiersField.setAccessible(true); + //& ：位与运算符，按位与； 运算规则：两个数都转为二进制，然后从高位开始比较，如果两个数都为1则为1，否则为0。 + //~ ：位非运算符，按位取反；运算规则：转成二进制，如果位为0，结果是1，如果位为1，结果是0. + modifiersField.setInt(field, field.getModifiers() & ~Modifier.FINAL); + } catch (final NoSuchFieldException | IllegalAccessException e) { + //内部，工具类，基本不抛出异常 + throw new UtilException(e, "IllegalAccess for {}.{}", field.getDeclaringClass(), field.getName()); + } + } + } + } + //-------------------------------------------------------------------------------------------------------- Private method start + + /** + * 多个修饰符做“与”操作，表示同时存在多个修饰符 + * + * @param modifierTypes 修饰符列表，元素不能为空 + * @return “与”之后的修饰符 + */ + private static int modifiersToInt(ModifierType... modifierTypes) { + int modifier = modifierTypes[0].getValue(); + for (int i = 1; i < modifierTypes.length; i++) { + modifier |= modifierTypes[i].getValue(); + } + return modifier; + } + //-------------------------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/NumberUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/NumberUtil.java new file mode 100755 index 0000000..db90aca --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/NumberUtil.java @@ -0,0 +1,2801 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.math.Calculator; + +import java.math.BigDecimal; +import java.math.BigInteger; +import java.math.RoundingMode; +import java.text.DecimalFormat; +import java.text.NumberFormat; +import java.text.ParseException; +import java.util.Collection; +import java.util.HashSet; +import java.util.Set; + +/** + * 数字工具类
+ * 对于精确值计算应该使用 {@link BigDecimal}
+ * JDK7中BigDecimal(double val)构造方法的结果有一定的不可预知性，例如： + * + * 
+ * new BigDecimal(0.1)
+ *
+ *

+ * 表示的不是0.1而是0.1000000000000000055511151231257827021181583404541015625 + * + *

+ * 这是因为0.1无法准确的表示为double。因此应该使用new BigDecimal(String)。 + *

+ * 相关介绍： + *
    + *
  • http://www.oschina.net/code/snippet_563112_25237
    • + *
  • https://github.com/venusdrogon/feilong-core/wiki/one-jdk7-bug-thinking
    • + *
+ * + * @author Looly + */ +public class NumberUtil { + + /** + * 默认除法运算精度 + */ + private static final int DEFAULT_DIV_SCALE = 10; + + /** + * 0-20对应的阶乘，超过20的阶乘会超过Long.MAX_VALUE + */ + private static final long[] FACTORIALS = new long[]{ + 1L, 1L, 2L, 6L, 24L, 120L, 720L, 5040L, 40320L, 362880L, 3628800L, 39916800L, 479001600L, 6227020800L, + 87178291200L, 1307674368000L, 20922789888000L, 355687428096000L, 6402373705728000L, 121645100408832000L, + 2432902008176640000L}; + + /** + * 提供精确的加法运算 + * + * @param v1 被加数 + * @param v2 加数 + * @return 和 + */ + public static double add(float v1, float v2) { + return add(Float.toString(v1), Float.toString(v2)).doubleValue(); + } + + /** + * 提供精确的加法运算 + * + * @param v1 被加数 + * @param v2 加数 + * @return 和 + */ + public static double add(float v1, double v2) { + return add(Float.toString(v1), Double.toString(v2)).doubleValue(); + } + + /** + * 提供精确的加法运算 + * + * @param v1 被加数 + * @param v2 加数 + * @return 和 + */ + public static double add(double v1, float v2) { + return add(Double.toString(v1), Float.toString(v2)).doubleValue(); + } + + /** + * 提供精确的加法运算 + * + * @param v1 被加数 + * @param v2 加数 + * @return 和 + */ + public static double add(double v1, double v2) { + return add(Double.toString(v1), Double.toString(v2)).doubleValue(); + } + + /** + * 提供精确的加法运算 + * + * @param v1 被加数 + * @param v2 加数 + * @return 和 + * @since 3.1.1 + */ + public static double add(Double v1, Double v2) { + //noinspection RedundantCast + return add((Number) v1, (Number) v2).doubleValue(); + } + + /** + * 提供精确的加法运算
+ * 如果传入多个值为null或者空，则返回0 + * + * @param v1 被加数 + * @param v2 加数 + * @return 和 + */ + public static BigDecimal add(Number v1, Number v2) { + return add(new Number[]{v1, v2}); + } + + /** + * 提供精确的加法运算
+ * 如果传入多个值为null或者空，则返回0 + * + * @param values 多个被加值 + * @return 和 + * @since 4.0.0 + */ + public static BigDecimal add(Number... values) { + if (ArrayUtil.isEmpty(values)) { + return BigDecimal.ZERO; + } + + Number value = values[0]; + BigDecimal result = toBigDecimal(value); + for (int i = 1; i < values.length; i++) { + value = values[i]; + if (null != value) { + result = result.add(toBigDecimal(value)); + } + } + return result; + } + + /** + * 提供精确的加法运算
+ * 如果传入多个值为null或者空，则返回0 + * + * @param values 多个被加值 + * @return 和 + * @since 4.0.0 + */ + public static BigDecimal add(String... values) { + if (ArrayUtil.isEmpty(values)) { + return BigDecimal.ZERO; + } + + String value = values[0]; + BigDecimal result = toBigDecimal(value); + for (int i = 1; i < values.length; i++) { + value = values[i]; + if (StrUtil.isNotBlank(value)) { + result = result.add(toBigDecimal(value)); + } + } + return result; + } + + /** + * 提供精确的加法运算
+ * 如果传入多个值为null或者空，则返回0 + * + * @param values 多个被加值 + * @return 和 + * @since 4.0.0 + */ + public static BigDecimal add(BigDecimal... values) { + if (ArrayUtil.isEmpty(values)) { + return BigDecimal.ZERO; + } + + BigDecimal value = values[0]; + BigDecimal result = toBigDecimal(value); + for (int i = 1; i < values.length; i++) { + value = values[i]; + if (null != value) { + result = result.add(value); + } + } + return result; + } + + /** + * 提供精确的减法运算 + * + * @param v1 被减数 + * @param v2 减数 + * @return 差 + */ + public static double sub(float v1, float v2) { + return sub(Float.toString(v1), Float.toString(v2)).doubleValue(); + } + + /** + * 提供精确的减法运算 + * + * @param v1 被减数 + * @param v2 减数 + * @return 差 + */ + public static double sub(float v1, double v2) { + return sub(Float.toString(v1), Double.toString(v2)).doubleValue(); + } + + /** + * 提供精确的减法运算 + * + * @param v1 被减数 + * @param v2 减数 + * @return 差 + */ + public static double sub(double v1, float v2) { + return sub(Double.toString(v1), Float.toString(v2)).doubleValue(); + } + + /** + * 提供精确的减法运算 + * + * @param v1 被减数 + * @param v2 减数 + * @return 差 + */ + public static double sub(double v1, double v2) { + return sub(Double.toString(v1), Double.toString(v2)).doubleValue(); + } + + /** + * 提供精确的减法运算 + * + * @param v1 被减数 + * @param v2 减数 + * @return 差 + */ + public static double sub(Double v1, Double v2) { + //noinspection RedundantCast + return sub((Number) v1, (Number) v2).doubleValue(); + } + + /** + * 提供精确的减法运算
+ * 如果传入多个值为null或者空，则返回0 + * + * @param v1 被减数 + * @param v2 减数 + * @return 差 + */ + public static BigDecimal sub(Number v1, Number v2) { + return sub(new Number[]{v1, v2}); + } + + /** + * 提供精确的减法运算
+ * 如果传入多个值为null或者空，则返回0 + * + * @param values 多个被减值 + * @return 差 + * @since 4.0.0 + */ + public static BigDecimal sub(Number... values) { + if (ArrayUtil.isEmpty(values)) { + return BigDecimal.ZERO; + } + + Number value = values[0]; + BigDecimal result = toBigDecimal(value); + for (int i = 1; i < values.length; i++) { + value = values[i]; + if (null != value) { + result = result.subtract(toBigDecimal(value)); + } + } + return result; + } + + /** + * 提供精确的减法运算
+ * 如果传入多个值为null或者空，则返回0 + * + * @param values 多个被减值 + * @return 差 + * @since 4.0.0 + */ + public static BigDecimal sub(String... values) { + if (ArrayUtil.isEmpty(values)) { + return BigDecimal.ZERO; + } + + String value = values[0]; + BigDecimal result = toBigDecimal(value); + for (int i = 1; i < values.length; i++) { + value = values[i]; + if (StrUtil.isNotBlank(value)) { + result = result.subtract(toBigDecimal(value)); + } + } + return result; + } + + /** + * 提供精确的减法运算
+ * 如果传入多个值为null或者空，则返回0 + * + * @param values 多个被减值 + * @return 差 + * @since 4.0.0 + */ + public static BigDecimal sub(BigDecimal... values) { + if (ArrayUtil.isEmpty(values)) { + return BigDecimal.ZERO; + } + + BigDecimal value = values[0]; + BigDecimal result = toBigDecimal(value); + for (int i = 1; i < values.length; i++) { + value = values[i]; + if (null != value) { + result = result.subtract(value); + } + } + return result; + } + + /** + * 提供精确的乘法运算 + * + * @param v1 被乘数 + * @param v2 乘数 + * @return 积 + */ + public static double mul(float v1, float v2) { + return mul(Float.toString(v1), Float.toString(v2)).doubleValue(); + } + + /** + * 提供精确的乘法运算 + * + * @param v1 被乘数 + * @param v2 乘数 + * @return 积 + */ + public static double mul(float v1, double v2) { + return mul(Float.toString(v1), Double.toString(v2)).doubleValue(); + } + + /** + * 提供精确的乘法运算 + * + * @param v1 被乘数 + * @param v2 乘数 + * @return 积 + */ + public static double mul(double v1, float v2) { + return mul(Double.toString(v1), Float.toString(v2)).doubleValue(); + } + + /** + * 提供精确的乘法运算 + * + * @param v1 被乘数 + * @param v2 乘数 + * @return 积 + */ + public static double mul(double v1, double v2) { + return mul(Double.toString(v1), Double.toString(v2)).doubleValue(); + } + + /** + * 提供精确的乘法运算
+ * 如果传入多个值为null或者空，则返回0 + * + * @param v1 被乘数 + * @param v2 乘数 + * @return 积 + */ + public static double mul(Double v1, Double v2) { + //noinspection RedundantCast + return mul((Number) v1, (Number) v2).doubleValue(); + } + + /** + * 提供精确的乘法运算
+ * 如果传入多个值为null或者空，则返回0 + * + * @param v1 被乘数 + * @param v2 乘数 + * @return 积 + */ + public static BigDecimal mul(Number v1, Number v2) { + return mul(new Number[]{v1, v2}); + } + + /** + * 提供精确的乘法运算
+ * 如果传入多个值为null或者空，则返回0 + * + * @param values 多个被乘值 + * @return 积 + * @since 4.0.0 + */ + public static BigDecimal mul(Number... values) { + if (ArrayUtil.isEmpty(values) || ArrayUtil.hasNull(values)) { + return BigDecimal.ZERO; + } + + Number value = values[0]; + BigDecimal result = new BigDecimal(value.toString()); + for (int i = 1; i < values.length; i++) { + value = values[i]; + result = result.multiply(new BigDecimal(value.toString())); + } + return result; + } + + /** + * 提供精确的乘法运算 + * + * @param v1 被乘数 + * @param v2 乘数 + * @return 积 + * @since 3.0.8 + */ + public static BigDecimal mul(String v1, String v2) { + return mul(new BigDecimal(v1), new BigDecimal(v2)); + } + + /** + * 提供精确的乘法运算
+ * 如果传入多个值为null或者空，则返回0 + * + * @param values 多个被乘值 + * @return 积 + * @since 4.0.0 + */ + public static BigDecimal mul(String... values) { + if (ArrayUtil.isEmpty(values) || ArrayUtil.hasNull(values)) { + return BigDecimal.ZERO; + } + + BigDecimal result = new BigDecimal(values[0]); + for (int i = 1; i < values.length; i++) { + result = result.multiply(new BigDecimal(values[i])); + } + + return result; + } + + /** + * 提供精确的乘法运算
+ * 如果传入多个值为null或者空，则返回0 + * + * @param values 多个被乘值 + * @return 积 + * @since 4.0.0 + */ + public static BigDecimal mul(BigDecimal... values) { + if (ArrayUtil.isEmpty(values) || ArrayUtil.hasNull(values)) { + return BigDecimal.ZERO; + } + + BigDecimal result = values[0]; + for (int i = 1; i < values.length; i++) { + result = result.multiply(values[i]); + } + return result; + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况的时候,精确到小数点后10位,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @return 两个参数的商 + */ + public static double div(float v1, float v2) { + return div(v1, v2, DEFAULT_DIV_SCALE); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况的时候,精确到小数点后10位,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @return 两个参数的商 + */ + public static double div(float v1, double v2) { + return div(v1, v2, DEFAULT_DIV_SCALE); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况的时候,精确到小数点后10位,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @return 两个参数的商 + */ + public static double div(double v1, float v2) { + return div(v1, v2, DEFAULT_DIV_SCALE); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况的时候,精确到小数点后10位,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @return 两个参数的商 + */ + public static double div(double v1, double v2) { + return div(v1, v2, DEFAULT_DIV_SCALE); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况的时候,精确到小数点后10位,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @return 两个参数的商 + */ + public static double div(Double v1, Double v2) { + return div(v1, v2, DEFAULT_DIV_SCALE); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况的时候,精确到小数点后10位,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @return 两个参数的商 + * @since 3.1.0 + */ + public static BigDecimal div(Number v1, Number v2) { + return div(v1, v2, DEFAULT_DIV_SCALE); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况的时候,精确到小数点后10位,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @return 两个参数的商 + */ + public static BigDecimal div(String v1, String v2) { + return div(v1, v2, DEFAULT_DIV_SCALE); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @return 两个参数的商 + */ + public static double div(float v1, float v2, int scale) { + return div(v1, v2, scale, RoundingMode.HALF_UP); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @return 两个参数的商 + */ + public static double div(float v1, double v2, int scale) { + return div(v1, v2, scale, RoundingMode.HALF_UP); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @return 两个参数的商 + */ + public static double div(double v1, float v2, int scale) { + return div(v1, v2, scale, RoundingMode.HALF_UP); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @return 两个参数的商 + */ + public static double div(double v1, double v2, int scale) { + return div(v1, v2, scale, RoundingMode.HALF_UP); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @return 两个参数的商 + */ + public static double div(Double v1, Double v2, int scale) { + return div(v1, v2, scale, RoundingMode.HALF_UP); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @return 两个参数的商 + * @since 3.1.0 + */ + public static BigDecimal div(Number v1, Number v2, int scale) { + return div(v1, v2, scale, RoundingMode.HALF_UP); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度,后面的四舍五入 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @return 两个参数的商 + */ + public static BigDecimal div(String v1, String v2, int scale) { + return div(v1, v2, scale, RoundingMode.HALF_UP); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 两个参数的商 + */ + public static double div(float v1, float v2, int scale, RoundingMode roundingMode) { + return div(Float.toString(v1), Float.toString(v2), scale, roundingMode).doubleValue(); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 两个参数的商 + */ + public static double div(float v1, double v2, int scale, RoundingMode roundingMode) { + return div(Float.toString(v1), Double.toString(v2), scale, roundingMode).doubleValue(); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 两个参数的商 + */ + public static double div(double v1, float v2, int scale, RoundingMode roundingMode) { + return div(Double.toString(v1), Float.toString(v2), scale, roundingMode).doubleValue(); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 两个参数的商 + */ + public static double div(double v1, double v2, int scale, RoundingMode roundingMode) { + return div(Double.toString(v1), Double.toString(v2), scale, roundingMode).doubleValue(); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 两个参数的商 + */ + public static double div(Double v1, Double v2, int scale, RoundingMode roundingMode) { + //noinspection RedundantCast + return div((Number) v1, (Number) v2, scale, roundingMode).doubleValue(); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 两个参数的商 + * @since 3.1.0 + */ + public static BigDecimal div(Number v1, Number v2, int scale, RoundingMode roundingMode) { + if (v1 instanceof BigDecimal && v2 instanceof BigDecimal) { + return div((BigDecimal) v1, (BigDecimal) v2, scale, roundingMode); + } + return div(StrUtil.toStringOrNull(v1), StrUtil.toStringOrNull(v2), scale, roundingMode); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 两个参数的商 + */ + public static BigDecimal div(String v1, String v2, int scale, RoundingMode roundingMode) { + return div(toBigDecimal(v1), toBigDecimal(v2), scale, roundingMode); + } + + /** + * 提供(相对)精确的除法运算,当发生除不尽的情况时,由scale指定精确度 + * + * @param v1 被除数 + * @param v2 除数 + * @param scale 精确度，如果为负值，取绝对值 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 两个参数的商 + * @since 3.0.9 + */ + public static BigDecimal div(BigDecimal v1, BigDecimal v2, int scale, RoundingMode roundingMode) { + Assert.notNull(v2, "Divisor must be not null !"); + if (null == v1) { + return BigDecimal.ZERO; + } + if (scale < 0) { + scale = -scale; + } + return v1.divide(v2, scale, roundingMode); + } + + /** + * 补充Math.ceilDiv() JDK8中添加了和Math.floorDiv()但却没有ceilDiv() + * + * @param v1 被除数 + * @param v2 除数 + * @return 两个参数的商 + * @since 5.3.3 + */ + public static int ceilDiv(int v1, int v2) { + return (int) Math.ceil((double) v1 / v2); + } + + // ------------------------------------------------------------------------------------------- round + + /** + * 保留固定位数小数
+ * 采用四舍五入策略 {@link RoundingMode#HALF_UP}
+ * 例如保留2位小数：123.456789 =》 123.46 + * + * @param v 值 + * @param scale 保留小数位数 + * @return 新值 + */ + public static BigDecimal round(double v, int scale) { + return round(v, scale, RoundingMode.HALF_UP); + } + + /** + * 保留固定位数小数
+ * 采用四舍五入策略 {@link RoundingMode#HALF_UP}
+ * 例如保留2位小数：123.456789 =》 123.46 + * + * @param v 值 + * @param scale 保留小数位数 + * @return 新值 + */ + public static String roundStr(double v, int scale) { + return round(v, scale).toPlainString(); + } + + /** + * 保留固定位数小数
+ * 采用四舍五入策略 {@link RoundingMode#HALF_UP}
+ * 例如保留2位小数：123.456789 =》 123.46 + * + * @param numberStr 数字值的字符串表现形式 + * @param scale 保留小数位数 + * @return 新值 + */ + public static BigDecimal round(String numberStr, int scale) { + return round(numberStr, scale, RoundingMode.HALF_UP); + } + + /** + * 保留固定位数小数
+ * 采用四舍五入策略 {@link RoundingMode#HALF_UP}
+ * 例如保留2位小数：123.456789 =》 123.46 + * + * @param number 数字值 + * @param scale 保留小数位数 + * @return 新值 + * @since 4.1.0 + */ + public static BigDecimal round(BigDecimal number, int scale) { + return round(number, scale, RoundingMode.HALF_UP); + } + + /** + * 保留固定位数小数
+ * 采用四舍五入策略 {@link RoundingMode#HALF_UP}
+ * 例如保留2位小数：123.456789 =》 123.46 + * + * @param numberStr 数字值的字符串表现形式 + * @param scale 保留小数位数 + * @return 新值 + * @since 3.2.2 + */ + public static String roundStr(String numberStr, int scale) { + return round(numberStr, scale).toPlainString(); + } + + /** + * 保留固定位数小数
+ * 例如保留四位小数：123.456789 =》 123.4567 + * + * @param v 值 + * @param scale 保留小数位数 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 新值 + */ + public static BigDecimal round(double v, int scale, RoundingMode roundingMode) { + return round(Double.toString(v), scale, roundingMode); + } + + /** + * 保留固定位数小数
+ * 例如保留四位小数：123.456789 =》 123.4567 + * + * @param v 值 + * @param scale 保留小数位数 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 新值 + * @since 3.2.2 + */ + public static String roundStr(double v, int scale, RoundingMode roundingMode) { + return round(v, scale, roundingMode).toPlainString(); + } + + /** + * 保留固定位数小数
+ * 例如保留四位小数：123.456789 =》 123.4567 + * + * @param numberStr 数字值的字符串表现形式 + * @param scale 保留小数位数，如果传入小于0，则默认0 + * @param roundingMode 保留小数的模式 {@link RoundingMode}，如果传入null则默认四舍五入 + * @return 新值 + */ + public static BigDecimal round(String numberStr, int scale, RoundingMode roundingMode) { + Assert.notBlank(numberStr); + if (scale < 0) { + scale = 0; + } + return round(toBigDecimal(numberStr), scale, roundingMode); + } + + /** + * 保留固定位数小数
+ * 例如保留四位小数：123.456789 =》 123.4567 + * + * @param number 数字值 + * @param scale 保留小数位数，如果传入小于0，则默认0 + * @param roundingMode 保留小数的模式 {@link RoundingMode}，如果传入null则默认四舍五入 + * @return 新值 + */ + public static BigDecimal round(BigDecimal number, int scale, RoundingMode roundingMode) { + if (null == number) { + number = BigDecimal.ZERO; + } + if (scale < 0) { + scale = 0; + } + if (null == roundingMode) { + roundingMode = RoundingMode.HALF_UP; + } + + return number.setScale(scale, roundingMode); + } + + /** + * 保留固定位数小数
+ * 例如保留四位小数：123.456789 =》 123.4567 + * + * @param numberStr 数字值的字符串表现形式 + * @param scale 保留小数位数 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 新值 + * @since 3.2.2 + */ + public static String roundStr(String numberStr, int scale, RoundingMode roundingMode) { + return round(numberStr, scale, roundingMode).toPlainString(); + } + + /** + * 四舍六入五成双计算法 + *

+ * 四舍六入五成双是一种比较精确比较科学的计数保留法，是一种数字修约规则。 + *

+ * + * 
+	 * 算法规则:
+	 * 四舍六入五考虑，
+	 * 五后非零就进一，
+	 * 五后皆零看奇偶，
+	 * 五前为偶应舍去，
+	 * 五前为奇要进一。
+	 *
+ * + * @param number 需要科学计算的数据 + * @param scale 保留的小数位 + * @return 结果 + * @since 4.1.0 + */ + public static BigDecimal roundHalfEven(Number number, int scale) { + return roundHalfEven(toBigDecimal(number), scale); + } + + /** + * 四舍六入五成双计算法 + *

+ * 四舍六入五成双是一种比较精确比较科学的计数保留法，是一种数字修约规则。 + *

+ * + * 
+	 * 算法规则:
+	 * 四舍六入五考虑，
+	 * 五后非零就进一，
+	 * 五后皆零看奇偶，
+	 * 五前为偶应舍去，
+	 * 五前为奇要进一。
+	 *
+ * + * @param value 需要科学计算的数据 + * @param scale 保留的小数位 + * @return 结果 + * @since 4.1.0 + */ + public static BigDecimal roundHalfEven(BigDecimal value, int scale) { + return round(value, scale, RoundingMode.HALF_EVEN); + } + + /** + * 保留固定小数位数，舍去多余位数 + * + * @param number 需要科学计算的数据 + * @param scale 保留的小数位 + * @return 结果 + * @since 4.1.0 + */ + public static BigDecimal roundDown(Number number, int scale) { + return roundDown(toBigDecimal(number), scale); + } + + /** + * 保留固定小数位数，舍去多余位数 + * + * @param value 需要科学计算的数据 + * @param scale 保留的小数位 + * @return 结果 + * @since 4.1.0 + */ + public static BigDecimal roundDown(BigDecimal value, int scale) { + return round(value, scale, RoundingMode.DOWN); + } + + // ------------------------------------------------------------------------------------------- decimalFormat + + /** + * 格式化double
+ * 对 {@link DecimalFormat} 做封装
+ * + * @param pattern 格式 格式中主要以 # 和 0 两种占位符号来指定数字长度。0 表示如果位数不足则以 0 填充，# 表示只要有可能就把数字拉上这个位置。
+ *
    + *
  • 0 =》 取一位整数
    • + *
  • 0.00 =》 取一位整数和两位小数
    • + *
  • 00.000 =》 取两位整数和三位小数
    • + *
  • # =》 取所有整数部分
    • + *
  • #.##% =》 以百分比方式计数，并取两位小数
    • + *
  • #.#####E0 =》 显示为科学计数法，并取五位小数
    • + *
  • ,### =》 每三位以逗号进行分隔，例如：299,792,458
    • + *
  • 光速大小为每秒,###米 =》 将格式嵌入文本
    • + *
+ * @param value 值 + * @return 格式化后的值 + */ + public static String decimalFormat(String pattern, double value) { + Assert.isTrue(isValid(value), "value is NaN or Infinite!"); + return new DecimalFormat(pattern).format(value); + } + + /** + * 格式化double
+ * 对 {@link DecimalFormat} 做封装
+ * + * @param pattern 格式 格式中主要以 # 和 0 两种占位符号来指定数字长度。0 表示如果位数不足则以 0 填充，# 表示只要有可能就把数字拉上这个位置。
+ *
    + *
  • 0 =》 取一位整数
    • + *
  • 0.00 =》 取一位整数和两位小数
    • + *
  • 00.000 =》 取两位整数和三位小数
    • + *
  • # =》 取所有整数部分
    • + *
  • #.##% =》 以百分比方式计数，并取两位小数
    • + *
  • #.#####E0 =》 显示为科学计数法，并取五位小数
    • + *
  • ,### =》 每三位以逗号进行分隔，例如：299,792,458
    • + *
  • 光速大小为每秒,###米 =》 将格式嵌入文本
    • + *
+ * @param value 值 + * @return 格式化后的值 + * @since 3.0.5 + */ + public static String decimalFormat(String pattern, long value) { + return new DecimalFormat(pattern).format(value); + } + + /** + * 格式化double
+ * 对 {@link DecimalFormat} 做封装
+ * + * @param pattern 格式 格式中主要以 # 和 0 两种占位符号来指定数字长度。0 表示如果位数不足则以 0 填充，# 表示只要有可能就把数字拉上这个位置。
+ *
    + *
  • 0 =》 取一位整数
    • + *
  • 0.00 =》 取一位整数和两位小数
    • + *
  • 00.000 =》 取两位整数和三位小数
    • + *
  • # =》 取所有整数部分
    • + *
  • #.##% =》 以百分比方式计数，并取两位小数
    • + *
  • #.#####E0 =》 显示为科学计数法，并取五位小数
    • + *
  • ,### =》 每三位以逗号进行分隔，例如：299,792,458
    • + *
  • 光速大小为每秒,###米 =》 将格式嵌入文本
    • + *
+ * @param value 值，支持BigDecimal、BigInteger、Number等类型 + * @return 格式化后的值 + * @since 5.1.6 + */ + public static String decimalFormat(String pattern, Object value) { + return decimalFormat(pattern, value, null); + } + + /** + * 格式化double
+ * 对 {@link DecimalFormat} 做封装
+ * + * @param pattern 格式 格式中主要以 # 和 0 两种占位符号来指定数字长度。0 表示如果位数不足则以 0 填充，# 表示只要有可能就把数字拉上这个位置。
+ *
    + *
  • 0 =》 取一位整数
    • + *
  • 0.00 =》 取一位整数和两位小数
    • + *
  • 00.000 =》 取两位整数和三位小数
    • + *
  • # =》 取所有整数部分
    • + *
  • #.##% =》 以百分比方式计数，并取两位小数
    • + *
  • #.#####E0 =》 显示为科学计数法，并取五位小数
    • + *
  • ,### =》 每三位以逗号进行分隔，例如：299,792,458
    • + *
  • 光速大小为每秒,###米 =》 将格式嵌入文本
    • + *
+ * @param value 值，支持BigDecimal、BigInteger、Number等类型 + * @param roundingMode 保留小数的方式枚举 + * @return 格式化后的值 + * @since 5.6.5 + */ + public static String decimalFormat(String pattern, Object value, RoundingMode roundingMode) { + if (value instanceof Number) { + Assert.isTrue(isValidNumber((Number) value), "value is NaN or Infinite!"); + } + final DecimalFormat decimalFormat = new DecimalFormat(pattern); + if (null != roundingMode) { + decimalFormat.setRoundingMode(roundingMode); + } + return decimalFormat.format(value); + } + + /** + * 格式化金额输出，每三位用逗号分隔 + * + * @param value 金额 + * @return 格式化后的值 + * @since 3.0.9 + */ + public static String decimalFormatMoney(double value) { + return decimalFormat(",##0.00", value); + } + + /** + * 格式化百分比，小数采用四舍五入方式 + * + * @param number 值 + * @param scale 保留小数位数 + * @return 百分比 + * @since 3.2.3 + */ + public static String formatPercent(double number, int scale) { + final NumberFormat format = NumberFormat.getPercentInstance(); + format.setMaximumFractionDigits(scale); + return format.format(number); + } + + // ------------------------------------------------------------------------------------------- isXXX + + /** + * 是否为数字，支持包括： + * + * 
+	 * 1、10进制
+	 * 2、16进制数字（0x开头）
+	 * 3、科学计数法形式（1234E3）
+	 * 4、类型标识形式（123D）
+	 * 5、正负数标识形式（+123、-234）
+	 *
+ * + * @param str 字符串值 + * @return 是否为数字 + */ + public static boolean isNumber(CharSequence str) { + if (StrUtil.isBlank(str)) { + return false; + } + char[] chars = str.toString().toCharArray(); + int sz = chars.length; + boolean hasExp = false; + boolean hasDecPoint = false; + boolean allowSigns = false; + boolean foundDigit = false; + // deal with any possible sign up front + int start = (chars[0] == '-' || chars[0] == '+') ? 1 : 0; + if (sz > start + 1) { + if (chars[start] == '0' && (chars[start + 1] == 'x' || chars[start + 1] == 'X')) { + int i = start + 2; + if (i == sz) { + return false; // str == "0x" + } + // checking hex (it can't be anything else) + for (; i < chars.length; i++) { + if ((chars[i] < '0' || chars[i] > '9') && (chars[i] < 'a' || chars[i] > 'f') && (chars[i] < 'A' || chars[i] > 'F')) { + return false; + } + } + return true; + } + } + sz--; // don't want to loop to the last char, check it afterwords + // for type qualifiers + int i = start; + // loop to the next to last char or to the last char if we need another digit to + // make a valid number (e.g. chars[0..5] = "1234E") + while (i < sz || (i < sz + 1 && allowSigns && !foundDigit)) { + if (chars[i] >= '0' && chars[i] <= '9') { + foundDigit = true; + allowSigns = false; + + } else if (chars[i] == '.') { + if (hasDecPoint || hasExp) { + // two decimal points or dec in exponent + return false; + } + hasDecPoint = true; + } else if (chars[i] == 'e' || chars[i] == 'E') { + // we've already taken care of hex. + if (hasExp) { + // two E's + return false; + } + if (false == foundDigit) { + return false; + } + hasExp = true; + allowSigns = true; + } else if (chars[i] == '+' || chars[i] == '-') { + if (!allowSigns) { + return false; + } + allowSigns = false; + foundDigit = false; // we need a digit after the E + } else { + return false; + } + i++; + } + if (i < chars.length) { + if (chars[i] >= '0' && chars[i] <= '9') { + // no type qualifier, OK + return true; + } + if (chars[i] == 'e' || chars[i] == 'E') { + // can't have an E at the last byte + return false; + } + if (chars[i] == '.') { + if (hasDecPoint || hasExp) { + // two decimal points or dec in exponent + return false; + } + // single trailing decimal point after non-exponent is ok + return foundDigit; + } + if (!allowSigns && (chars[i] == 'd' || chars[i] == 'D' || chars[i] == 'f' || chars[i] == 'F')) { + return foundDigit; + } + if (chars[i] == 'l' || chars[i] == 'L') { + // not allowing L with an exponent + return foundDigit && !hasExp; + } + // last character is illegal + return false; + } + // allowSigns is true iff the val ends in 'E' + // found digit it to make sure weird stuff like '.' and '1E-' doesn't pass + return false == allowSigns && foundDigit; + } + + /** + * 判断String是否是整数
+ * 支持10进制 + * + * @param s String + * @return 是否为整数 + */ + public static boolean isInteger(String s) { + if (StrUtil.isBlank(s)) { + return false; + } + try { + Integer.parseInt(s); + } catch (NumberFormatException e) { + return false; + } + return true; + } + + /** + * 判断字符串是否是Long类型
+ * 支持10进制 + * + * @param s String + * @return 是否为{@link Long}类型 + * @since 4.0.0 + */ + public static boolean isLong(String s) { + if (StrUtil.isBlank(s)) { + return false; + } + try { + Long.parseLong(s); + } catch (NumberFormatException e) { + return false; + } + return true; + } + + /** + * 判断字符串是否是浮点数 + * + * @param s String + * @return 是否为{@link Double}类型 + */ + public static boolean isDouble(String s) { + if (StrUtil.isBlank(s)) { + return false; + } + try { + Double.parseDouble(s); + } catch (NumberFormatException ignore) { + return false; + } + return s.contains("."); + } + + /** + * 是否是质数（素数）
+ * 质数表的质数又称素数。指整数在一个大于1的自然数中,除了1和此整数自身外,没法被其他自然数整除的数。 + * + * @param n 数字 + * @return 是否是质数 + */ + public static boolean isPrimes(int n) { + Assert.isTrue(n > 1, "The number must be > 1"); + for (int i = 2; i <= Math.sqrt(n); i++) { + if (n % i == 0) { + return false; + } + } + return true; + } + + // ------------------------------------------------------------------------------------------- generateXXX + + /** + * 生成不重复随机数 根据给定的最小数字和最大数字，以及随机数的个数，产生指定的不重复的数组 + * + * @param begin 最小数字（包含该数） + * @param end 最大数字（不包含该数） + * @param size 指定产生随机数的个数 + * @return 随机int数组 + */ + public static int[] generateRandomNumber(int begin, int end, int size) { + // 种子你可以随意生成，但不能重复 + final int[] seed = ArrayUtil.range(begin, end); + return generateRandomNumber(begin, end, size, seed); + } + + /** + * 生成不重复随机数 根据给定的最小数字和最大数字，以及随机数的个数，产生指定的不重复的数组 + * + * @param begin 最小数字（包含该数） + * @param end 最大数字（不包含该数） + * @param size 指定产生随机数的个数 + * @param seed 种子，用于取随机数的int池 + * @return 随机int数组 + * @since 5.4.5 + */ + public static int[] generateRandomNumber(int begin, int end, int size, int[] seed) { + if (begin > end) { + int temp = begin; + begin = end; + end = temp; + } + // 加入逻辑判断，确保begin= size, "Size is larger than range between begin and end!"); + Assert.isTrue(seed.length >= size, "Size is larger than seed size!"); + + final int[] ranArr = new int[size]; + // 数量你可以自己定义。 + for (int i = 0; i < size; i++) { + // 得到一个位置 + int j = RandomUtil.randomInt(seed.length - i); + // 得到那个位置的数值 + ranArr[i] = seed[j]; + // 将最后一个未用的数字放到这里 + seed[j] = seed[seed.length - 1 - i]; + } + return ranArr; + } + + /** + * 生成不重复随机数 根据给定的最小数字和最大数字，以及随机数的个数，产生指定的不重复的数组 + * + * @param begin 最小数字（包含该数） + * @param end 最大数字（不包含该数） + * @param size 指定产生随机数的个数 + * @return 随机int数组 + */ + public static Integer[] generateBySet(int begin, int end, int size) { + if (begin > end) { + int temp = begin; + begin = end; + end = temp; + } + // 加入逻辑判断，确保begin set = new HashSet<>(size, 1); + while (set.size() < size) { + set.add(begin + RandomUtil.randomInt(end - begin)); + } + + return set.toArray(new Integer[0]); + } + + // ------------------------------------------------------------------------------------------- range + + /** + * 从0开始给定范围内的整数列表，步进为1 + * + * @param stop 结束（包含） + * @return 整数列表 + * @since 3.3.1 + */ + public static int[] range(int stop) { + return range(0, stop); + } + + /** + * 给定范围内的整数列表，步进为1 + * + * @param start 开始（包含） + * @param stop 结束（包含） + * @return 整数列表 + */ + public static int[] range(int start, int stop) { + return range(start, stop, 1); + } + + /** + * 给定范围内的整数列表 + * + * @param start 开始（包含） + * @param stop 结束（包含） + * @param step 步进 + * @return 整数列表 + */ + public static int[] range(int start, int stop, int step) { + if (start < stop) { + step = Math.abs(step); + } else if (start > stop) { + step = -Math.abs(step); + } else {// start == end + return new int[]{start}; + } + + int size = Math.abs((stop - start) / step) + 1; + int[] values = new int[size]; + int index = 0; + for (int i = start; (step > 0) ? i <= stop : i >= stop; i += step) { + values[index] = i; + index++; + } + return values; + } + + /** + * 将给定范围内的整数添加到已有集合中，步进为1 + * + * @param start 开始（包含） + * @param stop 结束（包含） + * @param values 集合 + * @return 集合 + */ + public static Collection appendRange(int start, int stop, Collection values) { + return appendRange(start, stop, 1, values); + } + + /** + * 将给定范围内的整数添加到已有集合中 + * + * @param start 开始（包含） + * @param stop 结束（包含） + * @param step 步进 + * @param values 集合 + * @return 集合 + */ + public static Collection appendRange(int start, int stop, int step, Collection values) { + if (start < stop) { + step = Math.abs(step); + } else if (start > stop) { + step = -Math.abs(step); + } else {// start == end + values.add(start); + return values; + } + + for (int i = start; (step > 0) ? i <= stop : i >= stop; i += step) { + values.add(i); + } + return values; + } + + // ------------------------------------------------------------------------------------------- others + + /** + * 计算阶乘 + *

+ * n! = n * (n-1) * ... * 2 * 1 + *

+ * + * @param n 阶乘起始 + * @return 结果 + * @since 5.6.0 + */ + public static BigInteger factorial(BigInteger n) { + if (n.equals(BigInteger.ZERO)) { + return BigInteger.ONE; + } + return factorial(n, BigInteger.ZERO); + } + + /** + * 计算范围阶乘 + *

+ * factorial(start, end) = start * (start - 1) * ... * (end + 1) + *

+ * + * @param start 阶乘起始（包含） + * @param end 阶乘结束，必须小于起始（不包括） + * @return 结果 + * @since 5.6.0 + */ + public static BigInteger factorial(BigInteger start, BigInteger end) { + Assert.notNull(start, "Factorial start must be not null!"); + Assert.notNull(end, "Factorial end must be not null!"); + if (start.compareTo(BigInteger.ZERO) < 0 || end.compareTo(BigInteger.ZERO) < 0) { + throw new IllegalArgumentException(StrUtil.format("Factorial start and end both must be > 0, but got start={}, end={}", start, end)); + } + + if (start.equals(BigInteger.ZERO)) { + start = BigInteger.ONE; + } + + if (end.compareTo(BigInteger.ONE) < 0) { + end = BigInteger.ONE; + } + + BigInteger result = start; + end = end.add(BigInteger.ONE); + while (start.compareTo(end) > 0) { + start = start.subtract(BigInteger.ONE); + result = result.multiply(start); + } + return result; + } + + /** + * 计算范围阶乘 + *

+ * factorial(start, end) = start * (start - 1) * ... * (end + 1) + *

+ * + * @param start 阶乘起始（包含） + * @param end 阶乘结束，必须小于起始（不包括） + * @return 结果 + * @since 4.1.0 + */ + public static long factorial(long start, long end) { + // 负数没有阶乘 + if (start < 0 || end < 0) { + throw new IllegalArgumentException(StrUtil.format("Factorial start and end both must be >= 0, but got start={}, end={}", start, end)); + } + if (0L == start || start == end) { + return 1L; + } + if (start < end) { + return 0L; + } + return factorialMultiplyAndCheck(start, factorial(start - 1, end)); + } + + /** + * 计算范围阶乘中校验中间的计算是否存在溢出，factorial提前做了负数和0的校验，因此这里没有校验数字的正负 + * + * @param a 乘数 + * @param b 被乘数 + * @return 如果 a * b的结果没有溢出直接返回，否则抛出异常 + */ + private static long factorialMultiplyAndCheck(long a, long b) { + if (a <= Long.MAX_VALUE / b) { + return a * b; + } + throw new IllegalArgumentException(StrUtil.format("Overflow in multiplication: {} * {}", a, b)); + } + + /** + * 计算阶乘 + *

+ * n! = n * (n-1) * ... * 2 * 1 + *

+ * + * @param n 阶乘起始 + * @return 结果 + */ + public static long factorial(long n) { + if (n < 0 || n > 20) { + throw new IllegalArgumentException(StrUtil.format("Factorial must have n >= 0 and n <= 20 for n!, but got n = {}", n)); + } + return FACTORIALS[(int) n]; + } + + /** + * 平方根算法
+ * 推荐使用 {@link Math#sqrt(double)} + * + * @param x 值 + * @return 平方根 + */ + public static long sqrt(long x) { + long y = 0; + long b = (~Long.MAX_VALUE) >>> 1; + while (b > 0) { + if (x >= y + b) { + x -= y + b; + y >>= 1; + y += b; + } else { + y >>= 1; + } + b >>= 2; + } + return y; + } + + /** + * 可以用于计算双色球、大乐透注数的方法
+ * 比如大乐透35选5可以这样调用processMultiple(7,5); 就是数学中的：C75=7*6/2*1 + * + * @param selectNum 选中小球个数 + * @param minNum 最少要选中多少个小球 + * @return 注数 + */ + public static int processMultiple(int selectNum, int minNum) { + int result; + result = mathSubNode(selectNum, minNum) / mathNode(selectNum - minNum); + return result; + } + + /** + * 最大公约数 + * + * @param m 第一个值 + * @param n 第二个值 + * @return 最大公约数 + */ + public static int divisor(int m, int n) { + while (m % n != 0) { + int temp = m % n; + m = n; + n = temp; + } + return n; + } + + /** + * 最小公倍数 + * + * @param m 第一个值 + * @param n 第二个值 + * @return 最小公倍数 + */ + public static int multiple(int m, int n) { + return m * n / divisor(m, n); + } + + /** + * 获得数字对应的二进制字符串 + * + * @param number 数字 + * @return 二进制字符串 + */ + public static String getBinaryStr(Number number) { + if (number instanceof Long) { + return Long.toBinaryString((Long) number); + } else if (number instanceof Integer) { + return Integer.toBinaryString((Integer) number); + } else { + return Long.toBinaryString(number.longValue()); + } + } + + /** + * 二进制转int + * + * @param binaryStr 二进制字符串 + * @return int + */ + public static int binaryToInt(String binaryStr) { + return Integer.parseInt(binaryStr, 2); + } + + /** + * 二进制转long + * + * @param binaryStr 二进制字符串 + * @return long + */ + public static long binaryToLong(String binaryStr) { + return Long.parseLong(binaryStr, 2); + } + + // ------------------------------------------------------------------------------------------- compare + + /** + * 比较两个值的大小 + * + * @param x 第一个值 + * @param y 第二个值 + * @return x==y返回0，x<y返回小于0的数，x>y返回大于0的数 + * @see Character#compare(char, char) + * @since 3.0.1 + */ + public static int compare(char x, char y) { + return Character.compare(x, y); + } + + /** + * 比较两个值的大小 + * + * @param x 第一个值 + * @param y 第二个值 + * @return x==y返回0，x<y返回小于0的数，x>y返回大于0的数 + * @see Double#compare(double, double) + * @since 3.0.1 + */ + public static int compare(double x, double y) { + return Double.compare(x, y); + } + + /** + * 比较两个值的大小 + * + * @param x 第一个值 + * @param y 第二个值 + * @return x==y返回0，x<y返回小于0的数，x>y返回大于0的数 + * @see Integer#compare(int, int) + * @since 3.0.1 + */ + public static int compare(int x, int y) { + return Integer.compare(x, y); + } + + /** + * 比较两个值的大小 + * + * @param x 第一个值 + * @param y 第二个值 + * @return x==y返回0，x<y返回小于0的数，x>y返回大于0的数 + * @see Long#compare(long, long) + * @since 3.0.1 + */ + public static int compare(long x, long y) { + return Long.compare(x, y); + } + + /** + * 比较两个值的大小 + * + * @param x 第一个值 + * @param y 第二个值 + * @return x==y返回0，x<y返回小于0的数，x>y返回大于0的数 + * @see Short#compare(short, short) + * @since 3.0.1 + */ + public static int compare(short x, short y) { + return Short.compare(x, y); + } + + /** + * 比较两个值的大小 + * + * @param x 第一个值 + * @param y 第二个值 + * @return x==y返回0，x<y返回-1，x>y返回1 + * @see Byte#compare(byte, byte) + * @since 3.0.1 + */ + public static int compare(byte x, byte y) { + return Byte.compare(x, y); + } + + /** + * 比较大小，参数1 > 参数2 返回true + * + * @param bigNum1 数字1 + * @param bigNum2 数字2 + * @return 是否大于 + * @since 3.0.9 + */ + public static boolean isGreater(BigDecimal bigNum1, BigDecimal bigNum2) { + Assert.notNull(bigNum1); + Assert.notNull(bigNum2); + return bigNum1.compareTo(bigNum2) > 0; + } + + /** + * 比较大小，参数1 >= 参数2 返回true + * + * @param bigNum1 数字1 + * @param bigNum2 数字2 + * @return 是否大于等于 + * @since 3, 0.9 + */ + public static boolean isGreaterOrEqual(BigDecimal bigNum1, BigDecimal bigNum2) { + Assert.notNull(bigNum1); + Assert.notNull(bigNum2); + return bigNum1.compareTo(bigNum2) >= 0; + } + + /** + * 比较大小，参数1 < 参数2 返回true + * + * @param bigNum1 数字1 + * @param bigNum2 数字2 + * @return 是否小于 + * @since 3, 0.9 + */ + public static boolean isLess(BigDecimal bigNum1, BigDecimal bigNum2) { + Assert.notNull(bigNum1); + Assert.notNull(bigNum2); + return bigNum1.compareTo(bigNum2) < 0; + } + + /** + * 比较大小，参数1<=参数2 返回true + * + * @param bigNum1 数字1 + * @param bigNum2 数字2 + * @return 是否小于等于 + * @since 3, 0.9 + */ + public static boolean isLessOrEqual(BigDecimal bigNum1, BigDecimal bigNum2) { + Assert.notNull(bigNum1); + Assert.notNull(bigNum2); + return bigNum1.compareTo(bigNum2) <= 0; + } + + /** + * 检查值是否在指定范围内 + * + * @param value 值 + * @param minInclude 最小值（包含） + * @param maxInclude 最大值（包含） + * @return 经过检查后的值 + * @since 5.8.5 + */ + public static boolean isIn(final BigDecimal value, final BigDecimal minInclude, final BigDecimal maxInclude) { + Assert.notNull(value); + Assert.notNull(minInclude); + Assert.notNull(maxInclude); + return isGreaterOrEqual(value, minInclude) && isLessOrEqual(value, maxInclude); + } + + /** + * 比较大小，值相等 返回true
+ * 此方法通过调用{@link Double#doubleToLongBits(double)}方法来判断是否相等
+ * 此方法判断值相等时忽略精度的，即0.00 == 0 + * + * @param num1 数字1 + * @param num2 数字2 + * @return 是否相等 + * @since 5.4.2 + */ + public static boolean equals(double num1, double num2) { + return Double.doubleToLongBits(num1) == Double.doubleToLongBits(num2); + } + + /** + * 比较大小，值相等 返回true
+ * 此方法通过调用{@link Float#floatToIntBits(float)}方法来判断是否相等
+ * 此方法判断值相等时忽略精度的，即0.00 == 0 + * + * @param num1 数字1 + * @param num2 数字2 + * @return 是否相等 + * @since 5.4.5 + */ + public static boolean equals(float num1, float num2) { + return Float.floatToIntBits(num1) == Float.floatToIntBits(num2); + } + + /** + * 比较大小，值相等 返回true
+ * 此方法修复传入long型数据由于没有本类型重载方法,导致数据精度丢失 + * + * @param num1 数字1 + * @param num2 数字2 + * @return 是否相等 + * @since 5.7.19 + */ + public static boolean equals(long num1, long num2) { + return num1 == num2; + } + + /** + * 比较大小，值相等 返回true
+ * 此方法通过调用{@link BigDecimal#compareTo(BigDecimal)}方法来判断是否相等
+ * 此方法判断值相等时忽略精度的，即0.00 == 0 + * + * @param bigNum1 数字1 + * @param bigNum2 数字2 + * @return 是否相等 + */ + public static boolean equals(BigDecimal bigNum1, BigDecimal bigNum2) { + //noinspection NumberEquality + if (bigNum1 == bigNum2) { + // 如果用户传入同一对象，省略compareTo以提高性能。 + return true; + } + if (bigNum1 == null || bigNum2 == null) { + return false; + } + return 0 == bigNum1.compareTo(bigNum2); + } + + /** + * 比较两个字符是否相同 + * + * @param c1 字符1 + * @param c2 字符2 + * @param ignoreCase 是否忽略大小写 + * @return 是否相同 + * @see CharUtil#equals(char, char, boolean) + * @since 3.2.1 + */ + public static boolean equals(char c1, char c2, boolean ignoreCase) { + return CharUtil.equals(c1, c2, ignoreCase); + } + + /** + * 取最小值 + * + * @param 元素类型 + * @param numberArray 数字数组 + * @return 最小值 + * @see ArrayUtil#min(Comparable[]) + * @since 4.0.7 + */ + public static > T min(T[] numberArray) { + return ArrayUtil.min(numberArray); + } + + /** + * 取最小值 + * + * @param numberArray 数字数组 + * @return 最小值 + * @see ArrayUtil#min(long...) + * @since 4.0.7 + */ + public static long min(long... numberArray) { + return ArrayUtil.min(numberArray); + } + + /** + * 取最小值 + * + * @param numberArray 数字数组 + * @return 最小值 + * @see ArrayUtil#min(int...) + * @since 4.0.7 + */ + public static int min(int... numberArray) { + return ArrayUtil.min(numberArray); + } + + /** + * 取最小值 + * + * @param numberArray 数字数组 + * @return 最小值 + * @see ArrayUtil#min(short...) + * @since 4.0.7 + */ + public static short min(short... numberArray) { + return ArrayUtil.min(numberArray); + } + + /** + * 取最小值 + * + * @param numberArray 数字数组 + * @return 最小值 + * @see ArrayUtil#min(double...) + * @since 4.0.7 + */ + public static double min(double... numberArray) { + return ArrayUtil.min(numberArray); + } + + /** + * 取最小值 + * + * @param numberArray 数字数组 + * @return 最小值 + * @see ArrayUtil#min(float...) + * @since 4.0.7 + */ + public static float min(float... numberArray) { + return ArrayUtil.min(numberArray); + } + + /** + * 取最小值 + * + * @param numberArray 数字数组 + * @return 最小值 + * @see ArrayUtil#min(Comparable[]) + * @since 5.0.8 + */ + public static BigDecimal min(BigDecimal... numberArray) { + return ArrayUtil.min(numberArray); + } + + /** + * 取最大值 + * + * @param 元素类型 + * @param numberArray 数字数组 + * @return 最大值 + * @see ArrayUtil#max(Comparable[]) + * @since 4.0.7 + */ + public static > T max(T[] numberArray) { + return ArrayUtil.max(numberArray); + } + + /** + * 取最大值 + * + * @param numberArray 数字数组 + * @return 最大值 + * @see ArrayUtil#max(long...) + * @since 4.0.7 + */ + public static long max(long... numberArray) { + return ArrayUtil.max(numberArray); + } + + /** + * 取最大值 + * + * @param numberArray 数字数组 + * @return 最大值 + * @see ArrayUtil#max(int...) + * @since 4.0.7 + */ + public static int max(int... numberArray) { + return ArrayUtil.max(numberArray); + } + + /** + * 取最大值 + * + * @param numberArray 数字数组 + * @return 最大值 + * @see ArrayUtil#max(short...) + * @since 4.0.7 + */ + public static short max(short... numberArray) { + return ArrayUtil.max(numberArray); + } + + /** + * 取最大值 + * + * @param numberArray 数字数组 + * @return 最大值 + * @see ArrayUtil#max(double...) + * @since 4.0.7 + */ + public static double max(double... numberArray) { + return ArrayUtil.max(numberArray); + } + + /** + * 取最大值 + * + * @param numberArray 数字数组 + * @return 最大值 + * @see ArrayUtil#max(float...) + * @since 4.0.7 + */ + public static float max(float... numberArray) { + return ArrayUtil.max(numberArray); + } + + /** + * 取最大值 + * + * @param numberArray 数字数组 + * @return 最大值 + * @see ArrayUtil#max(Comparable[]) + * @since 5.0.8 + */ + public static BigDecimal max(BigDecimal... numberArray) { + return ArrayUtil.max(numberArray); + } + + /** + * 数字转字符串
+ * 调用{@link Number#toString()}，并去除尾小数点儿后多余的0 + * + * @param number A Number + * @param defaultValue 如果number参数为{@code null}，返回此默认值 + * @return A String. + * @since 3.0.9 + */ + public static String toStr(Number number, String defaultValue) { + return (null == number) ? defaultValue : toStr(number); + } + + /** + * 数字转字符串
+ * 调用{@link Number#toString()}或 {@link BigDecimal#toPlainString()}，并去除尾小数点儿后多余的0 + * + * @param number A Number + * @return A String. + */ + public static String toStr(Number number) { + return toStr(number, true); + } + + /** + * 数字转字符串
+ * 调用{@link Number#toString()}或 {@link BigDecimal#toPlainString()}，并去除尾小数点儿后多余的0 + * + * @param number A Number + * @param isStripTrailingZeros 是否去除末尾多余0，例如5.0返回5 + * @return A String. + */ + public static String toStr(Number number, boolean isStripTrailingZeros) { + Assert.notNull(number, "Number is null !"); + + // BigDecimal单独处理，使用非科学计数法 + if (number instanceof BigDecimal) { + return toStr((BigDecimal) number, isStripTrailingZeros); + } + + Assert.isTrue(isValidNumber(number), "Number is non-finite!"); + // 去掉小数点儿后多余的0 + String string = number.toString(); + if (isStripTrailingZeros) { + if (string.indexOf('.') > 0 && string.indexOf('e') < 0 && string.indexOf('E') < 0) { + while (string.endsWith("0")) { + string = string.substring(0, string.length() - 1); + } + if (string.endsWith(".")) { + string = string.substring(0, string.length() - 1); + } + } + } + return string; + } + + /** + * {@link BigDecimal}数字转字符串
+ * 调用{@link BigDecimal#toPlainString()}，并去除尾小数点儿后多余的0 + * + * @param bigDecimal A {@link BigDecimal} + * @return A String. + * @since 5.4.6 + */ + public static String toStr(BigDecimal bigDecimal) { + return toStr(bigDecimal, true); + } + + /** + * {@link BigDecimal}数字转字符串
+ * 调用{@link BigDecimal#toPlainString()}，可选去除尾小数点儿后多余的0 + * + * @param bigDecimal A {@link BigDecimal} + * @param isStripTrailingZeros 是否去除末尾多余0，例如5.0返回5 + * @return A String. + * @since 5.4.6 + */ + public static String toStr(BigDecimal bigDecimal, boolean isStripTrailingZeros) { + Assert.notNull(bigDecimal, "BigDecimal is null !"); + if (isStripTrailingZeros) { + bigDecimal = bigDecimal.stripTrailingZeros(); + } + return bigDecimal.toPlainString(); + } + + /** + * 数字转{@link BigDecimal}
+ * Float、Double等有精度问题，转换为字符串后再转换
+ * null转换为0 + * + * @param number 数字 + * @return {@link BigDecimal} + * @since 4.0.9 + */ + public static BigDecimal toBigDecimal(Number number) { + if (null == number) { + return BigDecimal.ZERO; + } + + if (number instanceof BigDecimal) { + return (BigDecimal) number; + } else if (number instanceof Long) { + return new BigDecimal((Long) number); + } else if (number instanceof Integer) { + return new BigDecimal((Integer) number); + } else if (number instanceof BigInteger) { + return new BigDecimal((BigInteger) number); + } + + // Float、Double等有精度问题，转换为字符串后再转换 + return toBigDecimal(number.toString()); + } + + /** + * 数字转{@link BigDecimal}
+ * null或""或空白符转换为0 + * + * @param numberStr 数字字符串 + * @return {@link BigDecimal} + * @since 4.0.9 + */ + public static BigDecimal toBigDecimal(String numberStr) { + if (StrUtil.isBlank(numberStr)) { + return BigDecimal.ZERO; + } + + try { + // 支持类似于 1,234.55 格式的数字 + final Number number = parseNumber(numberStr); + if (number instanceof BigDecimal) { + return (BigDecimal) number; + } else { + return new BigDecimal(number.toString()); + } + } catch (Exception ignore) { + // 忽略解析错误 + } + + return new BigDecimal(numberStr); + } + + /** + * 数字转{@link BigInteger}
+ * null转换为0 + * + * @param number 数字 + * @return {@link BigInteger} + * @since 5.4.5 + */ + public static BigInteger toBigInteger(Number number) { + if (null == number) { + return BigInteger.ZERO; + } + + if (number instanceof BigInteger) { + return (BigInteger) number; + } else if (number instanceof Long) { + return BigInteger.valueOf((Long) number); + } + + return toBigInteger(number.longValue()); + } + + /** + * 数字转{@link BigInteger}
+ * null或""或空白符转换为0 + * + * @param number 数字字符串 + * @return {@link BigInteger} + * @since 5.4.5 + */ + public static BigInteger toBigInteger(String number) { + return StrUtil.isBlank(number) ? BigInteger.ZERO : new BigInteger(number); + } + + /** + * 计算等份个数 + * + * @param total 总数 + * @param part 每份的个数 + * @return 分成了几份 + * @since 3.0.6 + */ + public static int count(int total, int part) { + return (total % part == 0) ? (total / part) : (total / part + 1); + } + + /** + * 空转0 + * + * @param decimal {@link BigDecimal}，可以为{@code null} + * @return {@link BigDecimal}参数为空时返回0的值 + * @since 3.0.9 + */ + public static BigDecimal null2Zero(BigDecimal decimal) { + + return decimal == null ? BigDecimal.ZERO : decimal; + } + + /** + * 如果给定值为0，返回1，否则返回原值 + * + * @param value 值 + * @return 1或非0值 + * @since 3.1.2 + */ + public static int zero2One(int value) { + return 0 == value ? 1 : value; + } + + /** + * 创建{@link BigInteger}，支持16进制、10进制和8进制，如果传入空白串返回null
+ * from Apache Common Lang + * + * @param str 数字字符串 + * @return {@link BigInteger} + * @since 3.2.1 + */ + public static BigInteger newBigInteger(String str) { + str = StrUtil.trimToNull(str); + if (null == str) { + return null; + } + + int pos = 0; // 数字字符串位置 + int radix = 10; + boolean negate = false; // 负数与否 + if (str.startsWith("-")) { + negate = true; + pos = 1; + } + if (str.startsWith("0x", pos) || str.startsWith("0X", pos)) { + // hex + radix = 16; + pos += 2; + } else if (str.startsWith("#", pos)) { + // alternative hex (allowed by Long/Integer) + radix = 16; + pos++; + } else if (str.startsWith("0", pos) && str.length() > pos + 1) { + // octal; so long as there are additional digits + radix = 8; + pos++; + } // default is to treat as decimal + + if (pos > 0) { + str = str.substring(pos); + } + final BigInteger value = new BigInteger(str, radix); + return negate ? value.negate() : value; + } + + /** + * 判断两个数字是否相邻，例如1和2相邻，1和3不相邻
+ * 判断方法为做差取绝对值判断是否为1 + * + * @param number1 数字1 + * @param number2 数字2 + * @return 是否相邻 + * @since 4.0.7 + */ + public static boolean isBeside(long number1, long number2) { + return Math.abs(number1 - number2) == 1; + } + + /** + * 判断两个数字是否相邻，例如1和2相邻，1和3不相邻
+ * 判断方法为做差取绝对值判断是否为1 + * + * @param number1 数字1 + * @param number2 数字2 + * @return 是否相邻 + * @since 4.0.7 + */ + public static boolean isBeside(int number1, int number2) { + return Math.abs(number1 - number2) == 1; + } + + /** + * 把给定的总数平均分成N份，返回每份的个数
+ * 当除以分数有余数时每份+1 + * + * @param total 总数 + * @param partCount 份数 + * @return 每份的个数 + * @since 4.0.7 + */ + public static int partValue(int total, int partCount) { + return partValue(total, partCount, true); + } + + /** + * 把给定的总数平均分成N份，返回每份的个数
+ * 如果isPlusOneWhenHasRem为true，则当除以分数有余数时每份+1，否则丢弃余数部分 + * + * @param total 总数 + * @param partCount 份数 + * @param isPlusOneWhenHasRem 在有余数时是否每份+1 + * @return 每份的个数 + * @since 4.0.7 + */ + public static int partValue(int total, int partCount, boolean isPlusOneWhenHasRem) { + int partValue = total / partCount; + if (isPlusOneWhenHasRem && total % partCount > 0) { + partValue++; + } + return partValue; + } + + /** + * 提供精确的幂运算 + * + * @param number 底数 + * @param n 指数 + * @return 幂的积 + * @since 4.1.0 + */ + public static BigDecimal pow(Number number, int n) { + return pow(toBigDecimal(number), n); + } + + /** + * 提供精确的幂运算 + * + * @param number 底数 + * @param n 指数 + * @return 幂的积 + * @since 4.1.0 + */ + public static BigDecimal pow(BigDecimal number, int n) { + return number.pow(n); + } + + + /** + * 判断一个整数是否是2的幂 + * + * @param n 待验证的整数 + * @return 如果n是2的幂返回true, 反之返回false + */ + public static boolean isPowerOfTwo(long n) { + return (n > 0) && ((n & (n - 1)) == 0); + } + + /** + * 解析转换数字字符串为int型数字，规则如下： + * + * 
+	 * 1、0x开头的视为16进制数字
+	 * 2、0开头的忽略开头的0
+	 * 3、其它情况按照10进制转换
+	 * 4、空串返回0
+	 * 5、.123形式返回0（按照小于0的小数对待）
+	 * 6、123.56截取小数点之前的数字，忽略小数部分
+	 *
+ * + * @param number 数字，支持0x开头、0开头和普通十进制 + * @return int + * @throws NumberFormatException 数字格式异常 + * @since 4.1.4 + */ + public static int parseInt(String number) throws NumberFormatException { + if (StrUtil.isBlank(number)) { + return 0; + } + + if(StrUtil.containsIgnoreCase(number, "E")){ + // 科学计数法忽略支持，科学计数法一般用于表示非常小和非常大的数字，这类数字转换为int后精度丢失，没有意义。 + throw new NumberFormatException(StrUtil.format("Unsupported int format: [{}]", number)); + } + + if (StrUtil.startWithIgnoreCase(number, "0x")) { + // 0x04表示16进制数 + return Integer.parseInt(number.substring(2), 16); + } + + try { + return Integer.parseInt(number); + } catch (NumberFormatException e) { + return parseNumber(number).intValue(); + } + } + + /** + * 解析转换数字字符串为long型数字，规则如下： + * + * 
+	 * 1、0x开头的视为16进制数字
+	 * 2、0开头的忽略开头的0
+	 * 3、空串返回0
+	 * 4、其它情况按照10进制转换
+	 * 5、.123形式返回0（按照小于0的小数对待）
+	 * 6、123.56截取小数点之前的数字，忽略小数部分
+	 *
+ * + * @param number 数字，支持0x开头、0开头和普通十进制 + * @return long + * @since 4.1.4 + */ + public static long parseLong(String number) { + if (StrUtil.isBlank(number)) { + return 0L; + } + + if (number.startsWith("0x")) { + // 0x04表示16进制数 + return Long.parseLong(number.substring(2), 16); + } + + try { + return Long.parseLong(number); + } catch (NumberFormatException e) { + return parseNumber(number).longValue(); + } + } + + /** + * 解析转换数字字符串为long型数字，规则如下： + * + * 
+	 * 1、0开头的忽略开头的0
+	 * 2、空串返回0
+	 * 3、其它情况按照10进制转换
+	 * 4、.123形式返回0.123（按照小于0的小数对待）
+	 *
+ * + * @param number 数字，支持0x开头、0开头和普通十进制 + * @return long + * @since 5.5.5 + */ + public static float parseFloat(String number) { + if (StrUtil.isBlank(number)) { + return 0f; + } + + try { + return Float.parseFloat(number); + } catch (NumberFormatException e) { + return parseNumber(number).floatValue(); + } + } + + /** + * 解析转换数字字符串为long型数字，规则如下： + * + * 
+	 * 1、0开头的忽略开头的0
+	 * 2、空串返回0
+	 * 3、其它情况按照10进制转换
+	 * 4、.123形式返回0.123（按照小于0的小数对待）
+	 *
+ * + * @param number 数字，支持0x开头、0开头和普通十进制 + * @return long + * @since 5.5.5 + */ + public static double parseDouble(String number) { + if (StrUtil.isBlank(number)) { + return 0D; + } + + try { + return Double.parseDouble(number); + } catch (NumberFormatException e) { + return parseNumber(number).doubleValue(); + } + } + + /** + * 将指定字符串转换为{@link Number} 对象
+ * 此方法不支持科学计数法 + * + * @param numberStr Number字符串 + * @return Number对象 + * @throws NumberFormatException 包装了{@link ParseException}，当给定的数字字符串无法解析时抛出 + * @since 4.1.15 + */ + public static Number parseNumber(String numberStr) throws NumberFormatException { + if (StrUtil.startWithIgnoreCase(numberStr, "0x")) { + // 0x04表示16进制数 + return Long.parseLong(numberStr.substring(2), 16); + } + + try { + final NumberFormat format = NumberFormat.getInstance(); + if (format instanceof DecimalFormat) { + // issue#1818@Github + // 当字符串数字超出double的长度时，会导致截断，此处使用BigDecimal接收 + ((DecimalFormat) format).setParseBigDecimal(true); + } + return format.parse(numberStr); + } catch (ParseException e) { + final NumberFormatException nfe = new NumberFormatException(e.getMessage()); + nfe.initCause(e); + throw nfe; + } + } + + /** + * int值转byte数组，使用大端字节序（高位字节在前，低位字节在后）
+ * 见：http://www.ruanyifeng.com/blog/2016/11/byte-order.html + * + * @param value 值 + * @return byte数组 + * @since 4.4.5 + */ + public static byte[] toBytes(int value) { + final byte[] result = new byte[4]; + + result[0] = (byte) (value >> 24); + result[1] = (byte) (value >> 16); + result[2] = (byte) (value >> 8); + result[3] = (byte) (value /* >> 0 */); + + return result; + } + + /** + * byte数组转int，使用大端字节序（高位字节在前，低位字节在后）
+ * 见：http://www.ruanyifeng.com/blog/2016/11/byte-order.html + * + * @param bytes byte数组 + * @return int + * @since 4.4.5 + */ + public static int toInt(byte[] bytes) { + return (bytes[0] & 0xff) << 24// + | (bytes[1] & 0xff) << 16// + | (bytes[2] & 0xff) << 8// + | (bytes[3] & 0xff); + } + + /** + * 以无符号字节数组的形式返回传入值。 + * + * @param value 需要转换的值 + * @return 无符号bytes + * @since 4.5.0 + */ + public static byte[] toUnsignedByteArray(BigInteger value) { + byte[] bytes = value.toByteArray(); + + if (bytes[0] == 0) { + byte[] tmp = new byte[bytes.length - 1]; + System.arraycopy(bytes, 1, tmp, 0, tmp.length); + + return tmp; + } + + return bytes; + } + + /** + * 以无符号字节数组的形式返回传入值。 + * + * @param length bytes长度 + * @param value 需要转换的值 + * @return 无符号bytes + * @since 4.5.0 + */ + public static byte[] toUnsignedByteArray(int length, BigInteger value) { + byte[] bytes = value.toByteArray(); + if (bytes.length == length) { + return bytes; + } + + int start = bytes[0] == 0 ? 1 : 0; + int count = bytes.length - start; + + if (count > length) { + throw new IllegalArgumentException("standard length exceeded for value"); + } + + byte[] tmp = new byte[length]; + System.arraycopy(bytes, start, tmp, tmp.length - count, count); + return tmp; + } + + /** + * 无符号bytes转{@link BigInteger} + * + * @param buf buf 无符号bytes + * @return {@link BigInteger} + * @since 4.5.0 + */ + public static BigInteger fromUnsignedByteArray(byte[] buf) { + return new BigInteger(1, buf); + } + + /** + * 无符号bytes转{@link BigInteger} + * + * @param buf 无符号bytes + * @param off 起始位置 + * @param length 长度 + * @return {@link BigInteger} + */ + public static BigInteger fromUnsignedByteArray(byte[] buf, int off, int length) { + byte[] mag = buf; + if (off != 0 || length != buf.length) { + mag = new byte[length]; + System.arraycopy(buf, off, mag, 0, length); + } + return new BigInteger(1, mag); + } + + /** + * 检查是否为有效的数字
+ * 检查Double和Float是否为无限大，或者Not a Number
+ * 非数字类型和Null将返回true + * + * @param number 被检查类型 + * @return 检查结果，非数字类型和Null将返回true + * @since 4.6.7 + */ + public static boolean isValidNumber(Number number) { + if (null == number) { + return false; + } + if (number instanceof Double) { + return (false == ((Double) number).isInfinite()) && (false == ((Double) number).isNaN()); + } else if (number instanceof Float) { + return (false == ((Float) number).isInfinite()) && (false == ((Float) number).isNaN()); + } + return true; + } + + /** + * 检查是否为有效的数字
+ * 检查double否为无限大，或者Not a Number（NaN）
+ * + * @param number 被检查double + * @return 检查结果 + * @since 5.7.0 + */ + public static boolean isValid(double number) { + return false == (Double.isNaN(number) || Double.isInfinite(number)); + } + + /** + * 检查是否为有效的数字
+ * 检查double否为无限大，或者Not a Number（NaN）
+ * + * @param number 被检查double + * @return 检查结果 + * @since 5.7.0 + */ + public static boolean isValid(float number) { + return false == (Float.isNaN(number) || Float.isInfinite(number)); + } + + /** + * 计算数学表达式的值，只支持加减乘除和取余
+ * 如： + * 
+	 *   calculate("(0*1--3)-5/-4-(3*(-2.13))") -》 10.64
+	 *
+ * + * @param expression 数学表达式 + * @return 结果 + * @since 5.7.6 + */ + public static double calculate(String expression) { + return Calculator.conversion(expression); + } + + /** + * Number值转换为double
+ * float强制转换存在精度问题，此方法避免精度丢失 + * + * @param value 被转换的float值 + * @return double值 + * @since 5.7.8 + */ + public static double toDouble(Number value) { + if (value instanceof Float) { + return Double.parseDouble(value.toString()); + } else { + return value.doubleValue(); + } + } + + /** + * 检查是否为奇数
+ * + * @param num 被判断的数值 + * @return 是否是奇数 + * @author GuoZG + * @since 5.7.17 + */ + public static boolean isOdd(int num) { + return (num & 1) == 1; + } + + /** + * 检查是否为偶数
+ * + * @param num 被判断的数值 + * @return 是否是偶数 + * @author GuoZG + * @since 5.7.17 + */ + public static boolean isEven(int num) { + return false == isOdd(num); + } + + // ------------------------------------------------------------------------------------------- Private method start + private static int mathSubNode(int selectNum, int minNum) { + if (selectNum == minNum) { + return 1; + } else { + return selectNum * mathSubNode(selectNum - 1, minNum); + } + } + + private static int mathNode(int selectNum) { + if (selectNum == 0) { + return 1; + } else { + return selectNum * mathNode(selectNum - 1); + } + } + // ------------------------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ObjUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ObjUtil.java new file mode 100755 index 0000000..f6b84c1 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ObjUtil.java @@ -0,0 +1,9 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +/** + * 对象工具类，同{@link ObjectUtil}
+ * 从6.x开始，将删除ObjectUtil，而使用ObjUtil + * + */ +public class ObjUtil extends ObjectUtil{ +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ObjectUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ObjectUtil.java new file mode 100644 index 0000000..33a7ae6 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ObjectUtil.java @@ -0,0 +1,753 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.collection.IterUtil; +import aiyh.utils.tool.cn.hutool.core.comparator.CompareUtil; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; + +import java.lang.reflect.Array; +import java.math.BigDecimal; +import java.util.*; +import java.util.function.Function; +import java.util.function.Supplier; + +/** + * 对象工具类，包括判空、克隆、序列化等操作 + * + * @author Looly + */ +public class ObjectUtil { + + /** + * 比较两个对象是否相等，此方法是 {@link #equal(Object, Object)}的别名方法。
+ * 相同的条件有两个，满足其一即可：
+ *
    + *
  1. obj1 == null && obj2 == null
    2. + *
  2. obj1.equals(obj2)
    3. + *
  3. 如果是BigDecimal比较，0 == obj1.compareTo(obj2)
    4. + *
+ * + * @param obj1 对象1 + * @param obj2 对象2 + * @return 是否相等 + * @see #equal(Object, Object) + * @since 5.4.3 + */ + public static boolean equals(Object obj1, Object obj2) { + return equal(obj1, obj2); + } + + /** + * 比较两个对象是否相等。
+ * 相同的条件有两个，满足其一即可：
+ *
    + *
  1. obj1 == null && obj2 == null
    2. + *
  2. obj1.equals(obj2)
    3. + *
  3. 如果是BigDecimal比较，0 == obj1.compareTo(obj2)
    4. + *
+ * + * @param obj1 对象1 + * @param obj2 对象2 + * @return 是否相等 + * @see Objects#equals(Object, Object) + */ + public static boolean equal(Object obj1, Object obj2) { + if (obj1 instanceof BigDecimal && obj2 instanceof BigDecimal) { + return NumberUtil.equals((BigDecimal) obj1, (BigDecimal) obj2); + } + return Objects.equals(obj1, obj2); + } + + /** + * 比较两个对象是否不相等。
+ * + * @param obj1 对象1 + * @param obj2 对象2 + * @return 是否不等 + * @since 3.0.7 + */ + public static boolean notEqual(Object obj1, Object obj2) { + return false == equal(obj1, obj2); + } + + /** + * 计算对象长度，如果是字符串调用其length函数，集合类调用其size函数，数组调用其length属性，其他可遍历对象遍历计算长度
+ * 支持的类型包括： + *
    + *
  • CharSequence
    • + *
  • Map
    • + *
  • Iterator
    • + *
  • Enumeration
    • + *
  • Array
    • + *
+ * + * @param obj 被计算长度的对象 + * @return 长度 + */ + public static int length(Object obj) { + if (obj == null) { + return 0; + } + if (obj instanceof CharSequence) { + return ((CharSequence) obj).length(); + } + if (obj instanceof Collection) { + return ((Collection) obj).size(); + } + if (obj instanceof Map) { + return ((Map) obj).size(); + } + + int count; + if (obj instanceof Iterator) { + final Iterator iter = (Iterator) obj; + count = 0; + while (iter.hasNext()) { + count++; + iter.next(); + } + return count; + } + if (obj instanceof Enumeration) { + final Enumeration enumeration = (Enumeration) obj; + count = 0; + while (enumeration.hasMoreElements()) { + count++; + enumeration.nextElement(); + } + return count; + } + if (obj.getClass().isArray() == true) { + return Array.getLength(obj); + } + return -1; + } + + /** + * 对象中是否包含元素
+ * 支持的对象类型包括： + *
    + *
  • String
    • + *
  • Collection
    • + *
  • Map
    • + *
  • Iterator
    • + *
  • Enumeration
    • + *
  • Array
    • + *
+ * + * @param obj 对象 + * @param element 元素 + * @return 是否包含 + */ + public static boolean contains(Object obj, Object element) { + if (obj == null) { + return false; + } + if (obj instanceof String) { + if (element == null) { + return false; + } + return ((String) obj).contains(element.toString()); + } + if (obj instanceof Collection) { + return ((Collection) obj).contains(element); + } + if (obj instanceof Map) { + return ((Map) obj).containsValue(element); + } + + if (obj instanceof Iterator) { + final Iterator iter = (Iterator) obj; + while (iter.hasNext()) { + final Object o = iter.next(); + if (equal(o, element)) { + return true; + } + } + return false; + } + if (obj instanceof Enumeration) { + final Enumeration enumeration = (Enumeration) obj; + while (enumeration.hasMoreElements()) { + final Object o = enumeration.nextElement(); + if (equal(o, element)) { + return true; + } + } + return false; + } + if (obj.getClass().isArray() == true) { + final int len = Array.getLength(obj); + for (int i = 0; i < len; i++) { + final Object o = Array.get(obj, i); + if (equal(o, element)) { + return true; + } + } + } + return false; + } + + /** + * 检查对象是否为null
+ * 判断标准为： + * + * 
+	 * 1. == null
+	 * 2. equals(null)
+	 *
+ * + * @param obj 对象 + * @return 是否为null + */ + public static boolean isNull(Object obj) { + //noinspection ConstantConditions + return null == obj || obj.equals(null); + } + + /** + * 检查对象是否不为null + * 
+	 * 1. != null
+	 * 2. not equals(null)
+	 *
+ * + * @param obj 对象 + * @return 是否为非null + */ + public static boolean isNotNull(Object obj) { + //noinspection ConstantConditions + return null != obj && false == obj.equals(null); + } + + /** + * 判断指定对象是否为空，支持： + * + * 
+	 * 1. CharSequence
+	 * 2. Map
+	 * 3. Iterable
+	 * 4. Iterator
+	 * 5. Array
+	 *
+ * + * @param obj 被判断的对象 + * @return 是否为空，如果类型不支持，返回false + * @since 4.5.7 + */ + @SuppressWarnings("rawtypes") + public static boolean isEmpty(Object obj) { + if (null == obj) { + return true; + } + + if (obj instanceof CharSequence) { + return StrUtil.isEmpty((CharSequence) obj); + } else if (obj instanceof Map) { + return MapUtil.isEmpty((Map) obj); + } else if (obj instanceof Iterable) { + return IterUtil.isEmpty((Iterable) obj); + } else if (obj instanceof Iterator) { + return IterUtil.isEmpty((Iterator) obj); + } else if (ArrayUtil.isArray(obj)) { + return ArrayUtil.isEmpty(obj); + } + + return false; + } + + /** + * 判断指定对象是否为非空，支持： + * + * 
+	 * 1. CharSequence
+	 * 2. Map
+	 * 3. Iterable
+	 * 4. Iterator
+	 * 5. Array
+	 *
+ * + * @param obj 被判断的对象 + * @return 是否为空，如果类型不支持，返回true + * @since 4.5.7 + */ + public static boolean isNotEmpty(Object obj) { + return false == isEmpty(obj); + } + + /** + * 如果给定对象为{@code null}返回默认值 + * + * 
+	 * ObjectUtil.defaultIfNull(null, null)      = null
+	 * ObjectUtil.defaultIfNull(null, "")        = ""
+	 * ObjectUtil.defaultIfNull(null, "zz")      = "zz"
+	 * ObjectUtil.defaultIfNull("abc", *)        = "abc"
+	 * ObjectUtil.defaultIfNull(Boolean.TRUE, *) = Boolean.TRUE
+	 *
+ * + * @param 对象类型 + * @param object 被检查对象，可能为{@code null} + * @param defaultValue 被检查对象为{@code null}返回的默认值，可以为{@code null} + * @return 被检查对象为{@code null}返回默认值，否则返回原值 + * @since 3.0.7 + */ + public static T defaultIfNull(final T object, final T defaultValue) { + return isNull(object) ? defaultValue : object; + } + + /** + * 如果被检查对象为 {@code null}， 返回默认值（由 defaultValueSupplier 提供）；否则直接返回 + * + * @param source 被检查对象 + * @param defaultValueSupplier 默认值提供者 + * @param 对象类型 + * @return 被检查对象为{@code null}返回默认值，否则返回自定义handle处理后的返回值 + * @throws NullPointerException {@code defaultValueSupplier == null} 时，抛出 + * @since 5.7.20 + */ + public static T defaultIfNull(T source, Supplier defaultValueSupplier) { + if (isNull(source)) { + return defaultValueSupplier.get(); + } + return source; + } + + /** + * 如果被检查对象为 {@code null}， 返回默认值（由 defaultValueSupplier 提供）；否则直接返回 + * + * @param source 被检查对象 + * @param defaultValueSupplier 默认值提供者 + * @param 对象类型 + * @return 被检查对象为{@code null}返回默认值，否则返回自定义handle处理后的返回值 + * @throws NullPointerException {@code defaultValueSupplier == null} 时，抛出 + * @since 5.7.20 + */ + public static T defaultIfNull(T source, Function defaultValueSupplier) { + if (isNull(source)) { + return defaultValueSupplier.apply(null); + } + return source; + } + + /** + * 如果给定对象为{@code null} 返回默认值, 如果不为null 返回自定义handle处理后的返回值 + * + * @param source Object 类型对象 + * @param handle 非空时自定义的处理方法 + * @param defaultValue 默认为空的返回值 + * @param 被检查对象为{@code null}返回默认值，否则返回自定义handle处理后的返回值 + * @return 处理后的返回值 + * @since 5.4.6 + * @deprecated 当str为{@code null}时，handle使用了str相关的方法引用会导致空指针问题 + */ + @Deprecated + public static T defaultIfNull(Object source, Supplier handle, final T defaultValue) { + if (isNotNull(source)) { + return handle.get(); + } + return defaultValue; + } + + /** + * 如果给定对象为{@code null} 返回默认值, 如果不为null 返回自定义handle处理后的返回值 + * + * @param 被检查对象为{@code null}返回默认值，否则返回自定义handle处理后的返回值 + * @param 被检查的对象类型 + * @param source Object 类型对象 + * @param handle 非空时自定义的处理方法 + * @param defaultValue 默认为空的返回值 + * @return 处理后的返回值 + * @since 5.4.6 + */ + public static T defaultIfNull(R source, Function handle, final T defaultValue) { + if (isNotNull(source)) { + return handle.apply(source); + } + return defaultValue; + } + + /** + * 如果给定对象为{@code null}或者""返回默认值, 否则返回自定义handle处理后的返回值 + * + * @param str String 类型 + * @param handle 自定义的处理方法 + * @param defaultValue 默认为空的返回值 + * @param 被检查对象为{@code null}或者 ""返回默认值，否则返回自定义handle处理后的返回值 + * @return 处理后的返回值 + * @since 5.4.6 + * @deprecated 当str为{@code null}时，handle使用了str相关的方法引用会导致空指针问题 + */ + @Deprecated + public static T defaultIfEmpty(String str, Supplier handle, final T defaultValue) { + if (StrUtil.isNotEmpty(str)) { + return handle.get(); + } + return defaultValue; + } + + /** + * 如果给定对象为{@code null}或者""返回默认值, 否则返回自定义handle处理后的返回值 + * + * @param str String 类型 + * @param handle 自定义的处理方法 + * @param defaultValue 默认为空的返回值 + * @param 被检查对象为{@code null}或者 ""返回默认值，否则返回自定义handle处理后的返回值 + * @return 处理后的返回值 + * @since 5.4.6 + */ + public static T defaultIfEmpty(String str, Function handle, final T defaultValue) { + if (StrUtil.isNotEmpty(str)) { + return handle.apply(str); + } + return defaultValue; + } + + /** + * 如果给定对象为{@code null}或者 "" 返回默认值 + * + * 
+	 * ObjectUtil.defaultIfEmpty(null, null)      = null
+	 * ObjectUtil.defaultIfEmpty(null, "")        = ""
+	 * ObjectUtil.defaultIfEmpty("", "zz")      = "zz"
+	 * ObjectUtil.defaultIfEmpty(" ", "zz")      = " "
+	 * ObjectUtil.defaultIfEmpty("abc", *)        = "abc"
+	 *
+ * + * @param 对象类型（必须实现CharSequence接口） + * @param str 被检查对象，可能为{@code null} + * @param defaultValue 被检查对象为{@code null}或者 ""返回的默认值，可以为{@code null}或者 "" + * @return 被检查对象为{@code null}或者 ""返回默认值，否则返回原值 + * @since 5.0.4 + */ + public static T defaultIfEmpty(final T str, final T defaultValue) { + return StrUtil.isEmpty(str) ? defaultValue : str; + } + + /** + * 如果被检查对象为 {@code null} 或 "" 时，返回默认值（由 defaultValueSupplier 提供）；否则直接返回 + * + * @param str 被检查对象 + * @param defaultValueSupplier 默认值提供者 + * @param 对象类型（必须实现CharSequence接口） + * @return 被检查对象为{@code null}返回默认值，否则返回自定义handle处理后的返回值 + * @throws NullPointerException {@code defaultValueSupplier == null} 时，抛出 + * @since 5.7.20 + */ + public static T defaultIfEmpty(T str, Supplier defaultValueSupplier) { + if (StrUtil.isEmpty(str)) { + return defaultValueSupplier.get(); + } + return str; + } + + /** + * 如果被检查对象为 {@code null} 或 "" 时，返回默认值（由 defaultValueSupplier 提供）；否则直接返回 + * + * @param str 被检查对象 + * @param defaultValueSupplier 默认值提供者 + * @param 对象类型（必须实现CharSequence接口） + * @return 被检查对象为{@code null}返回默认值，否则返回自定义handle处理后的返回值 + * @throws NullPointerException {@code defaultValueSupplier == null} 时，抛出 + * @since 5.7.20 + */ + public static T defaultIfEmpty(T str, Function defaultValueSupplier) { + if (StrUtil.isEmpty(str)) { + return defaultValueSupplier.apply(null); + } + return str; + } + + /** + * 如果给定对象为{@code null}或者""或者空白符返回默认值 + * + * 
+	 * ObjectUtil.defaultIfBlank(null, null)      = null
+	 * ObjectUtil.defaultIfBlank(null, "")        = ""
+	 * ObjectUtil.defaultIfBlank("", "zz")      = "zz"
+	 * ObjectUtil.defaultIfBlank(" ", "zz")      = "zz"
+	 * ObjectUtil.defaultIfBlank("abc", *)        = "abc"
+	 *
+ * + * @param 对象类型（必须实现CharSequence接口） + * @param str 被检查对象，可能为{@code null} + * @param defaultValue 被检查对象为{@code null}或者 ""或者空白符返回的默认值，可以为{@code null}或者 ""或者空白符 + * @return 被检查对象为{@code null}或者 ""或者空白符返回默认值，否则返回原值 + * @since 5.0.4 + */ + public static T defaultIfBlank(final T str, final T defaultValue) { + return StrUtil.isBlank(str) ? defaultValue : str; + } + + /** + * 如果被检查对象为 {@code null} 或 "" 或 空白字符串时，返回默认值（由 defaultValueSupplier 提供）；否则直接返回 + * + * @param str 被检查对象 + * @param defaultValueSupplier 默认值提供者 + * @param 对象类型（必须实现CharSequence接口） + * @return 被检查对象为{@code null}返回默认值，否则返回自定义handle处理后的返回值 + * @throws NullPointerException {@code defaultValueSupplier == null} 时，抛出 + * @since 5.7.20 + */ + public static T defaultIfBlank(T str, Supplier defaultValueSupplier) { + if (StrUtil.isBlank(str)) { + return defaultValueSupplier.get(); + } + return str; + } + + /** + * 如果被检查对象为 {@code null} 或 "" 或 空白字符串时，返回默认值（由 defaultValueSupplier 提供）；否则直接返回 + * + * @param str 被检查对象 + * @param defaultValueSupplier 默认值提供者 + * @param 对象类型（必须实现CharSequence接口） + * @return 被检查对象为{@code null}返回默认值，否则返回自定义handle处理后的返回值 + * @throws NullPointerException {@code defaultValueSupplier == null} 时，抛出 + * @since 5.7.20 + */ + public static T defaultIfBlank(T str, Function defaultValueSupplier) { + if (StrUtil.isBlank(str)) { + return defaultValueSupplier.apply(null); + } + return str; + } + + /** + * 克隆对象
+ * 如果对象实现Cloneable接口，调用其clone方法
+ * 如果实现Serializable接口，执行深度克隆
+ * 否则返回{@code null} + * + * @param 对象类型 + * @param obj 被克隆对象 + * @return 克隆后的对象 + */ + public static T clone(T obj) { + T result = ArrayUtil.clone(obj); + if (null == result) { + if (obj instanceof Cloneable) { + result = ReflectUtil.invoke(obj, "clone"); + } else { + result = cloneByStream(obj); + } + } + return result; + } + + /** + * 返回克隆后的对象，如果克隆失败，返回原对象 + * + * @param 对象类型 + * @param obj 对象 + * @return 克隆后或原对象 + */ + public static T cloneIfPossible(final T obj) { + T clone = null; + try { + clone = clone(obj); + } catch (Exception e) { + // pass + } + return clone == null ? obj : clone; + } + + /** + * 序列化后拷贝流的方式克隆
+ * 对象必须实现Serializable接口 + * + * @param 对象类型 + * @param obj 被克隆对象 + * @return 克隆后的对象 + * @throws UtilException IO异常和ClassNotFoundException封装 + */ + public static T cloneByStream(T obj) { + return SerializeUtil.clone(obj); + } + + /** + * 序列化
+ * 对象必须实现Serializable接口 + * + * @param 对象类型 + * @param obj 要被序列化的对象 + * @return 序列化后的字节码 + */ + public static byte[] serialize(T obj) { + return SerializeUtil.serialize(obj); + } + + /** + * 反序列化
+ * 对象必须实现Serializable接口 + * + *

+ * 注意！！！ 此方法不会检查反序列化安全，可能存在反序列化漏洞风险！！！ + *

+ * + * @param 对象类型 + * @param bytes 反序列化的字节码 + * @return 反序列化后的对象 + */ + public static T deserialize(byte[] bytes) { + return SerializeUtil.deserialize(bytes); + } + + /** + * 是否为基本类型，包括包装类型和非包装类型 + * + * @param object 被检查对象，{@code null}返回{@code false} + * @return 是否为基本类型 + * @see ClassUtil#isBasicType(Class) + */ + public static boolean isBasicType(Object object) { + if (null == object) { + return false; + } + return ClassUtil.isBasicType(object.getClass()); + } + + /** + * 检查是否为有效的数字
+ * 检查Double和Float是否为无限大，或者Not a Number
+ * 非数字类型和Null将返回true + * + * @param obj 被检查类型 + * @return 检查结果，非数字类型和Null将返回true + */ + public static boolean isValidIfNumber(Object obj) { + if (obj instanceof Number) { + return NumberUtil.isValidNumber((Number) obj); + } + return true; + } + + /** + * {@code null}安全的对象比较，{@code null}对象排在末尾 + * + * @param 被比较对象类型 + * @param c1 对象1，可以为{@code null} + * @param c2 对象2，可以为{@code null} + * @return 比较结果，如果c1 < c2，返回数小于0，c1==c2返回0，c1 > c2 大于0 + * @see java.util.Comparator#compare(Object, Object) + * @since 3.0.7 + */ + public static > int compare(T c1, T c2) { + return CompareUtil.compare(c1, c2); + } + + /** + * {@code null}安全的对象比较 + * + * @param 被比较对象类型 + * @param c1 对象1，可以为{@code null} + * @param c2 对象2，可以为{@code null} + * @param nullGreater 当被比较对象为null时是否排在前面 + * @return 比较结果，如果c1 < c2，返回数小于0，c1==c2返回0，c1 > c2 大于0 + * @see java.util.Comparator#compare(Object, Object) + * @since 3.0.7 + */ + public static > int compare(T c1, T c2, boolean nullGreater) { + return CompareUtil.compare(c1, c2, nullGreater); + } + + /** + * 获得给定类的第一个泛型参数 + * + * @param obj 被检查的对象 + * @return {@link Class} + * @since 3.0.8 + */ + public static Class getTypeArgument(Object obj) { + return getTypeArgument(obj, 0); + } + + /** + * 获得给定类的第一个泛型参数 + * + * @param obj 被检查的对象 + * @param index 泛型类型的索引号，即第几个泛型类型 + * @return {@link Class} + * @since 3.0.8 + */ + public static Class getTypeArgument(Object obj, int index) { + return ClassUtil.getTypeArgument(obj.getClass(), index); + } + + /** + * 将Object转为String
+ * 策略为： + * 
+	 *  1、null转为"null"
+	 *  2、调用Convert.toStr(Object)转换
+	 *
+ * + * @param obj Bean对象 + * @return Bean所有字段转为Map后的字符串 + * @since 3.2.0 + */ + public static String toString(Object obj) { + if (null == obj) { + return StrUtil.NULL; + } + if (obj instanceof Map) { + return obj.toString(); + } + + return Convert.toStr(obj); + } + + /** + * 存在多少个{@code null}或空对象，通过{@link ObjectUtil#isEmpty(Object)} 判断元素 + * + * @param objs 被检查的对象,一个或者多个 + * @return 存在{@code null}的数量 + */ + public static int emptyCount(Object... objs) { + return ArrayUtil.emptyCount(objs); + } + + /** + * 是否存在{@code null}对象，通过{@link ObjectUtil#isNull(Object)} 判断元素 + * + * @param objs 被检查对象 + * @return 是否存在 + * @see ArrayUtil#hasNull(Object[]) + * @since 5.5.3 + */ + public static boolean hasNull(Object... objs) { + return ArrayUtil.hasNull(objs); + } + + /** + * 是否存在{@code null}或空对象，通过{@link ObjectUtil#isEmpty(Object)} 判断元素 + * + * @param objs 被检查对象 + * @return 是否存在 + * @see ArrayUtil#hasEmpty(Object...) + */ + public static boolean hasEmpty(Object... objs) { + return ArrayUtil.hasEmpty(objs); + } + + /** + * 是否全都为{@code null}或空对象，通过{@link ObjectUtil#isEmpty(Object)} 判断元素 + * + * @param objs 被检查的对象,一个或者多个 + * @return 是否都为空 + */ + public static boolean isAllEmpty(Object... objs) { + return ArrayUtil.isAllEmpty(objs); + } + + /** + * 是否全都不为{@code null}或空对象，通过{@link ObjectUtil#isEmpty(Object)} 判断元素 + * + * @param objs 被检查的对象,一个或者多个 + * @return 是否都不为空 + */ + public static boolean isAllNotEmpty(Object... objs) { + return ArrayUtil.isAllNotEmpty(objs); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/PageUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/PageUtil.java new file mode 100644 index 0000000..3072630 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/PageUtil.java @@ -0,0 +1,274 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.lang.DefaultSegment; +import aiyh.utils.tool.cn.hutool.core.lang.Segment; + +/** + * 分页工具类 + * + * @author xiaoleilu + */ +public class PageUtil { + + private static int firstPageNo = 0; + + /** + * 获得首页的页码，可以为0或者1 + * + * @return 首页页码 + */ + public static int getFirstPageNo() { + return firstPageNo; + } + + /** + * 设置首页页码，可以为0或者1 + * + * 
+	 *     当设置为0时，页码0表示第一页，开始位置为0
+	 *     当设置为1时，页码1表示第一页，开始位置为0
+	 *
+ * + * @param customFirstPageNo 自定义的首页页码，为0或者1 + */ + synchronized public static void setFirstPageNo(int customFirstPageNo) { + firstPageNo = customFirstPageNo; + } + + /** + * 设置首页页码为1 + * + * 
+	 *     当设置为1时，页码1表示第一页，开始位置为0
+	 *
+ */ + public static void setOneAsFirstPageNo() { + setFirstPageNo(1); + } + + /** + * 将页数和每页条目数转换为开始位置
+ * 此方法用于不包括结束位置的分页方法
+ * 例如： + * + * 
+	 * 页码：0，每页10 =》 0
+	 * 页码：1，每页10 =》 10
+	 * ……
+	 *
+ * + *

+ * 当{@link #setFirstPageNo(int)}设置为1时： + * 

+	 * 页码：1，每页10 =》 0
+	 * 页码：2，每页10 =》 10
+	 * ……
+	 *
+ * + * @param pageNo 页码（从0计数） + * @param pageSize 每页条目数 + * @return 开始位置 + */ + public static int getStart(int pageNo, int pageSize) { + if (pageNo < firstPageNo) { + pageNo = firstPageNo; + } + + if (pageSize < 1) { + pageSize = 0; + } + + return (pageNo - firstPageNo) * pageSize; + } + + /** + * 将页数和每页条目数转换为结束位置
+ * 此方法用于不包括结束位置的分页方法
+ * 例如： + * + * 
+	 * 页码：0，每页10 =》 9
+	 * 页码：1，每页10 =》 19
+	 * ……
+	 *
+ * + *

+ * 当{@link #setFirstPageNo(int)}设置为1时： + * 

+	 * 页码：1，每页10 =》 9
+	 * 页码：2，每页10 =》 19
+	 * ……
+	 *
+ * + * @param pageNo 页码（从0计数） + * @param pageSize 每页条目数 + * @return 开始位置 + * @since 5.2.5 + */ + public static int getEnd(int pageNo, int pageSize) { + final int start = getStart(pageNo, pageSize); + return getEndByStart(start, pageSize); + } + + /** + * 将页数和每页条目数转换为开始位置和结束位置
+ * 此方法用于包括结束位置的分页方法
+ * 例如： + * + * 
+	 * 页码：0，每页10 =》 [0, 10]
+	 * 页码：1，每页10 =》 [10, 20]
+	 * ……
+	 *
+ * + *

+ * 当{@link #setFirstPageNo(int)}设置为1时： + * 

+	 * 页码：1，每页10 =》 [0, 10]
+	 * 页码：2，每页10 =》 [10, 20]
+	 * ……
+	 *
+ * + * @param pageNo 页码（从0计数） + * @param pageSize 每页条目数 + * @return 第一个数为开始位置，第二个数为结束位置 + */ + public static int[] transToStartEnd(int pageNo, int pageSize) { + final int start = getStart(pageNo, pageSize); + return new int[]{start, getEndByStart(start, pageSize)}; + } + + /** + * 将页数和每页条目数转换为开始位置和结束位置
+ * 此方法用于包括结束位置的分页方法
+ * 例如： + * + * 
+	 * 页码：0，每页10 =》 [0, 10]
+	 * 页码：1，每页10 =》 [10, 20]
+	 * ……
+	 *
+ * + *

+ * 当{@link #setFirstPageNo(int)}设置为1时： + * 

+	 * 页码：1，每页10 =》 [0, 10]
+	 * 页码：2，每页10 =》 [10, 20]
+	 * ……
+	 *
+ * + * @param pageNo 页码（从0计数） + * @param pageSize 每页条目数 + * @return {@link Segment} + * @since 5.5.3 + */ + public static Segment toSegment(int pageNo, int pageSize) { + final int[] startEnd = transToStartEnd(pageNo, pageSize); + return new DefaultSegment<>(startEnd[0], startEnd[1]); + } + + /** + * 根据总数计算总页数 + * + * @param totalCount 总数 + * @param pageSize 每页数 + * @return 总页数 + */ + public static int totalPage(int totalCount, int pageSize) { + return totalPage((long) totalCount,pageSize); + } + + /** + * 根据总数计算总页数 + * + * @param totalCount 总数 + * @param pageSize 每页数 + * @return 总页数 + * @since 5.8.5 + */ + public static int totalPage(long totalCount, int pageSize) { + if (pageSize == 0) { + return 0; + } + return Math.toIntExact(totalCount % pageSize == 0 ? (totalCount / pageSize) : (totalCount / pageSize + 1)); + } + + /** + * 分页彩虹算法
+ * 来自： + * https://github.com/iceroot/iceroot/blob/master/src/main/java/com/icexxx/util/IceUtil.java
+ * 通过传入的信息，生成一个分页列表显示 + * + * @param pageNo 当前页 + * @param totalPage 总页数 + * @param displayCount 每屏展示的页数 + * @return 分页条 + */ + public static int[] rainbow(int pageNo, int totalPage, int displayCount) { + // displayCount % 2 + boolean isEven = (displayCount & 1) == 0; + int left = displayCount >> 1; + int right = displayCount >> 1; + + int length = displayCount; + if (isEven) { + right++; + } + if (totalPage < displayCount) { + length = totalPage; + } + int[] result = new int[length]; + if (totalPage >= displayCount) { + if (pageNo <= left) { + for (int i = 0; i < result.length; i++) { + result[i] = i + 1; + } + } else if (pageNo > totalPage - right) { + for (int i = 0; i < result.length; i++) { + result[i] = i + totalPage - displayCount + 1; + } + } else { + for (int i = 0; i < result.length; i++) { + result[i] = i + pageNo - left + (isEven ? 1 : 0); + } + } + } else { + for (int i = 0; i < result.length; i++) { + result[i] = i + 1; + } + } + return result; + + } + + /** + * 分页彩虹算法(默认展示10页)
+ * 来自： + * https://github.com/iceroot/iceroot/blob/master/src/main/java/com/icexxx/util/IceUtil.java + * + * @param currentPage 当前页 + * @param pageCount 总页数 + * @return 分页条 + */ + public static int[] rainbow(int currentPage, int pageCount) { + return rainbow(currentPage, pageCount, 10); + } + + //------------------------------------------------------------------------- Private method start + + /** + * 根据起始位置获取结束位置 + * + * @param start 起始位置 + * @param pageSize 每页条目数 + * @return 结束位置 + */ + private static int getEndByStart(int start, int pageSize) { + if (pageSize < 1) { + pageSize = 0; + } + return start + pageSize; + } + + //------------------------------------------------------------------------- Private method end +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/PhoneUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/PhoneUtil.java new file mode 100755 index 0000000..928a343 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/PhoneUtil.java @@ -0,0 +1,188 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.lang.PatternPool; +import aiyh.utils.tool.cn.hutool.core.lang.Validator; + + +/** + * 电话号码工具类，包括： + *
    + *
  • 手机号码
    • + *
  • 400、800号码
    • + *
  • 座机号码
    • + *
+ * + * @author dahuoyzs + * @since 5.3.11 + */ +public class PhoneUtil { + + /** + * 验证是否为手机号码（中国大陆） + * + * @param value 值 + * @return 是否为手机号码（中国大陆） + * @since 5.3.11 + */ + public static boolean isMobile(CharSequence value) { + return Validator.isMatchRegex(PatternPool.MOBILE, value); + } + + /** + * 验证是否为手机号码（中国香港） + * @param value 手机号码 + * @return 是否为中国香港手机号码 + * @since 5.6.3 + * @author dazer, ourslook + */ + public static boolean isMobileHk(CharSequence value) { + return Validator.isMatchRegex(PatternPool.MOBILE_HK, value); + } + + /** + * 验证是否为手机号码（中国台湾） + * @param value 手机号码 + * @return 是否为中国台湾手机号码 + * @since 5.6.6 + * @author ihao + */ + public static boolean isMobileTw(CharSequence value) { + return Validator.isMatchRegex(PatternPool.MOBILE_TW, value); + } + + /** + * 验证是否为手机号码（中国澳门） + * @param value 手机号码 + * @return 是否为中国澳门手机号码 + * @since 5.6.6 + * @author ihao + */ + public static boolean isMobileMo(CharSequence value) { + return Validator.isMatchRegex(PatternPool.MOBILE_MO, value); + } + + /** + * 验证是否为座机号码（中国大陆） + * + * @param value 值 + * @return 是否为座机号码（中国大陆） + * @since 5.3.11 + */ + public static boolean isTel(CharSequence value) { + return Validator.isMatchRegex(PatternPool.TEL, value); + } + + /** + * 验证是否为座机号码（中国大陆）+ 400 + 800 + * + * @param value 值 + * @return 是否为座机号码（中国大陆） + * @since 5.6.3 + * @author dazer, ourslook + */ + public static boolean isTel400800(CharSequence value) { + return Validator.isMatchRegex(PatternPool.TEL_400_800, value); + } + + /** + * 验证是否为座机号码+手机号码（CharUtil中国）+ 400 + 800电话 + 手机号号码（中国香港） + * + * @param value 值 + * @return 是否为座机号码+手机号码（中国大陆）+手机号码（中国香港）+手机号码（中国台湾）+手机号码（中国澳门） + * @since 5.3.11 + */ + public static boolean isPhone(CharSequence value) { + return isMobile(value) || isTel400800(value) || isMobileHk(value) || isMobileTw(value) || isMobileMo(value); + } + + /** + * 隐藏手机号前7位 替换字符为"*" + * 栗子 + * + * @param phone 手机号码 + * @return 替换后的字符串 + * @since 5.3.11 + */ + public static CharSequence hideBefore(CharSequence phone) { + return StrUtil.hide(phone, 0, 7); + } + + /** + * 隐藏手机号中间4位 替换字符为"*" + * + * @param phone 手机号码 + * @return 替换后的字符串 + * @since 5.3.11 + */ + public static CharSequence hideBetween(CharSequence phone) { + return StrUtil.hide(phone, 3, 7); + } + + /** + * 隐藏手机号最后4位 替换字符为"*" + * + * @param phone 手机号码 + * @return 替换后的字符串 + * @since 5.3.11 + */ + public static CharSequence hideAfter(CharSequence phone) { + return StrUtil.hide(phone, 7, 11); + } + + /** + * 获取手机号前3位 + * + * @param phone 手机号码 + * @return 手机号前3位 + * @since 5.3.11 + */ + public static CharSequence subBefore(CharSequence phone) { + return StrUtil.sub(phone, 0, 3); + } + + /** + * 获取手机号中间4位 + * + * @param phone 手机号码 + * @return 手机号中间4位 + * @since 5.3.11 + */ + public static CharSequence subBetween(CharSequence phone) { + return StrUtil.sub(phone, 3, 7); + } + + /** + * 获取手机号后4位 + * + * @param phone 手机号码 + * @return 手机号后4位 + * @since 5.3.11 + */ + public static CharSequence subAfter(CharSequence phone) { + return StrUtil.sub(phone, 7, 11); + } + + /** + * 获取固话号码中的区号 + * + * @param value 完整的固话号码 + * @return 固话号码的区号部分 + * @since 5.7.7 + */ + public static CharSequence subTelBefore(CharSequence value) + { + return ReUtil.getGroup1(PatternPool.TEL, value); + } + + /** + * 获取固话号码中的号码 + * + * @param value 完整的固话号码 + * @return 固话号码的号码部分 + * @since 5.7.7 + */ + public static CharSequence subTelAfter(CharSequence value) + { + return ReUtil.get(PatternPool.TEL, value, 2); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/PrimitiveArrayUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/PrimitiveArrayUtil.java new file mode 100644 index 0000000..c1ed687 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/PrimitiveArrayUtil.java @@ -0,0 +1,3217 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import java.lang.reflect.Array; +import java.util.Arrays; +import java.util.Random; + +/** + * 原始类型数组工具类 + * + * @author looly + * @since 5.5.2 + */ +public class PrimitiveArrayUtil { + /** + * 数组中元素未找到的下标，值为-1 + */ + public static final int INDEX_NOT_FOUND = -1; + + // ---------------------------------------------------------------------- isEmpty + + /** + * 数组是否为空 + * + * @param array 数组 + * @return 是否为空 + */ + public static boolean isEmpty(long[] array) { + return array == null || array.length == 0; + } + + /** + * 数组是否为空 + * + * @param array 数组 + * @return 是否为空 + */ + public static boolean isEmpty(int[] array) { + return array == null || array.length == 0; + } + + /** + * 数组是否为空 + * + * @param array 数组 + * @return 是否为空 + */ + public static boolean isEmpty(short[] array) { + return array == null || array.length == 0; + } + + /** + * 数组是否为空 + * + * @param array 数组 + * @return 是否为空 + */ + public static boolean isEmpty(char[] array) { + return array == null || array.length == 0; + } + + /** + * 数组是否为空 + * + * @param array 数组 + * @return 是否为空 + */ + public static boolean isEmpty(byte[] array) { + return array == null || array.length == 0; + } + + /** + * 数组是否为空 + * + * @param array 数组 + * @return 是否为空 + */ + public static boolean isEmpty(double[] array) { + return array == null || array.length == 0; + } + + /** + * 数组是否为空 + * + * @param array 数组 + * @return 是否为空 + */ + public static boolean isEmpty(float[] array) { + return array == null || array.length == 0; + } + + /** + * 数组是否为空 + * + * @param array 数组 + * @return 是否为空 + */ + public static boolean isEmpty(boolean[] array) { + return array == null || array.length == 0; + } + + // ---------------------------------------------------------------------- isNotEmpty + + /** + * 数组是否为非空 + * + * @param array 数组 + * @return 是否为非空 + */ + public static boolean isNotEmpty(long[] array) { + return false == isEmpty(array); + } + + /** + * 数组是否为非空 + * + * @param array 数组 + * @return 是否为非空 + */ + public static boolean isNotEmpty(int[] array) { + return false == isEmpty(array); + } + + /** + * 数组是否为非空 + * + * @param array 数组 + * @return 是否为非空 + */ + public static boolean isNotEmpty(short[] array) { + return false == isEmpty(array); + } + + /** + * 数组是否为非空 + * + * @param array 数组 + * @return 是否为非空 + */ + public static boolean isNotEmpty(char[] array) { + return false == isEmpty(array); + } + + /** + * 数组是否为非空 + * + * @param array 数组 + * @return 是否为非空 + */ + public static boolean isNotEmpty(byte[] array) { + return false == isEmpty(array); + } + + /** + * 数组是否为非空 + * + * @param array 数组 + * @return 是否为非空 + */ + public static boolean isNotEmpty(double[] array) { + return false == isEmpty(array); + } + + /** + * 数组是否为非空 + * + * @param array 数组 + * @return 是否为非空 + */ + public static boolean isNotEmpty(float[] array) { + return false == isEmpty(array); + } + + /** + * 数组是否为非空 + * + * @param array 数组 + * @return 是否为非空 + */ + public static boolean isNotEmpty(boolean[] array) { + return false == isEmpty(array); + } + + // ---------------------------------------------------------------------- resize + + /** + * 生成一个新的重新设置大小的数组
+ * 调整大小后拷贝原数组到新数组下。扩大则占位前N个位置，其它位置补充0，缩小则截断 + * + * @param bytes 原数组 + * @param newSize 新的数组大小 + * @return 调整后的新数组 + * @since 4.6.7 + */ + public static byte[] resize(byte[] bytes, int newSize) { + if (newSize < 0) { + return bytes; + } + final byte[] newArray = new byte[newSize]; + if (newSize > 0 && isNotEmpty(bytes)) { + System.arraycopy(bytes, 0, newArray, 0, Math.min(bytes.length, newSize)); + } + return newArray; + } + + // ---------------------------------------------------------------------- addAll + + /** + * 将多个数组合并在一起
+ * 忽略null的数组 + * + * @param arrays 数组集合 + * @return 合并后的数组 + * @since 4.6.9 + */ + public static byte[] addAll(byte[]... arrays) { + if (arrays.length == 1) { + return arrays[0]; + } + + // 计算总长度 + int length = 0; + for (byte[] array : arrays) { + if (null != array) { + length += array.length; + } + } + + final byte[] result = new byte[length]; + length = 0; + for (byte[] array : arrays) { + if (null != array) { + System.arraycopy(array, 0, result, length, array.length); + length += array.length; + } + } + return result; + } + + /** + * 将多个数组合并在一起
+ * 忽略null的数组 + * + * @param arrays 数组集合 + * @return 合并后的数组 + * @since 4.6.9 + */ + public static int[] addAll(int[]... arrays) { + if (arrays.length == 1) { + return arrays[0]; + } + + // 计算总长度 + int length = 0; + for (int[] array : arrays) { + if (null != array) { + length += array.length; + } + } + + final int[] result = new int[length]; + length = 0; + for (int[] array : arrays) { + if (null != array) { + System.arraycopy(array, 0, result, length, array.length); + length += array.length; + } + } + return result; + } + + /** + * 将多个数组合并在一起
+ * 忽略null的数组 + * + * @param arrays 数组集合 + * @return 合并后的数组 + * @since 4.6.9 + */ + public static long[] addAll(long[]... arrays) { + if (arrays.length == 1) { + return arrays[0]; + } + + // 计算总长度 + int length = 0; + for (long[] array : arrays) { + if (null != array) { + length += array.length; + } + } + + final long[] result = new long[length]; + length = 0; + for (long[] array : arrays) { + if (null != array) { + System.arraycopy(array, 0, result, length, array.length); + length += array.length; + } + } + return result; + } + + /** + * 将多个数组合并在一起
+ * 忽略null的数组 + * + * @param arrays 数组集合 + * @return 合并后的数组 + * @since 4.6.9 + */ + public static double[] addAll(double[]... arrays) { + if (arrays.length == 1) { + return arrays[0]; + } + + // 计算总长度 + int length = 0; + for (double[] array : arrays) { + if (null != array) { + length += array.length; + } + } + + final double[] result = new double[length]; + length = 0; + for (double[] array : arrays) { + if (null != array) { + System.arraycopy(array, 0, result, length, array.length); + length += array.length; + } + } + return result; + } + + /** + * 将多个数组合并在一起
+ * 忽略null的数组 + * + * @param arrays 数组集合 + * @return 合并后的数组 + * @since 4.6.9 + */ + public static float[] addAll(float[]... arrays) { + if (arrays.length == 1) { + return arrays[0]; + } + + // 计算总长度 + int length = 0; + for (float[] array : arrays) { + if (null != array) { + length += array.length; + } + } + + final float[] result = new float[length]; + length = 0; + for (float[] array : arrays) { + if (null != array) { + System.arraycopy(array, 0, result, length, array.length); + length += array.length; + } + } + return result; + } + + /** + * 将多个数组合并在一起
+ * 忽略null的数组 + * + * @param arrays 数组集合 + * @return 合并后的数组 + * @since 4.6.9 + */ + public static char[] addAll(char[]... arrays) { + if (arrays.length == 1) { + return arrays[0]; + } + + // 计算总长度 + int length = 0; + for (char[] array : arrays) { + if (null != array) { + length += array.length; + } + } + + final char[] result = new char[length]; + length = 0; + for (char[] array : arrays) { + if (null != array) { + System.arraycopy(array, 0, result, length, array.length); + length += array.length; + } + } + return result; + } + + /** + * 将多个数组合并在一起
+ * 忽略null的数组 + * + * @param arrays 数组集合 + * @return 合并后的数组 + * @since 4.6.9 + */ + public static boolean[] addAll(boolean[]... arrays) { + if (arrays.length == 1) { + return arrays[0]; + } + + // 计算总长度 + int length = 0; + for (boolean[] array : arrays) { + if (null != array) { + length += array.length; + } + } + + final boolean[] result = new boolean[length]; + length = 0; + for (boolean[] array : arrays) { + if (null != array) { + System.arraycopy(array, 0, result, length, array.length); + length += array.length; + } + } + return result; + } + + /** + * 将多个数组合并在一起
+ * 忽略null的数组 + * + * @param arrays 数组集合 + * @return 合并后的数组 + * @since 4.6.9 + */ + public static short[] addAll(short[]... arrays) { + if (arrays.length == 1) { + return arrays[0]; + } + + // 计算总长度 + int length = 0; + for (short[] array : arrays) { + if (null != array) { + length += array.length; + } + } + + final short[] result = new short[length]; + length = 0; + for (short[] array : arrays) { + if (null != array) { + System.arraycopy(array, 0, result, length, array.length); + length += array.length; + } + } + return result; + } + + // ---------------------------------------------------------------------- range + + /** + * 生成一个从0开始的数字列表
+ * + * @param excludedEnd 结束的数字（不包含） + * @return 数字列表 + */ + public static int[] range(int excludedEnd) { + return range(0, excludedEnd, 1); + } + + /** + * 生成一个数字列表
+ * 自动判定正序反序 + * + * @param includedStart 开始的数字（包含） + * @param excludedEnd 结束的数字（不包含） + * @return 数字列表 + */ + public static int[] range(int includedStart, int excludedEnd) { + return range(includedStart, excludedEnd, 1); + } + + /** + * 生成一个数字列表
+ * 自动判定正序反序 + * + * @param includedStart 开始的数字（包含） + * @param excludedEnd 结束的数字（不包含） + * @param step 步进 + * @return 数字列表 + */ + public static int[] range(int includedStart, int excludedEnd, int step) { + if (includedStart > excludedEnd) { + int tmp = includedStart; + includedStart = excludedEnd; + excludedEnd = tmp; + } + + if (step <= 0) { + step = 1; + } + + int deviation = excludedEnd - includedStart; + int length = deviation / step; + if (deviation % step != 0) { + length += 1; + } + int[] range = new int[length]; + for (int i = 0; i < length; i++) { + range[i] = includedStart; + includedStart += step; + } + return range; + } + + // ---------------------------------------------------------------------- split + + /** + * 拆分byte数组为几个等份（最后一份按照剩余长度分配空间） + * + * @param array 数组 + * @param len 每个小节的长度 + * @return 拆分后的数组 + */ + public static byte[][] split(byte[] array, int len) { + int amount = array.length / len; + final int remainder = array.length % len; + if (remainder != 0) { + ++amount; + } + final byte[][] arrays = new byte[amount][]; + byte[] arr; + for (int i = 0; i < amount; i++) { + if (i == amount - 1 && remainder != 0) { + // 有剩余，按照实际长度创建 + arr = new byte[remainder]; + System.arraycopy(array, i * len, arr, 0, remainder); + } else { + arr = new byte[len]; + System.arraycopy(array, i * len, arr, 0, len); + } + arrays[i] = arr; + } + return arrays; + } + + // ---------------------------------------------------------------------- indexOf、LastIndexOf、contains + + /** + * 返回数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int indexOf(long[] array, long value) { + if (null != array) { + for (int i = 0; i < array.length; i++) { + if (value == array[i]) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在最后的位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int lastIndexOf(long[] array, long value) { + if (null != array) { + for (int i = array.length - 1; i >= 0; i--) { + if (value == array[i]) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 数组中是否包含元素 + * + * @param array 数组 + * @param value 被检查的元素 + * @return 是否包含 + * @since 3.0.7 + */ + public static boolean contains(long[] array, long value) { + return indexOf(array, value) > INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int indexOf(int[] array, int value) { + if (null != array) { + for (int i = 0; i < array.length; i++) { + if (value == array[i]) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在最后的位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int lastIndexOf(int[] array, int value) { + if (null != array) { + for (int i = array.length - 1; i >= 0; i--) { + if (value == array[i]) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 数组中是否包含元素 + * + * @param array 数组 + * @param value 被检查的元素 + * @return 是否包含 + * @since 3.0.7 + */ + public static boolean contains(int[] array, int value) { + return indexOf(array, value) > INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int indexOf(short[] array, short value) { + if (null != array) { + for (int i = 0; i < array.length; i++) { + if (value == array[i]) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在最后的位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int lastIndexOf(short[] array, short value) { + if (null != array) { + for (int i = array.length - 1; i >= 0; i--) { + if (value == array[i]) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 数组中是否包含元素 + * + * @param array 数组 + * @param value 被检查的元素 + * @return 是否包含 + * @since 3.0.7 + */ + public static boolean contains(short[] array, short value) { + return indexOf(array, value) > INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int indexOf(char[] array, char value) { + if (null != array) { + for (int i = 0; i < array.length; i++) { + if (value == array[i]) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在最后的位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int lastIndexOf(char[] array, char value) { + if (null != array) { + for (int i = array.length - 1; i >= 0; i--) { + if (value == array[i]) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 数组中是否包含元素 + * + * @param array 数组 + * @param value 被检查的元素 + * @return 是否包含 + * @since 3.0.7 + */ + public static boolean contains(char[] array, char value) { + return indexOf(array, value) > INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int indexOf(byte[] array, byte value) { + if (null != array) { + for (int i = 0; i < array.length; i++) { + if (value == array[i]) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在最后的位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int lastIndexOf(byte[] array, byte value) { + if (null != array) { + for (int i = array.length - 1; i >= 0; i--) { + if (value == array[i]) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 数组中是否包含元素 + * + * @param array 数组 + * @param value 被检查的元素 + * @return 是否包含 + * @since 3.0.7 + */ + public static boolean contains(byte[] array, byte value) { + return indexOf(array, value) > INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int indexOf(double[] array, double value) { + if (null != array) { + for (int i = 0; i < array.length; i++) { + if (NumberUtil.equals(value, array[i])) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在最后的位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int lastIndexOf(double[] array, double value) { + if (null != array) { + for (int i = array.length - 1; i >= 0; i--) { + if (NumberUtil.equals(value, array[i])) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 数组中是否包含元素 + * + * @param array 数组 + * @param value 被检查的元素 + * @return 是否包含 + * @since 3.0.7 + */ + public static boolean contains(double[] array, double value) { + return indexOf(array, value) > INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int indexOf(float[] array, float value) { + if (null != array) { + for (int i = 0; i < array.length; i++) { + if (NumberUtil.equals(value, array[i])) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在最后的位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int lastIndexOf(float[] array, float value) { + if (null != array) { + for (int i = array.length - 1; i >= 0; i--) { + if (NumberUtil.equals(value, array[i])) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 数组中是否包含元素 + * + * @param array 数组 + * @param value 被检查的元素 + * @return 是否包含 + * @since 3.0.7 + */ + public static boolean contains(float[] array, float value) { + return indexOf(array, value) > INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int indexOf(boolean[] array, boolean value) { + if (null != array) { + for (int i = 0; i < array.length; i++) { + if (value == array[i]) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 返回数组中指定元素所在最后的位置，未找到返回{@link #INDEX_NOT_FOUND} + * + * @param array 数组 + * @param value 被检查的元素 + * @return 数组中指定元素所在位置，未找到返回{@link #INDEX_NOT_FOUND} + * @since 3.0.7 + */ + public static int lastIndexOf(boolean[] array, boolean value) { + if (null != array) { + for (int i = array.length - 1; i >= 0; i--) { + if (value == array[i]) { + return i; + } + } + } + return INDEX_NOT_FOUND; + } + + /** + * 数组中是否包含元素 + * + * @param array 数组 + * @param value 被检查的元素 + * @return 是否包含 + * @since 3.0.7 + */ + public static boolean contains(boolean[] array, boolean value) { + return indexOf(array, value) > INDEX_NOT_FOUND; + } + + // ------------------------------------------------------------------- Wrap and unwrap + + /** + * 将原始类型数组包装为包装类型 + * + * @param values 原始类型数组 + * @return 包装类型数组 + */ + public static Integer[] wrap(int... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new Integer[0]; + } + + final Integer[] array = new Integer[length]; + for (int i = 0; i < length; i++) { + array[i] = values[i]; + } + return array; + } + + /** + * 包装类数组转为原始类型数组，null转为0 + * + * @param values 包装类型数组 + * @return 原始类型数组 + */ + public static int[] unWrap(Integer... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new int[0]; + } + + final int[] array = new int[length]; + for (int i = 0; i < length; i++) { + array[i] = ObjectUtil.defaultIfNull(values[i], 0); + } + return array; + } + + /** + * 将原始类型数组包装为包装类型 + * + * @param values 原始类型数组 + * @return 包装类型数组 + */ + public static Long[] wrap(long... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new Long[0]; + } + + final Long[] array = new Long[length]; + for (int i = 0; i < length; i++) { + array[i] = values[i]; + } + return array; + } + + /** + * 包装类数组转为原始类型数组 + * + * @param values 包装类型数组 + * @return 原始类型数组 + */ + public static long[] unWrap(Long... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new long[0]; + } + + final long[] array = new long[length]; + for (int i = 0; i < length; i++) { + array[i] = ObjectUtil.defaultIfNull(values[i], 0L); + } + return array; + } + + /** + * 将原始类型数组包装为包装类型 + * + * @param values 原始类型数组 + * @return 包装类型数组 + */ + public static Character[] wrap(char... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new Character[0]; + } + + final Character[] array = new Character[length]; + for (int i = 0; i < length; i++) { + array[i] = values[i]; + } + return array; + } + + /** + * 包装类数组转为原始类型数组 + * + * @param values 包装类型数组 + * @return 原始类型数组 + */ + public static char[] unWrap(Character... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new char[0]; + } + + char[] array = new char[length]; + for (int i = 0; i < length; i++) { + array[i] = ObjectUtil.defaultIfNull(values[i], Character.MIN_VALUE); + } + return array; + } + + /** + * 将原始类型数组包装为包装类型 + * + * @param values 原始类型数组 + * @return 包装类型数组 + */ + public static Byte[] wrap(byte... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new Byte[0]; + } + + final Byte[] array = new Byte[length]; + for (int i = 0; i < length; i++) { + array[i] = values[i]; + } + return array; + } + + /** + * 包装类数组转为原始类型数组 + * + * @param values 包装类型数组 + * @return 原始类型数组 + */ + public static byte[] unWrap(Byte... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new byte[0]; + } + + final byte[] array = new byte[length]; + for (int i = 0; i < length; i++) { + array[i] = ObjectUtil.defaultIfNull(values[i], (byte) 0); + } + return array; + } + + /** + * 将原始类型数组包装为包装类型 + * + * @param values 原始类型数组 + * @return 包装类型数组 + */ + public static Short[] wrap(short... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new Short[0]; + } + + final Short[] array = new Short[length]; + for (int i = 0; i < length; i++) { + array[i] = values[i]; + } + return array; + } + + /** + * 包装类数组转为原始类型数组 + * + * @param values 包装类型数组 + * @return 原始类型数组 + */ + public static short[] unWrap(Short... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new short[0]; + } + + final short[] array = new short[length]; + for (int i = 0; i < length; i++) { + array[i] = ObjectUtil.defaultIfNull(values[i], (short) 0); + } + return array; + } + + /** + * 将原始类型数组包装为包装类型 + * + * @param values 原始类型数组 + * @return 包装类型数组 + */ + public static Float[] wrap(float... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new Float[0]; + } + + final Float[] array = new Float[length]; + for (int i = 0; i < length; i++) { + array[i] = values[i]; + } + return array; + } + + /** + * 包装类数组转为原始类型数组 + * + * @param values 包装类型数组 + * @return 原始类型数组 + */ + public static float[] unWrap(Float... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new float[0]; + } + + final float[] array = new float[length]; + for (int i = 0; i < length; i++) { + array[i] = ObjectUtil.defaultIfNull(values[i], 0F); + } + return array; + } + + /** + * 将原始类型数组包装为包装类型 + * + * @param values 原始类型数组 + * @return 包装类型数组 + */ + public static Double[] wrap(double... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new Double[0]; + } + + final Double[] array = new Double[length]; + for (int i = 0; i < length; i++) { + array[i] = values[i]; + } + return array; + } + + /** + * 包装类数组转为原始类型数组 + * + * @param values 包装类型数组 + * @return 原始类型数组 + */ + public static double[] unWrap(Double... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new double[0]; + } + + final double[] array = new double[length]; + for (int i = 0; i < length; i++) { + array[i] = ObjectUtil.defaultIfNull(values[i], 0D); + } + return array; + } + + /** + * 将原始类型数组包装为包装类型 + * + * @param values 原始类型数组 + * @return 包装类型数组 + */ + public static Boolean[] wrap(boolean... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new Boolean[0]; + } + + final Boolean[] array = new Boolean[length]; + for (int i = 0; i < length; i++) { + array[i] = values[i]; + } + return array; + } + + /** + * 包装类数组转为原始类型数组
+ * {@code null} 按照 {@code false} 对待 + * + * @param values 包装类型数组 + * @return 原始类型数组 + */ + public static boolean[] unWrap(Boolean... values) { + if (null == values) { + return null; + } + final int length = values.length; + if (0 == length) { + return new boolean[0]; + } + + final boolean[] array = new boolean[length]; + for (int i = 0; i < length; i++) { + array[i] = ObjectUtil.defaultIfNull(values[i], false); + } + return array; + } + + // ------------------------------------------------------------------- sub + + /** + * 获取子数组 + * + * @param array 数组 + * @param start 开始位置（包括） + * @param end 结束位置（不包括） + * @return 新的数组 + * @see Arrays#copyOfRange(Object[], int, int) + * @since 4.5.2 + */ + public static byte[] sub(byte[] array, int start, int end) { + int length = Array.getLength(array); + if (start < 0) { + start += length; + } + if (end < 0) { + end += length; + } + if (start == length) { + return new byte[0]; + } + if (start > end) { + int tmp = start; + start = end; + end = tmp; + } + if (end > length) { + if (start >= length) { + return new byte[0]; + } + end = length; + } + return Arrays.copyOfRange(array, start, end); + } + + /** + * 获取子数组 + * + * @param array 数组 + * @param start 开始位置（包括） + * @param end 结束位置（不包括） + * @return 新的数组 + * @see Arrays#copyOfRange(Object[], int, int) + * @since 4.5.2 + */ + public static int[] sub(int[] array, int start, int end) { + int length = Array.getLength(array); + if (start < 0) { + start += length; + } + if (end < 0) { + end += length; + } + if (start == length) { + return new int[0]; + } + if (start > end) { + int tmp = start; + start = end; + end = tmp; + } + if (end > length) { + if (start >= length) { + return new int[0]; + } + end = length; + } + return Arrays.copyOfRange(array, start, end); + } + + /** + * 获取子数组 + * + * @param array 数组 + * @param start 开始位置（包括） + * @param end 结束位置（不包括） + * @return 新的数组 + * @see Arrays#copyOfRange(Object[], int, int) + * @since 4.5.2 + */ + public static long[] sub(long[] array, int start, int end) { + int length = Array.getLength(array); + if (start < 0) { + start += length; + } + if (end < 0) { + end += length; + } + if (start == length) { + return new long[0]; + } + if (start > end) { + int tmp = start; + start = end; + end = tmp; + } + if (end > length) { + if (start >= length) { + return new long[0]; + } + end = length; + } + return Arrays.copyOfRange(array, start, end); + } + + /** + * 获取子数组 + * + * @param array 数组 + * @param start 开始位置（包括） + * @param end 结束位置（不包括） + * @return 新的数组 + * @see Arrays#copyOfRange(Object[], int, int) + * @since 4.5.2 + */ + public static short[] sub(short[] array, int start, int end) { + int length = Array.getLength(array); + if (start < 0) { + start += length; + } + if (end < 0) { + end += length; + } + if (start == length) { + return new short[0]; + } + if (start > end) { + int tmp = start; + start = end; + end = tmp; + } + if (end > length) { + if (start >= length) { + return new short[0]; + } + end = length; + } + return Arrays.copyOfRange(array, start, end); + } + + /** + * 获取子数组 + * + * @param array 数组 + * @param start 开始位置（包括） + * @param end 结束位置（不包括） + * @return 新的数组 + * @see Arrays#copyOfRange(Object[], int, int) + * @since 4.5.2 + */ + public static char[] sub(char[] array, int start, int end) { + int length = Array.getLength(array); + if (start < 0) { + start += length; + } + if (end < 0) { + end += length; + } + if (start == length) { + return new char[0]; + } + if (start > end) { + int tmp = start; + start = end; + end = tmp; + } + if (end > length) { + if (start >= length) { + return new char[0]; + } + end = length; + } + return Arrays.copyOfRange(array, start, end); + } + + /** + * 获取子数组 + * + * @param array 数组 + * @param start 开始位置（包括） + * @param end 结束位置（不包括） + * @return 新的数组 + * @see Arrays#copyOfRange(Object[], int, int) + * @since 4.5.2 + */ + public static double[] sub(double[] array, int start, int end) { + int length = Array.getLength(array); + if (start < 0) { + start += length; + } + if (end < 0) { + end += length; + } + if (start == length) { + return new double[0]; + } + if (start > end) { + int tmp = start; + start = end; + end = tmp; + } + if (end > length) { + if (start >= length) { + return new double[0]; + } + end = length; + } + return Arrays.copyOfRange(array, start, end); + } + + /** + * 获取子数组 + * + * @param array 数组 + * @param start 开始位置（包括） + * @param end 结束位置（不包括） + * @return 新的数组 + * @see Arrays#copyOfRange(Object[], int, int) + * @since 4.5.2 + */ + public static float[] sub(float[] array, int start, int end) { + int length = Array.getLength(array); + if (start < 0) { + start += length; + } + if (end < 0) { + end += length; + } + if (start == length) { + return new float[0]; + } + if (start > end) { + int tmp = start; + start = end; + end = tmp; + } + if (end > length) { + if (start >= length) { + return new float[0]; + } + end = length; + } + return Arrays.copyOfRange(array, start, end); + } + + /** + * 获取子数组 + * + * @param array 数组 + * @param start 开始位置（包括） + * @param end 结束位置（不包括） + * @return 新的数组 + * @see Arrays#copyOfRange(Object[], int, int) + * @since 4.5.2 + */ + public static boolean[] sub(boolean[] array, int start, int end) { + int length = Array.getLength(array); + if (start < 0) { + start += length; + } + if (end < 0) { + end += length; + } + if (start == length) { + return new boolean[0]; + } + if (start > end) { + int tmp = start; + start = end; + end = tmp; + } + if (end > length) { + if (start >= length) { + return new boolean[0]; + } + end = length; + } + return Arrays.copyOfRange(array, start, end); + } + + // ------------------------------------------------------------------- remove + + /** + * 移除数组中对应位置的元素
+ * copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param index 位置，如果位置小于0或者大于长度，返回原数组 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static long[] remove(long[] array, int index) throws IllegalArgumentException { + return (long[]) remove((Object) array, index); + } + + /** + * 移除数组中对应位置的元素
+ * copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param index 位置，如果位置小于0或者大于长度，返回原数组 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static int[] remove(int[] array, int index) throws IllegalArgumentException { + return (int[]) remove((Object) array, index); + } + + /** + * 移除数组中对应位置的元素
+ * copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param index 位置，如果位置小于0或者大于长度，返回原数组 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static short[] remove(short[] array, int index) throws IllegalArgumentException { + return (short[]) remove((Object) array, index); + } + + /** + * 移除数组中对应位置的元素
+ * copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param index 位置，如果位置小于0或者大于长度，返回原数组 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static char[] remove(char[] array, int index) throws IllegalArgumentException { + return (char[]) remove((Object) array, index); + } + + /** + * 移除数组中对应位置的元素
+ * copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param index 位置，如果位置小于0或者大于长度，返回原数组 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static byte[] remove(byte[] array, int index) throws IllegalArgumentException { + return (byte[]) remove((Object) array, index); + } + + /** + * 移除数组中对应位置的元素
+ * copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param index 位置，如果位置小于0或者大于长度，返回原数组 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static double[] remove(double[] array, int index) throws IllegalArgumentException { + return (double[]) remove((Object) array, index); + } + + /** + * 移除数组中对应位置的元素
+ * copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param index 位置，如果位置小于0或者大于长度，返回原数组 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static float[] remove(float[] array, int index) throws IllegalArgumentException { + return (float[]) remove((Object) array, index); + } + + /** + * 移除数组中对应位置的元素
+ * copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param index 位置，如果位置小于0或者大于长度，返回原数组 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static boolean[] remove(boolean[] array, int index) throws IllegalArgumentException { + return (boolean[]) remove((Object) array, index); + } + + /** + * 移除数组中对应位置的元素
+ * copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param index 位置，如果位置小于0或者大于长度，返回原数组 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + @SuppressWarnings("SuspiciousSystemArraycopy") + public static Object remove(Object array, int index) throws IllegalArgumentException { + if (null == array) { + return null; + } + int length = Array.getLength(array); + if (index < 0 || index >= length) { + return array; + } + + final Object result = Array.newInstance(array.getClass().getComponentType(), length - 1); + System.arraycopy(array, 0, result, 0, index); + if (index < length - 1) { + // 后半部分 + System.arraycopy(array, index + 1, result, index, length - index - 1); + } + + return result; + } + + // ---------------------------------------------------------------------- removeEle + + /** + * 移除数组中指定的元素
+ * 只会移除匹配到的第一个元素 copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param element 要移除的元素 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static long[] removeEle(long[] array, long element) throws IllegalArgumentException { + return remove(array, indexOf(array, element)); + } + + /** + * 移除数组中指定的元素
+ * 只会移除匹配到的第一个元素 copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param element 要移除的元素 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static int[] removeEle(int[] array, int element) throws IllegalArgumentException { + return remove(array, indexOf(array, element)); + } + + /** + * 移除数组中指定的元素
+ * 只会移除匹配到的第一个元素 copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param element 要移除的元素 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static short[] removeEle(short[] array, short element) throws IllegalArgumentException { + return remove(array, indexOf(array, element)); + } + + /** + * 移除数组中指定的元素
+ * 只会移除匹配到的第一个元素 copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param element 要移除的元素 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static char[] removeEle(char[] array, char element) throws IllegalArgumentException { + return remove(array, indexOf(array, element)); + } + + /** + * 移除数组中指定的元素
+ * 只会移除匹配到的第一个元素 copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param element 要移除的元素 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static byte[] removeEle(byte[] array, byte element) throws IllegalArgumentException { + return remove(array, indexOf(array, element)); + } + + /** + * 移除数组中指定的元素
+ * 只会移除匹配到的第一个元素 copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param element 要移除的元素 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static double[] removeEle(double[] array, double element) throws IllegalArgumentException { + return remove(array, indexOf(array, element)); + } + + /** + * 移除数组中指定的元素
+ * 只会移除匹配到的第一个元素 copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param element 要移除的元素 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static float[] removeEle(float[] array, float element) throws IllegalArgumentException { + return remove(array, indexOf(array, element)); + } + + /** + * 移除数组中指定的元素
+ * 只会移除匹配到的第一个元素 copy from commons-lang + * + * @param array 数组对象，可以是对象数组，也可以原始类型数组 + * @param element 要移除的元素 + * @return 去掉指定元素后的新数组或原数组 + * @throws IllegalArgumentException 参数对象不为数组对象 + * @since 3.0.8 + */ + public static boolean[] removeEle(boolean[] array, boolean element) throws IllegalArgumentException { + return remove(array, indexOf(array, element)); + } + + // ---------------------------------------------------------------------- reverse + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @param startIndexInclusive 起始位置（包含） + * @param endIndexExclusive 结束位置（不包含） + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static long[] reverse(long[] array, final int startIndexInclusive, final int endIndexExclusive) { + if (isEmpty(array)) { + return array; + } + int i = Math.max(startIndexInclusive, 0); + int j = Math.min(array.length, endIndexExclusive) - 1; + while (j > i) { + swap(array, i, j); + j--; + i++; + } + return array; + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static long[] reverse(long[] array) { + return reverse(array, 0, array.length); + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @param startIndexInclusive 起始位置（包含） + * @param endIndexExclusive 结束位置（不包含） + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static int[] reverse(int[] array, final int startIndexInclusive, final int endIndexExclusive) { + if (isEmpty(array)) { + return array; + } + int i = Math.max(startIndexInclusive, 0); + int j = Math.min(array.length, endIndexExclusive) - 1; + while (j > i) { + swap(array, i, j); + j--; + i++; + } + return array; + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static int[] reverse(int[] array) { + return reverse(array, 0, array.length); + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @param startIndexInclusive 起始位置（包含） + * @param endIndexExclusive 结束位置（不包含） + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static short[] reverse(short[] array, final int startIndexInclusive, final int endIndexExclusive) { + if (isEmpty(array)) { + return array; + } + int i = Math.max(startIndexInclusive, 0); + int j = Math.min(array.length, endIndexExclusive) - 1; + while (j > i) { + swap(array, i, j); + j--; + i++; + } + return array; + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static short[] reverse(short[] array) { + return reverse(array, 0, array.length); + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @param startIndexInclusive 起始位置（包含） + * @param endIndexExclusive 结束位置（不包含） + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static char[] reverse(char[] array, final int startIndexInclusive, final int endIndexExclusive) { + if (isEmpty(array)) { + return array; + } + int i = Math.max(startIndexInclusive, 0); + int j = Math.min(array.length, endIndexExclusive) - 1; + while (j > i) { + swap(array, i, j); + j--; + i++; + } + return array; + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static char[] reverse(char[] array) { + return reverse(array, 0, array.length); + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @param startIndexInclusive 起始位置（包含） + * @param endIndexExclusive 结束位置（不包含） + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static byte[] reverse(byte[] array, final int startIndexInclusive, final int endIndexExclusive) { + if (isEmpty(array)) { + return array; + } + int i = Math.max(startIndexInclusive, 0); + int j = Math.min(array.length, endIndexExclusive) - 1; + while (j > i) { + swap(array, i, j); + j--; + i++; + } + return array; + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static byte[] reverse(byte[] array) { + return reverse(array, 0, array.length); + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @param startIndexInclusive 起始位置（包含） + * @param endIndexExclusive 结束位置（不包含） + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static double[] reverse(double[] array, final int startIndexInclusive, final int endIndexExclusive) { + if (isEmpty(array)) { + return array; + } + int i = Math.max(startIndexInclusive, 0); + int j = Math.min(array.length, endIndexExclusive) - 1; + while (j > i) { + swap(array, i, j); + j--; + i++; + } + return array; + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static double[] reverse(double[] array) { + return reverse(array, 0, array.length); + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @param startIndexInclusive 起始位置（包含） + * @param endIndexExclusive 结束位置（不包含） + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static float[] reverse(float[] array, final int startIndexInclusive, final int endIndexExclusive) { + if (isEmpty(array)) { + return array; + } + int i = Math.max(startIndexInclusive, 0); + int j = Math.min(array.length, endIndexExclusive) - 1; + while (j > i) { + swap(array, i, j); + j--; + i++; + } + return array; + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static float[] reverse(float[] array) { + return reverse(array, 0, array.length); + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @param startIndexInclusive 起始位置（包含） + * @param endIndexExclusive 结束位置（不包含） + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static boolean[] reverse(boolean[] array, final int startIndexInclusive, final int endIndexExclusive) { + if (isEmpty(array)) { + return array; + } + int i = Math.max(startIndexInclusive, 0); + int j = Math.min(array.length, endIndexExclusive) - 1; + while (j > i) { + swap(array, i, j); + j--; + i++; + } + return array; + } + + /** + * 反转数组，会变更原数组 + * + * @param array 数组，会变更 + * @return 变更后的原数组 + * @since 3.0.9 + */ + public static boolean[] reverse(boolean[] array) { + return reverse(array, 0, array.length); + } + + // ------------------------------------------------------------------------------------------------------------ min and max + + /** + * 取最小值 + * + * @param numberArray 数字数组 + * @return 最小值 + * @since 3.0.9 + */ + public static long min(long... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + long min = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (min > numberArray[i]) { + min = numberArray[i]; + } + } + return min; + } + + /** + * 取最小值 + * + * @param numberArray 数字数组 + * @return 最小值 + * @since 3.0.9 + */ + public static int min(int... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + int min = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (min > numberArray[i]) { + min = numberArray[i]; + } + } + return min; + } + + /** + * 取最小值 + * + * @param numberArray 数字数组 + * @return 最小值 + * @since 3.0.9 + */ + public static short min(short... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + short min = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (min > numberArray[i]) { + min = numberArray[i]; + } + } + return min; + } + + /** + * 取最小值 + * + * @param numberArray 数字数组 + * @return 最小值 + * @since 3.0.9 + */ + public static char min(char... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + char min = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (min > numberArray[i]) { + min = numberArray[i]; + } + } + return min; + } + + /** + * 取最小值 + * + * @param numberArray 数字数组 + * @return 最小值 + * @since 3.0.9 + */ + public static byte min(byte... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + byte min = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (min > numberArray[i]) { + min = numberArray[i]; + } + } + return min; + } + + /** + * 取最小值 + * + * @param numberArray 数字数组 + * @return 最小值 + * @since 3.0.9 + */ + public static double min(double... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + double min = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (min > numberArray[i]) { + min = numberArray[i]; + } + } + return min; + } + + /** + * 取最小值 + * + * @param numberArray 数字数组 + * @return 最小值 + * @since 3.0.9 + */ + public static float min(float... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + float min = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (min > numberArray[i]) { + min = numberArray[i]; + } + } + return min; + } + + /** + * 取最大值 + * + * @param numberArray 数字数组 + * @return 最大值 + * @since 3.0.9 + */ + public static long max(long... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + long max = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (max < numberArray[i]) { + max = numberArray[i]; + } + } + return max; + } + + /** + * 取最大值 + * + * @param numberArray 数字数组 + * @return 最大值 + * @since 3.0.9 + */ + public static int max(int... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + int max = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (max < numberArray[i]) { + max = numberArray[i]; + } + } + return max; + } + + /** + * 取最大值 + * + * @param numberArray 数字数组 + * @return 最大值 + * @since 3.0.9 + */ + public static short max(short... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + short max = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (max < numberArray[i]) { + max = numberArray[i]; + } + } + return max; + } + + /** + * 取最大值 + * + * @param numberArray 数字数组 + * @return 最大值 + * @since 3.0.9 + */ + public static char max(char... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + char max = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (max < numberArray[i]) { + max = numberArray[i]; + } + } + return max; + } + + /** + * 取最大值 + * + * @param numberArray 数字数组 + * @return 最大值 + * @since 3.0.9 + */ + public static byte max(byte... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + byte max = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (max < numberArray[i]) { + max = numberArray[i]; + } + } + return max; + } + + /** + * 取最大值 + * + * @param numberArray 数字数组 + * @return 最大值 + * @since 3.0.9 + */ + public static double max(double... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + double max = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (max < numberArray[i]) { + max = numberArray[i]; + } + } + return max; + } + + /** + * 取最大值 + * + * @param numberArray 数字数组 + * @return 最大值 + * @since 3.0.9 + */ + public static float max(float... numberArray) { + if (isEmpty(numberArray)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + float max = numberArray[0]; + for (int i = 1; i < numberArray.length; i++) { + if (max < numberArray[i]) { + max = numberArray[i]; + } + } + return max; + } + + // ---------------------------------------------------------------------- shuffle + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static int[] shuffle(int[] array) { + return shuffle(array, RandomUtil.getRandom()); + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @param random 随机数生成器 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static int[] shuffle(int[] array, Random random) { + if (array == null || random == null || array.length <= 1) { + return array; + } + + for (int i = array.length; i > 1; i--) { + swap(array, i - 1, random.nextInt(i)); + } + + return array; + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static long[] shuffle(long[] array) { + return shuffle(array, RandomUtil.getRandom()); + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @param random 随机数生成器 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static long[] shuffle(long[] array, Random random) { + if (array == null || random == null || array.length <= 1) { + return array; + } + + for (int i = array.length; i > 1; i--) { + swap(array, i - 1, random.nextInt(i)); + } + + return array; + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static double[] shuffle(double[] array) { + return shuffle(array, RandomUtil.getRandom()); + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @param random 随机数生成器 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static double[] shuffle(double[] array, Random random) { + if (array == null || random == null || array.length <= 1) { + return array; + } + + for (int i = array.length; i > 1; i--) { + swap(array, i - 1, random.nextInt(i)); + } + + return array; + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static float[] shuffle(float[] array) { + return shuffle(array, RandomUtil.getRandom()); + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @param random 随机数生成器 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static float[] shuffle(float[] array, Random random) { + if (array == null || random == null || array.length <= 1) { + return array; + } + + for (int i = array.length; i > 1; i--) { + swap(array, i - 1, random.nextInt(i)); + } + + return array; + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean[] shuffle(boolean[] array) { + return shuffle(array, RandomUtil.getRandom()); + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @param random 随机数生成器 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean[] shuffle(boolean[] array, Random random) { + if (array == null || random == null || array.length <= 1) { + return array; + } + + for (int i = array.length; i > 1; i--) { + swap(array, i - 1, random.nextInt(i)); + } + + return array; + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static byte[] shuffle(byte[] array) { + return shuffle(array, RandomUtil.getRandom()); + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @param random 随机数生成器 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static byte[] shuffle(byte[] array, Random random) { + if (array == null || random == null || array.length <= 1) { + return array; + } + + for (int i = array.length; i > 1; i--) { + swap(array, i - 1, random.nextInt(i)); + } + + return array; + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static char[] shuffle(char[] array) { + return shuffle(array, RandomUtil.getRandom()); + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @param random 随机数生成器 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static char[] shuffle(char[] array, Random random) { + if (array == null || random == null || array.length <= 1) { + return array; + } + + for (int i = array.length; i > 1; i--) { + swap(array, i - 1, random.nextInt(i)); + } + + return array; + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static short[] shuffle(short[] array) { + return shuffle(array, RandomUtil.getRandom()); + } + + /** + * 打乱数组顺序，会变更原数组 + * + * @param array 数组，会变更 + * @param random 随机数生成器 + * @return 打乱后的数组 + * @author FengBaoheng + * @since 5.5.2 + */ + public static short[] shuffle(short[] array, Random random) { + if (array == null || random == null || array.length <= 1) { + return array; + } + + for (int i = array.length; i > 1; i--) { + swap(array, i - 1, random.nextInt(i)); + } + + return array; + } + + // ---------------------------------------------------------------------- swap + + /** + * 交换数组中两个位置的值 + * + * @param array 数组 + * @param index1 位置1 + * @param index2 位置2 + * @return 交换后的数组，与传入数组为同一对象 + * @since 4.0.7 + */ + public static int[] swap(int[] array, int index1, int index2) { + if (isEmpty(array)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + int tmp = array[index1]; + array[index1] = array[index2]; + array[index2] = tmp; + return array; + } + + /** + * 交换数组中两个位置的值 + * + * @param array 数组 + * @param index1 位置1 + * @param index2 位置2 + * @return 交换后的数组，与传入数组为同一对象 + * @since 4.0.7 + */ + public static long[] swap(long[] array, int index1, int index2) { + if (isEmpty(array)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + long tmp = array[index1]; + array[index1] = array[index2]; + array[index2] = tmp; + return array; + } + + /** + * 交换数组中两个位置的值 + * + * @param array 数组 + * @param index1 位置1 + * @param index2 位置2 + * @return 交换后的数组，与传入数组为同一对象 + * @since 4.0.7 + */ + public static double[] swap(double[] array, int index1, int index2) { + if (isEmpty(array)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + double tmp = array[index1]; + array[index1] = array[index2]; + array[index2] = tmp; + return array; + } + + /** + * 交换数组中两个位置的值 + * + * @param array 数组 + * @param index1 位置1 + * @param index2 位置2 + * @return 交换后的数组，与传入数组为同一对象 + * @since 4.0.7 + */ + public static float[] swap(float[] array, int index1, int index2) { + if (isEmpty(array)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + float tmp = array[index1]; + array[index1] = array[index2]; + array[index2] = tmp; + return array; + } + + /** + * 交换数组中两个位置的值 + * + * @param array 数组 + * @param index1 位置1 + * @param index2 位置2 + * @return 交换后的数组，与传入数组为同一对象 + * @since 4.0.7 + */ + public static boolean[] swap(boolean[] array, int index1, int index2) { + if (isEmpty(array)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + boolean tmp = array[index1]; + array[index1] = array[index2]; + array[index2] = tmp; + return array; + } + + /** + * 交换数组中两个位置的值 + * + * @param array 数组 + * @param index1 位置1 + * @param index2 位置2 + * @return 交换后的数组，与传入数组为同一对象 + * @since 4.0.7 + */ + public static byte[] swap(byte[] array, int index1, int index2) { + if (isEmpty(array)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + byte tmp = array[index1]; + array[index1] = array[index2]; + array[index2] = tmp; + return array; + } + + /** + * 交换数组中两个位置的值 + * + * @param array 数组 + * @param index1 位置1 + * @param index2 位置2 + * @return 交换后的数组，与传入数组为同一对象 + * @since 4.0.7 + */ + public static char[] swap(char[] array, int index1, int index2) { + if (isEmpty(array)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + char tmp = array[index1]; + array[index1] = array[index2]; + array[index2] = tmp; + return array; + } + + /** + * 交换数组中两个位置的值 + * + * @param array 数组 + * @param index1 位置1 + * @param index2 位置2 + * @return 交换后的数组，与传入数组为同一对象 + * @since 4.0.7 + */ + public static short[] swap(short[] array, int index1, int index2) { + if (isEmpty(array)) { + throw new IllegalArgumentException("Number array must not empty !"); + } + short tmp = array[index1]; + array[index1] = array[index2]; + array[index2] = tmp; + return array; + } + + // ---------------------------------------------------------------------- asc and desc + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSorted(byte[] array) { + return isSortedASC(array); + } + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedASC(byte[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] > array[i + 1]) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否降序，即array[i] >= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否降序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedDESC(byte[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] < array[i + 1]) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSorted(short[] array) { + return isSortedASC(array); + } + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedASC(short[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] > array[i + 1]) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否降序，即array[i] >= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否降序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedDESC(short[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] < array[i + 1]) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSorted(char[] array) { + return isSortedASC(array); + } + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedASC(char[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] > array[i + 1]) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否降序，即array[i] >= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否降序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedDESC(char[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] < array[i + 1]) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSorted(int[] array) { + return isSortedASC(array); + } + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedASC(int[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] > array[i + 1]) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否降序，即array[i] >= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否降序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedDESC(int[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] < array[i + 1]) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSorted(long[] array) { + return isSortedASC(array); + } + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedASC(long[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] > array[i + 1]) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否降序，即array[i] >= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否降序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedDESC(long[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] < array[i + 1]) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSorted(double[] array) { + return isSortedASC(array); + } + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedASC(double[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] > array[i + 1]) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否降序，即array[i] >= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否降序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedDESC(double[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] < array[i + 1]) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSorted(float[] array) { + return isSortedASC(array); + } + + /** + * 检查数组是否升序，即array[i] <= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否升序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedASC(float[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] > array[i + 1]) { + return false; + } + } + + return true; + } + + /** + * 检查数组是否降序，即array[i] >= array[i+1]，若传入空数组，则返回false + * + * @param array 数组 + * @return 数组是否降序 + * @author FengBaoheng + * @since 5.5.2 + */ + public static boolean isSortedDESC(float[] array) { + if (array == null) { + return false; + } + + for (int i = 0; i < array.length - 1; i++) { + if (array[i] < array[i + 1]) { + return false; + } + } + + return true; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/RadixUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/RadixUtil.java new file mode 100644 index 0000000..fe092bd --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/RadixUtil.java @@ -0,0 +1,126 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +/** + * 进制转换工具类，可以转换为任意进制 + *

+ * 把一个十进制整数根据自己定义的进制规则进行转换
+ * from：https://gitee.com/loolly/hutool/pulls/260 + *

+ * 主要应用一下情况： + *

    + *
  • 根据ID生成邀请码,并且尽可能的缩短。并且不希望直接猜测出和ID的关联
    • + *
  • 短连接的生成，根据ID转成短连接，同样不希望被猜测到
    • + *
  • 数字加密，通过两次不同进制的转换，让有规律的数字看起来没有任何规律
    • + *
  • ....
    • + *
+ * + * @author xl7@qq.com + * @since 5.5.8 + */ + +public class RadixUtil { + /** + * 34进制字符串，不包含 IO 字符 + * 对于需要补齐的，自己可以随机填充IO字符 + * 26个字母：abcdefghijklmnopqrstuvwxyz + */ + public final static String RADIXS_34 = "0123456789ABCDEFGHJKLMNPQRSTUVWXYZ"; + /** + * 打乱后的34进制 + */ + public final static String RADIXS_SHUFFLE_34 = "H3UM16TDFPSBZJ90CW28QYRE45AXKNGV7L"; + + /** + * 59进制字符串,不包含 IOl 字符 + */ + public final static String RADIXS_59 = "0123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ"; + /** + * 打乱后的59进制 + */ + public final static String RADIXS_SHUFFLE_59 = "vh9wGkfK8YmqbsoENP3764SeCX0dVzrgy1HRtpnTaLjJW2xQiZAcBMUFDu5"; + + /** + * 把一个整型数值转换成自己定义的进制 + * 长度即进制
+ *
    + *
  • encode("AB",10) 51转换成2进制，A=0;B=1 。 二进制1010，结果 BABA
    • + *
  • encode("VIP",21) 21转换成3进制，V=0;I=1;P=2 ，三进制210 ,得到结果PIV
    • + *
+ * + * @param radixs 自定进制,不要重复，否则转不回来的。 + * @param num 要转换的数值 + * @return 自定义进制字符串 + */ + public static String encode(String radixs, int num) { + //考虑到负数问题 + long tmpNum = (num >= 0 ? num : (0x100000000L - (~num + 1))); + return encode(radixs, tmpNum, 32); + } + + /** + * 把一个长整型数值转换成自己定义的进制 + * + * @param radixs 自定进制,不要重复，否则转不回来的。 + * @param num 要转换的数值 + * @return 自定义进制字符串 + */ + public static String encode(String radixs, long num) { + if (num < 0) { + throw new RuntimeException("暂不支持负数！"); + } + + return encode(radixs, num, 64); + } + + /** + * 把转换后的进制字符还原成int 值 + * + * @param radixs 自定进制,需要和encode的保持一致 + * @param encodeStr 需要转换成十进制的字符串 + * @return int + */ + public static int decodeToInt(String radixs, String encodeStr) { + //还原负数 + return (int) decode(radixs, encodeStr); + } + + /** + * 把转换后进制的字符还原成long 值 + * + * @param radixs 自定进制,需要和encode的保持一致 + * @param encodeStr 需要转换成十进制的字符串 + * @return long + */ + public static long decode(String radixs, String encodeStr) { + //目标是多少进制 + int rl = radixs.length(); + long res = 0L; + + for (char c : encodeStr.toCharArray()) { + res = res * rl + radixs.indexOf(c); + } + return res; + } + + // -------------------------------------------------------------------------------- Private methods + private static String encode(String radixs, long num, int maxLength) { + if (radixs.length() < 2) { + throw new RuntimeException("自定义进制最少两个字符哦！"); + } + //目标是多少进制 + int rl = radixs.length(); + //考虑到负数问题 + long tmpNum = num; + //进制的结果，二进制最小进制转换结果是32个字符 + //StringBuilder 比较耗时 + char[] aa = new char[maxLength]; + //因为反需字符串比较耗时 + int i = aa.length; + do { + aa[--i] = radixs.charAt((int) (tmpNum % rl)); + tmpNum /= rl; + } while (tmpNum > 0); + //去掉前面的字符串，trim比较耗时 + return new String(aa, i, aa.length - i); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/RandomUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/RandomUtil.java new file mode 100755 index 0000000..8390fa7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/RandomUtil.java @@ -0,0 +1,663 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.collection.ListUtil; +import aiyh.utils.tool.cn.hutool.core.date.DateField; +import aiyh.utils.tool.cn.hutool.core.date.DateTime; +import aiyh.utils.tool.cn.hutool.core.date.DateUtil; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.lang.WeightRandom; +import aiyh.utils.tool.cn.hutool.core.lang.WeightRandom.WeightObj; + +import java.awt.Color; +import java.math.BigDecimal; +import java.math.RoundingMode; +import java.security.NoSuchAlgorithmException; +import java.security.SecureRandom; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Date; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Random; +import java.util.Set; +import java.util.concurrent.ThreadLocalRandom; + +/** + * 随机工具类 + * + * @author xiaoleilu + */ +public class RandomUtil { + + /** + * 用于随机选的数字 + */ + public static final String BASE_NUMBER = "0123456789"; + /** + * 用于随机选的字符 + */ + public static final String BASE_CHAR = "abcdefghijklmnopqrstuvwxyz"; + /** + * 用于随机选的字符和数字 + */ + public static final String BASE_CHAR_NUMBER = BASE_CHAR + BASE_NUMBER; + + /** + * 获取随机数生成器对象
+ * ThreadLocalRandom是JDK 7之后提供并发产生随机数，能够解决多个线程发生的竞争争夺。 + * + *

+ * 注意：此方法返回的{@link ThreadLocalRandom}不可以在多线程环境下共享对象，否则有重复随机数问题。 + * 见：https://www.jianshu.com/p/89dfe990295c + *

+ * + * @return {@link ThreadLocalRandom} + * @since 3.1.2 + */ + public static ThreadLocalRandom getRandom() { + return ThreadLocalRandom.current(); + } + + /** + * 创建{@link SecureRandom}，类提供加密的强随机数生成器 (RNG)
+ * + * @param seed 自定义随机种子 + * @return {@link SecureRandom} + * @since 4.6.5 + */ + public static SecureRandom createSecureRandom(byte[] seed) { + return (null == seed) ? new SecureRandom() : new SecureRandom(seed); + } + + /** + * 获取SHA1PRNG的{@link SecureRandom}，类提供加密的强随机数生成器 (RNG)
+ * 注意：此方法获取的是伪随机序列发生器PRNG（pseudo-random number generator） + * + *

+ * 相关说明见：https://stackoverflow.com/questions/137212/how-to-solve-slow-java-securerandom + * + * @return {@link SecureRandom} + * @since 3.1.2 + */ + public static SecureRandom getSecureRandom() { + return getSecureRandom(null); + } + + /** + * 获取SHA1PRNG的{@link SecureRandom}，类提供加密的强随机数生成器 (RNG)
+ * 注意：此方法获取的是伪随机序列发生器PRNG（pseudo-random number generator） + * + *

+ * 相关说明见：https://stackoverflow.com/questions/137212/how-to-solve-slow-java-securerandom + * + * @param seed 随机数种子 + * @return {@link SecureRandom} + * @see #createSecureRandom(byte[]) + * @since 5.5.2 + */ + public static SecureRandom getSecureRandom(byte[] seed) { + return createSecureRandom(seed); + } + + /** + * 获取SHA1PRNG的{@link SecureRandom}，类提供加密的强随机数生成器 (RNG)
+ * 注意：此方法获取的是伪随机序列发生器PRNG（pseudo-random number generator）,在Linux下噪声生成时可能造成较长时间停顿。
+ * see: http://ifeve.com/jvm-random-and-entropy-source/ + * + *

+ * 相关说明见：https://stackoverflow.com/questions/137212/how-to-solve-slow-java-securerandom + * + * @param seed 随机数种子 + * @return {@link SecureRandom} + * @since 5.5.8 + */ + public static SecureRandom getSHA1PRNGRandom(byte[] seed) { + SecureRandom random; + try { + random = SecureRandom.getInstance("SHA1PRNG"); + } catch (NoSuchAlgorithmException e) { + throw new UtilException(e); + } + if (null != seed) { + random.setSeed(seed); + } + return random; + } + + /** + * 获取algorithms/providers中提供的强安全随机生成器
+ * 注意：此方法可能造成阻塞或性能问题 + * + * @return {@link SecureRandom} + * @since 5.7.12 + */ + public static SecureRandom getSecureRandomStrong() { + try { + return SecureRandom.getInstanceStrong(); + } catch (NoSuchAlgorithmException e) { + throw new UtilException(e); + } + } + + /** + * 获取随机数产生器 + * + * @param isSecure 是否为强随机数生成器 (RNG) + * @return {@link Random} + * @see #getSecureRandom() + * @see #getRandom() + * @since 4.1.15 + */ + public static Random getRandom(boolean isSecure) { + return isSecure ? getSecureRandom() : getRandom(); + } + + /** + * 获得随机Boolean值 + * + * @return true or false + * @since 4.5.9 + */ + public static boolean randomBoolean() { + return 0 == randomInt(2); + } + + /** + * 随机汉字（'\u4E00'-'\u9FFF'） + * + * @return 随机的汉字字符 + * @since 5.7.15 + */ + public static char randomChinese() { + return (char) randomInt('\u4E00', '\u9FFF'); + } + + /** + * 获得指定范围内的随机数 + * + * @param min 最小数（包含） + * @param max 最大数（不包含） + * @return 随机数 + */ + public static int randomInt(int min, int max) { + return getRandom().nextInt(min, max); + } + + /** + * 获得随机数int值 + * + * @return 随机数 + * @see Random#nextInt() + */ + public static int randomInt() { + return getRandom().nextInt(); + } + + /** + * 获得指定范围内的随机数 [0,limit) + * + * @param limit 限制随机数的范围，不包括这个数 + * @return 随机数 + * @see Random#nextInt(int) + */ + public static int randomInt(int limit) { + return getRandom().nextInt(limit); + } + + /** + * 获得指定范围内的随机数[min, max) + * + * @param min 最小数（包含） + * @param max 最大数（不包含） + * @return 随机数 + * @see ThreadLocalRandom#nextLong(long, long) + * @since 3.3.0 + */ + public static long randomLong(long min, long max) { + return getRandom().nextLong(min, max); + } + + /** + * 获得随机数 + * + * @return 随机数 + * @see ThreadLocalRandom#nextLong() + * @since 3.3.0 + */ + public static long randomLong() { + return getRandom().nextLong(); + } + + /** + * 获得指定范围内的随机数 [0,limit) + * + * @param limit 限制随机数的范围，不包括这个数 + * @return 随机数 + * @see ThreadLocalRandom#nextLong(long) + */ + public static long randomLong(long limit) { + return getRandom().nextLong(limit); + } + + /** + * 获得指定范围内的随机数 + * + * @param min 最小数（包含） + * @param max 最大数（不包含） + * @return 随机数 + * @see ThreadLocalRandom#nextDouble(double, double) + * @since 3.3.0 + */ + public static double randomDouble(double min, double max) { + return getRandom().nextDouble(min, max); + } + + /** + * 获得指定范围内的随机数 + * + * @param min 最小数（包含） + * @param max 最大数（不包含） + * @param scale 保留小数位数 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 随机数 + * @since 4.0.8 + */ + public static double randomDouble(double min, double max, int scale, RoundingMode roundingMode) { + return NumberUtil.round(randomDouble(min, max), scale, roundingMode).doubleValue(); + } + + /** + * 获得随机数[0, 1) + * + * @return 随机数 + * @see ThreadLocalRandom#nextDouble() + * @since 3.3.0 + */ + public static double randomDouble() { + return getRandom().nextDouble(); + } + + /** + * 获得指定范围内的随机数 + * + * @param scale 保留小数位数 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 随机数 + * @since 4.0.8 + */ + public static double randomDouble(int scale, RoundingMode roundingMode) { + return NumberUtil.round(randomDouble(), scale, roundingMode).doubleValue(); + } + + /** + * 获得指定范围内的随机数 [0,limit) + * + * @param limit 限制随机数的范围，不包括这个数 + * @return 随机数 + * @see ThreadLocalRandom#nextDouble(double) + * @since 3.3.0 + */ + public static double randomDouble(double limit) { + return getRandom().nextDouble(limit); + } + + /** + * 获得指定范围内的随机数 + * + * @param limit 限制随机数的范围，不包括这个数 + * @param scale 保留小数位数 + * @param roundingMode 保留小数的模式 {@link RoundingMode} + * @return 随机数 + * @since 4.0.8 + */ + public static double randomDouble(double limit, int scale, RoundingMode roundingMode) { + return NumberUtil.round(randomDouble(limit), scale, roundingMode).doubleValue(); + } + + /** + * 获得指定范围内的随机数[0, 1) + * + * @return 随机数 + * @since 4.0.9 + */ + public static BigDecimal randomBigDecimal() { + return NumberUtil.toBigDecimal(getRandom().nextDouble()); + } + + /** + * 获得指定范围内的随机数 [0,limit) + * + * @param limit 最大数（不包含） + * @return 随机数 + * @since 4.0.9 + */ + public static BigDecimal randomBigDecimal(BigDecimal limit) { + return NumberUtil.toBigDecimal(getRandom().nextDouble(limit.doubleValue())); + } + + /** + * 获得指定范围内的随机数 + * + * @param min 最小数（包含） + * @param max 最大数（不包含） + * @return 随机数 + * @since 4.0.9 + */ + public static BigDecimal randomBigDecimal(BigDecimal min, BigDecimal max) { + return NumberUtil.toBigDecimal(getRandom().nextDouble(min.doubleValue(), max.doubleValue())); + } + + /** + * 随机bytes + * + * @param length 长度 + * @return bytes + */ + public static byte[] randomBytes(int length) { + byte[] bytes = new byte[length]; + getRandom().nextBytes(bytes); + return bytes; + } + + /** + * 随机获得列表中的元素 + * + * @param 元素类型 + * @param list 列表 + * @return 随机元素 + */ + public static T randomEle(List list) { + return randomEle(list, list.size()); + } + + /** + * 随机获得列表中的元素 + * + * @param 元素类型 + * @param list 列表 + * @param limit 限制列表的前N项 + * @return 随机元素 + */ + public static T randomEle(List list, int limit) { + if (list.size() < limit) { + limit = list.size(); + } + return list.get(randomInt(limit)); + } + + /** + * 随机获得数组中的元素 + * + * @param 元素类型 + * @param array 列表 + * @return 随机元素 + * @since 3.3.0 + */ + public static T randomEle(T[] array) { + return randomEle(array, array.length); + } + + /** + * 随机获得数组中的元素 + * + * @param 元素类型 + * @param array 列表 + * @param limit 限制列表的前N项 + * @return 随机元素 + * @since 3.3.0 + */ + public static T randomEle(T[] array, int limit) { + if (array.length < limit) { + limit = array.length; + } + return array[randomInt(limit)]; + } + + /** + * 随机获得列表中的一定量元素 + * + * @param 元素类型 + * @param list 列表 + * @param count 随机取出的个数 + * @return 随机元素 + */ + public static List randomEles(List list, int count) { + final List result = new ArrayList<>(count); + int limit = list.size(); + while (result.size() < count) { + result.add(randomEle(list, limit)); + } + + return result; + } + + /** + * 随机获得列表中的一定量的元素，返回List
+ * 此方法与{@link #randomEles(List, int)} 不同点在于，不会获取重复位置的元素 + * + * @param source 列表 + * @param count 随机取出的个数 + * @param 元素类型 + * @return 随机列表 + * @since 5.2.1 + */ + public static List randomEleList(List source, int count) { + if (count >= source.size()) { + return ListUtil.toList(source); + } + final int[] randomList = ArrayUtil.sub(randomInts(source.size()), 0, count); + List result = new ArrayList<>(); + for (int e : randomList) { + result.add(source.get(e)); + } + return result; + } + + /** + * 随机获得列表中的一定量的不重复元素，返回Set + * + * @param 元素类型 + * @param collection 列表 + * @param count 随机取出的个数 + * @return 随机元素 + * @throws IllegalArgumentException 需要的长度大于给定集合非重复总数 + */ + public static Set randomEleSet(Collection collection, int count) { + final ArrayList source = CollUtil.distinct(collection); + if (count > source.size()) { + throw new IllegalArgumentException("Count is larger than collection distinct size !"); + } + + final Set result = new LinkedHashSet<>(count); + int limit = source.size(); + while (result.size() < count) { + result.add(randomEle(source, limit)); + } + + return result; + } + + /** + * 创建指定长度的随机索引 + * + * @param length 长度 + * @return 随机索引 + * @since 5.2.1 + */ + public static int[] randomInts(int length) { + final int[] range = ArrayUtil.range(length); + for (int i = 0; i < length; i++) { + int random = randomInt(i, length); + ArrayUtil.swap(range, i, random); + } + return range; + } + + /** + * 获得一个随机的字符串（只包含数字和字符） + * + * @param length 字符串的长度 + * @return 随机字符串 + */ + public static String randomString(int length) { + return randomString(BASE_CHAR_NUMBER, length); + } + + /** + * 获得一个随机的字符串（只包含数字和大写字符） + * + * @param length 字符串的长度 + * @return 随机字符串 + * @since 4.0.13 + */ + public static String randomStringUpper(int length) { + return randomString(BASE_CHAR_NUMBER, length).toUpperCase(); + } + + /** + * 获得一个随机的字符串（只包含数字和小写字母） 并排除指定字符串 + * + * @param length 字符串的长度 + * @param elemData 要排除的字符串,如：去重容易混淆的字符串，oO0、lL1、q9Q、pP，不区分大小写 + * @return 随机字符串 + */ + public static String randomStringWithoutStr(int length, String elemData) { + String baseStr = BASE_CHAR_NUMBER; + baseStr = StrUtil.removeAll(baseStr, elemData.toLowerCase().toCharArray()); + return randomString(baseStr, length); + } + + /** + * 获得一个只包含数字的字符串 + * + * @param length 字符串的长度 + * @return 随机字符串 + */ + public static String randomNumbers(int length) { + return randomString(BASE_NUMBER, length); + } + + /** + * 获得一个随机的字符串 + * + * @param baseString 随机字符选取的样本 + * @param length 字符串的长度 + * @return 随机字符串 + */ + public static String randomString(String baseString, int length) { + if (StrUtil.isEmpty(baseString)) { + return StrUtil.EMPTY; + } + if (length < 1) { + length = 1; + } + + final StringBuilder sb = new StringBuilder(length); + int baseLength = baseString.length(); + for (int i = 0; i < length; i++) { + int number = randomInt(baseLength); + sb.append(baseString.charAt(number)); + } + return sb.toString(); + } + + /** + * 随机数字，数字为0~9单个数字 + * + * @return 随机数字字符 + * @since 3.1.2 + */ + public static char randomNumber() { + return randomChar(BASE_NUMBER); + } + + /** + * 随机字母或数字，小写 + * + * @return 随机字符 + * @since 3.1.2 + */ + public static char randomChar() { + return randomChar(BASE_CHAR_NUMBER); + } + + /** + * 随机字符 + * + * @param baseString 随机字符选取的样本 + * @return 随机字符 + * @since 3.1.2 + */ + public static char randomChar(String baseString) { + return baseString.charAt(randomInt(baseString.length())); + } + + /** + * 生成随机颜色 + * + * @return 随机颜色 + * @since 4.1.5 + * @deprecated 使用ImgUtil.randomColor() + */ + @Deprecated + public static Color randomColor() { + final Random random = getRandom(); + return new Color(random.nextInt(256), random.nextInt(256), random.nextInt(256)); + } + + /** + * 带有权重的随机生成器 + * + * @param 随机对象类型 + * @param weightObjs 带有权重的对象列表 + * @return {@link WeightRandom} + * @since 4.0.3 + */ + public static WeightRandom weightRandom(WeightObj[] weightObjs) { + return new WeightRandom<>(weightObjs); + } + + /** + * 带有权重的随机生成器 + * + * @param 随机对象类型 + * @param weightObjs 带有权重的对象列表 + * @return {@link WeightRandom} + * @since 4.0.3 + */ + public static WeightRandom weightRandom(Iterable> weightObjs) { + return new WeightRandom<>(weightObjs); + } + + /** + * 以当天为基准，随机产生一个日期 + * + * @param min 偏移最小天，可以为负数表示过去的时间（包含） + * @param max 偏移最大天，可以为负数表示过去的时间（不包含） + * @return 随机日期（随机天，其它时间不变） + * @since 4.0.8 + */ + public static DateTime randomDay(int min, int max) { + return randomDate(DateUtil.date(), DateField.DAY_OF_YEAR, min, max); + } + + /** + * 以给定日期为基准，随机产生一个日期 + * + * @param baseDate 基准日期 + * @param dateField 偏移的时间字段，例如时、分、秒等 + * @param min 偏移最小量，可以为负数表示过去的时间（包含） + * @param max 偏移最大量，可以为负数表示过去的时间（不包含） + * @return 随机日期 + * @since 4.5.8 + */ + public static DateTime randomDate(Date baseDate, DateField dateField, int min, int max) { + if (null == baseDate) { + baseDate = DateUtil.date(); + } + + return DateUtil.offset(baseDate, dateField, randomInt(min, max)); + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ReUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ReUtil.java new file mode 100755 index 0000000..121c2f0 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ReUtil.java @@ -0,0 +1,989 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.comparator.LengthComparator; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.PatternPool; +import aiyh.utils.tool.cn.hutool.core.lang.RegexPool; +import aiyh.utils.tool.cn.hutool.core.lang.Validator; +import aiyh.utils.tool.cn.hutool.core.lang.func.Func1; +import aiyh.utils.tool.cn.hutool.core.lang.mutable.Mutable; +import aiyh.utils.tool.cn.hutool.core.lang.mutable.MutableObj; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.TreeSet; +import java.util.function.Consumer; +import java.util.regex.MatchResult; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * 正则相关工具类
+ * 常用正则请见 {@link Validator} + * + * @author xiaoleilu + */ +public class ReUtil { + + /** + * 正则表达式匹配中文汉字 + */ + public final static String RE_CHINESE = RegexPool.CHINESE; + /** + * 正则表达式匹配中文字符串 + */ + public final static String RE_CHINESES = RegexPool.CHINESES; + + /** + * 正则中需要被转义的关键字 + */ + public final static Set RE_KEYS = CollUtil.newHashSet('$', '(', ')', '*', '+', '.', '[', ']', '?', '\\', '^', '{', '}', '|'); + + /** + * 获得匹配的字符串，获得正则中分组0的内容 + * + * @param regex 匹配的正则 + * @param content 被匹配的内容 + * @return 匹配后得到的字符串，未匹配返回null + * @since 3.1.2 + */ + public static String getGroup0(String regex, CharSequence content) { + return get(regex, content, 0); + } + + /** + * 获得匹配的字符串，获得正则中分组1的内容 + * + * @param regex 匹配的正则 + * @param content 被匹配的内容 + * @return 匹配后得到的字符串，未匹配返回null + * @since 3.1.2 + */ + public static String getGroup1(String regex, CharSequence content) { + return get(regex, content, 1); + } + + /** + * 获得匹配的字符串 + * + * @param regex 匹配的正则 + * @param content 被匹配的内容 + * @param groupIndex 匹配正则的分组序号 + * @return 匹配后得到的字符串，未匹配返回null + */ + public static String get(String regex, CharSequence content, int groupIndex) { + if (null == content || null == regex) { + return null; + } + + final Pattern pattern = PatternPool.get(regex, Pattern.DOTALL); + return get(pattern, content, groupIndex); + } + + /** + * 获得匹配的字符串 + * + * @param regex 匹配的正则 + * @param content 被匹配的内容 + * @param groupName 匹配正则的分组名称 + * @return 匹配后得到的字符串，未匹配返回null + */ + public static String get(String regex, CharSequence content, String groupName) { + if (null == content || null == regex) { + return null; + } + + final Pattern pattern = PatternPool.get(regex, Pattern.DOTALL); + return get(pattern, content, groupName); + } + + /** + * 获得匹配的字符串，获得正则中分组0的内容 + * + * @param pattern 编译后的正则模式 + * @param content 被匹配的内容 + * @return 匹配后得到的字符串，未匹配返回null + * @since 3.1.2 + */ + public static String getGroup0(Pattern pattern, CharSequence content) { + return get(pattern, content, 0); + } + + /** + * 获得匹配的字符串，获得正则中分组1的内容 + * + * @param pattern 编译后的正则模式 + * @param content 被匹配的内容 + * @return 匹配后得到的字符串，未匹配返回null + * @since 3.1.2 + */ + public static String getGroup1(Pattern pattern, CharSequence content) { + return get(pattern, content, 1); + } + + /** + * 获得匹配的字符串，对应分组0表示整个匹配内容，1表示第一个括号分组内容，依次类推 + * + * @param pattern 编译后的正则模式 + * @param content 被匹配的内容 + * @param groupIndex 匹配正则的分组序号，0表示整个匹配内容，1表示第一个括号分组内容，依次类推 + * @return 匹配后得到的字符串，未匹配返回null + */ + public static String get(Pattern pattern, CharSequence content, int groupIndex) { + if (null == content || null == pattern) { + return null; + } + + final MutableObj result = new MutableObj<>(); + get(pattern, content, matcher -> result.set(matcher.group(groupIndex))); + return result.get(); + } + + /** + * 获得匹配的字符串 + * + * @param pattern 匹配的正则 + * @param content 被匹配的内容 + * @param groupName 匹配正则的分组名称 + * @return 匹配后得到的字符串，未匹配返回null + * @since 5.7.15 + */ + public static String get(Pattern pattern, CharSequence content, String groupName) { + if (null == content || null == pattern || null == groupName) { + return null; + } + + final MutableObj result = new MutableObj<>(); + get(pattern, content, matcher -> result.set(matcher.group(groupName))); + return result.get(); + } + + /** + * 在给定字符串中查找给定规则的字符，如果找到则使用{@link Consumer}处理之
+ * 如果内容中有多个匹配项，则只处理找到的第一个结果。 + * + * @param pattern 匹配的正则 + * @param content 被匹配的内容 + * @param consumer 匹配到的内容处理器 + * @since 5.7.15 + */ + public static void get(Pattern pattern, CharSequence content, Consumer consumer) { + if (null == content || null == pattern || null == consumer) { + return; + } + final Matcher m = pattern.matcher(content); + if (m.find()) { + consumer.accept(m); + } + } + + /** + * 获得匹配的字符串匹配到的所有分组 + * + * @param pattern 编译后的正则模式 + * @param content 被匹配的内容 + * @return 匹配后得到的字符串数组，按照分组顺序依次列出，未匹配到返回空列表，任何一个参数为null返回null + * @since 3.1.0 + */ + public static List getAllGroups(Pattern pattern, CharSequence content) { + return getAllGroups(pattern, content, true); + } + + /** + * 获得匹配的字符串匹配到的所有分组 + * + * @param pattern 编译后的正则模式 + * @param content 被匹配的内容 + * @param withGroup0 是否包括分组0，此分组表示全匹配的信息 + * @return 匹配后得到的字符串数组，按照分组顺序依次列出，未匹配到返回空列表，任何一个参数为null返回null + * @since 4.0.13 + */ + public static List getAllGroups(Pattern pattern, CharSequence content, boolean withGroup0) { + return getAllGroups(pattern, content, withGroup0, false); + } + + /** + * 获得匹配的字符串匹配到的所有分组 + * + * @param pattern 编译后的正则模式 + * @param content 被匹配的内容 + * @param withGroup0 是否包括分组0，此分组表示全匹配的信息 + * @param findAll 是否查找所有匹配到的内容，{@code false}表示只读取第一个匹配到的内容 + * @return 匹配后得到的字符串数组，按照分组顺序依次列出，未匹配到返回空列表，任何一个参数为null返回null + * @since 4.0.13 + */ + public static List getAllGroups(Pattern pattern, CharSequence content, boolean withGroup0, boolean findAll) { + if (null == content || null == pattern) { + return null; + } + + ArrayList result = new ArrayList<>(); + final Matcher matcher = pattern.matcher(content); + while (matcher.find()) { + final int startGroup = withGroup0 ? 0 : 1; + final int groupCount = matcher.groupCount(); + for (int i = startGroup; i <= groupCount; i++) { + result.add(matcher.group(i)); + } + + if(false == findAll){ + break; + } + } + return result; + } + + /** + * 根据给定正则查找字符串中的匹配项，返回所有匹配的分组名对应分组值
+ * 

+	 * pattern: (?<year>\\d+)-(?<month>\\d+)-(?<day>\\d+)
+	 * content: 2021-10-11
+	 * result : year: 2021, month: 10, day: 11
+	 *
+ * + * @param pattern 匹配的正则 + * @param content 被匹配的内容 + * @return 命名捕获组，key为分组名，value为对应值 + * @since 5.7.15 + */ + public static Map getAllGroupNames(Pattern pattern, CharSequence content) { + if (null == content || null == pattern) { + return null; + } + final Matcher m = pattern.matcher(content); + final Map result = MapUtil.newHashMap(m.groupCount()); + if (m.find()) { + // 通过反射获取 namedGroups 方法 + final Map map = ReflectUtil.invoke(pattern, "namedGroups"); + map.forEach((key, value) -> result.put(key, m.group(value))); + } + return result; + } + + /** + * 从content中匹配出多个值并根据template生成新的字符串
+ * 例如：
+ * content 2013年5月 pattern (.*?)年(.*?)月 template： $1-$2 return 2013-5 + * + * @param pattern 匹配正则 + * @param content 被匹配的内容 + * @param template 生成内容模板，变量 $1 表示group1的内容，以此类推 + * @return 新字符串 + */ + public static String extractMulti(Pattern pattern, CharSequence content, String template) { + if (null == content || null == pattern || null == template) { + return null; + } + + //提取模板中的编号 + final TreeSet varNums = new TreeSet<>((o1, o2) -> ObjectUtil.compare(o2, o1)); + final Matcher matcherForTemplate = PatternPool.GROUP_VAR.matcher(template); + while (matcherForTemplate.find()) { + varNums.add(Integer.parseInt(matcherForTemplate.group(1))); + } + + final Matcher matcher = pattern.matcher(content); + if (matcher.find()) { + for (Integer group : varNums) { + template = template.replace("$" + group, matcher.group(group)); + } + return template; + } + return null; + } + + /** + * 从content中匹配出多个值并根据template生成新的字符串
+ * 匹配结束后会删除匹配内容之前的内容（包括匹配内容）
+ * 例如：
+ * content 2013年5月 pattern (.*?)年(.*?)月 template： $1-$2 return 2013-5 + * + * @param regex 匹配正则字符串 + * @param content 被匹配的内容 + * @param template 生成内容模板，变量 $1 表示group1的内容，以此类推 + * @return 按照template拼接后的字符串 + */ + public static String extractMulti(String regex, CharSequence content, String template) { + if (null == content || null == regex || null == template) { + return null; + } + + final Pattern pattern = PatternPool.get(regex, Pattern.DOTALL); + return extractMulti(pattern, content, template); + } + + /** + * 从content中匹配出多个值并根据template生成新的字符串
+ * 匹配结束后会删除匹配内容之前的内容（包括匹配内容）
+ * 例如：
+ * content 2013年5月 pattern (.*?)年(.*?)月 template： $1-$2 return 2013-5 + * + * @param pattern 匹配正则 + * @param contentHolder 被匹配的内容的Holder，value为内容正文，经过这个方法的原文将被去掉匹配之前的内容 + * @param template 生成内容模板，变量 $1 表示group1的内容，以此类推 + * @return 新字符串 + * @since 5.8.0 + */ + public static String extractMultiAndDelPre(Pattern pattern, Mutable contentHolder, String template) { + if (null == contentHolder || null == pattern || null == template) { + return null; + } + + HashSet varNums = findAll(PatternPool.GROUP_VAR, template, 1, new HashSet<>()); + + final CharSequence content = contentHolder.get(); + Matcher matcher = pattern.matcher(content); + if (matcher.find()) { + for (String var : varNums) { + int group = Integer.parseInt(var); + template = template.replace("$" + var, matcher.group(group)); + } + contentHolder.set(StrUtil.sub(content, matcher.end(), content.length())); + return template; + } + return null; + } + + /** + * 从content中匹配出多个值并根据template生成新的字符串
+ * 例如：
+ * content 2013年5月 pattern (.*?)年(.*?)月 template： $1-$2 return 2013-5 + * + * @param regex 匹配正则字符串 + * @param contentHolder 被匹配的内容的Holder，value为内容正文，经过这个方法的原文将被去掉匹配之前的内容 + * @param template 生成内容模板，变量 $1 表示group1的内容，以此类推 + * @return 按照template拼接后的字符串 + */ + public static String extractMultiAndDelPre(String regex, Mutable contentHolder, String template) { + if (null == contentHolder || null == regex || null == template) { + return null; + } + + final Pattern pattern = PatternPool.get(regex, Pattern.DOTALL); + return extractMultiAndDelPre(pattern, contentHolder, template); + } + + /** + * 删除匹配的第一个内容 + * + * @param regex 正则 + * @param content 被匹配的内容 + * @return 删除后剩余的内容 + */ + public static String delFirst(String regex, CharSequence content) { + if (StrUtil.hasBlank(regex, content)) { + return StrUtil.str(content); + } + + final Pattern pattern = PatternPool.get(regex, Pattern.DOTALL); + return delFirst(pattern, content); + } + + /** + * 删除匹配的第一个内容 + * + * @param pattern 正则 + * @param content 被匹配的内容 + * @return 删除后剩余的内容 + */ + public static String delFirst(Pattern pattern, CharSequence content) { + return replaceFirst(pattern, content, StrUtil.EMPTY); + } + + /** + * 替换匹配的第一个内容 + * + * @param pattern 正则 + * @param content 被匹配的内容 + * @param replacement 替换的内容 + * @return 替换后剩余的内容 + * @since 5.6.5 + */ + public static String replaceFirst(Pattern pattern, CharSequence content, String replacement) { + if (null == pattern || StrUtil.isEmpty(content)) { + return StrUtil.str(content); + } + + return pattern.matcher(content).replaceFirst(replacement); + } + + /** + * 删除匹配的最后一个内容 + * + * @param regex 正则 + * @param str 被匹配的内容 + * @return 删除后剩余的内容 + * @since 5.6.5 + */ + public static String delLast(String regex, CharSequence str) { + if (StrUtil.hasBlank(regex, str)) { + return StrUtil.str(str); + } + + final Pattern pattern = PatternPool.get(regex, Pattern.DOTALL); + return delLast(pattern, str); + } + + /** + * 删除匹配的最后一个内容 + * + * @param pattern 正则 + * @param str 被匹配的内容 + * @return 删除后剩余的内容 + * @since 5.6.5 + */ + public static String delLast(Pattern pattern, CharSequence str) { + if (null != pattern && StrUtil.isNotEmpty(str)) { + final MatchResult matchResult = lastIndexOf(pattern, str); + if (null != matchResult) { + return StrUtil.subPre(str, matchResult.start()) + StrUtil.subSuf(str, matchResult.end()); + } + } + + return StrUtil.str(str); + } + + /** + * 删除匹配的全部内容 + * + * @param regex 正则 + * @param content 被匹配的内容 + * @return 删除后剩余的内容 + */ + public static String delAll(String regex, CharSequence content) { + if (StrUtil.hasBlank(regex, content)) { + return StrUtil.str(content); + } + + final Pattern pattern = PatternPool.get(regex, Pattern.DOTALL); + return delAll(pattern, content); + } + + /** + * 删除匹配的全部内容 + * + * @param pattern 正则 + * @param content 被匹配的内容 + * @return 删除后剩余的内容 + */ + public static String delAll(Pattern pattern, CharSequence content) { + if (null == pattern || StrUtil.isBlank(content)) { + return StrUtil.str(content); + } + + return pattern.matcher(content).replaceAll(StrUtil.EMPTY); + } + + /** + * 删除正则匹配到的内容之前的字符 如果没有找到，则返回原文 + * + * @param regex 定位正则 + * @param content 被查找的内容 + * @return 删除前缀后的新内容 + */ + public static String delPre(String regex, CharSequence content) { + if (null == content || null == regex) { + return StrUtil.str(content); + } + + final Pattern pattern = PatternPool.get(regex, Pattern.DOTALL); + return delPre(pattern, content); + } + + /** + * 删除正则匹配到的内容之前的字符 如果没有找到，则返回原文 + * + * @param pattern 定位正则模式 + * @param content 被查找的内容 + * @return 删除前缀后的新内容 + */ + public static String delPre(Pattern pattern, CharSequence content) { + if (null == content || null == pattern) { + return StrUtil.str(content); + } + + final Matcher matcher = pattern.matcher(content); + if (matcher.find()) { + return StrUtil.sub(content, matcher.end(), content.length()); + } + return StrUtil.str(content); + } + + /** + * 取得内容中匹配的所有结果，获得匹配的所有结果中正则对应分组0的内容 + * + * @param regex 正则 + * @param content 被查找的内容 + * @return 结果列表 + * @since 3.1.2 + */ + public static List findAllGroup0(String regex, CharSequence content) { + return findAll(regex, content, 0); + } + + /** + * 取得内容中匹配的所有结果，获得匹配的所有结果中正则对应分组1的内容 + * + * @param regex 正则 + * @param content 被查找的内容 + * @return 结果列表 + * @since 3.1.2 + */ + public static List findAllGroup1(String regex, CharSequence content) { + return findAll(regex, content, 1); + } + + /** + * 取得内容中匹配的所有结果 + * + * @param regex 正则 + * @param content 被查找的内容 + * @param group 正则的分组 + * @return 结果列表 + * @since 3.0.6 + */ + public static List findAll(String regex, CharSequence content, int group) { + return findAll(regex, content, group, new ArrayList<>()); + } + + /** + * 取得内容中匹配的所有结果 + * + * @param 集合类型 + * @param regex 正则 + * @param content 被查找的内容 + * @param group 正则的分组 + * @param collection 返回的集合类型 + * @return 结果集 + */ + public static > T findAll(String regex, CharSequence content, int group, T collection) { + if (null == regex) { + return collection; + } + + return findAll(PatternPool.get(regex, Pattern.DOTALL), content, group, collection); + } + + /** + * 取得内容中匹配的所有结果，获得匹配的所有结果中正则对应分组0的内容 + * + * @param pattern 编译后的正则模式 + * @param content 被查找的内容 + * @return 结果列表 + * @since 3.1.2 + */ + public static List findAllGroup0(Pattern pattern, CharSequence content) { + return findAll(pattern, content, 0); + } + + /** + * 取得内容中匹配的所有结果，获得匹配的所有结果中正则对应分组1的内容 + * + * @param pattern 编译后的正则模式 + * @param content 被查找的内容 + * @return 结果列表 + * @since 3.1.2 + */ + public static List findAllGroup1(Pattern pattern, CharSequence content) { + return findAll(pattern, content, 1); + } + + /** + * 取得内容中匹配的所有结果 + * + * @param pattern 编译后的正则模式 + * @param content 被查找的内容 + * @param group 正则的分组 + * @return 结果列表 + * @since 3.0.6 + */ + public static List findAll(Pattern pattern, CharSequence content, int group) { + return findAll(pattern, content, group, new ArrayList<>()); + } + + /** + * 取得内容中匹配的所有结果 + * + * @param 集合类型 + * @param pattern 编译后的正则模式 + * @param content 被查找的内容 + * @param group 正则的分组 + * @param collection 返回的集合类型 + * @return 结果集 + */ + public static > T findAll(Pattern pattern, CharSequence content, int group, T collection) { + if (null == pattern || null == content) { + return null; + } + Assert.notNull(collection, "Collection must be not null !"); + + findAll(pattern, content, (matcher) -> collection.add(matcher.group(group))); + return collection; + } + + /** + * 取得内容中匹配的所有结果，使用{@link Consumer}完成匹配结果处理 + * + * @param pattern 编译后的正则模式 + * @param content 被查找的内容 + * @param consumer 匹配结果处理函数 + * @since 5.7.15 + */ + public static void findAll(Pattern pattern, CharSequence content, Consumer consumer) { + if (null == pattern || null == content) { + return; + } + + final Matcher matcher = pattern.matcher(content); + while (matcher.find()) { + consumer.accept(matcher); + } + } + + /** + * 计算指定字符串中，匹配pattern的个数 + * + * @param regex 正则表达式 + * @param content 被查找的内容 + * @return 匹配个数 + */ + public static int count(String regex, CharSequence content) { + if (null == regex || null == content) { + return 0; + } + + final Pattern pattern = PatternPool.get(regex, Pattern.DOTALL); + return count(pattern, content); + } + + /** + * 计算指定字符串中，匹配pattern的个数 + * + * @param pattern 编译后的正则模式 + * @param content 被查找的内容 + * @return 匹配个数 + */ + public static int count(Pattern pattern, CharSequence content) { + if (null == pattern || null == content) { + return 0; + } + + int count = 0; + final Matcher matcher = pattern.matcher(content); + while (matcher.find()) { + count++; + } + + return count; + } + + /** + * 指定内容中是否有表达式匹配的内容 + * + * @param regex 正则表达式 + * @param content 被查找的内容 + * @return 指定内容中是否有表达式匹配的内容 + * @since 3.3.1 + */ + public static boolean contains(String regex, CharSequence content) { + if (null == regex || null == content) { + return false; + } + + final Pattern pattern = PatternPool.get(regex, Pattern.DOTALL); + return contains(pattern, content); + } + + /** + * 指定内容中是否有表达式匹配的内容 + * + * @param pattern 编译后的正则模式 + * @param content 被查找的内容 + * @return 指定内容中是否有表达式匹配的内容 + * @since 3.3.1 + */ + public static boolean contains(Pattern pattern, CharSequence content) { + if (null == pattern || null == content) { + return false; + } + return pattern.matcher(content).find(); + } + + /** + * 找到指定正则匹配到字符串的开始位置 + * + * @param regex 正则 + * @param content 字符串 + * @return 位置，{@code null}表示未找到 + * @since 5.6.5 + */ + public static MatchResult indexOf(String regex, CharSequence content) { + if (null == regex || null == content) { + return null; + } + + final Pattern pattern = PatternPool.get(regex, Pattern.DOTALL); + return indexOf(pattern, content); + } + + /** + * 找到指定模式匹配到字符串的开始位置 + * + * @param pattern 模式 + * @param content 字符串 + * @return 位置，{@code null}表示未找到 + * @since 5.6.5 + */ + public static MatchResult indexOf(Pattern pattern, CharSequence content) { + if (null != pattern && null != content) { + final Matcher matcher = pattern.matcher(content); + if (matcher.find()) { + return matcher.toMatchResult(); + } + } + + return null; + } + + /** + * 找到指定正则匹配到第一个字符串的位置 + * + * @param regex 正则 + * @param content 字符串 + * @return 位置，{@code null}表示未找到 + * @since 5.6.5 + */ + public static MatchResult lastIndexOf(String regex, CharSequence content) { + if (null == regex || null == content) { + return null; + } + + final Pattern pattern = PatternPool.get(regex, Pattern.DOTALL); + return lastIndexOf(pattern, content); + } + + /** + * 找到指定模式匹配到最后一个字符串的位置 + * + * @param pattern 模式 + * @param content 字符串 + * @return 位置，{@code null}表示未找到 + * @since 5.6.5 + */ + public static MatchResult lastIndexOf(Pattern pattern, CharSequence content) { + MatchResult result = null; + if (null != pattern && null != content) { + final Matcher matcher = pattern.matcher(content); + while (matcher.find()) { + result = matcher.toMatchResult(); + } + } + + return result; + } + + /** + * 从字符串中获得第一个整数 + * + * @param StringWithNumber 带数字的字符串 + * @return 整数 + */ + public static Integer getFirstNumber(CharSequence StringWithNumber) { + return Convert.toInt(get(PatternPool.NUMBERS, StringWithNumber, 0), null); + } + + /** + * 给定内容是否匹配正则 + * + * @param regex 正则 + * @param content 内容 + * @return 正则为null或者""则不检查，返回true，内容为null返回false + */ + public static boolean isMatch(String regex, CharSequence content) { + if (content == null) { + // 提供null的字符串为不匹配 + return false; + } + + if (StrUtil.isEmpty(regex)) { + // 正则不存在则为全匹配 + return true; + } + + // Pattern pattern = Pattern.compile(regex, Pattern.DOTALL); + final Pattern pattern = PatternPool.get(regex, Pattern.DOTALL); + return isMatch(pattern, content); + } + + /** + * 给定内容是否匹配正则 + * + * @param pattern 模式 + * @param content 内容 + * @return 正则为null或者""则不检查，返回true，内容为null返回false + */ + public static boolean isMatch(Pattern pattern, CharSequence content) { + if (content == null || pattern == null) { + // 提供null的字符串为不匹配 + return false; + } + return pattern.matcher(content).matches(); + } + + /** + * 正则替换指定值
+ * 通过正则查找到字符串，然后把匹配到的字符串加入到replacementTemplate中，$1表示分组1的字符串 + * + *

+ * 例如：原字符串是：中文1234，我想把1234换成(1234)，则可以： + * + * 

+	 * ReUtil.replaceAll("中文1234", "(\\d+)", "($1)"))
+	 *
+	 * 结果：中文(1234)
+	 *
+ * + * @param content 文本 + * @param regex 正则 + * @param replacementTemplate 替换的文本模板，可以使用$1类似的变量提取正则匹配出的内容 + * @return 处理后的文本 + */ + public static String replaceAll(CharSequence content, String regex, String replacementTemplate) { + final Pattern pattern = Pattern.compile(regex, Pattern.DOTALL); + return replaceAll(content, pattern, replacementTemplate); + } + + /** + * 正则替换指定值
+ * 通过正则查找到字符串，然后把匹配到的字符串加入到replacementTemplate中，$1表示分组1的字符串 + * + * @param content 文本 + * @param pattern {@link Pattern} + * @param replacementTemplate 替换的文本模板，可以使用$1类似的变量提取正则匹配出的内容 + * @return 处理后的文本 + * @since 3.0.4 + */ + public static String replaceAll(CharSequence content, Pattern pattern, String replacementTemplate) { + if (StrUtil.isEmpty(content)) { + return StrUtil.str(content); + } + + final Matcher matcher = pattern.matcher(content); + boolean result = matcher.find(); + if (result) { + final Set varNums = findAll(PatternPool.GROUP_VAR, replacementTemplate, 1, new TreeSet<>(LengthComparator.INSTANCE.reversed())); + final StringBuffer sb = new StringBuffer(); + do { + String replacement = replacementTemplate; + for (final String var : varNums) { + final int group = Integer.parseInt(var); + replacement = replacement.replace("$" + var, matcher.group(group)); + } + matcher.appendReplacement(sb, escape(replacement)); + result = matcher.find(); + } while (result); + matcher.appendTail(sb); + return sb.toString(); + } + return StrUtil.str(content); + } + + /** + * 替换所有正则匹配的文本，并使用自定义函数决定如何替换
+ * replaceFun可以通过{@link Matcher}提取出匹配到的内容的不同部分，然后经过重新处理、组装变成新的内容放回原位。 + * + * 
+	 *     replaceAll(this.content, "(\\d+)", parameters -> "-" + parameters.group(1) + "-")
+	 *     // 结果为："ZZZaaabbbccc中文-1234-"
+	 *
+ * + * @param str 要替换的字符串 + * @param regex 用于匹配的正则式 + * @param replaceFun 决定如何替换的函数 + * @return 替换后的文本 + * @since 4.2.2 + */ + public static String replaceAll(CharSequence str, String regex, Func1 replaceFun) { + return replaceAll(str, Pattern.compile(regex), replaceFun); + } + + /** + * 替换所有正则匹配的文本，并使用自定义函数决定如何替换
+ * replaceFun可以通过{@link Matcher}提取出匹配到的内容的不同部分，然后经过重新处理、组装变成新的内容放回原位。 + * + * 
+	 *     replaceAll(this.content, "(\\d+)", parameters -> "-" + parameters.group(1) + "-")
+	 *     // 结果为："ZZZaaabbbccc中文-1234-"
+	 *
+ * + * @param str 要替换的字符串 + * @param pattern 用于匹配的正则式 + * @param replaceFun 决定如何替换的函数,可能被多次调用（当有多个匹配时） + * @return 替换后的字符串 + * @since 4.2.2 + */ + public static String replaceAll(CharSequence str, Pattern pattern, Func1 replaceFun) { + if (StrUtil.isEmpty(str)) { + return StrUtil.str(str); + } + + final Matcher matcher = pattern.matcher(str); + final StringBuffer buffer = new StringBuffer(); + while (matcher.find()) { + try { + matcher.appendReplacement(buffer, replaceFun.call(matcher)); + } catch (Exception e) { + throw new UtilException(e); + } + } + matcher.appendTail(buffer); + return buffer.toString(); + } + + /** + * 转义字符，将正则的关键字转义 + * + * @param c 字符 + * @return 转义后的文本 + */ + public static String escape(char c) { + final StringBuilder builder = new StringBuilder(); + if (RE_KEYS.contains(c)) { + builder.append('\\'); + } + builder.append(c); + return builder.toString(); + } + + /** + * 转义字符串，将正则的关键字转义 + * + * @param content 文本 + * @return 转义后的文本 + */ + public static String escape(CharSequence content) { + if (StrUtil.isBlank(content)) { + return StrUtil.str(content); + } + + final StringBuilder builder = new StringBuilder(); + int len = content.length(); + char current; + for (int i = 0; i < len; i++) { + current = content.charAt(i); + if (RE_KEYS.contains(current)) { + builder.append('\\'); + } + builder.append(current); + } + return builder.toString(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ReferenceUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ReferenceUtil.java new file mode 100644 index 0000000..959b98c --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ReferenceUtil.java @@ -0,0 +1,75 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import java.lang.ref.PhantomReference; +import java.lang.ref.Reference; +import java.lang.ref.ReferenceQueue; +import java.lang.ref.SoftReference; +import java.lang.ref.WeakReference; + +/** + * 引用工具类，主要针对{@link Reference} 工具化封装
+ * 主要封装包括： + * 
+ * 1. {@link SoftReference} 软引用，在GC报告内存不足时会被GC回收
+ * 2. {@link WeakReference} 弱引用，在GC时发现弱引用会回收其对象
+ * 3. {@link PhantomReference} 虚引用，在GC时发现虚引用对象，会将{@link PhantomReference}插入{@link ReferenceQueue}。 此时对象未被真正回收，要等到{@link ReferenceQueue}被真正处理后才会被回收。
+ *
+ * + * @author looly + * @since 3.1.2 + */ +public class ReferenceUtil { + + /** + * 获得引用 + * + * @param 被引用对象类型 + * @param type 引用类型枚举 + * @param referent 被引用对象 + * @return {@link Reference} + */ + public static Reference create(ReferenceType type, T referent) { + return create(type, referent, null); + } + + /** + * 获得引用 + * + * @param 被引用对象类型 + * @param type 引用类型枚举 + * @param referent 被引用对象 + * @param queue 引用队列 + * @return {@link Reference} + */ + public static Reference create(ReferenceType type, T referent, ReferenceQueue queue) { + switch (type) { + case SOFT: + return new SoftReference<>(referent, queue); + case WEAK: + return new WeakReference<>(referent, queue); + case PHANTOM: + return new PhantomReference<>(referent, queue); + default: + return null; + } + } + + /** + * 引用类型 + * + * @author looly + * + */ + public enum ReferenceType { + /** 软引用，在GC报告内存不足时会被GC回收 */ + SOFT, + /** 弱引用，在GC时发现弱引用会回收其对象 */ + WEAK, + /** + * 虚引用，在GC时发现虚引用对象，会将{@link PhantomReference}插入{@link ReferenceQueue}。
+ * 此时对象未被真正回收，要等到{@link ReferenceQueue}被真正处理后才会被回收。 + */ + PHANTOM + } + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ReflectUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ReflectUtil.java new file mode 100755 index 0000000..9ad094d --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ReflectUtil.java @@ -0,0 +1,1192 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.annotation.Alias; +import aiyh.utils.tool.cn.hutool.core.bean.NullWrapperBean; +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.collection.UniqueKeySet; +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.exceptions.InvocationTargetRuntimeException; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Filter; +import aiyh.utils.tool.cn.hutool.core.lang.reflect.MethodHandleUtil; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import aiyh.utils.tool.cn.hutool.core.map.WeakConcurrentMap; + +import java.lang.reflect.AccessibleObject; +import java.lang.reflect.Array; +import java.lang.reflect.Constructor; +import java.lang.reflect.Field; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.util.AbstractMap; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +/** + * 反射工具类 + * + * @author Looly + * @since 3.0.9 + */ +public class ReflectUtil { + + /** + * 构造对象缓存 + */ + private static final WeakConcurrentMap, Constructor[]> CONSTRUCTORS_CACHE = new WeakConcurrentMap<>(); + /** + * 字段缓存 + */ + private static final WeakConcurrentMap, Field[]> FIELDS_CACHE = new WeakConcurrentMap<>(); + /** + * 方法缓存 + */ + private static final WeakConcurrentMap, Method[]> METHODS_CACHE = new WeakConcurrentMap<>(); + + // --------------------------------------------------------------------------------------------------------- Constructor + + /** + * 查找类中的指定参数的构造方法，如果找到构造方法，会自动设置可访问为true + * + * @param 对象类型 + * @param clazz 类 + * @param parameterTypes 参数类型，只要任何一个参数是指定参数的父类或接口或相等即可，此参数可以不传 + * @return 构造方法，如果未找到返回null + */ + @SuppressWarnings("unchecked") + public static Constructor getConstructor(Class clazz, Class... parameterTypes) { + if (null == clazz) { + return null; + } + + final Constructor[] constructors = getConstructors(clazz); + Class[] pts; + for (Constructor constructor : constructors) { + pts = constructor.getParameterTypes(); + if (ClassUtil.isAllAssignableFrom(pts, parameterTypes)) { + // 构造可访问 + setAccessible(constructor); + return (Constructor) constructor; + } + } + return null; + } + + /** + * 获得一个类中所有构造列表 + * + * @param 构造的对象类型 + * @param beanClass 类，非{@code null} + * @return 字段列表 + * @throws SecurityException 安全检查异常 + */ + @SuppressWarnings("unchecked") + public static Constructor[] getConstructors(Class beanClass) throws SecurityException { + Assert.notNull(beanClass); + return (Constructor[]) CONSTRUCTORS_CACHE.computeIfAbsent(beanClass, () -> getConstructorsDirectly(beanClass)); + } + + /** + * 获得一个类中所有构造列表，直接反射获取，无缓存 + * + * @param beanClass 类 + * @return 字段列表 + * @throws SecurityException 安全检查异常 + */ + public static Constructor[] getConstructorsDirectly(Class beanClass) throws SecurityException { + return beanClass.getDeclaredConstructors(); + } + + // --------------------------------------------------------------------------------------------------------- Field + + /** + * 查找指定类中是否包含指定名称对应的字段，包括所有字段（包括非public字段），也包括父类和Object类的字段 + * + * @param beanClass 被查找字段的类,不能为null + * @param name 字段名 + * @return 是否包含字段 + * @throws SecurityException 安全异常 + * @since 4.1.21 + */ + public static boolean hasField(Class beanClass, String name) throws SecurityException { + return null != getField(beanClass, name); + } + + /** + * 获取字段名，如果存在{@link Alias}注解，读取注解的值作为名称 + * + * @param field 字段 + * @return 字段名 + * @since 5.1.6 + */ + public static String getFieldName(Field field) { + if (null == field) { + return null; + } + + final Alias alias = field.getAnnotation(Alias.class); + if (null != alias) { + return alias.value(); + } + + return field.getName(); + } + + /** + * 查找指定类中的指定name的字段（包括非public字段），也包括父类和Object类的字段， 字段不存在则返回{@code null} + * + * @param beanClass 被查找字段的类,不能为null + * @param name 字段名 + * @return 字段 + * @throws SecurityException 安全异常 + */ + public static Field getField(Class beanClass, String name) throws SecurityException { + final Field[] fields = getFields(beanClass); + return ArrayUtil.firstMatch((field) -> name.equals(getFieldName(field)), fields); + } + + /** + * 获取指定类中字段名和字段对应的有序Map，包括其父类中的字段
+ * 如果子类与父类中存在同名字段，则这两个字段同时存在，子类字段在前，父类字段在后。 + * + * @param beanClass 类 + * @return 字段名和字段对应的Map，有序 + * @since 5.0.7 + */ + public static Map getFieldMap(Class beanClass) { + final Field[] fields = getFields(beanClass); + final HashMap map = MapUtil.newHashMap(fields.length, true); + for (Field field : fields) { + map.put(field.getName(), field); + } + return map; + } + + /** + * 获得一个类中所有字段列表，包括其父类中的字段
+ * 如果子类与父类中存在同名字段，则这两个字段同时存在，子类字段在前，父类字段在后。 + * + * @param beanClass 类 + * @return 字段列表 + * @throws SecurityException 安全检查异常 + */ + public static Field[] getFields(Class beanClass) throws SecurityException { + Assert.notNull(beanClass); + return FIELDS_CACHE.computeIfAbsent(beanClass, () -> getFieldsDirectly(beanClass, true)); + } + + + /** + * 获得一个类中所有满足条件的字段列表，包括其父类中的字段
+ * 如果子类与父类中存在同名字段，则这两个字段同时存在，子类字段在前，父类字段在后。 + * + * @param beanClass 类 + * @param fieldFilter field过滤器，过滤掉不需要的field + * @return 字段列表 + * @throws SecurityException 安全检查异常 + * @since 5.7.14 + */ + public static Field[] getFields(Class beanClass, Filter fieldFilter) throws SecurityException { + return ArrayUtil.filter(getFields(beanClass), fieldFilter); + } + + /** + * 获得一个类中所有字段列表，直接反射获取，无缓存
+ * 如果子类与父类中存在同名字段，则这两个字段同时存在，子类字段在前，父类字段在后。 + * + * @param beanClass 类 + * @param withSuperClassFields 是否包括父类的字段列表 + * @return 字段列表 + * @throws SecurityException 安全检查异常 + */ + public static Field[] getFieldsDirectly(Class beanClass, boolean withSuperClassFields) throws SecurityException { + Assert.notNull(beanClass); + + Field[] allFields = null; + Class searchType = beanClass; + Field[] declaredFields; + while (searchType != null) { + declaredFields = searchType.getDeclaredFields(); + if (null == allFields) { + allFields = declaredFields; + } else { + allFields = ArrayUtil.append(allFields, declaredFields); + } + searchType = withSuperClassFields ? searchType.getSuperclass() : null; + } + + return allFields; + } + + /** + * 获取字段值 + * + * @param obj 对象，如果static字段，此处为类 + * @param fieldName 字段名 + * @return 字段值 + * @throws UtilException 包装IllegalAccessException异常 + */ + public static Object getFieldValue(Object obj, String fieldName) throws UtilException { + if (null == obj || StrUtil.isBlank(fieldName)) { + return null; + } + return getFieldValue(obj, getField(obj instanceof Class ? (Class) obj : obj.getClass(), fieldName)); + } + + /** + * 获取静态字段值 + * + * @param field 字段 + * @return 字段值 + * @throws UtilException 包装IllegalAccessException异常 + * @since 5.1.0 + */ + public static Object getStaticFieldValue(Field field) throws UtilException { + return getFieldValue(null, field); + } + + /** + * 获取字段值 + * + * @param obj 对象，static字段则此字段为null + * @param field 字段 + * @return 字段值 + * @throws UtilException 包装IllegalAccessException异常 + */ + public static Object getFieldValue(Object obj, Field field) throws UtilException { + if (null == field) { + return null; + } + if (obj instanceof Class) { + // 静态字段获取时对象为null + obj = null; + } + + setAccessible(field); + Object result; + try { + result = field.get(obj); + } catch (IllegalAccessException e) { + throw new UtilException(e, "IllegalAccess for {}.{}", field.getDeclaringClass(), field.getName()); + } + return result; + } + + /** + * 获取所有字段的值 + * + * @param obj bean对象，如果是static字段，此处为类class + * @return 字段值数组 + * @since 4.1.17 + */ + public static Object[] getFieldsValue(Object obj) { + if (null != obj) { + final Field[] fields = getFields(obj instanceof Class ? (Class) obj : obj.getClass()); + if (null != fields) { + final Object[] values = new Object[fields.length]; + for (int i = 0; i < fields.length; i++) { + values[i] = getFieldValue(obj, fields[i]); + } + return values; + } + } + return null; + } + + /** + * 设置字段值
+ * 若值类型与字段类型不一致，则会尝试通过 {@link Convert} 进行转换
+ * 若字段类型是原始类型而传入的值是 null，则会将字段设置为对应原始类型的默认值（见 {@link ClassUtil#getDefaultValue(Class)}） + * 如果是final字段，setFieldValue，调用这可以先调用 {@link ReflectUtil#removeFinalModify(Field)}方法去除final修饰符
+ * + * @param obj 对象,static字段则此处传Class + * @param fieldName 字段名 + * @param value 值，当值类型与字段类型不匹配时，会尝试转换 + * @throws UtilException 包装IllegalAccessException异常 + */ + public static void setFieldValue(Object obj, String fieldName, Object value) throws UtilException { + Assert.notNull(obj); + Assert.notBlank(fieldName); + + final Field field = getField((obj instanceof Class) ? (Class) obj : obj.getClass(), fieldName); + Assert.notNull(field, "Field [{}] is not exist in [{}]", fieldName, obj.getClass().getName()); + setFieldValue(obj, field, value); + } + + /** + * 设置字段值
+ * 若值类型与字段类型不一致，则会尝试通过 {@link Convert} 进行转换
+ * 若字段类型是原始类型而传入的值是 null，则会将字段设置为对应原始类型的默认值（见 {@link ClassUtil#getDefaultValue(Class)}）
+ * 如果是final字段，setFieldValue，调用这可以先调用 {@link ReflectUtil#removeFinalModify(Field)}方法去除final修饰符 + * + * @param obj 对象，如果是static字段，此参数为null + * @param field 字段 + * @param value 值，当值类型与字段类型不匹配时，会尝试转换 + * @throws UtilException UtilException 包装IllegalAccessException异常 + */ + public static void setFieldValue(Object obj, Field field, Object value) throws UtilException { + Assert.notNull(field, "Field in [{}] not exist !", obj); + + final Class fieldType = field.getType(); + if (null != value) { + if (false == fieldType.isAssignableFrom(value.getClass())) { + //对于类型不同的字段，尝试转换，转换失败则使用原对象类型 + final Object targetValue = Convert.convert(fieldType, value); + if (null != targetValue) { + value = targetValue; + } + } + } else { + // 获取null对应默认值，防止原始类型造成空指针问题 + value = ClassUtil.getDefaultValue(fieldType); + } + + setAccessible(field); + try { + field.set(obj instanceof Class ? null : obj, value); + } catch (IllegalAccessException e) { + throw new UtilException(e, "IllegalAccess for {}.{}", obj, field.getName()); + } + } + + /** + * 是否为父类引用字段
+ * 当字段所在类是对象子类时（对象中定义的非static的class），会自动生成一个以"this$0"为名称的字段，指向父类对象 + * + * @param field 字段 + * @return 是否为父类引用字段 + * @since 5.7.20 + */ + public static boolean isOuterClassField(Field field) { + return "this$0".equals(field.getName()); + } + + // --------------------------------------------------------------------------------------------------------- method + + /** + * 获得指定类本类及其父类中的Public方法名
+ * 去重重载的方法 + * + * @param clazz 类 + * @return 方法名Set + */ + public static Set getPublicMethodNames(Class clazz) { + final HashSet methodSet = new HashSet<>(); + final Method[] methodArray = getPublicMethods(clazz); + if (ArrayUtil.isNotEmpty(methodArray)) { + for (Method method : methodArray) { + methodSet.add(method.getName()); + } + } + return methodSet; + } + + /** + * 获得本类及其父类所有Public方法 + * + * @param clazz 查找方法的类 + * @return 过滤后的方法列表 + */ + public static Method[] getPublicMethods(Class clazz) { + return null == clazz ? null : clazz.getMethods(); + } + + /** + * 获得指定类过滤后的Public方法列表
+ * TODO 6.x此方法更改返回Method[] + * + * @param clazz 查找方法的类 + * @param filter 过滤器 + * @return 过滤后的方法列表 + */ + public static List getPublicMethods(Class clazz, Filter filter) { + if (null == clazz) { + return null; + } + + final Method[] methods = getPublicMethods(clazz); + List methodList; + if (null != filter) { + methodList = new ArrayList<>(); + for (Method method : methods) { + if (filter.accept(method)) { + methodList.add(method); + } + } + } else { + methodList = CollUtil.newArrayList(methods); + } + return methodList; + } + + /** + * 获得指定类过滤后的Public方法列表 + * + * @param clazz 查找方法的类 + * @param excludeMethods 不包括的方法 + * @return 过滤后的方法列表 + */ + public static List getPublicMethods(Class clazz, Method... excludeMethods) { + final HashSet excludeMethodSet = CollUtil.newHashSet(excludeMethods); + return getPublicMethods(clazz, method -> false == excludeMethodSet.contains(method)); + } + + /** + * 获得指定类过滤后的Public方法列表 + * + * @param clazz 查找方法的类 + * @param excludeMethodNames 不包括的方法名列表 + * @return 过滤后的方法列表 + */ + public static List getPublicMethods(Class clazz, String... excludeMethodNames) { + final HashSet excludeMethodNameSet = CollUtil.newHashSet(excludeMethodNames); + return getPublicMethods(clazz, method -> false == excludeMethodNameSet.contains(method.getName())); + } + + /** + * 查找指定Public方法 如果找不到对应的方法或方法不为public的则返回{@code null} + * + * @param clazz 类 + * @param methodName 方法名 + * @param paramTypes 参数类型 + * @return 方法 + * @throws SecurityException 无权访问抛出异常 + */ + public static Method getPublicMethod(Class clazz, String methodName, Class... paramTypes) throws SecurityException { + try { + return clazz.getMethod(methodName, paramTypes); + } catch (NoSuchMethodException ex) { + return null; + } + } + + /** + * 查找指定对象中的所有方法（包括非public方法），也包括父对象和Object类的方法 + * + *

+ * 此方法为精准获取方法名，即方法名和参数数量和类型必须一致，否则返回{@code null}。 + *

+ * + * @param obj 被查找的对象，如果为{@code null}返回{@code null} + * @param methodName 方法名，如果为空字符串返回{@code null} + * @param args 参数 + * @return 方法 + * @throws SecurityException 无访问权限抛出异常 + */ + public static Method getMethodOfObj(Object obj, String methodName, Object... args) throws SecurityException { + if (null == obj || StrUtil.isBlank(methodName)) { + return null; + } + return getMethod(obj.getClass(), methodName, ClassUtil.getClasses(args)); + } + + /** + * 忽略大小写查找指定方法，如果找不到对应的方法则返回{@code null} + * + *

+ * 此方法为精准获取方法名，即方法名和参数数量和类型必须一致，否则返回{@code null}。 + *

+ * + * @param clazz 类，如果为{@code null}返回{@code null} + * @param methodName 方法名，如果为空字符串返回{@code null} + * @param paramTypes 参数类型，指定参数类型如果是方法的子类也算 + * @return 方法 + * @throws SecurityException 无权访问抛出异常 + * @since 3.2.0 + */ + public static Method getMethodIgnoreCase(Class clazz, String methodName, Class... paramTypes) throws SecurityException { + return getMethod(clazz, true, methodName, paramTypes); + } + + /** + * 查找指定方法 如果找不到对应的方法则返回{@code null} + * + *

+ * 此方法为精准获取方法名，即方法名和参数数量和类型必须一致，否则返回{@code null}。 + *

+ * + * @param clazz 类，如果为{@code null}返回{@code null} + * @param methodName 方法名，如果为空字符串返回{@code null} + * @param paramTypes 参数类型，指定参数类型如果是方法的子类也算 + * @return 方法 + * @throws SecurityException 无权访问抛出异常 + */ + public static Method getMethod(Class clazz, String methodName, Class... paramTypes) throws SecurityException { + return getMethod(clazz, false, methodName, paramTypes); + } + + /** + * 查找指定方法 如果找不到对应的方法则返回{@code null}
+ * 此方法为精准获取方法名，即方法名和参数数量和类型必须一致，否则返回{@code null}。
+ * 如果查找的方法有多个同参数类型重载，查找第一个找到的方法 + * + * @param clazz 类，如果为{@code null}返回{@code null} + * @param ignoreCase 是否忽略大小写 + * @param methodName 方法名，如果为空字符串返回{@code null} + * @param paramTypes 参数类型，指定参数类型如果是方法的子类也算 + * @return 方法 + * @throws SecurityException 无权访问抛出异常 + * @since 3.2.0 + */ + public static Method getMethod(Class clazz, boolean ignoreCase, String methodName, Class... paramTypes) throws SecurityException { + if (null == clazz || StrUtil.isBlank(methodName)) { + return null; + } + + Method res = null; + final Method[] methods = getMethods(clazz); + if (ArrayUtil.isNotEmpty(methods)) { + for (Method method : methods) { + if (StrUtil.equals(methodName, method.getName(), ignoreCase) + && ClassUtil.isAllAssignableFrom(method.getParameterTypes(), paramTypes) + //排除协变桥接方法，pr#1965@Github + && (res == null + || res.getReturnType().isAssignableFrom(method.getReturnType()))) { + res = method; + } + } + } + return res; + } + + /** + * 按照方法名查找指定方法名的方法，只返回匹配到的第一个方法，如果找不到对应的方法则返回{@code null} + * + *

+ * 此方法只检查方法名是否一致，并不检查参数的一致性。 + *

+ * + * @param clazz 类，如果为{@code null}返回{@code null} + * @param methodName 方法名，如果为空字符串返回{@code null} + * @return 方法 + * @throws SecurityException 无权访问抛出异常 + * @since 4.3.2 + */ + public static Method getMethodByName(Class clazz, String methodName) throws SecurityException { + return getMethodByName(clazz, false, methodName); + } + + /** + * 按照方法名查找指定方法名的方法，只返回匹配到的第一个方法，如果找不到对应的方法则返回{@code null} + * + *

+ * 此方法只检查方法名是否一致（忽略大小写），并不检查参数的一致性。 + *

+ * + * @param clazz 类，如果为{@code null}返回{@code null} + * @param methodName 方法名，如果为空字符串返回{@code null} + * @return 方法 + * @throws SecurityException 无权访问抛出异常 + * @since 4.3.2 + */ + public static Method getMethodByNameIgnoreCase(Class clazz, String methodName) throws SecurityException { + return getMethodByName(clazz, true, methodName); + } + + /** + * 按照方法名查找指定方法名的方法，只返回匹配到的第一个方法，如果找不到对应的方法则返回{@code null} + * + *

+ * 此方法只检查方法名是否一致，并不检查参数的一致性。 + *

+ * + * @param clazz 类，如果为{@code null}返回{@code null} + * @param ignoreCase 是否忽略大小写 + * @param methodName 方法名，如果为空字符串返回{@code null} + * @return 方法 + * @throws SecurityException 无权访问抛出异常 + * @since 4.3.2 + */ + public static Method getMethodByName(Class clazz, boolean ignoreCase, String methodName) throws SecurityException { + if (null == clazz || StrUtil.isBlank(methodName)) { + return null; + } + + Method res = null; + final Method[] methods = getMethods(clazz); + if (ArrayUtil.isNotEmpty(methods)) { + for (Method method : methods) { + if (StrUtil.equals(methodName, method.getName(), ignoreCase) + //排除协变桥接方法，pr#1965@Github + && (res == null + || res.getReturnType().isAssignableFrom(method.getReturnType()))) { + res = method; + } + } + } + return res; + } + + /** + * 获得指定类中的方法名
+ * 去重重载的方法 + * + * @param clazz 类 + * @return 方法名Set + * @throws SecurityException 安全异常 + */ + public static Set getMethodNames(Class clazz) throws SecurityException { + final HashSet methodSet = new HashSet<>(); + final Method[] methods = getMethods(clazz); + for (Method method : methods) { + methodSet.add(method.getName()); + } + return methodSet; + } + + /** + * 获得指定类过滤后的方法列表 + * + * @param clazz 查找方法的类 + * @param filter 过滤器 + * @return 过滤后的方法列表 + * @throws SecurityException 安全异常 + */ + public static Method[] getMethods(Class clazz, Filter filter) throws SecurityException { + if (null == clazz) { + return null; + } + return ArrayUtil.filter(getMethods(clazz), filter); + } + + /** + * 获得一个类中所有方法列表，包括其父类中的方法 + * + * @param beanClass 类，非{@code null} + * @return 方法列表 + * @throws SecurityException 安全检查异常 + */ + public static Method[] getMethods(Class beanClass) throws SecurityException { + Assert.notNull(beanClass); + return METHODS_CACHE.computeIfAbsent(beanClass, + () -> getMethodsDirectly(beanClass, true, true)); + } + + /** + * 获得一个类中所有方法列表，直接反射获取，无缓存
+ * 接口获取方法和默认方法，获取的方法包括： + *
    + *
  • 本类中的所有方法（包括static方法）
    • + *
  • 父类中的所有方法（包括static方法）
    • + *
  • Object中（包括static方法）
    • + *
+ * + * @param beanClass 类或接口 + * @param withSupers 是否包括父类或接口的方法列表 + * @param withMethodFromObject 是否包括Object中的方法 + * @return 方法列表 + * @throws SecurityException 安全检查异常 + */ + public static Method[] getMethodsDirectly(Class beanClass, boolean withSupers, boolean withMethodFromObject) throws SecurityException { + Assert.notNull(beanClass); + + if (beanClass.isInterface()) { + // 对于接口，直接调用Class.getMethods方法获取所有方法，因为接口都是public方法 + return withSupers ? beanClass.getMethods() : beanClass.getDeclaredMethods(); + } + + final UniqueKeySet result = new UniqueKeySet<>(true, ReflectUtil::getUniqueKey); + Class searchType = beanClass; + while (searchType != null) { + if (false == withMethodFromObject && Object.class == searchType) { + break; + } + result.addAllIfAbsent(Arrays.asList(searchType.getDeclaredMethods())); + result.addAllIfAbsent(getDefaultMethodsFromInterface(searchType)); + + + searchType = (withSupers && false == searchType.isInterface()) ? searchType.getSuperclass() : null; + } + + return result.toArray(new Method[0]); + } + + /** + * 是否为equals方法 + * + * @param method 方法 + * @return 是否为equals方法 + */ + public static boolean isEqualsMethod(Method method) { + if (method == null || + 1 != method.getParameterCount() || + false == "equals".equals(method.getName())) { + return false; + } + return (method.getParameterTypes()[0] == Object.class); + } + + /** + * 是否为hashCode方法 + * + * @param method 方法 + * @return 是否为hashCode方法 + */ + public static boolean isHashCodeMethod(Method method) { + return method != null// + && "hashCode".equals(method.getName())// + && isEmptyParam(method); + } + + /** + * 是否为toString方法 + * + * @param method 方法 + * @return 是否为toString方法 + */ + public static boolean isToStringMethod(Method method) { + return method != null// + && "toString".equals(method.getName())// + && isEmptyParam(method); + } + + /** + * 是否为无参数方法 + * + * @param method 方法 + * @return 是否为无参数方法 + * @since 5.1.1 + */ + public static boolean isEmptyParam(Method method) { + return method.getParameterCount() == 0; + } + + /** + * 检查给定方法是否为Getter或者Setter方法，规则为：
+ *
    + *
  • 方法参数必须为0个或1个
    • + *
  • 如果是无参方法，则判断是否以“get”或“is”开头
    • + *
  • 如果方法参数1个，则判断是否以“set”开头
    • + *
+ * + * @param method 方法 + * @return 是否为Getter或者Setter方法 + * @since 5.7.20 + */ + public static boolean isGetterOrSetterIgnoreCase(Method method) { + return isGetterOrSetter(method, true); + } + + /** + * 检查给定方法是否为Getter或者Setter方法，规则为：
+ *
    + *
  • 方法参数必须为0个或1个
    • + *
  • 方法名称不能是getClass
    • + *
  • 如果是无参方法，则判断是否以“get”或“is”开头
    • + *
  • 如果方法参数1个，则判断是否以“set”开头
    • + *
+ * + * @param method 方法 + * @param ignoreCase 是否忽略方法名的大小写 + * @return 是否为Getter或者Setter方法 + * @since 5.7.20 + */ + public static boolean isGetterOrSetter(Method method, boolean ignoreCase) { + if (null == method) { + return false; + } + + // 参数个数必须为0或1 + final int parameterCount = method.getParameterCount(); + if (parameterCount > 1) { + return false; + } + + String name = method.getName(); + // 跳过getClass这个特殊方法 + if ("getClass".equals(name)) { + return false; + } + if (ignoreCase) { + name = name.toLowerCase(); + } + switch (parameterCount) { + case 0: + return name.startsWith("get") || name.startsWith("is"); + case 1: + return name.startsWith("set"); + default: + return false; + } + } + // --------------------------------------------------------------------------------------------------------- newInstance + + /** + * 实例化对象 + * + * @param 对象类型 + * @param clazz 类名 + * @return 对象 + * @throws UtilException 包装各类异常 + */ + @SuppressWarnings("unchecked") + public static T newInstance(String clazz) throws UtilException { + try { + return (T) Class.forName(clazz).newInstance(); + } catch (Exception e) { + throw new UtilException(e, "Instance class [{}] error!", clazz); + } + } + + /** + * 实例化对象 + * + * @param 对象类型 + * @param clazz 类 + * @param params 构造函数参数 + * @return 对象 + * @throws UtilException 包装各类异常 + */ + public static T newInstance(Class clazz, Object... params) throws UtilException { + if (ArrayUtil.isEmpty(params)) { + final Constructor constructor = getConstructor(clazz); + if (null == constructor) { + throw new UtilException("No constructor for [{}]", clazz); + } + try { + return constructor.newInstance(); + } catch (Exception e) { + throw new UtilException(e, "Instance class [{}] error!", clazz); + } + } + + final Class[] paramTypes = ClassUtil.getClasses(params); + final Constructor constructor = getConstructor(clazz, paramTypes); + if (null == constructor) { + throw new UtilException("No Constructor matched for parameter types: [{}]", new Object[]{paramTypes}); + } + try { + return constructor.newInstance(params); + } catch (Exception e) { + throw new UtilException(e, "Instance class [{}] error!", clazz); + } + } + + /** + * 尝试遍历并调用此类的所有构造方法，直到构造成功并返回 + *

+ * 对于某些特殊的接口，按照其默认实现实例化，例如： + * 

+	 *     Map       -》 HashMap
+	 *     Collction -》 ArrayList
+	 *     List      -》 ArrayList
+	 *     Set       -》 HashSet
+	 *
+ * + * @param 对象类型 + * @param type 被构造的类 + * @return 构造后的对象，构造失败返回{@code null} + */ + @SuppressWarnings("unchecked") + public static T newInstanceIfPossible(Class type) { + Assert.notNull(type); + + // 原始类型 + if (type.isPrimitive()) { + return (T) ClassUtil.getPrimitiveDefaultValue(type); + } + + // 某些特殊接口的实例化按照默认实现进行 + if (type.isAssignableFrom(AbstractMap.class)) { + type = (Class) HashMap.class; + } else if (type.isAssignableFrom(List.class)) { + type = (Class) ArrayList.class; + } else if (type.isAssignableFrom(Set.class)) { + type = (Class) HashSet.class; + } + + try { + return newInstance(type); + } catch (Exception e) { + // ignore + // 默认构造不存在的情况下查找其它构造 + } + + // 枚举 + if (type.isEnum()) { + return type.getEnumConstants()[0]; + } + + // 数组 + if (type.isArray()) { + return (T) Array.newInstance(type.getComponentType(), 0); + } + + final Constructor[] constructors = getConstructors(type); + Class[] parameterTypes; + for (Constructor constructor : constructors) { + parameterTypes = constructor.getParameterTypes(); + if (0 == parameterTypes.length) { + continue; + } + setAccessible(constructor); + try { + return constructor.newInstance(ClassUtil.getDefaultValues(parameterTypes)); + } catch (Exception ignore) { + // 构造出错时继续尝试下一种构造方式 + } + } + return null; + } + + // --------------------------------------------------------------------------------------------------------- invoke + + /** + * 执行静态方法 + * + * @param 对象类型 + * @param method 方法（对象方法或static方法都可） + * @param args 参数对象 + * @return 结果 + * @throws UtilException 多种异常包装 + */ + public static T invokeStatic(Method method, Object... args) throws UtilException { + return invoke(null, method, args); + } + + /** + * 执行方法
+ * 执行前要检查给定参数： + * + * 
+	 * 1. 参数个数是否与方法参数个数一致
+	 * 2. 如果某个参数为null但是方法这个位置的参数为原始类型，则赋予原始类型默认值
+	 *
+ * + * @param 返回对象类型 + * @param obj 对象，如果执行静态方法，此值为{@code null} + * @param method 方法（对象方法或static方法都可） + * @param args 参数对象 + * @return 结果 + * @throws UtilException 一些列异常的包装 + */ + public static T invokeWithCheck(Object obj, Method method, Object... args) throws UtilException { + final Class[] types = method.getParameterTypes(); + if (null != args) { + Assert.isTrue(args.length == types.length, "Params length [{}] is not fit for param length [{}] of method !", args.length, types.length); + Class type; + for (int i = 0; i < args.length; i++) { + type = types[i]; + if (type.isPrimitive() && null == args[i]) { + // 参数是原始类型，而传入参数为null时赋予默认值 + args[i] = ClassUtil.getDefaultValue(type); + } + } + } + + return invoke(obj, method, args); + } + + /** + * 执行方法 + * + *

+ * 对于用户传入参数会做必要检查，包括： + * + * 

+	 *     1、忽略多余的参数
+	 *     2、参数不够补齐默认值
+	 *     3、传入参数为null，但是目标参数类型为原始类型，做转换
+	 *
+ * + * @param 返回对象类型 + * @param obj 对象，如果执行静态方法，此值为{@code null} + * @param method 方法（对象方法或static方法都可） + * @param args 参数对象 + * @return 结果 + * @throws InvocationTargetRuntimeException 目标方法执行异常 + * @throws UtilException {@link IllegalAccessException}异常的包装 + */ + public static T invoke(Object obj, Method method, Object... args) throws InvocationTargetRuntimeException, UtilException { + try { + return invokeRaw(obj, method, args); + } catch (InvocationTargetException e) { + throw new InvocationTargetRuntimeException(e); + } catch (IllegalAccessException e) { + throw new UtilException(e); + } + } + + /** + * 执行方法 + * + *

+ * 对于用户传入参数会做必要检查，包括： + * + * 

+	 *     1、忽略多余的参数
+	 *     2、参数不够补齐默认值
+	 *     3、传入参数为null，但是目标参数类型为原始类型，做转换
+	 *
+ * + * @param 返回对象类型 + * @param obj 对象，如果执行静态方法，此值为{@code null} + * @param method 方法（对象方法或static方法都可） + * @param args 参数对象 + * @return 结果 + * @throws InvocationTargetException 目标方法执行异常 + * @throws IllegalAccessException 访问异常 + * @since 5.8.1 + */ + @SuppressWarnings("unchecked") + public static T invokeRaw(Object obj, Method method, Object... args) throws InvocationTargetException, IllegalAccessException { + setAccessible(method); + + // 检查用户传入参数： + // 1、忽略多余的参数 + // 2、参数不够补齐默认值 + // 3、通过NullWrapperBean传递的参数,会直接赋值null + // 4、传入参数为null，但是目标参数类型为原始类型，做转换 + // 5、传入参数类型不对应，尝试转换类型 + final Class[] parameterTypes = method.getParameterTypes(); + final Object[] actualArgs = new Object[parameterTypes.length]; + if (null != args) { + for (int i = 0; i < actualArgs.length; i++) { + if (i >= args.length || null == args[i]) { + // 越界或者空值 + actualArgs[i] = ClassUtil.getDefaultValue(parameterTypes[i]); + } else if (args[i] instanceof NullWrapperBean) { + //如果是通过NullWrapperBean传递的null参数,直接赋值null + actualArgs[i] = null; + } else if (false == parameterTypes[i].isAssignableFrom(args[i].getClass())) { + //对于类型不同的字段，尝试转换，转换失败则使用原对象类型 + final Object targetValue = Convert.convertQuietly(parameterTypes[i], args[i], args[i]); + if (null != targetValue) { + actualArgs[i] = targetValue; + } + } else { + actualArgs[i] = args[i]; + } + } + } + + if (method.isDefault()) { + // 当方法是default方法时，尤其对象是代理对象，需使用句柄方式执行 + // 代理对象情况下调用method.invoke会导致循环引用执行，最终栈溢出 + return MethodHandleUtil.invokeSpecial(obj, method, args); + } + + return (T) method.invoke(ClassUtil.isStatic(method) ? null : obj, actualArgs); + } + + /** + * 执行对象中指定方法 + * 如果需要传递的参数为null,请使用NullWrapperBean来传递,不然会丢失类型信息 + * + * @param 返回对象类型 + * @param obj 方法所在对象 + * @param methodName 方法名 + * @param args 参数列表 + * @return 执行结果 + * @throws UtilException IllegalAccessException等异常包装 + * @see NullWrapperBean + * @since 3.1.2 + */ + public static T invoke(Object obj, String methodName, Object... args) throws UtilException { + Assert.notNull(obj, "Object to get method must be not null!"); + Assert.notBlank(methodName, "Method name must be not blank!"); + + final Method method = getMethodOfObj(obj, methodName, args); + if (null == method) { + throw new UtilException("No such method: [{}] from [{}]", methodName, obj.getClass()); + } + return invoke(obj, method, args); + } + + /** + * 设置方法为可访问（私有方法可以被外部调用） + * + * @param AccessibleObject的子类，比如Class、Method、Field等 + * @param accessibleObject 可设置访问权限的对象，比如Class、Method、Field等 + * @return 被设置可访问的对象 + * @since 4.6.8 + */ + public static T setAccessible(T accessibleObject) { + if (null != accessibleObject && false == accessibleObject.isAccessible()) { + accessibleObject.setAccessible(true); + } + return accessibleObject; + } + + /** + * 设置final的field字段可以被修改 + * 只要不会被编译器内联优化的 final 属性就可以通过反射有效的进行修改 -- 修改后代码中可使用到新的值; + *

以下属性，编译器会内联优化，无法通过反射修改：

+ *
    + *
  • 基本类型 byte, char, short, int, long, float, double, boolean
    • + *
  • Literal String 类型(直接双引号字符串)
    • + *
+ *

以下属性，可以通过反射修改：

+ *
    + *
  • 基本类型的包装类 Byte、Character、Short、Long、Float、Double、Boolean
    • + *
  • 字符串，通过 new String("")实例化
    • + *
  • 自定义java类
    • + *
+ * 
+	 * {@code
+	 *      //示例，移除final修饰符
+	 *      class JdbcDialects {private static final List dialects = new ArrayList<>();}
+	 *      Field field = ReflectUtil.getField(JdbcDialects.class, fieldName);
+	 * 		ReflectUtil.removeFinalModify(field);
+	 * 		ReflectUtil.setFieldValue(JdbcDialects.class, fieldName, dialects);
+	 *    }
+	 *
+ * + * @param field 被修改的field，不可以为空 + * @throws UtilException IllegalAccessException等异常包装 + * @author dazer + * @since 5.8.8 + */ + public static void removeFinalModify(Field field) { + ModifierUtil.removeFinalModify(field); + } + + /** + * 获取方法的唯一键，结构为: + * 
+	 *     返回类型#方法名:参数1类型,参数2类型...
+	 *
+ * + * @param method 方法 + * @return 方法唯一键 + */ + private static String getUniqueKey(Method method) { + final StringBuilder sb = new StringBuilder(); + sb.append(method.getReturnType().getName()).append('#'); + sb.append(method.getName()); + Class[] parameters = method.getParameterTypes(); + for (int i = 0; i < parameters.length; i++) { + if (i == 0) { + sb.append(':'); + } else { + sb.append(','); + } + sb.append(parameters[i].getName()); + } + return sb.toString(); + } + + /** + * 获取类对应接口中的非抽象方法（default方法） + * + * @param clazz 类 + * @return 方法列表 + */ + private static List getDefaultMethodsFromInterface(Class clazz) { + List result = new ArrayList<>(); + for (Class ifc : clazz.getInterfaces()) { + for (Method m : ifc.getMethods()) { + if (false == ModifierUtil.isAbstract(m)) { + result.add(m); + } + } + } + return result; + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/RuntimeUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/RuntimeUtil.java new file mode 100755 index 0000000..87faa5a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/RuntimeUtil.java @@ -0,0 +1,382 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Pid; +import aiyh.utils.tool.cn.hutool.core.text.StrBuilder; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.Charset; +import java.util.ArrayList; +import java.util.List; +import java.util.Stack; +import java.util.concurrent.ThreadPoolExecutor; + +/** + * 系统运行时工具类，用于执行系统命令的工具 + * + * @author Looly + * @since 3.1.1 + */ +public class RuntimeUtil { + + /** + * 执行系统命令，使用系统默认编码 + * + * @param cmds 命令列表，每个元素代表一条命令 + * @return 执行结果 + * @throws IORuntimeException IO异常 + */ + public static String execForStr(String... cmds) throws IORuntimeException { + return execForStr(CharsetUtil.systemCharset(), cmds); + } + + /** + * 执行系统命令，使用传入的 {@link Charset charset} 编码 + * + * @param charset 编码 + * @param cmds 命令列表，每个元素代表一条命令 + * @return 执行结果 + * @throws IORuntimeException IO异常 + * @since 3.1.2 + */ + public static String execForStr(Charset charset, String... cmds) throws IORuntimeException { + return getResult(exec(cmds), charset); + } + + /** + * 执行系统命令，使用系统默认编码 + * + * @param cmds 命令列表，每个元素代表一条命令 + * @return 执行结果，按行区分 + * @throws IORuntimeException IO异常 + */ + public static List execForLines(String... cmds) throws IORuntimeException { + return execForLines(CharsetUtil.systemCharset(), cmds); + } + + /** + * 执行系统命令，使用传入的 {@link Charset charset} 编码 + * + * @param charset 编码 + * @param cmds 命令列表，每个元素代表一条命令 + * @return 执行结果，按行区分 + * @throws IORuntimeException IO异常 + * @since 3.1.2 + */ + public static List execForLines(Charset charset, String... cmds) throws IORuntimeException { + return getResultLines(exec(cmds), charset); + } + + /** + * 执行命令
+ * 命令带参数时参数可作为其中一个参数，也可以将命令和参数组合为一个字符串传入 + * + * @param cmds 命令 + * @return {@link Process} + */ + public static Process exec(String... cmds) { + Process process; + try { + process = new ProcessBuilder(handleCmds(cmds)).redirectErrorStream(true).start(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + return process; + } + + /** + * 执行命令
+ * 命令带参数时参数可作为其中一个参数，也可以将命令和参数组合为一个字符串传入 + * + * @param envp 环境变量参数，传入形式为key=value，null表示继承系统环境变量 + * @param cmds 命令 + * @return {@link Process} + * @since 4.1.6 + */ + public static Process exec(String[] envp, String... cmds) { + return exec(envp, null, cmds); + } + + /** + * 执行命令
+ * 命令带参数时参数可作为其中一个参数，也可以将命令和参数组合为一个字符串传入 + * + * @param envp 环境变量参数，传入形式为key=value，null表示继承系统环境变量 + * @param dir 执行命令所在目录（用于相对路径命令执行），null表示使用当前进程执行的目录 + * @param cmds 命令 + * @return {@link Process} + * @since 4.1.6 + */ + public static Process exec(String[] envp, File dir, String... cmds) { + try { + return Runtime.getRuntime().exec(handleCmds(cmds), envp, dir); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + // -------------------------------------------------------------------------------------------------- result + + /** + * 获取命令执行结果，使用系统默认编码，获取后销毁进程 + * + * @param process {@link Process} 进程 + * @return 命令执行结果列表 + */ + public static List getResultLines(Process process) { + return getResultLines(process, CharsetUtil.systemCharset()); + } + + /** + * 获取命令执行结果，使用传入的 {@link Charset charset} 编码，获取后销毁进程 + * + * @param process {@link Process} 进程 + * @param charset 编码 + * @return 命令执行结果列表 + * @since 3.1.2 + */ + public static List getResultLines(Process process, Charset charset) { + InputStream in = null; + try { + in = process.getInputStream(); + return IoUtil.readLines(in, charset, new ArrayList<>()); + } finally { + IoUtil.close(in); + destroy(process); + } + } + + /** + * 获取命令执行结果，使用系统默认编码，获取后销毁进程 + * + * @param process {@link Process} 进程 + * @return 命令执行结果列表 + * @since 3.1.2 + */ + public static String getResult(Process process) { + return getResult(process, CharsetUtil.systemCharset()); + } + + /** + * 获取命令执行结果，获取后销毁进程 + * + * @param process {@link Process} 进程 + * @param charset 编码 + * @return 命令执行结果列表 + * @since 3.1.2 + */ + public static String getResult(Process process, Charset charset) { + InputStream in = null; + try { + in = process.getInputStream(); + return IoUtil.read(in, charset); + } finally { + IoUtil.close(in); + destroy(process); + } + } + + /** + * 获取命令执行异常结果，使用系统默认编码，获取后销毁进程 + * + * @param process {@link Process} 进程 + * @return 命令执行结果列表 + * @since 4.1.21 + */ + public static String getErrorResult(Process process) { + return getErrorResult(process, CharsetUtil.systemCharset()); + } + + /** + * 获取命令执行异常结果，获取后销毁进程 + * + * @param process {@link Process} 进程 + * @param charset 编码 + * @return 命令执行结果列表 + * @since 4.1.21 + */ + public static String getErrorResult(Process process, Charset charset) { + InputStream in = null; + try { + in = process.getErrorStream(); + return IoUtil.read(in, charset); + } finally { + IoUtil.close(in); + destroy(process); + } + } + + /** + * 销毁进程 + * + * @param process 进程 + * @since 3.1.2 + */ + public static void destroy(Process process) { + if (null != process) { + process.destroy(); + } + } + + /** + * 增加一个JVM关闭后的钩子，用于在JVM关闭时执行某些操作 + * + * @param hook 钩子 + * @since 4.0.5 + */ + public static void addShutdownHook(Runnable hook) { + Runtime.getRuntime().addShutdownHook((hook instanceof Thread) ? (Thread) hook : new Thread(hook)); + } + + /** + * 获得JVM可用的处理器数量（一般为CPU核心数） + * + *

+ * 这里做一个特殊的处理,在特殊的CPU上面，会有获取不到CPU数量的情况，所以这里做一个保护; + * 默认给一个7，真实的CPU基本都是偶数，方便区分。 + * 如果不做处理，会出现创建线程池时{@link ThreadPoolExecutor}，抛出异常：{@link IllegalArgumentException} + *

+ * + * @return 可用的处理器数量 + * @since 5.3.0 + */ + public static int getProcessorCount() { + int cpu = Runtime.getRuntime().availableProcessors(); + if (cpu <= 0) { + cpu = 7; + } + return cpu; + } + + /** + * 获得JVM中剩余的内存数，单位byte + * + * @return JVM中剩余的内存数，单位byte + * @since 5.3.0 + */ + public static long getFreeMemory() { + return Runtime.getRuntime().freeMemory(); + } + + /** + * 获得JVM已经从系统中获取到的总共的内存数，单位byte + * + * @return JVM中剩余的内存数，单位byte + * @since 5.3.0 + */ + public static long getTotalMemory() { + return Runtime.getRuntime().totalMemory(); + } + + /** + * 获得JVM中可以从系统中获取的最大的内存数，单位byte，以-Xmx参数为准 + * + * @return JVM中剩余的内存数，单位byte + * @since 5.3.0 + */ + public static long getMaxMemory() { + return Runtime.getRuntime().maxMemory(); + } + + /** + * 获得JVM最大可用内存，计算方法为：
+ * 最大内存-总内存+剩余内存 + * + * @return 最大可用内存 + */ + public static long getUsableMemory() { + return getMaxMemory() - getTotalMemory() + getFreeMemory(); + } + + /** + * 获取当前进程ID，首先获取进程名称，读取@前的ID值，如果不存在，则读取进程名的hash值 + * + * @return 进程ID + * @throws UtilException 进程名称为空 + * @since 5.7.3 + */ + public static int getPid() throws UtilException { + return Pid.INSTANCE.get(); + } + + /** + * 处理命令，多行命令原样返回，单行命令拆分处理 + * + * @param cmds 命令 + * @return 处理后的命令 + */ + private static String[] handleCmds(String... cmds) { + if (ArrayUtil.isEmpty(cmds)) { + throw new NullPointerException("Command is empty !"); + } + + // 单条命令的情况 + if (1 == cmds.length) { + final String cmd = cmds[0]; + if (StrUtil.isBlank(cmd)) { + throw new NullPointerException("Command is blank !"); + } + cmds = cmdSplit(cmd); + } + return cmds; + } + + /** + * 命令分割，使用空格分割，考虑双引号和单引号的情况 + * + * @param cmd 命令，如 git commit -m 'test commit' + * @return 分割后的命令 + */ + private static String[] cmdSplit(String cmd) { + final List cmds = new ArrayList<>(); + + final int length = cmd.length(); + final Stack stack = new Stack<>(); + boolean inWrap = false; + final StrBuilder cache = StrUtil.strBuilder(); + + char c; + for (int i = 0; i < length; i++) { + c = cmd.charAt(i); + switch (c) { + case CharUtil.SINGLE_QUOTE: + case CharUtil.DOUBLE_QUOTES: + if (inWrap) { + if (c == stack.peek()) { + //结束包装 + stack.pop(); + inWrap = false; + } + cache.append(c); + } else { + stack.push(c); + cache.append(c); + inWrap = true; + } + break; + case CharUtil.SPACE: + if (inWrap) { + // 处于包装内 + cache.append(c); + } else { + cmds.add(cache.toString()); + cache.reset(); + } + break; + default: + cache.append(c); + break; + } + } + + if (cache.hasContent()) { + cmds.add(cache.toString()); + } + + return cmds.toArray(new String[0]); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/SerializeUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/SerializeUtil.java new file mode 100644 index 0000000..f1025c7 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/SerializeUtil.java @@ -0,0 +1,67 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.io.FastByteArrayOutputStream; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; + +import java.io.ByteArrayInputStream; +import java.io.Serializable; + +/** + * 序列化工具类
+ * 注意！此工具类依赖于JDK的序列化机制，某些版本的JDK中可能存在远程注入漏洞。 + * + * @author looly + * @since 5.6.3 + */ +public class SerializeUtil { + + /** + * 序列化后拷贝流的方式克隆
+ * 对象必须实现Serializable接口 + * + * @param 对象类型 + * @param obj 被克隆对象 + * @return 克隆后的对象 + * @throws UtilException IO异常和ClassNotFoundException封装 + */ + public static T clone(T obj) { + if (false == (obj instanceof Serializable)) { + return null; + } + return deserialize(serialize(obj)); + } + + /** + * 序列化
+ * 对象必须实现Serializable接口 + * + * @param 对象类型 + * @param obj 要被序列化的对象 + * @return 序列化后的字节码 + */ + public static byte[] serialize(T obj) { + if (false == (obj instanceof Serializable)) { + return null; + } + final FastByteArrayOutputStream byteOut = new FastByteArrayOutputStream(); + IoUtil.writeObjects(byteOut, false, (Serializable) obj); + return byteOut.toByteArray(); + } + + /** + * 反序列化
+ * 对象必须实现Serializable接口 + * + *

+ * 注意！！！ 此方法不会检查反序列化安全，可能存在反序列化漏洞风险！！！ + *

+ * + * @param 对象类型 + * @param bytes 反序列化的字节码 + * @return 反序列化后的对象 + */ + public static T deserialize(byte[] bytes) { + return IoUtil.readObj(new ByteArrayInputStream(bytes)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ServiceLoaderUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ServiceLoaderUtil.java new file mode 100644 index 0000000..80e88c2 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ServiceLoaderUtil.java @@ -0,0 +1,106 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.collection.ListUtil; + +import java.util.Iterator; +import java.util.List; +import java.util.ServiceConfigurationError; +import java.util.ServiceLoader; + +/** + * SPI机制中的服务加载工具类，流程如下 + * + * 
+ *     1、创建接口，并创建实现类
+ *     2、ClassPath/META-INF/services下创建与接口全限定类名相同的文件
+ *     3、文件内容填写实现类的全限定类名
+ *
+ * 相关介绍见：https://www.jianshu.com/p/3a3edbcd8f24 + * + * @author looly + * @since 5.1.6 + */ +public class ServiceLoaderUtil { + + /** + * 。加载第一个可用服务，如果用户定义了多个接口实现类，只获取第一个不报错的服务 + * + * @param 接口类型 + * @param clazz 服务接口 + * @return 第一个服务接口实现对象，无实现返回{@code null} + */ + public static T loadFirstAvailable(Class clazz) { + final Iterator iterator = load(clazz).iterator(); + while (iterator.hasNext()) { + try { + return iterator.next(); + } catch (ServiceConfigurationError ignore) { + // ignore + } + } + return null; + } + + /** + * 加载第一个服务，如果用户定义了多个接口实现类，只获取第一个。 + * + * @param 接口类型 + * @param clazz 服务接口 + * @return 第一个服务接口实现对象，无实现返回{@code null} + */ + public static T loadFirst(Class clazz) { + final Iterator iterator = load(clazz).iterator(); + if (iterator.hasNext()) { + return iterator.next(); + } + return null; + } + + /** + * 加载服务 + * + * @param 接口类型 + * @param clazz 服务接口 + * @return 服务接口实现列表 + */ + public static ServiceLoader load(Class clazz) { + return load(clazz, null); + } + + /** + * 加载服务 + * + * @param 接口类型 + * @param clazz 服务接口 + * @param loader {@link ClassLoader} + * @return 服务接口实现列表 + */ + public static ServiceLoader load(Class clazz, ClassLoader loader) { + return ServiceLoader.load(clazz, ObjectUtil.defaultIfNull(loader, ClassLoaderUtil::getClassLoader)); + } + + /** + * 加载服务 并已list列表返回 + * + * @param 接口类型 + * @param clazz 服务接口 + * @return 服务接口实现列表 + * @since 5.4.2 + */ + public static List loadList(Class clazz) { + return loadList(clazz, null); + } + + /** + * 加载服务 并已list列表返回 + * + * @param 接口类型 + * @param clazz 服务接口 + * @param loader {@link ClassLoader} + * @return 服务接口实现列表 + * @since 5.4.2 + */ + public static List loadList(Class clazz, ClassLoader loader) { + return ListUtil.list(false, load(clazz, loader)); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/StrUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/StrUtil.java new file mode 100755 index 0000000..1fb944a --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/StrUtil.java @@ -0,0 +1,471 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.text.CharSequenceUtil; +import aiyh.utils.tool.cn.hutool.core.text.StrBuilder; +import aiyh.utils.tool.cn.hutool.core.text.StrFormatter; +import aiyh.utils.tool.cn.hutool.core.text.StrPool; +import aiyh.utils.tool.cn.hutool.core.text.TextSimilarity; + +import java.io.StringReader; +import java.io.StringWriter; +import java.nio.ByteBuffer; +import java.nio.charset.Charset; +import java.util.Map; + +/** + * 字符串工具类 + * + * @author xiaoleilu + */ +public class StrUtil extends CharSequenceUtil implements StrPool { + + // ------------------------------------------------------------------------ Blank + + /** + *

如果对象是字符串是否为空白，空白的定义如下：

+ *
    + *
  1. {@code null}
    2. + *
  2. 空字符串：{@code ""}
    3. + *
  3. 空格、全角空格、制表符、换行符，等不可见字符
    4. + *
+ * + *

例：

+ *
    + *
  • {@code StrUtil.isBlankIfStr(null) // true}
    • + *
  • {@code StrUtil.isBlankIfStr("") // true}
    • + *
  • {@code StrUtil.isBlankIfStr(" \t\n") // true}
    • + *
  • {@code StrUtil.isBlankIfStr("abc") // false}
    • + *
+ * + *

注意：该方法与 {@link #isEmptyIfStr(Object)} 的区别是： + * 该方法会校验空白字符，且性能相对于 {@link #isEmptyIfStr(Object)} 略慢。

+ * + * @param obj 对象 + * @return 如果为字符串是否为空串 + * @see StrUtil#isBlank(CharSequence) + * @since 3.3.0 + */ + public static boolean isBlankIfStr(Object obj) { + if (null == obj) { + return true; + } else if (obj instanceof CharSequence) { + return isBlank((CharSequence) obj); + } + return false; + } + // ------------------------------------------------------------------------ Empty + + /** + *

如果对象是字符串是否为空串，空的定义如下：


+ *
    + *
  1. {@code null}
    2. + *
  2. 空字符串：{@code ""}
    3. + *
+ * + *

例：

+ *
    + *
  • {@code StrUtil.isEmptyIfStr(null) // true}
    • + *
  • {@code StrUtil.isEmptyIfStr("") // true}
    • + *
  • {@code StrUtil.isEmptyIfStr(" \t\n") // false}
    • + *
  • {@code StrUtil.isEmptyIfStr("abc") // false}
    • + *
+ * + *

注意：该方法与 {@link #isBlankIfStr(Object)} 的区别是：该方法不校验空白字符。

+ * + * @param obj 对象 + * @return 如果为字符串是否为空串 + * @since 3.3.0 + */ + public static boolean isEmptyIfStr(Object obj) { + if (null == obj) { + return true; + } else if (obj instanceof CharSequence) { + return 0 == ((CharSequence) obj).length(); + } + return false; + } + + // ------------------------------------------------------------------------ Trim + + /** + * 给定字符串数组全部做去首尾空格 + * + * @param strs 字符串数组 + */ + public static void trim(String[] strs) { + if (null == strs) { + return; + } + String str; + for (int i = 0; i < strs.length; i++) { + str = strs[i]; + if (null != str) { + strs[i] = trim(str); + } + } + } + + /** + * 将对象转为字符串
+ * + * 
+	 * 1、Byte数组和ByteBuffer会被转换为对应字符串的数组
+	 * 2、对象数组会调用Arrays.toString方法
+	 *
+ * + * @param obj 对象 + * @return 字符串 + */ + public static String utf8Str(Object obj) { + return str(obj, CharsetUtil.CHARSET_UTF_8); + } + + /** + * 将对象转为字符串 + * + * 
+	 * 1、Byte数组和ByteBuffer会被转换为对应字符串的数组
+	 * 2、对象数组会调用Arrays.toString方法
+	 *
+ * + * @param obj 对象 + * @param charsetName 字符集 + * @return 字符串 + * @deprecated 请使用 {@link #str(Object, Charset)} + */ + @Deprecated + public static String str(Object obj, String charsetName) { + return str(obj, Charset.forName(charsetName)); + } + + /** + * 将对象转为字符串 + * 
+	 * 	 1、Byte数组和ByteBuffer会被转换为对应字符串的数组
+	 * 	 2、对象数组会调用Arrays.toString方法
+	 *
+ * + * @param obj 对象 + * @param charset 字符集 + * @return 字符串 + */ + public static String str(Object obj, Charset charset) { + if (null == obj) { + return null; + } + + if (obj instanceof String) { + return (String) obj; + } else if (obj instanceof byte[]) { + return str((byte[]) obj, charset); + } else if (obj instanceof Byte[]) { + return str((Byte[]) obj, charset); + } else if (obj instanceof ByteBuffer) { + return str((ByteBuffer) obj, charset); + } else if (ArrayUtil.isArray(obj)) { + return ArrayUtil.toString(obj); + } + + return obj.toString(); + } + + /** + * 将byte数组转为字符串 + * + * @param bytes byte数组 + * @param charset 字符集 + * @return 字符串 + */ + public static String str(byte[] bytes, String charset) { + return str(bytes, CharsetUtil.charset(charset)); + } + + /** + * 解码字节码 + * + * @param data 字符串 + * @param charset 字符集，如果此字段为空，则解码的结果取决于平台 + * @return 解码后的字符串 + */ + public static String str(byte[] data, Charset charset) { + if (data == null) { + return null; + } + + if (null == charset) { + return new String(data); + } + return new String(data, charset); + } + + /** + * 将Byte数组转为字符串 + * + * @param bytes byte数组 + * @param charset 字符集 + * @return 字符串 + */ + public static String str(Byte[] bytes, String charset) { + return str(bytes, CharsetUtil.charset(charset)); + } + + /** + * 解码字节码 + * + * @param data 字符串 + * @param charset 字符集，如果此字段为空，则解码的结果取决于平台 + * @return 解码后的字符串 + */ + public static String str(Byte[] data, Charset charset) { + if (data == null) { + return null; + } + + byte[] bytes = new byte[data.length]; + Byte dataByte; + for (int i = 0; i < data.length; i++) { + dataByte = data[i]; + bytes[i] = (null == dataByte) ? -1 : dataByte; + } + + return str(bytes, charset); + } + + /** + * 将编码的byteBuffer数据转换为字符串 + * + * @param data 数据 + * @param charset 字符集，如果为空使用当前系统字符集 + * @return 字符串 + */ + public static String str(ByteBuffer data, String charset) { + if (data == null) { + return null; + } + + return str(data, CharsetUtil.charset(charset)); + } + + /** + * 将编码的byteBuffer数据转换为字符串 + * + * @param data 数据 + * @param charset 字符集，如果为空使用当前系统字符集 + * @return 字符串 + */ + public static String str(ByteBuffer data, Charset charset) { + if (null == charset) { + charset = Charset.defaultCharset(); + } + return charset.decode(data).toString(); + } + + /** + * 调用对象的toString方法，null会返回“null” + * + * @param obj 对象 + * @return 字符串 + * @since 4.1.3 + * @see String#valueOf(Object) + */ + public static String toString(Object obj) { + return String.valueOf(obj); + } + + /** + * 调用对象的toString方法，null会返回{@code null} + * + * @param obj 对象 + * @return 字符串 or {@code null} + * @since 5.7.17 + */ + public static String toStringOrNull(Object obj) { + return null == obj ? null : obj.toString(); + } + + /** + * 创建StringBuilder对象 + * + * @return StringBuilder对象 + */ + public static StringBuilder builder() { + return new StringBuilder(); + } + + /** + * 创建StrBuilder对象 + * + * @return StrBuilder对象 + * @since 4.0.1 + */ + public static StrBuilder strBuilder() { + return StrBuilder.create(); + } + + /** + * 创建StringBuilder对象 + * + * @param capacity 初始大小 + * @return StringBuilder对象 + */ + public static StringBuilder builder(int capacity) { + return new StringBuilder(capacity); + } + + /** + * 创建StrBuilder对象 + * + * @param capacity 初始大小 + * @return StrBuilder对象 + * @since 4.0.1 + */ + public static StrBuilder strBuilder(int capacity) { + return StrBuilder.create(capacity); + } + + /** + * 获得StringReader + * + * @param str 字符串 + * @return StringReader + */ + public static StringReader getReader(CharSequence str) { + if (null == str) { + return null; + } + return new StringReader(str.toString()); + } + + /** + * 获得StringWriter + * + * @return StringWriter + */ + public static StringWriter getWriter() { + return new StringWriter(); + } + + /** + * 反转字符串
+ * 例如：abcd =》dcba + * + * @param str 被反转的字符串 + * @return 反转后的字符串 + * @since 3.0.9 + */ + public static String reverse(String str) { + return new String(ArrayUtil.reverse(str.toCharArray())); + } + + // ------------------------------------------------------------------------ fill + + /** + * 将已有字符串填充为规定长度，如果已有字符串超过这个长度则返回这个字符串
+ * 字符填充于字符串前 + * + * @param str 被填充的字符串 + * @param filledChar 填充的字符 + * @param len 填充长度 + * @return 填充后的字符串 + * @since 3.1.2 + */ + public static String fillBefore(String str, char filledChar, int len) { + return fill(str, filledChar, len, true); + } + + /** + * 将已有字符串填充为规定长度，如果已有字符串超过这个长度则返回这个字符串
+ * 字符填充于字符串后 + * + * @param str 被填充的字符串 + * @param filledChar 填充的字符 + * @param len 填充长度 + * @return 填充后的字符串 + * @since 3.1.2 + */ + public static String fillAfter(String str, char filledChar, int len) { + return fill(str, filledChar, len, false); + } + + /** + * 将已有字符串填充为规定长度，如果已有字符串超过这个长度则返回这个字符串 + * + * @param str 被填充的字符串 + * @param filledChar 填充的字符 + * @param len 填充长度 + * @param isPre 是否填充在前 + * @return 填充后的字符串 + * @since 3.1.2 + */ + public static String fill(String str, char filledChar, int len, boolean isPre) { + final int strLen = str.length(); + if (strLen > len) { + return str; + } + + String filledStr = StrUtil.repeat(filledChar, len - strLen); + return isPre ? filledStr.concat(str) : str.concat(filledStr); + } + + /** + * 计算两个字符串的相似度 + * + * @param str1 字符串1 + * @param str2 字符串2 + * @return 相似度 + * @since 3.2.3 + */ + public static double similar(String str1, String str2) { + return TextSimilarity.similar(str1, str2); + } + + /** + * 计算两个字符串的相似度百分比 + * + * @param str1 字符串1 + * @param str2 字符串2 + * @param scale 相似度 + * @return 相似度百分比 + * @since 3.2.3 + */ + public static String similar(String str1, String str2, int scale) { + return TextSimilarity.similar(str1, str2, scale); + } + + /** + * 生成随机UUID + * + * @return UUID字符串 + * @see IdUtil#randomUUID() + * @since 4.0.10 + */ + public static String uuid() { + return IdUtil.randomUUID(); + } + + /** + * 格式化文本，使用 {varName} 占位
+ * map = {a: "aValue", b: "bValue"} format("{a} and {b}", map) ---=》 aValue and bValue + * + * @param template 文本模板，被替换的部分用 {key} 表示 + * @param map 参数值对 + * @return 格式化后的文本 + */ + public static String format(CharSequence template, Map map) { + return format(template, map, true); + } + + /** + * 格式化文本，使用 {varName} 占位
+ * map = {a: "aValue", b: "bValue"} format("{a} and {b}", map) ---=》 aValue and bValue + * + * @param template 文本模板，被替换的部分用 {key} 表示 + * @param map 参数值对 + * @param ignoreNull 是否忽略 {@code null} 值，忽略则 {@code null} 值对应的变量不被替换，否则替换为"" + * @return 格式化后的文本 + * @since 5.4.3 + */ + public static String format(CharSequence template, Map map, boolean ignoreNull) { + return StrFormatter.format(template, map, ignoreNull); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/SystemPropsUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/SystemPropsUtil.java new file mode 100644 index 0000000..25a6e41 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/SystemPropsUtil.java @@ -0,0 +1,141 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.convert.Convert; +import aiyh.utils.tool.cn.hutool.core.lang.Console; + +import java.util.Properties; + +/** + * 系统属性工具
+ * 此工具用于读取系统属性或环境变量信息，封装包括： + *
    + *
  • {@link System#getProperty(String)}
    • + *
  • {@link System#getenv(String)}
    • + *
+ * + * @author looly + * @since 5.7.16 + */ +public class SystemPropsUtil { + + /** Hutool自定义系统属性：是否解析日期字符串采用严格模式 */ + public static String HUTOOL_DATE_LENIENT = "hutool.date.lenient"; + + /** + * 取得系统属性，如果因为Java安全的限制而失败，则将错误打在Log中，然后返回 defaultValue + * + * @param name 属性名 + * @param defaultValue 默认值 + * @return 属性值或defaultValue + * @see System#getProperty(String) + * @see System#getenv(String) + */ + public static String get(String name, String defaultValue) { + return StrUtil.nullToDefault(get(name, false), defaultValue); + } + + /** + * 取得系统属性，如果因为Java安全的限制而失败，则将错误打在Log中，然后返回 {@code null} + * + * @param name 属性名 + * @param quiet 安静模式，不将出错信息打在{@code System.err}中 + * @return 属性值或{@code null} + * @see System#getProperty(String) + * @see System#getenv(String) + */ + public static String get(String name, boolean quiet) { + String value = null; + try { + value = System.getProperty(name); + } catch (SecurityException e) { + if (false == quiet) { + Console.error("Caught a SecurityException reading the system property '{}'; " + + "the SystemUtil property value will default to null.", name); + } + } + + if (null == value) { + try { + value = System.getenv(name); + } catch (SecurityException e) { + if (false == quiet) { + Console.error("Caught a SecurityException reading the system env '{}'; " + + "the SystemUtil env value will default to null.", name); + } + } + } + + return value; + } + + /** + * 获得System属性 + * + * @param key 键 + * @return 属性值 + * @see System#getProperty(String) + * @see System#getenv(String) + */ + public static String get(String key) { + return get(key, null); + } + + /** + * 获得boolean类型值 + * + * @param key 键 + * @param defaultValue 默认值 + * @return 值 + */ + public static boolean getBoolean(String key, boolean defaultValue) { + String value = get(key); + if (value == null) { + return defaultValue; + } + + return BooleanUtil.toBoolean(value); + } + + /** + * 获得int类型值 + * + * @param key 键 + * @param defaultValue 默认值 + * @return 值 + */ + public static int getInt(String key, int defaultValue) { + return Convert.toInt(get(key), defaultValue); + } + + /** + * 获得long类型值 + * + * @param key 键 + * @param defaultValue 默认值 + * @return 值 + */ + public static long getLong(String key, long defaultValue) { + return Convert.toLong(get(key), defaultValue); + } + + /** + * @return 属性列表 + */ + public static Properties getProps() { + return System.getProperties(); + } + + /** + * 设置系统属性，value为{@code null}表示移除此属性 + * + * @param key 属性名 + * @param value 属性值，{@code null}表示移除此属性 + */ + public static void set(String key, String value) { + if (null == value) { + System.clearProperty(key); + } else { + System.setProperty(key, value); + } + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/TypeUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/TypeUtil.java new file mode 100755 index 0000000..10de9c5 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/TypeUtil.java @@ -0,0 +1,403 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.lang.ParameterizedTypeImpl; +import aiyh.utils.tool.cn.hutool.core.lang.reflect.ActualTypeMapperPool; + +import java.lang.reflect.Field; +import java.lang.reflect.Method; +import java.lang.reflect.ParameterizedType; +import java.lang.reflect.Type; +import java.lang.reflect.TypeVariable; +import java.lang.reflect.WildcardType; +import java.util.Map; + +/** + * 针对 {@link Type} 的工具类封装
+ * 最主要功能包括： + * + * 
+ * 1. 获取方法的参数和返回值类型（包括Type和Class）
+ * 2. 获取泛型参数类型（包括对象的泛型参数或集合元素的泛型类型）
+ *
+ * + * @author Looly + * @since 3.0.8 + */ +public class TypeUtil { + + /** + * 获得Type对应的原始类 + * + * @param type {@link Type} + * @return 原始类，如果无法获取原始类，返回{@code null} + */ + public static Class getClass(Type type) { + if (null != type) { + if (type instanceof Class) { + return (Class) type; + } else if (type instanceof ParameterizedType) { + return (Class) ((ParameterizedType) type).getRawType(); + } else if (type instanceof TypeVariable) { + return (Class) ((TypeVariable) type).getBounds()[0]; + } else if (type instanceof WildcardType) { + final Type[] upperBounds = ((WildcardType) type).getUpperBounds(); + if (upperBounds.length == 1) { + return getClass(upperBounds[0]); + } + } + } + return null; + } + + /** + * 获取字段对应的Type类型
+ * 方法优先获取GenericType，获取不到则获取Type + * + * @param field 字段 + * @return {@link Type}，可能为{@code null} + */ + public static Type getType(Field field) { + if (null == field) { + return null; + } + return field.getGenericType(); + } + + /** + * 获得字段的泛型类型 + * + * @param clazz Bean类 + * @param fieldName 字段名 + * @return 字段的泛型类型 + * @since 5.4.2 + */ + public static Type getFieldType(Class clazz, String fieldName) { + return getType(ReflectUtil.getField(clazz, fieldName)); + } + + /** + * 获得Field对应的原始类 + * + * @param field {@link Field} + * @return 原始类，如果无法获取原始类，返回{@code null} + * @since 3.1.2 + */ + public static Class getClass(Field field) { + return null == field ? null : field.getType(); + } + + // ----------------------------------------------------------------------------------- Param Type + + /** + * 获取方法的第一个参数类型
+ * 优先获取方法的GenericParameterTypes，如果获取不到，则获取ParameterTypes + * + * @param method 方法 + * @return {@link Type}，可能为{@code null} + * @since 3.1.2 + */ + public static Type getFirstParamType(Method method) { + return getParamType(method, 0); + } + + /** + * 获取方法的第一个参数类 + * + * @param method 方法 + * @return 第一个参数类型，可能为{@code null} + * @since 3.1.2 + */ + public static Class getFirstParamClass(Method method) { + return getParamClass(method, 0); + } + + /** + * 获取方法的参数类型
+ * 优先获取方法的GenericParameterTypes，如果获取不到，则获取ParameterTypes + * + * @param method 方法 + * @param index 第几个参数的索引，从0开始计数 + * @return {@link Type}，可能为{@code null} + */ + public static Type getParamType(Method method, int index) { + Type[] types = getParamTypes(method); + if (null != types && types.length > index) { + return types[index]; + } + return null; + } + + /** + * 获取方法的参数类 + * + * @param method 方法 + * @param index 第几个参数的索引，从0开始计数 + * @return 参数类，可能为{@code null} + * @since 3.1.2 + */ + public static Class getParamClass(Method method, int index) { + Class[] classes = getParamClasses(method); + if (null != classes && classes.length > index) { + return classes[index]; + } + return null; + } + + /** + * 获取方法的参数类型列表
+ * 优先获取方法的GenericParameterTypes，如果获取不到，则获取ParameterTypes + * + * @param method 方法 + * @return {@link Type}列表，可能为{@code null} + * @see Method#getGenericParameterTypes() + * @see Method#getParameterTypes() + */ + public static Type[] getParamTypes(Method method) { + return null == method ? null : method.getGenericParameterTypes(); + } + + /** + * 解析方法的参数类型列表
+ * 依赖jre\lib\rt.jar + * + * @param method t方法 + * @return 参数类型类列表 + * @see Method#getGenericParameterTypes + * @see Method#getParameterTypes + * @since 3.1.2 + */ + public static Class[] getParamClasses(Method method) { + return null == method ? null : method.getParameterTypes(); + } + + // ----------------------------------------------------------------------------------- Return Type + + /** + * 获取方法的返回值类型
+ * 获取方法的GenericReturnType + * + * @param method 方法 + * @return {@link Type}，可能为{@code null} + * @see Method#getGenericReturnType() + * @see Method#getReturnType() + */ + public static Type getReturnType(Method method) { + return null == method ? null : method.getGenericReturnType(); + } + + /** + * 解析方法的返回类型类列表 + * + * @param method 方法 + * @return 返回值类型的类 + * @see Method#getGenericReturnType + * @see Method#getReturnType + * @since 3.1.2 + */ + public static Class getReturnClass(Method method) { + return null == method ? null : method.getReturnType(); + } + + // ----------------------------------------------------------------------------------- Type Argument + + /** + * 获得给定类的第一个泛型参数 + * + * @param type 被检查的类型，必须是已经确定泛型类型的类型 + * @return {@link Type}，可能为{@code null} + */ + public static Type getTypeArgument(Type type) { + return getTypeArgument(type, 0); + } + + /** + * 获得给定类的泛型参数 + * + * @param type 被检查的类型，必须是已经确定泛型类型的类 + * @param index 泛型类型的索引号，即第几个泛型类型 + * @return {@link Type} + */ + public static Type getTypeArgument(Type type, int index) { + final Type[] typeArguments = getTypeArguments(type); + if (null != typeArguments && typeArguments.length > index) { + return typeArguments[index]; + } + return null; + } + + /** + * 获得指定类型中所有泛型参数类型，例如： + * + * 
+	 * class A<T>
+	 * class B extends A<String>
+	 *
+ *

+ * 通过此方法，传入B.class即可得到String + * + * @param type 指定类型 + * @return 所有泛型参数类型 + */ + public static Type[] getTypeArguments(Type type) { + if (null == type) { + return null; + } + + final ParameterizedType parameterizedType = toParameterizedType(type); + return (null == parameterizedType) ? null : parameterizedType.getActualTypeArguments(); + } + + /** + * 将{@link Type} 转换为{@link ParameterizedType}
+ * {@link ParameterizedType}用于获取当前类或父类中泛型参数化后的类型
+ * 一般用于获取泛型参数具体的参数类型，例如： + * + * 

+	 * class A<T>
+	 * class B extends A<String>
+	 *
+ *

+ * 通过此方法，传入B.class即可得到B{@link ParameterizedType}，从而获取到String + * + * @param type {@link Type} + * @return {@link ParameterizedType} + * @since 4.5.2 + */ + public static ParameterizedType toParameterizedType(Type type) { + ParameterizedType result = null; + if (type instanceof ParameterizedType) { + result = (ParameterizedType) type; + } else if (type instanceof Class) { + final Class clazz = (Class) type; + Type genericSuper = clazz.getGenericSuperclass(); + if (null == genericSuper || Object.class.equals(genericSuper)) { + // 如果类没有父类，而是实现一些定义好的泛型接口，则取接口的Type + final Type[] genericInterfaces = clazz.getGenericInterfaces(); + if (ArrayUtil.isNotEmpty(genericInterfaces)) { + // 默认取第一个实现接口的泛型Type + genericSuper = genericInterfaces[0]; + } + } + result = toParameterizedType(genericSuper); + } + return result; + } + + /** + * 是否未知类型
+ * type为null或者{@link TypeVariable} 都视为未知类型 + * + * @param type Type类型 + * @return 是否未知类型 + * @since 4.5.2 + */ + public static boolean isUnknown(Type type) { + return null == type || type instanceof TypeVariable; + } + + /** + * 指定泛型数组中是否含有泛型变量 + * + * @param types 泛型数组 + * @return 是否含有泛型变量 + * @since 4.5.7 + */ + public static boolean hasTypeVariable(Type... types) { + for (Type type : types) { + if (type instanceof TypeVariable) { + return true; + } + } + return false; + } + + /** + * 获取泛型变量和泛型实际类型的对应关系Map，例如： + * + * 

+	 *     T    cn.hutool.test.User
+	 *     E    java.lang.Integer
+	 *
+ * + * @param clazz 被解析的包含泛型参数的类 + * @return 泛型对应关系Map + */ + public static Map getTypeMap(Class clazz) { + return ActualTypeMapperPool.get(clazz); + } + + /** + * 获得泛型字段对应的泛型实际类型，如果此变量没有对应的实际类型，返回null + * + * @param type 实际类型明确的类 + * @param field 字段 + * @return 实际类型，可能为Class等 + */ + public static Type getActualType(Type type, Field field) { + if (null == field) { + return null; + } + return getActualType(ObjectUtil.defaultIfNull(type, field.getDeclaringClass()), field.getGenericType()); + } + + /** + * 获得泛型变量对应的泛型实际类型，如果此变量没有对应的实际类型，返回null + * 此方法可以处理： + * + * 
+	 *     1. 泛型化对象，类似于Map<User, Key<Long>>
+	 *     2. 泛型变量，类似于T
+	 *
+ * + * @param type 类 + * @param typeVariable 泛型变量，例如T等 + * @return 实际类型，可能为Class等 + */ + public static Type getActualType(Type type, Type typeVariable) { + if (typeVariable instanceof ParameterizedType) { + return getActualType(type, (ParameterizedType) typeVariable); + } + + if (typeVariable instanceof TypeVariable) { + return ActualTypeMapperPool.getActualType(type, (TypeVariable) typeVariable); + } + + // 没有需要替换的泛型变量，原样输出 + return typeVariable; + } + + /** + * 获得泛型变量对应的泛型实际类型，如果此变量没有对应的实际类型，返回null + * 此方法可以处理复杂的泛型化对象，类似于Map<User, Key<Long>> + * + * @param type 类 + * @param parameterizedType 泛型变量，例如List<T>等 + * @return 实际类型，可能为Class等 + */ + public static Type getActualType(Type type, ParameterizedType parameterizedType) { + // 字段类型为泛型参数类型，解析对应泛型类型为真实类型，类似于List a + Type[] actualTypeArguments = parameterizedType.getActualTypeArguments(); + + // 泛型对象中含有未被转换的泛型变量 + if (TypeUtil.hasTypeVariable(actualTypeArguments)) { + actualTypeArguments = getActualTypes(type, parameterizedType.getActualTypeArguments()); + if (ArrayUtil.isNotEmpty(actualTypeArguments)) { + // 替换泛型变量为实际类型，例如List变为List + parameterizedType = new ParameterizedTypeImpl(actualTypeArguments, parameterizedType.getOwnerType(), parameterizedType.getRawType()); + } + } + + return parameterizedType; + } + + /** + * 获得泛型变量对应的泛型实际类型，如果此变量没有对应的实际类型，返回null + * + * @param type 类 + * @param typeVariables 泛型变量数组，例如T等 + * @return 实际类型数组，可能为Class等 + */ + public static Type[] getActualTypes(Type type, Type... typeVariables) { + return ActualTypeMapperPool.getActualTypes(type, typeVariables); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/URLUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/URLUtil.java new file mode 100644 index 0000000..5cbe769 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/URLUtil.java @@ -0,0 +1,779 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.io.resource.ResourceUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.net.URLDecoder; +import aiyh.utils.tool.cn.hutool.core.net.URLEncodeUtil; +import aiyh.utils.tool.cn.hutool.core.net.url.UrlQuery; + +import java.io.BufferedReader; +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.net.HttpURLConnection; +import java.net.JarURLConnection; +import java.net.MalformedURLException; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; +import java.net.URLConnection; +import java.net.URLStreamHandler; +import java.nio.charset.Charset; +import java.util.Map; +import java.util.jar.JarFile; + +/** + * URL（Uniform Resource Locator）统一资源定位符相关工具类 + * + *

+ * 统一资源定位符，描述了一台特定服务器上某资源的特定位置。 + *

+ * URL组成： + * 
+ *   协议://主机名[:端口]/ 路径/[:参数] [?查询]#Fragment
+ *   protocol :// hostname[:port] / path / [:parameters][?query]#fragment
+ *
+ * + * @author xiaoleilu + */ +public class URLUtil extends URLEncodeUtil { + + /** + * 针对ClassPath路径的伪协议前缀（兼容Spring）: "classpath:" + */ + public static final String CLASSPATH_URL_PREFIX = "classpath:"; + /** + * URL 前缀表示文件: "file:" + */ + public static final String FILE_URL_PREFIX = "file:"; + /** + * URL 前缀表示jar: "jar:" + */ + public static final String JAR_URL_PREFIX = "jar:"; + /** + * URL 前缀表示war: "war:" + */ + public static final String WAR_URL_PREFIX = "war:"; + /** + * URL 协议表示文件: "file" + */ + public static final String URL_PROTOCOL_FILE = "file"; + /** + * URL 协议表示Jar文件: "jar" + */ + public static final String URL_PROTOCOL_JAR = "jar"; + /** + * URL 协议表示zip文件: "zip" + */ + public static final String URL_PROTOCOL_ZIP = "zip"; + /** + * URL 协议表示WebSphere文件: "wsjar" + */ + public static final String URL_PROTOCOL_WSJAR = "wsjar"; + /** + * URL 协议表示JBoss zip文件: "vfszip" + */ + public static final String URL_PROTOCOL_VFSZIP = "vfszip"; + /** + * URL 协议表示JBoss文件: "vfsfile" + */ + public static final String URL_PROTOCOL_VFSFILE = "vfsfile"; + /** + * URL 协议表示JBoss VFS资源: "vfs" + */ + public static final String URL_PROTOCOL_VFS = "vfs"; + /** + * Jar路径以及内部文件路径的分界符: "!/" + */ + public static final String JAR_URL_SEPARATOR = "!/"; + /** + * WAR路径及内部文件路径分界符 + */ + public static final String WAR_URL_SEPARATOR = "*/"; + + /** + * 将{@link URI}转换为{@link URL} + * + * @param uri {@link URI} + * @return URL对象 + * @see URI#toURL() + * @throws UtilException {@link MalformedURLException}包装，URI格式有问题时抛出 + * @since 5.7.21 + */ + public static URL url(URI uri) throws UtilException{ + if(null == uri){ + return null; + } + try { + return uri.toURL(); + } catch (MalformedURLException e) { + throw new UtilException(e); + } + } + + /** + * 通过一个字符串形式的URL地址创建URL对象 + * + * @param url URL + * @return URL对象 + */ + public static URL url(String url) { + return url(url, null); + } + + /** + * 通过一个字符串形式的URL地址创建URL对象 + * + * @param url URL + * @param handler {@link URLStreamHandler} + * @return URL对象 + * @since 4.1.1 + */ + public static URL url(String url, URLStreamHandler handler) { + if(null == url){ + return null; + } + + // 兼容Spring的ClassPath路径 + if (url.startsWith(CLASSPATH_URL_PREFIX)) { + url = url.substring(CLASSPATH_URL_PREFIX.length()); + return ClassLoaderUtil.getClassLoader().getResource(url); + } + + try { + return new URL(null, url, handler); + } catch (MalformedURLException e) { + // 尝试文件路径 + try { + return new File(url).toURI().toURL(); + } catch (MalformedURLException ex2) { + throw new UtilException(e); + } + } + } + + /** + * 获取string协议的URL，类似于string:///xxxxx + * + * @param content 正文 + * @return URL + * @since 5.5.2 + */ + public static URI getStringURI(CharSequence content) { + if(null == content){ + return null; + } + final String contentStr = StrUtil.addPrefixIfNot(content, "string:///"); + return URI.create(contentStr); + } + + /** + * 将URL字符串转换为URL对象，并做必要验证 + * + * @param urlStr URL字符串 + * @return URL + * @since 4.1.9 + */ + public static URL toUrlForHttp(String urlStr) { + return toUrlForHttp(urlStr, null); + } + + /** + * 将URL字符串转换为URL对象，并做必要验证 + * + * @param urlStr URL字符串 + * @param handler {@link URLStreamHandler} + * @return URL + * @since 4.1.9 + */ + public static URL toUrlForHttp(String urlStr, URLStreamHandler handler) { + Assert.notBlank(urlStr, "Url is blank !"); + // 编码空白符，防止空格引起的请求异常 + urlStr = encodeBlank(urlStr); + try { + return new URL(null, urlStr, handler); + } catch (MalformedURLException e) { + throw new UtilException(e); + } + } + + /** + * 单独编码URL中的空白符，空白符编码为%20 + * + * @param urlStr URL字符串 + * @return 编码后的字符串 + * @since 4.5.14 + */ + public static String encodeBlank(CharSequence urlStr) { + if (urlStr == null) { + return null; + } + + int len = urlStr.length(); + final StringBuilder sb = new StringBuilder(len); + char c; + for (int i = 0; i < len; i++) { + c = urlStr.charAt(i); + if (CharUtil.isBlankChar(c)) { + sb.append("%20"); + } else { + sb.append(c); + } + } + return sb.toString(); + } + + /** + * 获得URL + * + * @param pathBaseClassLoader 相对路径（相对于classes） + * @return URL + * @see ResourceUtil#getResource(String) + */ + public static URL getURL(String pathBaseClassLoader) { + return ResourceUtil.getResource(pathBaseClassLoader); + } + + /** + * 获得URL + * + * @param path 相对给定 class所在的路径 + * @param clazz 指定class + * @return URL + * @see ResourceUtil#getResource(String, Class) + */ + public static URL getURL(String path, Class clazz) { + return ResourceUtil.getResource(path, clazz); + } + + /** + * 获得URL，常用于使用绝对路径时的情况 + * + * @param file URL对应的文件对象 + * @return URL + * @throws UtilException MalformedURLException + */ + public static URL getURL(File file) { + Assert.notNull(file, "File is null !"); + try { + return file.toURI().toURL(); + } catch (MalformedURLException e) { + throw new UtilException(e, "Error occured when get URL!"); + } + } + + /** + * 获得URL，常用于使用绝对路径时的情况 + * + * @param files URL对应的文件对象 + * @return URL + * @throws UtilException MalformedURLException + */ + public static URL[] getURLs(File... files) { + final URL[] urls = new URL[files.length]; + try { + for (int i = 0; i < files.length; i++) { + urls[i] = files[i].toURI().toURL(); + } + } catch (MalformedURLException e) { + throw new UtilException(e, "Error occured when get URL!"); + } + + return urls; + } + + /** + * 获取URL中域名部分，只保留URL中的协议（Protocol）、Host，其它为null。 + * + * @param url URL + * @return 域名的URI + * @since 4.6.9 + */ + public static URI getHost(URL url) { + if (null == url) { + return null; + } + + try { + return new URI(url.getProtocol(), url.getHost(), null, null); + } catch (URISyntaxException e) { + throw new UtilException(e); + } + } + + /** + * 补全相对路径 + * + * @param baseUrl 基准URL + * @param relativePath 相对URL + * @return 相对路径 + * @throws UtilException MalformedURLException + */ + public static String completeUrl(String baseUrl, String relativePath) { + baseUrl = normalize(baseUrl, false); + if (StrUtil.isBlank(baseUrl)) { + return null; + } + + try { + final URL absoluteUrl = new URL(baseUrl); + final URL parseUrl = new URL(absoluteUrl, relativePath); + return parseUrl.toString(); + } catch (MalformedURLException e) { + throw new UtilException(e); + } + } + //-------------------------------------------------------------------------- decode + + /** + * 解码URL
+ * 将%开头的16进制表示的内容解码。 + * + * @param url URL + * @return 解码后的URL + * @throws UtilException UnsupportedEncodingException + * @since 3.1.2 + */ + public static String decode(String url) throws UtilException { + return decode(url, CharsetUtil.UTF_8); + } + + /** + * 解码application/x-www-form-urlencoded字符
+ * 将%开头的16进制表示的内容解码。
+ * 规则见：https://url.spec.whatwg.org/#urlencoded-parsing + * + * @param content 被解码内容 + * @param charset 编码，null表示不解码 + * @return 编码后的字符 + * @since 4.4.1 + */ + public static String decode(String content, Charset charset) { + return URLDecoder.decode(content, charset); + } + + /** + * 解码application/x-www-form-urlencoded字符
+ * 将%开头的16进制表示的内容解码。 + * + * @param content 被解码内容 + * @param charset 编码，null表示不解码 + * @param isPlusToSpace 是否+转换为空格 + * @return 编码后的字符 + * @since 5.6.3 + */ + public static String decode(String content, Charset charset, boolean isPlusToSpace) { + return URLDecoder.decode(content, charset, isPlusToSpace); + } + + /** + * 解码application/x-www-form-urlencoded字符
+ * 将%开头的16进制表示的内容解码。 + * + * @param content URL + * @param charset 编码 + * @return 解码后的URL + * @throws UtilException UnsupportedEncodingException + */ + public static String decode(String content, String charset) throws UtilException { + return decode(content, StrUtil.isEmpty(charset) ? null : CharsetUtil.charset(charset)); + } + + /** + * 获得path部分
+ * + * @param uriStr URI路径 + * @return path + * @throws UtilException 包装URISyntaxException + */ + public static String getPath(String uriStr) { + return toURI(uriStr).getPath(); + } + + /** + * 从URL对象中获取不被编码的路径Path
+ * 对于本地路径，URL对象的getPath方法对于包含中文或空格时会被编码，导致本读路径读取错误。
+ * 此方法将URL转为URI后获取路径用于解决路径被编码的问题 + * + * @param url {@link URL} + * @return 路径 + * @since 3.0.8 + */ + public static String getDecodedPath(URL url) { + if (null == url) { + return null; + } + + String path = null; + try { + // URL对象的getPath方法对于包含中文或空格的问题 + path = toURI(url).getPath(); + } catch (UtilException e) { + // ignore + } + return (null != path) ? path : url.getPath(); + } + + /** + * 转URL为URI + * + * @param url URL + * @return URI + * @throws UtilException 包装URISyntaxException + */ + public static URI toURI(URL url) throws UtilException { + return toURI(url, false); + } + + /** + * 转URL为URI + * + * @param url URL + * @param isEncode 是否编码参数中的特殊字符（默认UTF-8编码） + * @return URI + * @throws UtilException 包装URISyntaxException + * @since 4.6.9 + */ + public static URI toURI(URL url, boolean isEncode) throws UtilException { + if (null == url) { + return null; + } + + return toURI(url.toString(), isEncode); + } + + /** + * 转字符串为URI + * + * @param location 字符串路径 + * @return URI + * @throws UtilException 包装URISyntaxException + */ + public static URI toURI(String location) throws UtilException { + return toURI(location, false); + } + + /** + * 转字符串为URI + * + * @param location 字符串路径 + * @param isEncode 是否编码参数中的特殊字符（默认UTF-8编码） + * @return URI + * @throws UtilException 包装URISyntaxException + * @since 4.6.9 + */ + public static URI toURI(String location, boolean isEncode) throws UtilException { + if (isEncode) { + location = encode(location); + } + try { + return new URI(StrUtil.trim(location)); + } catch (URISyntaxException e) { + throw new UtilException(e); + } + } + + /** + * 提供的URL是否为文件
+ * 文件协议包括"file", "vfsfile" 或 "vfs". + * + * @param url {@link URL} + * @return 是否为文件 + * @since 3.0.9 + */ + public static boolean isFileURL(URL url) { + Assert.notNull(url, "URL must be not null"); + String protocol = url.getProtocol(); + return (URL_PROTOCOL_FILE.equals(protocol) || // + URL_PROTOCOL_VFSFILE.equals(protocol) || // + URL_PROTOCOL_VFS.equals(protocol)); + } + + /** + * 提供的URL是否为jar包URL 协议包括： "jar", "zip", "vfszip" 或 "wsjar". + * + * @param url {@link URL} + * @return 是否为jar包URL + */ + public static boolean isJarURL(URL url) { + Assert.notNull(url, "URL must be not null"); + final String protocol = url.getProtocol(); + return (URL_PROTOCOL_JAR.equals(protocol) || // + URL_PROTOCOL_ZIP.equals(protocol) || // + URL_PROTOCOL_VFSZIP.equals(protocol) || // + URL_PROTOCOL_WSJAR.equals(protocol)); + } + + /** + * 提供的URL是否为Jar文件URL 判断依据为file协议且扩展名为.jar + * + * @param url the URL to check + * @return whether the URL has been identified as a JAR file URL + * @since 4.1 + */ + public static boolean isJarFileURL(URL url) { + Assert.notNull(url, "URL must be not null"); + return (URL_PROTOCOL_FILE.equals(url.getProtocol()) && // + url.getPath().toLowerCase().endsWith(FileUtil.JAR_FILE_EXT)); + } + + /** + * 从URL中获取流 + * + * @param url {@link URL} + * @return InputStream流 + * @since 3.2.1 + */ + public static InputStream getStream(URL url) { + Assert.notNull(url, "URL must be not null"); + try { + return url.openStream(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 获得Reader + * + * @param url {@link URL} + * @param charset 编码 + * @return {@link BufferedReader} + * @since 3.2.1 + */ + public static BufferedReader getReader(URL url, Charset charset) { + return IoUtil.getReader(getStream(url), charset); + } + + /** + * 从URL中获取JarFile + * + * @param url URL + * @return JarFile + * @since 4.1.5 + */ + public static JarFile getJarFile(URL url) { + try { + JarURLConnection urlConnection = (JarURLConnection) url.openConnection(); + return urlConnection.getJarFile(); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 标准化URL字符串，包括： + * + *
    + *
  1. 自动补齐“http://”头
    2. + *
  2. 去除开头的\或者/
    3. + *
  3. 替换\为/
    4. + *
+ * + * @param url URL字符串 + * @return 标准化后的URL字符串 + */ + public static String normalize(String url) { + return normalize(url, false); + } + + /** + * 标准化URL字符串，包括： + * + *
    + *
  1. 自动补齐“http://”头
    2. + *
  2. 去除开头的\或者/
    3. + *
  3. 替换\为/
    4. + *
+ * + * @param url URL字符串 + * @param isEncodePath 是否对URL中path部分的中文和特殊字符做转义（不包括 http:, /和域名部分） + * @return 标准化后的URL字符串 + * @since 4.4.1 + */ + public static String normalize(String url, boolean isEncodePath) { + return normalize(url, isEncodePath, false); + } + + /** + * 标准化URL字符串，包括： + * + *
    + *
  1. 自动补齐“http://”头
    2. + *
  2. 去除开头的\或者/
    3. + *
  3. 替换\为/
    4. + *
  4. 如果replaceSlash为true，则替换多个/为一个
    5. + *
+ * + * @param url URL字符串 + * @param isEncodePath 是否对URL中path部分的中文和特殊字符做转义（不包括 http:, /和域名部分） + * @param replaceSlash 是否替换url body中的 // + * @return 标准化后的URL字符串 + * @since 5.5.5 + */ + public static String normalize(String url, boolean isEncodePath, boolean replaceSlash) { + if (StrUtil.isBlank(url)) { + return url; + } + final int sepIndex = url.indexOf("://"); + String protocol; + String body; + if (sepIndex > 0) { + protocol = StrUtil.subPre(url, sepIndex + 3); + body = StrUtil.subSuf(url, sepIndex + 3); + } else { + protocol = "http://"; + body = url; + } + + final int paramsSepIndex = StrUtil.indexOf(body, '?'); + String params = null; + if (paramsSepIndex > 0) { + params = StrUtil.subSuf(body, paramsSepIndex); + body = StrUtil.subPre(body, paramsSepIndex); + } + + if (StrUtil.isNotEmpty(body)) { + // 去除开头的\或者/ + //noinspection ConstantConditions + body = body.replaceAll("^[\\\\/]+", StrUtil.EMPTY); + // 替换\为/ + body = body.replace("\\", "/"); + if (replaceSlash) { + //issue#I25MZL@Gitee，双斜杠在URL中是允许存在的，默认不做替换 + body = body.replaceAll("//+", "/"); + } + } + + final int pathSepIndex = StrUtil.indexOf(body, '/'); + String domain = body; + String path = null; + if (pathSepIndex > 0) { + domain = StrUtil.subPre(body, pathSepIndex); + path = StrUtil.subSuf(body, pathSepIndex); + } + if (isEncodePath) { + path = encode(path); + } + return protocol + domain + StrUtil.nullToEmpty(path) + StrUtil.nullToEmpty(params); + } + + /** + * 将Map形式的Form表单数据转换为Url参数形式
+ * paramMap中如果key为空（null和""）会被忽略，如果value为null，会被做为空白符（""）
+ * 会自动url编码键和值 + * + * 
+	 * key1=v1&key2=&key3=v3
+	 *
+ * + * @param paramMap 表单数据 + * @param charset 编码，编码为null表示不编码 + * @return url参数 + */ + public static String buildQuery(Map paramMap, Charset charset) { + return UrlQuery.of(paramMap).build(charset); + } + + /** + * 获取指定URL对应资源的内容长度，对于Http，其长度使用Content-Length头决定。 + * + * @param url URL + * @return 内容长度，未知返回-1 + * @throws IORuntimeException IO异常 + * @since 5.3.4 + */ + public static long getContentLength(URL url) throws IORuntimeException { + if (null == url) { + return -1; + } + + URLConnection conn = null; + try { + conn = url.openConnection(); + return conn.getContentLengthLong(); + } catch (IOException e) { + throw new IORuntimeException(e); + } finally { + if (conn instanceof HttpURLConnection) { + ((HttpURLConnection) conn).disconnect(); + } + } + } + + /** + * Data URI Scheme封装，数据格式为Base64。data URI scheme 允许我们使用内联（inline-code）的方式在网页中包含数据，
+ * 目的是将一些小的数据，直接嵌入到网页中，从而不用再从外部文件载入。常用于将图片嵌入网页。 + * + *

+ * Data URI的格式规范： + * 

+	 *     data:[<mime type>][;charset=<charset>][;<encoding>],<encoded data>
+	 *
+ * + * @param mimeType 可选项（null表示无），数据类型（image/png、text/plain等） + * @param data 编码后的数据 + * @return Data URI字符串 + * @since 5.3.11 + */ + public static String getDataUriBase64(String mimeType, String data) { + return getDataUri(mimeType, null, "base64", data); + } + + /** + * Data URI Scheme封装。data URI scheme 允许我们使用内联（inline-code）的方式在网页中包含数据，
+ * 目的是将一些小的数据，直接嵌入到网页中，从而不用再从外部文件载入。常用于将图片嵌入网页。 + * + *

+ * Data URI的格式规范： + * 

+	 *     data:[<mime type>][;charset=<charset>][;<encoding>],<encoded data>
+	 *
+ * + * @param mimeType 可选项（null表示无），数据类型（image/png、text/plain等） + * @param encoding 数据编码方式（US-ASCII，BASE64等） + * @param data 编码后的数据 + * @return Data URI字符串 + * @since 5.3.6 + */ + public static String getDataUri(String mimeType, String encoding, String data) { + return getDataUri(mimeType, null, encoding, data); + } + + /** + * Data URI Scheme封装。data URI scheme 允许我们使用内联（inline-code）的方式在网页中包含数据，
+ * 目的是将一些小的数据，直接嵌入到网页中，从而不用再从外部文件载入。常用于将图片嵌入网页。 + * + *

+ * Data URI的格式规范： + * 

+	 *     data:[<mime type>][;charset=<charset>][;<encoding>],<encoded data>
+	 *
+ * + * @param mimeType 可选项（null表示无），数据类型（image/png、text/plain等） + * @param charset 可选项（null表示无），源文本的字符集编码方式 + * @param encoding 数据编码方式（US-ASCII，BASE64等） + * @param data 编码后的数据 + * @return Data URI字符串 + * @since 5.3.6 + */ + public static String getDataUri(String mimeType, Charset charset, String encoding, String data) { + final StringBuilder builder = StrUtil.builder("data:"); + if (StrUtil.isNotBlank(mimeType)) { + builder.append(mimeType); + } + if (null != charset) { + builder.append(";charset=").append(charset.name()); + } + if (StrUtil.isNotBlank(encoding)) { + builder.append(';').append(encoding); + } + builder.append(',').append(data); + + return builder.toString(); + } +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/XmlUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/XmlUtil.java new file mode 100755 index 0000000..7cc46eb --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/XmlUtil.java @@ -0,0 +1,1538 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.bean.BeanUtil; +import aiyh.utils.tool.cn.hutool.core.collection.CollUtil; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.map.BiMap; +import aiyh.utils.tool.cn.hutool.core.map.MapUtil; +import org.w3c.dom.Document; +import org.w3c.dom.Element; +import org.w3c.dom.NamedNodeMap; +import org.w3c.dom.Node; +import org.w3c.dom.NodeList; +import org.xml.sax.ContentHandler; +import org.xml.sax.InputSource; +import org.xml.sax.SAXException; +import org.xml.sax.XMLReader; +import org.xml.sax.helpers.DefaultHandler; + +import javax.xml.XMLConstants; +import javax.xml.namespace.NamespaceContext; +import javax.xml.namespace.QName; +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.parsers.ParserConfigurationException; +import javax.xml.parsers.SAXParser; +import javax.xml.parsers.SAXParserFactory; +import javax.xml.transform.OutputKeys; +import javax.xml.transform.Result; +import javax.xml.transform.Source; +import javax.xml.transform.Transformer; +import javax.xml.transform.TransformerFactory; +import javax.xml.transform.dom.DOMSource; +import javax.xml.transform.stream.StreamResult; +import javax.xml.xpath.XPath; +import javax.xml.xpath.XPathConstants; +import javax.xml.xpath.XPathExpressionException; +import javax.xml.xpath.XPathFactory; +import java.beans.XMLEncoder; +import java.io.BufferedInputStream; +import java.io.BufferedWriter; +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.Reader; +import java.io.StringWriter; +import java.io.Writer; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Map; + +/** + * XML工具类
+ * 此工具使用w3c dom工具，不需要依赖第三方包。
+ * 工具类封装了XML文档的创建、读取、写出和部分XML操作 + * + * @author xiaoleilu + * @see JAXBUtil + */ +public class XmlUtil { + + /** + * 字符串常量：XML 不间断空格转义 {@code " " -> " "} + */ + public static final String NBSP = " "; + + /** + * 字符串常量：XML And 符转义 {@code "&" -> "&"} + */ + public static final String AMP = "&"; + + /** + * 字符串常量：XML 双引号转义 {@code """ -> "\""} + */ + public static final String QUOTE = """; + + /** + * 字符串常量：XML 单引号转义 {@code "&apos" -> "'"} + */ + public static final String APOS = "'"; + + /** + * 字符串常量：XML 小于号转义 {@code "<" -> "<"} + */ + public static final String LT = "<"; + + /** + * 字符串常量：XML 大于号转义 {@code ">" -> ">"} + */ + public static final String GT = ">"; + + /** + * 在XML中无效的字符 正则 + */ + public static final String INVALID_REGEX = "[\\x00-\\x08\\x0b-\\x0c\\x0e-\\x1f]"; + /** + * 在XML中注释的内容 正则 + */ + public static final String COMMENT_REGEX = "(?s)"; + /** + * XML格式化输出默认缩进量 + */ + public static final int INDENT_DEFAULT = 2; + + /** + * 默认的DocumentBuilderFactory实现 + */ + private static String defaultDocumentBuilderFactory = "com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl"; + + /** + * 是否打开命名空间支持 + */ + private static boolean namespaceAware = true; + /** + * Sax读取器工厂缓存 + */ + private static SAXParserFactory factory; + + /** + * 禁用默认的DocumentBuilderFactory，禁用后如果有第三方的实现（如oracle的xdb包中的xmlparse），将会自动加载实现。 + */ + synchronized public static void disableDefaultDocumentBuilderFactory() { + defaultDocumentBuilderFactory = null; + } + + /** + * 设置是否打开命名空间支持，默认打开 + * + * @param isNamespaceAware 是否命名空间支持 + * @since 5.3.1 + */ + synchronized public static void setNamespaceAware(boolean isNamespaceAware) { + namespaceAware = isNamespaceAware; + } + + // -------------------------------------------------------------------------------------- Read + + /** + * 读取解析XML文件 + * + * @param file XML文件 + * @return XML文档对象 + */ + public static Document readXML(File file) { + Assert.notNull(file, "Xml file is null !"); + if (false == file.exists()) { + throw new UtilException("File [{}] not a exist!", file.getAbsolutePath()); + } + if (false == file.isFile()) { + throw new UtilException("[{}] not a file!", file.getAbsolutePath()); + } + + try { + file = file.getCanonicalFile(); + } catch (IOException e) { + // ignore + } + + BufferedInputStream in = null; + try { + in = FileUtil.getInputStream(file); + return readXML(in); + } finally { + IoUtil.close(in); + } + } + + /** + * 读取解析XML文件
+ * 如果给定内容以“<”开头，表示这是一个XML内容，直接读取，否则按照路径处理
+ * 路径可以为相对路径，也可以是绝对路径，相对路径相对于ClassPath + * + * @param pathOrContent 内容或路径 + * @return XML文档对象 + * @since 3.0.9 + */ + public static Document readXML(String pathOrContent) { + if (StrUtil.startWith(pathOrContent, '<')) { + return parseXml(pathOrContent); + } + return readXML(FileUtil.file(pathOrContent)); + } + + /** + * 读取解析XML文件
+ * 编码在XML中定义 + * + * @param inputStream XML流 + * @return XML文档对象 + * @throws UtilException IO异常或转换异常 + * @since 3.0.9 + */ + public static Document readXML(InputStream inputStream) throws UtilException { + return readXML(new InputSource(inputStream)); + } + + /** + * 读取解析XML文件 + * + * @param reader XML流 + * @return XML文档对象 + * @throws UtilException IO异常或转换异常 + * @since 3.0.9 + */ + public static Document readXML(Reader reader) throws UtilException { + return readXML(new InputSource(reader)); + } + + /** + * 读取解析XML文件
+ * 编码在XML中定义 + * + * @param source {@link InputSource} + * @return XML文档对象 + * @since 3.0.9 + */ + public static Document readXML(InputSource source) { + final DocumentBuilder builder = createDocumentBuilder(); + try { + return builder.parse(source); + } catch (Exception e) { + throw new UtilException(e, "Parse XML from stream error!"); + } + } + + /** + * 使用Sax方式读取指定的XML
+ * 如果用户传入的contentHandler为{@link DefaultHandler}，则其接口都会被处理 + * + * @param file XML源文件,使用后自动关闭 + * @param contentHandler XML流处理器，用于按照Element处理xml + * @since 5.4.4 + */ + public static void readBySax(File file, ContentHandler contentHandler) { + InputStream in = null; + try { + in = FileUtil.getInputStream(file); + readBySax(new InputSource(in), contentHandler); + } finally { + IoUtil.close(in); + } + } + + /** + * 使用Sax方式读取指定的XML
+ * 如果用户传入的contentHandler为{@link DefaultHandler}，则其接口都会被处理 + * + * @param reader XML源Reader,使用后自动关闭 + * @param contentHandler XML流处理器，用于按照Element处理xml + * @since 5.4.4 + */ + public static void readBySax(Reader reader, ContentHandler contentHandler) { + try { + readBySax(new InputSource(reader), contentHandler); + } finally { + IoUtil.close(reader); + } + } + + /** + * 使用Sax方式读取指定的XML
+ * 如果用户传入的contentHandler为{@link DefaultHandler}，则其接口都会被处理 + * + * @param source XML源流,使用后自动关闭 + * @param contentHandler XML流处理器，用于按照Element处理xml + * @since 5.4.4 + */ + public static void readBySax(InputStream source, ContentHandler contentHandler) { + try { + readBySax(new InputSource(source), contentHandler); + } finally { + IoUtil.close(source); + } + } + + /** + * 使用Sax方式读取指定的XML
+ * 如果用户传入的contentHandler为{@link DefaultHandler}，则其接口都会被处理 + * + * @param source XML源，可以是文件、流、路径等 + * @param contentHandler XML流处理器，用于按照Element处理xml + * @since 5.4.4 + */ + public static void readBySax(InputSource source, ContentHandler contentHandler) { + // 1.获取解析工厂 + if (null == factory) { + factory = SAXParserFactory.newInstance(); + factory.setValidating(false); + factory.setNamespaceAware(namespaceAware); + } + // 2.从解析工厂获取解析器 + final SAXParser parse; + XMLReader reader; + try { + parse = factory.newSAXParser(); + if (contentHandler instanceof DefaultHandler) { + parse.parse(source, (DefaultHandler) contentHandler); + return; + } + + // 3.得到解读器 + reader = parse.getXMLReader(); + reader.setContentHandler(contentHandler); + reader.parse(source); + } catch (ParserConfigurationException | SAXException e) { + throw new UtilException(e); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 将String类型的XML转换为XML文档 + * + * @param xmlStr XML字符串 + * @return XML文档 + */ + public static Document parseXml(String xmlStr) { + if (StrUtil.isBlank(xmlStr)) { + throw new IllegalArgumentException("XML content string is empty !"); + } + xmlStr = cleanInvalid(xmlStr); + return readXML(StrUtil.getReader(xmlStr)); + } + + // -------------------------------------------------------------------------------------- Write + + /** + * 将XML文档转换为String
+ * 字符编码使用XML文档中的编码，获取不到则使用UTF-8
+ * 默认非格式化输出，若想格式化请使用{@link #format(Document)} + * + * @param doc XML文档 + * @return XML字符串 + * @since 5.4.5 + */ + public static String toStr(Node doc) { + return toStr(doc, false); + } + + /** + * 将XML文档转换为String
+ * 字符编码使用XML文档中的编码，获取不到则使用UTF-8
+ * 默认非格式化输出，若想格式化请使用{@link #format(Document)} + * + * @param doc XML文档 + * @return XML字符串 + */ + public static String toStr(Document doc) { + return toStr((Node) doc); + } + + /** + * 将XML文档转换为String
+ * 字符编码使用XML文档中的编码，获取不到则使用UTF-8 + * + * @param doc XML文档 + * @param isPretty 是否格式化输出 + * @return XML字符串 + * @since 5.4.5 + */ + public static String toStr(Node doc, boolean isPretty) { + return toStr(doc, CharsetUtil.UTF_8, isPretty); + } + + /** + * 将XML文档转换为String
+ * 字符编码使用XML文档中的编码，获取不到则使用UTF-8 + * + * @param doc XML文档 + * @param isPretty 是否格式化输出 + * @return XML字符串 + * @since 3.0.9 + */ + public static String toStr(Document doc, boolean isPretty) { + return toStr((Node) doc, isPretty); + } + + /** + * 将XML文档转换为String
+ * 字符编码使用XML文档中的编码，获取不到则使用UTF-8 + * + * @param doc XML文档 + * @param charset 编码 + * @param isPretty 是否格式化输出 + * @return XML字符串 + * @since 5.4.5 + */ + public static String toStr(Node doc, String charset, boolean isPretty) { + return toStr(doc, charset, isPretty, false); + } + + /** + * 将XML文档转换为String
+ * 字符编码使用XML文档中的编码，获取不到则使用UTF-8 + * + * @param doc XML文档 + * @param charset 编码 + * @param isPretty 是否格式化输出 + * @return XML字符串 + * @since 3.0.9 + */ + public static String toStr(Document doc, String charset, boolean isPretty) { + return toStr((Node) doc, charset, isPretty); + } + + /** + * 将XML文档转换为String
+ * 字符编码使用XML文档中的编码，获取不到则使用UTF-8 + * + * @param doc XML文档 + * @param charset 编码 + * @param isPretty 是否格式化输出 + * @param omitXmlDeclaration 是否忽略 xml Declaration + * @return XML字符串 + * @since 5.1.2 + */ + public static String toStr(Node doc, String charset, boolean isPretty, boolean omitXmlDeclaration) { + final StringWriter writer = StrUtil.getWriter(); + try { + write(doc, writer, charset, isPretty ? INDENT_DEFAULT : 0, omitXmlDeclaration); + } catch (Exception e) { + throw new UtilException(e, "Trans xml document to string error!"); + } + return writer.toString(); + } + + /** + * 格式化XML输出 + * + * @param doc {@link Document} XML文档 + * @return 格式化后的XML字符串 + * @since 4.4.5 + */ + public static String format(Document doc) { + return toStr(doc, true); + } + + /** + * 格式化XML输出 + * + * @param xmlStr XML字符串 + * @return 格式化后的XML字符串 + * @since 4.4.5 + */ + public static String format(String xmlStr) { + return format(parseXml(xmlStr)); + } + + /** + * 将XML文档写入到文件
+ * 使用Document中的编码 + * + * @param doc XML文档 + * @param absolutePath 文件绝对路径，不存在会自动创建 + */ + public static void toFile(Document doc, String absolutePath) { + toFile(doc, absolutePath, null); + } + + /** + * 将XML文档写入到文件
+ * + * @param doc XML文档 + * @param path 文件路径绝对路径或相对ClassPath路径，不存在会自动创建 + * @param charsetName 自定义XML文件的编码，如果为{@code null} 读取XML文档中的编码，否则默认UTF-8 + */ + public static void toFile(Document doc, String path, String charsetName) { + if (StrUtil.isBlank(charsetName)) { + charsetName = doc.getXmlEncoding(); + } + if (StrUtil.isBlank(charsetName)) { + charsetName = CharsetUtil.UTF_8; + } + + BufferedWriter writer = null; + try { + writer = FileUtil.getWriter(path, CharsetUtil.charset(charsetName), false); + write(doc, writer, charsetName, INDENT_DEFAULT); + } finally { + IoUtil.close(writer); + } + } + + /** + * 将XML文档写出 + * + * @param node {@link Node} XML文档节点或文档本身 + * @param writer 写出的Writer，Writer决定了输出XML的编码 + * @param charset 编码 + * @param indent 格式化输出中缩进量，小于1表示不格式化输出 + * @since 3.0.9 + */ + public static void write(Node node, Writer writer, String charset, int indent) { + transform(new DOMSource(node), new StreamResult(writer), charset, indent); + } + + /** + * 将XML文档写出 + * + * @param node {@link Node} XML文档节点或文档本身 + * @param writer 写出的Writer，Writer决定了输出XML的编码 + * @param charset 编码 + * @param indent 格式化输出中缩进量，小于1表示不格式化输出 + * @param omitXmlDeclaration 是否输出 xml Declaration + * @since 5.1.2 + */ + public static void write(Node node, Writer writer, String charset, int indent, boolean omitXmlDeclaration) { + transform(new DOMSource(node), new StreamResult(writer), charset, indent, omitXmlDeclaration); + } + + /** + * 将XML文档写出 + * + * @param node {@link Node} XML文档节点或文档本身 + * @param out 写出的Writer，Writer决定了输出XML的编码 + * @param charset 编码 + * @param indent 格式化输出中缩进量，小于1表示不格式化输出 + * @since 4.0.8 + */ + public static void write(Node node, OutputStream out, String charset, int indent) { + transform(new DOMSource(node), new StreamResult(out), charset, indent); + } + + /** + * 将XML文档写出 + * + * @param node {@link Node} XML文档节点或文档本身 + * @param out 写出的Writer，Writer决定了输出XML的编码 + * @param charset 编码 + * @param indent 格式化输出中缩进量，小于1表示不格式化输出 + * @param omitXmlDeclaration 是否输出 xml Declaration + * @since 5.1.2 + */ + public static void write(Node node, OutputStream out, String charset, int indent, boolean omitXmlDeclaration) { + transform(new DOMSource(node), new StreamResult(out), charset, indent, omitXmlDeclaration); + } + + /** + * 将XML文档写出
+ * 格式化输出逻辑参考：https://stackoverflow.com/questions/139076/how-to-pretty-print-xml-from-java + * + * @param source 源 + * @param result 目标 + * @param charset 编码 + * @param indent 格式化输出中缩进量，小于1表示不格式化输出 + * @since 4.0.9 + */ + public static void transform(Source source, Result result, String charset, int indent) { + transform(source, result, charset, indent, false); + } + + /** + * 将XML文档写出
+ * 格式化输出逻辑参考：https://stackoverflow.com/questions/139076/how-to-pretty-print-xml-from-java + * + * @param source 源 + * @param result 目标 + * @param charset 编码 + * @param indent 格式化输出中缩进量，小于1表示不格式化输出 + * @param omitXmlDeclaration 是否输出 xml Declaration + * @since 5.1.2 + */ + public static void transform(Source source, Result result, String charset, int indent, boolean omitXmlDeclaration) { + final TransformerFactory factory = TransformerFactory.newInstance(); + try { + final Transformer xformer = factory.newTransformer(); + if (indent > 0) { + xformer.setOutputProperty(OutputKeys.INDENT, "yes"); + //fix issue#1232@Github + xformer.setOutputProperty(OutputKeys.DOCTYPE_PUBLIC, "yes"); + xformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", String.valueOf(indent)); + } + if (StrUtil.isNotBlank(charset)) { + xformer.setOutputProperty(OutputKeys.ENCODING, charset); + } + if (omitXmlDeclaration) { + xformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes"); + } + xformer.transform(source, result); + } catch (Exception e) { + throw new UtilException(e, "Trans xml document to string error!"); + } + } + + // -------------------------------------------------------------------------------------- Create + + /** + * 创建XML文档
+ * 创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，即XML在转为文本的时候才定义编码 + * + * @return XML文档 + * @since 4.0.8 + */ + public static Document createXml() { + return createDocumentBuilder().newDocument(); + } + + /** + * 创建 DocumentBuilder + * + * @return DocumentBuilder + * @since 4.1.2 + */ + public static DocumentBuilder createDocumentBuilder() { + DocumentBuilder builder; + try { + builder = createDocumentBuilderFactory().newDocumentBuilder(); + } catch (Exception e) { + throw new UtilException(e, "Create xml document error!"); + } + return builder; + } + + /** + * 创建{@link DocumentBuilderFactory} + *

+ * 默认使用"com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl"
+ * 如果使用第三方实现，请调用{@link #disableDefaultDocumentBuilderFactory()} + *

+ * + * @return {@link DocumentBuilderFactory} + */ + public static DocumentBuilderFactory createDocumentBuilderFactory() { + final DocumentBuilderFactory factory; + if (StrUtil.isNotEmpty(defaultDocumentBuilderFactory)) { + factory = DocumentBuilderFactory.newInstance(defaultDocumentBuilderFactory, null); + } else { + factory = DocumentBuilderFactory.newInstance(); + } + // 默认打开NamespaceAware，getElementsByTagNameNS可以使用命名空间 + factory.setNamespaceAware(namespaceAware); + return disableXXE(factory); + } + + /** + * 创建XML文档
+ * 创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，即XML在转为文本的时候才定义编码 + * + * @param rootElementName 根节点名称 + * @return XML文档 + */ + public static Document createXml(String rootElementName) { + return createXml(rootElementName, null); + } + + /** + * 创建XML文档
+ * 创建的XML默认是utf8编码，修改编码的过程是在toStr和toFile方法里，即XML在转为文本的时候才定义编码 + * + * @param rootElementName 根节点名称 + * @param namespace 命名空间，无则传null + * @return XML文档 + * @since 5.0.4 + */ + public static Document createXml(String rootElementName, String namespace) { + final Document doc = createXml(); + doc.appendChild(null == namespace ? doc.createElement(rootElementName) : doc.createElementNS(namespace, rootElementName)); + return doc; + } + + // -------------------------------------------------------------------------------------- Function + + /** + * 获得XML文档根节点 + * + * @param doc {@link Document} + * @return 根节点 + * @see Document#getDocumentElement() + * @since 3.0.8 + */ + public static Element getRootElement(Document doc) { + return (null == doc) ? null : doc.getDocumentElement(); + } + + /** + * 获取节点所在的Document + * + * @param node 节点 + * @return {@link Document} + * @since 5.3.0 + */ + public static Document getOwnerDocument(Node node) { + return (node instanceof Document) ? (Document) node : node.getOwnerDocument(); + } + + /** + * 去除XML文本中的无效字符 + * + * @param xmlContent XML文本 + * @return 当传入为null时返回null + */ + public static String cleanInvalid(String xmlContent) { + if (xmlContent == null) { + return null; + } + return xmlContent.replaceAll(INVALID_REGEX, ""); + } + + /** + * 去除XML文本中的注释内容 + * + * @param xmlContent XML文本 + * @return 当传入为null时返回null + * @since 5.4.5 + */ + public static String cleanComment(String xmlContent) { + if (xmlContent == null) { + return null; + } + return xmlContent.replaceAll(COMMENT_REGEX, StrUtil.EMPTY); + } + + /** + * 根据节点名获得子节点列表 + * + * @param element 节点 + * @param tagName 节点名，如果节点名为空（null或blank），返回所有子节点 + * @return 节点列表 + */ + public static List getElements(Element element, String tagName) { + final NodeList nodeList = StrUtil.isBlank(tagName) ? element.getChildNodes() : element.getElementsByTagName(tagName); + return transElements(element, nodeList); + } + + /** + * 根据节点名获得第一个子节点 + * + * @param element 节点 + * @param tagName 节点名 + * @return 节点 + */ + public static Element getElement(Element element, String tagName) { + final NodeList nodeList = element.getElementsByTagName(tagName); + final int length = nodeList.getLength(); + if (length < 1) { + return null; + } + for (int i = 0; i < length; i++) { + Element childEle = (Element) nodeList.item(i); + if (childEle == null || childEle.getParentNode() == element) { + return childEle; + } + } + return null; + } + + /** + * 根据节点名获得第一个子节点 + * + * @param element 节点 + * @param tagName 节点名 + * @return 节点中的值 + */ + public static String elementText(Element element, String tagName) { + Element child = getElement(element, tagName); + return child == null ? null : child.getTextContent(); + } + + /** + * 根据节点名获得第一个子节点 + * + * @param element 节点 + * @param tagName 节点名 + * @param defaultValue 默认值 + * @return 节点中的值 + */ + public static String elementText(Element element, String tagName, String defaultValue) { + Element child = getElement(element, tagName); + return child == null ? defaultValue : child.getTextContent(); + } + + /** + * 将NodeList转换为Element列表 + * + * @param nodeList NodeList + * @return Element列表 + */ + public static List transElements(NodeList nodeList) { + return transElements(null, nodeList); + } + + /** + * 将NodeList转换为Element列表
+ * 非Element节点将被忽略 + * + * @param parentEle 父节点，如果指定将返回此节点的所有直接子节点，null返回所有就节点 + * @param nodeList NodeList + * @return Element列表 + */ + public static List transElements(Element parentEle, NodeList nodeList) { + int length = nodeList.getLength(); + final ArrayList elements = new ArrayList<>(length); + Node node; + Element element; + for (int i = 0; i < length; i++) { + node = nodeList.item(i); + if (Node.ELEMENT_NODE == node.getNodeType()) { + element = (Element) nodeList.item(i); + if (parentEle == null || element.getParentNode() == parentEle) { + elements.add(element); + } + } + } + + return elements; + } + + /** + * 将可序列化的对象转换为XML写入文件，已经存在的文件将被覆盖
+ * Writes serializable object to a XML file. Existing file will be overwritten + * + * @param dest 目标文件 + * @param bean 对象 + */ + public static void writeObjectAsXml(File dest, Object bean) { + XMLEncoder xmlenc = null; + try { + xmlenc = new XMLEncoder(FileUtil.getOutputStream(dest)); + xmlenc.writeObject(bean); + } finally { + // 关闭XMLEncoder会相应关闭OutputStream + IoUtil.close(xmlenc); + } + } + + /** + * 创建XPath
+ * Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html + * + * @return {@link XPath} + * @since 3.2.0 + */ + public static XPath createXPath() { + return XPathFactory.newInstance().newXPath(); + } + + /** + * 通过XPath方式读取XML节点等信息
+ * Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html + * + * @param expression XPath表达式 + * @param source 资源，可以是Docunent、Node节点等 + * @return 匹配返回类型的值 + * @since 4.0.9 + */ + public static Element getElementByXPath(String expression, Object source) { + return (Element) getNodeByXPath(expression, source); + } + + /** + * 通过XPath方式读取XML的NodeList
+ * Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html + * + * @param expression XPath表达式 + * @param source 资源，可以是Docunent、Node节点等 + * @return NodeList + * @since 4.0.9 + */ + public static NodeList getNodeListByXPath(String expression, Object source) { + return (NodeList) getByXPath(expression, source, XPathConstants.NODESET); + } + + /** + * 通过XPath方式读取XML节点等信息
+ * Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html + * + * @param expression XPath表达式 + * @param source 资源，可以是Docunent、Node节点等 + * @return 匹配返回类型的值 + * @since 4.0.9 + */ + public static Node getNodeByXPath(String expression, Object source) { + return (Node) getByXPath(expression, source, XPathConstants.NODE); + } + + /** + * 通过XPath方式读取XML节点等信息
+ * Xpath相关文章：https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html + * + * @param expression XPath表达式 + * @param source 资源，可以是Docunent、Node节点等 + * @param returnType 返回类型，{@link javax.xml.xpath.XPathConstants} + * @return 匹配返回类型的值 + * @since 3.2.0 + */ + public static Object getByXPath(String expression, Object source, QName returnType) { + NamespaceContext nsContext = null; + if (source instanceof Node) { + nsContext = new UniversalNamespaceCache((Node) source, false); + } + return getByXPath(expression, source, returnType, nsContext); + } + + /** + * 通过XPath方式读取XML节点等信息
+ * Xpath相关文章：
+ * https://www.ibm.com/developerworks/cn/xml/x-javaxpathapi.html
+ * https://www.ibm.com/developerworks/cn/xml/x-nmspccontext/ + * + * @param expression XPath表达式 + * @param source 资源，可以是Docunent、Node节点等 + * @param returnType 返回类型，{@link javax.xml.xpath.XPathConstants} + * @param nsContext {@link NamespaceContext} + * @return 匹配返回类型的值 + * @since 5.3.1 + */ + public static Object getByXPath(String expression, Object source, QName returnType, NamespaceContext nsContext) { + final XPath xPath = createXPath(); + if (null != nsContext) { + xPath.setNamespaceContext(nsContext); + } + try { + if (source instanceof InputSource) { + return xPath.evaluate(expression, (InputSource) source, returnType); + } else { + return xPath.evaluate(expression, source, returnType); + } + } catch (XPathExpressionException e) { + throw new UtilException(e); + } + } + + /** + * 转义XML特殊字符: + * + * 
+	 * & (ampersand) 替换为 &amp;
+	 * < (小于) 替换为 &lt;
+	 * > (大于) 替换为 &gt;
+	 * " (双引号) 替换为 &quot;
+	 *
+ * + * @param string 被替换的字符串 + * @return 替换后的字符串 + * @since 4.0.8 + */ + public static String escape(String string) { + return EscapeUtil.escapeHtml4(string); + } + + /** + * 反转义XML特殊字符: + * + * @param string 被替换的字符串 + * @return 替换后的字符串 + * @see EscapeUtil#unescape(String) + * @since 5.0.6 + */ + public static String unescape(String string) { + return EscapeUtil.unescapeHtml4(string); + } + + /** + * XML格式字符串转换为Map + * + * @param xmlStr XML字符串 + * @return XML数据转换后的Map + * @since 4.0.8 + */ + public static Map xmlToMap(String xmlStr) { + return xmlToMap(xmlStr, new HashMap<>()); + } + + /** + * XML转Java Bean + * + * @param bean类型 + * @param node XML节点 + * @param bean bean类 + * @return bean + * @see JAXBUtil#xmlToBean(String, Class) + * @since 5.2.4 + */ + public static T xmlToBean(Node node, Class bean) { + final Map map = xmlToMap(node); + if (null != map && map.size() == 1) { + final String simpleName = bean.getSimpleName(); + if (map.containsKey(simpleName)) { + // 只有key和bean的名称匹配时才做单一对象转换 + return BeanUtil.toBean(map.get(simpleName), bean); + } + } + return BeanUtil.toBean(map, bean); + } + + /** + * XML格式字符串转换为Map + * + * @param node XML节点 + * @return XML数据转换后的Map + * @since 4.0.8 + */ + public static Map xmlToMap(Node node) { + return xmlToMap(node, new HashMap<>()); + } + + /** + * XML格式字符串转换为Map
+ * 只支持第一级别的XML，不支持多级XML + * + * @param xmlStr XML字符串 + * @param result 结果Map类型 + * @return XML数据转换后的Map + * @since 4.0.8 + */ + public static Map xmlToMap(String xmlStr, Map result) { + final Document doc = parseXml(xmlStr); + final Element root = getRootElement(doc); + root.normalize(); + + return xmlToMap(root, result); + } + + /** + * XML节点转换为Map + * + * @param node XML节点 + * @param result 结果Map类型 + * @return XML数据转换后的Map + * @since 4.0.8 + */ + @SuppressWarnings("unchecked") + public static Map xmlToMap(Node node, Map result) { + if (null == result) { + result = new HashMap<>(); + } + final NodeList nodeList = node.getChildNodes(); + final int length = nodeList.getLength(); + Node childNode; + Element childEle; + for (int i = 0; i < length; ++i) { + childNode = nodeList.item(i); + if (false == isElement(childNode)) { + continue; + } + + childEle = (Element) childNode; + final Object value = result.get(childEle.getNodeName()); + Object newValue; + if (childEle.hasChildNodes()) { + // 子节点继续递归遍历 + final Map map = xmlToMap(childEle); + if (MapUtil.isNotEmpty(map)) { + newValue = map; + } else { + newValue = childEle.getTextContent(); + } + } else { + newValue = childEle.getTextContent(); + } + + + if (null != newValue) { + if (null != value) { + if (value instanceof List) { + ((List) value).add(newValue); + } else { + result.put(childEle.getNodeName(), CollUtil.newArrayList(value, newValue)); + } + } else { + result.put(childEle.getNodeName(), newValue); + } + } + } + return result; + } + + /** + * 将Map转换为XML格式的字符串 + * + * @param data Map类型数据 + * @return XML格式的字符串 + * @see JAXBUtil#beanToXml(Object) + * @since 5.1.2 + */ + public static String mapToXmlStr(Map data) { + return toStr(mapToXml(data, "xml")); + } + + /** + * 将Map转换为XML格式的字符串 + * + * @param data Map类型数据 + * @param omitXmlDeclaration 是否输出 xml Declaration + * @return XML格式的字符串 + * @see JAXBUtil#beanToXml(Object) + * @since 5.1.2 + */ + public static String mapToXmlStr(Map data, boolean omitXmlDeclaration) { + return toStr(mapToXml(data, "xml"), CharsetUtil.UTF_8, false, omitXmlDeclaration); + } + + /** + * 将Map转换为XML格式的字符串 + * + * @param data Map类型数据 + * @param rootName 根节点名 + * @return XML格式的字符串 + * @see JAXBUtil#beanToXml(Object) + * @since 4.0.8 + */ + public static String mapToXmlStr(Map data, String rootName) { + return toStr(mapToXml(data, rootName)); + } + + /** + * 将Map转换为XML格式的字符串 + * + * @param data Map类型数据 + * @param rootName 根节点名 + * @param namespace 命名空间，可以为null + * @return XML格式的字符串 + * @see JAXBUtil#beanToXml(Object) + * @since 5.0.4 + */ + public static String mapToXmlStr(Map data, String rootName, String namespace) { + return toStr(mapToXml(data, rootName, namespace)); + } + + /** + * 将Map转换为XML格式的字符串 + * + * @param data Map类型数据 + * @param rootName 根节点名 + * @param namespace 命名空间，可以为null + * @param omitXmlDeclaration 是否输出 xml Declaration + * @return XML格式的字符串 + * @see JAXBUtil#beanToXml(Object) + * @since 5.1.2 + */ + public static String mapToXmlStr(Map data, String rootName, String namespace, boolean omitXmlDeclaration) { + return toStr(mapToXml(data, rootName, namespace), CharsetUtil.UTF_8, false, omitXmlDeclaration); + } + + /** + * 将Map转换为XML格式的字符串 + * + * @param data Map类型数据 + * @param rootName 根节点名 + * @param namespace 命名空间，可以为null + * @param isPretty 是否格式化输出 + * @param omitXmlDeclaration 是否输出 xml Declaration + * @return XML格式的字符串 + * @see JAXBUtil#beanToXml(Object) + * @since 5.1.2 + */ + public static String mapToXmlStr(Map data, String rootName, String namespace, boolean isPretty, boolean omitXmlDeclaration) { + return toStr(mapToXml(data, rootName, namespace), CharsetUtil.UTF_8, isPretty, omitXmlDeclaration); + } + + /** + * 将Map转换为XML格式的字符串 + * + * @param data Map类型数据 + * @param rootName 根节点名 + * @param namespace 命名空间，可以为null + * @param charset 编码 + * @param isPretty 是否格式化输出 + * @param omitXmlDeclaration 是否输出 xml Declaration + * @return XML格式的字符串 + * @see JAXBUtil#beanToXml(Object) + * @since 5.1.2 + */ + public static String mapToXmlStr(Map data, String rootName, String namespace, String charset, boolean isPretty, boolean omitXmlDeclaration) { + return toStr(mapToXml(data, rootName, namespace), charset, isPretty, omitXmlDeclaration); + } + + /** + * 将Map转换为XML + * + * @param data Map类型数据 + * @param rootName 根节点名 + * @return XML + * @see JAXBUtil#beanToXml(Object) + * @since 4.0.9 + */ + public static Document mapToXml(Map data, String rootName) { + return mapToXml(data, rootName, null); + } + + /** + * 将Map转换为XML + * + * @param data Map类型数据 + * @param rootName 根节点名 + * @param namespace 命名空间，可以为null + * @return XML + * @see JAXBUtil#beanToXml(Object) + * @since 5.0.4 + */ + public static Document mapToXml(Map data, String rootName, String namespace) { + final Document doc = createXml(); + final Element root = appendChild(doc, rootName, namespace); + + appendMap(doc, root, data); + return doc; + } + + /** + * 将Bean转换为XML + * + * @param bean Bean对象 + * @return XML + * @see JAXBUtil#beanToXml(Object) + * @since 5.3.4 + */ + public static Document beanToXml(Object bean) { + return beanToXml(bean, null); + } + + /** + * 将Bean转换为XML + * + * @param bean Bean对象 + * @param namespace 命名空间，可以为null + * @return XML + * @see JAXBUtil#beanToXml(Object) + * @since 5.2.4 + */ + public static Document beanToXml(Object bean, String namespace) { + return beanToXml(bean, namespace, false); + } + + /** + * 将Bean转换为XML + * + * @param bean Bean对象 + * @param namespace 命名空间，可以为null + * @param ignoreNull 忽略值为{@code null}的属性 + * @return XML + * @see JAXBUtil#beanToXml(Object) + * @since 5.7.10 + */ + public static Document beanToXml(Object bean, String namespace, boolean ignoreNull) { + if (null == bean) { + return null; + } + return mapToXml(BeanUtil.beanToMap(bean, false, ignoreNull), + bean.getClass().getSimpleName(), namespace); + } + + /** + * 给定节点是否为{@link Element} 类型节点 + * + * @param node 节点 + * @return 是否为{@link Element} 类型节点 + * @since 4.0.8 + */ + public static boolean isElement(Node node) { + return (null != node) && Node.ELEMENT_NODE == node.getNodeType(); + } + + /** + * 在已有节点上创建子节点 + * + * @param node 节点 + * @param tagName 标签名 + * @return 子节点 + * @since 4.0.9 + */ + public static Element appendChild(Node node, String tagName) { + return appendChild(node, tagName, null); + } + + /** + * 在已有节点上创建子节点 + * + * @param node 节点 + * @param tagName 标签名 + * @param namespace 命名空间，无传null + * @return 子节点 + * @since 5.0.4 + */ + public static Element appendChild(Node node, String tagName, String namespace) { + final Document doc = getOwnerDocument(node); + final Element child = (null == namespace) ? doc.createElement(tagName) : doc.createElementNS(namespace, tagName); + node.appendChild(child); + return child; + } + + /** + * 创建文本子节点 + * + * @param node 节点 + * @param text 文本 + * @return 子节点 + * @since 5.3.0 + */ + public static Node appendText(Node node, CharSequence text) { + return appendText(getOwnerDocument(node), node, text); + } + + /** + * 追加数据子节点，可以是Map、集合、文本 + * + * @param node 节点 + * @param data 数据 + * @since 5.7.10 + */ + public static void append(Node node, Object data) { + append(getOwnerDocument(node), node, data); + } + // ---------------------------------------------------------------------------------------- Private method start + + /** + * 追加数据子节点，可以是Map、集合、文本 + * + * @param doc {@link Document} + * @param node 节点 + * @param data 数据 + */ + @SuppressWarnings("rawtypes") + private static void append(Document doc, Node node, Object data) { + if (data instanceof Map) { + // 如果值依旧为map，递归继续 + appendMap(doc, node, (Map) data); + } else if (data instanceof Iterator) { + // 如果值依旧为map，递归继续 + appendIterator(doc, node, (Iterator) data); + } else if (data instanceof Iterable) { + // 如果值依旧为map，递归继续 + appendIterator(doc, node, ((Iterable) data).iterator()); + } else { + appendText(doc, node, data.toString()); + } + } + + /** + * 追加Map数据子节点 + * + * @param doc {@link Document} + * @param node 当前节点 + * @param data Map类型数据 + * @since 4.0.8 + */ + @SuppressWarnings({"rawtypes", "unchecked"}) + private static void appendMap(Document doc, Node node, Map data) { + data.forEach((key, value) -> { + if (null != key) { + final Element child = appendChild(node, key.toString()); + if (null != value) { + append(doc, child, value); + } + } + }); + } + + /** + * 追加集合节点 + * + * @param doc {@link Document} + * @param node 节点 + * @param data 数据 + */ + @SuppressWarnings("rawtypes") + private static void appendIterator(Document doc, Node node, Iterator data) { + final Node parentNode = node.getParentNode(); + boolean isFirst = true; + Object eleData; + while (data.hasNext()) { + eleData = data.next(); + if (isFirst) { + append(doc, node, eleData); + isFirst = false; + } else { + final Node cloneNode = node.cloneNode(false); + parentNode.appendChild(cloneNode); + append(doc, cloneNode, eleData); + } + } + } + + /** + * 追加文本节点 + * + * @param doc {@link Document} + * @param node 节点 + * @param text 文本内容 + * @return 增加的子节点，即Text节点 + * @since 5.3.0 + */ + private static Node appendText(Document doc, Node node, CharSequence text) { + return node.appendChild(doc.createTextNode(StrUtil.str(text))); + } + + /** + * 关闭XXE，避免漏洞攻击
+ * see: https://www.owasp.org/index.php/XML_External_Entity_(XXE)_Prevention_Cheat_Sheet#JAXP_DocumentBuilderFactory.2C_SAXParserFactory_and_DOM4J + * + * @param dbf DocumentBuilderFactory + * @return DocumentBuilderFactory + */ + private static DocumentBuilderFactory disableXXE(DocumentBuilderFactory dbf) { + String feature; + try { + // This is the PRIMARY defense. If DTDs (doctypes) are disallowed, almost all XML entity attacks are prevented + // Xerces 2 only - http://xerces.apache.org/xerces2-j/features.html#disallow-doctype-decl + feature = "http://apache.org/xml/features/disallow-doctype-decl"; + dbf.setFeature(feature, true); + // If you can't completely disable DTDs, then at least do the following: + // Xerces 1 - http://xerces.apache.org/xerces-j/features.html#external-general-entities + // Xerces 2 - http://xerces.apache.org/xerces2-j/features.html#external-general-entities + // JDK7+ - http://xml.org/sax/features/external-general-entities + feature = "http://xml.org/sax/features/external-general-entities"; + dbf.setFeature(feature, false); + // Xerces 1 - http://xerces.apache.org/xerces-j/features.html#external-parameter-entities + // Xerces 2 - http://xerces.apache.org/xerces2-j/features.html#external-parameter-entities + // JDK7+ - http://xml.org/sax/features/external-parameter-entities + feature = "http://xml.org/sax/features/external-parameter-entities"; + dbf.setFeature(feature, false); + // Disable external DTDs as well + feature = "http://apache.org/xml/features/nonvalidating/load-external-dtd"; + dbf.setFeature(feature, false); + // and these as well, per Timothy Morgan's 2014 paper: "XML Schema, DTD, and Entity Attacks" + dbf.setXIncludeAware(false); + dbf.setExpandEntityReferences(false); + } catch (ParserConfigurationException e) { + // ignore + } + return dbf; + } + + /** + * 全局命名空间上下文
+ * 见：https://www.ibm.com/developerworks/cn/xml/x-nmspccontext/ + */ + public static class UniversalNamespaceCache implements NamespaceContext { + private static final String DEFAULT_NS = "DEFAULT"; + private final BiMap prefixUri = new BiMap<>(new HashMap<>()); + + /** + * This constructor parses the document and stores all namespaces it can + * find. If toplevelOnly is true, only namespaces in the root are used. + * + * @param node source Node + * @param toplevelOnly restriction of the search to enhance performance + */ + public UniversalNamespaceCache(Node node, boolean toplevelOnly) { + examineNode(node.getFirstChild(), toplevelOnly); + } + + /** + * A single node is read, the namespace attributes are extracted and stored. + * + * @param node to examine + * @param attributesOnly, if true no recursion happens + */ + private void examineNode(Node node, boolean attributesOnly) { + final NamedNodeMap attributes = node.getAttributes(); + //noinspection ConstantConditions + if (null != attributes) { + final int length = attributes.getLength(); + for (int i = 0; i < length; i++) { + Node attribute = attributes.item(i); + storeAttribute(attribute); + } + } + + if (false == attributesOnly) { + final NodeList childNodes = node.getChildNodes(); + //noinspection ConstantConditions + if(null != childNodes){ + Node item; + final int childLength = childNodes.getLength(); + for (int i = 0; i < childLength; i++) { + item = childNodes.item(i); + if (item.getNodeType() == Node.ELEMENT_NODE) + examineNode(item, false); + } + } + } + } + + /** + * This method looks at an attribute and stores it, if it is a namespace + * attribute. + * + * @param attribute to examine + */ + private void storeAttribute(Node attribute) { + if (null == attribute) { + return; + } + // examine the attributes in namespace xmlns + if (XMLConstants.XMLNS_ATTRIBUTE_NS_URI.equals(attribute.getNamespaceURI())) { + // Default namespace xmlns="uri goes here" + if (XMLConstants.XMLNS_ATTRIBUTE.equals(attribute.getNodeName())) { + prefixUri.put(DEFAULT_NS, attribute.getNodeValue()); + } else { + // The defined prefixes are stored here + prefixUri.put(attribute.getLocalName(), attribute.getNodeValue()); + } + } + + } + + /** + * This method is called by XPath. It returns the default namespace, if the + * prefix is null or "". + * + * @param prefix to search for + * @return uri + */ + @Override + public String getNamespaceURI(String prefix) { + if (prefix == null || XMLConstants.DEFAULT_NS_PREFIX.equals(prefix)) { + return prefixUri.get(DEFAULT_NS); + } else { + return prefixUri.get(prefix); + } + } + + /** + * This method is not needed in this context, but can be implemented in a + * similar way. + */ + @Override + public String getPrefix(String namespaceURI) { + return prefixUri.getInverse().get(namespaceURI); + } + + @Override + public Iterator getPrefixes(String namespaceURI) { + // Not implemented + return null; + } + + } + // ---------------------------------------------------------------------------------------- Private method end + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ZipUtil.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ZipUtil.java new file mode 100755 index 0000000..720d1c8 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/ZipUtil.java @@ -0,0 +1,1041 @@ +package aiyh.utils.tool.cn.hutool.core.util; + +import aiyh.utils.tool.cn.hutool.core.collection.EnumerationIter; +import aiyh.utils.tool.cn.hutool.core.compress.Deflate; +import aiyh.utils.tool.cn.hutool.core.compress.Gzip; +import aiyh.utils.tool.cn.hutool.core.compress.ZipCopyVisitor; +import aiyh.utils.tool.cn.hutool.core.compress.ZipReader; +import aiyh.utils.tool.cn.hutool.core.compress.ZipWriter; +import aiyh.utils.tool.cn.hutool.core.exceptions.UtilException; +import aiyh.utils.tool.cn.hutool.core.io.FastByteArrayOutputStream; +import aiyh.utils.tool.cn.hutool.core.io.FileUtil; +import aiyh.utils.tool.cn.hutool.core.io.IORuntimeException; +import aiyh.utils.tool.cn.hutool.core.io.IoUtil; +import aiyh.utils.tool.cn.hutool.core.io.LimitedInputStream; +import aiyh.utils.tool.cn.hutool.core.io.file.FileSystemUtil; +import aiyh.utils.tool.cn.hutool.core.io.file.PathUtil; +import aiyh.utils.tool.cn.hutool.core.io.resource.Resource; + +import java.io.BufferedInputStream; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.FileFilter; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.charset.Charset; +import java.nio.file.CopyOption; +import java.nio.file.FileAlreadyExistsException; +import java.nio.file.FileSystem; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.Enumeration; +import java.util.List; +import java.util.function.Consumer; +import java.util.zip.ZipEntry; +import java.util.zip.ZipFile; +import java.util.zip.ZipInputStream; +import java.util.zip.ZipOutputStream; + +/** + * 压缩工具类 + * + * @author Looly + * @see aiyh.utils.tool.cn.hutool.core.compress.ZipWriter + */ +public class ZipUtil { + + private static final int DEFAULT_BYTE_ARRAY_LENGTH = 32; + + /** + * 默认编码，使用平台相关编码 + */ + private static final Charset DEFAULT_CHARSET = CharsetUtil.defaultCharset(); + + /** + * 将Zip文件转换为{@link ZipFile} + * + * @param file zip文件 + * @param charset 解析zip文件的编码，null表示{@link CharsetUtil#CHARSET_UTF_8} + * @return {@link ZipFile} + */ + public static ZipFile toZipFile(File file, Charset charset) { + try { + return new ZipFile(file, ObjectUtil.defaultIfNull(charset, CharsetUtil.CHARSET_UTF_8)); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 获取指定{@link ZipEntry}的流，用于读取这个entry的内容
+ * 此处使用{@link LimitedInputStream} 限制最大写出大小，避免ZIP bomb漏洞 + * + * @param zipFile {@link ZipFile} + * @param zipEntry {@link ZipEntry} + * @return 流 + * @since 5.5.2 + */ + public static InputStream getStream(ZipFile zipFile, ZipEntry zipEntry) { + try { + return new LimitedInputStream(zipFile.getInputStream(zipEntry), zipEntry.getSize()); + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 获得 {@link ZipOutputStream} + * + * @param out 压缩文件流 + * @param charset 编码 + * @return {@link ZipOutputStream} + * @since 5.8.0 + */ + public static ZipOutputStream getZipOutputStream(OutputStream out, Charset charset) { + if (out instanceof ZipOutputStream) { + return (ZipOutputStream) out; + } + return new ZipOutputStream(out, charset); + } + + /** + * 在zip文件中添加新文件或目录
+ * 新文件添加在zip根目录，文件夹包括其本身和内容
+ * 如果待添加文件夹是系统根路径（如/或c:/），则只复制文件夹下的内容 + * + * @param zipPath zip文件的Path + * @param appendFilePath 待添加文件Path(可以是文件夹) + * @param options 拷贝选项，可选是否覆盖等 + * @throws IORuntimeException IO异常 + * @since 5.7.15 + */ + public static void append(Path zipPath, Path appendFilePath, CopyOption... options) throws IORuntimeException { + try (FileSystem zipFileSystem = FileSystemUtil.createZip(zipPath.toString())) { + if (Files.isDirectory(appendFilePath)) { + Path source = appendFilePath.getParent(); + if (null == source) { + // 如果用户提供的是根路径，则不复制目录，直接复制目录下的内容 + source = appendFilePath; + } + Files.walkFileTree(appendFilePath, new ZipCopyVisitor(source, zipFileSystem, options)); + } else { + Files.copy(appendFilePath, zipFileSystem.getPath(PathUtil.getName(appendFilePath)), options); + } + } catch (FileAlreadyExistsException ignored) { + // 不覆盖情况下，文件已存在, 跳过 + } catch (IOException e) { + throw new IORuntimeException(e); + } + } + + /** + * 打包到当前目录，使用默认编码UTF-8 + * + * @param srcPath 源文件路径 + * @return 打包好的压缩文件 + * @throws UtilException IO异常 + */ + public static File zip(String srcPath) throws UtilException { + return zip(srcPath, DEFAULT_CHARSET); + } + + /** + * 打包到当前目录 + * + * @param srcPath 源文件路径 + * @param charset 编码 + * @return 打包好的压缩文件 + * @throws UtilException IO异常 + */ + public static File zip(String srcPath, Charset charset) throws UtilException { + return zip(FileUtil.file(srcPath), charset); + } + + /** + * 打包到当前目录，使用默认编码UTF-8 + * + * @param srcFile 源文件或目录 + * @return 打包好的压缩文件 + * @throws UtilException IO异常 + */ + public static File zip(File srcFile) throws UtilException { + return zip(srcFile, DEFAULT_CHARSET); + } + + /** + * 打包到当前目录 + * + * @param srcFile 源文件或目录 + * @param charset 编码 + * @return 打包好的压缩文件 + * @throws UtilException IO异常 + */ + public static File zip(File srcFile, Charset charset) throws UtilException { + final File zipFile = FileUtil.file(srcFile.getParentFile(), FileUtil.mainName(srcFile) + ".zip"); + zip(zipFile, charset, false, srcFile); + return zipFile; + } + + /** + * 对文件或文件目录进行压缩
+ * 不包含被打包目录 + * + * @param srcPath 要压缩的源文件路径。如果压缩一个文件，则为该文件的全路径；如果压缩一个目录，则为该目录的顶层目录路径 + * @param zipPath 压缩文件保存的路径，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @return 压缩好的Zip文件 + * @throws UtilException IO异常 + */ + public static File zip(String srcPath, String zipPath) throws UtilException { + return zip(srcPath, zipPath, false); + } + + /** + * 对文件或文件目录进行压缩
+ * + * @param srcPath 要压缩的源文件路径。如果压缩一个文件，则为该文件的全路径；如果压缩一个目录，则为该目录的顶层目录路径 + * @param zipPath 压缩文件保存的路径，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @param withSrcDir 是否包含被打包目录 + * @return 压缩文件 + * @throws UtilException IO异常 + */ + public static File zip(String srcPath, String zipPath, boolean withSrcDir) throws UtilException { + return zip(srcPath, zipPath, DEFAULT_CHARSET, withSrcDir); + } + + /** + * 对文件或文件目录进行压缩
+ * + * @param srcPath 要压缩的源文件路径。如果压缩一个文件，则为该文件的全路径；如果压缩一个目录，则为该目录的顶层目录路径 + * @param zipPath 压缩文件保存的路径，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @param charset 编码 + * @param withSrcDir 是否包含被打包目录 + * @return 压缩文件 + * @throws UtilException IO异常 + */ + public static File zip(String srcPath, String zipPath, Charset charset, boolean withSrcDir) throws UtilException { + final File srcFile = FileUtil.file(srcPath); + final File zipFile = FileUtil.file(zipPath); + zip(zipFile, charset, withSrcDir, srcFile); + return zipFile; + } + + /** + * 对文件或文件目录进行压缩
+ * 使用默认UTF-8编码 + * + * @param zipFile 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @param withSrcDir 是否包含被打包目录，只针对压缩目录有效。若为false，则只压缩目录下的文件或目录，为true则将本目录也压缩 + * @param srcFiles 要压缩的源文件或目录。 + * @return 压缩文件 + * @throws UtilException IO异常 + */ + public static File zip(File zipFile, boolean withSrcDir, File... srcFiles) throws UtilException { + return zip(zipFile, DEFAULT_CHARSET, withSrcDir, srcFiles); + } + + /** + * 对文件或文件目录进行压缩 + * + * @param zipFile 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @param charset 编码 + * @param withSrcDir 是否包含被打包目录，只针对压缩目录有效。若为false，则只压缩目录下的文件或目录，为true则将本目录也压缩 + * @param srcFiles 要压缩的源文件或目录。如果压缩一个文件，则为该文件的全路径；如果压缩一个目录，则为该目录的顶层目录路径 + * @return 压缩文件 + * @throws UtilException IO异常 + */ + public static File zip(File zipFile, Charset charset, boolean withSrcDir, File... srcFiles) throws UtilException { + return zip(zipFile, charset, withSrcDir, null, srcFiles); + } + + /** + * 对文件或文件目录进行压缩 + * + * @param zipFile 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @param charset 编码 + * @param withSrcDir 是否包含被打包目录，只针对压缩目录有效。若为false，则只压缩目录下的文件或目录，为true则将本目录也压缩 + * @param filter 文件过滤器，通过实现此接口，自定义要过滤的文件（过滤掉哪些文件或文件夹不加入压缩） + * @param srcFiles 要压缩的源文件或目录。如果压缩一个文件，则为该文件的全路径；如果压缩一个目录，则为该目录的顶层目录路径 + * @return 压缩文件 + * @throws IORuntimeException IO异常 + * @since 4.6.5 + */ + public static File zip(File zipFile, Charset charset, boolean withSrcDir, FileFilter filter, File... srcFiles) throws IORuntimeException { + validateFiles(zipFile, srcFiles); + //noinspection resource + ZipWriter.of(zipFile, charset).add(withSrcDir, filter, srcFiles).close(); + return zipFile; + } + + /** + * 对文件或文件目录进行压缩 + * + * @param out 生成的Zip到的目标流，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @param charset 编码 + * @param withSrcDir 是否包含被打包目录，只针对压缩目录有效。若为false，则只压缩目录下的文件或目录，为true则将本目录也压缩 + * @param filter 文件过滤器，通过实现此接口，自定义要过滤的文件（过滤掉哪些文件或文件夹不加入压缩） + * @param srcFiles 要压缩的源文件或目录。如果压缩一个文件，则为该文件的全路径；如果压缩一个目录，则为该目录的顶层目录路径 + * @throws IORuntimeException IO异常 + * @since 5.1.1 + */ + public static void zip(OutputStream out, Charset charset, boolean withSrcDir, FileFilter filter, File... srcFiles) throws IORuntimeException { + ZipWriter.of(out, charset).add(withSrcDir, filter, srcFiles).close(); + } + + /** + * 对文件或文件目录进行压缩 + * + * @param zipOutputStream 生成的Zip到的目标流，自动关闭此流 + * @param withSrcDir 是否包含被打包目录，只针对压缩目录有效。若为false，则只压缩目录下的文件或目录，为true则将本目录也压缩 + * @param filter 文件过滤器，通过实现此接口，自定义要过滤的文件（过滤掉哪些文件或文件夹不加入压缩） + * @param srcFiles 要压缩的源文件或目录。如果压缩一个文件，则为该文件的全路径；如果压缩一个目录，则为该目录的顶层目录路径 + * @throws IORuntimeException IO异常 + * @since 5.1.1 + * @deprecated 请使用 {@link #zip(OutputStream, Charset, boolean, FileFilter, File...)} + */ + @Deprecated + public static void zip(ZipOutputStream zipOutputStream, boolean withSrcDir, FileFilter filter, File... srcFiles) throws IORuntimeException { + try (final ZipWriter zipWriter = new ZipWriter(zipOutputStream)) { + zipWriter.add(withSrcDir, filter, srcFiles); + } + } + + /** + * 对流中的数据加入到压缩文件，使用默认UTF-8编码 + * + * @param zipFile 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @param path 流数据在压缩文件中的路径或文件名 + * @param data 要压缩的数据 + * @return 压缩文件 + * @throws UtilException IO异常 + * @since 3.0.6 + */ + public static File zip(File zipFile, String path, String data) throws UtilException { + return zip(zipFile, path, data, DEFAULT_CHARSET); + } + + /** + * 对流中的数据加入到压缩文件
+ * + * @param zipFile 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @param path 流数据在压缩文件中的路径或文件名 + * @param data 要压缩的数据 + * @param charset 编码 + * @return 压缩文件 + * @throws UtilException IO异常 + * @since 3.2.2 + */ + public static File zip(File zipFile, String path, String data, Charset charset) throws UtilException { + return zip(zipFile, path, IoUtil.toStream(data, charset), charset); + } + + /** + * 对流中的数据加入到压缩文件
+ * 使用默认编码UTF-8 + * + * @param zipFile 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @param path 流数据在压缩文件中的路径或文件名 + * @param in 要压缩的源 + * @return 压缩文件 + * @throws UtilException IO异常 + * @since 3.0.6 + */ + public static File zip(File zipFile, String path, InputStream in) throws UtilException { + return zip(zipFile, path, in, DEFAULT_CHARSET); + } + + /** + * 对流中的数据加入到压缩文件 + * + * @param zipFile 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @param path 流数据在压缩文件中的路径或文件名 + * @param in 要压缩的源，默认关闭 + * @param charset 编码 + * @return 压缩文件 + * @throws UtilException IO异常 + * @since 3.2.2 + */ + public static File zip(File zipFile, String path, InputStream in, Charset charset) throws UtilException { + return zip(zipFile, new String[]{path}, new InputStream[]{in}, charset); + } + + /** + * 对流中的数据加入到压缩文件
+ * 路径列表和流列表长度必须一致 + * + * @param zipFile 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @param paths 流数据在压缩文件中的路径或文件名 + * @param ins 要压缩的源，添加完成后自动关闭流 + * @return 压缩文件 + * @throws UtilException IO异常 + * @since 3.0.9 + */ + public static File zip(File zipFile, String[] paths, InputStream[] ins) throws UtilException { + return zip(zipFile, paths, ins, DEFAULT_CHARSET); + } + + /** + * 对流中的数据加入到压缩文件
+ * 路径列表和流列表长度必须一致 + * + * @param zipFile 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @param paths 流数据在压缩文件中的路径或文件名 + * @param ins 要压缩的源，添加完成后自动关闭流 + * @param charset 编码 + * @return 压缩文件 + * @throws UtilException IO异常 + * @since 3.0.9 + */ + public static File zip(File zipFile, String[] paths, InputStream[] ins, Charset charset) throws UtilException { + try (final ZipWriter zipWriter = ZipWriter.of(zipFile, charset)) { + zipWriter.add(paths, ins); + } + + return zipFile; + } + + /** + * 将文件流压缩到目标流中 + * + * @param out 目标流，压缩完成自动关闭 + * @param paths 流数据在压缩文件中的路径或文件名 + * @param ins 要压缩的源，添加完成后自动关闭流 + * @since 5.5.2 + */ + public static void zip(OutputStream out, String[] paths, InputStream[] ins) { + zip(getZipOutputStream(out, DEFAULT_CHARSET), paths, ins); + } + + /** + * 将文件流压缩到目标流中 + * + * @param zipOutputStream 目标流，压缩完成自动关闭 + * @param paths 流数据在压缩文件中的路径或文件名 + * @param ins 要压缩的源，添加完成后自动关闭流 + * @throws IORuntimeException IO异常 + * @since 5.5.2 + */ + public static void zip(ZipOutputStream zipOutputStream, String[] paths, InputStream[] ins) throws IORuntimeException { + try (final ZipWriter zipWriter = new ZipWriter(zipOutputStream)) { + zipWriter.add(paths, ins); + } + } + + /** + * 对流中的数据加入到压缩文件
+ * 路径列表和流列表长度必须一致 + * + * @param zipFile 生成的Zip文件，包括文件名。注意：zipPath不能是srcPath路径下的子文件夹 + * @param charset 编码 + * @param resources 需要压缩的资源，资源的路径为{@link Resource#getName()} + * @return 压缩文件 + * @throws UtilException IO异常 + * @since 5.5.2 + */ + public static File zip(File zipFile, Charset charset, Resource... resources) throws UtilException { + //noinspection resource + ZipWriter.of(zipFile, charset).add(resources).close(); + return zipFile; + } + + // ---------------------------------------------------------------------------------------------- Unzip + + /** + * 解压到文件名相同的目录中，默认编码UTF-8 + * + * @param zipFilePath 压缩文件路径 + * @return 解压的目录 + * @throws UtilException IO异常 + */ + public static File unzip(String zipFilePath) throws UtilException { + return unzip(zipFilePath, DEFAULT_CHARSET); + } + + /** + * 解压到文件名相同的目录中 + * + * @param zipFilePath 压缩文件路径 + * @param charset 编码 + * @return 解压的目录 + * @throws UtilException IO异常 + * @since 3.2.2 + */ + public static File unzip(String zipFilePath, Charset charset) throws UtilException { + return unzip(FileUtil.file(zipFilePath), charset); + } + + /** + * 解压到文件名相同的目录中，使用UTF-8编码 + * + * @param zipFile 压缩文件 + * @return 解压的目录 + * @throws UtilException IO异常 + * @since 3.2.2 + */ + public static File unzip(File zipFile) throws UtilException { + return unzip(zipFile, DEFAULT_CHARSET); + } + + /** + * 解压到文件名相同的目录中 + * + * @param zipFile 压缩文件 + * @param charset 编码 + * @return 解压的目录 + * @throws UtilException IO异常 + * @since 3.2.2 + */ + public static File unzip(File zipFile, Charset charset) throws UtilException { + final File destDir = FileUtil.file(zipFile.getParentFile(), FileUtil.mainName(zipFile)); + return unzip(zipFile, destDir, charset); + } + + /** + * 解压，默认UTF-8编码 + * + * @param zipFilePath 压缩文件的路径 + * @param outFileDir 解压到的目录 + * @return 解压的目录 + * @throws UtilException IO异常 + */ + public static File unzip(String zipFilePath, String outFileDir) throws UtilException { + return unzip(zipFilePath, outFileDir, DEFAULT_CHARSET); + } + + /** + * 解压 + * + * @param zipFilePath 压缩文件的路径 + * @param outFileDir 解压到的目录 + * @param charset 编码 + * @return 解压的目录 + * @throws UtilException IO异常 + */ + public static File unzip(String zipFilePath, String outFileDir, Charset charset) throws UtilException { + return unzip(FileUtil.file(zipFilePath), FileUtil.mkdir(outFileDir), charset); + } + + /** + * 解压，默认使用UTF-8编码 + * + * @param zipFile zip文件 + * @param outFile 解压到的目录 + * @return 解压的目录 + * @throws UtilException IO异常 + */ + public static File unzip(File zipFile, File outFile) throws UtilException { + return unzip(zipFile, outFile, DEFAULT_CHARSET); + } + + /** + * 解压 + * + * @param zipFile zip文件 + * @param outFile 解压到的目录 + * @param charset 编码 + * @return 解压的目录 + * @since 3.2.2 + */ + public static File unzip(File zipFile, File outFile, Charset charset) { + return unzip(toZipFile(zipFile, charset), outFile); + } + + /** + * 解压 + * + * @param zipFile zip文件，附带编码信息，使用完毕自动关闭 + * @param outFile 解压到的目录 + * @return 解压的目录 + * @throws IORuntimeException IO异常 + * @since 4.5.8 + */ + public static File unzip(ZipFile zipFile, File outFile) throws IORuntimeException { + return unzip(zipFile, outFile, -1); + } + + /** + * 限制解压后文件大小 + * + * @param zipFile zip文件，附带编码信息，使用完毕自动关闭 + * @param outFile 解压到的目录 + * @param limit 限制解压文件大小(单位B) + * @return 解压的目录 + * @throws IORuntimeException IO异常 + * @since 5.8.5 + */ + public static File unzip(ZipFile zipFile, File outFile, long limit) throws IORuntimeException { + if (outFile.exists() && outFile.isFile()) { + throw new IllegalArgumentException( + StrUtil.format("Target path [{}] exist!", outFile.getAbsolutePath())); + } + + // pr#726@Gitee + if (limit > 0) { + final Enumeration zipEntries = zipFile.entries(); + long zipFileSize = 0L; + while (zipEntries.hasMoreElements()) { + final ZipEntry zipEntry = zipEntries.nextElement(); + zipFileSize += zipEntry.getSize(); + if (zipFileSize > limit) { + throw new IllegalArgumentException("The file size exceeds the limit"); + } + } + } + + try (final ZipReader reader = new ZipReader(zipFile)) { + reader.readTo(outFile); + } + return outFile; + } + + /** + * 获取压缩包中的指定文件流 + * + * @param zipFile 压缩文件 + * @param charset 编码 + * @param path 需要提取文件的文件名或路径 + * @return 压缩文件流，如果未找到返回{@code null} + * @since 5.5.2 + */ + public static InputStream get(File zipFile, Charset charset, String path) { + return get(toZipFile(zipFile, charset), path); + } + + /** + * 获取压缩包中的指定文件流 + * + * @param zipFile 压缩文件 + * @param path 需要提取文件的文件名或路径 + * @return 压缩文件流，如果未找到返回{@code null} + * @since 5.5.2 + */ + public static InputStream get(ZipFile zipFile, String path) { + final ZipEntry entry = zipFile.getEntry(path); + if (null != entry) { + return getStream(zipFile, entry); + } + return null; + } + + /** + * 读取并处理Zip文件中的每一个{@link ZipEntry} + * + * @param zipFile Zip文件 + * @param consumer {@link ZipEntry}处理器 + * @since 5.5.2 + */ + public static void read(ZipFile zipFile, Consumer consumer) { + try (final ZipReader reader = new ZipReader(zipFile)) { + reader.read(consumer); + } + } + + /** + * 解压
+ * ZIP条目不使用高速缓冲。 + * + * @param in zip文件流，使用完毕自动关闭 + * @param outFile 解压到的目录 + * @param charset 编码 + * @return 解压的目录 + * @throws UtilException IO异常 + * @since 4.5.8 + */ + public static File unzip(InputStream in, File outFile, Charset charset) throws UtilException { + if (null == charset) { + charset = DEFAULT_CHARSET; + } + return unzip(new ZipInputStream(in, charset), outFile); + } + + /** + * 解压
+ * ZIP条目不使用高速缓冲。 + * + * @param zipStream zip文件流，包含编码信息 + * @param outFile 解压到的目录 + * @return 解压的目录 + * @throws UtilException IO异常 + * @since 4.5.8 + */ + public static File unzip(ZipInputStream zipStream, File outFile) throws UtilException { + try (final ZipReader reader = new ZipReader(zipStream)) { + reader.readTo(outFile); + } + return outFile; + } + + /** + * 读取并处理Zip流中的每一个{@link ZipEntry} + * + * @param zipStream zip文件流，包含编码信息 + * @param consumer {@link ZipEntry}处理器 + * @since 5.5.2 + */ + public static void read(ZipInputStream zipStream, Consumer consumer) { + try (final ZipReader reader = new ZipReader(zipStream)) { + reader.read(consumer); + } + } + + /** + * 从Zip文件中提取指定的文件为bytes + * + * @param zipFilePath Zip文件 + * @param name 文件名，如果存在于子文件夹中，此文件名必须包含目录名，例如images/aaa.txt + * @return 文件内容bytes + * @since 4.1.8 + */ + public static byte[] unzipFileBytes(String zipFilePath, String name) { + return unzipFileBytes(zipFilePath, DEFAULT_CHARSET, name); + } + + /** + * 从Zip文件中提取指定的文件为bytes + * + * @param zipFilePath Zip文件 + * @param charset 编码 + * @param name 文件名，如果存在于子文件夹中，此文件名必须包含目录名，例如images/aaa.txt + * @return 文件内容bytes + * @since 4.1.8 + */ + public static byte[] unzipFileBytes(String zipFilePath, Charset charset, String name) { + return unzipFileBytes(FileUtil.file(zipFilePath), charset, name); + } + + /** + * 从Zip文件中提取指定的文件为bytes + * + * @param zipFile Zip文件 + * @param name 文件名，如果存在于子文件夹中，此文件名必须包含目录名，例如images/aaa.txt + * @return 文件内容bytes + * @since 4.1.8 + */ + public static byte[] unzipFileBytes(File zipFile, String name) { + return unzipFileBytes(zipFile, DEFAULT_CHARSET, name); + } + + /** + * 从Zip文件中提取指定的文件为bytes + * + * @param zipFile Zip文件 + * @param charset 编码 + * @param name 文件名，如果存在于子文件夹中，此文件名必须包含目录名，例如images/aaa.txt + * @return 文件内容bytes + * @since 4.1.8 + */ + public static byte[] unzipFileBytes(File zipFile, Charset charset, String name) { + try (final ZipReader reader = ZipReader.of(zipFile, charset)) { + return IoUtil.readBytes(reader.get(name)); + } + } + + // ----------------------------------------------------------------------------- Gzip + + /** + * Gzip压缩处理 + * + * @param content 被压缩的字符串 + * @param charset 编码 + * @return 压缩后的字节流 + * @throws UtilException IO异常 + */ + public static byte[] gzip(String content, String charset) throws UtilException { + return gzip(StrUtil.bytes(content, charset)); + } + + /** + * Gzip压缩处理 + * + * @param buf 被压缩的字节流 + * @return 压缩后的字节流 + * @throws UtilException IO异常 + */ + public static byte[] gzip(byte[] buf) throws UtilException { + return gzip(new ByteArrayInputStream(buf), buf.length); + } + + /** + * Gzip压缩文件 + * + * @param file 被压缩的文件 + * @return 压缩后的字节流 + * @throws UtilException IO异常 + */ + public static byte[] gzip(File file) throws UtilException { + BufferedInputStream in = null; + try { + in = FileUtil.getInputStream(file); + return gzip(in, (int) file.length()); + } finally { + IoUtil.close(in); + } + } + + /** + * Gzip压缩文件 + * + * @param in 被压缩的流 + * @return 压缩后的字节流 + * @throws UtilException IO异常 + * @since 4.1.18 + */ + public static byte[] gzip(InputStream in) throws UtilException { + return gzip(in, DEFAULT_BYTE_ARRAY_LENGTH); + } + + /** + * Gzip压缩文件 + * + * @param in 被压缩的流 + * @param length 预估长度 + * @return 压缩后的字节流 + * @throws UtilException IO异常 + * @since 4.1.18 + */ + public static byte[] gzip(InputStream in, int length) throws UtilException { + final ByteArrayOutputStream bos = new ByteArrayOutputStream(length); + Gzip.of(in, bos).gzip().close(); + return bos.toByteArray(); + } + + /** + * Gzip解压缩处理 + * + * @param buf 压缩过的字节流 + * @param charset 编码 + * @return 解压后的字符串 + * @throws UtilException IO异常 + */ + public static String unGzip(byte[] buf, String charset) throws UtilException { + return StrUtil.str(unGzip(buf), charset); + } + + /** + * Gzip解压处理 + * + * @param buf buf + * @return bytes + * @throws UtilException IO异常 + */ + public static byte[] unGzip(byte[] buf) throws UtilException { + return unGzip(new ByteArrayInputStream(buf), buf.length); + } + + /** + * Gzip解压处理 + * + * @param in Gzip数据 + * @return 解压后的数据 + * @throws UtilException IO异常 + */ + public static byte[] unGzip(InputStream in) throws UtilException { + return unGzip(in, DEFAULT_BYTE_ARRAY_LENGTH); + } + + /** + * Gzip解压处理 + * + * @param in Gzip数据 + * @param length 估算长度，如果无法确定请传入{@link #DEFAULT_BYTE_ARRAY_LENGTH} + * @return 解压后的数据 + * @throws UtilException IO异常 + * @since 4.1.18 + */ + public static byte[] unGzip(InputStream in, int length) throws UtilException { + FastByteArrayOutputStream bos = new FastByteArrayOutputStream(length); + Gzip.of(in, bos).unGzip().close(); + return bos.toByteArray(); + } + + // ----------------------------------------------------------------------------- Zlib + + /** + * Zlib压缩处理 + * + * @param content 被压缩的字符串 + * @param charset 编码 + * @param level 压缩级别，1~9 + * @return 压缩后的字节流 + * @since 4.1.4 + */ + public static byte[] zlib(String content, String charset, int level) { + return zlib(StrUtil.bytes(content, charset), level); + } + + /** + * Zlib压缩文件 + * + * @param file 被压缩的文件 + * @param level 压缩级别 + * @return 压缩后的字节流 + * @since 4.1.4 + */ + public static byte[] zlib(File file, int level) { + BufferedInputStream in = null; + try { + in = FileUtil.getInputStream(file); + return zlib(in, level, (int) file.length()); + } finally { + IoUtil.close(in); + } + } + + /** + * 打成Zlib压缩包 + * + * @param buf 数据 + * @param level 压缩级别，0~9 + * @return 压缩后的bytes + * @since 4.1.4 + */ + public static byte[] zlib(byte[] buf, int level) { + return zlib(new ByteArrayInputStream(buf), level, buf.length); + } + + /** + * 打成Zlib压缩包 + * + * @param in 数据流 + * @param level 压缩级别，0~9 + * @return 压缩后的bytes + * @since 4.1.19 + */ + public static byte[] zlib(InputStream in, int level) { + return zlib(in, level, DEFAULT_BYTE_ARRAY_LENGTH); + } + + /** + * 打成Zlib压缩包 + * + * @param in 数据流 + * @param level 压缩级别，0~9 + * @param length 预估大小 + * @return 压缩后的bytes + * @since 4.1.19 + */ + public static byte[] zlib(InputStream in, int level, int length) { + final ByteArrayOutputStream out = new ByteArrayOutputStream(length); + Deflate.of(in, out, false).deflater(level); + return out.toByteArray(); + } + + /** + * Zlib解压缩处理 + * + * @param buf 压缩过的字节流 + * @param charset 编码 + * @return 解压后的字符串 + * @since 4.1.4 + */ + public static String unZlib(byte[] buf, String charset) { + return StrUtil.str(unZlib(buf), charset); + } + + /** + * 解压缩zlib + * + * @param buf 数据 + * @return 解压后的bytes + * @since 4.1.4 + */ + public static byte[] unZlib(byte[] buf) { + return unZlib(new ByteArrayInputStream(buf), buf.length); + } + + /** + * 解压缩zlib + * + * @param in 数据流 + * @return 解压后的bytes + * @since 4.1.19 + */ + public static byte[] unZlib(InputStream in) { + return unZlib(in, DEFAULT_BYTE_ARRAY_LENGTH); + } + + /** + * 解压缩zlib + * + * @param in 数据流 + * @param length 预估长度 + * @return 解压后的bytes + * @since 4.1.19 + */ + public static byte[] unZlib(InputStream in, int length) { + final ByteArrayOutputStream out = new ByteArrayOutputStream(length); + Deflate.of(in, out, false).inflater(); + return out.toByteArray(); + } + + /** + * 获取Zip文件中指定目录下的所有文件，只显示文件，不显示目录
+ * 此方法并不会关闭{@link ZipFile}。 + * + * @param zipFile Zip文件 + * @param dir 目录前缀（目录前缀不包含开头的/） + * @return 文件列表 + * @since 4.6.6 + */ + public static List listFileNames(ZipFile zipFile, String dir) { + if (StrUtil.isNotBlank(dir)) { + // 目录尾部添加"/" + dir = StrUtil.addSuffixIfNot(dir, StrUtil.SLASH); + } + + final List fileNames = new ArrayList<>(); + String name; + for (ZipEntry entry : new EnumerationIter<>(zipFile.entries())) { + name = entry.getName(); + if (StrUtil.isEmpty(dir) || name.startsWith(dir)) { + final String nameSuffix = StrUtil.removePrefix(name, dir); + if (StrUtil.isNotEmpty(nameSuffix) && false == StrUtil.contains(nameSuffix, CharUtil.SLASH)) { + fileNames.add(nameSuffix); + } + } + } + + return fileNames; + } + + // ---------------------------------------------------------------------------------------------- Private method start + + /** + * 判断压缩文件保存的路径是否为源文件路径的子文件夹，如果是，则抛出异常（防止无限递归压缩的发生） + * + * @param zipFile 压缩后的产生的文件路径 + * @param srcFiles 被压缩的文件或目录 + */ + private static void validateFiles(File zipFile, File... srcFiles) throws UtilException { + if (zipFile.isDirectory()) { + throw new UtilException("Zip file [{}] must not be a directory !", zipFile.getAbsoluteFile()); + } + + for (File srcFile : srcFiles) { + if (null == srcFile) { + continue; + } + if (false == srcFile.exists()) { + throw new UtilException(StrUtil.format("File [{}] not exist!", srcFile.getAbsolutePath())); + } + + // issue#1961@Github + // 当 zipFile = new File("temp.zip") 时, zipFile.getParentFile() == null + File parentFile; + try { + parentFile = zipFile.getCanonicalFile().getParentFile(); + } catch (IOException e) { + parentFile = zipFile.getParentFile(); + } + + // 压缩文件不能位于被压缩的目录内 + if (srcFile.isDirectory() && FileUtil.isSub(srcFile, parentFile)) { + throw new UtilException("Zip file path [{}] must not be the child directory of [{}] !", zipFile.getPath(), srcFile.getPath()); + } + } + } + // ---------------------------------------------------------------------------------------------- Private method end + +} diff --git a/src/main/java/aiyh/utils/tool/cn/hutool/core/util/package-info.java b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/package-info.java new file mode 100644 index 0000000..a3a07f4 --- /dev/null +++ b/src/main/java/aiyh/utils/tool/cn/hutool/core/util/package-info.java @@ -0,0 +1,7 @@ +/** + * 提供各种工具方法，按照归类入口为XXXUtil，如字符串工具StrUtil等 + * + * @author looly + * + */ +package aiyh.utils.tool.cn.hutool.core.util; diff --git a/src/main/java/com/api/xuanran/wang/shyl/controller/BatchCreateWorkFlowController.java b/src/main/java/com/api/xuanran/wang/shyl/controller/BatchCreateWorkFlowController.java new file mode 100644 index 0000000..3c0791d --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/controller/BatchCreateWorkFlowController.java @@ -0,0 +1,91 @@ +package com.api.xuanran.wang.shyl.controller; + +import aiyh.utils.ApiResult; +import aiyh.utils.Util; +import aiyh.utils.excention.CustomerException; +import com.alibaba.fastjson.JSONArray; +import com.alibaba.fastjson.JSONObject; +import com.api.xuanran.wang.shyl.service.BatchCreateWorkflowService; +import com.api.xuanran.wang.shyl.service.MeetingService; +import com.api.xuanran.wang.shyl.vo.CreateWfVO; +import com.engine.common.util.ServiceUtil; +import com.engine.workflow.publicApi.WorkflowRequestOperatePA; +import com.engine.workflow.publicApi.impl.WorkflowRequestOperatePAImpl; +import com.engine.workflow.util.CommonUtil; +import io.swagger.v3.oas.annotations.parameters.RequestBody; +import org.apache.commons.lang3.StringUtils; +import org.apache.log4j.Logger; +import weaver.hrm.User; +import weaver.xuanran.wang.common.mapper.CommonMapper; + +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import javax.ws.rs.Consumes; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.MediaType; +import java.util.List; + +/** + *

上海团校-批量创建流程接口

+ * + * @author xuanran.wang + * @date 2023/2/22 13:51 + */ +@Path("/wxr/shyl/workflow") +public class BatchCreateWorkFlowController { + + private final Logger log = Util.getLogger(); + + /** + *

创建流程对象

+ **/ + public static WorkflowRequestOperatePA WRO = null; + + static { + WRO = getRequestOperatePA(); + } + + private final BatchCreateWorkflowService service = new BatchCreateWorkflowService(); + + + @Path("/batchCreate") + @POST + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + public String batchCreate(@Context HttpServletRequest request, + @Context HttpServletResponse response, + @RequestBody JSONObject obj) { + User user = CommonUtil.getUserByRequest(request, response); + if(null == user){ + return ApiResult.error(500,"请先登陆!"); + } + try { + log.info("批量预约&取消接口接收参数: \n" + obj.toString()); + if(obj.isEmpty()){ + throw new CustomerException("请求体对象不能为空!"); + } + String cancelIds = Util.null2DefaultStr(obj.get("cancelIds"),""); + if(StringUtils.isNotBlank(cancelIds)){ + service.cancelMeeting(cancelIds); + } + JSONArray workflows = obj.getJSONArray("workflows"); + return ApiResult.success(service.batchCreateWorkflow(user, workflows)); + }catch (Exception e){ + log.error(Util.logStr("batchCreate error : {}", e.getMessage())); + return ApiResult.error(500,"批量创建流程接口发生异常! 异常信息 :[ " + e.getMessage() + " ]"); + } + } + + /** + *

获取创建流程对象（系统标准方法）

+ * @author xuanran.wang + * @dateTime 2023/2/22 16:53 + * @return 创建流程对象 + **/ + private static WorkflowRequestOperatePA getRequestOperatePA() { + return (WorkflowRequestOperatePAImpl) ServiceUtil.getService(WorkflowRequestOperatePAImpl.class); + } +} diff --git a/src/main/java/com/api/xuanran/wang/shyl/controller/CarToMQController.java b/src/main/java/com/api/xuanran/wang/shyl/controller/CarToMQController.java new file mode 100644 index 0000000..83032a0 --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/controller/CarToMQController.java @@ -0,0 +1,37 @@ +package com.api.xuanran.wang.shyl.controller; + +import aiyh.utils.ApiResult; +import com.api.xuanran.wang.shyl.service.CarService; + +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import javax.ws.rs.*; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.MediaType; + +/** + *

车辆信息发送到mq中

+ * + * @author xuanran.wang + * @date 2023/2/27 13:25 + */ +@Path("/wxr/shyl/car") +public class CarToMQController { + + private final CarService carService = new CarService(); + @Path("/toMq") + @GET + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + public String batchCreate(@Context HttpServletRequest request, + @Context HttpServletResponse response) { + try { + carService.sendCarToMQ(request); + return ApiResult.success(null); + }catch (Exception e){ + return ApiResult.error("车辆信息发送MQ异常 : " + e.getMessage()); + } + + } + +} diff --git a/src/main/java/com/api/xuanran/wang/shyl/controller/GetStudentsClass.java b/src/main/java/com/api/xuanran/wang/shyl/controller/GetStudentsClass.java new file mode 100644 index 0000000..10b720f --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/controller/GetStudentsClass.java @@ -0,0 +1,48 @@ +package com.api.xuanran.wang.shyl.controller; + +import aiyh.utils.ApiResult; +import aiyh.utils.Util; +import com.api.xuanran.wang.shyl.service.StudentsService; +import com.engine.workflow.util.CommonUtil; +import org.apache.log4j.Logger; +import weaver.hrm.User; + +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.MediaType; + +/** + *

+ * + * @author xuanran.wang + * @date 2023/3/1 10:56 + */ +@Path("/wxr/students") +public class GetStudentsClass { + + private final Logger log = Util.getLogger(); + + private final StudentsService studentsService = new StudentsService(); + @Path("/getStudentsByClassId") + @GET + @Produces(MediaType.TEXT_PLAIN) + public String getStudentsByClassId(@Context HttpServletRequest request, + @Context HttpServletResponse response){ + User user = CommonUtil.getUserByRequest(request, response); + if(null == user){ + return ApiResult.error(500,"请先登陆!"); + } + String id = Util.null2DefaultStr(request.getParameter("id"),""); + log.info(Util.logStr("class id : {}", id)); + try { + return ApiResult.success(studentsService.getStudentsByClassId(id)); + }catch (Exception e){ + log.error(Util.logStr("getStudentsByClassId error ! {}", e.getMessage())); + return ApiResult.error(500,"获取学员信息接口发生异常! 异常信息 :[ " + e.getMessage() + " ]"); + } + } +} diff --git a/src/main/java/com/api/xuanran/wang/shyl/controller/MeetingController.java b/src/main/java/com/api/xuanran/wang/shyl/controller/MeetingController.java new file mode 100644 index 0000000..3074b74 --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/controller/MeetingController.java @@ -0,0 +1,63 @@ +package com.api.xuanran.wang.shyl.controller; + +import aiyh.utils.ApiResult; +import aiyh.utils.Util; +import com.api.xuanran.wang.shyl.service.MeetingService; +import com.engine.workflow.util.CommonUtil; +import org.apache.log4j.Logger; +import weaver.hrm.User; + +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import javax.ws.rs.*; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.MediaType; + +/** + *

批量取消

+ * + * @author xuanran.wang + * @date 2023/2/23 18:56 + */ +@Path("/wxr/meeting") +public class MeetingController { + private final Logger log = Util.getLogger(); + private final MeetingService meetingService = new MeetingService(); + + /** + *

会议取消

+ * @author xuanran.wang + * @dateTime 2023/3/1 15:24 + **/ + @Path("/cancel") + @GET + @Produces(MediaType.TEXT_PLAIN) + public String meetingCancel(@Context HttpServletRequest request, + @Context HttpServletResponse response){ + User user = CommonUtil.getUserByRequest(request, response); + if(null == user){ + return ApiResult.error(500,"请先登陆!"); + } + String id = Util.null2DefaultStr(request.getParameter("id"),""); + log.info(Util.logStr("cancel interface id : {}", id)); + try { + meetingService.cancelMeeting(id); + return ApiResult.success(null); + }catch (Exception e){ + log.error(Util.logStr("MeetingController error ! {}", e.getMessage())); + return ApiResult.error(500,"会议取消接口发生异常! 异常信息 :[ " + e.getMessage() + " ]"); + } + } + + @Path("/cusFormConfig") + @GET + @Produces(MediaType.TEXT_PLAIN) + public String getMeetingFormConfig(@Context HttpServletRequest request, + @Context HttpServletResponse response){ + User user = CommonUtil.getUserByRequest(request, response); + if(null == user){ + return ApiResult.error(500,"请先登陆!"); + } + return ApiResult.success(meetingService.getMeetingFieldCusConfig()); + } +} diff --git a/src/main/java/com/api/xuanran/wang/shyl/entity/CusCreateWfInfo.java b/src/main/java/com/api/xuanran/wang/shyl/entity/CusCreateWfInfo.java new file mode 100644 index 0000000..6fc120f --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/entity/CusCreateWfInfo.java @@ -0,0 +1,17 @@ +package com.api.xuanran.wang.shyl.entity; +import com.engine.workflow.entity.publicApi.PAResponseEntity; +import lombok.Data; + +/** + *

创建流程对象

+ * + * @author xuanran.wang + * @date 2023/2/24 12:02 + */ +@Data +public class CusCreateWfInfo { + private PAResponseEntity paResponseEntity; + private int index; + private int workflowId; + private String customId; +} diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/entity/MQMessage.java b/src/main/java/com/api/xuanran/wang/shyl/entity/MQMessage.java similarity index 92% rename from src/main/java/weaver/xuanran/wang/shyl/mq/entity/MQMessage.java rename to src/main/java/com/api/xuanran/wang/shyl/entity/MQMessage.java index 1c005ab..6c14570 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/entity/MQMessage.java +++ b/src/main/java/com/api/xuanran/wang/shyl/entity/MQMessage.java @@ -1,4 +1,4 @@ -package weaver.xuanran.wang.shyl.mq.entity; +package com.api.xuanran.wang.shyl.entity; import lombok.Data; @@ -40,5 +40,5 @@ public class MQMessage { /** *

消息业务内容,json 格式,分业务(用户、机构、密码修改)

**/ - private String content; + private Object content; } diff --git a/src/main/java/com/api/xuanran/wang/shyl/entity/ProducerCarInfo.java b/src/main/java/com/api/xuanran/wang/shyl/entity/ProducerCarInfo.java new file mode 100644 index 0000000..2614726 --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/entity/ProducerCarInfo.java @@ -0,0 +1,111 @@ +package com.api.xuanran.wang.shyl.entity; + +import aiyh.utils.annotation.recordset.SqlDbFieldAnn; +import aiyh.utils.annotation.recordset.SqlOracleDbFieldAnn; +import com.weaverboot.frame.dao.anno.WeaSqlFrom; +import lombok.Data; +import weaver.xuanran.wang.common.annocation.Map2JSONConvert; + +import java.lang.annotation.Annotation; + +/** + *

mq生产者车辆信息

+ * + * @author xuanran.wang + * @date 2023/2/25 15:04 + */ +public class ProducerCarInfo { + @SqlDbFieldAnn("ID") + private String carCode; + @SqlOracleDbFieldAnn("DEPOSIT") + private String status; + @SqlOracleDbFieldAnn("DRIVER") + private String driver; + @SqlOracleDbFieldAnn("USERNAME") + private String userName; + @SqlOracleDbFieldAnn("USERPHONE") + private String userPhone; + @SqlOracleDbFieldAnn("CARNO") + private String plateList; + @SqlOracleDbFieldAnn("REMARK") + private String remark; + private String identification; + + public String getCarCode() { + return carCode; + } + + public void setCarCode(String carCode) { + this.carCode = carCode; + } + + public String getStatus() { + return status; + } + + public void setStatus(String status) { + this.status = status; + } + + public String getDriver() { + return driver; + } + + public void setDriver(String driver) { + this.driver = driver; + } + + public String getUserName() { + return userName; + } + + public void setUserName(String userName) { + this.userName = userName; + } + + public String getUserPhone() { + return userPhone; + } + + public void setUserPhone(String userPhone) { + this.userPhone = userPhone; + } + + public String getPlateList() { + return plateList; + } + + public void setPlateList(String plateList) { + this.plateList = plateList; + } + + public String getRemark() { + return remark; + } + + public void setRemark(String remark) { + this.remark = remark; + } + + public String getIdentification() { + return identification; + } + + public void setIdentification(String identification) { + this.identification = identification; + } + + @Override + public String toString() { + return "ProducerCarInfo{" + + "carCode='" + carCode + '\'' + + ", status='" + status + '\'' + + ", driver='" + driver + '\'' + + ", userName='" + userName + '\'' + + ", userPhone='" + userPhone + '\'' + + ", plateList='" + plateList + '\'' + + ", remark='" + remark + '\'' + + ", identification='" + identification + '\'' + + '}'; + } +} diff --git a/src/main/java/com/api/xuanran/wang/shyl/entity/meeting/MeetingCusFieldConfigDetail.java b/src/main/java/com/api/xuanran/wang/shyl/entity/meeting/MeetingCusFieldConfigDetail.java new file mode 100644 index 0000000..495f5b0 --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/entity/meeting/MeetingCusFieldConfigDetail.java @@ -0,0 +1,18 @@ +package com.api.xuanran.wang.shyl.entity.meeting; + +import aiyh.utils.annotation.recordset.SqlOracleDbFieldAnn; +import lombok.Data; + +/** + *

会议新增字段配置表主表对象

+ * + * @author xuanran.wang + * @date 2023/3/1 15:43 + */ +@Data +public class MeetingCusFieldConfigDetail { + @SqlOracleDbFieldAnn("SELECTKEY") + private String selectKey; + @SqlOracleDbFieldAnn("SELECTSHOWNAME") + private String selectShowName; +} diff --git a/src/main/java/com/api/xuanran/wang/shyl/entity/meeting/MeetingCusFieldConfigMain.java b/src/main/java/com/api/xuanran/wang/shyl/entity/meeting/MeetingCusFieldConfigMain.java new file mode 100644 index 0000000..b8c7ce1 --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/entity/meeting/MeetingCusFieldConfigMain.java @@ -0,0 +1,23 @@ +package com.api.xuanran.wang.shyl.entity.meeting; + +import aiyh.utils.annotation.recordset.SqlOracleDbFieldAnn; +import lombok.Data; + +import java.util.List; + +/** + *

会议新增字段配置表主表对象

+ * + * @author xuanran.wang + * @date 2023/3/1 15:41 + */ +@Data +public class MeetingCusFieldConfigMain { + @SqlOracleDbFieldAnn("FIELDNAME") + private String fieldName; + @SqlOracleDbFieldAnn("FIELDTYPE") + private int fieldType; + @SqlOracleDbFieldAnn("FIELDONLYMARK") + private String fieldOnlyMark; + private List options; +} diff --git a/src/main/java/com/api/xuanran/wang/shyl/mapper/MeetingMapper.java b/src/main/java/com/api/xuanran/wang/shyl/mapper/MeetingMapper.java new file mode 100644 index 0000000..42eb115 --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/mapper/MeetingMapper.java @@ -0,0 +1,61 @@ +package com.api.xuanran.wang.shyl.mapper; + +import aiyh.utils.annotation.recordset.*; +import com.api.xuanran.wang.shyl.entity.meeting.MeetingCusFieldConfigDetail; +import com.api.xuanran.wang.shyl.entity.meeting.MeetingCusFieldConfigMain; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + *

会议模块相关

+ * + * @author xuanran.wang + * @date 2023/2/24 19:09 + */ +@SqlMapper +public interface MeetingMapper { + /** + *

查询配置表主表信息

+ * @author xuanran.wang + * @dateTime 2023/3/1 16:39 + * @return 主表配置对象 + **/ + @Select("select * from uf_meetFieldConfig where enable = 0") + @CollectionMappings({ + @CollectionMapping(property = "options", + column = "id", + id = @Id(value = Integer.class, methodId = 1)) + }) + List queryMeetingCusConfigMain(); + + /** + *

查询配置表明细表信息

+ * @author xuanran.wang + * @dateTime 2023/3/1 16:39 + * @param mainId 主表数据id + * @return 配置集合 + **/ + @Select("select * from uf_meetFieldConfig_dt1 where mainid = #{mainId}") + @CollectionMethod(1) + List queryMeetingCusConfigDetail(@ParamMapper("mainId") int mainId); + + /** + *

更新会议室信息

+ * @param sql 自定义sql + * @param conditionData 条件值 + * @return 是否更新成功 + */ + @Update(custom = true) + boolean updateMeetingRoom(@SqlString String sql, HashMap conditionData); + + /** + *

查询会议室信息

+ * @author xuanran.wang + * @dateTime 2023/3/1 16:44 + * @param id 会议室id + **/ + @Select("select * from meetingroom where id = #{id}") + Map queryMeetingRoom(@ParamMapper("id") String id); +} diff --git a/src/main/java/com/api/xuanran/wang/shyl/mapper/ProducerMapper.java b/src/main/java/com/api/xuanran/wang/shyl/mapper/ProducerMapper.java new file mode 100644 index 0000000..3b7da0c --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/mapper/ProducerMapper.java @@ -0,0 +1,33 @@ +package com.api.xuanran.wang.shyl.mapper; + +import aiyh.utils.annotation.recordset.ParamMapper; +import aiyh.utils.annotation.recordset.Select; +import aiyh.utils.annotation.recordset.SqlMapper; +import com.api.xuanran.wang.shyl.entity.ProducerCarInfo; + +import java.util.HashMap; + +/** + *

生产者mapper

+ * + * @author xuanran.wang + * @date 2023/2/25 15:50 + */ +@SqlMapper +public interface ProducerMapper { + @Select("select a.id carCode, Deposit status,b.outkey driver, b.lastname userName, " + + "b.telephone userPhone, carNo plateList, remark " + + "from carinfo a " + + "left join hrmresource b " + + "on a.driver = b.id " + + "where a.id = #{id}") + ProducerCarInfo queryCarInfo(@ParamMapper("id") String id); + + @Select("select a.id carCode, Deposit status,b.outkey driver, b.lastname userName, " + + "b.telephone userPhone, carNo plateList, remark " + + "from carinfo a " + + "left join hrmresource b " + + "on a.driver = b.id " + + "where a.carNo = #{carNo}") + ProducerCarInfo queryCarNo(@ParamMapper("carNo") String carNo); +} diff --git a/src/main/java/com/api/xuanran/wang/shyl/service/BatchCreateWorkflowService.java b/src/main/java/com/api/xuanran/wang/shyl/service/BatchCreateWorkflowService.java new file mode 100644 index 0000000..7621447 --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/service/BatchCreateWorkflowService.java @@ -0,0 +1,195 @@ +package com.api.xuanran.wang.shyl.service; + +import aiyh.utils.Util; +import aiyh.utils.excention.CustomerException; +import com.alibaba.fastjson.JSONArray; +import com.alibaba.fastjson.JSONObject; +import com.api.xuanran.wang.shyl.controller.BatchCreateWorkFlowController; +import com.api.xuanran.wang.shyl.entity.CusCreateWfInfo; +import com.api.xuanran.wang.shyl.vo.CreateWfVO; +import com.engine.workflow.constant.PAResponseCode; +import com.engine.workflow.entity.publicApi.PAResponseEntity; +import com.engine.workflow.entity.publicApi.ReqOperateRequestEntity; +import org.apache.commons.collections4.MapUtils; +import org.apache.commons.lang3.StringUtils; +import org.apache.log4j.Logger; +import weaver.hrm.User; +import weaver.workflow.webservices.WorkflowRequestTableField; +import weaver.xuanran.wang.common.util.CommonUtil; + +import java.util.*; +import java.util.concurrent.*; +import java.util.stream.Collectors; + + +/** + *

批量创建流程业务方法

+ * + * @author xuanran.wang + * @date 2023/2/22 13:58 + */ +public class BatchCreateWorkflowService { + + // 表名 : requestId 本次需要删除的数据 + private final ConcurrentHashMap> delWorkflowTableRequestId = new ConcurrentHashMap<>(); + // workflowId : tableName + private static final HashMap workflowTable = new HashMap<>(); + private final Logger log = Util.getLogger(); + + private static final String CUSTOM_ID = "customId"; + +// private final MeetingMapper meetingTransMapper = Util.getTransMapper(MeetingMapper.class); + + private final MeetingService meetingService = new MeetingService(); + /** + *

取消会议 支持多个

+ * @author xuanran.wang + * @dateTime 2023/2/24 10:21 + * @param ids 会议id + **/ + public void cancelMeeting(String ids){ + meetingService.cancelMeeting(ids); + } + + /** + *

批量创建流程

+ * @author xuanran.wang + * @dateTime 2023/2/22 17:10 + * @param array 流程数据数组 + * @return 创建流程结果 + **/ + public List batchCreateWorkflow(User user, JSONArray array) { + List> list = new ArrayList<>(); + List errors = new ArrayList<>(); + ArrayList res = new ArrayList<>(); + try { + List reqOperateRequestEntities = checkParams(array); + // 结果集 + for (int i = 0; i < reqOperateRequestEntities.size(); i++) { + int temp = i; + // 创建流程 + Callable callable = () -> this.createWorkflow(user,reqOperateRequestEntities.get(temp), temp); + list.add(Util.threadPool.submit(callable)); + } + for (Future future : list) { + CusCreateWfInfo cusCreateWfInfo = future.get(); + PAResponseEntity entity = cusCreateWfInfo.getPaResponseEntity(); + String tableName = workflowTable.get(cusCreateWfInfo.getWorkflowId()); + if(PAResponseCode.SUCCESS != entity.getCode()){ + errors.add(cusCreateWfInfo); + continue; + } + // 将生成的requestId存到vo中返回 + Map data = (Map) entity.getData(); + String requestId = Util.null2DefaultStr(data.get("requestid"),""); + CreateWfVO vo = new CreateWfVO(); + vo.setRequestId(requestId); + vo.setCustomId(cusCreateWfInfo.getCustomId()); + res.add(vo); + + // 将表名 requestId 存到成员变量中 + if (!delWorkflowTableRequestId.containsKey(tableName)) { + ArrayList requestIds = new ArrayList<>(); + requestIds.add(requestId); + delWorkflowTableRequestId.put(tableName, requestIds); + }else { + delWorkflowTableRequestId.get(tableName).add(requestId); + } + } + if(errors.size() > 0){ + throw new CustomerException("创建流程失败!错误参数流程 : \n" + JSONObject.toJSONString(errors)); + } + return res; + }catch (Exception e){ + if(MapUtils.isNotEmpty(delWorkflowTableRequestId)){ + log.info("删除流程数据map : " + JSONObject.toJSONString(delWorkflowTableRequestId)); + for (Map.Entry> entry : delWorkflowTableRequestId.entrySet()) { + String tableName = entry.getKey(); + List requestIds = entry.getValue(); + if (!CommonUtil.deleteWorkflowDataByRequestIds(tableName, requestIds)) { + log.error(Util.logStr("删除流程数据失败!表名:{}, 待删除流程集合: {} ", tableName,JSONObject.toJSONString(requestIds))); + } + if (!CommonUtil.deleteWorkflowDataByRequestIds("workflow_requestbase", requestIds)) { + log.error(Util.logStr("删除流程数据失败!表名:{}, 待删除流程集合: {} ", "workflow_requestbase", JSONObject.toJSONString(requestIds))); + } + if (!CommonUtil.deleteWorkflowDataByRequestIds("Bill_Meeting", requestIds)) { + log.error(Util.logStr("删除流程数据失败!表名:{}, 待删除流程集合: {} ", "Bill_Meeting", JSONObject.toJSONString(requestIds))); + } + } + } + throw new CustomerException(e.getMessage()); + } + } + + /** + *

创建流程

+ * @author xuanran.wang + * @dateTime 2023/2/24 14:33 + * @param user 用户 + * @param requestEntity 流程请求体 + * @param index 流程集合下标 + * @return 流程创建成功相关数据 + **/ + public CusCreateWfInfo createWorkflow(User user, + ReqOperateRequestEntity requestEntity, + int index){ + // 创建流程 + PAResponseEntity responseEntity = BatchCreateWorkFlowController.WRO.doCreateRequest(user, requestEntity); + CusCreateWfInfo cusCreateWfInfo = new CusCreateWfInfo(); + cusCreateWfInfo.setIndex(index); + cusCreateWfInfo.setPaResponseEntity(responseEntity); + int workflowId = requestEntity.getWorkflowId(); + String tableName = workflowTable.get(workflowId); + if(StringUtils.isBlank(tableName)){ + tableName = CommonUtil.getTableNameByWorkflowId(workflowId); + workflowTable.put(workflowId, tableName); + } + // 获取主表的customId + List collect = requestEntity.getMainData() + .stream() + .filter(item -> CUSTOM_ID.equals(item.getFieldName())) + .collect(Collectors.toList()); + String customIdVal = collect.get(0).getFieldValue(); + cusCreateWfInfo.setCustomId(customIdVal); + cusCreateWfInfo.setWorkflowId(workflowId); + return cusCreateWfInfo; + } + + /** + *

参数校验并将json转成ReqOperateRequestEntity

+ * @author xuanran.wang + * @dateTime 2023/2/24 13:36 + * @param array json数组 + * @return 解析后的集合 + **/ + public List checkParams(JSONArray array){ + ArrayList res = new ArrayList<>(); + try { + for (Object obj : array) { + ReqOperateRequestEntity entity; + JSONObject jsonObject; + // 将json转成内部流程对象 + try { + jsonObject = JSONObject.parseObject(obj.toString()); + entity = JSONObject.parseObject(jsonObject.toString(), ReqOperateRequestEntity.class); + }catch (Exception e){ + throw new CustomerException(Util.logStr("json反序列化失败!当前对象:{}, 错误信息: {}" ,obj,e.getMessage())); + } + if(Util.getIntValue(String.valueOf(entity.getWorkflowId()),-1) < 0){ + throw new CustomerException(Util.logStr("该对象workflowId为空!", obj)); + } + List collect = entity.getMainData() + .stream() + .filter(item -> CUSTOM_ID.equals(item.getFieldName())) + .collect(Collectors.toList()); + if(collect.size() == 0){ + throw new CustomerException(Util.logStr("该对象mainData中未找到customId!:{}", obj)); + } + res.add(entity); + } + }catch (Exception e){ + throw new CustomerException(Util.logStr("JSON参数校验失败!请检查json是否正确!错误信息: {}",e.getMessage())); + } + return res; + } +} diff --git a/src/main/java/com/api/xuanran/wang/shyl/service/CarService.java b/src/main/java/com/api/xuanran/wang/shyl/service/CarService.java new file mode 100644 index 0000000..c4205ec --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/service/CarService.java @@ -0,0 +1,111 @@ +package com.api.xuanran.wang.shyl.service; + +import aiyh.utils.Util; +import aiyh.utils.excention.CustomerException; +import com.alibaba.fastjson.JSONObject; +import com.api.xuanran.wang.shyl.entity.MQMessage; +import com.api.xuanran.wang.shyl.entity.ProducerCarInfo; +import com.api.xuanran.wang.shyl.mapper.ProducerMapper; +import org.apache.commons.lang3.StringUtils; +import org.apache.log4j.Logger; +import weaver.general.TimeUtil; +import weaver.xuanran.wang.shyl_mq.constant.RocketMQConstant; +import weaver.xuanran.wang.shyl_mq.util.RocketConsumerUtil; +import weaver.zwl.common.ToolUtil; + +import javax.servlet.http.HttpServletRequest; +import java.util.Objects; +import java.util.UUID; + +/** + *

车辆业务方法

+ * + * @author xuanran.wang + * @date 2023/2/27 13:28 + */ +public class CarService { + private final Logger log = Util.getLogger(); + private final ToolUtil toolUtil = new ToolUtil(); + private final ProducerMapper producerMapper = Util.getMapper(ProducerMapper.class); + + /** + *

将信息发送到mq中

+ * @author xuanran.wang + * @dateTime 2023/2/27 13:29 + * @param request 请求对象 + **/ + public void sendCarToMQ(HttpServletRequest request){ + try { + // 操作类型 edit 编辑 add 新增 deposit 封存 + String operation = Util.null2String(request.getParameter("operation")); + // 车辆id + String id = Util.null2String(request.getParameter("id")); + log.info(Util.logStr("operation : {}. id : {}", operation, id)); + String actionType = ""; + // 标识 新增 0 修改 1 删除 2 + String identification = ""; + switch (operation){ + case "add":{ + identification = "0"; + actionType = RocketMQConstant.CREATE_ACTION; + }break; + case "deposit": + case "edit":{ + identification = "1"; + actionType = RocketMQConstant.UPDATE_ACTION; + }break; + case "del":{ + identification = "2"; + actionType = RocketMQConstant.DELETE_ACTION; + } + break; + } + if(StringUtils.isBlank(operation)){ + identification = "2"; + actionType = RocketMQConstant.DELETE_ACTION; + } + String sendMQ = Util.null2DefaultStr(toolUtil.getSystemParamValue("sendMQ"),""); + log.info(Util.logStr("carId : {}, sendMQ : {}",id, sendMQ)); + String msg = ""; + MQMessage mqMessage = new MQMessage(); + mqMessage.setId(UUID.randomUUID().toString()); + mqMessage.setTopic("OA_CAR_TOPIC"); + mqMessage.setSendTime(TimeUtil.getCurrentTimeString()); + mqMessage.setActionType(actionType); + ProducerCarInfo info = null; + String carNo = ""; + if(StringUtils.isNotBlank(id)){ + info = producerMapper.queryCarInfo(id); + }else { + // 车牌号 + carNo = Util.null2DefaultStr(request.getParameter("carNo"),""); + info = producerMapper.queryCarNo(carNo); + } + // 如果能找到就说明是更新或者新增 + if("del".equals(operation)){ //删除状态下 + info = new ProducerCarInfo(); + info.setCarCode(id); + info.setStatus("1"); + info.setRemark(""); + info.setDriver(""); + info.setPlateList(""); + info.setUserName(""); + info.setUserPhone(""); + log.info("删除状态下!"); + } + log.info("ProducerCarInfo : " + JSONObject.toJSONString(info)); + if(!Objects.isNull(info)){ + carNo = Util.null2DefaultStr(info.getPlateList(),""); + info.setIdentification(identification); + mqMessage.setContent(info); + msg = JSONObject.toJSONString(mqMessage); + log.info(Util.logStr("car msg : {}", msg)); + if("1".equals(sendMQ) && StringUtils.isNotBlank(msg)){ + RocketConsumerUtil.producerSendMsg("OACar", msg, carNo); + } + } + }catch (Exception e){ + throw new CustomerException("sendCarToMQ error : " + e.getMessage()); + } + } +} diff --git a/src/main/java/com/api/xuanran/wang/shyl/service/MeetingService.java b/src/main/java/com/api/xuanran/wang/shyl/service/MeetingService.java new file mode 100644 index 0000000..acec27d --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/service/MeetingService.java @@ -0,0 +1,78 @@ +package com.api.xuanran.wang.shyl.service; + +import aiyh.utils.Util; +import aiyh.utils.excention.CustomerException; +import com.api.xuanran.wang.shyl.entity.meeting.MeetingCusFieldConfigMain; +import com.api.xuanran.wang.shyl.mapper.MeetingMapper; +import org.apache.commons.lang3.StringUtils; +import weaver.xuanran.wang.common.mapper.CommonMapper; +import weaver.xuanran.wang.shyl_mq.service.ProducerService; +import weaver.zwl.common.ToolUtil; + +import java.util.Arrays; +import java.util.List; +import java.util.stream.Collectors; + +/** + *

会议相关业务

+ * + * @author xuanran.wang + * @date 2023/2/24 10:20 + */ +public class MeetingService { + + private final ToolUtil toolUtil = new ToolUtil(); + private final CommonMapper commonMapper = Util.getMapper(CommonMapper.class); + private final ProducerService producerService = new ProducerService(); + private final String TABLE_NAME = Util.null2DefaultStr(toolUtil.getSystemParamValue("meetingTableName"),""); + private final String CONFIG_NAME = Util.null2DefaultStr(toolUtil.getSystemParamValue("OAMeetingConfig"),"OAMeeting"); + private final String ONLY_MARK = Util.null2DefaultStr(toolUtil.getSystemParamValue("meetingOnlyMark"),"meeting"); + + private final MeetingMapper meetingMapper = Util.getMapper(MeetingMapper.class); + /** + *

取消会议 支持多个

+ * @author xuanran.wang + * @dateTime 2023/2/24 10:21 + * @param ids 会议id + **/ + public void cancelMeeting(String ids){ + String[] idArr = ids.split(","); + List requestIds = Arrays.stream(idArr).collect(Collectors.toList()); + if (!commonMapper.cancelMeeting(requestIds)){ + throw new CustomerException("更新会议状态失败!"); + } + try { + if(StringUtils.isNotBlank(TABLE_NAME)){ + sendToMQ(requestIds); + } + }catch (Exception e){ + throw new CustomerException("更新会议状态下发MQ失败! " + e.getMessage()); + } + } + + /** + *

将取消的会议发送到mq中

+ * @author xuanran.wang + * @dateTime 2023/2/28 14:40 + * @param requestIds 请求ids + **/ + private void sendToMQ(List requestIds){ + for (String requestId : requestIds) { + producerService.pushWorkFlowToMQ(CONFIG_NAME,ONLY_MARK, requestId, TABLE_NAME, (map)->{ + map.put("actionType", "DELETE_ACTION"); + }); + } + } + + /** + *

获取会议新增字段配置

+ * @author xuanran.wang + * @dateTime 2023/3/1 15:45 + * @return 建模配置对象 + **/ + public List getMeetingFieldCusConfig(){ + return meetingMapper.queryMeetingCusConfigMain(); + } + + +} diff --git a/src/main/java/com/api/xuanran/wang/shyl/service/StudentsService.java b/src/main/java/com/api/xuanran/wang/shyl/service/StudentsService.java new file mode 100644 index 0000000..2d6d657 --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/service/StudentsService.java @@ -0,0 +1,59 @@ +package com.api.xuanran.wang.shyl.service; + +import aiyh.utils.Util; +import aiyh.utils.excention.CustomerException; +import aiyh.utils.httpUtil.ResponeVo; +import aiyh.utils.httpUtil.util.HttpUtils; +import com.alibaba.fastjson.JSON; +import org.apache.commons.lang3.StringUtils; +import org.apache.log4j.Logger; +import weaver.zwl.common.ToolUtil; + +import javax.ws.rs.core.MediaType; +import java.util.HashMap; + +/** + *

学员业务方法

+ * + * @author xuanran.wang + * @date 2023/3/1 11:01 + */ +public class StudentsService { + + private final HttpUtils httpUtils = new HttpUtils(); + private final Logger log = Util.getLogger(); + private final ToolUtil toolUtil = new ToolUtil(); + + { + httpUtils.getGlobalCache().header.put("Content-Type", MediaType.APPLICATION_JSON); // 全局请求头 + } + + /** + *

根据班级id获取学员信息

+ * @author xuanran.wang + * @dateTime 2023/3/1 11:17 + * @param classId 班级id + * @return 接口返回的学员信息json + **/ + public String getStudentsByClassId(String classId){ + String url = Util.null2DefaultStr(toolUtil.getSystemParamValue("studentsUrl"),""); + if(StringUtils.isBlank(url)){ + throw new CustomerException("在系统配置表中没有配置教研资studentsUrl!"); + } + HashMap params = new HashMap<>(); + params.put("classId", classId); + try { + ResponeVo responeVo = httpUtils.apiGet(url, params, new HashMap<>()); + if(responeVo.getCode() != 200){ + log.error(Util.logStr("can not fetch [{}]，this request params is [{}]，" + // 构建日志字符串 + "this request heard is [{}]，but response status code is [{}]，" + + "this response is [{}]", url, JSON.toJSON(params), "", responeVo.getCode(), // 相应状态码 + responeVo.getEntityString())); // 相应内容 + } + return responeVo.getEntityString(); + }catch (Exception e){ + log.error(Util.logStr("查询班级列表人员数据接口失败!错误信息:{}",e.getMessage())); + } + return ""; + } +} diff --git a/src/main/java/com/api/xuanran/wang/shyl/vo/CreateWfVO.java b/src/main/java/com/api/xuanran/wang/shyl/vo/CreateWfVO.java new file mode 100644 index 0000000..61b0841 --- /dev/null +++ b/src/main/java/com/api/xuanran/wang/shyl/vo/CreateWfVO.java @@ -0,0 +1,15 @@ +package com.api.xuanran.wang.shyl.vo; + +import lombok.Data; + +/** + *

+ * + * @author xuanran.wang + * @date 2023/2/24 13:19 + */ +@Data +public class CreateWfVO { + private String customId; + private String requestId; +} diff --git a/src/main/java/com/api/youhong/ai/jitu/hrmlogintip/controller/HrmLoinTipController.java b/src/main/java/com/api/youhong/ai/jitu/hrmlogintip/controller/HrmLoinTipController.java index 0177040..296cffa 100644 --- a/src/main/java/com/api/youhong/ai/jitu/hrmlogintip/controller/HrmLoinTipController.java +++ b/src/main/java/com/api/youhong/ai/jitu/hrmlogintip/controller/HrmLoinTipController.java @@ -61,4 +61,49 @@ public class HrmLoinTipController { } + @Path("/doc/get") + @GET + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + public String getNotReadDocId(@Context HttpServletRequest request, @Context HttpServletResponse response) { + User user = null; + try { + user = HrmUserVarify.getUser(request, response); + return ApiResult.success(service.getNotReadDocId(user)); + } catch (Exception e) { + log.error("query not read doc error! " + Util.getErrString(e)); + return ApiResult.error("query not read doc error! system error!"); + } + } + + @Path("/doc/not-read/get") + @GET + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + public String getNotRead(@Context HttpServletRequest request, @Context HttpServletResponse response) { + User user = null; + try { + user = HrmUserVarify.getUser(request, response); + return ApiResult.success(service.getNotRead(user)); + } catch (Exception e) { + log.error("query not read doc error! " + Util.getErrString(e)); + return ApiResult.error("query not read doc error! system error!"); + } + } + + @Path("/doc/set") + @GET + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + public String setRead(@Context HttpServletRequest request, @Context HttpServletResponse response) { + User user = null; + try { + String ipAddress = Util.getIpAddress(request); + user = HrmUserVarify.getUser(request, response); + return ApiResult.success(service.setRead(user, ipAddress)); + } catch (Exception e) { + log.error("set read doc error! " + Util.getErrString(e)); + return ApiResult.error("set read doc error! system error!"); + } + } } diff --git a/src/main/java/com/api/youhong/ai/jitu/hrmlogintip/mapper/HrmLoinTipMapper.java b/src/main/java/com/api/youhong/ai/jitu/hrmlogintip/mapper/HrmLoinTipMapper.java index c967be8..a65b08b 100644 --- a/src/main/java/com/api/youhong/ai/jitu/hrmlogintip/mapper/HrmLoinTipMapper.java +++ b/src/main/java/com/api/youhong/ai/jitu/hrmlogintip/mapper/HrmLoinTipMapper.java @@ -2,6 +2,8 @@ package com.api.youhong.ai.jitu.hrmlogintip.mapper; import aiyh.utils.annotation.recordset.*; +import java.util.List; + /** *

* @@ -67,4 +69,40 @@ public interface HrmLoinTipMapper { @Select("select SEQORDER from cus_fielddata where scope = 'HrmCustomFieldByInfoType'\n" + " and scopeid = -1 and id = #{userId}") Integer getMessageStatusId(@ParamMapper("userId") Integer userId); + + /** + *

查询已读的文档id

+ * + * @param split 文档id + * @param userId 用户 + * @return 已读的文档id + */ + @Select("select DOCID from docreadtag where DOCID in ($t{split}) and " + + "READCOUNT > 0 and USERID = #{userId}") + List selectReadDocByDocIds(@ParamMapper("split") String[] split, + @ParamMapper("userId") Integer userId); + + /** + *

查询已读未读记录

+ * + * @param uid 用户id + * @param loginTipDocIds 文档ids + * @return 主键 + */ + @Select("select id from uf_pop_window_doc where user_id = #{userId} and doc_ids = #{docIds}") + Integer selectRead(@ParamMapper("userId") int uid, @ParamMapper("docIds") String loginTipDocIds); + + /** + *

更新文档已读信息

+ * + * @param modeDataId 表id + * @param uid 用户ID + * @param loginTipDocIds 文档id + * @return 是否更新成功 + */ + @Update("update uf_pop_window_doc set doc_ids = #{docIds}, user_id = #{userId},ip_address = #{ipAddress} where id = #{dataId}") + boolean updateRead(@ParamMapper("dataId") int modeDataId, + @ParamMapper("userId") int uid, + @ParamMapper("docIds") String loginTipDocIds, + @ParamMapper("ipAddress") String ipAddress); } diff --git a/src/main/java/com/api/youhong/ai/jitu/hrmlogintip/service/HrmLoinTipService.java b/src/main/java/com/api/youhong/ai/jitu/hrmlogintip/service/HrmLoinTipService.java index 43023fd..b1f267d 100644 --- a/src/main/java/com/api/youhong/ai/jitu/hrmlogintip/service/HrmLoinTipService.java +++ b/src/main/java/com/api/youhong/ai/jitu/hrmlogintip/service/HrmLoinTipService.java @@ -1,11 +1,17 @@ package com.api.youhong.ai.jitu.hrmlogintip.service; import aiyh.utils.Util; +import aiyh.utils.entity.DocImageInfo; import aiyh.utils.tool.Assert; +import aiyh.utils.tool.cn.hutool.core.collection.CollectionUtil; import com.api.youhong.ai.jitu.hrmlogintip.mapper.HrmLoinTipMapper; +import org.apache.commons.lang.StringUtils; import weaver.hrm.User; +import java.util.Arrays; +import java.util.List; import java.util.Objects; +import java.util.stream.Collectors; /** *

@@ -60,4 +66,74 @@ public class HrmLoinTipService { } return mapper.insertStatus(showStatusField, userId); } + + /** + *

查询未读的文档信息

+ * + * @param user 当前登录的用户 + * @return 未读的文档docId + */ + public List getNotReadDocId(User user) { + + // 登录提示的文档docId字符串，多个使用,隔开 + String loginTipDocIds = Util.getCusConfigDefaultValue("LOGIN_TIP_DOC_IDS", ""); + if (StringUtils.isBlank(loginTipDocIds)) { + return null; + } + String[] split = loginTipDocIds.split(","); + List readDocIds = mapper.selectReadDocByDocIds(split, user.getUID()); + if (CollectionUtil.isEmpty(readDocIds)) { + List collect = Arrays.stream(split) + .mapToInt(Integer::parseInt) + .filter(item -> !readDocIds.contains(item)) + .boxed() + .collect(Collectors.toList()); + return Util.selectImageInfoByDocIds(Util.joinEach(collect, ",")); + } + // Util.selectImageInfoByDocIds() + List collect = Arrays.stream(split) + .mapToInt(Integer::parseInt) + .filter(item -> !readDocIds.contains(item)) + .boxed() + .collect(Collectors.toList()); + return Util.selectImageInfoByDocIds(Util.joinEach(collect, ",")); + } + + + /** + *

查询未读文档信息

+ * + * @param user 当前用户 + * @return 未读的文档信息 + */ + public List getNotRead(User user) { + String loginTipDocIds = Util.getCusConfigDefaultValue("LOGIN_TIP_DOC_IDS", ""); + if (StringUtils.isBlank(loginTipDocIds)) { + return null; + } + Integer id = mapper.selectRead(user.getUID(), loginTipDocIds); + if (id != null && id > 0) { + return null; + } + return Util.selectImageInfoByDocIds(loginTipDocIds); + } + + + /** + *

设置文档信息已读

+ * + * @param user 用户 + * @param ipAddress 用户ip + * @return 是否成功 + */ + public boolean setRead(User user, String ipAddress) { + String loginTipDocIds = Util.getCusConfigDefaultValue("LOGIN_TIP_DOC_IDS", ""); + if (StringUtils.isBlank(loginTipDocIds)) { + return true; + } + String formId = Util.getModeIdByTableName("uf_pop_window_doc"); + int modeDataId = Util.getModeDataId("uf_pop_window_doc", Integer.parseInt(formId), + 1); + return mapper.updateRead(modeDataId, user.getUID(), loginTipDocIds, ipAddress); + } } diff --git a/src/main/java/com/api/youhong/ai/pcn/workflow/ccworkflow/controller/CCWorkflowActionTriggerController.java b/src/main/java/com/api/youhong/ai/pcn/workflow/ccworkflow/controller/CCWorkflowActionTriggerController.java new file mode 100644 index 0000000..05285d4 --- /dev/null +++ b/src/main/java/com/api/youhong/ai/pcn/workflow/ccworkflow/controller/CCWorkflowActionTriggerController.java @@ -0,0 +1,50 @@ +package com.api.youhong.ai.pcn.workflow.ccworkflow.controller; + +import aiyh.utils.ApiResult; +import aiyh.utils.Util; +import com.api.youhong.ai.pcn.workflow.ccworkflow.service.CCWorkflowActionTriggerService; +import io.swagger.v3.oas.annotations.parameters.RequestBody; +import org.apache.log4j.Logger; +import weaver.hrm.HrmUserVarify; +import weaver.hrm.User; + +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import javax.ws.rs.Consumes; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.MediaType; +import java.util.Map; + +/** + *

抄送流程actin触发

+ * + *

create: 2023/3/14 10:13

+ * + * @author youHong.ai + */ +@Path("aiyh/pcn/cc-workflow") +public class CCWorkflowActionTriggerController { + + private final Logger log = Util.getLogger(); + + private final CCWorkflowActionTriggerService service = new CCWorkflowActionTriggerService(); + + @Path("/trigger") + @POST + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + public String triggerCCWorkflow(@Context HttpServletRequest request, + @Context HttpServletResponse response, + @RequestBody Map params) { + User user = HrmUserVarify.getUser(request, response); + try { + return ApiResult.success(service.triggerCCWorkflow(user, params, request)); + } catch (Exception e) { + log.error("trigger workflow cc action error!" + Util.getErrString(e)); + return ApiResult.error("trigger workflow cc action error!"); + } + } +} diff --git a/src/main/java/com/api/youhong/ai/pcn/workflow/ccworkflow/mapper/CCWorkflowActionTriggerMapper.java b/src/main/java/com/api/youhong/ai/pcn/workflow/ccworkflow/mapper/CCWorkflowActionTriggerMapper.java new file mode 100644 index 0000000..f8af1b4 --- /dev/null +++ b/src/main/java/com/api/youhong/ai/pcn/workflow/ccworkflow/mapper/CCWorkflowActionTriggerMapper.java @@ -0,0 +1,28 @@ +package com.api.youhong.ai.pcn.workflow.ccworkflow.mapper; + +import aiyh.utils.annotation.recordset.ParamMapper; +import aiyh.utils.annotation.recordset.Select; +import aiyh.utils.annotation.recordset.SqlMapper; + +import java.util.Map; + +/** + *

+ * + *

create: 2023/3/14 14:23

+ * + * @author youHong.ai + */ +@SqlMapper +public interface CCWorkflowActionTriggerMapper { + + /** + *

查询流程基本信息

+ * + * @param requestId 流程请求id + * @return 流程信息 + */ + + @Select("select creater,createdate create_date,createtime create_time from workflow_requestbase where REQUESTID = #{requestId}") + Map selectRequestInfo(@ParamMapper("requestId") String requestId); +} diff --git a/src/main/java/com/api/youhong/ai/pcn/workflow/ccworkflow/service/CCWorkflowActionTriggerService.java b/src/main/java/com/api/youhong/ai/pcn/workflow/ccworkflow/service/CCWorkflowActionTriggerService.java new file mode 100644 index 0000000..7fdbc98 --- /dev/null +++ b/src/main/java/com/api/youhong/ai/pcn/workflow/ccworkflow/service/CCWorkflowActionTriggerService.java @@ -0,0 +1,58 @@ +package com.api.youhong.ai.pcn.workflow.ccworkflow.service; + +import aiyh.utils.Util; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; +import com.api.youhong.ai.pcn.workflow.ccworkflow.mapper.CCWorkflowActionTriggerMapper; +import weaver.hrm.User; +import weaver.soa.workflow.request.RequestInfo; +import weaver.soa.workflow.request.RequestService; +import weaver.workflow.request.RequestManager; +import weaver.youhong.ai.pcn.actioin.ccworkflow.CCWorkflowAction; + +import javax.servlet.http.HttpServletRequest; +import java.util.Map; + +/** + *

抄送流程service触发

+ * + *

create: 2023/3/14 10:16

+ * + * @author youHong.ai + */ +public class CCWorkflowActionTriggerService { + + private final CCWorkflowActionTriggerMapper mapper = Util.getMapper(CCWorkflowActionTriggerMapper.class); + + /** + *

触发抄送流程action

+ * + * @param user 当前用户 + * @param params 请求参数 + * @param request 请求request对象 + * @return 是否触发成功 + */ + public boolean triggerCCWorkflow(User user, Map params, HttpServletRequest request) { + CCWorkflowAction ccWorkflowAction = new CCWorkflowAction(); + Object detailNo = params.get("detailNo"); + Object requestId = params.get("requestId"); + Object ccResourceField = params.get("ccResourceField"); + Object firstLevelDepResponsibleField = params.get("firstLevelDepResponsibleField"); + ccWorkflowAction.setDetailNo(String.valueOf(detailNo)); + ccWorkflowAction.setCcResourceField(String.valueOf(ccResourceField)); + ccWorkflowAction.setFirstLevelDepResponsibleField(String.valueOf(firstLevelDepResponsibleField)); + RequestService requestService = new RequestService(); + RequestInfo requestInfo = requestService.getRequest(Integer.parseInt(String.valueOf(requestId))); + RequestManager requestManager = new RequestManager(); + requestManager.setRequestid(Integer.parseInt(String.valueOf(requestId))); + requestInfo.setRequestManager(requestManager); + requestManager.setUser(user); + requestManager.setRequest(request); + Map requestMap = mapper.selectRequestInfo(String.valueOf(requestId)); + Assert.notEmpty(requestMap, "request base info is null or empty!"); + requestInfo.setCreatorid(String.valueOf(user.getUID())); + requestManager.setCreatedate(String.valueOf(requestMap.get("createDate"))); + requestManager.setCreatetime(String.valueOf(requestMap.get("createTime"))); + ccWorkflowAction.execute(requestInfo); + return true; + } +} diff --git a/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/controller/FunctionListController.java b/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/controller/FunctionListController.java new file mode 100644 index 0000000..285b6ba --- /dev/null +++ b/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/controller/FunctionListController.java @@ -0,0 +1,63 @@ +package com.api.youhong.ai.taibao.fcuntionlist.controller; + + +import aiyh.utils.ApiResult; +import aiyh.utils.Util; +import com.api.youhong.ai.taibao.fcuntionlist.service.FunctionListService; +import org.apache.log4j.Logger; +import weaver.hrm.HrmUserVarify; +import weaver.hrm.User; + +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.MediaType; + +/** + *

方法列表web接口

+ * + *

create: 2023/3/9 21:54

+ * + * @author youHong.ai + */ +@Path("/aiyh/tai-bao/function-list") +public class FunctionListController { + + private final FunctionListService service = new FunctionListService(); + + private final Logger log = Util.getLogger(); + + @GET + @Path("/get") + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + public String getFunctionList(@Context HttpServletRequest request, @Context HttpServletResponse response) { + User user = HrmUserVarify.getUser(request, response); + try { + return ApiResult.success(service.getFunctionList(user)); + } catch (Exception e) { + log.error("get function list config error!" + Util.getErrString(e)); + return ApiResult.error("get function list config error!"); + } + } + + + @GET + @Path("/todo-num") + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + public String getTodoRequestNum(@Context HttpServletRequest request, @Context HttpServletResponse response) { + User user = HrmUserVarify.getUser(request, response); + + try { + return ApiResult.success(service.getOAAndOtherTodoCount(user)); + } catch (Exception e) { + log.error("get oa and other todo count error!" + Util.getErrString(e)); + return ApiResult.error("get oa and other todo count error"); + } + } +} diff --git a/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/mapper/FunctionListMapper.java b/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/mapper/FunctionListMapper.java new file mode 100644 index 0000000..205abcd --- /dev/null +++ b/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/mapper/FunctionListMapper.java @@ -0,0 +1,63 @@ +package com.api.youhong.ai.taibao.fcuntionlist.mapper; + +import aiyh.utils.annotation.recordset.*; +import aiyh.utils.entity.DocImageInfo; +import com.api.youhong.ai.taibao.fcuntionlist.pojo.FunctionListConfigItem; + +import java.util.List; + +/** + *

+ * + *

create: 2023/3/9 21:57

+ * + * @author youHong.ai + */ +@SqlMapper +public interface FunctionListMapper { + + /** + *

查询方法按钮列表，通过分部id

+ * + * @param userSubCompanyLike 分部ID + * @return 返回结果 + */ + @Associations( + @Association(property = "buttonIcon", + column = "button_icon", + id = @Id(value = String.class, methodId = 1)) + ) + @Select("select * from uf_fun_list_config where CONCAT(',' , subcompany_id , ',') like #{userSubCompanyLike}") + @SelectOracle("select * from uf_fun_list_config where (',' || subcompany_id || ',') like #{userSubCompanyLike}") + List selectFunctionList(@ParamMapper("userSubCompanyLike") String userSubCompanyLike); + + + /** + *

查询所有按钮配置

+ * + * @return 所有按钮配置 + */ + @Associations( + @Association(property = "buttonIcon", + column = "button_icon", + id = @Id(value = String.class, methodId = 1)) + ) + @Select("select * from uf_fun_list_config") + List selectFunctionListAll(); + + /** + *

查询docImageInfo对象

+ * + * @param docIds docIds + * @return 方法对象 + */ + @Select("select di.id id,dc.id doc_id," + + "di.imagefileid image_file_id, di.docfiletype doc_file_type," + + "dc.DOCCREATEDATE doc_create_date,dc.DOCCREATETIME doc_create_time," + + "(case when imagefilename = '' or imagefilename is null then dc.DOCSUBJECT else imagefilename end) image_file_name " + + "from DocDetail dc " + + "left join docimagefile di on (dc.id in ($t{docIds}) and dc.id = di.docid )" + + "where dc.id in ($t{docIds})") + @AssociationMethod(1) + DocImageInfo selectDocImageInfo(String docIds); +} diff --git a/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/mapstruct/FunctionListConfigMapStruct.java b/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/mapstruct/FunctionListConfigMapStruct.java new file mode 100644 index 0000000..5a5abb5 --- /dev/null +++ b/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/mapstruct/FunctionListConfigMapStruct.java @@ -0,0 +1,45 @@ +package com.api.youhong.ai.taibao.fcuntionlist.mapstruct; + +import com.api.youhong.ai.taibao.fcuntionlist.pojo.FunctionListConfigItem; +import com.api.youhong.ai.taibao.fcuntionlist.vo.FunctionListVo; +import org.mapstruct.Mapper; +import org.mapstruct.Mapping; +import org.mapstruct.factory.Mappers; + +import java.util.List; + +/** + *

mapstruct 接口

+ * + *

create: 2023/3/9 22:12

+ * + * @author youHong.ai + */ +@Mapper +public interface FunctionListConfigMapStruct { + + + FunctionListConfigMapStruct INSTANCE = Mappers.getMapper(FunctionListConfigMapStruct.class); + + /** + *

数据库对象转换为Vo对象

+ * + * @param item 数据库实体 + * @return vo对象 + */ + @Mapping(target = "title", source = "buttonName") + @Mapping(target = "numUrl", source = "numberUrl") + @Mapping(target = "image", expression = "java(item.getButtonIcon() == null ? null : item.getButtonIcon().getImageFileId())") + @Mapping(target = "clickUrl", source = "buttonUrl") + FunctionListVo pojo2Vo(FunctionListConfigItem item); + + + /** + *

数据库实体list转换为Volist

+ * + * @param list 数据库实体list + * @return vo对象 + */ + List projoList2VoList(List list); + +} diff --git a/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/pojo/FunctionListConfigItem.java b/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/pojo/FunctionListConfigItem.java new file mode 100644 index 0000000..0c72146 --- /dev/null +++ b/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/pojo/FunctionListConfigItem.java @@ -0,0 +1,38 @@ +package com.api.youhong.ai.taibao.fcuntionlist.pojo; + +import aiyh.utils.annotation.recordset.SqlOracleDbFieldAnn; +import aiyh.utils.entity.DocImageInfo; +import lombok.Getter; +import lombok.Setter; +import lombok.ToString; + +/** + *

+ * + *

create: 2023/3/9 22:05

+ * + * @author youHong.ai + */ +@Getter +@Setter +@ToString +public class FunctionListConfigItem { + /** 按钮分组 */ + @SqlOracleDbFieldAnn("BUTTON_GROUP") + private Integer buttonGroup; + /** 按钮名称 */ + @SqlOracleDbFieldAnn("BUTTON_NAME") + private String buttonName; + /** 按钮图标 */ + @SqlOracleDbFieldAnn("BUTTON_ICON") + private DocImageInfo buttonIcon; + /** 按钮链接 */ + @SqlOracleDbFieldAnn("BUTTON_URL") + private String buttonUrl; + /** 显示分部 */ + @SqlOracleDbFieldAnn("SUBCOMPANY_ID") + private String subcompanyId; + /** 图标数量接口地址 */ + @SqlOracleDbFieldAnn("NUMBER_URL") + private String numberUrl; +} diff --git a/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/service/FunctionListService.java b/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/service/FunctionListService.java new file mode 100644 index 0000000..186f689 --- /dev/null +++ b/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/service/FunctionListService.java @@ -0,0 +1,180 @@ +package com.api.youhong.ai.taibao.fcuntionlist.service; + +import aiyh.utils.Util; +import aiyh.utils.tool.cn.hutool.core.collection.CollectionUtil; +import com.alibaba.fastjson.JSON; +import com.alibaba.fastjson.JSONArray; +import com.api.youhong.ai.taibao.fcuntionlist.mapper.FunctionListMapper; +import com.api.youhong.ai.taibao.fcuntionlist.mapstruct.FunctionListConfigMapStruct; +import com.api.youhong.ai.taibao.fcuntionlist.pojo.FunctionListConfigItem; +import com.api.youhong.ai.taibao.fcuntionlist.vo.FunctionListVo; +import com.cloudstore.dev.api.util.Util_DataCache; +import weaver.conn.RecordSet; +import weaver.general.BaseBean; +import weaver.hrm.User; +import weaver.workflow.request.todo.OfsSettingObject; +import weaver.workflow.request.todo.RequestUtil; +import weaver.workflow.webservices.WorkflowBaseInfo; +import weaver.workflow.webservices.WorkflowRequestInfo; + +import java.io.IOException; +import java.util.*; +import java.util.stream.Collectors; + +/** + *

方法列表service

+ * + *

create: 2023/3/9 21:56

+ * + * @author youHong.ai + */ +public class FunctionListService { + + private final FunctionListMapper mapper = Util.getMapper(FunctionListMapper.class); + + /** + *

根据当前用户所在分部id将配置表数据转换为前端展示对象

+ * + * @param user 当前用户 + * @return 前端展示数据 + */ + public Map> getFunctionList(User user) { + List configList; + if (user.getUID() == 1) { + configList = mapper.selectFunctionListAll(); + } else { + configList = mapper.selectFunctionList("%," + user.getUserSubCompany1() + ",%"); + } + if (CollectionUtil.isEmpty(configList)) { + return Collections.emptyMap(); + } + Map> collect = + configList.stream() + .collect( + Collectors + .groupingBy(FunctionListConfigItem::getButtonGroup) + ); + Map> result = new HashMap<>(8); + for (Map.Entry> entry : collect.entrySet()) { + result.put(String.valueOf(entry.getKey()), FunctionListConfigMapStruct.INSTANCE.projoList2VoList(entry.getValue())); + } + return result; + } + + + /** + *

查询oa和其他的待办数量，从他们的class文件拷贝过来的

+ * + * @param user 用户 + * @return 待办数量 + */ + public int getOAAndOtherTodoCount(User user) { + int qtdbCount = 0; + BaseBean baseBean = new BaseBean(); + String logindid = user.getLoginid(); + int userid = user.getUID(); + if (userid == -1) { + return 0; + } else { + RecordSet rs = new RecordSet(); + rs.executeQuery("select count(*) from uf_tbtydb where status = 0 and systemid in (select systemid from uf_tbtydbxtmc where pckq is null or pckq=0) and p13loginid=?", logindid); + if (rs.next()) { + qtdbCount = weaver.general.Util.getIntValue(rs.getString(1)); + baseBean.writeLog("getOAAndOthenTodoCount,qtdbCount:" + qtdbCount); + } + + baseBean.writeLog("getOAAndOthenTodoCount,userid:" + userid); + String oaredisKey = "weaver_wftodo" + userid; + baseBean.writeLog("oaredisKey:" + oaredisKey); + Object datas = Util_DataCache.getObjValWithRedis(oaredisKey); + int lcdbCount; + if (datas == null) { + List list = this.getToDoWorkflowRequestCount(userid + ""); + + try { + Util_DataCache.setObjValWithRedis(oaredisKey, list); + } catch (IOException e) { + baseBean.writeLog(e); + } + lcdbCount = list.size(); + } else { + String str = JSON.toJSONString(datas); + JSONArray jsonArray = JSONArray.parseArray(str); + lcdbCount = jsonArray.size(); + } + baseBean.writeLog("getOAAndOthenTodoCount,lcdbCount:" + lcdbCount); + int total = qtdbCount + lcdbCount; + baseBean.writeLog("getOAAndOthenTodoCount,total:" + total); + return qtdbCount + lcdbCount; + } + } + + /** + *

待办流程详情总数

+ * + * @param operators 操作用户 + * @return 待办流程数组 + */ + public List getToDoWorkflowRequestCount(String operators) { + RequestUtil ru = new RequestUtil(); + OfsSettingObject oso = ru.getOfsSetting(); + RecordSet rs = new RecordSet(); + List wfrequestlist = new ArrayList<>(); + try { + String remark = "'1','5','7','8','9','11'"; + String select = " select distinct "; + String fields = " t2.userid ,t2.workflowid,t2.requestid ,t2.isremark , t2.viewtype, 0 as sysid , '0' as syscode"; + String from = " from workflow_currentoperator t2 ,workflow_requestbase t1 "; + String where = " where t2.requestid = t1.requestid and t2.usertype = 0 "; + if (!"".equals(operators)) { + where = where + " and t2.userid in(" + operators + ")"; + } + where = where + " and ((t2.isremark=0 and (t2.takisremark is null or t2.takisremark=0 )) or t2.isremark in(" + remark + ")) and t2.islasttimes=1 "; + where = where + " and t2.workflowID in(select id from workflow_base where isvalid in('1','3') and workflowtype<>1 ) "; + String sql = select + fields + from + where; + rs.executeQuery(sql); + String fieldsOs; + String from_os; + String sqlwhere_os; + String workflowid; + String requestid; + while (rs.next()) { + sqlwhere_os = weaver.general.Util.null2String(rs.getString("requestid")); + workflowid = weaver.general.Util.null2String(rs.getString("syscode")); + requestid = weaver.general.Util.null2String(rs.getString("isremark")); + WorkflowRequestInfo wfrequestinfo = new WorkflowRequestInfo(); + wfrequestinfo.setRequestId(sqlwhere_os); + wfrequestinfo.setRequestId(requestid); + WorkflowBaseInfo workflowBaseInfo = new WorkflowBaseInfo(); + workflowBaseInfo.setWorkflowId(workflowid); + wfrequestinfo.setWorkflowBaseInfo(workflowBaseInfo); + wfrequestlist.add(wfrequestinfo); + } + if (oso != null && oso.getIsuse() == 1) { + fieldsOs = " t1.userid,t1.workflowid,t1.requestid,t1.isremark,t1.viewtype,t1.sysid,t1.syscode "; + from_os = " from ofs_todo_data t1 "; + sqlwhere_os = " where islasttimes=1 and isremark='0' "; + if (!operators.equals("")) { + sqlwhere_os = sqlwhere_os + " and userid in ( " + operators + ")"; + } + + sql = " select distinct " + fieldsOs + from_os + sqlwhere_os; + rs.executeQuery(sql); + + while (rs.next()) { + workflowid = weaver.general.Util.null2String(rs.getString("workflowid")); + requestid = weaver.general.Util.null2String(rs.getString("requestid")); + WorkflowRequestInfo wfrequestinfo = new WorkflowRequestInfo(); + wfrequestinfo.setRequestId(requestid); + WorkflowBaseInfo workflowBaseInfo = new WorkflowBaseInfo(); + workflowBaseInfo.setWorkflowId(workflowid); + wfrequestinfo.setWorkflowBaseInfo(workflowBaseInfo); + wfrequestlist.add(wfrequestinfo); + } + } + } catch (Exception e) { + e.printStackTrace(); + } + return wfrequestlist; + } +} diff --git a/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/vo/FunctionListVo.java b/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/vo/FunctionListVo.java new file mode 100644 index 0000000..3f988c0 --- /dev/null +++ b/src/main/java/com/api/youhong/ai/taibao/fcuntionlist/vo/FunctionListVo.java @@ -0,0 +1,30 @@ +package com.api.youhong.ai.taibao.fcuntionlist.vo; + +import lombok.Getter; +import lombok.Setter; +import lombok.ToString; + +/** + *

+ * + *

create: 2023/3/9 22:01

+ * + * @author youHong.ai + */ +@Getter +@Setter +@ToString +public class FunctionListVo { + + /** 标题 */ + private String title; + + /** 标题数字 */ + private String numUrl; + + /** 图片icon */ + private Integer image; + + /** 点击连接 */ + private String clickUrl; +} diff --git a/src/main/java/com/api/youhong/ai/taibao/qikan/controller/PeriodicalController.java b/src/main/java/com/api/youhong/ai/taibao/qikan/controller/PeriodicalController.java new file mode 100644 index 0000000..9c584f4 --- /dev/null +++ b/src/main/java/com/api/youhong/ai/taibao/qikan/controller/PeriodicalController.java @@ -0,0 +1,42 @@ +package com.api.youhong.ai.taibao.qikan.controller; + +import aiyh.utils.ApiResult; +import aiyh.utils.Util; +import com.api.youhong.ai.taibao.qikan.service.PeriodicalService; +import org.apache.log4j.Logger; + +import javax.ws.rs.Consumes; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +/** + *

期刊web端

+ * + *

create: 2023/3/10 11:28

+ * + * @author youHong.ai + */ + +@Path("aiyh/taibao/periodical") +public class PeriodicalController { + + private final PeriodicalService service = new PeriodicalService(); + + private final Logger log = Util.getLogger(); + + + @Path("/get") + @GET + @Produces(MediaType.APPLICATION_JSON) + @Consumes(MediaType.APPLICATION_JSON) + public String getPeriodicalInfo() { + try { + return ApiResult.success(service.getPeriodicalInfo()); + } catch (Exception e) { + log.error("get periodical error! " + Util.getErrString(e)); + return ApiResult.error("get periodical error!"); + } + } +} diff --git a/src/main/java/com/api/youhong/ai/taibao/qikan/mapper/PeriodicalMapper.java b/src/main/java/com/api/youhong/ai/taibao/qikan/mapper/PeriodicalMapper.java new file mode 100644 index 0000000..84dd4f0 --- /dev/null +++ b/src/main/java/com/api/youhong/ai/taibao/qikan/mapper/PeriodicalMapper.java @@ -0,0 +1,39 @@ +package com.api.youhong.ai.taibao.qikan.mapper; + +import aiyh.utils.annotation.recordset.*; +import com.api.youhong.ai.taibao.qikan.vo.PeriodicalVo; + +/** + *

+ * + *

create: 2023/3/10 11:29

+ * + * @author youHong.ai + */ +@SqlMapper +public interface PeriodicalMapper { + + + @Associations({ + @Association(property = "docImageInfo", + column = "doc_image_info", + select = "aiyh.utils.mapper.UtilMapper.selectDocImageInfo", + id = @Id(value = String.class)), + @Association( + property = "image", + column = "image", + id = @Id(value = Integer.class, methodId = 1) + ) + }) + @Select("select biaoti title,tupian image," + + "urltype url_type," + + "secid doc_image_info," + + "url url," + + "riqi date from uf_mhqikan where urltype = #{urlType}") + PeriodicalVo selectPeriodicalVo(@ParamMapper("urlType") Integer urlType); + + + @Select("select IMAGEFILEID from docimagefile where DOCID = #{docId}") + @AssociationMethod(1) + Integer selectImageFileId(Integer docId); +} diff --git a/src/main/java/com/api/youhong/ai/taibao/qikan/service/PeriodicalService.java b/src/main/java/com/api/youhong/ai/taibao/qikan/service/PeriodicalService.java new file mode 100644 index 0000000..6197675 --- /dev/null +++ b/src/main/java/com/api/youhong/ai/taibao/qikan/service/PeriodicalService.java @@ -0,0 +1,32 @@ +package com.api.youhong.ai.taibao.qikan.service; + +import aiyh.utils.Util; +import com.api.youhong.ai.taibao.qikan.mapper.PeriodicalMapper; +import com.api.youhong.ai.taibao.qikan.vo.PeriodicalVo; + +import java.util.Arrays; +import java.util.List; + +/** + *

+ * + *

create: 2023/3/10 11:28

+ * + * @author youHong.ai + */ +public class PeriodicalService { + + + private final PeriodicalMapper mapper = Util.getMapper(PeriodicalMapper.class); + + /** + *

查询期刊信息

+ * + * @return 期刊信息 + */ + public List getPeriodicalInfo() { + PeriodicalVo periodicalVoLeft = mapper.selectPeriodicalVo(0); + PeriodicalVo periodicalVoRight = mapper.selectPeriodicalVo(1); + return Arrays.asList(periodicalVoLeft, periodicalVoRight); + } +} diff --git a/src/main/java/com/api/youhong/ai/taibao/qikan/vo/PeriodicalVo.java b/src/main/java/com/api/youhong/ai/taibao/qikan/vo/PeriodicalVo.java new file mode 100644 index 0000000..8c8c4a0 --- /dev/null +++ b/src/main/java/com/api/youhong/ai/taibao/qikan/vo/PeriodicalVo.java @@ -0,0 +1,44 @@ +package com.api.youhong.ai.taibao.qikan.vo; + +import aiyh.utils.annotation.recordset.SqlOracleDbFieldAnn; +import aiyh.utils.entity.DocImageInfo; +import lombok.Getter; +import lombok.Setter; +import lombok.ToString; + +/** + *

+ * + *

create: 2023/3/10 11:33

+ * + * @author youHong.ai + */ +@Getter +@Setter +@ToString +public class PeriodicalVo { + /** 标题 */ + @SqlOracleDbFieldAnn("TITLE") + private String title; + + /** 图片 */ + @SqlOracleDbFieldAnn("IMAGE") + private Integer image; + + /** 地址类型 0 - 外部系统 1 - 文档 */ + @SqlOracleDbFieldAnn("URL_TYPE") + private Integer urlType; + + /** 附件信息 */ + @SqlOracleDbFieldAnn("DOC_IMAGE_INFO") + private DocImageInfo docImageInfo; + // private Integer docImageInfo; + + /** 外部地址 */ + @SqlOracleDbFieldAnn("URL") + private String url; + + /** 日期 */ + @SqlOracleDbFieldAnn("DATE") + private String date; +} diff --git a/src/main/java/com/customization/shyl/service/impl/MeetingRoomAddCusAopService.java b/src/main/java/com/customization/shyl/service/impl/MeetingRoomAddCusAopService.java new file mode 100644 index 0000000..031edfb --- /dev/null +++ b/src/main/java/com/customization/shyl/service/impl/MeetingRoomAddCusAopService.java @@ -0,0 +1,88 @@ +package com.customization.shyl.service.impl; + +import aiyh.utils.Util; +import com.alibaba.fastjson.JSONObject; +import com.api.xuanran.wang.shyl.entity.meeting.MeetingCusFieldConfigMain; +import com.api.xuanran.wang.shyl.mapper.MeetingMapper; +import com.engine.core.cfg.annotation.CommandDynamicProxy; +import com.engine.core.interceptor.AbstractCommandProxy; +import com.engine.core.interceptor.Command; +import com.engine.meeting.cmd.meetingroom.DoAddRoomCmd; +import com.weaverboot.frame.ioc.anno.methodAnno.WeaReplaceAfter; +import com.weaverboot.frame.ioc.handler.replace.weaReplaceParam.impl.WeaAfterReplaceParam; +import org.apache.commons.lang3.StringUtils; +import org.apache.log4j.Logger; +import org.springframework.util.Assert; + +import javax.servlet.http.HttpServletRequest; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + *

会议室新增时将自定义字段写入后端数据库

+ * + * @author xuanran.wang + * @date 2023/3/1 16:18 + */ +//@WeaIocReplaceComponent("MeetingRoomAddCusAopService") +@CommandDynamicProxy(target = DoAddRoomCmd.class, desc="会议室新增时将自定义字段写入后端数据库") +public class MeetingRoomAddCusAopService extends AbstractCommandProxy> { + private final Logger logger = Util.getLogger(); + private final MeetingMapper meetingMapper = Util.getMapper(MeetingMapper.class); + + @Override + public Map execute(Command> command) { + DoAddRoomCmd doAddRoomCmd = (DoAddRoomCmd) command; + Map request = doAddRoomCmd.getParams(); + Map result = nextExecute(command); + try { + String id = Util.null2DefaultStr(result.get("id"),""); + logger.info("------------ addRoomAfterCmd start------------"); + logger.info("roomId : " + id); + changeMeetingInfo(id,request); + logger.info("------------ addRoomAfterCmd end------------"); + }catch (Exception e){ + logger.error(Util.logStr("addRoomAfter error: {}", e.getMessage())); + } + return result; + } + + /** + *

修改会议表参数

+ * @author xuanran.wang + * @dateTime 2023/3/2 14:49 + * @param roomId 会议室id + * @param request 请求参数 + **/ + public void changeMeetingInfo(String roomId, Map request){ + if(StringUtils.isNotBlank(roomId)){ + List config = meetingMapper.queryMeetingCusConfigMain(); + Assert.notNull(config, "查询会议室新增字段配置为空!"); + HashMap params = new HashMap<>(); + for (MeetingCusFieldConfigMain main : config) { + // 数据库字段 + String fieldOnlyMark = main.getFieldOnlyMark(); + // 接口字段值 + String requestValue = Util.null2DefaultStr(request.get(fieldOnlyMark),""); + params.put(fieldOnlyMark, requestValue); + } + StringBuilder sb = new StringBuilder("update "); + sb.append("meetingroom").append(" set "); + for (Map.Entry entry : params.entrySet()) { + sb.append(entry.getKey()) + .append(" = #{") + .append(entry.getKey()) + .append("},"); + } + sb.deleteCharAt(sb.length() - 1); + sb.append(" where id = ").append(roomId); + String sql = sb.toString(); + boolean success = meetingMapper.updateMeetingRoom(sql, params); + if(!success){ + logger.info("更新会议室表失败!"); + } + } + } + +} diff --git a/src/main/java/com/customization/shyl/service/impl/MeetingRoomEditCusAopService.java b/src/main/java/com/customization/shyl/service/impl/MeetingRoomEditCusAopService.java new file mode 100644 index 0000000..66921c8 --- /dev/null +++ b/src/main/java/com/customization/shyl/service/impl/MeetingRoomEditCusAopService.java @@ -0,0 +1,41 @@ +package com.customization.shyl.service.impl; + +import aiyh.utils.Util; +import com.engine.core.cfg.annotation.CommandDynamicProxy; +import com.engine.core.interceptor.AbstractCommandProxy; +import com.engine.core.interceptor.Command; +import com.engine.meeting.cmd.meetingroom.DoAddRoomCmd; +import com.engine.meeting.cmd.meetingroom.DoEditRoomCmd; +import com.engine.meeting.cmd.meetingroom.GetRoomFieldsCmd; +import org.apache.log4j.Logger; + +import java.util.Map; + +/** + *

会议室编辑时将自定义字段写入后端数据库

+ * + * @author xuanran.wang + * @date 2023/3/2 14:45 + */ +@CommandDynamicProxy(target = DoEditRoomCmd.class, desc="会议室编辑时将自定义字段返回") +public class MeetingRoomEditCusAopService extends AbstractCommandProxy> { + private final Logger logger = Util.getLogger(); + + private final MeetingRoomAddCusAopService roomAddCusAopService = new MeetingRoomAddCusAopService(); + @Override + public Map execute(Command> command) { + DoEditRoomCmd doEditRoomCmd = (DoEditRoomCmd) command; + Map request = doEditRoomCmd.getParams(); + Map result = nextExecute(command); + try { + String id = Util.null2DefaultStr(request.get("roomid"),""); + logger.info("------------ editRoomAfterCmd start ------------"); + logger.info("roomId : " + id); + roomAddCusAopService.changeMeetingInfo(id, request); + logger.info("------------ editRoomAfterCmd end ------------"); + }catch (Exception e){ + logger.error(Util.logStr("editRoomAfter error: {}", e.getMessage())); + } + return result; + } +} diff --git a/src/main/java/com/customization/shyl/service/impl/MeetingRoomLookCusAopService.java b/src/main/java/com/customization/shyl/service/impl/MeetingRoomLookCusAopService.java new file mode 100644 index 0000000..38eda7c --- /dev/null +++ b/src/main/java/com/customization/shyl/service/impl/MeetingRoomLookCusAopService.java @@ -0,0 +1,123 @@ +package com.customization.shyl.service.impl; + +import aiyh.utils.Util; +import com.alibaba.fastjson.JSONObject; +import com.api.browser.bean.SearchConditionOption; +import com.api.meeting.util.FieldUtil; +import com.api.xuanran.wang.shyl.entity.meeting.MeetingCusFieldConfigDetail; +import com.api.xuanran.wang.shyl.entity.meeting.MeetingCusFieldConfigMain; +import com.api.xuanran.wang.shyl.mapper.MeetingMapper; +import com.engine.core.cfg.annotation.CommandDynamicProxy; +import com.engine.core.interceptor.AbstractCommandProxy; +import com.engine.core.interceptor.Command; +import com.engine.meeting.cmd.meetingroom.DoAddRoomCmd; +import com.engine.meeting.cmd.meetingroom.GetRoomFieldsCmd; +import com.weaverboot.frame.ioc.anno.classAnno.WeaIocReplaceComponent; +import com.weaverboot.frame.ioc.anno.methodAnno.WeaReplaceAfter; +import com.weaverboot.frame.ioc.handler.replace.weaReplaceParam.impl.WeaAfterReplaceParam; +import org.apache.commons.lang3.StringUtils; +import org.apache.log4j.Logger; +import org.springframework.util.Assert; + +import javax.servlet.http.HttpServletRequest; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + *

会议室查看时将自定义字段返回

+ * + * @author xuanran.wang + * @date 2023/3/1 17:04 + */ +@CommandDynamicProxy(target = GetRoomFieldsCmd.class, desc="会议室查看时将自定义字段返回") +public class MeetingRoomLookCusAopService extends AbstractCommandProxy> { + private final MeetingMapper meetingMapper = Util.getMapper(MeetingMapper.class); + private final Logger log = Util.getLogger(); + /** + *

可编辑

+ **/ + private static final int EDIT = 2; + /** + *

数字

+ **/ + private static final int NUMBER = 0; + /** + *

下拉框

+ **/ + private static final int SELECT_TYPE = 1; + /** + *

文本

+ **/ + private static final int TEXT = 2; + + @Override + public Map execute(Command> command) { + GetRoomFieldsCmd getRoomFieldsCmd = (GetRoomFieldsCmd) command; + Map params = getRoomFieldsCmd.getParams(); + Map res = nextExecute(command); + String roomId = Util.null2DefaultStr(params.get("roomid"), ""); + try { + log.info("------------ lookRoomAfterCmd ------------"); + Map map = new HashMap<>(); + if(StringUtils.isNotBlank(roomId)){ + map = meetingMapper.queryMeetingRoom(roomId); + Assert.notNull(map, "根据会议室id查询会议室信息为空!"); + } + + List config = meetingMapper.queryMeetingCusConfigMain(); + Assert.notNull(config, "查询会议室新增字段配置为空!"); + + List> fields = (List>) res.get("fields"); + Assert.notNull(fields, "接口返回fields为空!"); + + Map roomAddress = fields.get(1); + Assert.notNull(roomAddress, "fields.get(1)为空!"); + + List> roomAddressFields = (List>) roomAddress.get("items"); + Assert.notNull(roomAddressFields, "roomAddressFields为空!"); + + for (MeetingCusFieldConfigMain configMain : config) { + Map item = null; + // 数据库字段 + String dbField = configMain.getFieldOnlyMark(); + // 当前值 + String currentValue = Util.null2DefaultStr(map.get(dbField), ""); + // 前端显示名称 + String fieldName = configMain.getFieldName(); + int fieldType = configMain.getFieldType(); + // 下拉框 + if (fieldType == SELECT_TYPE) { + List options = getOptions(currentValue, configMain.getOptions()); + item = FieldUtil.getFormItemForSelect(dbField, fieldName, currentValue, EDIT, options); + } else if(fieldType == NUMBER) { + item = FieldUtil.getFormItemForInputNumber(dbField, fieldName, currentValue, -999, 999, EDIT); + }else if(fieldType == TEXT){ + item = FieldUtil.getFormItemForInput(dbField, fieldName, currentValue, EDIT); + } + roomAddressFields.add(item); + } + fields.remove(1); + roomAddress.put("items", roomAddressFields); + fields.add(roomAddress); + res.put("fields", fields); + } catch (Exception e) { + log.error(Util.logStr("lookRoomAfter error : {}", e.getMessage())); + } + return res; + + } + + public List getOptions(String currentValue, + List details) { + List options = new ArrayList<>(); + for (MeetingCusFieldConfigDetail option : details) { + String key = option.getSelectKey(); + options.add(new SearchConditionOption(key, option.getSelectShowName(), key.equals(currentValue))); + } + return options; + } + + +} diff --git a/src/main/java/weaver/xuanran/wang/bme/action/ContractApplyComDateAction.java b/src/main/java/weaver/xuanran/wang/bme/action/ContractApplyComDateAction.java index 2739c08..55478d3 100644 --- a/src/main/java/weaver/xuanran/wang/bme/action/ContractApplyComDateAction.java +++ b/src/main/java/weaver/xuanran/wang/bme/action/ContractApplyComDateAction.java @@ -2,14 +2,22 @@ package weaver.xuanran.wang.bme.action; import aiyh.utils.Util; import aiyh.utils.action.SafeCusBaseAction; +import aiyh.utils.annotation.PrintParamMark; import aiyh.utils.annotation.RequiredMark; import aiyh.utils.excention.CustomerException; +import org.apache.commons.collections.CollectionUtils; import org.apache.commons.lang3.StringUtils; -import weaver.conn.RecordSetTrans; +import org.apache.log4j.Logger; +import weaver.conn.RecordSet; +import weaver.general.TimeUtil; import weaver.hrm.User; +import weaver.interfaces.workflow.action.Action; +import weaver.soa.workflow.request.Property; import weaver.soa.workflow.request.RequestInfo; +import weaver.workflow.request.RequestManager; + +import java.util.*; -import java.util.Map; /** *

柏美施工合同修改日期action

@@ -17,49 +25,97 @@ import java.util.Map; * @Author xuanran.wang * @Date 2022/12/20 11:33 */ -public class ContractApplyComDateAction extends SafeCusBaseAction { +public class ContractApplyComDateAction implements Action { /** *

施工合同项目字段

**/ @RequiredMark + @PrintParamMark private String buildContractProjectField; /** *

施工合同主表名

**/ @RequiredMark + @PrintParamMark private String buildContractTable; /** *

施工合同明细表表名

**/ @RequiredMark + @PrintParamMark private String detailContractTable; /** *

施工合同明细表更新日期字段

**/ @RequiredMark + @PrintParamMark private String detailContractDateFiled; /** *

验收流程项目字段

**/ @RequiredMark + @PrintParamMark private String projectField; /** *

验收流程日期字段

**/ @RequiredMark + @PrintParamMark private String checkDateField; + /** - *

明细表更新验收日期的条件

+ *

明细前后字段

**/ - private String updateWhere; + @RequiredMark + private String beforeBackField; + + /** + *

明细表天数

+ **/ + @RequiredMark + @PrintParamMark + private String dayField; + + /** + *

更新条件字段

+ **/ + @RequiredMark + @PrintParamMark + private String whereField; + + /** + *

更新条件值

+ **/ + @RequiredMark + @PrintParamMark + private String whereValues; + + /** + *

嵌套条件自定义sql

+ *

+ * select a.id,a.requestid + * from + * formtable_main_58 a + * right join uf_cgdd b + * on a.id = b.cght + * where b.id = 874; + *

+ **/ + @PrintParamMark + private String relationSql; + private static final String BEFORE = "0"; + + private final Logger log = Util.getLogger(); @Override - public void doSubmit(String requestId, String billTable, int workflowId, User user, RequestInfo requestInfo) { + public String execute(RequestInfo requestInfo) { + String requestId = requestInfo.getRequestid(); log.info(Util.logStr("--------------- requestId : {} Begin ---------------", requestId)); - RecordSetTrans rs = new RecordSetTrans(); - rs.setAutoCommit(false); + RecordSet rs = new RecordSet(); + RequestManager requestManager = requestInfo.getRequestManager(); try { + Util.verifyRequiredField(this); Map mainTableValue = getMainTableValue(requestInfo); // 验收流程的实际验收日期 String checkDate = mainTableValue.get(checkDateField); @@ -68,25 +124,79 @@ public class ContractApplyComDateAction extends SafeCusBaseAction { log.error(Util.logStr("checkDate:{}, project:{}", checkDate, project)); throw new CustomerException("实际验收日期或项目字段字段为空!"); } - String selectSql = "select id from " + buildContractTable + " where " + buildContractProjectField + " = ?"; + String selectSql = "select id,requestid from " + buildContractTable + " where " + buildContractProjectField + " = ?"; + if(StringUtils.isNotBlank(relationSql)){ + selectSql = relationSql; + } + log.info(Util.logStr("查询主表数据sql: {}, 参数: {}", selectSql, project)); if(rs.executeQuery(selectSql, project) && rs.next()){ String mainId = rs.getString("id"); - String updateSql = "update " + detailContractTable + " set " + detailContractDateFiled + " = ? where mainid = ?"; - if(StringUtils.isNotBlank(updateWhere)){ - updateSql += " and " + updateWhere; + String tempRequestId = rs.getString("requestid"); + // 查明细表数据 + selectSql = "select * from " + detailContractTable + " where " + whereField + " in ( " + whereValues + " ) and mainid = ?"; + log.info(Util.logStr("查明细表数据sql: {}, 参数: {}", selectSql, mainId)); + String updateSql = "update " + detailContractTable + " set " + detailContractDateFiled + " = ? where id = ?"; + log.info(Util.logStr("更新表单数据sql : {}", updateSql)); + List params = new ArrayList<>(); + if (rs.executeQuery(selectSql, mainId)) { + while (rs.next()) { + ArrayList param = new ArrayList<>(); + int temp = 1; + // 前还是后 + String beforeBack = rs.getString(beforeBackField); + // 天数 + String dayStr = rs.getString(dayField); + if(StringUtils.isBlank(beforeBack) || StringUtils.isBlank(dayStr)){ + continue; + } + if(BEFORE.equals(beforeBack)){ + temp = -1; + } + int day = Util.getIntValue(dayStr,1); + String computeDate = TimeUtil.dateAdd(checkDate, temp * day); + param.add(computeDate); + param.add(rs.getString("id")); + params.add(param); + log.info(Util.logStr("关联流程requestId: {}, 流程明细前后字段: {}, 天数: {}, 计算后的日期: {}",tempRequestId, beforeBack, day, computeDate)); + } } - log.info(Util.logStr("更新合同明细表sql:{}, 参数:{}, {}", updateSql, checkDate, mainId)); - if(!rs.executeUpdate(updateSql, checkDate, mainId)){ - throw new CustomerException("更新合同sql错误!"); + if(CollectionUtils.isNotEmpty(params)){ + if(!rs.executeBatchSql(updateSql,params)){ + log.error(Util.logStr("更新sql : {}, 参数 : {}", updateSql, params)); + throw new CustomerException("更新合同sql错误!"); + } + }else { + log.error(Util.logStr("明细表: {}不存在数据!", detailContractTable)); } - rs.commit(); + }else{ - log.error(Util.logStr("查询施工合同关联项目sql暂未查到数据! sql {} ,{}", selectSql, requestId)); + log.error(Util.logStr("查询关联项目sql暂未查到数据! sql {} ,{}", selectSql, requestId)); } + return Action.SUCCESS; }catch (Exception e){ - rs.rollback(); - throw new CustomerException(Util.logStr("更新施工合同实际验收日期发生异常: {} ", e.getMessage())); + log.error(Util.logStr("execute action fail, exception message is [{}], error stack trace msg is: \n{}", + e.getMessage(), Util.getErrString(e))); + return Util.actionFail(requestManager,Util.logStr("更新日期发生异常: {} ", e.getMessage())); } } + protected Map getMainTableValue(RequestInfo requestInfo) { + // 获取主表数据 + Property[] propertyArr = requestInfo.getMainTableInfo().getProperty(); + return getStringMap(propertyArr); + } + + private Map getStringMap(Property[] propertyArr) { + if (null == propertyArr) { + return Collections.emptyMap(); + } + Map mainTable = new HashMap<>((int) Math.ceil(propertyArr.length * 1.4)); + for (Property property : propertyArr) { + String fieldName = property.getName(); + String value = property.getValue(); + mainTable.put(fieldName, value); + } + return mainTable; + } + } diff --git a/src/main/java/weaver/xuanran/wang/bme/action/CusCreateWaterNoAction.java b/src/main/java/weaver/xuanran/wang/bme/action/CusCreateWaterNoAction.java index e129c0b..45ff7cc 100644 --- a/src/main/java/weaver/xuanran/wang/bme/action/CusCreateWaterNoAction.java +++ b/src/main/java/weaver/xuanran/wang/bme/action/CusCreateWaterNoAction.java @@ -152,9 +152,13 @@ public class CusCreateWaterNoAction extends SafeCusBaseAction { } if(endInt < 10){ endStr = "0" + endInt; + }else { + endStr = "" + endInt; } if(frontInt < 10){ frontStr = "0" + frontInt; + }else { + frontStr = "" + frontInt; } res = frontStr + "." + endStr; } @@ -162,6 +166,9 @@ public class CusCreateWaterNoAction extends SafeCusBaseAction { } LinkedHashMap map = new LinkedHashMap<>(); String serialCode = inventoryCode + "." + res; + if(serialCode.charAt(0) == '0'){ + serialCode = serialCode.substring(1); + } map.put("invClassificationCode", inventoryCode); map.put("serialNumber", res); map.put("serialCode", serialCode); diff --git a/src/main/java/weaver/xuanran/wang/bme/action/TransOrderApproval.java b/src/main/java/weaver/xuanran/wang/bme/action/TransOrderApproval.java new file mode 100644 index 0000000..ac4174a --- /dev/null +++ b/src/main/java/weaver/xuanran/wang/bme/action/TransOrderApproval.java @@ -0,0 +1,36 @@ +package weaver.xuanran.wang.bme.action; + +import aiyh.utils.Util; +import aiyh.utils.action.SafeCusBaseAction; +import aiyh.utils.annotation.PrintParamMark; +import aiyh.utils.annotation.RequiredMark; +import aiyh.utils.excention.CustomerException; +import weaver.hrm.User; +import weaver.soa.workflow.request.RequestInfo; +import weaver.soa.workflow.request.RequestService; +import weaver.xuanran.wang.bme.service.PushDataService; + +/** + *

调拨单审核action 将流程数据推送到u8

+ * + * @author xuanran.wang + * @date 2023/2/21 13:19 + */ +public class TransOrderApproval extends SafeCusBaseAction { + /** + *

配置唯一标识

+ **/ + @PrintParamMark + @RequiredMark + private String onlyMark; + + private final PushDataService pushDataService = new PushDataService(); + @Override + public void doSubmit(String requestId, String billTable, int workflowId, User user, RequestInfo requestInfo) { + try { + pushDataService.pushData(onlyMark, requestId, billTable); + }catch (Exception e){ + throw new CustomerException(Util.logStr("TransOrderApproval error : {}", e.getMessage())); + } + } +} diff --git a/src/main/java/weaver/xuanran/wang/bme/action/UpdateModelInfo.java b/src/main/java/weaver/xuanran/wang/bme/action/UpdateModelInfo.java new file mode 100644 index 0000000..2b44e2f --- /dev/null +++ b/src/main/java/weaver/xuanran/wang/bme/action/UpdateModelInfo.java @@ -0,0 +1,190 @@ +package weaver.xuanran.wang.bme.action; + +import aiyh.utils.Util; +import aiyh.utils.annotation.PrintParamMark; +import aiyh.utils.annotation.RequiredMark; +import aiyh.utils.excention.CustomerException; +import aiyh.utils.sqlUtil.sqlResult.impl.PrepSqlResultImpl; +import aiyh.utils.sqlUtil.whereUtil.Where; +import com.alibaba.fastjson.JSONObject; +import org.apache.commons.lang3.StringUtils; +import org.apache.log4j.Logger; +import weaver.conn.RecordSet; +import weaver.conn.RecordSetTrans; +import weaver.interfaces.workflow.action.Action; +import weaver.soa.workflow.request.RequestInfo; +import weaver.workflow.request.RequestManager; + +import java.util.HashMap; +import java.util.List; + +/** + *

更新采购/施工合同建模数据

+ *

沙雕代码

+ * @author xuanran.wang + * @date 2022/12/13 11:13 + */ +public class UpdateModelInfo implements Action { + + private final Logger log = Util.getLogger(); + + /** + *

订单类型 glddxx

+ **/ + @PrintParamMark + @RequiredMark + private String orderType; + + /** + *

施工合同表名

+ * select * from formtable_main_62 where htbh = 'D520230209001' + **/ + @PrintParamMark + @RequiredMark + private String sgTable; + + /** + *

施工合同明细表名

+ * select * from formtable_main_62 where htbh = 'D520230209001' + **/ + @PrintParamMark + @RequiredMark + private String sgDetailTable; + /** + *

采购合同表名

+ **/ + @PrintParamMark + @RequiredMark + private String cgTable; + /** + *

采购合同明细表名

+ **/ + @PrintParamMark + @RequiredMark + private String cgDetailTable; + + /** + *

更新字段映射关系

+ *

bcfkje:sjfkje,sjfkrq:sjfkrq

+ **/ + @PrintParamMark + @RequiredMark + private String sgFieldMapping; + /** + *

更新字段映射关系

+ *

bcfkje:fkje,sjfkrq:sjfkrq

+ **/ + @PrintParamMark + @RequiredMark + private String cgFieldMapping; + /** + *

采购合同流程关联字段

+ **/ + @PrintParamMark + @RequiredMark + private String cgModelRelationField; + /** + *

施工合同流程关联字段

+ * htbh + **/ + @PrintParamMark + @RequiredMark + private String sgModelRelationField; + /** + *

订单号

+ **/ + private static final String DDH = "ddh"; + /** + *

款项类型

+ **/ + private static final String KXLX = "kxlx"; + + @Override + public String execute(RequestInfo requestInfo) { + RecordSetTrans rsts = new RecordSetTrans(); + RequestManager requestManager = requestInfo.getRequestManager(); + String requestId = requestInfo.getRequestid(); + String billTable = requestManager.getBillTableName(); + rsts.setAutoCommit(false); + log.info("UpdateModelInfo begin ===== " + requestId); + try { + Util.verifyRequiredField(this); + String sql = "select * from " + billTable + " where requestid = ?"; + // 查询的建模表单名称 + String modelTableName = ""; + RecordSet mainRs = new RecordSet(); + // 建模表关联流程sql + String relationField = ""; + // 建模更新表名 + String updateTable = ""; + String fieldMapping = ""; + if (mainRs.executeQuery(sql, requestId) && mainRs.next()) { + String orderTypeVal = mainRs.getString(orderType); + switch (orderTypeVal){ + case "0":{ + modelTableName = cgTable; + relationField += cgModelRelationField; + updateTable = cgDetailTable; + fieldMapping = cgFieldMapping; + }break; + case "1":{ + modelTableName = sgTable; + relationField += sgModelRelationField; + updateTable = sgDetailTable; + fieldMapping = sgFieldMapping; + break; + } + } + String modelMainRsSql = "select id from " + modelTableName + " where " + relationField + " = ?"; + log.info("查询关联建模主表数据id sql " + modelMainRsSql); + // 建模明细表 + RecordSet detailRs = new RecordSet(); + String mainId = mainRs.getString("id"); + RecordSet modelMainRs = new RecordSet(); + + String detail3Sql = "select * from " + billTable + "_dt3 where mainid = ?"; + detailRs.executeQuery(detail3Sql, mainId); + while (detailRs.next()) { + // 订单号 + String orderIdVal = detailRs.getString(DDH); + if(StringUtils.isBlank(orderIdVal)) { + continue; + } + String modelMainId = ""; + if (modelMainRs.executeQuery(modelMainRsSql, orderIdVal) && modelMainRs.next()) { + modelMainId = modelMainRs.getString("id"); + } + log.info("orderIdVal : " + orderIdVal); + String[] split = fieldMapping.split(","); + HashMap params = new HashMap<>(); + Where where = Util.createPrepWhereImpl() + .whereAnd("mainid") + .whereEqual(modelMainId) + .whereAnd(KXLX) + .whereEqual(Util.null2DefaultStr(detailRs.getString(KXLX),"")); + for (String field : split) { + String[] fields = field.split(":"); + params.put(fields[1], Util.null2DefaultStr(detailRs.getString(fields[0]),"")); + } + PrepSqlResultImpl updateSql = Util.createSqlBuilder().updateSql(updateTable, params, where); + String sqlStr = updateSql.getSqlStr(); + List args = updateSql.getArgs(); + log.info("更新表单sql : " + sqlStr); + log.info("参数 : " + JSONObject.toJSONString(args)); + if(!rsts.executeUpdate(sqlStr, args)){ + throw new CustomerException("执行更新sql失败! 当前sql : " + sqlStr + " 参数 : " + JSONObject.toJSONString(args)); + } + } + rsts.commit(); + } + return Action.SUCCESS; + }catch (Exception e){ + rsts.rollback(); + String error = Util.logStr("UpdateModelInfo error : {}", e.getMessage()); + log.error(error); + requestManager.setMessageid(System.currentTimeMillis() + ""); + requestManager.setMessagecontent(error); + return Action.FAILURE_AND_CONTINUE; + } + } +} diff --git a/src/main/java/weaver/xuanran/wang/bme/service/PushDataService.java b/src/main/java/weaver/xuanran/wang/bme/service/PushDataService.java new file mode 100644 index 0000000..1b4143c --- /dev/null +++ b/src/main/java/weaver/xuanran/wang/bme/service/PushDataService.java @@ -0,0 +1,95 @@ +package weaver.xuanran.wang.bme.service; + +import aiyh.utils.Util; +import aiyh.utils.excention.CustomerException; +import aiyh.utils.httpUtil.ResponeVo; +import aiyh.utils.httpUtil.util.HttpUtils; +import aiyh.utils.tool.Assert; +import com.alibaba.fastjson.JSON; +import com.fasterxml.jackson.core.JsonProcessingException; +import org.apache.commons.collections.CollectionUtils; +import org.apache.commons.lang3.StringUtils; +import org.apache.log4j.Logger; +import weaver.conn.RecordSet; +import weaver.xiao.commons.config.entity.RequestMappingConfig; +import weaver.xiao.commons.config.service.DealWithMapping; +import weaver.xuanran.wang.schroeder.mapper.SchroederMapper; + +import javax.ws.rs.core.MediaType; +import java.io.IOException; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + *

数据推送方法

+ * + * @author xuanran.wang + * @date 2023/2/21 13:21 + */ +public class PushDataService { + + private static final int SUCCESS_CODE = 200; + /** + *

接口响应信息

+ **/ + private static final String MESSAGE_FIELD = "Message"; + /** + *

业务处理成功/失败标识

+ */ + private static final String SUCCESS_FIELD = "Success"; + /** + *

requestId记录表名

+ **/ + private final DealWithMapping dealWithMapping = new DealWithMapping(); + private final Logger log = Util.getLogger(); // 获取日志对象 + private final HttpUtils httpUtils = new HttpUtils(); + + { + httpUtils.getGlobalCache().header.put("Content-Type", MediaType.APPLICATION_JSON); // 全局请求头 + } + + /** + *

数据推送

+ * @author xuanran.wang + * @dateTime 2023/2/21 13:34 + * @param onlyMark 建模配置表唯一标识 + * @param requestId 请求id + * @param tableName 表名 + **/ + public void pushData(String onlyMark, + String requestId, + String tableName) throws IOException { + RequestMappingConfig requestMappingConfig = dealWithMapping.treeDealWithUniqueCode(onlyMark); + dealWithMapping.setMainTable(tableName); + String cusWhere = Util.null2DefaultStr(requestMappingConfig.getCusWhereSql(), ""); + if (StringUtils.isNotBlank(cusWhere)) { + cusWhere = DealWithMapping.sbc2dbcCase(cusWhere); // 全角转半角 + } + String url = requestMappingConfig.getRequestUrl(); + String selectMainSql = "select * from " + tableName + " where requestid = ? " + cusWhere; + log.info(Util.logStr("查询主表数据sql : {}, requestId : {}", selectMainSql, requestId)); + RecordSet recordSet = new RecordSet(); + recordSet.executeQuery(selectMainSql, requestId); + if (recordSet.next()) { + dealWithMapping.setMainTable(tableName); + List listParam = dealWithMapping.getRequestListParam(recordSet, requestMappingConfig); + Assert.isNull(listParam,"流程生成JSON失败!"); + ResponeVo responseVo = httpUtils.apiPost(url, listParam,new HashMap<>()); + Map headers = httpUtils.getGlobalCache().header;// 全局请求头 + if (responseVo.getCode() != SUCCESS_CODE) { // 相应状态码 + log.error(Util.logStr("can not fetch [{}]，this request params is [{}]，" + // 构建日志字符串 + "this request heard is [{}]，but response status code is [{}]，" + + "this response is [{}]", url, JSON.toJSON(listParam), JSON.toJSONString(headers), responseVo.getCode(), // 相应状态码 + responseVo.getEntityString())); // 相应内容 + throw new CustomerException(Util.logStr("can not fetch [{}]", url)); // 自定义异常类 create 2022/3/9 2:20 PM 构建日志字符串 + } + Map response = responseVo.getResponseMap(); // 根据相应结果转化为map集合 + Boolean success = (Boolean) response.get(SUCCESS_FIELD); + if (!success) { + throw new CustomerException(Util.logStr("接口响应码不为 : [{}],接口响应信息: {}", success, Util.null2DefaultStr(response.get(MESSAGE_FIELD), ""))); // 自定义异常类 create 2022/3/9 2:20 PM 构建日志字符串 + } + } + } + +} diff --git a/src/main/java/weaver/xuanran/wang/common/annocation/Map2JSONConvert.java b/src/main/java/weaver/xuanran/wang/common/annocation/Map2JSONConvert.java new file mode 100644 index 0000000..80d5611 --- /dev/null +++ b/src/main/java/weaver/xuanran/wang/common/annocation/Map2JSONConvert.java @@ -0,0 +1,25 @@ +package weaver.xuanran.wang.common.annocation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + *

map转json注解

+ * + * @author xuanran.wang + * @date 2023/2/25 15:22 + */ +@Target({ElementType.FIELD,ElementType.TYPE}) +@Retention(RetentionPolicy.RUNTIME) +public @interface Map2JSONConvert { + /** + *

map字段名

+ **/ + String mapField() default ""; + /** + *

json字段名

+ **/ + String jsonField() default ""; +} diff --git a/src/main/java/weaver/xuanran/wang/common/mapper/CommonMapper.java b/src/main/java/weaver/xuanran/wang/common/mapper/CommonMapper.java index b932268..ec35493 100644 --- a/src/main/java/weaver/xuanran/wang/common/mapper/CommonMapper.java +++ b/src/main/java/weaver/xuanran/wang/common/mapper/CommonMapper.java @@ -42,6 +42,25 @@ public interface CommonMapper { boolean deleteModelDataByIds(@ParamMapper("tableName") String tableName, @ParamMapper("ids") List ids); + /** + *

通过requestId删除流程表数据

+ * @author xuanran.wang + * @dateTime 2022/11/17 10:41 + * @param tableName 流程表名 + * @param requestIds 请求id集合 + * @return 删除是否成功 + **/ + @Delete("delete from $t{tableName} where requestid in (${requestIds})") + boolean deleteWorkflowDataByRequestIds(@ParamMapper("tableName") String tableName, + @ParamMapper("requestIds") List requestIds); + + /** + *

根据模块id查询数据审批配置

+ * @author xuanran.wang + * @dateTime 2023/2/22 15:17 + * @param modelId 模块id + * @return + **/ @Select("SELECT mp.id,m.formId,mpd.triggerWorkflowSetId " + "FROM MODE_PageExpand mp " + "INNER JOIN modeInfo m " + @@ -51,10 +70,46 @@ public interface CommonMapper { "WHERE mp.modeid = #{modelId} AND mp.isSystem = 1 AND mp.iSSystemFlag = 1") Map getExpendConfigByModeId(@ParamMapper("modelId") int modelId); + /** + *

TODO

+ * @author xuanran.wang + * @dateTime 2023/2/22 15:37 + * @param triggerId 数据审批id + * @return + **/ @Select("select * from mode_triggerworkflowset where id = #{triggerId}") Map getConfigByTriggerId(@ParamMapper("triggerId") String triggerId); + /** + *

TODO

+ * @author xuanran.wang + * @dateTime 2023/2/22 15:38 + * @param triggerId + * @return + **/ @Select("select showcondition from mode_triggerworkflowset where id = #{triggerId}") String getConditionByTriggerId(@ParamMapper("triggerId") String triggerId); + /** + *

根据流程id获取流程表名

+ * @author xuanran.wang + * @dateTime 2023/2/22 15:38 + * @param workflowId 流程id + * @return 表id + **/ + @Select("select tablename from workflow_bill a right join workflow_base b on a.id = b.FORMID where b.id = #{workflowId}") + String queryTableNameByWorkflowId(@ParamMapper("workflowId") int workflowId); + + /** + *

根据请求id获取会议id

+ * @author xuanran.wang + * @dateTime 2023/2/22 15:38 + * @param requestId 请求id + * @return 查询会议id + **/ + @Select("select id from meeting where requestid = #{requestId}") + String queryMeetingIdByRequestId(@ParamMapper("requestId") String requestId); + + @Update("update meeting set meetingstatus = 4 where requestid in (${requestIds})") + boolean cancelMeeting(@ParamMapper("requestIds") List requestIds); } diff --git a/src/main/java/weaver/xuanran/wang/common/util/CommonUtil.java b/src/main/java/weaver/xuanran/wang/common/util/CommonUtil.java index 2ddb52d..818b3f0 100644 --- a/src/main/java/weaver/xuanran/wang/common/util/CommonUtil.java +++ b/src/main/java/weaver/xuanran/wang/common/util/CommonUtil.java @@ -18,6 +18,8 @@ import weaver.xuanran.wang.common.annocation.ParamNotNull; import weaver.xuanran.wang.common.annocation.ParamPrint; import weaver.xuanran.wang.common.mapper.CommonMapper; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; import java.io.*; import java.lang.reflect.Field; import java.nio.charset.Charset; @@ -274,6 +276,7 @@ public class CommonUtil { ).filter(b -> !b.isEmpty()) .collect(Collectors.toList()); } + /** *

通过自定义日期注解转换参数值

* @author xuanran.wang @@ -618,6 +621,40 @@ public class CommonUtil { return "select * from " + tableName + " where requestid = ? " + cusWhere; } + /** + *

根据路径ID获取流程表名

+ * @author xuanran.wang + * @dateTime 2023/2/22 16:25 + * @param workflowId 流程id + * @return 表名 + **/ + public static String getTableNameByWorkflowId(int workflowId){ + return commonMapper.queryTableNameByWorkflowId(workflowId); + } + + /** + *

通过requestId删除流程表数据

+ * @author xuanran.wang + * @dateTime 2022/11/17 10:41 + * @param tableName 流程表名 + * @param requestIds 请求id集合 + * @return 删除是否成功 + **/ + public static boolean deleteWorkflowDataByRequestIds(String tableName, List requestIds){ + return commonMapper.deleteWorkflowDataByRequestIds(tableName, requestIds); + } + + /** + *

根据请求id获取会议id

+ * @author xuanran.wang + * @dateTime 2023/2/22 17:37 + * @param requestId 请求id + * @return 会议id + **/ + public static String getMeetingIdByRequestId(String requestId){ + return commonMapper.queryMeetingIdByRequestId(requestId); + } + } diff --git a/src/main/java/weaver/xuanran/wang/shyl/dataasync/job/CusDataAsyncJob.java b/src/main/java/weaver/xuanran/wang/shyl/dataasync/job/CusDataAsyncJob.java index e649494..4778f42 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/dataasync/job/CusDataAsyncJob.java +++ b/src/main/java/weaver/xuanran/wang/shyl/dataasync/job/CusDataAsyncJob.java @@ -1,6 +1,7 @@ package weaver.xuanran.wang.shyl.dataasync.job; import aiyh.utils.Util; +import lombok.Data; import org.apache.log4j.Logger; import weaver.interfaces.schedule.BaseCronJob; import weaver.xuanran.wang.common.annocation.ParamNotNull; @@ -18,6 +19,7 @@ import java.util.HashMap; * @author xuanran.wang * @date 2023/2/9 10:02 */ +@Data public class CusDataAsyncJob extends BaseCronJob { /** @@ -26,54 +28,30 @@ public class CusDataAsyncJob extends BaseCronJob { @ParamPrint @ParamNotNull private String baseAddr; - /** - *

教研资系统动态码地址

- **/ - @ParamPrint - @ParamNotNull - private String dynamicCodeUrl; - /** - *

教研资系统登陆地址

- **/ - @ParamPrint - @ParamNotNull - private String loginUrl; /** *

查询班级列表url

**/ @ParamPrint @ParamNotNull private String queryClassUrl; - /** - *

查询学员列表Url

- **/ - @ParamPrint - @ParamNotNull - private String queryStuUrl; +// /** +// *

查询学员列表Url

+// **/ +// @ParamPrint +// @ParamNotNull +// private String queryStuUrl; /** *

班级模块id

**/ @ParamPrint @ParamNotNull private String classModelId; - /** - *

学员模块id

- **/ - @ParamPrint - @ParamNotNull - private String studentModelId; - /** - *

教研资系统用户名

- **/ - @ParamPrint - @ParamNotNull - private String userName; - /** - *

教研资系统密码

- **/ - @ParamPrint - @ParamNotNull - private String userPwd; +// /** +// *

学员模块id

+// **/ +// @ParamPrint +// @ParamNotNull +// private String studentModelId; /** *

更新班级建模条件sql

**/ @@ -85,28 +63,17 @@ public class CusDataAsyncJob extends BaseCronJob { private final CusDataAsyncService dataAsyncService = new CusDataAsyncService(); - private final Logger log = Util.getLogger(); +// private final Logger logger = Util.getLogger(); @Override public void execute() { try { CommonUtil.checkParamNotNull(this); - - // 获取token参数 - HashMap loginParams = new HashMap<>(); - loginParams.put("username", userName); - loginParams.put("password", userPwd); - loginParams.put("authType", "normal"); - - Object token = dataAsyncService.getToken(dynamicCodeUrl, loginUrl, loginParams); - HashMap headers = new HashMap<>(); - headers.put("Authorization", "Bearer " + token); // 数据同步 - dataAsyncService.asyncData(baseAddr + queryClassUrl, classModelId, StudentClass.class, updateClassSql,headers); - dataAsyncService.asyncData(baseAddr + queryStuUrl, studentModelId, Student.class, updateStudentSql, headers); + dataAsyncService.asyncData(baseAddr + queryClassUrl, classModelId, StudentClass.class, updateClassSql,"data"); }catch (Exception e){ - log.error(Util.logStr("CusDataAsyncJob execute error! the error is :{}, " + - "error stack trace msg is: \n{}", e.getMessage(), Util.getErrString(e))); +// logger.error(Util.logStr("CusDataAsyncJob execute error! the error is :{}, " + +// "error stack trace msg is: \n{}", e.getMessage(), Util.getErrString(e))); } } } diff --git a/src/main/java/weaver/xuanran/wang/shyl/dataasync/service/CusDataAsyncService.java b/src/main/java/weaver/xuanran/wang/shyl/dataasync/service/CusDataAsyncService.java index 04377ac..91be9a6 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/dataasync/service/CusDataAsyncService.java +++ b/src/main/java/weaver/xuanran/wang/shyl/dataasync/service/CusDataAsyncService.java @@ -5,7 +5,9 @@ import aiyh.utils.excention.CustomerException; import aiyh.utils.httpUtil.ResponeVo; import aiyh.utils.httpUtil.util.HttpUtils; import com.alibaba.fastjson.JSON; +import com.alibaba.fastjson.JSONArray; import com.alibaba.fastjson.JSONObject; +import org.apache.commons.collections.CollectionUtils; import org.apache.commons.collections.MapUtils; import org.apache.commons.lang3.StringUtils; import org.apache.log4j.Logger; @@ -13,10 +15,7 @@ import weaver.xuanran.wang.common.util.CusInfoToOAUtil; import javax.ws.rs.core.MediaType; import java.io.IOException; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Objects; +import java.util.*; /** *

班级列表/学员数据同步业务方法

@@ -49,14 +48,22 @@ public class CusDataAsyncService { * @param modelId 建模模块id * @param clazz 实体类class * @param updateSql 建模更新数据sql - * @param headers 请求头 **/ public void asyncData(String url, String modelId, - Class clazz,String updateSql, - HashMap headers){ - Object data = getResponseDataByPost(url, new HashMap<>(), headers,""); - List list = JSONObject.parseArray(data.toString(), clazz); - CusInfoToOAUtil.executeBatchByEntity(Util.getIntValue(modelId, -1), list, updateSql); + Class clazz,String updateSql, String key){ + Object data = getResponseDataByGet(url, new HashMap<>(), new HashMap<>(), key); + JSONArray array = JSONObject.parseArray(JSONObject.toJSONString(data)); + log.info("data : " + array); + if(CollectionUtils.isEmpty(array)){ + log.error("array is empty!"); + return; + } + ArrayList dataList = new ArrayList<>(); + for (Object o : array) { + Object temp = JSONObject.parseObject(o.toString(), clazz); + dataList.add(temp); + } + CusInfoToOAUtil.executeBatchByEntity(Util.getIntValue(modelId, -1), dataList, updateSql); } /** @@ -90,7 +97,7 @@ public class CusDataAsyncService { private Object getResponseDataByPost(String url, Map params, Map headers, String key){ try { - ResponeVo responseVo = httpUtils.apiPost(url, params, headers); + ResponeVo responseVo = httpUtils.apiGet(url, params, headers); return getResponseData(url, responseVo, key); }catch (IOException e) { throw new CustomerException(Util.logStr("api get error! current url is : {}, error is :{}",url, e.getMessage())); diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/action/ProducerAction.java b/src/main/java/weaver/xuanran/wang/shyl/mq/action/ProducerAction.java deleted file mode 100644 index d12b20f..0000000 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/action/ProducerAction.java +++ /dev/null @@ -1,44 +0,0 @@ -package weaver.xuanran.wang.shyl.mq.action; - -import aiyh.utils.Util; -import aiyh.utils.action.SafeCusBaseAction; -import aiyh.utils.annotation.PrintParamMark; -import aiyh.utils.annotation.RequiredMark; -import aiyh.utils.excention.CustomerException; -import weaver.hrm.User; -import weaver.soa.workflow.request.RequestInfo; -import weaver.xuanran.wang.shyl.mq.service.ProducerService; - -/** - *

生产者action 将流程数据发送到mq中

- * - * @author xuanran.wang - * @date 2023/1/4 14:47 - */ -public class ProducerAction extends SafeCusBaseAction { - - /** - *

mq配置文件名称

- **/ - @RequiredMark - @PrintParamMark - private String MQConfigName; - /** - *

配置文件唯一标识

- **/ - @RequiredMark - @PrintParamMark - private String onlyMark; - - private final ProducerService producerService = new ProducerService(); - - @Override - public void doSubmit(String requestId, String billTable, int workflowId, User user, RequestInfo requestInfo) { - try { - producerService.pushWorkFlowToMQ(MQConfigName, onlyMark, billTable, requestId); - }catch (Exception e){ - String error = Util.logStr("push workFlow to MQ error! the error is :[{}]", e.getMessage()); - throw new CustomerException(error); - } - } -} diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/service/CusInfoActionService.java b/src/main/java/weaver/xuanran/wang/shyl/mq/service/CusInfoActionService.java deleted file mode 100644 index 4dd8f42..0000000 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/service/CusInfoActionService.java +++ /dev/null @@ -1,49 +0,0 @@ -package weaver.xuanran.wang.shyl.mq.service; - -import aiyh.utils.Util; -import org.apache.log4j.Logger; -import weaver.conn.RecordSet; -import weaver.xuanran.wang.shyl.mq.mapper.ConsumerMapper; -import weaver.xuanran.wang.shyl.mq.service.interfaces.CreateAction; -import weaver.xuanran.wang.shyl.mq.service.interfaces.DeleteAction; -import weaver.xuanran.wang.shyl.mq.service.interfaces.PassWordAction; -import weaver.xuanran.wang.shyl.mq.service.interfaces.UpdateAction; - -/** - *

抽象类

- * - * @Author xuanran.wang - * @Date 2022/12/30 13:04 - */ -public abstract class CusInfoActionService implements CreateAction, DeleteAction, UpdateAction, PassWordAction { - protected final RecordSet recordSet = new RecordSet(); - - protected final Logger logger = Util.getLogger(); - /** - *

consumer-mapper

- **/ - protected final ConsumerMapper consumerMapper = Util.getMapper(ConsumerMapper.class); - /** - *

分部id

- **/ - protected String subId; - // 默认初始化分部ID - { - subId = consumerMapper.getDefaultSubId(); - } - - - /** - *

获取下一个人员id

- * @author xuanran.wang - * @dateTime 2023/01/03 10:50 - * @return next id - **/ - protected synchronized String getNextHrmId(){ - recordSet.executeProc("HrmResourceMaxId_Get", ""); - recordSet.next(); - //新增的部门id - return Util.null2String(recordSet.getInt(1)); - } - -} diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/service/ProducerService.java b/src/main/java/weaver/xuanran/wang/shyl/mq/service/ProducerService.java deleted file mode 100644 index e028dae..0000000 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/service/ProducerService.java +++ /dev/null @@ -1,49 +0,0 @@ -package weaver.xuanran.wang.shyl.mq.service; - -import aiyh.utils.excention.CustomerException; -import com.alibaba.fastjson.JSONObject; -import org.apache.commons.collections.MapUtils; -import weaver.conn.RecordSet; -import weaver.xiao.commons.config.entity.RequestMappingConfig; -import weaver.xiao.commons.config.service.DealWithMapping; -import weaver.xuanran.wang.common.util.CommonUtil; -import weaver.xuanran.wang.shyl.mq.util.RocketUtil; - -import java.util.HashMap; -import java.util.Map; - -/** - *

生产者业务方法

- * - * @author xuanran.wang - * @date 2023/1/4 14:54 - */ -public class ProducerService { - - private final DealWithMapping dealWithMapping = new DealWithMapping(); - - /** - *

作为生产者将流程数据推送至mq中

- * @author xuanran.wang - * @dateTime 2023/1/18 10:22 - * @param configName mq配置文件名称 - * @param onlyMark 建模配置唯一标识 - * @param requestId 请求id - * @param tableName 主表表名 - **/ - public void pushWorkFlowToMQ(String configName, String onlyMark, String requestId, String tableName){ - RequestMappingConfig requestMappingConfig = dealWithMapping.treeDealWithUniqueCode(onlyMark); - String selectMainSql = CommonUtil.getSelectSql(requestMappingConfig, tableName); - RecordSet recordSet = new RecordSet(); - recordSet.executeQuery(selectMainSql, requestId); - Map requestParam = new HashMap<>(); - if (recordSet.next()) { - dealWithMapping.setMainTable(tableName); - requestParam = dealWithMapping.getRequestParam(recordSet, requestMappingConfig); - } - if(MapUtils.isEmpty(requestParam)){ - throw new CustomerException("convert workflow information to json error!"); - } - RocketUtil.producerSendMsg(configName, JSONObject.toJSONString(requestParam)); - } -} diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/service/interfaces/CreateAction.java b/src/main/java/weaver/xuanran/wang/shyl/mq/service/interfaces/CreateAction.java deleted file mode 100644 index 018e37a..0000000 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/service/interfaces/CreateAction.java +++ /dev/null @@ -1,14 +0,0 @@ -package weaver.xuanran.wang.shyl.mq.service.interfaces; - -import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyStatus; -import weaver.xuanran.wang.shyl.mq.entity.MQMessage; - -/** - *

新增接口

- * - * @Author xuanran.wang - * @Date 2022/12/30 13:00 - */ -public interface CreateAction { - ConsumeConcurrentlyStatus cusCreateAction(MQMessage message); -} diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/service/interfaces/DeleteAction.java b/src/main/java/weaver/xuanran/wang/shyl/mq/service/interfaces/DeleteAction.java deleted file mode 100644 index ff2bc9e..0000000 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/service/interfaces/DeleteAction.java +++ /dev/null @@ -1,14 +0,0 @@ -package weaver.xuanran.wang.shyl.mq.service.interfaces; - -import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyStatus; -import weaver.xuanran.wang.shyl.mq.entity.MQMessage; - -/** - *

删除接口

- * - * @Author xuanran.wang - * @Date 2022/12/30 13:02 - */ -public interface DeleteAction { - ConsumeConcurrentlyStatus cusDeleteAction(MQMessage message); -} diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/service/interfaces/PassWordAction.java b/src/main/java/weaver/xuanran/wang/shyl/mq/service/interfaces/PassWordAction.java deleted file mode 100644 index 956e1cb..0000000 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/service/interfaces/PassWordAction.java +++ /dev/null @@ -1,14 +0,0 @@ -package weaver.xuanran.wang.shyl.mq.service.interfaces; - -import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyStatus; -import weaver.xuanran.wang.shyl.mq.entity.MQMessage; - -/** - *

密码修改接口

- * - * @Author xuanran.wang - * @Date 2022/12/30 13:03 - */ -public interface PassWordAction { - ConsumeConcurrentlyStatus cusPassWordAction(MQMessage message); -} diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/service/interfaces/UpdateAction.java b/src/main/java/weaver/xuanran/wang/shyl/mq/service/interfaces/UpdateAction.java deleted file mode 100644 index 0ad59b4..0000000 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/service/interfaces/UpdateAction.java +++ /dev/null @@ -1,14 +0,0 @@ -package weaver.xuanran.wang.shyl.mq.service.interfaces; - -import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyStatus; -import weaver.xuanran.wang.shyl.mq.entity.MQMessage; - -/** - *

更新接口

- * - * @Author xuanran.wang - * @Date 2022/12/30 13:01 - */ -public interface UpdateAction { - ConsumeConcurrentlyStatus cusUpdateAction(MQMessage message); -} diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/RocketMQConsumerListener.java b/src/main/java/weaver/xuanran/wang/shyl_mq/RocketMQConsumerListener.java similarity index 94% rename from src/main/java/weaver/xuanran/wang/shyl/mq/RocketMQConsumerListener.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/RocketMQConsumerListener.java index 366a1b1..0ef2ef6 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/RocketMQConsumerListener.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/RocketMQConsumerListener.java @@ -1,4 +1,4 @@ -package weaver.xuanran.wang.shyl.mq; +package weaver.xuanran.wang.shyl_mq;//package weaver.xuanran.wang.shyl.mq; import aiyh.utils.Util; import aiyh.utils.excention.CustomerException; @@ -50,7 +50,6 @@ public abstract class RocketMQConsumerListener extends HttpServlet { }catch (Exception e){ throw new CustomerException(Util.logStr("the consumer start exception : {}", e.getMessage())); } - log.info(Util.logStr("---- consumer : {} initialized end ----", configName)); }catch (Exception e){ log.info(Util.logStr("---- consumer : {} initialized error ----", configName)); log.error(Util.getErrString(e)); diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/RocketMQFactory.java b/src/main/java/weaver/xuanran/wang/shyl_mq/RocketMQFactory.java similarity index 88% rename from src/main/java/weaver/xuanran/wang/shyl/mq/RocketMQFactory.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/RocketMQFactory.java index 2df840a..45b0aaf 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/RocketMQFactory.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/RocketMQFactory.java @@ -1,4 +1,4 @@ -package weaver.xuanran.wang.shyl.mq; +package weaver.xuanran.wang.shyl_mq;//package weaver.xuanran.wang.shyl.mq; import aiyh.utils.Util; import aiyh.utils.excention.CustomerException; @@ -8,8 +8,8 @@ import org.apache.rocketmq.client.exception.MQClientException; import org.apache.rocketmq.client.producer.DefaultMQProducer; import org.apache.rocketmq.common.consumer.ConsumeFromWhere; import org.apache.rocketmq.common.protocol.heartbeat.MessageModel; -import weaver.xuanran.wang.shyl.mq.constant.RocketMQConstant; -import weaver.xuanran.wang.shyl.mq.util.RocketUtil; +import weaver.xuanran.wang.shyl_mq.constant.RocketMQConstant; +import weaver.xuanran.wang.shyl_mq.util.RocketConsumerUtil; import java.util.HashMap; import java.util.Map; @@ -60,6 +60,8 @@ public class RocketMQFactory { consumer.subscribe(Util.null2String(configMap.get("Topic")), Util.null2String(configMap.get("Tag"))); // Listener，主要进行消息的逻辑处理,监听topic，如果有消息就会立即去消费 consumer.registerMessageListener(messageListenerConcurrently); + // 是否开启vip + consumer.setVipChannelEnabled(false); return consumer; }catch (Exception e){ throw new CustomerException(Util.logStr("consumer init error, now config name is : {} error : {}",configName, e.getMessage()), e); @@ -82,17 +84,18 @@ public class RocketMQFactory { return PRODUCER_MAP.get(configName); }else { Map configMap = getConfigMapByName(configName); - defaultMQProducer = new DefaultMQProducer(); + defaultMQProducer = new DefaultMQProducer(Util.null2DefaultStr(configMap.get("ConsumerGroup"),"")); // 发送消息最大超时时间 默认60000 int sendMsgTimeOut = Util.getIntValue(Util.null2String(configMap.get("sendMsgTimeOut")), RocketMQConstant.PRODUCER_SEND_MSG_TIME_OUT); defaultMQProducer.setSendMsgTimeout(sendMsgTimeOut); + defaultMQProducer.setVipChannelEnabled(false); + defaultMQProducer.setNamesrvAddr(Util.null2String(configMap.get("NameServer"))); try { defaultMQProducer.start(); }catch (MQClientException e){ - throw new CustomerException("producer start error!",e); + throw new CustomerException(Util.logStr("producer start error!:{}",e.getMessage())); } // mq地址 - defaultMQProducer.setNamesrvAddr(Util.null2String(configMap.get("NameServer"))); PRODUCER_MAP.put(configName, defaultMQProducer); } } @@ -109,7 +112,7 @@ public class RocketMQFactory { private synchronized static Map getConfigMapByName(String configName){ Map configMap = new HashMap<>(); if(!CONFIG_MAPS.containsKey(configName)){ - configMap = RocketUtil.initMQConfigMap(configName); + configMap = RocketConsumerUtil.initMQConfigMap(configName); CONFIG_MAPS.put(configName, configMap); } return configMap; diff --git a/src/main/java/weaver/xuanran/wang/shyl_mq/action/ProducerAction.java b/src/main/java/weaver/xuanran/wang/shyl_mq/action/ProducerAction.java new file mode 100644 index 0000000..ba7f09a --- /dev/null +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/action/ProducerAction.java @@ -0,0 +1,47 @@ +package weaver.xuanran.wang.shyl_mq.action; + +import aiyh.utils.Util; +import org.apache.log4j.Logger; +import weaver.interfaces.workflow.action.Action; +import weaver.soa.workflow.request.RequestInfo; +import weaver.workflow.request.RequestManager; +import weaver.xuanran.wang.shyl_mq.service.ProducerService; + +/** + *

生产者action 将流程数据发送到mq中

+ * + * @author xuanran.wang + * @date 2023/1/4 14:47 + */ +public class ProducerAction implements Action { + + /** + *

建模配置标识

+ **/ + private String onlyMark; + + /** + *

配置文件名称

+ **/ + private String configName; + private final Logger logger = Util.getLogger(); + + private final ProducerService producerService = new ProducerService(); + + @Override + public String execute(RequestInfo requestInfo) { + RequestManager requestManager = requestInfo.getRequestManager(); + String billTable = requestManager.getBillTableName(); + String requestId = requestInfo.getRequestid(); + try { + producerService.pushWorkFlowToMQ(configName,onlyMark, requestId, billTable, null); + return Action.SUCCESS; + }catch (Exception e){ + String error = Util.logStr("push workFlow to MQ error! the error is :[{}]", e.getMessage()); + logger.error(error); + requestManager.setMessageid(System.currentTimeMillis() + ""); + requestManager.setMessagecontent(error); + return Action.FAILURE_AND_CONTINUE; + } + } +} diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/constant/RocketMQConstant.java b/src/main/java/weaver/xuanran/wang/shyl_mq/constant/RocketMQConstant.java similarity index 91% rename from src/main/java/weaver/xuanran/wang/shyl/mq/constant/RocketMQConstant.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/constant/RocketMQConstant.java index 9af0e6a..7bd6915 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/constant/RocketMQConstant.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/constant/RocketMQConstant.java @@ -1,4 +1,4 @@ -package weaver.xuanran.wang.shyl.mq.constant; +package weaver.xuanran.wang.shyl_mq.constant; import java.util.HashMap; import java.util.Map; @@ -14,7 +14,7 @@ public class RocketMQConstant { public static final String UPDATE_ACTION = "UPDATE_ACTION"; public static final String DELETE_ACTION = "DELETE_ACTION"; public static final String PASSWORD_ACTION = "PASSWORD_ACTION"; - public static final int DEFAULT_MAX_RECONSUME_TIMES = 5; + public static final int DEFAULT_MAX_RECONSUME_TIMES = 2; public static final String SEX_GIRL = "1"; public static final String SEX_BOY = "2"; public static final String STATUS_ENABLE = "1"; diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/consumer/OrgConsumer.java b/src/main/java/weaver/xuanran/wang/shyl_mq/consumer/OrgConsumer.java similarity index 67% rename from src/main/java/weaver/xuanran/wang/shyl/mq/consumer/OrgConsumer.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/consumer/OrgConsumer.java index b5c11a1..2a6a978 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/consumer/OrgConsumer.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/consumer/OrgConsumer.java @@ -1,13 +1,13 @@ -package weaver.xuanran.wang.shyl.mq.consumer; +package weaver.xuanran.wang.shyl_mq.consumer;//package weaver.xuanran.wang.shyl.mq.consumer; import aiyh.utils.Util; import org.apache.log4j.Logger; import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyContext; import org.apache.rocketmq.client.consumer.listener.MessageListenerConcurrently; import org.apache.rocketmq.common.message.MessageExt; -import weaver.xuanran.wang.shyl.mq.RocketMQConsumerListener; -import weaver.xuanran.wang.shyl.mq.service.impl.OrgServiceImpl; -import weaver.xuanran.wang.shyl.mq.util.RocketUtil; +import weaver.xuanran.wang.shyl_mq.RocketMQConsumerListener; +import weaver.xuanran.wang.shyl_mq.service.impl.OrgServiceImpl; +import weaver.xuanran.wang.shyl_mq.util.RocketConsumerUtil; import java.util.List; @@ -29,7 +29,7 @@ public class OrgConsumer extends RocketMQConsumerListener { @Override public MessageListenerConcurrently service() { - return (List msg, ConsumeConcurrentlyContext consumeConcurrentlyContext) -> RocketUtil.execute(msg, consumeConcurrentlyContext, orgService, CONFIG_NAME); + return (List msg, ConsumeConcurrentlyContext consumeConcurrentlyContext) -> RocketConsumerUtil.execute(msg, consumeConcurrentlyContext, orgService, CONFIG_NAME); } } diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/consumer/PassWordConsumer.java b/src/main/java/weaver/xuanran/wang/shyl_mq/consumer/PassWordConsumer.java similarity index 68% rename from src/main/java/weaver/xuanran/wang/shyl/mq/consumer/PassWordConsumer.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/consumer/PassWordConsumer.java index f400e56..fadf164 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/consumer/PassWordConsumer.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/consumer/PassWordConsumer.java @@ -1,13 +1,12 @@ -package weaver.xuanran.wang.shyl.mq.consumer; - +package weaver.xuanran.wang.shyl_mq.consumer;//package weaver.xuanran.wang.shyl.mq.consumer; import aiyh.utils.Util; import org.apache.log4j.Logger; import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyContext; import org.apache.rocketmq.client.consumer.listener.MessageListenerConcurrently; import org.apache.rocketmq.common.message.MessageExt; -import weaver.xuanran.wang.shyl.mq.RocketMQConsumerListener; -import weaver.xuanran.wang.shyl.mq.service.impl.PassWordServiceImpl; -import weaver.xuanran.wang.shyl.mq.util.RocketUtil; +import weaver.xuanran.wang.shyl_mq.RocketMQConsumerListener; +import weaver.xuanran.wang.shyl_mq.service.impl.PassWordServiceImpl; +import weaver.xuanran.wang.shyl_mq.util.RocketConsumerUtil; import java.util.List; @@ -30,7 +29,7 @@ public class PassWordConsumer extends RocketMQConsumerListener { @Override public MessageListenerConcurrently service() { - return (List msg, ConsumeConcurrentlyContext consumeConcurrentlyContext) -> RocketUtil.execute(msg, consumeConcurrentlyContext, passWordService, CONFIG_NAME); + return (List msg, ConsumeConcurrentlyContext consumeConcurrentlyContext) -> RocketConsumerUtil.execute(msg, consumeConcurrentlyContext, passWordService, CONFIG_NAME); } } diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/consumer/UserInfoConsumer.java b/src/main/java/weaver/xuanran/wang/shyl_mq/consumer/UserInfoConsumer.java similarity index 68% rename from src/main/java/weaver/xuanran/wang/shyl/mq/consumer/UserInfoConsumer.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/consumer/UserInfoConsumer.java index f87a276..7d1e44b 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/consumer/UserInfoConsumer.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/consumer/UserInfoConsumer.java @@ -1,13 +1,13 @@ -package weaver.xuanran.wang.shyl.mq.consumer; +package weaver.xuanran.wang.shyl_mq.consumer;//package weaver.xuanran.wang.shyl.mq.consumer; import aiyh.utils.Util; import org.apache.log4j.Logger; import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyContext; import org.apache.rocketmq.client.consumer.listener.MessageListenerConcurrently; import org.apache.rocketmq.common.message.MessageExt; -import weaver.xuanran.wang.shyl.mq.RocketMQConsumerListener; -import weaver.xuanran.wang.shyl.mq.service.impl.UserServiceImpl; -import weaver.xuanran.wang.shyl.mq.util.RocketUtil; +import weaver.xuanran.wang.shyl_mq.RocketMQConsumerListener; +import weaver.xuanran.wang.shyl_mq.service.impl.UserServiceImpl; +import weaver.xuanran.wang.shyl_mq.util.RocketConsumerUtil; import java.util.List; @@ -29,7 +29,7 @@ public class UserInfoConsumer extends RocketMQConsumerListener { @Override public MessageListenerConcurrently service() { - return (List msg, ConsumeConcurrentlyContext consumeConcurrentlyContext) -> RocketUtil.execute(msg, consumeConcurrentlyContext, userInfoService, CONFIG_NAME); + return (List msg, ConsumeConcurrentlyContext consumeConcurrentlyContext) -> RocketConsumerUtil.execute(msg, consumeConcurrentlyContext, userInfoService, CONFIG_NAME); } } diff --git a/src/main/java/weaver/xuanran/wang/shyl_mq/entity/MQMessage.java b/src/main/java/weaver/xuanran/wang/shyl_mq/entity/MQMessage.java new file mode 100644 index 0000000..ae01080 --- /dev/null +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/entity/MQMessage.java @@ -0,0 +1,53 @@ +package weaver.xuanran.wang.shyl_mq.entity; + +import lombok.Data; +import weaver.xuanran.wang.common.annocation.SqlFieldMapping; + +/** + *

mq消息实体类

+ * + * @Author xuanran.wang + * @Date 2022/12/30 13:09 + */ +@Data +public class MQMessage { + /** + *

消息ID

+ **/ + @SqlFieldMapping("messageId") + private String id; + /** + *

消息队列名

+ *

+ * AUTH_CONSOLE_USERINFO_TOPIC: 用户队列; + * AUTH_CONSOLE_ORG_TOPIC: 机构队列; + * AUTH_CONSOLE_USERINFO_PASSWORD_TOPIC: 密码修改队列 + *

+ **/ + @SqlFieldMapping() + private String topic; + /** + *

消息内容操作类型

+ *

+ * CREATE_ACTION：新增; + * UPDATE_ACTION: 修改; + * DELETE_ACTION: 删除; + * PASSWORD_ACTION: 修改密码 + *

+ **/ + @SqlFieldMapping() + private String actionType; + /** + *

消息发送时间

+ **/ + @SqlFieldMapping() + private String sendTime; + /** + *

消息业务内容,json 格式,分业务(用户、机构、密码修改)

+ **/ + @SqlFieldMapping() + private String content; + + @SqlFieldMapping() + private String error; +} diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/entity/ModifyPassWord.java b/src/main/java/weaver/xuanran/wang/shyl_mq/entity/ModifyPassWord.java similarity index 94% rename from src/main/java/weaver/xuanran/wang/shyl/mq/entity/ModifyPassWord.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/entity/ModifyPassWord.java index f147608..2884b93 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/entity/ModifyPassWord.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/entity/ModifyPassWord.java @@ -1,4 +1,4 @@ -package weaver.xuanran.wang.shyl.mq.entity; +package weaver.xuanran.wang.shyl_mq.entity; import lombok.Data; diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/entity/Org.java b/src/main/java/weaver/xuanran/wang/shyl_mq/entity/Org.java similarity index 92% rename from src/main/java/weaver/xuanran/wang/shyl/mq/entity/Org.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/entity/Org.java index 10c9ad8..5ff754f 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/entity/Org.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/entity/Org.java @@ -1,5 +1,5 @@ -package weaver.xuanran.wang.shyl.mq.entity; +package weaver.xuanran.wang.shyl_mq.entity; import lombok.Data; diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/entity/UserInfo.java b/src/main/java/weaver/xuanran/wang/shyl_mq/entity/UserInfo.java similarity index 95% rename from src/main/java/weaver/xuanran/wang/shyl/mq/entity/UserInfo.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/entity/UserInfo.java index 2849a15..4b5a39a 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/entity/UserInfo.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/entity/UserInfo.java @@ -1,4 +1,4 @@ -package weaver.xuanran.wang.shyl.mq.entity; +package weaver.xuanran.wang.shyl_mq.entity; import lombok.Data; diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/mapper/ConsumerMapper.java b/src/main/java/weaver/xuanran/wang/shyl_mq/mapper/ConsumerMapper.java similarity index 60% rename from src/main/java/weaver/xuanran/wang/shyl/mq/mapper/ConsumerMapper.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/mapper/ConsumerMapper.java index 7a74f64..1d6bab2 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/mapper/ConsumerMapper.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/mapper/ConsumerMapper.java @@ -1,8 +1,6 @@ -package weaver.xuanran.wang.shyl.mq.mapper; +package weaver.xuanran.wang.shyl_mq.mapper; -import aiyh.utils.annotation.recordset.ParamMapper; -import aiyh.utils.annotation.recordset.Select; -import aiyh.utils.annotation.recordset.Update; +import aiyh.utils.annotation.recordset.*; import java.util.Map; @@ -12,6 +10,7 @@ import java.util.Map; * @Author xuanran.wang * @Date 2022/12/30 14:19 */ +@SqlMapper public interface ConsumerMapper { /** @@ -23,14 +22,25 @@ public interface ConsumerMapper { @Update("update hrmresource set status = 5 where outkey = #{outKey}") boolean updateUserStatusByOutKey(@ParamMapper("outKey") String outKey); + /** + *

通过id删除部门

+ * @author xuanran.wang + * @dateTime 2022/12/30 14:33 + * @param id id + * @return 删除是否成功 + **/ + @Delete("delete from hrmdepartment where id = #{id}") + boolean deleteDepartmentById(@ParamMapper("id") String id); + /** *

通过outKey封存部门

* @author xuanran.wang * @dateTime 2022/12/30 14:33 * @param outKey 外部系统id * @return 删除是否成功 + * set canceled = 1 where outkey = #{outKey} **/ - @Update("update hrmdepartment set canceled = 1 where outkey = #{outKey}") + @Delete("delete from hrmdepartment where outkey = #{outKey}") boolean deleteDepartmentByOutKey(@ParamMapper("outKey") String outKey); /** @@ -40,7 +50,7 @@ public interface ConsumerMapper { * @param outKey 外部系统id * @return map key : id, val : 分部id **/ - @Update("select id departmentId, subcompanyid1 subCompanyId from hrmdepartment where outkey = #{outKey} and canceled != 1") + @Select("select id departmentId, subcompanyid1 subCompanyId from hrmdepartment where outkey = #{outKey} and canceled != 1") Map getDepInfoByOutKey(@ParamMapper("outKey") String outKey); /** @@ -50,7 +60,7 @@ public interface ConsumerMapper { * @param outKey 外部系统id * @return id **/ - @Update("select id from hrmresource where outkey = #{outKey}") + @Select("select id from hrmresource where outkey = #{outKey}") String getHrmIdByOutKey(@ParamMapper("outKey") String outKey); /** @@ -60,7 +70,7 @@ public interface ConsumerMapper { * @param outKey 外部系统id * @return id **/ - @Update("select id from hrmdepartment where outkey = #{outKey} and canceled != 1") + @Select("select id from hrmdepartment where outkey = #{outKey} and canceled != 1") String getDepIdByOutKey(@ParamMapper("outKey") String outKey); /** @@ -82,4 +92,27 @@ public interface ConsumerMapper { **/ @Select("select id from hrmsubcompany") String getDefaultSubId(); + + /** + *

通过id删除人员

+ * @author xuanran.wang + * @dateTime 2022/12/30 14:33 + * @param id id + * @return true/false + **/ + @Delete("delete from hrmresource where id = #{id}") + boolean deleteHrmById(@ParamMapper("id") String id); + + /** + *

通过outKey删除人员

+ * @author xuanran.wang + * @dateTime 2022/12/30 14:33 + * @param outKey outKey + * @return true/false + **/ + @Delete("delete from hrmresource where outkey = #{outKey}") + boolean deleteHrmByOutKey(@ParamMapper("outKey") String outKey); + + @Select("select count(1) from uf_mqLog where messageId = #{messageId}") + int getMainIdFromMQLogByMessageId(@ParamMapper("messageId") String messageId); } diff --git a/src/main/java/weaver/xuanran/wang/shyl_mq/service/ChangeRequestParam.java b/src/main/java/weaver/xuanran/wang/shyl_mq/service/ChangeRequestParam.java new file mode 100644 index 0000000..be103ed --- /dev/null +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/service/ChangeRequestParam.java @@ -0,0 +1,17 @@ +package weaver.xuanran.wang.shyl_mq.service; + +import java.util.Map; + +/** + *

修改请求配置参数

+ * + * @author xuanran.wang + * @date 2023/2/28 14:35 + */ +public interface ChangeRequestParam { + /** + * 修改请求配置参数 + * @param requestParam 请求 + */ + void changeRequestParam(Map requestParam); +} diff --git a/src/main/java/weaver/xuanran/wang/shyl_mq/service/CusInfoActionService.java b/src/main/java/weaver/xuanran/wang/shyl_mq/service/CusInfoActionService.java new file mode 100644 index 0000000..5d39072 --- /dev/null +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/service/CusInfoActionService.java @@ -0,0 +1,74 @@ +package weaver.xuanran.wang.shyl_mq.service; + +import aiyh.utils.Util; +import org.apache.log4j.Logger; +import weaver.conn.RecordSet; +import weaver.general.TimeUtil; +import weaver.xuanran.wang.common.util.CusInfoToOAUtil; +import weaver.xuanran.wang.shyl_mq.mapper.ConsumerMapper; +import weaver.xuanran.wang.shyl_mq.service.interfaces.CRUDAction; +import weaver.zwl.common.ToolUtil; + +import java.util.HashMap; + +/** + *

抽象类

+ * + * @Author xuanran.wang + * @Date 2022/12/30 13:04 + */ +public abstract class CusInfoActionService implements CRUDAction { + + protected final RecordSet recordSet = new RecordSet(); + + protected final Logger log = Util.getLogger(); + /** + *

consumer-mapper

+ **/ + protected final ConsumerMapper consumerMapper = Util.getMapper(ConsumerMapper.class); + protected ToolUtil toolUtil = new ToolUtil(); + /** + *

分部id

+ **/ + protected String subId; + /** + *

成功消费日志模块id

+ **/ + private final int modelId; + + // 默认初始化分部ID + { + subId = consumerMapper.getDefaultSubId(); + modelId = Util.getIntValue(toolUtil.getSystemParamValue("mqLogModelId"),-1); + log.info(Util.logStr("subId : {}, modelId : {}", subId, modelId)); + } + + + /** + *

获取下一个人员id

+ * @author xuanran.wang + * @dateTime 2023/01/03 10:50 + * @return next id + **/ + protected synchronized String getNextHrmId(){ + recordSet.executeProc("HrmResourceMaxId_Get", ""); + recordSet.next(); + //新增的部门id + return Util.null2String(recordSet.getInt(1)); + } + + /** + *

将处理过的mq消息存入oa

+ * @author xuanran.wang + * @dateTime 2023/2/21 18:27 + * @param messageId 消息id + **/ + protected void writeInOA(String messageId){ + HashMap params = new HashMap<>(); + params.put("messageId",messageId); + params.put("dealTime", TimeUtil.getCurrentTimeString()); + log.info(Util.logStr("messageId : {}, consumer success!",messageId)); + CusInfoToOAUtil.getDataId(modelId,params); + } + +} diff --git a/src/main/java/weaver/xuanran/wang/shyl_mq/service/ProducerService.java b/src/main/java/weaver/xuanran/wang/shyl_mq/service/ProducerService.java new file mode 100644 index 0000000..75c5bbc --- /dev/null +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/service/ProducerService.java @@ -0,0 +1,78 @@ +package weaver.xuanran.wang.shyl_mq.service; + +import aiyh.utils.Util; +import aiyh.utils.httpUtil.util.HttpUtils; +import com.alibaba.fastjson.JSONObject; +import org.apache.commons.collections.MapUtils; +import org.apache.log4j.Logger; +import weaver.conn.RecordSet; +import weaver.xiao.commons.config.entity.RequestMappingConfig; +import weaver.xiao.commons.config.service.DealWithMapping; +import weaver.xuanran.wang.common.util.CommonUtil; +import weaver.xuanran.wang.shyl_mq.util.RocketConsumerUtil; +import weaver.zwl.common.ToolUtil; + +import javax.ws.rs.core.MediaType; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + + +/** + *

生产者业务方法

+ * + * @author xuanran.wang + * @date 2023/1/4 14:54 + */ +public class ProducerService { + + private final Logger logger = Util.getLogger(); + + private final DealWithMapping dealWithMapping = new DealWithMapping(); + private final ToolUtil toolUtil = new ToolUtil(); + private final HttpUtils httpUtils = new HttpUtils(); + + { + httpUtils.getGlobalCache().header.put("Content-Type", MediaType.APPLICATION_JSON); // 全局请求头 + } + + + + /** + *

作为生产者将流程数据推送至mq中

+ * @author xuanran.wang + * @dateTime 2023/1/18 10:22 + * @param configName 配置文件名称 + * @param onlyMark 建模配置唯一标识 + * @param requestId 请求id + * @param tableName 主表表名 + **/ + public void pushWorkFlowToMQ(String configName, + String onlyMark, + String requestId, + String tableName, + ChangeRequestParam changeRequestParam){ + RequestMappingConfig requestMappingConfig = dealWithMapping.treeDealWithUniqueCode(onlyMark); + String selectMainSql = CommonUtil.getSelectSql(requestMappingConfig, tableName); + logger.info("查询主表sql : " + selectMainSql); + RecordSet recordSet = new RecordSet(); + recordSet.executeQuery(selectMainSql, requestId); + Map requestParam = new HashMap<>(); + if (recordSet.next()) { + dealWithMapping.setMainTable(tableName); + requestParam = dealWithMapping.getRequestParam(recordSet, requestMappingConfig); + } + if(MapUtils.isEmpty(requestParam)){ + logger.error(Util.logStr("requestId: {}, 生成json为空!",requestId)); + return; + } + if(!Objects.isNull(changeRequestParam)){ + changeRequestParam.changeRequestParam(requestParam); + } +// logger.info(Util.logStr("requestId : {}, msg:{}", requestId, JSONObject.toJSONString(requestParam))); + String sendMQ = Util.null2DefaultStr(toolUtil.getSystemParamValue("sendMQ"),""); + if("1".equals(sendMQ)){ + RocketConsumerUtil.producerSendMsg(configName,JSONObject.toJSONString(requestParam), requestId); + } + } +} diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/service/impl/OrgServiceImpl.java b/src/main/java/weaver/xuanran/wang/shyl_mq/service/impl/OrgServiceImpl.java similarity index 78% rename from src/main/java/weaver/xuanran/wang/shyl/mq/service/impl/OrgServiceImpl.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/service/impl/OrgServiceImpl.java index a569617..ddbf9e1 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/service/impl/OrgServiceImpl.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/service/impl/OrgServiceImpl.java @@ -1,29 +1,37 @@ -package weaver.xuanran.wang.shyl.mq.service.impl; +package weaver.xuanran.wang.shyl_mq.service.impl; import aiyh.utils.Util; import aiyh.utils.excention.CustomerException; import com.alibaba.fastjson.JSONObject; import org.apache.commons.lang3.StringUtils; +import org.apache.log4j.Logger; import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyStatus; import weaver.conn.RecordSet; import weaver.general.TimeUtil; import weaver.hrm.company.DepartmentComInfo; import weaver.interfaces.hrm.HrmServiceManager; import weaver.matrix.MatrixUtil; -import weaver.xuanran.wang.shyl.mq.entity.MQMessage; -import weaver.xuanran.wang.shyl.mq.entity.Org; -import weaver.xuanran.wang.shyl.mq.service.CusInfoActionService; +import weaver.xuanran.wang.shyl_mq.service.CusInfoActionService; +import weaver.xuanran.wang.shyl_mq.entity.MQMessage; +import weaver.xuanran.wang.shyl_mq.entity.Org; import java.util.ArrayList; import java.util.List; /** - *

+ *

组织结构

* * @Author xuanran.wang * @Date 2022/12/30 15:05 */ public class OrgServiceImpl extends CusInfoActionService { + private Logger logger = Util.getLogger("mq-consumer-org"); + + { + if(null == logger){ + logger = Util.getLogger("mq-consumer-org"); + } + } /** *

部门创建

@@ -34,9 +42,11 @@ public class OrgServiceImpl extends CusInfoActionService { **/ @Override public ConsumeConcurrentlyStatus cusCreateAction(MQMessage message) { + int depId = 0; try { String content = message.getContent(); Org org = JSONObject.parseObject(content, Org.class); + logger.info(Util.logStr("orgCusCreateAction messageId: {},org : {} ",message.getId(), JSONObject.toJSONString(org))); char separator = weaver.general.Util.getSeparator(); // 分部id RecordSet insertRs = new RecordSet(); @@ -48,11 +58,13 @@ public class OrgServiceImpl extends CusInfoActionService { "" + separator + "" + separator + subId + separator + org.getSortIndex() + separator + ""; insertRs.executeProc("HrmDepartment_Insert", para); if (insertRs.next()) { - int depId = insertRs.getInt(1); + depId = insertRs.getInt(1); updateDepartmentInfo(String.valueOf(depId), subId, org); } + writeInOA(message.getId()); return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; }catch (Exception e){ + consumerMapper.deleteDepartmentById(subId + ""); throw new CustomerException(Util.logStr("orgCreateAction error : {}", e.getMessage()), e); } } @@ -69,6 +81,7 @@ public class OrgServiceImpl extends CusInfoActionService { try { String content = message.getContent(); Org org = JSONObject.parseObject(content, Org.class); + logger.info(Util.logStr("orgCusDeleteAction messageId: {}, org : {} ",message.getId(),JSONObject.toJSONString(org))); String id = org.getId(); if(StringUtils.isBlank(id)){ throw new CustomerException("userInfo id can not be empty!"); @@ -77,6 +90,7 @@ public class OrgServiceImpl extends CusInfoActionService { if (!success) { throw new CustomerException(Util.logStr("update user status error!")); } + writeInOA(message.getId()); return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; }catch (Exception e){ throw new CustomerException(Util.logStr("orgDeleteAction execute error : [{}]!", e.getMessage()), e); @@ -95,13 +109,19 @@ public class OrgServiceImpl extends CusInfoActionService { try { String content = message.getContent(); Org org = JSONObject.parseObject(content, Org.class); - String outKey = org.getId(); + logger.info(Util.logStr("orgCusUpdateAction messageId: {}, org : {} ",message.getId(), JSONObject.toJSONString(org))); + String outKey = Util.null2DefaultStr(org.getId(),""); + if(StringUtils.isBlank(outKey)){ + throw new CustomerException("orgId can not null!"); + } // 分部待明确 String depId = consumerMapper.getDepIdByOutKey(outKey); if(StringUtils.isBlank(depId)){ - throw new CustomerException(Util.logStr("The department information data obtained by foreign key is empty!")); + logger.error(Util.logStr("The department information data obtained by foreign key is empty!")); + return cusCreateAction(message); } updateDepartmentInfo(depId, subId, org); + writeInOA(message.getId()); return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; }catch (Exception e){ throw new CustomerException(Util.logStr("orgUpdateAction error : {}", e.getMessage()), e); @@ -123,7 +143,7 @@ public class OrgServiceImpl extends CusInfoActionService { RecordSet updateRs = new RecordSet(); List params = initDepartParam(String.valueOf(depId), subId, org); if (!updateRs.executeUpdate(insertSQL, params)) { - throw new CustomerException(Util.logStr("insert HrmDepartment error sql : {}, params : {}", insertSQL, JSONObject.toJSONString(params))); + throw new CustomerException(Util.logStr("insert HrmDepartment error sql : {}, params : {}", insertSQL, params)); } DepartmentComInfo dci = new DepartmentComInfo(); //清除全部部门缓存 @@ -161,16 +181,16 @@ public class OrgServiceImpl extends CusInfoActionService { // 显示顺序 params.add(org.getSortIndex()); // 是否封存 - params.add("0"); + params.add(0); // 部门标识 params.add(org.getOrgName()); // 部门名称 params.add(org.getOrgName()); String parentId = org.getParentId(); // 父级部门id - String supDepId = ""; - if(StringUtils.isNotBlank(parentId)){ - supDepId = consumerMapper.getDepIdByOutKey(parentId); + String supDepId = consumerMapper.getDepIdByOutKey(parentId); + if(StringUtils.isBlank(supDepId)){ + supDepId = "1"; } params.add(supDepId); // 分部 @@ -183,6 +203,6 @@ public class OrgServiceImpl extends CusInfoActionService { @Override public ConsumeConcurrentlyStatus cusPassWordAction(MQMessage message) { - return null; + return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; } } diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/service/impl/PassWordServiceImpl.java b/src/main/java/weaver/xuanran/wang/shyl_mq/service/impl/PassWordServiceImpl.java similarity index 64% rename from src/main/java/weaver/xuanran/wang/shyl/mq/service/impl/PassWordServiceImpl.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/service/impl/PassWordServiceImpl.java index 6130288..b9cf11a 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/service/impl/PassWordServiceImpl.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/service/impl/PassWordServiceImpl.java @@ -1,13 +1,14 @@ -package weaver.xuanran.wang.shyl.mq.service.impl; +package weaver.xuanran.wang.shyl_mq.service.impl; import aiyh.utils.Util; import aiyh.utils.excention.CustomerException; import com.alibaba.fastjson.JSONObject; import org.apache.commons.lang3.StringUtils; +import org.apache.log4j.Logger; import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyStatus; -import weaver.xuanran.wang.shyl.mq.entity.MQMessage; -import weaver.xuanran.wang.shyl.mq.entity.ModifyPassWord; -import weaver.xuanran.wang.shyl.mq.service.CusInfoActionService; +import weaver.xuanran.wang.shyl_mq.entity.MQMessage; +import weaver.xuanran.wang.shyl_mq.entity.ModifyPassWord; +import weaver.xuanran.wang.shyl_mq.service.CusInfoActionService; /** *

密码修改业务方法

@@ -16,14 +17,23 @@ import weaver.xuanran.wang.shyl.mq.service.CusInfoActionService; * @date 2023/1/3 16:07 */ public class PassWordServiceImpl extends CusInfoActionService { + + private Logger logger = Util.getLogger("mq-consumer-password"); + + { + if(null == logger){ + logger = Util.getLogger("mq-consumer-password"); + } + } + @Override public ConsumeConcurrentlyStatus cusCreateAction(MQMessage message) { - return null; + return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; } @Override public ConsumeConcurrentlyStatus cusDeleteAction(MQMessage message) { - return null; + return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; } @Override @@ -31,14 +41,16 @@ public class PassWordServiceImpl extends CusInfoActionService { try { String content = message.getContent(); ModifyPassWord passWord = JSONObject.parseObject(content, ModifyPassWord.class); + logger.info(Util.logStr("cusPassWordAction messageId: {},UserInfo : {} ",message.getId(),JSONObject.toJSONString(passWord))); String outKey = passWord.getId(); String hrmId = consumerMapper.getHrmIdByOutKey(outKey); if(StringUtils.isBlank(hrmId)){ - throw new CustomerException(Util.logStr("the userId is {} , no personnel information found in oa!", hrmId)); + throw new CustomerException(Util.logStr("the userId is {} , no personnel information found in oa!", outKey)); } if (!consumerMapper.updatePasswordById(hrmId, Util.getEncrypt(passWord.getPassword()))) { throw new CustomerException("update user password error!"); } + writeInOA(message.getId()); return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; } catch (Exception e) { throw new CustomerException(Util.logStr("passWordAction execute error : [{}]!", e.getMessage())); @@ -47,6 +59,6 @@ public class PassWordServiceImpl extends CusInfoActionService { @Override public ConsumeConcurrentlyStatus cusUpdateAction(MQMessage message) { - return null; + return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; } } diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/service/impl/UserServiceImpl.java b/src/main/java/weaver/xuanran/wang/shyl_mq/service/impl/UserServiceImpl.java similarity index 79% rename from src/main/java/weaver/xuanran/wang/shyl/mq/service/impl/UserServiceImpl.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/service/impl/UserServiceImpl.java index c95c7b0..01d336e 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/service/impl/UserServiceImpl.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/service/impl/UserServiceImpl.java @@ -1,4 +1,4 @@ -package weaver.xuanran.wang.shyl.mq.service.impl; +package weaver.xuanran.wang.shyl_mq.service.impl; import aiyh.utils.Util; import aiyh.utils.excention.CustomerException; @@ -6,24 +6,21 @@ import com.alibaba.fastjson.JSONObject; import com.weaver.general.TimeUtil; import org.apache.commons.collections.MapUtils; import org.apache.commons.lang3.StringUtils; +import org.apache.log4j.Logger; import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyStatus; import weaver.conn.RecordSet; import weaver.hrm.finance.SalaryManager; import weaver.hrm.resource.ResourceComInfo; -import weaver.xiao.commons.utils.JsonResult; -import weaver.xuanran.wang.shyl.mq.constant.RocketMQConstant; -import weaver.xuanran.wang.shyl.mq.entity.MQMessage; -import weaver.xuanran.wang.shyl.mq.entity.UserInfo; -import weaver.xuanran.wang.shyl.mq.mapper.ConsumerMapper; -import weaver.xuanran.wang.shyl.mq.service.CusInfoActionService; +import weaver.xuanran.wang.shyl_mq.constant.RocketMQConstant; +import weaver.xuanran.wang.shyl_mq.service.CusInfoActionService; +import weaver.xuanran.wang.shyl_mq.entity.MQMessage; +import weaver.xuanran.wang.shyl_mq.entity.UserInfo; import java.util.ArrayList; import java.util.Calendar; import java.util.List; import java.util.Map; -import static com.api.ecme.excel.HtmlLayoutOperate.user; - /** *

用户业务方法

* @@ -31,7 +28,13 @@ import static com.api.ecme.excel.HtmlLayoutOperate.user; * @Date 2022/12/30 13:04 */ public class UserServiceImpl extends CusInfoActionService { + private Logger logger = Util.getLogger("mq-consumer-user"); + { + if(null == logger){ + logger = Util.getLogger("mq-consumer-user"); + } + } /** *

用户新增

* @author xuanran.wang @@ -41,10 +44,15 @@ public class UserServiceImpl extends CusInfoActionService { **/ @Override public ConsumeConcurrentlyStatus cusCreateAction(MQMessage message) { + String nextHrmId = ""; try { String content = message.getContent(); UserInfo userInfo = JSONObject.parseObject(content, UserInfo.class); - String outKey = userInfo.getId(); + logger.info(Util.logStr("userCusCreateAction messageId: {}, UserInfo : {} ",message.getId(), JSONObject.toJSONString(userInfo))); + String outKey = Util.null2DefaultStr(userInfo.getId(),""); + if(StringUtils.isBlank(outKey)){ + throw new CustomerException("create user id can not null!"); + } String userId = consumerMapper.getHrmIdByOutKey(outKey); // 如果存在就走更新 if(StringUtils.isNotBlank(userId)){ @@ -60,10 +68,16 @@ public class UserServiceImpl extends CusInfoActionService { // 通过外键获取部门信息数据为空 throw new CustomerException("The department information data obtained by foreign key is empty!"); } - String nextHrmId = getNextHrmId(); + nextHrmId = getNextHrmId(); List params = initHrmParam(nextHrmId, userInfo, depInfoByOutKey); String departmentId = Util.null2DefaultStr(depInfoByOutKey.get("departmentId"), ""); + if(StringUtils.isBlank(departmentId)){ + departmentId = Util.null2DefaultStr(depInfoByOutKey.get("DEPARTMENTID"), ""); + } String subCompanyId = Util.null2DefaultStr(depInfoByOutKey.get("subCompanyId"), ""); + if(StringUtils.isBlank(subCompanyId)){ + departmentId = Util.null2DefaultStr(depInfoByOutKey.get("SUBCOMPANYID"), ""); + } RecordSet insertRs = new RecordSet(); //使用sql新增人员 String insertSql = "insert into HrmResource(systemlanguage,workcode,departmentid,subcompanyid1," + @@ -93,11 +107,15 @@ public class UserServiceImpl extends CusInfoActionService { String sql_10 = ("insert into HrmInfoStatus (itemid,hrmid) values(10," + nextHrmId + ")"); insertRs.execute(sql_10); resourceComInfo.updateResourceInfoCache(nextHrmId); + writeInOA(message.getId()); return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; }else { throw new CustomerException(Util.logStr("insert HrmResource error sql : {}, params : {}", insertSql, JSONObject.toJSONString(params))); } }catch (Exception e){ + if(StringUtils.isNotBlank(nextHrmId)){ + consumerMapper.deleteHrmById(nextHrmId); + } throw new CustomerException(Util.logStr("hrmCreateAction error : {}", e.getMessage())); } } @@ -114,14 +132,16 @@ public class UserServiceImpl extends CusInfoActionService { try { String content = message.getContent(); UserInfo userInfo = JSONObject.parseObject(content, UserInfo.class); + logger.info(Util.logStr("userCusDeleteAction messageId: {},UserInfo : {} ", message.getId(),JSONObject.toJSONString(userInfo))); String id = userInfo.getId(); if(StringUtils.isBlank(id)){ throw new CustomerException("userInfo id can not be empty!"); } - boolean success = consumerMapper.updateUserStatusByOutKey(id); + boolean success = consumerMapper.deleteHrmByOutKey(id); if (!success) { throw new CustomerException(Util.logStr("update user status error!")); } + writeInOA(message.getId()); return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; } catch (Exception e) { throw new CustomerException(Util.logStr("hrmDeleteAction execute error : [{}]!", e.getMessage())); @@ -140,8 +160,9 @@ public class UserServiceImpl extends CusInfoActionService { try { String content = message.getContent(); UserInfo userInfo = JSONObject.parseObject(content, UserInfo.class); - String userInfoId = userInfo.getId(); - String userInfoDepartmentId = userInfo.getDepartmentId(); + logger.info(Util.logStr("userCusUpdateAction messageId: {},UserInfo : {} ", message.getId(), JSONObject.toJSONString(userInfo))); + String userInfoId = Util.null2DefaultStr(userInfo.getId(),""); + String userInfoDepartmentId = Util.null2DefaultStr(userInfo.getDepartmentId(),""); // 接口人员id if(StringUtils.isBlank(userInfoId)){ throw new CustomerException("userInfo id can not be empty!"); @@ -159,7 +180,8 @@ public class UserServiceImpl extends CusInfoActionService { // oa人员id String hrmId = consumerMapper.getHrmIdByOutKey(userInfoId); if(StringUtils.isBlank(hrmId)){ - throw new CustomerException(Util.logStr("userInfoId = [{}], No personnel information found in oa!", userInfoId)); + logger.error(Util.logStr("userInfoId = [{}], No personnel information found in oa!", userInfoId)); + return cusCreateAction(message); } //使用sql新增人员 String updateSql = "update HrmResource set systemlanguage = ?, workcode = ?, departmentid = ?, subcompanyid1 = ?," + @@ -173,9 +195,10 @@ public class UserServiceImpl extends CusInfoActionService { ResourceComInfo resourceComInfo = new ResourceComInfo(); // 清空缓存 resourceComInfo.updateResourceInfoCache(hrmId); + writeInOA(message.getId()); return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; }catch (Exception e){ - throw new CustomerException(Util.logStr("hrmUpdateAction execute error : [{}]!", e.getMessage())); + throw new CustomerException(Util.logStr("userCusUpdateAction execute error : [{}]!", e.getMessage())); } } @@ -194,7 +217,13 @@ public class UserServiceImpl extends CusInfoActionService { ArrayList params = new ArrayList<>(); String userName = Util.null2DefaultStr(userInfo.getUserName(), ""); String departmentId = Util.null2DefaultStr(depInfoByOutKey.get("departmentId"), ""); + if(StringUtils.isBlank(departmentId)){ + departmentId = Util.null2DefaultStr(depInfoByOutKey.get("DEPARTMENTID"), ""); + } String subCompanyId = Util.null2DefaultStr(depInfoByOutKey.get("subCompanyId"), ""); + if(StringUtils.isBlank(subCompanyId)){ + subCompanyId = Util.null2DefaultStr(depInfoByOutKey.get("SUBCOMPANYID"), ""); + } // 语言 params.add(7); // 工号 @@ -238,6 +267,6 @@ public class UserServiceImpl extends CusInfoActionService { @Override public ConsumeConcurrentlyStatus cusPassWordAction(MQMessage message) { - return null; + return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; } } diff --git a/src/main/java/weaver/xuanran/wang/shyl_mq/service/interfaces/CRUDAction.java b/src/main/java/weaver/xuanran/wang/shyl_mq/service/interfaces/CRUDAction.java new file mode 100644 index 0000000..5d78e47 --- /dev/null +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/service/interfaces/CRUDAction.java @@ -0,0 +1,17 @@ +package weaver.xuanran.wang.shyl_mq.service.interfaces; + +import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyStatus; +import weaver.xuanran.wang.shyl_mq.entity.MQMessage; + +/** + *

组织/用户 新增、删除、更新action

+ * + * @author xuanran.wang + * @date 2023/2/22 09:43 + */ +public interface CRUDAction { + ConsumeConcurrentlyStatus cusCreateAction(MQMessage message); + ConsumeConcurrentlyStatus cusDeleteAction(MQMessage message); + ConsumeConcurrentlyStatus cusUpdateAction(MQMessage message); + ConsumeConcurrentlyStatus cusPassWordAction(MQMessage message); +} diff --git a/src/main/java/weaver/xuanran/wang/shyl/mq/util/RocketUtil.java b/src/main/java/weaver/xuanran/wang/shyl_mq/util/RocketConsumerUtil.java similarity index 57% rename from src/main/java/weaver/xuanran/wang/shyl/mq/util/RocketUtil.java rename to src/main/java/weaver/xuanran/wang/shyl_mq/util/RocketConsumerUtil.java index c5ef4d6..a27c413 100644 --- a/src/main/java/weaver/xuanran/wang/shyl/mq/util/RocketUtil.java +++ b/src/main/java/weaver/xuanran/wang/shyl_mq/util/RocketConsumerUtil.java @@ -1,4 +1,4 @@ -package weaver.xuanran.wang.shyl.mq.util; +package weaver.xuanran.wang.shyl_mq.util;//package weaver.xuanran.wang.shyl.mq.util; import aiyh.utils.Util; import aiyh.utils.excention.CustomerException; @@ -18,14 +18,16 @@ import org.apache.rocketmq.common.message.Message; import org.apache.rocketmq.common.message.MessageExt; import org.apache.rocketmq.remoting.common.RemotingHelper; import org.apache.rocketmq.remoting.exception.RemotingException; -import weaver.xuanran.wang.shyl.mq.constant.RocketMQConstant; -import weaver.xuanran.wang.shyl.mq.RocketMQFactory; -import weaver.xuanran.wang.shyl.mq.entity.MQMessage; -import weaver.xuanran.wang.shyl.mq.service.CusInfoActionService; +import weaver.xuanran.wang.common.util.CusInfoToOAUtil; +import weaver.xuanran.wang.shyl_mq.RocketMQFactory; +import weaver.xuanran.wang.shyl_mq.constant.RocketMQConstant; +import weaver.xuanran.wang.shyl_mq.entity.MQMessage; +import weaver.xuanran.wang.shyl_mq.mapper.ConsumerMapper; +import weaver.xuanran.wang.shyl_mq.service.CusInfoActionService; +import weaver.zwl.common.ToolUtil; import java.nio.charset.StandardCharsets; -import java.util.List; -import java.util.Map; +import java.util.*; /** *

rocketMQ集成工具类

@@ -33,8 +35,18 @@ import java.util.Map; * @Author xuanran.wang * @Date 2022/12/29 21:03 */ -public class RocketUtil { - private static final Logger log = Util.getLogger(); +public class RocketConsumerUtil { + private static Logger log = Util.getLogger("mq-util"); + private static final ConsumerMapper consumerMapper = Util.getMapper(ConsumerMapper.class); + private static final ToolUtil tool = new ToolUtil(); + private static final int ERROR_LOG_ID; + + static { + ERROR_LOG_ID = Util.getIntValue(tool.getSystemParamValue("mqErrorLogModelId"), -1); + if(log == null){ + log = Util.getLogger("mq-util"); + } + } /** *

初始化配置文件对象

@@ -70,52 +82,71 @@ public class RocketUtil { public static ConsumeConcurrentlyStatus execute(List msg, ConsumeConcurrentlyContext consumeConcurrentlyContext, CusInfoActionService cusInfoActionService, String configName){ Map configMap = RocketMQFactory.CONFIG_MAPS.get(configName); - log.info(Util.logStr("{} service config is {}", configName, JSONObject.toJSONString(configMap))); - int maxReconsumeTimes = Util.getIntValue(Util.null2String(configMap.get("MaxReconsumeTimes")),RocketMQConstant.DEFAULT_MAX_RECONSUME_TIMES); + int maxReconsumeTimes = Util.getIntValue(Util.null2String(configMap.get("MaxReconsumeTimes")), RocketMQConstant.DEFAULT_MAX_RECONSUME_TIMES); + MessageExt messageExt = null; + String msgBody = ""; + String mqMessageId = ""; + MQMessage mqMessage = null; try { if (CollectionUtils.isNotEmpty(msg)) { - MessageExt messageExt = msg.get(0); - String msgBody; - MQMessage mqMessage; + messageExt = msg.get(0); + if(Objects.isNull(messageExt)){ + throw new CustomerException("messageExt is null!"); + } try { msgBody = new String(messageExt.getBody(), StandardCharsets.UTF_8); if(StringUtils.isBlank(msgBody)){ throw new CustomerException("MQ msgBody is empty!"); } mqMessage = JSONObject.parseObject(msgBody, MQMessage.class); - // 业务主体 - String content = Util.null2DefaultStr(mqMessage.getContent(),""); - if(StringUtils.isBlank(content)){ - throw new CustomerException(Util.logStr("the messageId : {}, content is empty!", Util.null2DefaultStr(mqMessage.getId(), ""))); - } - log.info(Util.logStr("MQMessage : {} ", mqMessage)); - // 业务类型 - String actionType = mqMessage.getActionType(); - switch (actionType){ - case RocketMQConstant.CREATE_ACTION:{ - return cusInfoActionService.cusCreateAction(mqMessage); - } - case RocketMQConstant.UPDATE_ACTION:{ - return cusInfoActionService.cusUpdateAction(mqMessage); - } - case RocketMQConstant.DELETE_ACTION:{ - return cusInfoActionService.cusDeleteAction(mqMessage); - } - case RocketMQConstant.PASSWORD_ACTION:{ - return cusInfoActionService.cusPassWordAction(mqMessage); - } - default: throw new CustomerException(Util.logStr("current actionType : [{}] is not supported!", actionType)); + if(Objects.isNull(mqMessage)){ + throw new CustomerException("parseObject error!"); } }catch (Exception e){ - throw new CustomerException(Util.logStr("parse msgBody to Message error current msgBody is {}, the error is {}", msg, e.getMessage())); + throw new CustomerException(Util.logStr("parse msgBody to Message error current msgBody is {}, the error is {}", msgBody, e.getMessage())); + } + // 业务主体 + String content = Util.null2DefaultStr(mqMessage.getContent(),""); + if(StringUtils.isBlank(content)){ + throw new CustomerException(Util.logStr("the messageId : {}, content is empty! msgBody : {}", Util.null2DefaultStr(mqMessage.getId(), ""), msgBody)); + } + mqMessageId = mqMessage.getId(); + int mqLogByMessageId = consumerMapper.getMainIdFromMQLogByMessageId(mqMessageId); + if(mqLogByMessageId > 0){ + log.error(Util.logStr("MQMessageId: {}, Already consumed!",mqMessageId)); + return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; + } + // 业务类型 + String actionType = mqMessage.getActionType(); + switch (actionType){ + case RocketMQConstant.CREATE_ACTION:{ + return cusInfoActionService.cusCreateAction(mqMessage); + } + case RocketMQConstant.UPDATE_ACTION:{ + return cusInfoActionService.cusUpdateAction(mqMessage); + } + case RocketMQConstant.DELETE_ACTION:{ + return cusInfoActionService.cusDeleteAction(mqMessage); + } + case RocketMQConstant.PASSWORD_ACTION:{ + return cusInfoActionService.cusPassWordAction(mqMessage); + } + default: throw new CustomerException(Util.logStr("current actionType : [{}] is not supported!", actionType)); } }else { log.error("the msgList is empty!"); } } catch (Exception e) { - // 如果重试达到最大还是异常那么先返回成功 oa将错误日志记录到日志中 + log.error(Util.logStr("msgId: {}, RocketUtil error: {}",mqMessageId, e.getMessage() )); if (msg.get(0).getReconsumeTimes() == maxReconsumeTimes) { - //TODO + if(!Objects.isNull(mqMessage)){ + mqMessage.setError(e.getMessage()); + List ids = CusInfoToOAUtil.executeBatchByEntity(ERROR_LOG_ID, Collections.singletonList(mqMessage), ""); + if(CollectionUtils.isEmpty(ids)){ + log.error("insert into mq_error_log failed!"); + } + } + log.error(Util.logStr("MQ producer error already bigger maxReconsumeTimes! messageId : {}",mqMessageId)); return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; } else { return ConsumeConcurrentlyStatus.RECONSUME_LATER; @@ -130,8 +161,9 @@ public class RocketUtil { * @dateTime 2023/1/4 14:30 * @param configName 配置文件名称 * @param msg 消息主体 + * @param requestId 请求id **/ - public static void producerSendMsg(String configName, String msg) { + public static void producerSendMsg(String configName, String msg, String requestId) { // 先从本地缓存中获取生产者对象 DefaultMQProducer producer = RocketMQFactory.getMQProducer(configName); // 获取配置信息 @@ -142,7 +174,7 @@ public class RocketUtil { String tag = Util.null2DefaultStr(configMap.get("Tag"), ""); Message message; try { - message = new Message(topic, tag, msg.getBytes(RemotingHelper.DEFAULT_CHARSET)); + message = new Message(topic, msg.getBytes(RemotingHelper.DEFAULT_CHARSET)); } catch (Exception e) { throw new CustomerException(Util.logStr("init message error : {} !", e.getMessage())); } @@ -156,8 +188,9 @@ public class RocketUtil { try { result = producer.send(message); } catch (MQClientException | RemotingException | MQBrokerException | InterruptedException e) { - throw new CustomerException(Util.logStr("producer send message error!", e.getMessage())); + throw new CustomerException(Util.logStr("producer send message error!: {}", e.getMessage())); } + log.info(Util.logStr("requestId: {}, result : {}",requestId, JSONObject.toJSONString(result))); SendStatus sendStatus = result.getSendStatus(); // 如果失败 if (!SendStatus.SEND_OK.equals(sendStatus)) { @@ -165,11 +198,13 @@ public class RocketUtil { log.error(error); // 如果重试超过最大次数 if(count >= RocketMQConstant.SEND_MAX_COUNT){ - throw new CustomerException(error); + throw new CustomerException(error + " and retry > max"); } }else { sendOk = true; } - } while (!sendOk || count < RocketMQConstant.SEND_MAX_COUNT); + } while (!sendOk); } + + } diff --git a/src/main/java/weaver/youhong/ai/pcn/actioin/ccworkflow/CCWorkflowAction.java b/src/main/java/weaver/youhong/ai/pcn/actioin/ccworkflow/CCWorkflowAction.java index 0aacab6..986f396 100644 --- a/src/main/java/weaver/youhong/ai/pcn/actioin/ccworkflow/CCWorkflowAction.java +++ b/src/main/java/weaver/youhong/ai/pcn/actioin/ccworkflow/CCWorkflowAction.java @@ -194,7 +194,7 @@ public class CCWorkflowAction extends SafeCusBaseAction { * @param ccUserIds 抄送用户列表 * @param requestTitle 流程明晨 */ - private void sendMsg(RequestInfo requestInfo, Map currentOperatorIdMap, Set ccUserIds, String requestTitle) { + public void sendMsg(RequestInfo requestInfo, Map currentOperatorIdMap, Set ccUserIds, String requestTitle) { RequestManager requestManager = requestInfo.getRequestManager(); MsgEntity msgEntity = new MsgEntity(); diff --git a/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/ModeExpandQuanJinSaveAction.java b/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/ModeExpandQuanJinSaveAction.java new file mode 100644 index 0000000..d3b8e29 --- /dev/null +++ b/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/ModeExpandQuanJinSaveAction.java @@ -0,0 +1,40 @@ +package weaver.youhong.ai.yihong.formmode.stagediagram; + +import aiyh.utils.Util; +import com.alibaba.fastjson.JSON; +import org.apache.log4j.Logger; +import weaver.formmode.customjavacode.AbstractModeExpandJavaCodeNew; +import weaver.youhong.ai.yihong.formmode.stagediagram.service.ModeExpandSaveService; + +import java.util.HashMap; +import java.util.Map; + +/** + *

保存自定义处理方法

+ * + *

create: 2023-02-06 12:57

+ * + * @author youHong.ai + */ + +public class ModeExpandQuanJinSaveAction extends AbstractModeExpandJavaCodeNew { + + private final Logger log = Util.getLogger(); + + @Override + public Map doModeExpand(Map param) { + Map result = new HashMap<>(8); + ModeExpandSaveService service = new ModeExpandSaveService(); + try { + log.info("自定义接口保存动作参数: " + JSON.toJSONString(param)); + service.updateStageDiagramView(param, + "STAGE_DIAGRAM_AMOUNT_TABLE_QJ", "STAGE_DIAGRAM_PROJECT_ID_FIELD_QJ", + "STAGE_DIAGRAM_AMOUNT_FIELD_QJ", "MAPPING_CONFIG_MARK_QJ"); + } catch (Exception e) { + result.put("errmsg", e.getMessage()); + result.put("flag", "false"); + log.error("建模自定义保存接口错误：" + e.getMessage() + Util.getErrString(e)); + } + return result; + } +} diff --git a/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/ModeExpandSaveAction.java b/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/ModeExpandSaveAction.java index 9d51a57..a7735e0 100644 --- a/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/ModeExpandSaveAction.java +++ b/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/ModeExpandSaveAction.java @@ -18,23 +18,23 @@ import java.util.Map; */ public class ModeExpandSaveAction extends AbstractModeExpandJavaCodeNew { - - private final Logger log = Util.getLogger(); - - @Override - public Map doModeExpand(Map param) { - Map result = new HashMap<>(8); - ModeExpandSaveService service = new ModeExpandSaveService(); - try { - log.info("自定义接口保存动作参数: " + JSON.toJSONString(param)); - service.updateStageDiagramView(param, - "STAGE_DIAGRAM_AMOUNT_TABLE", "STAGE_DIAGRAM_PROJECT_ID_FIELD", - "STAGE_DIAGRAM_AMOUNT_FIELD"); - } catch (Exception e) { - result.put("errmsg", e.getMessage()); - result.put("flag", "false"); - log.error("建模自定义保存接口错误：" + e.getMessage() + Util.getErrString(e)); - } - return result; - } + + private final Logger log = Util.getLogger(); + + @Override + public Map doModeExpand(Map param) { + Map result = new HashMap<>(8); + ModeExpandSaveService service = new ModeExpandSaveService(); + try { + log.info("自定义接口保存动作参数: " + JSON.toJSONString(param)); + service.updateStageDiagramView(param, + "STAGE_DIAGRAM_AMOUNT_TABLE", "STAGE_DIAGRAM_PROJECT_ID_FIELD", + "STAGE_DIAGRAM_AMOUNT_FIELD", "MAPPING_CONFIG_MARK"); + } catch (Exception e) { + result.put("errmsg", e.getMessage()); + result.put("flag", "false"); + log.error("建模自定义保存接口错误：" + e.getMessage() + Util.getErrString(e)); + } + return result; + } } diff --git a/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/mapper/ModeExpandSaveActionMapper.java b/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/mapper/ModeExpandSaveActionMapper.java index 1ca1d46..f41eb0b 100644 --- a/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/mapper/ModeExpandSaveActionMapper.java +++ b/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/mapper/ModeExpandSaveActionMapper.java @@ -1,11 +1,11 @@ package weaver.youhong.ai.yihong.formmode.stagediagram.mapper; -import aiyh.utils.annotation.recordset.ParamMapper; -import aiyh.utils.annotation.recordset.Select; -import aiyh.utils.annotation.recordset.SqlMapper; -import aiyh.utils.annotation.recordset.Update; +import aiyh.utils.annotation.recordset.*; import weaver.youhong.ai.yihong.formmode.stagediagram.dto.StageNodeInfo; +import weaver.youhong.ai.yihong.formmode.stagediagram.pojo.StageUpdateFieldConfig; +import weaver.youhong.ai.yihong.formmode.stagediagram.pojo.StageUpdateFieldItem; +import java.util.List; import java.util.Map; /** @@ -18,46 +18,117 @@ import java.util.Map; @SqlMapper public interface ModeExpandSaveActionMapper { - - /** - *

查询台账信息

- * - * @param projectId 项目id - * @return 项目台账信息 - */ - @Select("select * from uf_stage_node_info where project_id = #{projectId}") - StageNodeInfo selectStageNodeInfoByProjectId(@ParamMapper("projectId") String projectId); - - /** - *

根据唯一标识查询配置表主表ID

- * - * @param onlyMark 唯一标识 - * @return 主表id - */ - @Select("select id from uf_yh_stage_diagram where only_mark = #{onlyMark}") - Integer selectConfigMainId(@ParamMapper("onlyMark") String onlyMark); - - /** - *

查询配置表明细表信息

- * - * @param formId 表单id - * @return 明细id - */ - // @Select("select * from uf_yh_stage_diagram_dt1 where mainid = #{mainId} and model_table = #{formId]") - // Map selectDetailConfig(@ParamMapper("mainId") Integer mainId, @ParamMapper("formId") String formId); - @Select("select * from uf_yh_stage_diagram_dt1 where model_table = #{formId}") - Map selectDetailConfig(@ParamMapper("formId") String formId); - - @Select("select $t{amountField} from $t{amountTable} where $t{projectIdField} = #{projectId}") - String selectAmountByProjectId(@ParamMapper("projectId") String projectId, - @ParamMapper("projectIdField") String projectIdField, - @ParamMapper("amountTable") String amountTable, - @ParamMapper("amountField") String amountField); - - @Update("update uf_stage_node_info set project_id = #{projectId}, amount = #{amount}, " + - "current_node = #{nodeName} where id = #{dataId}") - boolean updateStageNodeInfo(@ParamMapper("dataId") Integer dataId, - @ParamMapper("projectId") String projectId, - @ParamMapper("nodeName") String nodeName, - @ParamMapper("amount") String amount); + + /** + *

查询台账信息

+ * + * @param projectId 项目id + * @return 项目台账信息 + */ + @Select("select * from uf_stage_node_info where project_id = #{projectId}") + StageNodeInfo selectStageNodeInfoByProjectId(@ParamMapper("projectId") String projectId); + + /** + *

根据唯一标识查询配置表主表ID

+ * + * @param onlyMark 唯一标识 + * @return 主表id + */ + @Select("select id from uf_yh_stage_diagram where only_mark = #{onlyMark}") + Integer selectConfigMainId(@ParamMapper("onlyMark") String onlyMark); + + /** + *

查询配置表明细表信息

+ * + * @param formId 表单id + * @return 明细id + */ + @Select("select * from uf_yh_stage_diagram_dt1 where model_table = #{formId}") + Map selectDetailConfig(@ParamMapper("formId") String formId); + + /** + *

查询金额

+ * + * @param projectId 项目ID + * @param projectIdField 项目id字段 + * @param amountTable 金额表 + * @param amountField 金额字段 + * @return 金额 + */ + @Select("select $t{amountField} from $t{amountTable} where $t{projectIdField} = #{projectId}") + String selectAmountByProjectId(@ParamMapper("projectId") String projectId, + @ParamMapper("projectIdField") String projectIdField, + @ParamMapper("amountTable") String amountTable, + @ParamMapper("amountField") String amountField); + + /** + *

更新阶段信息

+ * + * @param dataId 数据ID + * @param projectId 项目id + * @param nodeName 节点信息 + * @param amount 钱 + * @return 是否成功 + */ + @Update("update uf_stage_node_info set project_id = #{projectId}, amount = #{amount}, " + + "current_node = #{nodeName} where id = #{dataId}") + boolean updateStageNodeInfo(@ParamMapper("dataId") Integer dataId, + @ParamMapper("projectId") String projectId, + @ParamMapper("nodeName") String nodeName, + @ParamMapper("amount") String amount); + + /** + *

查询信息

+ * + * @param onlyMark 唯一标识 + * @return 查询配置结果 + */ + @Select("select * from uf_yh_stage_diagram where only_mark = #{onlyMark}") + @Associations({ + @Association(property = "baseTable", + column = "base_table", + select = "aiyh.utils.mapper.UtilMapper.selectModelTableInfo", + id = @Id(Integer.class)) + }) + @CollectionMappings({ + @CollectionMapping(property = "mappings", + column = "id", + id = @Id(value = Integer.class, methodId = 1)) + }) + StageUpdateFieldConfig selectConfigUpdate(@ParamMapper("onlyMark") String onlyMark); + + + /** + *

查询配置表明细数据

+ * + * @param mainId 主表id + * @return 明细数据 + */ + @CollectionMethod(1) + @Select("select * from uf_yh_stage_diagram_dt2 where mainid = #{mainId}") + @Associations({ + @Association(property = "baseTableFiled", + column = "base_table_filed", + select = "aiyh.utils.mapper.UtilMapper.selectFieldInfo", + id = @Id(Integer.class)) + }) + List selectConfigItem(Integer mainId); + + /** + *

查询自定义sql

+ * + * @param sql 自定义sql + * @return 查询结果 + */ + @Select(custom = true) + Map selectCustomerSql(@SqlString String sql); + + /** + *

更新自定义信息

+ * + * @param sqlString sqlString + * @param projectInfo 项目信息 + */ + @Update(custom = true) + void updateCustomerSql(@SqlString String sqlString, Map projectInfo); } diff --git a/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/pojo/StageUpdateFieldConfig.java b/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/pojo/StageUpdateFieldConfig.java new file mode 100644 index 0000000..02cb989 --- /dev/null +++ b/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/pojo/StageUpdateFieldConfig.java @@ -0,0 +1,33 @@ +package weaver.youhong.ai.yihong.formmode.stagediagram.pojo; + +import aiyh.utils.entity.ModelTableInfo; +import lombok.Getter; +import lombok.Setter; +import lombok.ToString; + +import java.util.List; + +/** + *

+ * + *

create: 2023/3/14 17:02

+ * + * @author youHong.ai + */ +@Getter +@Setter +@ToString +public class StageUpdateFieldConfig { + + /** id */ + private Integer id; + + /** 唯一标识 */ + private String onlyMark; + + /** 建模表信息 */ + private ModelTableInfo baseTable; + + /** 配置表明细映射 */ + private List mappings; +} diff --git a/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/pojo/StageUpdateFieldItem.java b/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/pojo/StageUpdateFieldItem.java new file mode 100644 index 0000000..511648c --- /dev/null +++ b/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/pojo/StageUpdateFieldItem.java @@ -0,0 +1,27 @@ +package weaver.youhong.ai.yihong.formmode.stagediagram.pojo; + +import aiyh.utils.entity.FieldViewInfo; +import lombok.Getter; +import lombok.Setter; +import lombok.ToString; + +/** + *

+ * + *

create: 2023/3/14 17:09

+ * + * @author youHong.ai + */ +@Getter +@Setter +@ToString +public class StageUpdateFieldItem { + + /** id */ + private Integer id; + /** 项目基本信息表字段 */ + private FieldViewInfo baseTableFiled; + + /** 台账字段 */ + private String targetField; +} diff --git a/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/service/ModeExpandSaveService.java b/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/service/ModeExpandSaveService.java index fcea666..f327ddd 100644 --- a/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/service/ModeExpandSaveService.java +++ b/src/main/java/weaver/youhong/ai/yihong/formmode/stagediagram/service/ModeExpandSaveService.java @@ -1,7 +1,7 @@ package weaver.youhong.ai.yihong.formmode.stagediagram.service; import aiyh.utils.Util; -import cn.hutool.core.lang.Assert; +import aiyh.utils.tool.cn.hutool.core.lang.Assert; import com.alibaba.fastjson.JSON; import org.apache.log4j.Logger; import org.jetbrains.annotations.NotNull; @@ -9,11 +9,10 @@ import weaver.soa.workflow.request.Property; import weaver.soa.workflow.request.RequestInfo; import weaver.youhong.ai.yihong.formmode.stagediagram.dto.StageNodeInfo; import weaver.youhong.ai.yihong.formmode.stagediagram.mapper.ModeExpandSaveActionMapper; +import weaver.youhong.ai.yihong.formmode.stagediagram.pojo.StageUpdateFieldConfig; +import weaver.youhong.ai.yihong.formmode.stagediagram.pojo.StageUpdateFieldItem; -import java.util.Collections; -import java.util.HashMap; -import java.util.Map; -import java.util.Objects; +import java.util.*; /** *

保存自定义处理方法service

@@ -24,86 +23,123 @@ import java.util.Objects; */ public class ModeExpandSaveService { - - private final Logger log = Util.getLogger(); - - private final ModeExpandSaveActionMapper mapper = Util.getMapper(ModeExpandSaveActionMapper.class); - - public void updateStageDiagramView(Map param, - String amountTable, - String projectIdField, - String amountField) { - /* ******************* 查询当前节点对应的projectId ******************* */ - String formId = Util.null2String(param.get("formId")); - Map currentNodeConfig = mapper.selectDetailConfig(formId); - // String stageDiagramProjectFieldName = Util.getCusConfigValue(projectFieldMark); - String stageDiagramProjectFieldName = Util.null2String(currentNodeConfig.get("projectFieldName")); - Assert.notBlank(stageDiagramProjectFieldName, "cna not find projectFieldMark from uf_cus_dev_config! the config can not be null!"); - RequestInfo requestInfo = (RequestInfo) param.get("RequestInfo"); - Map mainTableValue = getMainTableValue(requestInfo); - String projectId = mainTableValue.get(stageDiagramProjectFieldName); - log.info("主表数据：" + JSON.toJSONString(mainTableValue)); - // 获取当前模块id - /* ******************* 查询台账中对应的project是否存在, 台账中不存在则插入，存在则更新 ******************* */ - StageNodeInfo nodeInfo = mapper.selectStageNodeInfoByProjectId(projectId); - log.info("查询到的nodeINFo数据:" + JSON.toJSONString(nodeInfo)); - if (Objects.isNull(nodeInfo)) { + + private final Logger log = Util.getLogger(); + + private final ModeExpandSaveActionMapper mapper = Util.getMapper(ModeExpandSaveActionMapper.class); + + public void updateStageDiagramView(Map param, + String amountTable, + String projectIdField, + String amountField, + String mappingConfigMark) { + /* ******************* 查询当前节点对应的projectId ******************* */ + String formId = Util.null2String(param.get("formId")); + Map currentNodeConfig = mapper.selectDetailConfig(formId); + String stageDiagramProjectFieldName = Util.null2String(currentNodeConfig.get("projectFieldName")); + Assert.notBlank(stageDiagramProjectFieldName, "cna not find projectFieldMark from uf_cus_dev_config! the config can not be null!"); + RequestInfo requestInfo = (RequestInfo) param.get("RequestInfo"); + Map mainTableValue = getMainTableValue(requestInfo); + String projectId = mainTableValue.get(stageDiagramProjectFieldName); + log.info("主表数据：" + JSON.toJSONString(mainTableValue)); + // 获取当前模块id + /* ******************* 查询台账中对应的project是否存在, 台账中不存在则插入，存在则更新 ******************* */ + StageNodeInfo nodeInfo = mapper.selectStageNodeInfoByProjectId(projectId); + log.info("查询到的nodeInFo数据:" + JSON.toJSONString(nodeInfo)); + if (Objects.isNull(nodeInfo)) { // 不存在项目信息在台账中插入项目信息到台账信息中 - Integer dataId = Util.getModeDataId("uf_stage_node_info", 1); - // 查询配置表信息 - // Integer mainId = mapper.selectConfigMainId(Util.getCusConfigValue(onlyMarkCusMark)); - // Map currentNodeConfig = mapper.selectDetailConfig(mainId, formId); - String nodeName = (String) currentNodeConfig.get("nodeName"); - log.info("节点名称： " + nodeName); - String amount = mapper.selectAmountByProjectId(projectId, - Util.getCusConfigValueNullOrEmpty(projectIdField, ""), - Util.getCusConfigValueNullOrEmpty(amountTable, ""), - Util.getCusConfigValueNullOrEmpty(amountField, "")); - - boolean update = mapper.updateStageNodeInfo(dataId, projectId, nodeName, amount); - if (!update) { - Util.deleteModeId("uf_stage_node_info", dataId); - } else { - Util.rebuildModeDataShare(1, Integer.parseInt(Util.getModeIdByTableName("uf_stage_node_info")), - dataId); - } - } else { - // 存在，更新当前项目的节点信息 - Integer dataId = nodeInfo.getId(); - // Integer mainId = mapper.selectConfigMainId(Util.getCusConfigValue(onlyMarkCusMark)); - // Map currentNodeConfig = mapper.selectDetailConfig(mainId, formId); - String nodeName = (String) currentNodeConfig.get("nodeName"); - String amount = mapper.selectAmountByProjectId(projectId, - Util.getCusConfigValueNullOrEmpty(projectIdField, ""), - Util.getCusConfigValueNullOrEmpty(amountTable, ""), - Util.getCusConfigValueNullOrEmpty(amountField, "")); - mapper.updateStageNodeInfo(dataId, projectId, nodeName, amount); - } - } - - - /** - *

获取流程主表数据

- * - * @return 流程主表数据 - */ - protected Map getMainTableValue(RequestInfo requestInfo) { - // 获取主表数据 - Property[] propertyArr = requestInfo.getMainTableInfo().getProperty(); - return getStringMap(propertyArr); - } - - @NotNull - private Map getStringMap(Property[] propertyArr) { - if (null == propertyArr) { - return Collections.emptyMap(); - } - Map mainTable = new HashMap<>(8); - for (Property property : propertyArr) { - String fieldName = property.getName(); - String value = property.getValue(); - mainTable.put(fieldName, value); - } - return mainTable; - } + Integer dataId = Util.getModeDataId("uf_stage_node_info", 1); + // 查询配置表信息 + String nodeName = (String) currentNodeConfig.get("nodeName"); + log.info("节点名称： " + nodeName); + String amount = mapper.selectAmountByProjectId(projectId, + Util.getCusConfigValueNullOrEmpty(projectIdField, ""), + Util.getCusConfigValueNullOrEmpty(amountTable, ""), + Util.getCusConfigValueNullOrEmpty(amountField, "")); + + boolean update = mapper.updateStageNodeInfo(dataId, projectId, nodeName, amount); + if (!update) { + Util.deleteModeId("uf_stage_node_info", dataId); + } else { + Util.rebuildModeDataShare(1, Integer.parseInt(Util.getModeIdByTableName("uf_stage_node_info")), + dataId); + } + } else { + // 存在，更新当前项目的节点信息 + Integer dataId = nodeInfo.getId(); + String nodeName = (String) currentNodeConfig.get("nodeName"); + String amount = mapper.selectAmountByProjectId(projectId, + Util.getCusConfigValueNullOrEmpty(projectIdField, ""), + Util.getCusConfigValueNullOrEmpty(amountTable, ""), + Util.getCusConfigValueNullOrEmpty(amountField, "")); + mapper.updateStageNodeInfo(dataId, projectId, nodeName, amount); + } + /* ******************* 更新其他字段 ******************* */ + String onlyMark = Util.getCusConfigValue(mappingConfigMark); + StageUpdateFieldConfig stageUpdateFieldConfig = mapper.selectConfigUpdate(onlyMark); + if (stageUpdateFieldConfig == null) { + return; + } + List mappings = stageUpdateFieldConfig.getMappings(); + if (mappings == null || mappings.isEmpty()) { + return; + } + StringBuilder selectSql = new StringBuilder(); + selectSql.append("select "); + StringBuilder update = new StringBuilder(); + update.append("update uf_stage_node_info set "); + + for (StageUpdateFieldItem item : mappings) { + selectSql.append(item.getBaseTableFiled().getFieldName()) + .append(","); + update.append(" ") + .append(item.getTargetField().trim()) + .append(" = ") + .append(" #{") + .append(item.getBaseTableFiled().getFieldName()) + .append("},"); + } + selectSql.deleteCharAt(selectSql.length() - 1); + update.deleteCharAt(update.length() - 1); + selectSql.append(" from ") + .append(stageUpdateFieldConfig.getBaseTable().getTableName()) + .append(" where ") + .append(Util.getCusConfigValueNullOrEmpty(projectIdField, "")) + .append(" = '") + .append(projectId.replace("'", "''")) + .append("'"); + Map projectInfo = mapper.selectCustomerSql(selectSql.toString()); + Assert.notEmpty(projectInfo, "query project info empty!"); + update.append(" where project_id = '") + .append(projectId.replace("'", "''")) + .append("'"); + mapper.updateCustomerSql(update.toString(), projectInfo); + + } + + + /** + *

获取流程主表数据

+ * + * @return 流程主表数据 + */ + protected Map getMainTableValue(RequestInfo requestInfo) { + // 获取主表数据 + Property[] propertyArr = requestInfo.getMainTableInfo().getProperty(); + return getStringMap(propertyArr); + } + + @NotNull + private Map getStringMap(Property[] propertyArr) { + if (null == propertyArr) { + return Collections.emptyMap(); + } + Map mainTable = new HashMap<>(8); + for (Property property : propertyArr) { + String fieldName = property.getName(); + String value = property.getValue(); + mainTable.put(fieldName, value); + } + return mainTable; + } } diff --git a/src/main/resources/WEB-INF/prop/prop2map/OACar.properties b/src/main/resources/WEB-INF/prop/prop2map/OACar.properties index 0606409..e59d985 100644 --- a/src/main/resources/WEB-INF/prop/prop2map/OACar.properties +++ b/src/main/resources/WEB-INF/prop/prop2map/OACar.properties @@ -1,4 +1,4 @@ ConsumerGroup=weaver-car -NameServer=183.192.65.118:9876 +NameServer=114.115.168.220:9876 Topic=OA_CAR_TOPIC Tag=* \ No newline at end of file diff --git a/src/main/resources/WEB-INF/prop/prop2map/OAMeal.properties b/src/main/resources/WEB-INF/prop/prop2map/OAMeal.properties index 4bbdaf5..4df76a1 100644 --- a/src/main/resources/WEB-INF/prop/prop2map/OAMeal.properties +++ b/src/main/resources/WEB-INF/prop/prop2map/OAMeal.properties @@ -1,4 +1,4 @@ ConsumerGroup=weaver-meal -NameServer=183.192.65.118:9876 +NameServer=114.115.168.220:9876 Topic=OA_MEAL_TOPIC Tag=* \ No newline at end of file diff --git a/src/main/resources/WEB-INF/prop/prop2map/OAMeeting.properties b/src/main/resources/WEB-INF/prop/prop2map/OAMeeting.properties index a693a32..ca730e1 100644 --- a/src/main/resources/WEB-INF/prop/prop2map/OAMeeting.properties +++ b/src/main/resources/WEB-INF/prop/prop2map/OAMeeting.properties @@ -1,4 +1,5 @@ ConsumerGroup=weaver-meeting -NameServer=183.192.65.118:9876 +NameServer=114.115.168.220:9876 +#114.115.168.220:9876 Topic=OA_MEETING_TOPIC Tag=* \ No newline at end of file diff --git a/src/main/resources/WEB-INF/prop/prop2map/OAVisitor.properties b/src/main/resources/WEB-INF/prop/prop2map/OAVisitor.properties index 9d47d17..e4bf6d0 100644 --- a/src/main/resources/WEB-INF/prop/prop2map/OAVisitor.properties +++ b/src/main/resources/WEB-INF/prop/prop2map/OAVisitor.properties @@ -1,4 +1,4 @@ ConsumerGroup=weaver-visitor -NameServer=183.192.65.118:9876 +NameServer=114.115.168.220:9876 Topic=OA_VISITOR_TOPIC Tag=* \ No newline at end of file diff --git a/src/main/resources/WEB-INF/prop/prop2map/OrgConsumer.properties b/src/main/resources/WEB-INF/prop/prop2map/OrgConsumer.properties index 024092c..2b07de5 100644 --- a/src/main/resources/WEB-INF/prop/prop2map/OrgConsumer.properties +++ b/src/main/resources/WEB-INF/prop/prop2map/OrgConsumer.properties @@ -1,4 +1,4 @@ ConsumerGroup=weaver-org -NameServer=183.192.65.118:9876 +NameServer=114.115.168.220:9876 Topic=AUTH_CONSOLE_ORG_TOPIC Tag=* \ No newline at end of file diff --git a/src/main/resources/WEB-INF/prop/prop2map/PassWordConsumer.properties b/src/main/resources/WEB-INF/prop/prop2map/PassWordConsumer.properties index 04f8b6b..b87f068 100644 --- a/src/main/resources/WEB-INF/prop/prop2map/PassWordConsumer.properties +++ b/src/main/resources/WEB-INF/prop/prop2map/PassWordConsumer.properties @@ -1,4 +1,4 @@ ConsumerGroup=weaver-password -NameServer=183.192.65.118:9876 +NameServer=114.115.168.220:9876 Topic=AUTH_CONSOLE_USERINFO_PASSWORD_TOPIC Tag=* \ No newline at end of file diff --git a/src/main/resources/WEB-INF/prop/prop2map/PatentWall.properties b/src/main/resources/WEB-INF/prop/prop2map/PatentWall.properties new file mode 100644 index 0000000..ef0339e --- /dev/null +++ b/src/main/resources/WEB-INF/prop/prop2map/PatentWall.properties @@ -0,0 +1,149 @@ +# ${id}\u8868\u793A\u8BFB\u53D6\u6570\u636E\u5E93\u4E2D\u7684id\uFF0C\u4E0D\u5BF9\u7ED3\u679C\u8F6C\u4E49\uFF0C#{id}\u8868\u793A\u8BFB\u53D6\u6570\u636E\u5E93\u4E2D\u7684id\uFF0C\u5E76\u5C06\u7ED3\u679C\u8FDB\u884C\u8F6C\u4E49\u4F7F\u7528?\u4EE3\u66FF\u540E\u62FC\u63A5\u5230sql\u5B57\u7B26\u4E32\u4E2D +# #sql{select xx from xxx } \u8868\u793A\u67E5\u8BE2SQL\uFF0C\u5C06\u7ED3\u679C\u7684\u7B2C\u4E00\u4E2A\u5B57\u6BB5\u5F53\u505A\u503C +# \u67E5\u8BE2\u7ED3\u679C\u914D\u7F6E +aiyh.patentWall.voMapping.dataResource=uf_zlqzsb +aiyh.patentWall.voMapping.id=${id} +aiyh.patentWall.voMapping.icon=patent.png +aiyh.patentWall.voMapping.activeIcon=patent_active.png +aiyh.patentWall.voMapping.title=#sql{select imagefilename from docimagefile where docid = #{zlzs} } +# labelName labelIndex linkUrl +aiyh.patentWall.voMapping.linkList[0].labelName=\u67E5\u770B\u6587\u6863 +aiyh.patentWall.voMapping.linkList[0].labelIndex=-93792 +aiyh.patentWall.voMapping.linkList[0].linkUrl=/spa/document/index.jsp?id=${zlzs} +aiyh.patentWall.voMapping.linkList[1].labelName=\u8DF3\u8F6C\u6D41\u7A0B +aiyh.patentWall.voMapping.linkList[1].labelIndex=-93793 +aiyh.patentWall.voMapping.linkList[1].linkUrl=/spa/document/index.jsp?id=${zlzs} +#aiyh.patentWall.voMapping.linkUrl=/spa/document/index.jsp?id=${zlzs} +aiyh.patentWall.voMapping.docId=${zlzs} +aiyh.patentWall.voMapping.imageFileId=#sql{select imagefileid from docimagefile where docid = #{zlzs} } + +# \u641C\u7D22\u4FE1\u606F\u914D\u7F6E +# type \u8868\u793A\u641C\u7D22\u6846\u7C7B\u578B\uFF0C1-\u9009\u62E9\u6846\uFF0C2-\u5355\u884C\u6587\u672C\uFF0C3-\u65E5\u671F\uFF0C4-\u5355\u4EBA\u529B\u8D44\u6E90\uFF0C5-\u591A\u4EBA\u529B\u8D44\u6E90\uFF0C6-\u6D41\u7A0B\u8DEF\u5F84\uFF0C7-\u591A\u6D41\u7A0B\u8DEF\u5F84\uFF0C8-\u65E5\u671F\u8303\u56F4 +# name \u6570\u636E\u5E93\u5B57\u6BB5 \u641C\u7D22\u65F6\u9700\u8981\u8FC7\u6EE4\u90A3\u4E2A\u6570\u636E\u5E93\u5B57\u6BB5\u7684\u503C +# labelName \u524D\u7AEF\u9ED8\u8BA4\u663E\u793A\u6587\u5B57\u7684labelName +# labelIndex \u524D\u7AEF\u663E\u793A\u6587\u5B57\u7684labelIndex +# searchType \u641C\u7D22\u7C7B\u578B 1-\u7B49\u4E8E\uFF0C2-\u5927\u4E8E\uFF0C3-\u5C0F\u4E8E\uFF0C4-in\uFF0C5-\u65E5\u671F\u5927\u4E8E\uFF0C6-\u65E5\u671F\u5C0F\u4E8E\uFF0C7-\u65E5\u671F\u7B49\u4E8E,8-\u65E5\u671F\u8303\u56F4 +aiyh.patentWall.search.dataResource=uf_zlqzsb + +aiyh.patentWall.search.inputs[0].type=2 +aiyh.patentWall.search.inputs[0].dbFieldName=zlqr +aiyh.patentWall.search.inputs[0].labelName=\u4E13\u5229\u6743\u4EBA +aiyh.patentWall.search.inputs[0].labelIndex=-95588 +aiyh.patentWall.search.inputs[0].searchType=1 +aiyh.patentWall.search.inputs[0].value= + +aiyh.patentWall.search.inputs[1].type=2 +aiyh.patentWall.search.inputs[1].dbFieldName=fmrsjr +aiyh.patentWall.search.inputs[1].labelName=\u53D1\u660E\u4EBA/\u8BBE\u8BA1\u4EBA +aiyh.patentWall.search.inputs[1].labelIndex=-95589 +aiyh.patentWall.search.inputs[1].searchType=1 +aiyh.patentWall.search.inputs[1].value= + +aiyh.patentWall.search.inputs[2].type=2 +aiyh.patentWall.search.inputs[2].dbFieldName=zlcpmc +aiyh.patentWall.search.inputs[2].labelName=\u4E13\u5229\u4EA7\u54C1\u540D\u79F0 +aiyh.patentWall.search.inputs[2].labelIndex=-95590 +aiyh.patentWall.search.inputs[2].searchType=1 +aiyh.patentWall.search.inputs[2].value= + +aiyh.patentWall.search.inputs[3].type=1 +aiyh.patentWall.search.inputs[3].dbFieldName=zllx +aiyh.patentWall.search.inputs[3].labelName=\u4E13\u5229\u7C7B\u578B +aiyh.patentWall.search.inputs[3].labelIndex=-95591 +aiyh.patentWall.search.inputs[3].searchType=1 +aiyh.patentWall.search.inputs[3].multiple=true +aiyh.patentWall.search.inputs[3].value= + +aiyh.patentWall.search.inputs[4].type=3 +aiyh.patentWall.search.inputs[4].dbFieldName=zlsqrq +aiyh.patentWall.search.inputs[4].labelName=\u4E13\u5229\u7533\u8BF7\u65E5\u671F +aiyh.patentWall.search.inputs[4].labelIndex=-95592 +aiyh.patentWall.search.inputs[4].searchType=1 +aiyh.patentWall.search.inputs[4].value= + +aiyh.patentWall.search.inputs[5].type=1 +aiyh.patentWall.search.inputs[5].dbFieldName=zlzt +aiyh.patentWall.search.inputs[5].labelName=\u4E13\u5229\u72B6\u6001 +aiyh.patentWall.search.inputs[5].labelIndex=-95593 +aiyh.patentWall.search.inputs[5].searchType=1 +aiyh.patentWall.search.inputs[5].value= + +aiyh.patentWall.search.inputs[6].type=1 +aiyh.patentWall.search.inputs[6].dbFieldName=sqlx +aiyh.patentWall.search.inputs[6].labelName=\u6388\u6743\u7C7B\u578B +aiyh.patentWall.search.inputs[6].labelIndex=-95594 +aiyh.patentWall.search.inputs[6].searchType=1 +aiyh.patentWall.search.inputs[6].value= + + +# copyrightWall \u8457\u4F5C\u5899 + +aiyh.copyrightWall.voMapping.dataResource=uf_zlqzsb +aiyh.copyrightWall.voMapping.id=${id} +aiyh.copyrightWall.voMapping.icon=patent.png +aiyh.copyrightWall.voMapping.activeIcon=patent_active.png +aiyh.copyrightWall.voMapping.title=#sql{select imagefilename from docimagefile where docid = #{zlzs} } +# labelName labelIndex linkUrl +aiyh.copyrightWall.voMapping.linkList[0].labelName=\u67E5\u770B\u6587\u6863 +aiyh.copyrightWall.voMapping.linkList[0].labelIndex=-93802 +aiyh.copyrightWall.voMapping.linkList[0].linkUrl=/spa/document/index.jsp?id=${zlzs} +aiyh.copyrightWall.voMapping.linkList[1].labelName=\u8DF3\u8F6C\u6D41\u7A0B +aiyh.copyrightWall.voMapping.linkList[1].labelIndex=-93803 +aiyh.copyrightWall.voMapping.linkList[1].linkUrl=/spa/document/index.jsp?id=${zlzs} +#aiyh.copyrightWall.voMapping.linkUrl=/spa/document/index.jsp?id=${zlzs} +aiyh.copyrightWall.voMapping.docId=${zlzs} +aiyh.copyrightWall.voMapping.imageFileId=#sql{select imagefileid from docimagefile where docid = #{zlzs} } + + + +aiyh.copyrightWall.search.dataResource=uf_zlqzsb + +aiyh.copyrightWall.search.inputs[0].type=2 +aiyh.copyrightWall.search.inputs[0].dbFieldName=zlqr +aiyh.copyrightWall.search.inputs[0].labelName=\u4E13\u5229\u6743\u4EBA +aiyh.copyrightWall.search.inputs[0].labelIndex=-95595 +aiyh.copyrightWall.search.inputs[0].searchType=1 +aiyh.copyrightWall.search.inputs[0].value= + +aiyh.copyrightWall.search.inputs[1].type=2 +aiyh.copyrightWall.search.inputs[1].dbFieldName=fmrsjr +aiyh.copyrightWall.search.inputs[1].labelName=\u53D1\u660E\u4EBA/\u8BBE\u8BA1\u4EBA +aiyh.copyrightWall.search.inputs[1].labelIndex=-95598 +aiyh.copyrightWall.search.inputs[1].searchType=1 +aiyh.copyrightWall.search.inputs[1].value= + +aiyh.copyrightWall.search.inputs[2].type=2 +aiyh.copyrightWall.search.inputs[2].dbFieldName=zlcpmc +aiyh.copyrightWall.search.inputs[2].labelName=\u4E13\u5229\u4EA7\u54C1\u540D\u79F0 +aiyh.copyrightWall.search.inputs[2].labelIndex=-95597 +aiyh.copyrightWall.search.inputs[2].searchType=1 +aiyh.copyrightWall.search.inputs[2].value= + +aiyh.copyrightWall.search.inputs[3].type=1 +aiyh.copyrightWall.search.inputs[3].dbFieldName=zllx +aiyh.copyrightWall.search.inputs[3].labelName=\u4E13\u5229\u7C7B\u578B +aiyh.copyrightWall.search.inputs[3].labelIndex=-95599 +aiyh.copyrightWall.search.inputs[3].searchType=1 +aiyh.copyrightWall.search.inputs[3].multiple=true +aiyh.copyrightWall.search.inputs[3].value= + +aiyh.copyrightWall.search.inputs[4].type=3 +aiyh.copyrightWall.search.inputs[4].dbFieldName=zlsqrq +aiyh.copyrightWall.search.inputs[4].labelName=\u4E13\u5229\u7533\u8BF7\u65E5\u671F +aiyh.copyrightWall.search.inputs[4].labelIndex=-95600 +aiyh.copyrightWall.search.inputs[4].searchType=1 +aiyh.copyrightWall.search.inputs[4].value= + +aiyh.copyrightWall.search.inputs[5].type=1 +aiyh.copyrightWall.search.inputs[5].dbFieldName=zlzt +aiyh.copyrightWall.search.inputs[5].labelName=\u4E13\u5229\u72B6\u6001 +aiyh.copyrightWall.search.inputs[5].labelIndex=-95601 +aiyh.copyrightWall.search.inputs[5].searchType=1 +aiyh.copyrightWall.search.inputs[5].value= + +aiyh.copyrightWall.search.inputs[6].type=1 +aiyh.copyrightWall.search.inputs[6].dbFieldName=sqlx +aiyh.copyrightWall.search.inputs[6].labelName=\u6388\u6743\u7C7B\u578B +aiyh.copyrightWall.search.inputs[6].labelIndex=-95594 +aiyh.copyrightWall.search.inputs[6].searchType=1 +aiyh.copyrightWall.search.inputs[6].value= diff --git a/src/main/resources/WEB-INF/prop/prop2map/UserInfoConsumer.properties b/src/main/resources/WEB-INF/prop/prop2map/UserInfoConsumer.properties index b285ae1..33e22d9 100644 --- a/src/main/resources/WEB-INF/prop/prop2map/UserInfoConsumer.properties +++ b/src/main/resources/WEB-INF/prop/prop2map/UserInfoConsumer.properties @@ -1,4 +1,4 @@ ConsumerGroup=weaver-userinfo -NameServer=183.192.65.118:9876 +NameServer=114.115.168.220:9876 Topic=AUTH_CONSOLE_USERINFO_TOPIC Tag=* \ No newline at end of file diff --git a/src/main/resources/WEB-INF/prop/prop2map/classificationWall.properties b/src/main/resources/WEB-INF/prop/prop2map/classificationWall.properties new file mode 100644 index 0000000..cba2e66 --- /dev/null +++ b/src/main/resources/WEB-INF/prop/prop2map/classificationWall.properties @@ -0,0 +1,25 @@ +# ${id}\u8868\u793A\u8BFB\u53D6\u6570\u636E\u5E93\u4E2D\u7684id\uFF0C\u4E0D\u5BF9\u7ED3\u679C\u8F6C\u4E49\uFF0C#{id}\u8868\u793A\u8BFB\u53D6\u6570\u636E\u5E93\u4E2D\u7684id\uFF0C\u5E76\u5C06\u7ED3\u679C\u8FDB\u884C\u8F6C\u4E49\u4F7F\u7528?\u4EE3\u66FF\u540E\u62FC\u63A5\u5230sql\u5B57\u7B26\u4E32\u4E2D +# #sql{select xx from xxx } \u8868\u793A\u67E5\u8BE2SQL\uFF0C\u5C06\u7ED3\u679C\u7684\u7B2C\u4E00\u4E2A\u5B57\u6BB5\u5F53\u505A\u503C +# \u67E5\u8BE2\u7ED3\u679C\u914D\u7F6E +aiyh.classificationWall.voMapping.dataResource=uf_zfzy +# \u6DFB\u52A0\u8D44\u6E90\u6309\u94AE\u94FE\u63A5 +aiyh.classificationWall.voMapping.addSourceUrl=http://www.baidu.com +aiyh.classificationWall.voMapping.addSourceLabelIndex=-1000 +aiyh.classificationWall.voMapping.addSourceLabelName=\u6DFB\u52A0\u8D44\u6E90 +# \u6570\u636EID +aiyh.classificationWall.voMapping.id=${id} +# \u56FA\u5B9A\u503C\u56FE\u7247\u540D\u79F0ecode\u56FE\u7247\u540D\u79F0 +aiyh.classificationWall.voMapping.icon=patent.png +aiyh.classificationWall.voMapping.activeIcon=patent_active.png +# \u4E0B\u811A\u663E\u793A\u7684\u6807\u9898 +aiyh.classificationWall.voMapping.title=${mc} +aiyh.classificationWall.voMapping.titleEn=${mc} +# labelName labelIndex linkUrl +aiyh.classificationWall.voMapping.linkList[0].labelName=\u67E5\u770B\u6587\u6863 +aiyh.classificationWall.voMapping.linkList[0].labelIndex=-93792 +aiyh.classificationWall.voMapping.linkList[0].linkUrl=/spa/document/index.jsp?id=${zyxq} +aiyh.classificationWall.voMapping.linkList[1].labelName=\u8DF3\u8F6C\u6D41\u7A0B +aiyh.classificationWall.voMapping.linkList[1].labelIndex=-93793 +aiyh.classificationWall.voMapping.linkList[1].linkUrl=/spa/document/index.jsp?id=${id} +aiyh.classificationWall.voMapping.docId=0 +aiyh.classificationWall.voMapping.imageFileId=0 diff --git a/src/main/resources/WEB-INF/prop/prop2map/cronJobConfig.properties b/src/main/resources/WEB-INF/prop/prop2map/cronJobConfig.properties new file mode 100644 index 0000000..a5d5d91 --- /dev/null +++ b/src/main/resources/WEB-INF/prop/prop2map/cronJobConfig.properties @@ -0,0 +1,16 @@ +# \u5047\u671F\u7C7B\u578B\u6620\u5C04\u5173\u7CFB +# its\u5E74\u5047\u6620\u5C04OA\u5176\u4ED6 +holidaySync.its_type.1=9 +# its\u8C03\u4F11\u6620\u5C04OA\u8C03\u4F11\u5047 +holidaySync.its_type.2=10 + + +# \u5047\u671F\u4F7F\u7528\u989D +holidaySync.its_oa_holiday_viw.used_amount=usedamount +holidaySync.its_oa_holiday_viw.total_amount=baseAmount + + + + + + diff --git a/src/main/resources/WEB-INF/prop/prop2map/ftClientSecret.properties b/src/main/resources/WEB-INF/prop/prop2map/ftClientSecret.properties new file mode 100644 index 0000000..7779212 --- /dev/null +++ b/src/main/resources/WEB-INF/prop/prop2map/ftClientSecret.properties @@ -0,0 +1,7 @@ +# \u6388\u6743\u7801 +aiyh.client.clientId=100001 +aiyh.client.clientSecret=1099af237ed347b19a992a5e46520241 + +# \u6620\u5C04\u89C4\u5219 +aiyh.sqlMapper.ee_no=#{loginid} +aiyh.sqlMapper.org_code=ford diff --git a/src/main/resources/WEB-INF/prop/prop2map/governmentSourceWall.properties b/src/main/resources/WEB-INF/prop/prop2map/governmentSourceWall.properties new file mode 100644 index 0000000..cba2e66 --- /dev/null +++ b/src/main/resources/WEB-INF/prop/prop2map/governmentSourceWall.properties @@ -0,0 +1,25 @@ +# ${id}\u8868\u793A\u8BFB\u53D6\u6570\u636E\u5E93\u4E2D\u7684id\uFF0C\u4E0D\u5BF9\u7ED3\u679C\u8F6C\u4E49\uFF0C#{id}\u8868\u793A\u8BFB\u53D6\u6570\u636E\u5E93\u4E2D\u7684id\uFF0C\u5E76\u5C06\u7ED3\u679C\u8FDB\u884C\u8F6C\u4E49\u4F7F\u7528?\u4EE3\u66FF\u540E\u62FC\u63A5\u5230sql\u5B57\u7B26\u4E32\u4E2D +# #sql{select xx from xxx } \u8868\u793A\u67E5\u8BE2SQL\uFF0C\u5C06\u7ED3\u679C\u7684\u7B2C\u4E00\u4E2A\u5B57\u6BB5\u5F53\u505A\u503C +# \u67E5\u8BE2\u7ED3\u679C\u914D\u7F6E +aiyh.classificationWall.voMapping.dataResource=uf_zfzy +# \u6DFB\u52A0\u8D44\u6E90\u6309\u94AE\u94FE\u63A5 +aiyh.classificationWall.voMapping.addSourceUrl=http://www.baidu.com +aiyh.classificationWall.voMapping.addSourceLabelIndex=-1000 +aiyh.classificationWall.voMapping.addSourceLabelName=\u6DFB\u52A0\u8D44\u6E90 +# \u6570\u636EID +aiyh.classificationWall.voMapping.id=${id} +# \u56FA\u5B9A\u503C\u56FE\u7247\u540D\u79F0ecode\u56FE\u7247\u540D\u79F0 +aiyh.classificationWall.voMapping.icon=patent.png +aiyh.classificationWall.voMapping.activeIcon=patent_active.png +# \u4E0B\u811A\u663E\u793A\u7684\u6807\u9898 +aiyh.classificationWall.voMapping.title=${mc} +aiyh.classificationWall.voMapping.titleEn=${mc} +# labelName labelIndex linkUrl +aiyh.classificationWall.voMapping.linkList[0].labelName=\u67E5\u770B\u6587\u6863 +aiyh.classificationWall.voMapping.linkList[0].labelIndex=-93792 +aiyh.classificationWall.voMapping.linkList[0].linkUrl=/spa/document/index.jsp?id=${zyxq} +aiyh.classificationWall.voMapping.linkList[1].labelName=\u8DF3\u8F6C\u6D41\u7A0B +aiyh.classificationWall.voMapping.linkList[1].labelIndex=-93793 +aiyh.classificationWall.voMapping.linkList[1].linkUrl=/spa/document/index.jsp?id=${id} +aiyh.classificationWall.voMapping.docId=0 +aiyh.classificationWall.voMapping.imageFileId=0 diff --git a/src/main/resources/WEB-INF/prop/prop2map/htmlLabelIndex.properties b/src/main/resources/WEB-INF/prop/prop2map/htmlLabelIndex.properties new file mode 100644 index 0000000..7bff55e --- /dev/null +++ b/src/main/resources/WEB-INF/prop/prop2map/htmlLabelIndex.properties @@ -0,0 +1,6 @@ +aiyh.htmlLabel.porsche.FaDDContractController.pushErr.labelIndex=-1 +aiyh.htmlLabel.porsche.FaDDContractController.pushErr.defaultStr=\u90AE\u4EF6\u53D1\u9001\u5931\u8D25\uFF0C\u8BF7\u8054\u7CFB\u7BA1\u7406\u5458\uFF01 +aiyh.htmlLabel.porsche.FaDDContractController.pushSuccess.labelIndex=-1 +aiyh.htmlLabel.porsche.FaDDContractController.pushSuccess.defaultStr=\u7B7E\u7F72\u90AE\u4EF6\u53D1\u9001\u6210\u529F\uFF01 +attachment_sort.AnnexSortAction.sortErr.labelIndex=-1 +attachment_sort.AnnexSortAction.sortErr.defaultStr=\u6587\u4EF6\u6392\u5E8F\u5931\u8D25\uFF0C\u8BF7\u8054\u7CFB\u7CFB\u7EDF\u7BA1\u7406\u5458\uFF01 \ No newline at end of file diff --git a/src/main/resources/WEB-INF/prop/prop2map/jt_fadadaAuthenticConfiguration.properties b/src/main/resources/WEB-INF/prop/prop2map/jt_fadadaAuthenticConfiguration.properties new file mode 100644 index 0000000..fadbd00 --- /dev/null +++ b/src/main/resources/WEB-INF/prop/prop2map/jt_fadadaAuthenticConfiguration.properties @@ -0,0 +1,29 @@ +# \u8BF7\u6C42\u53C2\u6570\u4FE1\u606F +# request params config +# #{resource_id} replace database hrmresource table's id +# #{field} or ${field} replace database hrmresource and cus_fielddata field value +# #sql{select name from xxx where id = #{resource_id}} while replace execute customer sql to value +# String: Express this value is String; Integer: Express this value is Integer; Boolean: Express this value is Boolean; Double: Express this value is Double +# #{resource_id} \u8868\u793A\u4EBA\u529B\u8D44\u6E90\u8868\u4E2D\u7684id +# #{field} \u8868\u793A\u4EBA\u529B\u8D44\u6E90\u8868\u4E2D\u6216cus_fielddata\u5373\u81EA\u5B9A\u4E49\u4EBA\u5458\u5361\u7247\u5B57\u6BB5\u7684\u503C +# #sql{select name from xx where id = #{xx}} \u8868\u662F\u81EA\u5B9A\u4E49SQL +# String: Integer: Boolean: Double: \u5206\u522B\u8868\u793A\u8FD9\u4E2A\u503C\u7C7B\u578B\u4E3Astring\u3001integer\u3001boolean\u3001double\u7C7B\u578B\u7684\u8BF7\u6C42\u53C2\u6570 +fadada.realNameAuthentication.customerId=String:#{lasyname} +fadada.realNameAuthentication.verifiedWay=Integer:#sql{select id from hrmdeptment where id = #{deptId}} +fadada.realNameAuthentication.pageModify=Boolean: +fadada.realNameAuthentication.isRepeatVerified=Double: +fadada.realNameAuthentication.customerName= +fadada.realNameAuthentication.customerIdentityType= +fadada.realNameAuthentication.customerIdentityNo= +fadada.realNameAuthentication.mobile= +fadada.realNameAuthentication.identityFrontPath= +fadada.realNameAuthentication.notifyUrl= +fadada.realNameAuthentication.returnUrl= +fadada.realNameAuthentication.isSendSms= +fadada.realNameAuthentication.identityBackPath= +fadada.realNameAuthentication.resultType= +fadada.realNameAuthentication.certType= +fadada.realNameAuthentication.applyCert= +fadada.realNameAuthentication.certMode= +fadada.realNameAuthentication.miniProgram= +fadada.realNameAuthentication.mobileDevice= diff --git a/src/main/resources/WEB-INF/prop/prop2map/jt_fadadaRequestConfigInfo.properties b/src/main/resources/WEB-INF/prop/prop2map/jt_fadadaRequestConfigInfo.properties new file mode 100644 index 0000000..1e40251 --- /dev/null +++ b/src/main/resources/WEB-INF/prop/prop2map/jt_fadadaRequestConfigInfo.properties @@ -0,0 +1,3 @@ +fadada.baseUrl=http://123.60.67.228:8070/ +fadada.appKey=BLEshmz8xZPyKRAG4aUiSopt +fadada.appId=100000 \ No newline at end of file diff --git a/src/main/resources/WEB-INF/prop/prop2map/jt_tokenConfigInfo.properties b/src/main/resources/WEB-INF/prop/prop2map/jt_tokenConfigInfo.properties new file mode 100644 index 0000000..d852f27 --- /dev/null +++ b/src/main/resources/WEB-INF/prop/prop2map/jt_tokenConfigInfo.properties @@ -0,0 +1,47 @@ +# \u914D\u7F6E\u89C4\u5219 \u73AF\u5883.\u4E1A\u52A1\u540D\u79F0.\u83B7\u53D6token\u8D26\u53F7\u4FE1\u606F +# configuration environment.Business name.token info +# oa\u53D1\u677F\u6D41\u7A0B\u63A8\u9001 +# product environment +pro.release.userName=oa005 +pro.release.password=123456 +pro.release.systemCode=oa +pro.release.secretKey=5362448sd132d241e5ae27e318qws11d +pro.release.baseUrl=https://jtdcapi.jtexpress.com.cn +pro.release.expiration=24 +# uat test environment +uat.release.userName=oa003 +uat.release.password=JT0725! +uat.release.systemCode=oa +uat.release.secretKey=5362448sd132d241e5ae27e318qws11d +uat.release.baseUrl=https://uat-jtdcapi.jtexpress.com.cn +uat.release.expiration=24 +# jms\u5E72\u7EBF\u63A8\u9001 +# product environment +pro.jms.userName=oa005 +pro.jms.password=123456 +pro.jms.systemCode=oa +pro.jms.secretKey=5362448sd132d241e5ae27e318qws11d +pro.jms.baseUrl=https://jtdcapi.jtexpress.com.cn +pro.jms.expiration=24 +# uat test environment +uat.jms.userName=oa003 +uat.jms.password=JT0725! +uat.jms.systemCode=oa +uat.jms.secretKey=5362448sd132d241e5ae27e318qws11d +uat.jms.baseUrl=https://uat-jtdcapi.jtexpress.com.cn +uat.jms.expiration=24 +# \u9ED8\u8BA4 +# product environment +pro.default.userName=oa005 +pro.default.password=123456 +pro.default.systemCode=oa +pro.default.secretKey=5362448sd132d241e5ae27e318qws11d +pro.default.baseUrl=https://jtdcapi.jtexpress.com.cn +pro.default.expiration=24 +# uat test environment +uat.default.userName=oa003 +uat.default.password=JT0725! +uat.default.systemCode=oa +uat.default.secretKey=5362448sd132d241e5ae27e318qws11d +uat.default.baseUrl=https://uat-jtdcapi.jtexpress.com.cn +uat.default.expiration=24 diff --git a/src/main/resources/WEB-INF/prop/prop2map/test.properties b/src/main/resources/WEB-INF/prop/prop2map/test.properties new file mode 100644 index 0000000..1a82ab3 --- /dev/null +++ b/src/main/resources/WEB-INF/prop/prop2map/test.properties @@ -0,0 +1,3 @@ +1=1212 +2=212 +#2=21 \ No newline at end of file diff --git a/src/main/resources/WEB-INF/prop/prop2map/wxAccessTokenConfig.properties b/src/main/resources/WEB-INF/prop/prop2map/wxAccessTokenConfig.properties new file mode 100644 index 0000000..e740a9d --- /dev/null +++ b/src/main/resources/WEB-INF/prop/prop2map/wxAccessTokenConfig.properties @@ -0,0 +1,18 @@ +# \u4F01\u4E1A\u5FAE\u4FE1\u83B7\u53D6accessToken\u914D\u7F6E\u4FE1\u606F +# \u4F01\u4E1Acorpid +# corpid +wx.corpid=wwe5f751c365f187e7 +# \u901A\u8BAF\u5F55\u7EF4\u62A4\u63A5\u53E3\u51ED\u8BC1 +# wx corpsecret +wx.corpsecret=L_3ml7weLt9qnonRAPsHN8qw2fG0xJQxsUfWSKv0tsA +# \u83B7\u53D6access_token\u5730\u5740 +wx.baseHost=https://qyapi.weixin.qq.com +# ============================= # +# EM7 corpid +# corpid +em.corpid=em049e8906ac5811e9833ffa163ed86778 +# \u901A\u8BAF\u5F55\u7EF4\u62A4\u63A5\u53E3\u51ED\u8BC1 +# wx corpsecret +em.corpsecret=8e5f4d98-8dd0-4657-9025-fb8ace22494b +# \u83B7\u53D6access_token\u5730\u5740 +em.baseHost=http://121.36.197.152:8999 \ No newline at end of file diff --git a/src/main/resources/WEB-INF/prop/weaver_client_pwd.properties b/src/main/resources/WEB-INF/prop/weaver_client_pwd.properties new file mode 100644 index 0000000..9d842e2 --- /dev/null +++ b/src/main/resources/WEB-INF/prop/weaver_client_pwd.properties @@ -0,0 +1 @@ +key=217f4f62-5acb-4a \ No newline at end of file diff --git a/src/test/java/xuanran/wang/bme/PushDataActionTest.java b/src/test/java/xuanran/wang/bme/PushDataActionTest.java new file mode 100644 index 0000000..45dd960 --- /dev/null +++ b/src/test/java/xuanran/wang/bme/PushDataActionTest.java @@ -0,0 +1,45 @@ +package xuanran.wang.bme; + +import aiyh.utils.Util; +import basetest.BaseTest; +import org.apache.commons.lang3.StringUtils; +import org.junit.Test; +import weaver.conn.RecordSet; +import weaver.xiao.commons.config.entity.RequestMappingConfig; +import weaver.xiao.commons.config.service.DealWithMapping; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + *

柏美测试类

+ * + * @author xuanran.wang + * @date 2023/2/21 14:04 + */ +public class PushDataActionTest extends BaseTest { + + private final DealWithMapping dealWithMapping = new DealWithMapping(); + + @Test + public void testA(){ + String onlyMark = "listTest"; + String tableName = "formtable_main_22"; + String requestId = "55065"; + RequestMappingConfig requestMappingConfig = dealWithMapping.treeDealWithUniqueCode(onlyMark); + dealWithMapping.setMainTable(tableName); + String cusWhere = Util.null2DefaultStr(requestMappingConfig.getCusWhereSql(), ""); + if (StringUtils.isNotBlank(cusWhere)) { + cusWhere = DealWithMapping.sbc2dbcCase(cusWhere); // 全角转半角 + } + String url = requestMappingConfig.getRequestUrl(); + String selectMainSql = "select * from " + tableName + " where requestid = ? " + cusWhere; + log.info(Util.logStr("查询主表数据sql : {}, requestId : {}", selectMainSql, requestId)); + RecordSet recordSet = new RecordSet(); + recordSet.executeQuery(selectMainSql, requestId); + recordSet.next(); + List requestListParam = dealWithMapping.getRequestListParam(recordSet, requestMappingConfig); + log.info("list : " + requestListParam); + } +} diff --git a/src/test/java/xuanran/wang/http_test/annotations/CusPathQuery.java b/src/test/java/xuanran/wang/http_test/annotations/CusPathQuery.java new file mode 100644 index 0000000..3d43003 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/annotations/CusPathQuery.java @@ -0,0 +1,16 @@ +package xuanran.wang.http_test.annotations; + +import java.lang.annotation.*; + +/** + *

请求路径参数替换

+ * + * @author xuanran.wang + * @date 2023/3/10 17:00 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.PARAMETER}) +@Documented +public @interface CusPathQuery { + String value(); +} diff --git a/src/test/java/xuanran/wang/http_test/annotations/CusRequest.java b/src/test/java/xuanran/wang/http_test/annotations/CusRequest.java new file mode 100644 index 0000000..ef05213 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/annotations/CusRequest.java @@ -0,0 +1,15 @@ +package xuanran.wang.http_test.annotations; + +import java.lang.annotation.*; + +/** + *

+ * + * @author xuanran.wang + * @date 2023/3/10 10:46 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.TYPE}) +@Documented +public @interface CusRequest { +} diff --git a/src/test/java/xuanran/wang/http_test/annotations/CusRequestAddress.java b/src/test/java/xuanran/wang/http_test/annotations/CusRequestAddress.java new file mode 100644 index 0000000..460b59c --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/annotations/CusRequestAddress.java @@ -0,0 +1,19 @@ +package xuanran.wang.http_test.annotations; + +import java.lang.annotation.*; + +/** + *

请求地址

+ * + * @author xuanran.wang + * @date 2023/3/10 10:18 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.TYPE}) +@Documented +public @interface CusRequestAddress { + // ip地址 + String host() default ""; + // 端口号 + int port() default 0; +} diff --git a/src/test/java/xuanran/wang/http_test/annotations/GetPathValue.java b/src/test/java/xuanran/wang/http_test/annotations/GetPathValue.java new file mode 100644 index 0000000..65dd302 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/annotations/GetPathValue.java @@ -0,0 +1,15 @@ +package xuanran.wang.http_test.annotations; + +import java.lang.annotation.*; + +/** + *

路径参数 可以修饰map,字段 如果是字段那就会将

+ * + * @author xuanran.wang + * @date 2023/3/10 13:06 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.PARAMETER) +@Documented +public @interface GetPathValue { +} diff --git a/src/test/java/xuanran/wang/http_test/annotations/PostBody.java b/src/test/java/xuanran/wang/http_test/annotations/PostBody.java new file mode 100644 index 0000000..2f704c8 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/annotations/PostBody.java @@ -0,0 +1,15 @@ +package xuanran.wang.http_test.annotations; + +import java.lang.annotation.*; + +/** + *

post请求体

+ * + * @author xuanran.wang + * @date 2023/3/10 13:48 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.PARAMETER) +@Documented +public @interface PostBody { +} diff --git a/src/test/java/xuanran/wang/http_test/annotations/async/AsyncFun.java b/src/test/java/xuanran/wang/http_test/annotations/async/AsyncFun.java new file mode 100644 index 0000000..c23be52 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/annotations/async/AsyncFun.java @@ -0,0 +1,15 @@ +package xuanran.wang.http_test.annotations.async; + +import java.lang.annotation.*; + +/** + *

异步

+ * + * @author xuanran.wang + * @date 2023/3/10 14:17 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.PARAMETER) +@Documented +public @interface AsyncFun { +} diff --git a/src/test/java/xuanran/wang/http_test/annotations/async/CusAsync.java b/src/test/java/xuanran/wang/http_test/annotations/async/CusAsync.java new file mode 100644 index 0000000..73ceae1 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/annotations/async/CusAsync.java @@ -0,0 +1,17 @@ +package xuanran.wang.http_test.annotations.async; + +import java.lang.annotation.*; + +/** + *

是否开启异步

+ * + * @author xuanran.wang + * @date 2023/3/10 10:13 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +@Documented +public @interface CusAsync { + //

是否开启异步 默认为false

+ boolean enable() default false; +} diff --git a/src/test/java/xuanran/wang/http_test/annotations/header/CusRequestHeader.java b/src/test/java/xuanran/wang/http_test/annotations/header/CusRequestHeader.java new file mode 100644 index 0000000..4f41825 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/annotations/header/CusRequestHeader.java @@ -0,0 +1,21 @@ +package xuanran.wang.http_test.annotations.header; + +import java.lang.annotation.*; + +/** + *

自定义请求头

+ * + * @author xuanran.wang + * @date 2023/3/10 14:20 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD,ElementType.TYPE}) +@Documented +public @interface CusRequestHeader { + // 自定义请求头java文件全路径 + String cusHeadersClassPath() default ""; + // 自定义请求头 + String[] cusHeaders() default {}; + // 自定义请求头标识 + String value() default ""; +} diff --git a/src/test/java/xuanran/wang/http_test/annotations/request_path/CusPathQuery.java b/src/test/java/xuanran/wang/http_test/annotations/request_path/CusPathQuery.java new file mode 100644 index 0000000..c6c3706 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/annotations/request_path/CusPathQuery.java @@ -0,0 +1,24 @@ +package xuanran.wang.http_test.annotations.request_path; + +import java.lang.annotation.*; + +/** + *

+ * 路径参数注解 + * 可以作用于参数中如果想要替换路径中的/api/test/{job} {job} 需要在参数指明替换占位符的key + * 如果不指明会判断参数类型 如果是map则直接拼接在路径中 + * 如果是/api/test/${job} 以$开头的则将参数 通过&进行分割解析成map + *

+ * + * @author xuanran.wang + * @date 2023/3/14 22:50 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD}) +@Documented +public @interface CusPathQuery { + /** + *

路径中需要替换的key

+ **/ + String value() default ""; +} diff --git a/src/test/java/xuanran/wang/http_test/annotations/request_type/CusRequestDelete.java b/src/test/java/xuanran/wang/http_test/annotations/request_type/CusRequestDelete.java new file mode 100644 index 0000000..a20a87a --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/annotations/request_type/CusRequestDelete.java @@ -0,0 +1,16 @@ +package xuanran.wang.http_test.annotations.request_type; + +import java.lang.annotation.*; + +/** + *

delete 请求

+ * + * @author xuanran.wang + * @date 2023/3/10 10:17 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +@Documented +public @interface CusRequestDelete { + String url() default ""; +} diff --git a/src/test/java/xuanran/wang/http_test/annotations/request_type/CusRequestGet.java b/src/test/java/xuanran/wang/http_test/annotations/request_type/CusRequestGet.java new file mode 100644 index 0000000..14a7ec2 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/annotations/request_type/CusRequestGet.java @@ -0,0 +1,16 @@ +package xuanran.wang.http_test.annotations.request_type; + +import java.lang.annotation.*; + +/** + *

get 请求

+ * + * @author xuanran.wang + * @date 2023/3/10 10:15 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD}) +@Documented +public @interface CusRequestGet{ + String url() default ""; +} diff --git a/src/test/java/xuanran/wang/http_test/annotations/request_type/CusRequestPost.java b/src/test/java/xuanran/wang/http_test/annotations/request_type/CusRequestPost.java new file mode 100644 index 0000000..4871a05 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/annotations/request_type/CusRequestPost.java @@ -0,0 +1,16 @@ +package xuanran.wang.http_test.annotations.request_type; + +import java.lang.annotation.*; + +/** + *

post 请求

+ * + * @author xuanran.wang + * @date 2023/3/10 10:17 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD}) +@Documented +public @interface CusRequestPost { + String url() default ""; +} diff --git a/src/test/java/xuanran/wang/http_test/annotations/request_type/CusRequestPut.java b/src/test/java/xuanran/wang/http_test/annotations/request_type/CusRequestPut.java new file mode 100644 index 0000000..0fd5c5d --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/annotations/request_type/CusRequestPut.java @@ -0,0 +1,16 @@ +package xuanran.wang.http_test.annotations.request_type; + +import java.lang.annotation.*; + +/** + *

put 请求

+ * + * @author xuanran.wang + * @date 2023/3/10 10:18 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD}) +@Documented +public @interface CusRequestPut { + String url() default ""; +} diff --git a/src/test/java/xuanran/wang/http_test/constant/RequestUtilConstant.java b/src/test/java/xuanran/wang/http_test/constant/RequestUtilConstant.java new file mode 100644 index 0000000..d8f6c83 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/constant/RequestUtilConstant.java @@ -0,0 +1,15 @@ +package xuanran.wang.http_test.constant; + +/** + *

请求工具常量

+ * + * @author xuanran.wang + * @date 2023/3/10 14:01 + */ +public class RequestUtilConstant { + public static final int GET = 0; + public static final int POST = 1; + public static final int DELETE = 2; + public static final int PUT = 3; + public static final int HEADER = -1; +} diff --git a/src/test/java/xuanran/wang/http_test/entity/CusRequestEntity.java b/src/test/java/xuanran/wang/http_test/entity/CusRequestEntity.java new file mode 100644 index 0000000..143ac83 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/entity/CusRequestEntity.java @@ -0,0 +1,29 @@ +package xuanran.wang.http_test.entity; + +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + +import java.util.Map; +import java.util.function.Consumer; + +/** + *

真实请求对象

+ * + * @author xuanran.wang + * @date 2023/3/14 23:28 + */ +@AllArgsConstructor +@NoArgsConstructor +@Setter +@Getter +public class CusRequestEntity{ + private String url; + private Map headers; + private Map pathParams; + private Object bodyParams; + private int requestType; + private Consumer consumer; + private boolean async; +} diff --git a/src/test/java/xuanran/wang/http_test/handle/PostTypeHandle.java b/src/test/java/xuanran/wang/http_test/handle/PostTypeHandle.java new file mode 100644 index 0000000..7b75eeb --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/handle/PostTypeHandle.java @@ -0,0 +1,35 @@ +//package xuanran.wang.http_test.handle; +// +//import com.alibaba.fastjson.JSONObject; +//import xuanran.wang.http_test.annotations.PostBody; +// +//import java.lang.reflect.Method; +//import java.lang.reflect.Parameter; +//import java.util.HashMap; +//import java.util.Map; +// +///** +// *

post方法解析

+// * +// * @author xuanran.wang +// * @date 2023/3/10 13:54 +// */ +//public class PostTypeHandle implements RequestBeforeHandle { +// @Override +// public Map handle(String url, Method method, Object[] args) { +// Parameter[] parameters = method.getParameters(); +// for (int i = 0; i < parameters.length; i++) { +// PostBody postBody = parameters[i].getDeclaredAnnotation(PostBody.class); +// if(postBody != null){ +// Object arg = args[i]; +// if(arg instanceof Map){ +// return (Map) arg; +// }else if(arg instanceof String){ +// String json = JSONObject.toJSONString(arg); +// return JSONObject.parseObject(json, Map.class); +// } +// } +// } +// return new HashMap(); +// } +//} diff --git a/src/test/java/xuanran/wang/http_test/handle/RequestBeforeHandle.java b/src/test/java/xuanran/wang/http_test/handle/RequestBeforeHandle.java new file mode 100644 index 0000000..48faa20 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/handle/RequestBeforeHandle.java @@ -0,0 +1,15 @@ +package xuanran.wang.http_test.handle; + +import xuanran.wang.http_test.entity.CusRequestEntity; + +import java.lang.reflect.Method; + +/** + *

请求前处理

+ * + * @author xuanran.wang + * @date 2023/3/10 11:38 + */ +public interface RequestBeforeHandle { + void handle(CusRequestEntity requestEntity, Method method, Object[] args); +} diff --git a/src/test/java/xuanran/wang/http_test/handle/RequestHeaderHandle.java b/src/test/java/xuanran/wang/http_test/handle/RequestHeaderHandle.java new file mode 100644 index 0000000..6d2d99b --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/handle/RequestHeaderHandle.java @@ -0,0 +1,81 @@ +//package xuanran.wang.http_test.handle; +// +//import aiyh.utils.Util; +//import aiyh.utils.excention.CustomerException; +//import org.apache.commons.collections.CollectionUtils; +//import org.apache.commons.collections.MapUtils; +//import org.apache.commons.lang3.StringUtils; +//import xuanran.wang.http_test.annotations.header.CusRequestHeader; +//import xuanran.wang.http_test.interfaces.CusCreateRequestHeader; +// +//import java.lang.reflect.Method; +//import java.lang.reflect.Parameter; +//import java.util.HashMap; +//import java.util.Map; +// +///** +// *

请求头处理

+// * +// * @author xuanran.wang +// * @date 2023/3/10 14:42 +// */ +//public class RequestHeaderHandle implements RequestBeforeHandle { +// @Override +// public Object handle(String url, Method method, Object[] args) { +// CusRequestHeader methodCusRequestHeader = method.getDeclaredAnnotation(CusRequestHeader.class); +// if(methodCusRequestHeader == null){ +// return new HashMap<>(); +// } +// // 数组形式 +// String[] headersArr = methodCusRequestHeader.cusHeaders(); +// HashMap headers = new HashMap<>(); +// if(headersArr != null){ +// for (String headerStr : headersArr) { +// String[] split = headerStr.split(":"); +// String key = Util.null2DefaultStr(split[0],"").trim(); +// String val = Util.null2DefaultStr(split[1],"").trim(); +// if(StringUtils.isNotBlank(key) && StringUtils.isNotBlank(val)){ +// headers.put(key, val); +// } +// } +// } +// +// // java代码自定义 +// String path = Util.null2DefaultStr(methodCusRequestHeader.cusHeadersClassPath(),""); +// if(StringUtils.isNotBlank(path)){ +// Class clazz; +// try { +// clazz = Class.forName(path); +// } catch (ClassNotFoundException e) { +// throw new CustomerException(Util.logStr("自定义请求头java类文件没找到!: {}", path)); +// } +// if(!clazz.isAssignableFrom(CusCreateRequestHeader.class)){ +// throw new CustomerException(Util.logStr("当前类路径:[{}] ,未实现CusCreateRequestHeader接口!", path)); +// } +// CusCreateRequestHeader o; +// try { +// o = (CusCreateRequestHeader) clazz.newInstance(); +// }catch (InstantiationException | IllegalAccessException e) { +// throw new CustomerException(Util.logStr("实例化 [{}] 对象失败! error:{}", path, e.getMessage())); +// } +// Map cusCreateHeader = o.createHeader(); +// if(MapUtils.isNotEmpty(cusCreateHeader)){ +// headers.putAll(cusCreateHeader); +// } +// } +// // 参数中 +// Parameter[] parameters = method.getParameters(); +// for (int i = 0; i < parameters.length; i++) { +// Parameter parameter = parameters[i]; +// CusRequestHeader requestHeader = parameter.getAnnotation(CusRequestHeader.class); +// if(requestHeader != null){ +// String val = Util.null2DefaultStr(args[i], "").trim(); +// String key = requestHeader.value().trim(); +// if(StringUtils.isNotBlank(key) && StringUtils.isNotBlank(val)){ +// headers.put(key, val); +// } +// } +// } +// return headers; +// } +//} diff --git a/src/test/java/xuanran/wang/http_test/handle/path_handle/CusFieldKeyParseHandle.java b/src/test/java/xuanran/wang/http_test/handle/path_handle/CusFieldKeyParseHandle.java new file mode 100644 index 0000000..19ab94e --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/handle/path_handle/CusFieldKeyParseHandle.java @@ -0,0 +1,43 @@ +package xuanran.wang.http_test.handle.path_handle; + +import aiyh.utils.Util; +import org.apache.commons.lang3.StringUtils; +import xuanran.wang.http_test.annotations.CusPathQuery; +import xuanran.wang.http_test.entity.CusRequestEntity; +import xuanran.wang.http_test.handle.RequestBeforeHandle; + +import java.lang.reflect.Method; +import java.lang.reflect.Parameter; +import java.util.Map; + +/** + *

解析方法路径中是否包含占位符 并将参数匹配的key进行替换

+ * + * @author xuanran.wang + * @date 2023/3/14 23:11 + */ +public class CusFieldKeyParseHandle implements RequestBeforeHandle { + @Override + public void handle(CusRequestEntity requestEntity, Method method, Object[] args) { + Parameter[] parameters = method.getParameters(); + String url = requestEntity.getUrl(); + for (int i = 0; i < parameters.length; i++) { + Parameter parameter = parameters[i]; + CusPathQuery cusPathQuery = parameter.getDeclaredAnnotation(CusPathQuery.class); + if(cusPathQuery != null){ + String pathQuery = cusPathQuery.value(); + Object arg = args[i]; + if (StringUtils.isNotBlank(pathQuery)) { + String key = "\\{" + pathQuery + "}"; + url = url.replaceAll(key, Util.null2DefaultStr(arg,"")); + }else { + Class clazz = parameter.getType(); + if(clazz.isAssignableFrom(Map.class)){ + requestEntity.setPathParams((Map) arg); + } + } + } + } + requestEntity.setUrl(url); + } +} diff --git a/src/test/java/xuanran/wang/http_test/interfaces/CusCreateRequestHeader.java b/src/test/java/xuanran/wang/http_test/interfaces/CusCreateRequestHeader.java new file mode 100644 index 0000000..045d6fd --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/interfaces/CusCreateRequestHeader.java @@ -0,0 +1,13 @@ +package xuanran.wang.http_test.interfaces; + +import java.util.Map; + +/** + *

自定义请求头

+ * + * @author xuanran.wang + * @date 2023/3/10 16:33 + */ +public interface CusCreateRequestHeader { + Map createHeader(); +} diff --git a/src/test/java/xuanran/wang/http_test/proxy/CusUtil.java b/src/test/java/xuanran/wang/http_test/proxy/CusUtil.java new file mode 100644 index 0000000..13f83e5 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/proxy/CusUtil.java @@ -0,0 +1,17 @@ +package xuanran.wang.http_test.proxy; + +/** + *

+ * + * @author xuanran.wang + * @date 2023/3/10 12:44 + */ +public class CusUtil { + + private static final RequestUtil requestUtil = new RequestUtil(); + + public static T getRequestClient(Class t) { + return requestUtil.getRequestClient(t); + } + +} diff --git a/src/test/java/xuanran/wang/http_test/proxy/RequestUtil.java b/src/test/java/xuanran/wang/http_test/proxy/RequestUtil.java new file mode 100644 index 0000000..f0c7cc2 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/proxy/RequestUtil.java @@ -0,0 +1,92 @@ +package xuanran.wang.http_test.proxy; + +import aiyh.utils.Util; +import aiyh.utils.excention.CustomerException; +import aiyh.utils.httpUtil.ResponeVo; +import aiyh.utils.httpUtil.util.HttpUtils; +import com.alibaba.fastjson.JSON; +import com.alibaba.fastjson.JSONObject; +import org.apache.log4j.Logger; +import xuanran.wang.http_test.annotations.*; +import xuanran.wang.http_test.annotations.async.CusAsync; +import xuanran.wang.http_test.annotations.request_type.CusRequestDelete; +import xuanran.wang.http_test.annotations.request_type.CusRequestGet; +import xuanran.wang.http_test.annotations.request_type.CusRequestPost; +import xuanran.wang.http_test.annotations.request_type.CusRequestPut; +import xuanran.wang.http_test.constant.RequestUtilConstant; +import xuanran.wang.http_test.entity.CusRequestEntity; +import xuanran.wang.http_test.handle.*; +import xuanran.wang.http_test.handle.path_handle.CusFieldKeyParseHandle; + +import java.io.IOException; +import java.lang.annotation.Annotation; +import java.lang.reflect.InvocationHandler; +import java.lang.reflect.Method; +import java.lang.reflect.Parameter; +import java.lang.reflect.Proxy; +import java.util.HashMap; +import java.util.Map; +import java.util.function.Function; + +/** + *

声明式发送http请求

+ * + * @author xuanran.wang + * @date 2023/3/10 10:35 + */ +public class RequestUtil implements InvocationHandler { + private CusRequestAddress cusRequestAddress = null; + private final HttpUtils httpUtils = new HttpUtils(); + private final Logger log = Util.getLogger(); + private boolean async = false; + public T getRequestClient(Class clazz){ + Annotation annotation = clazz.getDeclaredAnnotation(CusRequest.class); + if(annotation == null){ + throw new CustomerException("该类未添加CusRequest注解!"); + } + cusRequestAddress = clazz.getDeclaredAnnotation(CusRequestAddress.class); + if(null != clazz.getDeclaredAnnotation(CusAsync.class)){ + async = true; + } + return (T) Proxy.newProxyInstance(clazz.getClassLoader(), new Class[]{clazz}, this); + } + + @Override + public Object invoke(Object proxy, Method method, Object[] args) { + StringBuilder url = new StringBuilder(); + CusRequestEntity cusRequest = new CusRequestEntity(); + if(cusRequestAddress != null){ + String host = Util.null2DefaultStr(cusRequestAddress.host(),""); + int port = Util.getIntValue( Util.null2DefaultStr(cusRequestAddress.port(),""),0); + url.append(host) + .append(":") + .append(port); + cusRequest.setUrl(url.toString()); + } + CusFieldKeyParseHandle keyParseHandle = new CusFieldKeyParseHandle(); + keyParseHandle.handle(cusRequest, method, args); + log.info("cusRequest : \n" + JSONObject.toJSONString(cusRequest)); + return ""; + } + + private String appendPath(StringBuilder url, String path){ + if(!path.endsWith("/")){ + url.append("/"); + } + url.append(path); + return url.toString(); + } + + public Object get(String url, Map params, Map headers) throws IOException { + return httpUtils.apiGet(url, params, headers); + } + + public static boolean isJSON(String str) { + try { + JSON.parse(str); + return true; + } catch (Exception e) { + return false; + } + } +} diff --git a/src/test/java/xuanran/wang/http_test/service/TestService.java b/src/test/java/xuanran/wang/http_test/service/TestService.java new file mode 100644 index 0000000..00e770b --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/service/TestService.java @@ -0,0 +1,32 @@ +package xuanran.wang.http_test.service; + +import aiyh.utils.httpUtil.ResponeVo; +import xuanran.wang.http_test.annotations.*; +import xuanran.wang.http_test.annotations.header.CusRequestHeader; +import xuanran.wang.http_test.annotations.request_type.CusRequestGet; +import xuanran.wang.http_test.annotations.request_type.CusRequestPost; + +import java.util.Map; + +/** + *

+ * + * @author xuanran.wang + * @date 2023/3/10 12:39 + */ +@CusRequest +@CusRequestAddress(host = "http://114.115.168.220/educate-plat/api/v1/class/getClassList/{test}", port = 8191) +public interface TestService { + + + @CusRequestGet(url = "educate-plat/api/v1/class/getClassList/{test}") + @CusRequestHeader(cusHeaders = {"sa: sasa", "sas:11212"}) + String getStu(Map path, + @PostBody Map body, + @CusRequestHeader("hsjhdsad") String test, + @CusPathQuery("test") String test1); + + @CusRequestPost(url = "test/post/sas") + @CusRequestHeader(cusHeaders = {"content-Type: application/json"}, cusHeadersClassPath = "java.fsdfds") + String getStu(@PostBody Map body); +} diff --git a/src/test/java/xuanran/wang/http_test/test/RequestTest.java b/src/test/java/xuanran/wang/http_test/test/RequestTest.java new file mode 100644 index 0000000..ca18084 --- /dev/null +++ b/src/test/java/xuanran/wang/http_test/test/RequestTest.java @@ -0,0 +1,41 @@ +package xuanran.wang.http_test.test; + +import aiyh.utils.httpUtil.ResponeVo; +import basetest.BaseTest; +import org.junit.Test; +import xuanran.wang.http_test.proxy.CusUtil; +import xuanran.wang.http_test.proxy.RequestUtil; +import xuanran.wang.http_test.service.TestService; + +import java.util.HashMap; + +/** + *

+ * + * @author xuanran.wang + * @date 2023/3/10 12:42 + */ +public class RequestTest extends BaseTest { + private TestService requestClient = CusUtil.getRequestClient(TestService.class); + + @Test + public void test(){ + HashMap map = new HashMap<>(); + map.put("a","1"); + map.put("b","2"); + HashMap body = new HashMap<>(); + + body.put("a","3"); + body.put("b","4"); + + HashMap path = new HashMap<>(); + + path.put("e","5"); + path.put("f","6"); + requestClient.getStu(map, body, "a", "test1111"); + +// String stu1 = requestClient.getStu(body); + + + } +} diff --git a/src/test/java/xuanran/wang/shyl/dataasync/AsyncTest.java b/src/test/java/xuanran/wang/shyl/dataasync/AsyncTest.java index 8257758..563e1dc 100644 --- a/src/test/java/xuanran/wang/shyl/dataasync/AsyncTest.java +++ b/src/test/java/xuanran/wang/shyl/dataasync/AsyncTest.java @@ -2,19 +2,46 @@ package xuanran.wang.shyl.dataasync; import aiyh.utils.Util; import aiyh.utils.excention.CustomerException; +import aiyh.utils.httpUtil.util.HttpUtils; import basetest.BaseTest; -import cfca.sadk.org.bouncycastle.jcajce.provider.digest.SHA1; +import com.alibaba.fastjson.JSONArray; import com.alibaba.fastjson.JSONObject; +import com.api.xuanran.wang.shyl.entity.MQMessage; import org.apache.commons.lang3.StringUtils; +import org.apache.rocketmq.client.consumer.DefaultMQPushConsumer; +import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyContext; +import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyStatus; +import org.apache.rocketmq.client.consumer.listener.MessageListenerConcurrently; +import org.apache.rocketmq.client.exception.MQBrokerException; +import org.apache.rocketmq.client.exception.MQClientException; +import org.apache.rocketmq.common.consumer.ConsumeFromWhere; +import org.apache.rocketmq.common.message.MessageExt; +import org.apache.rocketmq.common.protocol.heartbeat.MessageModel; +import org.apache.rocketmq.remoting.exception.RemotingException; import org.junit.Test; import weaver.xuanran.wang.common.annocation.SqlFieldMapping; import weaver.xuanran.wang.common.annocation.SqlUpdateWhereField; import weaver.xuanran.wang.shyl.dataasync.entity.StudentClass; +import java.io.UnsupportedEncodingException; import java.lang.reflect.Field; -import java.security.acl.LastOwnerException; +import java.nio.charset.StandardCharsets; import java.util.*; +import cn.hutool.core.util.CharsetUtil; +import cn.hutool.core.util.StrUtil; +import cn.hutool.crypto.asymmetric.KeyType; +import cn.hutool.crypto.asymmetric.RSA; +import cn.hutool.http.HttpRequest; +import cn.hutool.json.JSONUtil; +import weaver.xuanran.wang.shyl_mq.RocketMQFactory; +import weaver.xuanran.wang.shyl_mq.consumer.OrgConsumer; +import weaver.xuanran.wang.shyl_mq.util.RocketConsumerUtil; + +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + /** *

上海团校测试类

* @@ -24,7 +51,8 @@ import java.util.*; public class AsyncTest extends BaseTest { @Test - public void testExecuteBatchByEntity(){ + public void testExecuteBatchByEntity() { + HttpUtils httpUtils = new HttpUtils(); String json = "{\n" + "\t\"msg\": \"success\",\n" + "\t\"code\": 0,\n" + @@ -47,7 +75,7 @@ public class AsyncTest extends BaseTest { List> params = new ArrayList<>(); List> whereParams = new ArrayList<>(); for (Object o : list) { - if(Objects.isNull(o)){ + if (Objects.isNull(o)) { continue; } Class clazz = o.getClass(); @@ -64,23 +92,23 @@ public class AsyncTest extends BaseTest { throw new CustomerException(Util.logStr("field get error! the error is :[{}]," + "current field is: [{}], current obj is: [{}]", e.getMessage(), fieldName, JSONObject.toJSONString(o))); } - if(Objects.isNull(fieldValue)){ + if (Objects.isNull(fieldValue)) { continue; } // 数据库字段映射 如果注解中没有值那么写入数据库就是实体类字段名 SqlFieldMapping sqlFieldMapping = field.getAnnotation(SqlFieldMapping.class); - if(null == sqlFieldMapping){ + if (null == sqlFieldMapping) { continue; } String sqlFieldMappingValue = sqlFieldMapping.value(); - if(StringUtils.isNotBlank(sqlFieldMappingValue)){ + if (StringUtils.isNotBlank(sqlFieldMappingValue)) { fieldName = sqlFieldMappingValue; } linkedHashMap.put(fieldName, fieldValue); // 更新条件字段注解 SqlUpdateWhereField sqlUpdateWhereField = field.getAnnotation(SqlUpdateWhereField.class); - if(null == sqlUpdateWhereField || !sqlUpdateWhereField.value()){ + if (null == sqlUpdateWhereField || !sqlUpdateWhereField.value()) { continue; } whereParam.add(fieldValue.toString()); @@ -91,4 +119,281 @@ public class AsyncTest extends BaseTest { log.info("params : " + JSONObject.toJSONString(params)); log.info("wheres : " + whereParams); } + + @Test + public void testSql() { + String json = "[{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"}],\"workflowId\":\"451\"}]"; + JSONArray temp = new JSONArray(); + JSONArray arr = JSONObject.parseObject(json, JSONArray.class); + for (int i = 0; i < arr.size() - 1; i++) { + for (int j = 0; j < 25; j++) { + Object o = arr.get(i); + JSONObject object = JSONObject.parseObject(o.toString()); + temp.add(object); + } + } + JSONArray arrr = new JSONArray(); + for (Object o : temp) { + JSONObject object = JSONObject.parseObject(o.toString()); + List mainData = (List)object.get("mainData"); + JSONObject jsonObject = new JSONObject(); + jsonObject.put("fieldName","customId"); + jsonObject.put("fieldValue",UUID.randomUUID().toString()); + mainData.add(jsonObject); + object.put("mainData", mainData); + arrr.add(object); + } + arr.addAll(arrr); + log.info("json arr size " + arr.size()); + log.info("arr : \n" + JSONObject.toJSONString(arr)); +// try { +// List s = batchCreateWorkflowService.batchCreateWorkflow2(arr); +// log.info("创建流程接口返回 " + s); +// } catch (Exception e) { +// log.error("创建流程失败 ! " + e.getMessage()); +// } + } + + @Test + public void testC() { + try { + // 声明一个消费者consumer，需要传入一个组 weaver-consumer + DefaultMQPushConsumer consumer = new DefaultMQPushConsumer("weaver-consumer"); + // 设置集群的NameServer地址，多个地址之间以分号分隔 183.192.65.118:9876 + consumer.setNamesrvAddr("114.115.168.220:9876"); + // 设置consumer的消费策略 + consumer.setConsumeFromWhere(ConsumeFromWhere.CONSUME_FROM_FIRST_OFFSET); + // 集群模式消费，广播消费不会重试 + consumer.setMessageModel(MessageModel.CLUSTERING); + // 设置最大重试次数，默认是16次 + consumer.setMaxReconsumeTimes(1); + // 设置consumer所订阅的Topic和Tag，*代表全部的Tag AUTH_CONSOLE_USERINFO_TOPIC + consumer.subscribe("AUTH_CONSOLE_ORG_TOPIC", "*"); + consumer.setVipChannelEnabled(false); + // Listener，主要进行消息的逻辑处理,监听topic，如果有消息就会立即去消费 + consumer.registerMessageListener(new MessageListenerConcurrently() { + @Override + public ConsumeConcurrentlyStatus consumeMessage(List list, ConsumeConcurrentlyContext consumeConcurrentlyContext) { + MessageExt messageExt = list.get(0); + String msgBody; + MQMessage mqMessage; + try { + msgBody = new String(messageExt.getBody(), StandardCharsets.UTF_8); + if (StringUtils.isBlank(msgBody)) { + throw new CustomerException("MQ msgBody is empty!"); + } + mqMessage = JSONObject.parseObject(msgBody, MQMessage.class); + // 业务主体 + String content = Util.null2DefaultStr(mqMessage.getContent(), ""); + if (StringUtils.isBlank(content)) { + throw new CustomerException(Util.logStr("the messageId : {}, content is empty!", Util.null2DefaultStr(mqMessage.getId(), ""))); + } + log.info(Util.logStr("MQMessage : {} ", mqMessage)); + return ConsumeConcurrentlyStatus.CONSUME_SUCCESS; + } catch (Exception e) { + throw new CustomerException("consumeMessage => " + e.getMessage()); + } + } + }); + consumer.start(); + } catch (Exception e) { + log.error(" e => " + e.getMessage()); + } + } + + @Test + public void testD() throws UnsupportedEncodingException, MQBrokerException, RemotingException, InterruptedException, MQClientException { + String msg = "{\n" + + "\t\"actionType\": \"CREATE_ACTION\",\n" + + "\t\"topic\": \"OA_MEETING_TOPIC\",\n" + + "\t\"id\": \"29039\",\n" + + "\t\"content\": {\n" + + "\t\t\"sourceId\": \"29050\",\n" + + "\t\t\"mrtype\": \"2\",\n" + + "\t\t\"EndTime\": \"17:10\",\n" + + "\t\t\"meetingStatus\": \"1\",\n" + + "\t\t\"BeginTime\": \"17:36\",\n" + + "\t\t\"meetingTitle\": \"MQ测试20230223\",\n" + + "\t\t\"roomCode\": \"青年会堂会议室\",\n" + + "\t\t\"signCode\": \"\",\n" + + "\t\t\"EndDate\": \"2023-02-24\",\n" + + "\t\t\"BeginDate\": \"2023-02-23\",\n" + + "\t\t\"meetingHost\": \"96\",\n" + + "\t\t\"userList\": \"96\",\n" + + "\t\t\"meetingContent\": \"测试MQ20230223\"\n" + + "\t},\n" + + "\t\"sendTime\": \"2023-02-23 17:49:11\"\n" + + "}"; + RocketConsumerUtil.producerSendMsg("OAMeeting", msg,""); + // 先从本地缓存中获取生产者对象 + } + + @Test + public void testE() { + DefaultMQPushConsumer consumer = null; + log.info(Util.logStr("---- consumer : {} initialized start ----", "OrgConsumer")); + try { + try { + // 根据配置文件初始化一个consumer对象 + consumer = RocketMQFactory.getMQPushConsumer("OrgConsumer", new OrgConsumer().service()); + } catch (Exception e) { + throw new CustomerException(Util.logStr("the consumer init exception : {}", e.getMessage())); + } + try { + // 调用start()方法启动consumer + consumer.start(); + } catch (Exception e) { + throw new CustomerException(Util.logStr("the consumer start exception : {}", e.getMessage())); + } + log.info(Util.logStr("---- consumer : {} initialized end ----", "OrgConsumer")); + } catch (Exception e) { + log.info(Util.logStr("---- consumer : {} initialized error ----", "OrgConsumer")); + log.error(Util.getErrString(e)); + } + + } + + private static final Map SYSTEM_CACHE = new HashMap<>(); + /** + * ecology系统发放的授权许可证(appid) + */ + private static final String APPID = "JYZ"; + + @Test + public void testB() { + String json = "[{\n" + + "\t\"requestName\": \"你个沙雕32323\",\n" + + "\t\"workflowId\": \"45\",\n" + + "\t\"mainData\": [{\n" + + "\t\t\"fieldName\": \"yysy\",\n" + + "\t\t\"fieldValue\": \"测试20230309\"\n" + + "\t}]\n" + + "}, {\n" + + "\t\"requestName\": \"沙雕2号\",\n" + + "\t\"workflowId\": \"45\",\n" + + "\t\"mainData\": [{\n" + + "\t\t\"fieldName\": \"yysy\",\n" + + "\t\t\"fieldValue\": \"沙雕沙雕沙雕沙雕沙雕\"\n" + + "\t}]\n" + + "}, {\n" + + "\t\"requestName\": \"沙雕2号\",\n" + + "\t\"workflowId\": \"451\",\n" + + "\t\"mainData\": [{\n" + + "\t\t\"fieldName\": \"yysy\",\n" + + "\t\t\"fieldValue\": \"沙雕沙雕沙雕沙雕沙雕\"\n" + + "\t}]\n" + + "}]"; + testRestful("http://183.192.65.115:8080", "/api/wxr/shyl/workflow/batchCreate233", json); + } + + /** + * 第一步： + *

+ * 调用ecology注册接口,根据appid进行注册,将返回服务端公钥和Secret信息 + */ + public static Map testRegist(String address) { + //获取当前系统RSA加密的公钥 + RSA rsa = new RSA(); + String publicKey = rsa.getPublicKeyBase64(); + String privateKey = rsa.getPrivateKeyBase64(); + // 客户端RSA私钥 + SYSTEM_CACHE.put("LOCAL_PRIVATE_KEY", privateKey); + // 客户端RSA公钥 + SYSTEM_CACHE.put("LOCAL_PUBLIC_KEY", publicKey); + //调用ECOLOGY系统接口进行注册 + String data = HttpRequest.post(address + "/api/ec/dev/auth/regist") + .header("appid", APPID) + .header("cpk", publicKey) + .timeout(2000) + .execute().body(); + // 打印ECOLOGY响应信息 + System.out.println("testRegist()：" + data); + Map datas = JSONUtil.parseObj(data); + //ECOLOGY返回的系统公钥 + SYSTEM_CACHE.put("SERVER_PUBLIC_KEY", StrUtil.nullToEmpty((String) datas.get("spk"))); + //ECOLOGY返回的系统密钥 + SYSTEM_CACHE.put("SERVER_SECRET", StrUtil.nullToEmpty((String) datas.get("secrit"))); + return datas; + } + + /** + * 第二步： + *

+ * 通过第一步中注册系统返回信息进行获取token信息 + */ + public static Map testGetoken(String address) { + // 从系统缓存或者数据库中获取ECOLOGY系统公钥和Secret信息 + String secret = SYSTEM_CACHE.get("SERVER_SECRET"); + String spk = SYSTEM_CACHE.get("SERVER_PUBLIC_KEY"); + // 如果为空,说明还未进行注册,调用注册接口进行注册认证与数据更新 + if (Objects.isNull(secret) || Objects.isNull(spk)) { + testRegist(address); + // 重新获取最新ECOLOGY系统公钥和Secret信息 + secret = SYSTEM_CACHE.get("SERVER_SECRET"); + spk = SYSTEM_CACHE.get("SERVER_PUBLIC_KEY"); + } + // 公钥加密,所以RSA对象私钥为null + RSA rsa = new RSA(null, spk); + //对秘钥进行加密传输，防止篡改数据 + String encryptSecret = rsa.encryptBase64(secret, CharsetUtil.CHARSET_UTF_8, KeyType.PublicKey); + //调用ECOLOGY系统接口进行注册 + String data = HttpRequest.post(address + "/api/ec/dev/auth/applytoken") + .header("appid", APPID) + .header("secret", encryptSecret) + .header("time", "3600") + .execute().body(); + System.out.println("testGetoken()：" + data); + Map datas = JSONUtil.parseObj(data); + //ECOLOGY返回的token + // TODO 为Token缓存设置过期时间 + SYSTEM_CACHE.put("SERVER_TOKEN", StrUtil.nullToEmpty((String) datas.get("token"))); + return datas; + } + + /** + * 第三步： + *

+ * 调用ecology系统的rest接口，请求头部带上token和用户标识认证信息 + * + * @param address ecology系统地址 + * @param api rest api 接口地址(该测试代码仅支持GET请求) + * @param jsonParams 请求参数json串 + *

+ * 注意：ECOLOGY系统所有POST接口调用请求头请设置 "Content-Type","application/x-www-form-urlencoded; charset=utf-8" + */ + public String testRestful(String address, String api, String jsonParams) { + //ECOLOGY返回的token + String token = SYSTEM_CACHE.get("SERVER_TOKEN"); + if (StrUtil.isEmpty(token)) { + token = (String) testGetoken(address).get("token"); + } + String spk = SYSTEM_CACHE.get("SERVER_PUBLIC_KEY"); + //封装请求头参数 + RSA rsa = new RSA(null, spk); + //对用户信息进行加密传输,暂仅支持传输OA用户ID + String encryptUserid = rsa.encryptBase64("1", CharsetUtil.CHARSET_UTF_8, KeyType.PublicKey); + List list = JSONObject.parseObject(jsonParams, List.class); + HttpUtils httpUtils = new HttpUtils(); + HashMap headers = new HashMap<>(); + headers.put("appid", APPID); + headers.put("token", token); + headers.put("userid", encryptUserid); + headers.put("Content-Type", "application/x-www-form-urlencoded; charset=utf-8"); + log.info("请求头 = > " + headers); +// try { +// ResponeVo responeVo = httpUtils.apiPostObject(address + api, list, headers); +// log.info("reslut => " + JSONObject.toJSON(responeVo)); +// } catch (Exception e) { +// log.error("e => " + e.getMessage()); +// } + return ""; + } + + @Test + public void testF() { + Map test = Util.getProperties2Map("test"); + log.info("test => " + JSONObject.toJSONString(test)); + } + + } diff --git a/src/test/java/xuanran/wang/shyl/dataasync/CreateWorkflowTest.java b/src/test/java/xuanran/wang/shyl/dataasync/CreateWorkflowTest.java new file mode 100644 index 0000000..8aedbb5 --- /dev/null +++ b/src/test/java/xuanran/wang/shyl/dataasync/CreateWorkflowTest.java @@ -0,0 +1,192 @@ +package xuanran.wang.shyl.dataasync; + +import aiyh.utils.Util; +import basetest.BaseTest; +import com.alibaba.fastjson.JSONArray; +import com.alibaba.fastjson.JSONObject; +import com.api.xuanran.wang.shyl.entity.MQMessage; +import com.api.xuanran.wang.shyl.entity.ProducerCarInfo; +import com.api.xuanran.wang.shyl.mapper.ProducerMapper; +import com.api.xuanran.wang.shyl.service.BatchCreateWorkflowService; +import com.api.xuanran.wang.shyl.vo.CreateWfVO; +import ebu7common.youhong.ai.bean.Builder; +import org.apache.commons.lang3.StringUtils; +import org.junit.Test; +import weaver.general.TimeUtil; +import weaver.hrm.User; +import weaver.xuanran.wang.shyl.dataasync.entity.StudentClass; +import weaver.xuanran.wang.shyl.dataasync.service.CusDataAsyncService; +import weaver.xuanran.wang.shyl_mq.util.RocketConsumerUtil; + +import java.util.List; +import java.util.Objects; +import java.util.UUID; + +/** + *

+ * + * @author xuanran.wang + * @date 2023/2/24 13:09 + */ +public class CreateWorkflowTest extends BaseTest { + + private final BatchCreateWorkflowService batchCreateWorkflowService = new BatchCreateWorkflowService(); + private final ProducerMapper producerMapper = Util.getMapper(ProducerMapper.class); + + @Test + public void testA(){ + String json = "[{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"212121\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"cbc7bc14-01ef-4fbc-9a64-07d68ece640d\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"81fdff79-361e-4377-9094-1d4f88b8a258\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"cddc29b7-0fd6-4624-a98f-52e88b466bfb\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"e50787ba-547a-42f2-b0f8-e0e220f22704\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"1d24eef1-ee6e-4d66-9a63-aef642801920\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"3219d315-3bcf-406f-8932-33e9cdf6f443\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"f1789302-835d-4cb3-b24b-fdd5860865f6\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"04977392-1fdb-42f0-a3ef-d1a181c41a07\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"ce09860e-3f31-4790-95fe-5c06700e6262\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"7ce49160-3e66-40cb-9bb2-fb692a17f7b7\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"c5eee9d8-9605-419c-85d1-07eb36cc8bcd\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"3f16559d-e2a9-4f01-a089-4556c4d44554\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"e5f0a91b-be45-4908-9965-1d97a2290717\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"fbb60256-7972-45e2-802a-edc42f20ed64\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"97f8551e-df0b-4559-9219-ffa6d02f049a\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"1a34307b-74fc-4b08-98fb-3433a6276d3e\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"edf54ba8-a29d-4aea-90c6-711d8f045125\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"593fb831-8c0f-4c51-b919-ef9b27643483\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"eb20f0a1-9ee7-44d3-a9e4-fb470af0444e\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"2d5c3eac-0f41-4da7-97b5-8dded1dd1583\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"95fa2685-85db-4f4d-b526-9ea3bac05787\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"ef1e3243-fc3f-439d-a293-0b95fd25234a\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"7dc79466-3fab-4b12-af04-88b9b07493bd\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"43d16081-7a95-47d9-be96-a891ad9ea589\"}],\"workflowId\":\"45\"},{\"requestName\":\"放松放松\",\"mainData\":[{\"fieldName\":\"yysy\",\"fieldValue\":\"测试20230309\"},{\"fieldName\":\"customId\",\"fieldValue\":\"122323\"},{\"fieldName\":\"customId\",\"fieldValue\":\"8b1092b5-604f-4fbe-a73f-b1ab87b937e1\"}],\"workflowId\":\"45\"}] \n"; + JSONArray temp = new JSONArray(); + JSONArray arr = JSONObject.parseObject(json, JSONArray.class); +// for (int i = 0; i < arr.size() - 1; i++) { +// Object o = arr.get(i); +// for (int j = 0; j < 25; j++) { +// temp.add(o); +// } +// } +// arr.addAll(temp); + log.info("jsonarr : \n" + JSONObject.toJSONString(arr)); + log.info("json arr size " + arr.size()); + try { + List res = batchCreateWorkflowService.batchCreateWorkflow(new User(1), arr); + log.info("res => " + res); + }catch (Exception e){ + log.error("批量创建流程异常 : " + e.getMessage()); + } + } + + @Test + public void testB(){ + String url = "https://ecology.yeyaguitu.cn/api/wxr/meeting/cancel"; + String id = "111,112"; + url += "?id="+id; + try { + String encode= java.net.URLEncoder.encode(url, "UTF-8"); + log.info("encode => " + encode); + }catch (Exception e){ + log.error("e => " + e.getMessage()); + } + } + + @Test + public void testC(){ + String json = "{\n" + + "\t\"id\": \"43489ef6-4f48-4c00-b9fd-258bd943434\",\n" + + "\t\"topic\": \"AUTH_CONSOLE_ORG_TOPIC\",\n" + + "\t\"actionType\": \"CREATE_ACTION\",\n" + + "\t\"sendTime\": \"2023-02-18 19:26:25\",\n" + + "\t\"content\": {\n" + + "\t\t\"id\": \"780053000679849931313\",\n" + + "\t\t\"orgCode\": \"ZJJF\",\n" + + "\t\t\"orgName\": \"展馆教学管理部1\",\n" + + "\t\t\"fullName\": \"展馆教学管理部1\",\n" + + "\t\t\"parentId\": \"1\",\n" + + "\t\t\"parentName\": \"\",\n" + + "\t\t\"type\": \"1\",\n" + + "\t\t\"codePath\": \"1/780053000679849984\",\n" + + "\t\t\"namePath\": \"上海青年管理干部学院/展馆教学管理部\",\n" + + "\t\t\"level\": 0,\n" + + "\t\t\"division\": \"\",\n" + + "\t\t\"country\": \"\",\n" + + "\t\t\"region\": \"\",\n" + + "\t\t\"locality\": \"\",\n" + + "\t\t\"street\": \"\",\n" + + "\t\t\"address\": \"\",\n" + + "\t\t\"contact\": \"\",\n" + + "\t\t\"postalCode\": \"\",\n" + + "\t\t\"phone\": \"\",\n" + + "\t\t\"fax\": \"\",\n" + + "\t\t\"email\": \"\",\n" + + "\t\t\"sortIndex\": 1,\n" + + "\t\t\"status\": 1,\n" + + "\t\t\"instId\": \"1\",\n" + + "\t\t\"isPrimary\": 0,\n" + + "\t\t\"reorgNamePath\": false,\n" + + "\t\t\"rows\": 0,\n" + + "\t\t\"pageSize\": 20,\n" + + "\t\t\"pageNumber\": 1,\n" + + "\t\t\"startRow\": 0,\n" + + "\t\t\"endRow\": 0,\n" + + "\t\t\"pageable\": false\n" + + "\t}\n" + + "}"; + RocketConsumerUtil.producerSendMsg("OrgConsumer",json,""); + } + + @Test + public void testD(){ + ProducerCarInfo dsdasds = Builder.builder(ProducerCarInfo::new) + .with(ProducerCarInfo::setStatus, "1") + .with(ProducerCarInfo::setPlateList,"ggsahdsah") + .with(ProducerCarInfo::setCarCode, "2") + .build(); + MQMessage mqMessage = new MQMessage(); + mqMessage.setId(UUID.randomUUID().toString()); + mqMessage.setTopic("OACar"); + mqMessage.setSendTime(TimeUtil.getCurrentTimeString()); + mqMessage.setActionType("create"); + mqMessage.setContent(dsdasds); + String msg = JSONObject.toJSONString(mqMessage); + log.info(Util.logStr("car msg : {}", msg)); + } + + @Test + public void testE(){ + ProducerCarInfo info = null; + String id = "1"; + String carNo = "21212"; + MQMessage mqMessage = new MQMessage(); + mqMessage.setId(UUID.randomUUID().toString()); + mqMessage.setTopic("OA_CAR_TOPIC"); + mqMessage.setSendTime(TimeUtil.getCurrentTimeString()); + mqMessage.setActionType("1"); + if(StringUtils.isNotBlank(id)){ + info = producerMapper.queryCarInfo(id); + }else { + // 车牌号 + info = producerMapper.queryCarNo(carNo); + } + + // 如果能找到就说明是更新或者新增 + if(Objects.isNull(info) && StringUtils.isNotBlank(id)){ //删除状态下 + info = new ProducerCarInfo(); + info.setCarCode(id); + info.setStatus("1"); + info.setRemark(""); + info.setDriver(""); + info.setPlateList(""); + info.setUserName(""); + info.setUserPhone(""); + log.info("删除状态下!"); + } + log.info("ProducerCarInfo : " + JSONObject.toJSONString(info)); + if(Objects.isNull(info)){ + log.error("查找车辆信息失败!"); + return; + } + carNo = info.getPlateList(); + info.setIdentification("1"); + mqMessage.setContent(info); + String msg = JSONObject.toJSONString(mqMessage); + log.info(Util.logStr("car msg : {}", msg)); + } + + private final CusDataAsyncService dataAsyncService = new CusDataAsyncService(); + + /** + *

更新班级建模条件sql

+ **/ + private static final String updateClassSql = "select id from #{tableName} where classId = ?"; + /** + *

更新学员建模条件sql

+ **/ + private static final String updateStudentSql = "select id from #{tableName} where studentId = ?"; + + @Test + public void testAsync(){ + String baseAddr = "http://114.115.168.220:8191"; + String queryClassUrl = "/educate-plat/api/v1/class/getClassList"; + String classModelId = "97"; + dataAsyncService.asyncData(baseAddr + queryClassUrl, classModelId, StudentClass.class, updateClassSql,"data"); + } +} diff --git a/src/test/java/xuanran/wang/shyl/dataasync/MapperTest.java b/src/test/java/xuanran/wang/shyl/dataasync/MapperTest.java new file mode 100644 index 0000000..98a6fa5 --- /dev/null +++ b/src/test/java/xuanran/wang/shyl/dataasync/MapperTest.java @@ -0,0 +1,49 @@ +package xuanran.wang.shyl.dataasync; + +import basetest.BaseTest; +import com.alibaba.fastjson.JSONObject; +import com.api.meeting.util.FieldUtil; +import com.api.xuanran.wang.shyl.entity.meeting.MeetingCusFieldConfigMain; +import com.api.xuanran.wang.shyl.service.MeetingService; +import org.junit.Test; +import weaver.general.TimeUtil; +import weaver.general.Util; +import weaver.systeminfo.SystemEnv; + +import java.util.ArrayList; +import java.util.Date; +import java.util.List; +import java.util.Map; + +/** + *

+ * + * @author xuanran.wang + * @date 2023/3/1 15:58 + */ +public class MapperTest extends BaseTest { + + private final MeetingService meetingService = new MeetingService(); + @Test + public void testA(){ + List meetingFieldCusConfig = meetingService.getMeetingFieldCusConfig(); + log.info("config : " + JSONObject.toJSONString(meetingFieldCusConfig)); + } + + @Test + public void testB(){ + Map dalou = FieldUtil.getFormItemForSelect("dalou", "大楼", "1213", 2, new ArrayList<>()); + log.info("大楼 : " + dalou); + Map var70 = FieldUtil.getFormItemForInputNumber("shuliang", "数量", String.valueOf(131), -999, 999, 2); + log.info("数量 : " + var70); + + Map formItemForInput = FieldUtil.getFormItemForInput("shuliang", "数量", String.valueOf(131), 2); + log.info("formItemForInput : " + formItemForInput); + } + + @Test + public void testC(){ + String s = TimeUtil.dateAdd("2023-03-02", -3); + log.info("time => " + s); + } +} diff --git a/src/test/java/xuanran/wang/traffic_bank/waco_first/WacoFirstTest.java b/src/test/java/xuanran/wang/traffic_bank/waco_first/WacoFirstTest.java index 3699a15..44d1118 100644 --- a/src/test/java/xuanran/wang/traffic_bank/waco_first/WacoFirstTest.java +++ b/src/test/java/xuanran/wang/traffic_bank/waco_first/WacoFirstTest.java @@ -100,4 +100,5 @@ public class WacoFirstTest extends BaseTest { } + } diff --git a/src/test/java/youhong/ai/mymapper/ParseSqlTest.java b/src/test/java/youhong/ai/mymapper/ParseSqlTest.java index e5d52a0..5f8c72e 100644 --- a/src/test/java/youhong/ai/mymapper/ParseSqlTest.java +++ b/src/test/java/youhong/ai/mymapper/ParseSqlTest.java @@ -6,7 +6,6 @@ import org.junit.Test; import youhong.ai.mymapper.command.entity.SqlDefinition; import youhong.ai.mymapper.util.ParseSqlUtil; -import java.util.Arrays; import java.util.HashMap; import java.util.Map; @@ -27,15 +26,15 @@ public class ParseSqlTest extends BaseTest { // "\t}\n" + // // "} order by abase = #{order} $t{desc}"; - String sql = "select * from table @my-trim:suffix=\"suffix-1\":prefix=\"prefix-1\":prefixOverrides=\"where\":suffixOverrides=\"?\"{\n" + - "\t@my-where{\n" + - "\t\t@my-for:item=\"item\":index=\"index\":collection=\"ids.split(',')\":open=\"\":separator=\"\":close=\"\":nullable{\n" + - "\t\t\t@my-if:test=\" index <= 1\"{\n" + - "\t\t\t\tand $t{index} = #{item}\n" + - "\t\t\t}\n" + - "\t\t}\n" + - "\t}\n" + - "} test = @{desc}"; + String sql = "select * from table @trim:suffix=\"suffix-1\":prefix=\"prefix-1\":prefixOverrides=\"where\":suffixOverrides=\"?\"{\n" + + "\t\t\t\t :my-where{\n" + + "\t\t\t\t :my-for:item=\"item\":index=\"index\":collection=\"ids\":open=\"\":separator=\"\":close=\"\":nullable{\n" + + "\t\t\t\t :if:test=\" index <= 1\"{\n" + + "\t\t\t\t and $t{index} = #{item}\n" + + "\t\t\t\t }\n" + + "\t\t\t\t }\n" + + "\t\t\t\t }\n" + + "\t\t\t\t }"; ParseSqlUtil parseSqlUtil = new ParseSqlUtil(); Map param = new HashMap<>(); // param.put("ids", "var1,var2,var3"); @@ -52,6 +51,65 @@ public class ParseSqlTest extends BaseTest { @Test public void testLoadClass() { - System.out.println(Arrays.asList("1", "2", "3", "4")); + String sql = "{\n" + + "\t\t@my-when:test=\"\"{\n" + + "\t\t\tid = #{id}\n" + + "\t\t}\n" + + "\t\t@my-when:test=\"\"{\n" + + "\t\t\tid = #{id}\n" + + "\t\t}\n" + + "\t\t@my-when:test=\"\"{\n" + + "\t\t\tid = #{id}\n" + + "\t\t}\n" + + "\t\t@my-when:test=\"\"{\n" + + "\t\t\tid = #{id}\n" + + "\t\t}\n" + + "\t\t@my-otherwise{\n" + + "\t\t\tid = #{id}\n" + + "\t\t}\n" + + "}"; + ParseSqlUtil parseSqlUtil = new ParseSqlUtil(); + System.out.println(JSON.toJSONString(parseSqlUtil.getCommandList(sql))); + } + + + @Test + public void testSqlChoose() { + String sql = "@my-bind:name='likeName':value=''%' + name + '%''{}\n" + + "select * from table @my-where{\n" + + "\t@my-for:collection='list':separator='and'{\n" + + "\t\t${index} = #{item}\t\n" + + "\t}\n" + + "} or @my-choose{\n" + + "\t@my-when:test='selectValue == 1'{\n" + + "\t\tselect_name = #{selectName1}\n" + + "\t}\n" + + "\t@my-when:test='selectValue == 2'{\n" + + "\t\tselect_name = #{selectName2}\n" + + "\t}\n" + + "\t@my-when:test='selectValue == 3'{\n" + + "\t\tselect_name = #{selectName3}\n" + + "\t}\n" + + "\t@my-otherwise{\n" + + "\t\tselect_name like #{likeName}\n" + + "\t}\n" + + "}\n"; + + Map param = new HashMap<>(); + param.put("list", new HashMap() {{ + put("field1", "1"); + put("field2", "2"); + put("field3", "3"); + }}); + + param.put("selectValue", 4); + param.put("selectName1", "name1"); + param.put("selectName2", "name2"); + param.put("selectName3", "name3"); + param.put("selectNameDefault", "default"); + param.put("name", "zhang"); + ParseSqlUtil parseSqlUtil = new ParseSqlUtil(); + SqlDefinition parse = parseSqlUtil.parse(sql, param); + System.out.println(JSON.toJSONString(parse)); } } diff --git a/src/test/java/youhong/ai/mymapper/command/commandImpl/MyBindCommand.java b/src/test/java/youhong/ai/mymapper/command/commandImpl/MyBindCommand.java new file mode 100644 index 0000000..032aa87 --- /dev/null +++ b/src/test/java/youhong/ai/mymapper/command/commandImpl/MyBindCommand.java @@ -0,0 +1,59 @@ +package youhong.ai.mymapper.command.commandImpl; + +import aiyh.utils.Util; +import aiyh.utils.excention.CustomerException; +import aiyh.utils.tool.cn.hutool.core.collection.CollectionUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import youhong.ai.mymapper.command.ISqlCommand; +import youhong.ai.mymapper.command.annotation.SqlCommand; +import youhong.ai.mymapper.command.constant.CommandConsTant; +import youhong.ai.mymapper.command.entity.SqlCommandDefinition; +import youhong.ai.mymapper.command.properties.MyBindProperties; +import youhong.ai.mymapper.util.ParseSqlUtil; +import youhong.ai.mymapper.util.ScriptUtil; + +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +/** + *

bind指令

+ * + *

create: 2023/3/15 11:58

+ * + * @author youHong.ai + */ +@SqlCommand(CommandConsTant.BIND) +public class MyBindCommand implements ISqlCommand { + @Override + public String execute(SqlCommandDefinition sqlCommandDefinition) { + MyBindProperties properties = (MyBindProperties) sqlCommandDefinition.getProperties(); + String name = properties.getName(); + if (StrUtil.isBlank(name)) { + throw new CustomerException("bind command attribute of name can not be null"); + } + Map tempMap = ParseSqlUtil.PARSE_TEMP_PARAM_LOCALE.get(); + if (CollectionUtil.isEmpty(tempMap)) { + Map map = new HashMap<>(); + ParseSqlUtil.PARSE_TEMP_PARAM_LOCALE.set(map); + tempMap = map; + } + name = name.trim(); + if (tempMap.containsKey(name)) { + throw new CustomerException(Util.logStr("can not bind variable [{}], [{}] has been declared!", + name, name)); + } + Map param = ParseSqlUtil.PARSE_PARAM_LOCALE.get(); + if (Objects.isNull(param)) { + return null; + } + param.putAll(tempMap); + String valueStr = properties.getValue(); + Object value = null; + if (!StrUtil.isBlank(valueStr)) { + value = ScriptUtil.invokeScript(valueStr.trim(), param); + } + param.put(name, value); + return null; + } +} diff --git a/src/test/java/youhong/ai/mymapper/command/commandImpl/MyChooseCommand.java b/src/test/java/youhong/ai/mymapper/command/commandImpl/MyChooseCommand.java new file mode 100644 index 0000000..e338192 --- /dev/null +++ b/src/test/java/youhong/ai/mymapper/command/commandImpl/MyChooseCommand.java @@ -0,0 +1,101 @@ +package youhong.ai.mymapper.command.commandImpl; + +import aiyh.utils.Util; +import aiyh.utils.excention.CustomerException; +import aiyh.utils.tool.cn.hutool.core.collection.CollectionUtil; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; +import youhong.ai.mymapper.command.CommandExecutor; +import youhong.ai.mymapper.command.ISqlCommand; +import youhong.ai.mymapper.command.annotation.SqlCommand; +import youhong.ai.mymapper.command.constant.CommandConsTant; +import youhong.ai.mymapper.command.entity.SqlCommandDefinition; +import youhong.ai.mymapper.command.properties.MyWhenProperties; +import youhong.ai.mymapper.util.ParseSqlUtil; +import youhong.ai.mymapper.util.ScriptUtil; + +import java.util.*; + +/** + *

choose 指令

+ * + *

create: 2023/3/15 09:24

+ * + * @author youHong.ai + */ +@SqlCommand(CommandConsTant.CHOOSE) +public class MyChooseCommand implements ISqlCommand { + + private final List CHILDREN_LIST = Arrays.asList(CommandConsTant.WHEN, CommandConsTant.OTHERWISE); + + @Override + public String execute(SqlCommandDefinition sqlCommandDefinition) { + ParseSqlUtil parseSqlUtil = new ParseSqlUtil(); + String commandContent = sqlCommandDefinition.getCommandContent(); + List commandList = parseSqlUtil.getCommandList(commandContent); + if (CollectionUtil.isEmpty(commandList)) { + return null; + } + int otherwiseNum = 0; + SqlCommandDefinition otherWiseDefinition = null; + List commandListSort = new ArrayList<>(); + for (SqlCommandDefinition commandDefinition : commandList) { + if (!CHILDREN_LIST.contains(commandDefinition.getCommandType())) { + throw new CustomerException(Util.logStr("The command node of choose can only include {}, not {}", CHILDREN_LIST.toString(), commandDefinition.getCommandType())); + } + if (CommandConsTant.OTHERWISE.equals(commandDefinition.getCommandType())) { + otherwiseNum++; + otherWiseDefinition = commandDefinition; + continue; + } + commandListSort.add(commandDefinition); + } + if (otherwiseNum > 1) { + throw new CustomerException(CommandConsTant.OTHERWISE + " command has and can only have one!"); + } + if (!Objects.isNull(otherWiseDefinition)) { + commandListSort.add(otherWiseDefinition); + } + return extracted(commandListSort); + } + + /** + *

选择执行命令

+ * + * @param commandList 命令列表 + * @return 执行结果 + */ + private String extracted(List commandList) { + SqlCommandDefinition commandDefinition = null; + for (int i = 0; i < commandList.size(); i++) { + SqlCommandDefinition item = commandList.get(i); + String commandType = item.getCommandType(); + if (CommandConsTant.WHEN.equals(commandType)) { + MyWhenProperties properties = (MyWhenProperties) item.getProperties(); + String test = properties.getTest(); + if (StrUtil.isBlank(test)) { + throw new CustomerException("when command attribute of test can not blank!"); + } + Map tempMap = ParseSqlUtil.PARSE_TEMP_PARAM_LOCALE.get(); + Map param = ParseSqlUtil.PARSE_PARAM_LOCALE.get(); + if (Objects.isNull(param)) { + return null; + } + if (!Objects.isNull(tempMap)) { + param.putAll(tempMap); + } + boolean flag = (boolean) ScriptUtil.invokeScript(test, param); + if (flag) { + commandDefinition = item; + break; + } + } else { + commandDefinition = item; + } + } + if (Objects.isNull(commandDefinition)) { + return null; + } + CommandExecutor commandExecutor = new CommandExecutor(); + return commandExecutor.executor(commandDefinition); + } +} diff --git a/src/test/java/youhong/ai/mymapper/command/commandImpl/MyForCommand.java b/src/test/java/youhong/ai/mymapper/command/commandImpl/MyForCommand.java index 834dbea..a855ea4 100644 --- a/src/test/java/youhong/ai/mymapper/command/commandImpl/MyForCommand.java +++ b/src/test/java/youhong/ai/mymapper/command/commandImpl/MyForCommand.java @@ -2,6 +2,7 @@ package youhong.ai.mymapper.command.commandImpl; import aiyh.utils.Util; import aiyh.utils.excention.CustomerException; +import aiyh.utils.tool.cn.hutool.core.collection.CollectionUtil; import org.apache.commons.lang.StringUtils; import weaver.common.util.string.StringUtil; import youhong.ai.mymapper.command.ISqlCommand; @@ -186,22 +187,40 @@ public class MyForCommand implements ISqlCommand { return null; } StringBuilder sqlBuilder = new StringBuilder(); - String open = properties.getOpen(); - String close = properties.getClose(); - String separator = properties.getSeparator(); + String open = properties.getOpen() == null ? "" : properties.getOpen(); + String close = properties.getClose() == null ? "" : properties.getClose(); + String separator = properties.getSeparator() == null ? "" : properties.getSeparator(); sqlBuilder.append(open); int i = 0; + boolean hasTemp = false; for (Map.Entry entry : map.entrySet()) { Map tempParam = new HashMap<>(); tempParam.put(itemName, entry.getValue()); tempParam.put(indexName, entry.getKey()); - ParseSqlUtil.PARSE_TEMP_PARAM_LOCALE.set(tempParam); + Map tempParamLocale = ParseSqlUtil.PARSE_TEMP_PARAM_LOCALE.get(); + if (CollectionUtil.isEmpty(tempParamLocale)) { + ParseSqlUtil.PARSE_TEMP_PARAM_LOCALE.set(tempParam); + } else { + hasTemp = true; + for (Map.Entry tempEntry : tempParamLocale.entrySet()) { + if (tempParam.containsKey(tempEntry.getKey())) { + throw new CustomerException(Util.logStr("The variable of {} has been declared and cannot be declared again", tempEntry.getKey())); + } + } + tempParamLocale.putAll(tempParam); + } String parse = parseSqlUtil.parse(properties.getCommandContent()); - sqlBuilder.append(" ").append(parse); + sqlBuilder.append(" ").append(parse).append(" "); if (i < map.size() - 1) { sqlBuilder.append(separator); } - ParseSqlUtil.PARSE_TEMP_PARAM_LOCALE.remove(); + if (!hasTemp) { + ParseSqlUtil.PARSE_TEMP_PARAM_LOCALE.remove(); + } else { + for (Map.Entry tempEntry : tempParam.entrySet()) { + tempParamLocale.remove(tempEntry.getKey()); + } + } } sqlBuilder.append(close); return sqlBuilder.toString(); diff --git a/src/test/java/youhong/ai/mymapper/command/commandImpl/MyOtherwiseCommand.java b/src/test/java/youhong/ai/mymapper/command/commandImpl/MyOtherwiseCommand.java new file mode 100644 index 0000000..07ce388 --- /dev/null +++ b/src/test/java/youhong/ai/mymapper/command/commandImpl/MyOtherwiseCommand.java @@ -0,0 +1,27 @@ +package youhong.ai.mymapper.command.commandImpl; + +import youhong.ai.mymapper.command.ISqlCommand; +import youhong.ai.mymapper.command.annotation.SqlCommand; +import youhong.ai.mymapper.command.constant.CommandConsTant; +import youhong.ai.mymapper.command.entity.SqlCommandDefinition; +import youhong.ai.mymapper.command.properties.MyOtherwiseProperties; +import youhong.ai.mymapper.util.ParseSqlUtil; + +/** + *

otherwise 指令

+ * + *

create: 2023/3/15 09:24

+ * + * @author youHong.ai + */ + +@SqlCommand(CommandConsTant.OTHERWISE) +public class MyOtherwiseCommand implements ISqlCommand { + + @Override + public String execute(SqlCommandDefinition sqlCommandDefinition) { + MyOtherwiseProperties properties = (MyOtherwiseProperties) sqlCommandDefinition.getProperties(); + ParseSqlUtil parseSqlUtil = new ParseSqlUtil(); + return parseSqlUtil.parse(properties.getCommandContent()); + } +} diff --git a/src/test/java/youhong/ai/mymapper/command/commandImpl/MyWhenCommand.java b/src/test/java/youhong/ai/mymapper/command/commandImpl/MyWhenCommand.java new file mode 100644 index 0000000..017fdb0 --- /dev/null +++ b/src/test/java/youhong/ai/mymapper/command/commandImpl/MyWhenCommand.java @@ -0,0 +1,25 @@ +package youhong.ai.mymapper.command.commandImpl; + +import youhong.ai.mymapper.command.ISqlCommand; +import youhong.ai.mymapper.command.annotation.SqlCommand; +import youhong.ai.mymapper.command.constant.CommandConsTant; +import youhong.ai.mymapper.command.entity.SqlCommandDefinition; +import youhong.ai.mymapper.command.properties.MyWhenProperties; +import youhong.ai.mymapper.util.ParseSqlUtil; + +/** + *

when 指令

+ * + *

create: 2023/3/15 09:24

+ * + * @author youHong.ai + */ +@SqlCommand(CommandConsTant.WHEN) +public class MyWhenCommand implements ISqlCommand { + @Override + public String execute(SqlCommandDefinition sqlCommandDefinition) { + MyWhenProperties properties = (MyWhenProperties) sqlCommandDefinition.getProperties(); + ParseSqlUtil parseSqlUtil = new ParseSqlUtil(); + return parseSqlUtil.parse(properties.getCommandContent()); + } +} diff --git a/src/test/java/youhong/ai/mymapper/command/constant/CommandConsTant.java b/src/test/java/youhong/ai/mymapper/command/constant/CommandConsTant.java index 8044b79..27c0979 100644 --- a/src/test/java/youhong/ai/mymapper/command/constant/CommandConsTant.java +++ b/src/test/java/youhong/ai/mymapper/command/constant/CommandConsTant.java @@ -42,5 +42,8 @@ public class CommandConsTant { public static final String IF = "if"; public static final String TRIM = "trim"; - public static final String TEST = "@{"; + public static final String CHOOSE = "choose"; + public static final String WHEN = "when"; + public static final String OTHERWISE = "otherwise"; + public static final String BIND = "bind"; } diff --git a/src/test/java/youhong/ai/mymapper/command/properties/MyBindProperties.java b/src/test/java/youhong/ai/mymapper/command/properties/MyBindProperties.java new file mode 100644 index 0000000..3d6ad7f --- /dev/null +++ b/src/test/java/youhong/ai/mymapper/command/properties/MyBindProperties.java @@ -0,0 +1,25 @@ +package youhong.ai.mymapper.command.properties; + +import lombok.Getter; +import lombok.Setter; +import lombok.ToString; + +/** + *

bind指令参数

+ * + *

create: 2023/3/15 12:10

+ * + * @author youHong.ai + */ +@Getter +@Setter +@ToString +public class MyBindProperties extends AbstractCommandProperties { + + /** 名字 */ + private String name; + + /** 绑定vale */ + private String value; + +} diff --git a/src/test/java/youhong/ai/mymapper/command/properties/MyChooseProperties.java b/src/test/java/youhong/ai/mymapper/command/properties/MyChooseProperties.java new file mode 100644 index 0000000..5782c19 --- /dev/null +++ b/src/test/java/youhong/ai/mymapper/command/properties/MyChooseProperties.java @@ -0,0 +1,18 @@ +package youhong.ai.mymapper.command.properties; + +import lombok.Getter; +import lombok.Setter; +import lombok.ToString; + +/** + *

+ * + *

create: 2023/3/15 10:10

+ * + * @author youHong.ai + */ +@Getter +@Setter +@ToString +public class MyChooseProperties extends AbstractCommandProperties { +} diff --git a/src/test/java/youhong/ai/mymapper/command/properties/MyOtherwiseProperties.java b/src/test/java/youhong/ai/mymapper/command/properties/MyOtherwiseProperties.java new file mode 100644 index 0000000..a920614 --- /dev/null +++ b/src/test/java/youhong/ai/mymapper/command/properties/MyOtherwiseProperties.java @@ -0,0 +1,18 @@ +package youhong.ai.mymapper.command.properties; + +import lombok.Getter; +import lombok.Setter; +import lombok.ToString; + +/** + *

+ * + *

create: 2023/3/15 10:12

+ * + * @author youHong.ai + */ +@Getter +@Setter +@ToString +public class MyOtherwiseProperties extends AbstractCommandProperties { +} diff --git a/src/test/java/youhong/ai/mymapper/command/properties/MyWhenProperties.java b/src/test/java/youhong/ai/mymapper/command/properties/MyWhenProperties.java new file mode 100644 index 0000000..852e0f9 --- /dev/null +++ b/src/test/java/youhong/ai/mymapper/command/properties/MyWhenProperties.java @@ -0,0 +1,20 @@ +package youhong.ai.mymapper.command.properties; + +import lombok.Getter; +import lombok.Setter; +import lombok.ToString; + +/** + *

+ * + *

create: 2023/3/15 10:11

+ * + * @author youHong.ai + */ +@Getter +@Setter +@ToString +public class MyWhenProperties extends AbstractCommandProperties { + /** 表达式 */ + private String test; +} diff --git a/src/test/java/youhong/ai/mymapper/util/AbstractCommandPropertiesFactory.java b/src/test/java/youhong/ai/mymapper/util/AbstractCommandPropertiesFactory.java index f80a92b..e96920c 100644 --- a/src/test/java/youhong/ai/mymapper/util/AbstractCommandPropertiesFactory.java +++ b/src/test/java/youhong/ai/mymapper/util/AbstractCommandPropertiesFactory.java @@ -15,9 +15,7 @@ import java.util.List; */ public class AbstractCommandPropertiesFactory { - @MethodRuleNo(name = CommandConsTant.WHERE, desc = "where 指令参数解析") - private AbstractCommandProperties getWhereProperties(List commandItemList) { - AbstractCommandProperties commandProperties = new MyWhereProperties(); + private AbstractCommandProperties setValue(List commandItemList, AbstractCommandProperties commandProperties) { for (int i = 1; i < commandItemList.size(); i++) { String item = commandItemList.get(i); CommandPropUtil.setValueString(commandProperties, item); @@ -25,35 +23,44 @@ public class AbstractCommandPropertiesFactory { return commandProperties; } + @MethodRuleNo(name = CommandConsTant.WHERE, desc = "where 指令参数解析") + private AbstractCommandProperties getWhereProperties(List commandItemList) { + return this.setValue(commandItemList, new MyWhereProperties()); + } + @MethodRuleNo(name = CommandConsTant.FOR, desc = "for 指令参数解析") private AbstractCommandProperties getForProperties(List commandItemList) { - AbstractCommandProperties commandProperties = new MyForProperties(); - for (int i = 1; i < commandItemList.size(); i++) { - String item = commandItemList.get(i); - CommandPropUtil.setValueString(commandProperties, item); - } - return commandProperties; + return this.setValue(commandItemList, new MyForProperties()); } @MethodRuleNo(name = CommandConsTant.IF, desc = "if 指令参数解析") private AbstractCommandProperties getIfProperties(List commandItemList) { - AbstractCommandProperties commandProperties = new MyIfProperties(); - for (int i = 1; i < commandItemList.size(); i++) { - String item = commandItemList.get(i); - CommandPropUtil.setValueString(commandProperties, item); - } - return commandProperties; + return this.setValue(commandItemList, new MyIfProperties()); } - @MethodRuleNo(name = CommandConsTant.TRIM, desc = "tirm 指令参数解析") private AbstractCommandProperties getTrimProperties(List commandItemList) { - AbstractCommandProperties commandProperties = new MyTrimProperties(); - for (int i = 1; i < commandItemList.size(); i++) { - String item = commandItemList.get(i); - CommandPropUtil.setValueString(commandProperties, item); - } - return commandProperties; + return this.setValue(commandItemList, new MyTrimProperties()); } + @MethodRuleNo(name = CommandConsTant.CHOOSE, desc = "choose 指令参数解析") + private AbstractCommandProperties getChooseProperties(List commandItemList) { + return this.setValue(commandItemList, new MyChooseProperties()); + } + + @MethodRuleNo(name = CommandConsTant.WHEN, desc = "when 指令参数解析") + private AbstractCommandProperties getWhenProperties(List commandItemList) { + return this.setValue(commandItemList, new MyWhenProperties()); + } + + @MethodRuleNo(name = CommandConsTant.OTHERWISE, desc = "otherwise 指令参数解析") + private AbstractCommandProperties getOtherwiseProperties(List commandItemList) { + return this.setValue(commandItemList, new MyOtherwiseProperties()); + } + + + @MethodRuleNo(name = CommandConsTant.BIND, desc = "bind 指令参数解析") + private AbstractCommandProperties getBindProperties(List commandItemList) { + return this.setValue(commandItemList, new MyBindProperties()); + } } diff --git a/src/test/java/youhong/ai/mymapper/util/ParamValueUtil.java b/src/test/java/youhong/ai/mymapper/util/ParamValueUtil.java index 3c46d51..32587a6 100644 --- a/src/test/java/youhong/ai/mymapper/util/ParamValueUtil.java +++ b/src/test/java/youhong/ai/mymapper/util/ParamValueUtil.java @@ -53,7 +53,7 @@ public class ParamValueUtil { sb.deleteCharAt(sb.length() - 1); return sb.toString(); } - if (o instanceof String || o instanceof Character) { + if (o instanceof CharSequence) { sb.append("'"); for (Object obj : arr) { sb.append(Util.null2String(obj).replace("'", "''")).append("','"); diff --git a/src/test/java/youhong/ai/mymapper/util/ParseSqlUtil.java b/src/test/java/youhong/ai/mymapper/util/ParseSqlUtil.java index b8af33a..8fbd58b 100644 --- a/src/test/java/youhong/ai/mymapper/util/ParseSqlUtil.java +++ b/src/test/java/youhong/ai/mymapper/util/ParseSqlUtil.java @@ -2,6 +2,7 @@ package youhong.ai.mymapper.util; import aiyh.utils.Util; import aiyh.utils.excention.CustomerException; +import aiyh.utils.tool.cn.hutool.core.util.StrUtil; import youhong.ai.mymapper.command.CommandExecutor; import youhong.ai.mymapper.command.constant.CommandConsTant; import youhong.ai.mymapper.command.entity.CommandContentDefinition; @@ -29,6 +30,13 @@ public class ParseSqlUtil { private final CommandExecutor commandExecutor = new CommandExecutor(); + /** + *

解析sql

+ * + * @param sql 需要解析的sql字符串 + * @param params sql所需要的参数 + * @return 解析后的sql数据 + */ public SqlDefinition parse(String sql, Map params) { if (!Objects.isNull(params)) { PARSE_PARAM_LOCALE.set(params); @@ -46,11 +54,19 @@ public class ParseSqlUtil { sqlDefinition.setArgs(sqlParams); SQL_PARAM_LOCALE.remove(); } + if (!Objects.isNull(PARSE_TEMP_PARAM_LOCALE.get())) { + PARSE_TEMP_PARAM_LOCALE.remove(); + } } - return sqlDefinition; } + /** + *

解析sql或sql片段

+ * + * @param sql sql + * @return 解析后sql + */ public String parse(String sql) { if (Objects.isNull(sql) || sql.isEmpty()) { throw new CustomerException("can not parse sql, sql is empty!"); @@ -64,6 +80,7 @@ public class ParseSqlUtil { for (int i = 0; i < chars.length; i++) { char c = chars[i]; if (CommandConsTant.Skip_CHAR.contains(c)) { + sqlBuilder.append(" "); continue; } if (CommandConsTant.COMMAND_PRE_FIX_MARK == c) { @@ -74,7 +91,9 @@ public class ParseSqlUtil { sqlBuilder.delete(0, sqlBuilder.length()); sqlBuilder.append(tempSql); i += CommandConsTant.COMMAND_PRE_FIX.length + 1; + // 获取sql指令定义信息 SqlCommandDefinition commandDefinition = parseCommand(chars, i); + // 获取解析后的sql String commandContent = commandDefinition.getCommandContent(); sqlBuilder.append(Objects.isNull(commandContent) ? "" : commandContent); i += commandDefinition.getCommandLength(); @@ -92,6 +111,12 @@ public class ParseSqlUtil { return simpleSql(sqlStr); } + /** + *

简化sql，去除回车table键等字符

+ * + * @param sql 需要简化的sql + * @return 简化后的sql + */ public String simpleSql(String sql) { char[] chars = sql.toCharArray(); StringBuilder sqlBuilder = new StringBuilder(); @@ -99,6 +124,7 @@ public class ParseSqlUtil { for (int i = 0; i < chars.length; i++) { char c = chars[i]; if (CommandConsTant.Skip_CHAR.contains(c)) { + sqlBuilder.append(" "); continue; } if (c == '\\') { @@ -128,6 +154,12 @@ public class ParseSqlUtil { return sqlBuilder.toString().trim(); } + /** + *

判断是否含有指令

+ * + * @param chars sql字符串char数组 + * @return 是否含有指令 + */ private boolean hasCommand(char[] chars) { for (int i = 0; i < chars.length; i++) { char c = chars[i]; @@ -138,6 +170,13 @@ public class ParseSqlUtil { return false; } + /** + *

检查是否存属于指令

+ * + * @param chars sql字符串char数组 + * @param index 开始下标 + * @return 是否属于指令 + */ private boolean checkCommand(char[] chars, int index) { if (index + CommandConsTant.COMMAND_PRE_FIX.length + 1 >= chars.length) { return false; @@ -150,13 +189,29 @@ public class ParseSqlUtil { return true; } + /** + *

解析sql指令

+ * + * @param chars sql字符串char数组 + * @param index 指令开始下标 + * @return sql指令定义信息 + */ private SqlCommandDefinition parseCommand(char[] chars, int index) { SqlCommandDefinition commandDefinition = getCommandDefinition(chars, index); + // 值执行器执行解析操作 String executor = commandExecutor.executor(commandDefinition); + // 解析后的sql设置为指令内容 commandDefinition.setCommandContent(executor); return commandDefinition; } + /** + *

获取指令定义信息

+ * + * @param chars sql字符串char数组 + * @param index 指令开始下标 + * @return 指令定义信息 + */ private SqlCommandDefinition getCommandDefinition(char[] chars, int index) { StringBuilder commandSb = new StringBuilder(); boolean isCommand = false; @@ -164,6 +219,7 @@ public class ParseSqlUtil { for (int i = index; i < chars.length; i++) { char c = chars[i]; if (CommandConsTant.Skip_CHAR.contains(c)) { + commandSb.append(" "); continue; } if (c == '\\') { @@ -190,6 +246,13 @@ public class ParseSqlUtil { return CommandUtil.createCommandProperties(command, commandContent); } + /** + *

获取指令内容

+ * + * @param chars sql字符串char数组 + * @param index 指令内容开始下标 + * @return 指令内容信息定义 + */ private CommandContentDefinition getCommandContent(char[] chars, int index) { int commandSyntaxCount = 0; StringBuilder commandContent = new StringBuilder(); @@ -198,6 +261,7 @@ public class ParseSqlUtil { char c = chars[i]; account++; if (CommandConsTant.Skip_CHAR.contains(c)) { + commandContent.append(" "); continue; } if (c == '\\') { @@ -238,6 +302,12 @@ public class ParseSqlUtil { } + /** + *

解析sql占位符，绑定值

+ * + * @param sql sql字符串 + * @return 解析后sql字符串 + */ public String parseStatement(String sql) { char[] chars = sql.toCharArray(); StringBuilder sqlBuilder = new StringBuilder(); @@ -282,21 +352,17 @@ public class ParseSqlUtil { } continue; } - if ('@' == c) { - variable = isVariable(chars, i, CommandConsTant.TEST); - if (!Objects.isNull(variable)) { - i += CommandConsTant.VARIABLE_PREPARED_STATEMENT.length() + variable.length(); - Object value = getVariableValue(variable); - sqlBuilder.append("?"); - ParseSqlUtil.SQL_PARAM_LOCALE.get().add(ParamValueUtil.getPreparedParam(value)); - } - continue; - } sqlBuilder.append(c); } return sqlBuilder.toString(); } + /** + *

获取变量的值，通过变量名

+ * + * @param variable 变量名 + * @return 变量值 + */ private Object getVariableValue(String variable) { variable = variable.trim(); Map tempMap = ParseSqlUtil.PARSE_TEMP_PARAM_LOCALE.get(); @@ -308,6 +374,14 @@ public class ParseSqlUtil { return value; } + /** + *

判断是否属于变量占位符

+ * + * @param chars sql字符串char数组 + * @param startIndex 开始下标 + * @param variablePrefix 变量前缀 + * @return 变量名称 + */ private String isVariable(char[] chars, int startIndex, String variablePrefix) { char[] prefix = variablePrefix.toCharArray(); StringBuilder sb = new StringBuilder(); @@ -336,4 +410,36 @@ public class ParseSqlUtil { } return null; } + + + /** + *

获取所有指令

+ * + * @param sql + * @return + */ + public List getCommandList(String sql) { + if (StrUtil.isBlank(sql)) { + return null; + } + List result = new ArrayList<>(); + char[] chars = sql.toCharArray(); + for (int i = 0; i < chars.length; i++) { + char c = chars[i]; + if (CommandConsTant.Skip_CHAR.contains(c)) { + continue; + } + if (CommandConsTant.COMMAND_PRE_FIX_MARK == c) { + boolean isCommand = checkCommand(chars, i); + if (isCommand) { + i += CommandConsTant.COMMAND_PRE_FIX.length + 1; + // 获取sql指令定义信息 + SqlCommandDefinition commandDefinition = getCommandDefinition(chars, i); + result.add(commandDefinition); + i += commandDefinition.getCommandLength(); + } + } + } + return result; + } } diff --git a/src/test/java/youhong/ai/pcn/UtilTest.java b/src/test/java/youhong/ai/pcn/UtilTest.java index 2bc3940..f7af5c0 100644 --- a/src/test/java/youhong/ai/pcn/UtilTest.java +++ b/src/test/java/youhong/ai/pcn/UtilTest.java @@ -5,9 +5,14 @@ import aiyh.utils.Util; import aiyh.utils.tool.org.apache.commons.jexl3.*; import basetest.BaseTest; import com.alibaba.fastjson.JSON; +import com.api.youhong.ai.jitu.hrmlogintip.service.HrmLoinTipService; import ebu7common.youhong.ai.bean.Builder; import org.apache.log4j.Logger; import org.junit.Test; +import weaver.general.BaseBean; +import weaver.hrm.User; +import weaver.rsa.security.RSA; +import weaver.sm.SM4Utils; import weaver.workflow.msg.MsgPushUtil; import weaver.workflow.msg.entity.MsgEntity; import weaver.workflow.msg.entity.MsgOperateType; @@ -17,12 +22,16 @@ import weaver.youhong.ai.haripijiu.action.sapdocking.config.util.ValueRuleMethod import weaver.youhong.ai.haripijiu.action.sapdocking.service.VoucherPayableService; import weaver.youhong.ai.pcn.actioin.sendemail.SendEmailToExternalPersonnelAction; import youhong.ai.pcn.mapper.TransTestMapper; +import youhong.ai.pcn.pojo.ConfigCache; import youhong.ai.pcn.pojo.Student; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.HashMap; -import java.util.List; +import java.lang.reflect.Constructor; +import java.lang.reflect.InvocationTargetException; +import java.util.*; + +import static com.alibaba.fastjson.JSON.parseObject; +import static com.alibaba.fastjson.JSON.toJSONString; +import static java.lang.System.out; /** *

测试

@@ -43,16 +52,16 @@ public class UtilTest extends BaseTest { .with(Student::setAge, 10) .with(Student::setSex, 1).build(); boolean b = transMapper.insertStudent(student); - System.out.println(b); + out.println(b); // boolean b1 = Util.rollbackTransMapper(TransTestMapper.class); - System.out.println(Util.commitTransMapper(TransTestMapper.class)); + out.println(Util.commitTransMapper(TransTestMapper.class)); } @Test public void test1() { - System.out.println(ValueRuleMethod.VALUE_RULE_FUNCTION.get(0).apply( + out.println(ValueRuleMethod.VALUE_RULE_FUNCTION.get(0).apply( Builder.builder(SapConfigDetail::new) .with(SapConfigDetail::setCustomerValue, "哈哈哈") .build(), new HashMap<>())); @@ -62,8 +71,8 @@ public class UtilTest extends BaseTest { @Test public void test2() { VoucherPayableService voucherPayableService = new VoucherPayableService(); - System.out.println(voucherPayableService.sendSapVoucher("testVoucher", "57058", "formtable_main_20")); - System.out.println(voucherPayableService.sendReceiptVoucher("testPayment", "57058", "formtable_main_20")); + out.println(voucherPayableService.sendSapVoucher("testVoucher", "57058", "formtable_main_20")); + out.println(voucherPayableService.sendReceiptVoucher("testPayment", "57058", "formtable_main_20")); } @@ -86,14 +95,14 @@ public class UtilTest extends BaseTest { @Test public void testResUtil() { TransTestMapper mapper = Util.getMapper(TransTestMapper.class); - System.out.println(mapper.selectStudent()); + out.println(mapper.selectStudent()); } @Test public void testC() { String uploadSapFileCharset = Util.getCusConfigDefaultValue("UPLOAD_SAP_FILE_CHARSET", "UTF-8"); - System.out.println(uploadSapFileCharset); + out.println(uploadSapFileCharset); } @@ -125,7 +134,7 @@ public class UtilTest extends BaseTest { List operateMsg = manager.getOperateMsg("1213", MsgOperateType.OTHER); operateMsg.get(2).getCurrentOperatorIdMap().put("111", "2700"); operateMsg.get(2).getUserId().add("111"); - System.out.println(JSON.toJSONString(operateMsg)); + out.println(toJSONString(operateMsg)); new MsgPushUtil().pushMsg(operateMsg); @@ -162,9 +171,9 @@ public class UtilTest extends BaseTest { @Test public void testChar() { - System.out.println('\n'); - System.out.println('\t'); - System.out.println(' '); + out.println('\n'); + out.println('\t'); + out.println(' '); Logger logger = Util.getLogger(); logger.info("哈哈哈哈哈舒服哈我是不是在控制台我擦！"); } @@ -187,7 +196,66 @@ public class UtilTest extends BaseTest { jc.set("array", new ArrayList<>()); JexlExpression expression = jexl.createExpression("test.split(',')"); Object result = expression.evaluate(jc); - System.out.println(Arrays.toString((Object[]) result)); + out.println(Arrays.toString((Object[]) result)); } + + + @Test + public void testFs() throws NoSuchMethodException, ClassNotFoundException, InvocationTargetException, InstantiationException, IllegalAccessException { + String name = ConfigCache.class.getName(); + // String innerClassName = name + "$" + "CacheHolder"; + // Class aClass = Class.forName(innerClassName); + Class aClass = Class.forName(name); + Constructor declaredConstructor = aClass.getDeclaredConstructor(); + declaredConstructor.setAccessible(true); + Object o = declaredConstructor.newInstance(); + out.println(ConfigCache.getInstance().equals(o)); + out.println(o); + out.println(ConfigCache.getInstance()); + } + + + @Test + public void testPar() { + String str = "eyJ1c2VyIjoiYWl5aCIsInBhc3N3b3JkIjoiMzU1ZmY5OWQzYzQ1NDUwZTFmY2RlNjhjNDEyODdmZWZfcmFuZG9tXyJ9"; + byte[] decode = Base64.getDecoder().decode(str.getBytes()); + String json = new String(decode); + out.println(json); + out.println(parseObject(json)); + } + + + @Test + public void testpas() { + RSA rsa = new RSA(); + String decrypt = rsa.decrypt("ft7H5R132V+3EnunzdSR6zqyGMJdOzN0ZFk2Nhhoif98tceYVnFe9JgNCP07I6/vTzGvNlbxeGSOm+9urOHCqAhjKF/RTuR6VkaVYwbBCFrOzUwAvAGGtz37dOxnKYqPm4rCma3AEDzfjWpHHv7gQqYE1bkD/k8BC8KfEqX9fViVNaaQPnsK0LyZuotvCIxrR1FEijlp9CgxCKo0oP9lAVfg0rC6Nd8nXZXV7/ecNulnx4vr66bpKuV+KlIeKQrl9bjYMrfIQbeq+48yj+LnWwsnWpXvT2ON6q6KOq2UxT/HZEVgc1e4ilq3epsXIhOMA3jFfe9ByorE8aRE4VW+6Q==``RSA``"); + out.println(decrypt); + SM4Utils sm4 = new SM4Utils(); + BaseBean bb = new BaseBean(); + String key = weaver.general.Util.null2String(bb.getPropValue("weaver_client_pwd", "key")); + if (!"".equals(key)) { + decrypt = decrypt.substring(0, decrypt.lastIndexOf("_random_")); + decrypt = sm4.decrypt(decrypt, key); + } + out.println(decrypt); + } + + + @Test + public void testdoc() { + System.out.println(JSON.toJSONString(Util.selectImageInfoByDocIds("9,10,11,12,13,14,15"))); + } + + + @Test + public void teseNotRead() { + HrmLoinTipService hrmLoinTipService = new HrmLoinTipService(); + out.println(toJSONString(hrmLoinTipService.getNotReadDocId(new User(90)))); + } + + + @Test + public void testOaNum() { + } } diff --git a/src/test/java/youhong/ai/pcn/pojo/ConfigCache.java b/src/test/java/youhong/ai/pcn/pojo/ConfigCache.java new file mode 100644 index 0000000..05cdd31 --- /dev/null +++ b/src/test/java/youhong/ai/pcn/pojo/ConfigCache.java @@ -0,0 +1,27 @@ +package youhong.ai.pcn.pojo; + +public class ConfigCache { + private ConfigCache() { + StackTraceElement[] trace = Thread.currentThread().getStackTrace(); + if (trace.length >= 3) { + if (trace[2].toString().startsWith("sun.reflect.NativeConstructorAccessorImpl")) { + throw new RuntimeException("This class does not provide constructors!"); + } + } + } + + + public final String test = "alsdjfalsfj"; + + public static ConfigCache getInstance() { + return CacheHolder.configCache; + } + + private static class CacheHolder { + private static final ConfigCache configCache = new ConfigCache(); + + private CacheHolder() { + // throw new RuntimeException("This class does not provide constructors!"); + } + } +} \ No newline at end of file diff --git a/src/test/java/youhong/ai/taibao/TestTaiBao.java b/src/test/java/youhong/ai/taibao/TestTaiBao.java new file mode 100644 index 0000000..4070bf1 --- /dev/null +++ b/src/test/java/youhong/ai/taibao/TestTaiBao.java @@ -0,0 +1,155 @@ +package youhong.ai.taibao; + +import basetest.BaseTest; +import com.alibaba.fastjson.JSON; +import com.alibaba.fastjson.JSONArray; +import com.api.youhong.ai.taibao.fcuntionlist.service.FunctionListService; +import com.api.youhong.ai.taibao.qikan.service.PeriodicalService; +import com.cloudstore.dev.api.util.Util_DataCache; +import org.junit.Test; +import weaver.conn.RecordSet; +import weaver.general.BaseBean; +import weaver.general.Util; +import weaver.hrm.User; +import weaver.workflow.request.todo.OfsSettingObject; +import weaver.workflow.request.todo.RequestUtil; +import weaver.workflow.webservices.WorkflowBaseInfo; +import weaver.workflow.webservices.WorkflowRequestInfo; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + *

测试

+ * + *

create: 2023/3/10 00:13

+ * + * @author youHong.ai + */ +public class TestTaiBao extends BaseTest { + + + @Test + public void test() { + FunctionListService functionListService = new FunctionListService(); + System.out.println(JSON.toJSONString(functionListService.getFunctionList(new User(90)))); + } + + + @Test + public void testP() { + PeriodicalService periodicalService = new PeriodicalService(); + System.out.println(JSON.toJSONString(periodicalService.getPeriodicalInfo())); + } + + @Test + public void testPoint() { + System.out.println(this.getOAAndOthenTodoCount(new User(1))); + } + + public int getOAAndOthenTodoCount(User user) { + int qtdbCount = 0; + BaseBean baseBean = new BaseBean(); + String logindid = user.getLoginid(); + int userid = user.getUID(); + if (userid == -1) { + return 0; + } else { + RecordSet rs = new RecordSet(); + rs.executeQuery("select count(*) from uf_tbtydb where status = 0 and systemid in (select systemid from uf_tbtydbxtmc where pckq is null or pckq=0) and p13loginid=?", logindid); + if (rs.next()) { + qtdbCount = Util.getIntValue(rs.getString(1)); + baseBean.writeLog("getOAAndOthenTodoCount,qtdbCount:" + qtdbCount); + } + + baseBean.writeLog("getOAAndOthenTodoCount,userid:" + userid); + String oaredisKey = "weaver_wftodo" + userid; + baseBean.writeLog("oaredisKey:" + oaredisKey); + Object datas = Util_DataCache.getObjValWithRedis(oaredisKey); + int lcdbCount; + if (datas == null) { + List list = this.getToDoWorkflowRequestCount(userid + ""); + + try { + Util_DataCache.setObjValWithRedis(oaredisKey, list); + } catch (IOException e) { + baseBean.writeLog(e); + } + lcdbCount = list.size(); + } else { + String str = JSON.toJSONString(datas); + JSONArray jsonArray = JSONArray.parseArray(str); + lcdbCount = jsonArray.size(); + } + baseBean.writeLog("getOAAndOthenTodoCount,lcdbCount:" + lcdbCount); + int total = qtdbCount + lcdbCount; + baseBean.writeLog("getOAAndOthenTodoCount,total:" + total); + return qtdbCount + lcdbCount; + } + } + + public List getToDoWorkflowRequestCount(String operators) { + RequestUtil ru = new RequestUtil(); + OfsSettingObject oso = ru.getOfsSetting(); + RecordSet rs = new RecordSet(); + List wfrequestlist = new ArrayList<>(); + try { + String remark = "'1','5','7','8','9','11'"; + String select = " select distinct "; + String fields = " t2.userid ,t2.workflowid,t2.requestid ,t2.isremark , t2.viewtype, 0 as sysid , '0' as syscode"; + String from = " from workflow_currentoperator t2 ,workflow_requestbase t1 "; + String where = " where t2.requestid = t1.requestid and t2.usertype = 0 "; + if (!operators.equals("")) { + where = where + " and t2.userid in(" + operators + ")"; + } + where = where + " and ((t2.isremark=0 and (t2.takisremark is null or t2.takisremark=0 )) or t2.isremark in(" + remark + ")) and t2.islasttimes=1 "; + where = where + " and t2.workflowID in(select id from workflow_base where isvalid in('1','3') and workflowtype<>1 ) "; + String sql = select + fields + from + where; + rs.executeQuery(sql); + String fields_os; + String from_os; + String sqlwhere_os; + String workflowid; + String requestid; + while (rs.next()) { + sqlwhere_os = Util.null2String(rs.getString("requestid")); + workflowid = Util.null2String(rs.getString("syscode")); + requestid = Util.null2String(rs.getString("isremark")); + WorkflowRequestInfo wfrequestinfo = new WorkflowRequestInfo(); + wfrequestinfo.setRequestId(sqlwhere_os); + wfrequestinfo.setRequestId(requestid); + WorkflowBaseInfo workflowBaseInfo = new WorkflowBaseInfo(); + workflowBaseInfo.setWorkflowId(workflowid); + wfrequestinfo.setWorkflowBaseInfo(workflowBaseInfo); + wfrequestlist.add(wfrequestinfo); + } + if (oso != null && oso.getIsuse() == 1) { + fields_os = " t1.userid,t1.workflowid,t1.requestid,t1.isremark,t1.viewtype,t1.sysid,t1.syscode "; + from_os = " from ofs_todo_data t1 "; + sqlwhere_os = " where islasttimes=1 and isremark='0' "; + if (!operators.equals("")) { + sqlwhere_os = sqlwhere_os + " and userid in ( " + operators + ")"; + } + + sql = " select distinct " + fields_os + from_os + sqlwhere_os; + rs.executeQuery(sql); + + while (rs.next()) { + workflowid = Util.null2String(rs.getString("workflowid")); + requestid = Util.null2String(rs.getString("requestid")); + WorkflowRequestInfo wfrequestinfo = new WorkflowRequestInfo(); + wfrequestinfo.setRequestId(requestid); + WorkflowBaseInfo workflowBaseInfo = new WorkflowBaseInfo(); + workflowBaseInfo.setWorkflowId(workflowid); + wfrequestinfo.setWorkflowBaseInfo(workflowBaseInfo); + wfrequestlist.add(wfrequestinfo); + } + } + } catch (Exception e) { + e.printStackTrace(); + } + + return wfrequestlist; + } +} diff --git a/src/test/java/youhong/ai/yihong/YiHongTest.java b/src/test/java/youhong/ai/yihong/YiHongTest.java new file mode 100644 index 0000000..4539fa9 --- /dev/null +++ b/src/test/java/youhong/ai/yihong/YiHongTest.java @@ -0,0 +1,26 @@ +package youhong.ai.yihong; + +import aiyh.utils.Util; +import basetest.BaseTest; +import com.alibaba.fastjson.JSON; +import org.junit.Test; +import weaver.youhong.ai.yihong.formmode.stagediagram.mapper.ModeExpandSaveActionMapper; +import weaver.youhong.ai.yihong.formmode.stagediagram.pojo.StageUpdateFieldConfig; + +/** + *

屹宏测试

+ * + *

create: 2023/3/14 18:31

+ * + * @author youHong.ai + */ +public class YiHongTest extends BaseTest { + + + @Test + public void testSelectMapper() { + ModeExpandSaveActionMapper mapper = Util.getMapper(ModeExpandSaveActionMapper.class); + StageUpdateFieldConfig testWrite = mapper.selectConfigUpdate("test_write"); + System.out.println(JSON.toJSONString(testWrite)); + } +} diff --git a/常用信息.md b/常用信息.md index 2d95acb..9d52a87 100644 --- a/常用信息.md +++ b/常用信息.md @@ -230,269 +230,9 @@ function loadJs(url, callback) { mysqldump -uroot -p'passowrd' --single-transaction -ApiResult -E --databases ecology_dev> /tmp/ecology_dev_back.sql ``` -**mysql常用视图** +### 常用视图 -```sql --- 流程类型视图，可用于数据集成或流览按钮 -create -or replace view workflow_type_info_view as -select wb.id, - wb.workflowname, - wt.typename, - wb.workflowdesc, - (IF(wb.version is null, 1, wb.version)) version -from workflow_base wb - RIGHT JOIN workflow_type wt on wb.workflowtype = wt.id; - --- 流程表单视图，用于流览按钮或数据集成，配置流程类型表可以用字段联动获取流程表表名 -create -or replace view workflow_table_view as -select base.id, - base.workflowname, - base.formid, - bill.tablename, - (IF(base.version is null, 1, base.version)) version -from workflow_bill bill - join workflow_base base on base.formid = bill.id; - --- 流程明细表信息，可用流程主表查询对应的明细表信息，用于流览框 -create -or replace view workflow_detail_table_view as -select CONCAT(bill.id, '-', base.id) id, - bill.id bill_id, - base.id workflow_id, - base.workflowname, - base.formid main_formid, - bill.tablename -from workflow_billdetailtable bill - join workflow_base base on base.formid = bill.billid; - --- 流程和建模字段视图，更具流程和建模的billid可以查询流程和建模中的字段信息 -create -or replace view workflow_field_table_view as -select wb.id, - wb.fieldname, - concat(ht.indexdesc, '：', wb.fieldname) indexdesc, - ( - case - when wb.detailtable is null then (select distinct tablename from workflow_bill where id = wb.billid) - when wb.detailtable = '' - then (select distinct tablename from workflow_bill where id = wb.billid) - else wb.detailtable - end - ) tablename, - billid, - ( - case - when wb.detailtable = '' then 'main table' - when wb.detailtable is null then 'main table' - else wb.detailtable end - ) showtablename, - (case - when wb.fieldhtmltype = '1' then '单行文本框' - when wb.FIELDHTMLTYPE = '2' then '多行文本框' - when wb.FIELDHTMLTYPE = '3' then '流览框' - when wb.FIELDHTMLTYPE = '4' then 'check框' - when wb.FIELDHTMLTYPE = '5' then '选择框' - else '附件上传' end) fieldhtmltype -from workflow_billfield wb - left join htmllabelindex ht on wb.fieldlabel = ht.id; - --- 建模表信息视图 -create -or replace view mode_bill_info_view as -select bill.id, bill.tablename, hti.indexdesc -from workflow_bill bill - left join htmllabelindex hti on hti.id = bill.namelabel -where bill.id < 0 - and bill.tablename like 'uf%'; - --- 流程节点信息视图 -create -or replace view workflow_node_info_view as -select distinct nb.id, - nb.nodename, - (case when wb.version is null then 1 else wb.version end) version, - fn.workflowid -from workflow_nodebase nb - left join workflow_flownode fn on nb.id = fn.nodeid - left join workflow_base wb on wb.id = fn.workflowid; - -``` - -**oracle常用视图，与mysql对应** - -```sql -create -or replace view workflow_type_info_view as -select wb.id, - wb.workflowname, - wt.typename, - wb.workflowdesc, - (IF(wb.version is null, 1, wb.version)) version -from workflow_base wb - RIGHT JOIN workflow_type wt on wb.workflowtype = wt.id - / - -create -or replace view workflow_table_view as -select base.id, - base.workflowname, - base.formid, - bill.tablename, - (IF(base.version is null, 1, base.version)) version -from workflow_bill bill - join workflow_base base on base.formid = bill.id - / - -create -or replace view workflow_detail_table_view as -select (bill.id || '-' || base.id) id, - bill.id bill_id, - base.id workflow_id, - base.workflowname, - base.formid main_formid, - bill.tablename -from workflow_billdetailtable bill - join workflow_base base on base.formid = bill.billid - / - - -create -or replace view workflow_field_table_view as -select wb.id, - wb.fieldname, - (ht.indexdesc || '：' || wb.fieldname) indexdesc, - ( - case - when wb.detailtable is null then (select distinct tablename from workflow_bill where id = wb.billid) - when wb.detailtable = '' - then (select distinct tablename from workflow_bill where id = wb.billid) - else wb.detailtable - end - ) tablename, - billid, - ( - case - when wb.detailtable = '' then 'main table' - when wb.detailtable is null then 'main table' - else wb.detailtable end - ) showtablename, - (case - when wb.fieldhtmltype = '1' then '单行文本框' - when wb.FIELDHTMLTYPE = '2' then '多行文本框' - when wb.FIELDHTMLTYPE = '3' then '流览框' - when wb.FIELDHTMLTYPE = '4' then 'check框' - when wb.FIELDHTMLTYPE = '5' then '选择框' - else '附件上传' end) fieldhtmltype -from workflow_billfield wb - left join htmllabelindex ht on wb.fieldlabel = ht.id - / - -create -or replace view mode_bill_info_view as -select bill.id, bill.tablename, hti.indexdesc -from workflow_bill bill - left join htmllabelindex hti on hti.id = bill.namelabel -where bill.id < 0 - and bill.tablename like 'uf%' - / - -create -or replace view workflow_node_info_view as -select distinct nb.id, - nb.nodename, - (case when wb.version is null then 1 else wb.version end) version, - fn.workflowid -from workflow_nodebase nb - left join workflow_flownode fn on nb.id = fn.nodeid - left join workflow_base wb on wb.id = fn.workflowid - / - -``` - -**sqlserver常用视图，与mysql对应** - -```sql -create view workflow_type_info_view as -select wb.id, - wb.workflowname, - wt.typename, - wb.workflowdesc, - ( - IF(wb.version is null, 1, wb.version)) version -from workflow_base wb - RIGHT JOIN workflow_type wt on wb.workflowtype = wt.id; - -create -or replace view workflow_table_view as -select base.id, - base.workflowname, - base.formid, - bill.tablename, - ( - IF(base.version is null, 1, base.version)) version -from workflow_bill bill - join workflow_base base on base.formid = bill.id; - -create -or replace view workflow_detail_table_view as -select (bill.id + '-' + base.id) id, - bill.id bill_id, - base.id workflow_id, - base.workflowname, - base.formid main_formid, - bill.tablename -from workflow_billdetailtable bill - join workflow_base base on base.formid = bill.billid; - - -create view workflow_field_table_view as -select wb.id, - wb.fieldname, - (ht.indexdesc + '：' + wb.fieldname) indexdesc, - ( - case - when wb.detailtable is null then (select distinct tablename from workflow_bill where id = wb.billid) - when wb.detailtable = '' - then (select distinct tablename from workflow_bill where id = wb.billid) - else wb.detailtable - end - ) tablename, - billid, - ( - case - when wb.detailtable = '' then 'main table' - when wb.detailtable is null then 'main table' - else wb.detailtable end - ) showtablename, - (case - when wb.fieldhtmltype = '1' then '单行文本框' - when wb.FIELDHTMLTYPE = '2' then '多行文本框' - when wb.FIELDHTMLTYPE = '3' then '流览框' - when wb.FIELDHTMLTYPE = '4' then 'check框' - when wb.FIELDHTMLTYPE = '5' then '选择框' - else '附件上传' end) fieldhtmltype -from workflow_billfield wb - left join htmllabelindex ht on wb.fieldlabel = ht.id; - -create view mode_bill_info_view as -select bill.id, bill.tablename, hti.indexdesc -from workflow_bill bill - left join htmllabelindex hti on hti.id = bill.namelabel -where bill.id < 0 - and bill.tablename like 'uf%'; - -create view workflow_node_info_view as -select distinct nb.id, - nb.nodename, - (case when wb.version is null then 1 else wb.version end) version, - fn.workflowid -from workflow_nodebase nb - left join workflow_flownode fn on nb.id = fn.nodeid - left join workflow_base wb on wb.id = fn.workflowid; - -``` +请查询查看项目根目录下的相关视图文件 ### 后端 diff --git a/常用命令.md b/常用命令.md new file mode 100644 index 0000000..30107e9 --- /dev/null +++ b/常用命令.md @@ -0,0 +1,6 @@ +# 常用的命令 +### 1.打有宏utils jar包 +```text +cd target/classes/ +jar -cvf aiyh_utils.jar aiyh +``` \ No newline at end of file