diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..261eeb9e9f8b2b4b0d119366dda99c6fd7d35c64 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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 + + http://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. diff --git a/README.md b/README.md index 9d2fee2404ddf615409b3040ae0712572ee7dc94..a40c2b39fe2cdc2df4bef5a81cfc95738956d157 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,109 @@ # spring-boot-starter-slf4j #### 介绍 -一个注解搞定日志 +一个注解搞定日志,减少到处编写日志的烦恼 #### 软件架构 -软件架构说明 +依赖spring-boot-starter-aop +#### 原理说明 +AOP + Reflect + +#### 作用范围 +1. 由**spring管理**的类 +2. 由**外部调用**的**public类型**方法 #### 安装教程 -1. xxxx -2. xxxx -3. xxxx +``` + + wiki.xsx + spring-boot-starter-slf4j + 1.0.0 + +``` #### 使用说明 -1. xxxx -2. xxxx -3. xxxx +##### 准备工作 +1. 添加依赖: + +``` + + wiki.xsx + spring-boot-starter-slf4j + 1.0.0 + +``` +2. 开启日志: + +yml方式: + +``` +logging: + level: + wiki.xsx.log: 对应级别 +``` +properties方式: + +``` +logging.level.wiki.xsx.log: 对应级别 +``` + +##### 开始使用 + +例如: +``` +@Service +public class TestService { + + @ParamLog("test1") + public void test1() {} + + @ResultLog("test2") + public void test2(String name) {} + + @ThrowingLog("test3") + public void test3(String name, int id) {} + + @Log("test4") + public void test4(String name, int ...id) {} +} +``` -#### 参与贡献 +方法调用: +``` +@SpringBootApplication +public class DemoApplication { + public static void main(String[] args) { + ConfigurableApplicationContext context = SpringApplication.run(DemoApplication.class, args); + TestService bean = context.getBean(TestService.class); + bean.test1(); + bean.test2("xsx"); + bean.test3("xsx`", 1); + bean.test4("xsx2", 1, 2, 3, 4); + } +} +``` -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +打印效果: +``` +2019-06-20 00:53:32.390 DEBUG 7932 --- [ main] wiki.xsx.core.log.LogProcessor : 调用方法:【com.example.demo.service.TestService.test1(TestService.java:19)】,业务名称:【test1】,接收参数:【{}】 +2019-06-20 00:53:32.405 DEBUG 7932 --- [ main] wiki.xsx.core.log.LogProcessor : 调用方法:【com.example.demo.service.TestService.test2(TestService.java:22)】,业务名称:【test2】,返回结果:【null】 +2019-06-20 00:53:32.412 DEBUG 7932 --- [ main] wiki.xsx.core.log.LogProcessor : 调用方法:【com.example.demo.service.TestService.test4(TestService.java:28)】,业务名称:【test4】,接收参数:【{name=xsx2, id=[1, 2, 3, 4]}】 +2019-06-20 00:53:32.413 DEBUG 7932 --- [ main] wiki.xsx.core.log.LogProcessor : 调用方法:【com.example.demo.service.TestService.test4(TestService.java:28)】,业务名称:【test4】,返回结果:【null】 +``` +#### 其他说明 -#### 码云特技 +##### 日志级别 +1. DEBUG(默认): 调试级别 +2. INFO: 信息级别 +3. WARN: 警告级别 +4. ERROR: 错误级别 -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目,是码云综合评定出的优秀开源项目 -5. 码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) \ No newline at end of file +##### 日志类型 +1. @ParamLog:参数类型,仅打印参数 +2. @ResultLog:结果类型,仅打印结果 +3. @ThrowingLog:异常类型,仅打印异常 +4. @Log:综合类型,打印参数+结果+异常 \ No newline at end of file diff --git a/src/main/java/wiki/xsx/core/log/Level.java b/src/main/java/wiki/xsx/core/log/Level.java index 399c8af842579e5dbc7c8f3ba9fc4c6d9df8c63e..a82e41f83f49477d8209dfd3b3aa02d746ff399a 100644 --- a/src/main/java/wiki/xsx/core/log/Level.java +++ b/src/main/java/wiki/xsx/core/log/Level.java @@ -22,5 +22,5 @@ public enum Level { /** * 错误级别 */ - ERROR; + ERROR } diff --git a/src/main/java/wiki/xsx/core/log/LogProcessor.java b/src/main/java/wiki/xsx/core/log/LogProcessor.java index ec9c9a703c54f539923c3fc239ba9b4b61534bcc..86f10ac31f479917ffd94121960351e3c1342d4b 100644 --- a/src/main/java/wiki/xsx/core/log/LogProcessor.java +++ b/src/main/java/wiki/xsx/core/log/LogProcessor.java @@ -6,12 +6,11 @@ import org.aspectj.lang.JoinPoint; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.Signature; import org.aspectj.lang.annotation.*; +import wiki.xsx.core.support.ArrayType; import wiki.xsx.core.support.MethodInfo; import wiki.xsx.core.support.MethodParser; -import java.util.HashMap; -import java.util.List; -import java.util.Map; +import java.util.*; /** * 日志处理器 @@ -204,7 +203,7 @@ public class LogProcessor { if (count>0) { Map paramMap = new HashMap<>(count); for (int i = 0; i < count; i++) { - paramMap.put(paramNames.get(i), params[i]); + paramMap.put(paramNames.get(i), this.getParam(params[i])); } return builder.append(paramMap).append("】").toString(); } @@ -240,6 +239,89 @@ public class LogProcessor { return builder.toString(); } + /** + * 获取对应参数 + * @param param 参数 + * @return 返回参数 + */ + private Object getParam(Object param) { + Class type = param.getClass(); + return type.isArray() ? this.getList(type, param): param; + } + + /** + * 获取数组类型参数列表 + * @param valueType 数组类型 + * @param value 参数值 + * @return 返回参数列表 + */ + private List getList(Class valueType, Object value) { + if (valueType.isAssignableFrom(ArrayType.OBJECT_ARRAY.getType())) { + Object[] array = (Object[]) value; + List list = new ArrayList<>(array.length); + Collections.addAll(list, array); + return list; + }else if (valueType.isAssignableFrom(ArrayType.INT_ARRAY.getType())) { + int[] array = (int[]) value; + List list = new ArrayList<>(array.length); + for (int v : array) { + list.add(v); + } + return list; + }else if (valueType.isAssignableFrom(ArrayType.LONG_ARRAY.getType())) { + long[] array = (long[]) value; + List list = new ArrayList<>(array.length); + for (long v : array) { + list.add(v); + } + return list; + }else if (valueType.isAssignableFrom(ArrayType.DOUBLE_ARRAY.getType())) { + double[] array = (double[]) value; + List list = new ArrayList<>(array.length); + for (double v : array) { + list.add(v); + } + return list; + }else if (valueType.isAssignableFrom(ArrayType.FLOAT_ARRAY.getType())) { + float[] array = (float[]) value; + List list = new ArrayList<>(array.length); + for (float v : array) { + list.add(v); + } + return list; + }else if (valueType.isAssignableFrom(ArrayType.CHAR_ARRAY.getType())) { + char[] array = (char[]) value; + List list = new ArrayList<>(array.length); + for (char v : array) { + list.add(v); + } + return list; + }else if (valueType.isAssignableFrom(ArrayType.BOOLEAN_ARRAY.getType())) { + boolean[] array = (boolean[]) value; + List list = new ArrayList<>(array.length); + for (boolean v : array) { + list.add(v); + } + return list; + }else if (valueType.isAssignableFrom(ArrayType.BYTE_ARRAY.getType())) { + byte[] array = (byte[]) value; + List list = new ArrayList<>(array.length); + for (byte v : array) { + list.add(v); + } + return list; + }else if (valueType.isAssignableFrom(ArrayType.SHORT_ARRAY.getType())) { + short[] array = (short[]) value; + List list = new ArrayList<>(array.length); + for (short v : array) { + list.add(v); + } + return list; + }else { + return null; + } + } + /** * 创建方法栈 * @param signature 签名信息 diff --git a/src/main/java/wiki/xsx/core/support/ArrayType.java b/src/main/java/wiki/xsx/core/support/ArrayType.java new file mode 100644 index 0000000000000000000000000000000000000000..38862d225b553d46af5997f3d6335d84e6a238ca --- /dev/null +++ b/src/main/java/wiki/xsx/core/support/ArrayType.java @@ -0,0 +1,68 @@ +package wiki.xsx.core.support; + +/** + * 数组类型 + * @author xsx + * @date 2019/6/19 + * @since 1.8 + */ +public enum ArrayType { + + /** + * 字符数组 + */ + CHAR_ARRAY(char[].class), + /** + * 字节数组 + */ + BYTE_ARRAY(byte[].class), + /** + * 短整型数组 + */ + SHORT_ARRAY(short[].class), + /** + * 整型数组 + */ + INT_ARRAY(int[].class), + /** + * 长整型数组 + */ + LONG_ARRAY(long[].class), + /** + * 单精度浮点型数组 + */ + FLOAT_ARRAY(float[].class), + /** + * 双精度浮点型数组 + */ + DOUBLE_ARRAY(double[].class), + /** + * 布尔型数组 + */ + BOOLEAN_ARRAY(boolean[].class), + /** + * 对象数组 + */ + OBJECT_ARRAY(Object[].class); + + /** + * 类型 + */ + private Class type; + + /** + * 数组类型构造 + * @param type 对应类型 + */ + ArrayType(Class type) { + this.type = type; + } + + /** + * 获取对应类型 + * @return 返回对应类型 + */ + public Class getType() { + return type; + } +}