├── .github
└── workflows
│ └── main.yml
├── .gitignore
├── .mvn
└── wrapper
│ ├── MavenWrapperDownloader.java
│ ├── maven-wrapper.jar
│ └── maven-wrapper.properties
├── Image
├── common.png
├── ding0.png
├── ding1.png
├── ding2.png
├── ding3.png
├── ding4.png
├── ding5.png
├── ding6.png
├── ding7.png
├── ding8-1.png
└── web.png
├── LICENSE
├── README.md
├── _config.yml
├── mvnw
├── mvnw.cmd
├── pom.xml
└── src
├── main
├── java
│ └── com
│ │ └── marvin
│ │ ├── common
│ │ ├── constant
│ │ │ └── ExceptionConstant.java
│ │ ├── enumeration
│ │ │ ├── ExceptionType.java
│ │ │ ├── ListenType.java
│ │ │ └── ProjectEnvironment.java
│ │ └── exception
│ │ │ ├── CalmaRuntimeException.java
│ │ │ ├── IGException.java
│ │ │ ├── NoSuchHttpRequestMethodException.java
│ │ │ └── internal
│ │ │ └── TypeConvertException.java
│ │ ├── config
│ │ ├── CommonNoticeContextConfiguration.java
│ │ ├── DingComponentConfiguration.java
│ │ ├── DingDingClientConfiguration.java
│ │ ├── ListenerConfiguration.java
│ │ ├── MarkdownExceptionNoticeSendConfiguration.java
│ │ ├── SmsClientConfiguration.java
│ │ ├── SmsComponentConfiguration.java
│ │ ├── TextExceptionNoticeSendConfiguration.java
│ │ ├── WebNoticeContextConfiguration.java
│ │ ├── anno
│ │ │ ├── CalmaExceptionListener.java
│ │ │ ├── ConditionOnCalmaExceptionNotice.java
│ │ │ ├── ConditionOnMarkdownExceptionNotice.java
│ │ │ ├── ConditionOnTextExceptionNotice.java
│ │ │ ├── ConditionOnWebAutoConfigure.java
│ │ │ └── WebIGExceptionListener.java
│ │ ├── aop
│ │ │ └── CommonAop.java
│ │ ├── condition
│ │ │ ├── OnCalmaExceptionNoticeCondition.java
│ │ │ ├── OnMarkdownExceptionNoticeCondition.java
│ │ │ ├── OnTextExceptionNoticeCondition.java
│ │ │ └── OnWebAutoConfigureCondition.java
│ │ ├── notice
│ │ │ ├── AopConfiguration.java
│ │ │ └── CalmaNoticeConfiguration.java
│ │ └── web
│ │ │ ├── WebExceptionListenConfiguration.java
│ │ │ └── load
│ │ │ └── WebAutoLoadConfiguration.java
│ │ ├── context
│ │ ├── AbstractNoticeContext.java
│ │ ├── DefaultNoticeContext.java
│ │ ├── HttpNoticeContext.java
│ │ ├── aware
│ │ │ └── StatisticallyAware.java
│ │ └── support
│ │ │ ├── AbstractConditionPostProcessor.java
│ │ │ ├── IGAnnoPostProcessor.java
│ │ │ ├── IGExceptionPostProcessor.java
│ │ │ ├── client
│ │ │ ├── Client.java
│ │ │ ├── DingClient.java
│ │ │ └── SmsClient.java
│ │ │ └── component
│ │ │ ├── DingNoticeSendComponent.java
│ │ │ ├── NoticeSendComponent.java
│ │ │ └── SmsNoticeSendComponent.java
│ │ ├── event
│ │ ├── ExceptionEvent.java
│ │ └── listener
│ │ │ ├── AbstractCalmaNotifier.java
│ │ │ └── CalmaNotifier.java
│ │ ├── factory
│ │ ├── DingMessageFactory.java
│ │ └── ExceptionStatisticDtoFactory.java
│ │ ├── model
│ │ ├── message
│ │ │ ├── DingMessage.java
│ │ │ ├── Message.java
│ │ │ ├── SmsMessage.java
│ │ │ └── ding
│ │ │ │ ├── DingAt.java
│ │ │ │ ├── DingDingProperty.java
│ │ │ │ ├── DingMarkdown.java
│ │ │ │ └── DingText.java
│ │ ├── notice
│ │ │ ├── CommonNotice.java
│ │ │ ├── HttpNotice.java
│ │ │ └── Notice.java
│ │ └── web
│ │ │ └── WebNoticeInfo.java
│ │ ├── resolver
│ │ └── CalmaValueResolver.java
│ │ ├── statistic
│ │ ├── cache
│ │ │ └── StatisticHelper.java
│ │ └── dto
│ │ │ └── ExceptionStatisticDto.java
│ │ ├── util
│ │ ├── DingClientFeign.java
│ │ ├── JsonExpander.java
│ │ ├── NumberUtils.java
│ │ ├── StreamUtils.java
│ │ ├── factory
│ │ │ └── SupportYamlPropertyFactory.java
│ │ └── web
│ │ │ └── bridge
│ │ │ └── CacheBridge.java
│ │ └── web
│ │ ├── interceptor
│ │ └── ClearBodyInterceptor.java
│ │ └── resolver
│ │ ├── CalmaExceptionHandlerResolver.java
│ │ ├── CurrentRequestBodyResolver.java
│ │ ├── CurrentRequestHeaderResolver.java
│ │ ├── DefaultRequestBodyResolver.java
│ │ └── DefaultRequestHeaderResolver.java
└── resources
│ └── META-INF
│ └── spring.factories
└── test
└── java
└── com
└── marvin
├── CommonTestProjectApplicationTests.java
└── testModel
├── TestCalma.java
└── TestController.java
/.github/workflows/main.yml:
--------------------------------------------------------------------------------
1 | # GitHub Action for generating a contribution graph with a snake eating your contributions.
2 |
3 | name: Generate Snake
4 |
5 | on:
6 | schedule:
7 | - cron: "0 0 * * *"
8 | workflow_dispatch:
9 |
10 | jobs:
11 | build:
12 | runs-on: ubuntu-latest
13 |
14 | steps:
15 | - name: Checkout
16 | uses: actions/checkout@v2.3.4
17 |
18 | - name: Generate Snake
19 | uses: Platane/snk@master
20 | id: snake-gif
21 | with:
22 | github_user_name: ${{ github.repository_owner }}
23 | gif_out_path: ./assets/github-contribution-grid-snake.gif
24 | svg_out_path: ./assets/github-contribution-grid-snake.svg
25 |
26 | - name: Push to GitHub
27 | uses: EndBug/add-and-commit@v7.2.1
28 | with:
29 | branch: main
30 | message: 'Generate Contribution Snake'
31 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | HELP.md
2 | target/
3 | !.mvn/wrapper/maven-wrapper.jar
4 | !**/src/main/**/target/
5 | !**/src/test/**/target/
6 |
7 | ### STS ###
8 | .apt_generated
9 | .classpath
10 | .factorypath
11 | .project
12 | .settings
13 | .springBeans
14 | .sts4-cache
15 |
16 | ### IntelliJ IDEA ###
17 | .idea
18 | *.iws
19 | *.iml
20 | *.ipr
21 |
22 | ### NetBeans ###
23 | /nbproject/private/
24 | /nbbuild/
25 | /dist/
26 | /nbdist/
27 | /.nb-gradle/
28 | build/
29 | !**/src/main/**/build/
30 | !**/src/test/**/build/
31 |
32 | ### VS Code ###
33 | .vscode/
34 |
--------------------------------------------------------------------------------
/.mvn/wrapper/MavenWrapperDownloader.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2007-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 | import java.net.*;
17 | import java.io.*;
18 | import java.nio.channels.*;
19 | import java.util.Properties;
20 |
21 | public class MavenWrapperDownloader {
22 |
23 | private static final String WRAPPER_VERSION = "0.5.6";
24 | /**
25 | * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
26 | */
27 | private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
28 | + WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
29 |
30 | /**
31 | * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to
32 | * use instead of the default one.
33 | */
34 | private static final String MAVEN_WRAPPER_PROPERTIES_PATH =
35 | ".mvn/wrapper/maven-wrapper.properties";
36 |
37 | /**
38 | * Path where the maven-wrapper.jar will be saved to.
39 | */
40 | private static final String MAVEN_WRAPPER_JAR_PATH =
41 | ".mvn/wrapper/maven-wrapper.jar";
42 |
43 | /**
44 | * Name of the property which should be used to override the default download url for the wrapper.
45 | */
46 | private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
47 |
48 | public static void main(String args[]) {
49 | System.out.println("- Downloader started");
50 | File baseDirectory = new File(args[0]);
51 | System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath());
52 |
53 | // If the maven-wrapper.properties exists, read it and check if it contains a custom
54 | // wrapperUrl parameter.
55 | File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH);
56 | String url = DEFAULT_DOWNLOAD_URL;
57 | if(mavenWrapperPropertyFile.exists()) {
58 | FileInputStream mavenWrapperPropertyFileInputStream = null;
59 | try {
60 | mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile);
61 | Properties mavenWrapperProperties = new Properties();
62 | mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream);
63 | url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url);
64 | } catch (IOException e) {
65 | System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'");
66 | } finally {
67 | try {
68 | if(mavenWrapperPropertyFileInputStream != null) {
69 | mavenWrapperPropertyFileInputStream.close();
70 | }
71 | } catch (IOException e) {
72 | // Ignore ...
73 | }
74 | }
75 | }
76 | System.out.println("- Downloading from: " + url);
77 |
78 | File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
79 | if(!outputFile.getParentFile().exists()) {
80 | if(!outputFile.getParentFile().mkdirs()) {
81 | System.out.println(
82 | "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
83 | }
84 | }
85 | System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
86 | try {
87 | downloadFileFromURL(url, outputFile);
88 | System.out.println("Done");
89 | System.exit(0);
90 | } catch (Throwable e) {
91 | System.out.println("- Error downloading");
92 | e.printStackTrace();
93 | System.exit(1);
94 | }
95 | }
96 |
97 | private static void downloadFileFromURL(String urlString, File destination) throws Exception {
98 | if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
99 | String username = System.getenv("MVNW_USERNAME");
100 | char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
101 | Authenticator.setDefault(new Authenticator() {
102 | @Override
103 | protected PasswordAuthentication getPasswordAuthentication() {
104 | return new PasswordAuthentication(username, password);
105 | }
106 | });
107 | }
108 | URL website = new URL(urlString);
109 | ReadableByteChannel rbc;
110 | rbc = Channels.newChannel(website.openStream());
111 | FileOutputStream fos = new FileOutputStream(destination);
112 | fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
113 | fos.close();
114 | rbc.close();
115 | }
116 |
117 | }
118 |
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/marvinSpring/spring-boot-starter-calma/27e4a7e62a63ac1e73ab08ba2de5d5f434f5b2ae/.mvn/wrapper/maven-wrapper.jar
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
2 | wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar
3 |
--------------------------------------------------------------------------------
/Image/common.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/marvinSpring/spring-boot-starter-calma/27e4a7e62a63ac1e73ab08ba2de5d5f434f5b2ae/Image/common.png
--------------------------------------------------------------------------------
/Image/ding0.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/marvinSpring/spring-boot-starter-calma/27e4a7e62a63ac1e73ab08ba2de5d5f434f5b2ae/Image/ding0.png
--------------------------------------------------------------------------------
/Image/ding1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/marvinSpring/spring-boot-starter-calma/27e4a7e62a63ac1e73ab08ba2de5d5f434f5b2ae/Image/ding1.png
--------------------------------------------------------------------------------
/Image/ding2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/marvinSpring/spring-boot-starter-calma/27e4a7e62a63ac1e73ab08ba2de5d5f434f5b2ae/Image/ding2.png
--------------------------------------------------------------------------------
/Image/ding3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/marvinSpring/spring-boot-starter-calma/27e4a7e62a63ac1e73ab08ba2de5d5f434f5b2ae/Image/ding3.png
--------------------------------------------------------------------------------
/Image/ding4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/marvinSpring/spring-boot-starter-calma/27e4a7e62a63ac1e73ab08ba2de5d5f434f5b2ae/Image/ding4.png
--------------------------------------------------------------------------------
/Image/ding5.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/marvinSpring/spring-boot-starter-calma/27e4a7e62a63ac1e73ab08ba2de5d5f434f5b2ae/Image/ding5.png
--------------------------------------------------------------------------------
/Image/ding6.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/marvinSpring/spring-boot-starter-calma/27e4a7e62a63ac1e73ab08ba2de5d5f434f5b2ae/Image/ding6.png
--------------------------------------------------------------------------------
/Image/ding7.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/marvinSpring/spring-boot-starter-calma/27e4a7e62a63ac1e73ab08ba2de5d5f434f5b2ae/Image/ding7.png
--------------------------------------------------------------------------------
/Image/ding8-1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/marvinSpring/spring-boot-starter-calma/27e4a7e62a63ac1e73ab08ba2de5d5f434f5b2ae/Image/ding8-1.png
--------------------------------------------------------------------------------
/Image/web.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/marvinSpring/spring-boot-starter-calma/27e4a7e62a63ac1e73ab08ba2de5d5f434f5b2ae/Image/web.png
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | #### 异常通知spring-boot-starter
2 |
3 | **介绍**
4 |
5 | 本项目是适用于企业开发,个人开发者,在平时开发中这个项目可能一点忙都帮不上你,但是当你的项目开发完成并且上线之后,它的作用就发挥出来了,因为它将代替你监控你的工程
6 | ,在你不想去24小时不停盯着日志看是否报错的时候,在你下班或者休息的时间帮你照看你的项目, 直到它发生异常的时候,它将精准的把异常通过手机短信/钉钉来通知你项目的异常情况,这让你可以
7 | 在项目上线之后无需在让人一直守着它,甚至如果项目出问题的时候可以将锅直接甩到负责人身上, 而无需在它出异常的时候再去定位异常找出是谁写的,然后再通知他,这样效率很低,而本项目可以 自动化的将所有这一切令人不爽的工作自动化的处理,省时省力。
8 |
9 | 系统需求:   
10 |
11 | **快速入门**
12 |
13 | 1.在你的工程的pom文件中将以下依赖加入
14 |
15 | ```xml
16 |
17 | io.github.marvinspring
18 | spring-boot-starter-calma
19 | 1.0.6.RELEASE
20 |
21 | ```
22 |
23 | 2.在SpringBoot的配置文件:application.yml中做如下的配置:
24 |
25 | ```yaml
26 | spring:
27 | application:
28 | name: #项目名称,这里和project-name都可以给项目配置名称
29 | calma:
30 | exceptionnotice:
31 | enabled: true #开启异常通知
32 | listen-type: common #普通模式
33 | project-name: a example project #项目名称
34 | #Sms配置
35 | # sms:
36 | # enable: true #开启短信通知
37 | # regionId: 阿里云短信的regionId
38 | # accessKey: 阿里云短信的accessKey
39 | # secret: 阿里云短信的密钥
40 | # phoneNumbers: 你的手机号
41 | # signName: 阿里云短信的签名
42 | # templateCode: 阿里云短信的模板码
43 | #钉钉
44 | dingding:
45 | enable: true #开启钉钉通知
46 | msgtype: text #发送的消息格式,text将通过普通文本方式发送,markdown将会将异常信息用markdown语法转化后发送
47 | phoneNumbers: #要@的人的手机号,格式为:136xxxxxxxx,159xxxxxxxx
48 | userIds: #要@的人的钉钉id,格式为:xxx,xxxx
49 | isAtAll: true #true 通知全体成员,false则不
50 | access_token: #钉钉机器人的token
51 | secret: #钉钉机器人的密钥
52 | ```
53 |
54 | 3.首先在你的项目中写如下案例
55 |
56 | ```java
57 |
58 | @Component//由于common方式通知实现是由spring aop方式实现,这里它必须被装载到spring中
59 | @CalmaExceptionListener // 异常通知的监控来自这个注解
60 | public class ExceptionTest {
61 |
62 | //@CalmaExceptionListener当然标注在某个方法上面就只监控被标注的方法
63 | public void testException(String param) {
64 | System.out.println("参数:" + param);
65 | throw new IllegalArgumentException("异常");
66 | }
67 |
68 | }
69 |
70 | ```
71 |
72 | 4.测试
73 |
74 | ```java
75 |
76 | @RunWith(SpringRunner.class)
77 | @SpringBootTest
78 | public class DemoApplicationTests {
79 |
80 | @Autowired
81 | private ExceptionTest exceptionTest;
82 |
83 | @Test
84 | public void contextLoads() {
85 | exceptionTest.testException("冲冲冲!");
86 | }
87 | }
88 | ```
89 | 然后你的钉钉就会钉d=====( ̄▽ ̄*)b的一声
90 | 
91 |
92 | 到这里测试就完成了,可以快乐的当一个帅锅侠了
93 |
94 | --------------------------------------------------------------------
95 |
96 | 从这开始讲解如何在web模式下使用本框架
97 |
98 | 1.在你的工程的pom文件中将以下依赖加入
99 |
100 | ```xml
101 |
102 | io.github.marvinspring
103 | spring-boot-starter-calma
104 | 1.0.6.RELEASE
105 |
106 | ```
107 |
108 | 2.在SpringBoot的配置文件:application.yml中做如下的配置:
109 |
110 | ```yaml
111 | spring:
112 | application:
113 | name: #这里和project-name都可以配置项目名称
114 | calma:
115 | exceptionnotice:
116 | enabled: true #开启异常通知
117 | listen-type: web #区别是这里是web,开启了web模式的征途了
118 | project-name: a example project #项目名称
119 | #Sms配置
120 | # sms:
121 | # enable: true #开启短信通知
122 | # regionId: 阿里云短信的regionId
123 | # accessKey: 阿里云短信的accessKey
124 | # secret: 阿里云短信的密钥
125 | # phoneNumbers: 你的手机号
126 | # signName: 阿里云短信的签名
127 | # templateCode: 阿里云短信的模板码
128 | #钉钉
129 | dingding:
130 | enable: true #开启钉钉通知
131 | msgtype: text #发送的消息格式,text将通过普通文本方式发送,markdown将会将异常信息用markdown语法转化后发送
132 | phoneNumbers: #要@的人的手机号,格式为:136xxxxxxxx,159xxxxxxxx
133 | userIds: #要@的人的钉钉id,格式为:xxx,xxxx
134 | isAtAll: true #true 通知全体成员,false则不
135 | access_token: #钉钉机器人的token
136 | secret: #钉钉机器人的密钥
137 | ```
138 | 3.当然是像上面一样写个模拟的控制器了,你还在期待什么
139 | ```java
140 | @RestController//web方式只需要将其声明为控制器就可以例如:@Controller
141 | @CalmaExceptionListener//写在这里可以让所有的方法都被监控
142 | public class ExampleController{
143 |
144 | @GetMapping("/testFoo")
145 | //@CalmaExceptionListener当然标注在某个方法上面就只监控被标注的方法
146 | public void foo(String param){
147 | int i = 1/0;
148 | }
149 |
150 | @PostMapping("/testFoo")
151 | public void foo(Integer param){
152 | param = param/0;
153 | }
154 |
155 | }
156 | ```
157 |
158 | 4.请求它,无所谓用httpclient或者postman或者其他方式,这里由于我懒得截图,,就没图了
159 |
160 | 然后你的钉钉再一次钉d=====( ̄▽ ̄*)b
161 | 
162 | 到这里为止,web模式的这个测试也完了,还不快点去试试?
163 |
164 | --------------------------------------------------------------------
165 | #### web模式下开启自动加载controller
166 |
167 | 该功能背景是由于某些项目需要监听的接口太多,一个一个标注@CalmaExceptionListener太过于繁琐,不利于开发者,本着约定大于配置的约束,有了本功能以及以下介绍:
168 |
169 | 1.首先,看完上面你应该已经知道如何配置web模式并成功通知了,所以假定你已经可以正常的发通知了
170 |
171 | 2.只需要在此基础上将配置文件(application.yml也可能在你的项目是其他指定名称)中添加
172 |
173 | ```yaml
174 | calma:
175 | exceptionnotice:
176 | listen-type: web #区别是这里是web,开启了web模式的征途了
177 | auto: true #注意该值不为true或者缺省都不会进行自动通知,尤其是listen-type不为web时,该配置无意义,只有在web模式下才会自动扫描控制器并将自动通知
178 | ```
179 |
180 | 3.写一个控制器类似于
181 |
182 | ```java
183 | @RestController//web方式只需要将其声明为控制器就可以例如:@Controller
184 | //@CalmaExceptionListener//这时候该注解就可有可无了
185 | public class ExampleController{
186 |
187 | @GetMapping("/testFoo")
188 | //@CalmaExceptionListener这时候该注解就可有可无了
189 | public void foo(String param){
190 | int i = 1/0;
191 | }
192 |
193 | @PostMapping("/testFoo")
194 | public void foo(Integer param){
195 | param = param/0;
196 | }
197 |
198 | }
199 | ```
200 | 在此类中一共有俩个接口被扫描到,分别是GET /testFoo以及POST /testFoo,这俩接口都将被calma扫描并当异常发生时通知到你
201 |
202 | 4.这里由于考虑到某些特定的接口不需要被通知,你还可以使用@WebIGExceptionListener注解对不需要通知的接口标注,也可以标注在对应的类身上,例如
203 |
204 |
205 | ```java
206 | @RestController//web方式只需要将其声明为控制器就可以例如:@Controller
207 | public class ExampleController{
208 |
209 | @GetMapping("/testFoo")
210 | @WebIGExceptionListener
211 | public void foo(String param){
212 | int i = 1/0;
213 | }
214 |
215 | @PostMapping("/testFoo")
216 | public void foo(Integer param){
217 | param = param/0;
218 | }
219 |
220 | }
221 | ```
222 |
223 | 这里GET /testFoo接口中发生的任何异常calma不会将其纳入通知范围
224 |
225 | ------------
226 | #### 全模式支持IGException异常。
227 | 该异常为忽略异常,如果被监听的方法/接口抛出了该异常将不会发起通知。
228 |
229 | 该功能背景是作用于某些特定的逻辑下,异常是必须抛出的,而又不需要去监听,因为开发者不关心他,那么你可以抛出IGException or extends它,它设定为RuntimeException并且是非final异常,你的所有业务异常可以继承它,当然这样就有一定侵入性(当我后期对这个异常进行更改名称/异常层次等,当然不会将其变更为final异常)这样你的项目会有麻烦。
230 |
231 | 在web模式下:
232 |
233 | ```java
234 | @RestController//web方式只需要将其声明为控制器就可以例如:@Controller
235 | public class ExampleController{
236 |
237 | @GetMapping("/testFoo")
238 | public void foo(String param){
239 | int i = 1/0;
240 | }
241 |
242 | @PostMapping("/testFoo")
243 | public void foo(Integer param){
244 | if(xxxCondition){
245 | throw new IGException("我不想被通知");
246 | }
247 | param = param/0;
248 | }
249 |
250 | }
251 | ```
252 | 如上述代码中POST /testFoo接口如果走到了xxxCondition逻辑内并成功抛出IGException异常,那么此次请求将不会发起通知流程
253 |
254 | 同样的,在普通模式下:
255 |
256 | ```java
257 | @RunWith(SpringRunner.class)
258 | @SpringBootTest
259 | public class DemoApplicationTests {
260 |
261 | @Autowired
262 | private ExceptionTest exceptionTest;
263 |
264 | @Test
265 | public void contextLoads() {
266 | if(xxxCondition){
267 | throw new IGException("我不想被通知");
268 | }
269 | exceptionTest.testException("冲冲冲!");
270 | }
271 | }
272 | ```
273 | contextLoads方法如果走到了xxxCondition逻辑内并成功抛出IGException异常,那么此次请求将不会发起通知流程。
274 |
275 | ------------
276 | ###### 关于钉钉机器人的配置:
277 |
278 | ###### 1.找到你所需要通知的群
279 |
280 | 
281 |
282 | ###### 2.点击群设置,在pc端,它通常在右上角的位置
283 |
284 | 
285 |
286 | ###### 3.在群设置中找到机器人选项,进入
287 |
288 | 
289 |
290 | ###### 4.点击添加机器人
291 |
292 | 
293 |
294 | ###### 5.继续点击机器人
295 |
296 | 
297 |
298 | ###### 6.选中自定义机器人
299 |
300 | 
301 |
302 | ###### 7.给你的机器人取个名字并找到安全设置,勾选加签作为认证方式,点击复制,将签名复制到你的项目中的ding.secret的值的位置
303 |
304 | 
305 |
306 | ###### 8.在上一步中,点击完成后,你需要将钉钉的access token同样复制到你的配置文件中的ding.access_token的值的位置中
307 |
308 | 
309 |
310 | ###### 9.到这一步钉钉机器人的配置就完成了
311 |
312 | 
313 |
314 | ------------
315 |
316 |
317 | 未完待续.............
318 |
319 | (有问题请联系我的Email:1261626796@qq.com,我会很快回复的)
320 |
321 | 下个版本的期待:
322 |
323 | 1.支持微服务的监控通知
324 |
325 | _ps:终于吧markdown补充好了,之前一直有其他事情没空搞
326 |
--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
1 | theme: jekyll-theme-merlot
--------------------------------------------------------------------------------
/mvnw:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | # ----------------------------------------------------------------------------
3 | # Licensed to the Apache Software Foundation (ASF) under one
4 | # or more contributor license agreements. See the NOTICE file
5 | # distributed with this work for additional information
6 | # regarding copyright ownership. The ASF licenses this file
7 | # to you under the Apache License, Version 2.0 (the
8 | # "License"); you may not use this file except in compliance
9 | # with the License. You may obtain a copy of the License at
10 | #
11 | # https://www.apache.org/licenses/LICENSE-2.0
12 | #
13 | # Unless required by applicable law or agreed to in writing,
14 | # software distributed under the License is distributed on an
15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | # KIND, either express or implied. See the License for the
17 | # specific language governing permissions and limitations
18 | # under the License.
19 | # ----------------------------------------------------------------------------
20 |
21 | # ----------------------------------------------------------------------------
22 | # Maven Start Up Batch script
23 | #
24 | # Required ENV vars:
25 | # ------------------
26 | # JAVA_HOME - location of a JDK home dir
27 | #
28 | # Optional ENV vars
29 | # -----------------
30 | # M2_HOME - location of maven2's installed home dir
31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven
32 | # e.g. to debug Maven itself, use
33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files
35 | # ----------------------------------------------------------------------------
36 |
37 | if [ -z "$MAVEN_SKIP_RC" ] ; then
38 |
39 | if [ -f /etc/mavenrc ] ; then
40 | . /etc/mavenrc
41 | fi
42 |
43 | if [ -f "$HOME/.mavenrc" ] ; then
44 | . "$HOME/.mavenrc"
45 | fi
46 |
47 | fi
48 |
49 | # OS specific support. $var _must_ be set to either true or false.
50 | cygwin=false;
51 | darwin=false;
52 | mingw=false
53 | case "`uname`" in
54 | CYGWIN*) cygwin=true ;;
55 | MINGW*) mingw=true;;
56 | Darwin*) darwin=true
57 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
58 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html
59 | if [ -z "$JAVA_HOME" ]; then
60 | if [ -x "/usr/libexec/java_home" ]; then
61 | export JAVA_HOME="`/usr/libexec/java_home`"
62 | else
63 | export JAVA_HOME="/Library/Java/Home"
64 | fi
65 | fi
66 | ;;
67 | esac
68 |
69 | if [ -z "$JAVA_HOME" ] ; then
70 | if [ -r /etc/gentoo-release ] ; then
71 | JAVA_HOME=`java-config --jre-home`
72 | fi
73 | fi
74 |
75 | if [ -z "$M2_HOME" ] ; then
76 | ## resolve links - $0 may be a link to maven's home
77 | PRG="$0"
78 |
79 | # need this for relative symlinks
80 | while [ -h "$PRG" ] ; do
81 | ls=`ls -ld "$PRG"`
82 | link=`expr "$ls" : '.*-> \(.*\)$'`
83 | if expr "$link" : '/.*' > /dev/null; then
84 | PRG="$link"
85 | else
86 | PRG="`dirname "$PRG"`/$link"
87 | fi
88 | done
89 |
90 | saveddir=`pwd`
91 |
92 | M2_HOME=`dirname "$PRG"`/..
93 |
94 | # make it fully qualified
95 | M2_HOME=`cd "$M2_HOME" && pwd`
96 |
97 | cd "$saveddir"
98 | # echo Using m2 at $M2_HOME
99 | fi
100 |
101 | # For Cygwin, ensure paths are in UNIX format before anything is touched
102 | if $cygwin ; then
103 | [ -n "$M2_HOME" ] &&
104 | M2_HOME=`cygpath --unix "$M2_HOME"`
105 | [ -n "$JAVA_HOME" ] &&
106 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
107 | [ -n "$CLASSPATH" ] &&
108 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"`
109 | fi
110 |
111 | # For Mingw, ensure paths are in UNIX format before anything is touched
112 | if $mingw ; then
113 | [ -n "$M2_HOME" ] &&
114 | M2_HOME="`(cd "$M2_HOME"; pwd)`"
115 | [ -n "$JAVA_HOME" ] &&
116 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
117 | fi
118 |
119 | if [ -z "$JAVA_HOME" ]; then
120 | javaExecutable="`which javac`"
121 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then
122 | # readlink(1) is not available as standard on Solaris 10.
123 | readLink=`which readlink`
124 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then
125 | if $darwin ; then
126 | javaHome="`dirname \"$javaExecutable\"`"
127 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac"
128 | else
129 | javaExecutable="`readlink -f \"$javaExecutable\"`"
130 | fi
131 | javaHome="`dirname \"$javaExecutable\"`"
132 | javaHome=`expr "$javaHome" : '\(.*\)/bin'`
133 | JAVA_HOME="$javaHome"
134 | export JAVA_HOME
135 | fi
136 | fi
137 | fi
138 |
139 | if [ -z "$JAVACMD" ] ; then
140 | if [ -n "$JAVA_HOME" ] ; then
141 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
142 | # IBM's JDK on AIX uses strange locations for the executables
143 | JAVACMD="$JAVA_HOME/jre/sh/java"
144 | else
145 | JAVACMD="$JAVA_HOME/bin/java"
146 | fi
147 | else
148 | JAVACMD="`which java`"
149 | fi
150 | fi
151 |
152 | if [ ! -x "$JAVACMD" ] ; then
153 | echo "Error: JAVA_HOME is not defined correctly." >&2
154 | echo " We cannot execute $JAVACMD" >&2
155 | exit 1
156 | fi
157 |
158 | if [ -z "$JAVA_HOME" ] ; then
159 | echo "Warning: JAVA_HOME environment variable is not set."
160 | fi
161 |
162 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher
163 |
164 | # traverses directory structure from process work directory to filesystem root
165 | # first directory with .mvn subdirectory is considered project base directory
166 | find_maven_basedir() {
167 |
168 | if [ -z "$1" ]
169 | then
170 | echo "Path not specified to find_maven_basedir"
171 | return 1
172 | fi
173 |
174 | basedir="$1"
175 | wdir="$1"
176 | while [ "$wdir" != '/' ] ; do
177 | if [ -d "$wdir"/.mvn ] ; then
178 | basedir=$wdir
179 | break
180 | fi
181 | # workaround for JBEAP-8937 (on Solaris 10/Sparc)
182 | if [ -d "${wdir}" ]; then
183 | wdir=`cd "$wdir/.."; pwd`
184 | fi
185 | # end of workaround
186 | done
187 | echo "${basedir}"
188 | }
189 |
190 | # concatenates all lines of a file
191 | concat_lines() {
192 | if [ -f "$1" ]; then
193 | echo "$(tr -s '\n' ' ' < "$1")"
194 | fi
195 | }
196 |
197 | BASE_DIR=`find_maven_basedir "$(pwd)"`
198 | if [ -z "$BASE_DIR" ]; then
199 | exit 1;
200 | fi
201 |
202 | ##########################################################################################
203 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
204 | # This allows using the maven wrapper in projects that prohibit checking in binary data.
205 | ##########################################################################################
206 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then
207 | if [ "$MVNW_VERBOSE" = true ]; then
208 | echo "Found .mvn/wrapper/maven-wrapper.jar"
209 | fi
210 | else
211 | if [ "$MVNW_VERBOSE" = true ]; then
212 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..."
213 | fi
214 | if [ -n "$MVNW_REPOURL" ]; then
215 | jarUrl="$MVNW_REPOURL/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
216 | else
217 | jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
218 | fi
219 | while IFS="=" read key value; do
220 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;;
221 | esac
222 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties"
223 | if [ "$MVNW_VERBOSE" = true ]; then
224 | echo "Downloading from: $jarUrl"
225 | fi
226 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar"
227 | if $cygwin; then
228 | wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"`
229 | fi
230 |
231 | if command -v wget > /dev/null; then
232 | if [ "$MVNW_VERBOSE" = true ]; then
233 | echo "Found wget ... using wget"
234 | fi
235 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
236 | wget "$jarUrl" -O "$wrapperJarPath"
237 | else
238 | wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath"
239 | fi
240 | elif command -v curl > /dev/null; then
241 | if [ "$MVNW_VERBOSE" = true ]; then
242 | echo "Found curl ... using curl"
243 | fi
244 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
245 | curl -o "$wrapperJarPath" "$jarUrl" -f
246 | else
247 | curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f
248 | fi
249 |
250 | else
251 | if [ "$MVNW_VERBOSE" = true ]; then
252 | echo "Falling back to using Java to download"
253 | fi
254 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java"
255 | # For Cygwin, switch paths to Windows format before running javac
256 | if $cygwin; then
257 | javaClass=`cygpath --path --windows "$javaClass"`
258 | fi
259 | if [ -e "$javaClass" ]; then
260 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
261 | if [ "$MVNW_VERBOSE" = true ]; then
262 | echo " - Compiling MavenWrapperDownloader.java ..."
263 | fi
264 | # Compiling the Java class
265 | ("$JAVA_HOME/bin/javac" "$javaClass")
266 | fi
267 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
268 | # Running the downloader
269 | if [ "$MVNW_VERBOSE" = true ]; then
270 | echo " - Running MavenWrapperDownloader.java ..."
271 | fi
272 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR")
273 | fi
274 | fi
275 | fi
276 | fi
277 | ##########################################################################################
278 | # End of extension
279 | ##########################################################################################
280 |
281 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
282 | if [ "$MVNW_VERBOSE" = true ]; then
283 | echo $MAVEN_PROJECTBASEDIR
284 | fi
285 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
286 |
287 | # For Cygwin, switch paths to Windows format before running java
288 | if $cygwin; then
289 | [ -n "$M2_HOME" ] &&
290 | M2_HOME=`cygpath --path --windows "$M2_HOME"`
291 | [ -n "$JAVA_HOME" ] &&
292 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"`
293 | [ -n "$CLASSPATH" ] &&
294 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"`
295 | [ -n "$MAVEN_PROJECTBASEDIR" ] &&
296 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"`
297 | fi
298 |
299 | # Provide a "standardized" way to retrieve the CLI args that will
300 | # work with both Windows and non-Windows executions.
301 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@"
302 | export MAVEN_CMD_LINE_ARGS
303 |
304 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
305 |
306 | exec "$JAVACMD" \
307 | $MAVEN_OPTS \
308 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
309 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
310 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"
311 |
--------------------------------------------------------------------------------
/mvnw.cmd:
--------------------------------------------------------------------------------
1 | @REM ----------------------------------------------------------------------------
2 | @REM Licensed to the Apache Software Foundation (ASF) under one
3 | @REM or more contributor license agreements. See the NOTICE file
4 | @REM distributed with this work for additional information
5 | @REM regarding copyright ownership. The ASF licenses this file
6 | @REM to you under the Apache License, Version 2.0 (the
7 | @REM "License"); you may not use this file except in compliance
8 | @REM with the License. You may obtain a copy of the License at
9 | @REM
10 | @REM https://www.apache.org/licenses/LICENSE-2.0
11 | @REM
12 | @REM Unless required by applicable law or agreed to in writing,
13 | @REM software distributed under the License is distributed on an
14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | @REM KIND, either express or implied. See the License for the
16 | @REM specific language governing permissions and limitations
17 | @REM under the License.
18 | @REM ----------------------------------------------------------------------------
19 |
20 | @REM ----------------------------------------------------------------------------
21 | @REM Maven Start Up Batch script
22 | @REM
23 | @REM Required ENV vars:
24 | @REM JAVA_HOME - location of a JDK home dir
25 | @REM
26 | @REM Optional ENV vars
27 | @REM M2_HOME - location of maven2's installed home dir
28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
31 | @REM e.g. to debug Maven itself, use
32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
34 | @REM ----------------------------------------------------------------------------
35 |
36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
37 | @echo off
38 | @REM set title of command window
39 | title %0
40 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
42 |
43 | @REM set %HOME% to equivalent of $HOME
44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
45 |
46 | @REM Execute a user defined script before this one
47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending
49 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat"
50 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd"
51 | :skipRcPre
52 |
53 | @setlocal
54 |
55 | set ERROR_CODE=0
56 |
57 | @REM To isolate internal variables from possible post scripts, we use another setlocal
58 | @setlocal
59 |
60 | @REM ==== START VALIDATION ====
61 | if not "%JAVA_HOME%" == "" goto OkJHome
62 |
63 | echo.
64 | echo Error: JAVA_HOME not found in your environment. >&2
65 | echo Please set the JAVA_HOME variable in your environment to match the >&2
66 | echo location of your Java installation. >&2
67 | echo.
68 | goto error
69 |
70 | :OkJHome
71 | if exist "%JAVA_HOME%\bin\java.exe" goto init
72 |
73 | echo.
74 | echo Error: JAVA_HOME is set to an invalid directory. >&2
75 | echo JAVA_HOME = "%JAVA_HOME%" >&2
76 | echo Please set the JAVA_HOME variable in your environment to match the >&2
77 | echo location of your Java installation. >&2
78 | echo.
79 | goto error
80 |
81 | @REM ==== END VALIDATION ====
82 |
83 | :init
84 |
85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
86 | @REM Fallback to current working directory if not found.
87 |
88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
90 |
91 | set EXEC_DIR=%CD%
92 | set WDIR=%EXEC_DIR%
93 | :findBaseDir
94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound
95 | cd ..
96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound
97 | set WDIR=%CD%
98 | goto findBaseDir
99 |
100 | :baseDirFound
101 | set MAVEN_PROJECTBASEDIR=%WDIR%
102 | cd "%EXEC_DIR%"
103 | goto endDetectBaseDir
104 |
105 | :baseDirNotFound
106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
107 | cd "%EXEC_DIR%"
108 |
109 | :endDetectBaseDir
110 |
111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
112 |
113 | @setlocal EnableExtensions EnableDelayedExpansion
114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
116 |
117 | :endReadAdditionalConfig
118 |
119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
122 |
123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
124 |
125 | FOR /F "tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
126 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B
127 | )
128 |
129 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
130 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data.
131 | if exist %WRAPPER_JAR% (
132 | if "%MVNW_VERBOSE%" == "true" (
133 | echo Found %WRAPPER_JAR%
134 | )
135 | ) else (
136 | if not "%MVNW_REPOURL%" == "" (
137 | SET DOWNLOAD_URL="%MVNW_REPOURL%/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
138 | )
139 | if "%MVNW_VERBOSE%" == "true" (
140 | echo Couldn't find %WRAPPER_JAR%, downloading it ...
141 | echo Downloading from: %DOWNLOAD_URL%
142 | )
143 |
144 | powershell -Command "&{"^
145 | "$webclient = new-object System.Net.WebClient;"^
146 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
147 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
148 | "}"^
149 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^
150 | "}"
151 | if "%MVNW_VERBOSE%" == "true" (
152 | echo Finished downloading %WRAPPER_JAR%
153 | )
154 | )
155 | @REM End of extension
156 |
157 | @REM Provide a "standardized" way to retrieve the CLI args that will
158 | @REM work with both Windows and non-Windows executions.
159 | set MAVEN_CMD_LINE_ARGS=%*
160 |
161 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
162 | if ERRORLEVEL 1 goto error
163 | goto end
164 |
165 | :error
166 | set ERROR_CODE=1
167 |
168 | :end
169 | @endlocal & set ERROR_CODE=%ERROR_CODE%
170 |
171 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost
172 | @REM check for post script, once with legacy .bat ending and once with .cmd ending
173 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat"
174 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd"
175 | :skipRcPost
176 |
177 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
178 | if "%MAVEN_BATCH_PAUSE%" == "on" pause
179 |
180 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE%
181 |
182 | exit /B %ERROR_CODE%
183 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 4.0.0
4 |
5 | org.springframework.boot
6 | spring-boot-starter-parent
7 | 2.3.6.RELEASE
8 |
9 |
10 | io.github.marvinspring
11 | spring-boot-starter-calma
12 | 1.0.6.RELEASE
13 | spring-boot-starter-calma
14 | 一个异常通知框架
15 |
16 |
17 | 8
18 |
19 |
20 |
21 |
22 |
27 |
28 |
29 | org.springframework.boot
30 | spring-boot-configuration-processor
31 |
32 |
33 |
34 | org.springframework.boot
35 | spring-boot-starter-web
36 |
37 |
38 | com.aliyun
39 | aliyun-java-sdk-core
40 | 4.5.3
41 |
42 |
43 | org.springframework.boot
44 | spring-boot-starter-aop
45 |
46 |
47 | com.google.code.gson
48 | gson
49 |
50 |
51 | io.github.openfeign
52 | feign-core
53 | 9.7.0
54 |
55 |
56 | org.springframework.boot
57 | spring-boot-starter-test
58 | test
59 |
60 |
61 | org.junit.vintage
62 | junit-vintage-engine
63 |
64 |
65 |
66 |
67 | org.springframework.boot
68 | spring-boot-starter
69 |
70 |
71 | org.projectlombok
72 | lombok
73 | true
74 |
75 |
76 | commons-codec
77 | commons-codec
78 |
79 |
80 | org.springframework.boot
81 | spring-boot-configuration-processor
82 | true
83 |
84 |
85 |
86 |
87 |
88 | org.apache.maven.plugins
89 | maven-jar-plugin
90 |
91 |
92 |
93 |
94 |
--------------------------------------------------------------------------------
/src/main/java/com/marvin/common/constant/ExceptionConstant.java:
--------------------------------------------------------------------------------
1 | package com.marvin.common.constant;
2 |
3 | public class ExceptionConstant {
4 |
5 | private static final String TYPE_CANNOT_BE_CONVERT = "type {%s} cannot convert to {%s},please check your configuration\n The following information may be help you:\n {%s}";
6 |
7 | public static final String VARIABLE_IS_NULL = "variable {%s} cannot convert be null";
8 |
9 | public static String typeConvertErrorText(String old, String newest, String varName) {
10 | return String.format(TYPE_CANNOT_BE_CONVERT, old, newest, varName);
11 | }
12 |
13 | static public class Internal {
14 |
15 | private static final String EXCEPTION = "error code is {%s},Please contact me if you see this Exception.\n mail: {%s}";
16 |
17 | //框架全局联系人邮件
18 | private static final String MAIL = "1261626796@qq.com";
19 |
20 | public static String internalException(String code) {
21 | return String.format(EXCEPTION, code, MAIL);
22 | }
23 |
24 | }
25 |
26 | }
27 |
--------------------------------------------------------------------------------
/src/main/java/com/marvin/common/enumeration/ExceptionType.java:
--------------------------------------------------------------------------------
1 | package com.marvin.common.enumeration;
2 |
3 | public enum ExceptionType {
4 |
5 | ERROR_OBTAINING_METHOD(9521,"Request method not found or empty."),
6 | UNABLE_FIND_CONTROLLER(9522,"Controller not found."),;
7 |
8 | private final Integer value;
9 | private final String message;
10 |
11 | public Integer getValue() {
12 | return value;
13 | }
14 |
15 | public String getMessage() {
16 | return message;
17 | }
18 |
19 | ExceptionType(Integer value, String message) {
20 | this.value = value;
21 | this.message = message;
22 | }
23 | }
24 |
--------------------------------------------------------------------------------
/src/main/java/com/marvin/common/enumeration/ListenType.java:
--------------------------------------------------------------------------------
1 | package com.marvin.common.enumeration;
2 |
3 | public enum ListenType {
4 |
5 | COMMON,WEB;
6 | }
7 |
--------------------------------------------------------------------------------
/src/main/java/com/marvin/common/enumeration/ProjectEnvironment.java:
--------------------------------------------------------------------------------
1 | package com.marvin.common.enumeration;
2 |
3 | //项目环境
4 | public enum ProjectEnvironment {
5 |
6 | DEVELOP("develop"),PREVIEW("preview"),ROLLBACK("rollback"),RELEASE("release"),TEST("test");
7 |
8 | private String name;
9 |
10 | ProjectEnvironment(String name) {
11 | this.name = name;
12 | }
13 |
14 | public String getName() {
15 | return name;
16 | }
17 |
18 | public void setName(String name) {
19 | this.name = name;
20 | }
21 |
22 |
23 | }
24 |
--------------------------------------------------------------------------------
/src/main/java/com/marvin/common/exception/CalmaRuntimeException.java:
--------------------------------------------------------------------------------
1 | package com.marvin.common.exception;
2 |
3 |
4 | import com.marvin.common.enumeration.ExceptionType;
5 |
6 | import java.io.Serializable;
7 |
8 | //本stater的内部异常,用来处理内部问题,在别的项目引用本项目时,可能会有本项目报错的问题,这个时候它就不能很好的吧问题抛出来,我在想这种时候怎么能吧问题让开发者知道,再去套娃抛出来还是
9 | public class CalmaRuntimeException extends RuntimeException implements Serializable {
10 |
11 | private static final Long serializableId = 0L;
12 |
13 | public CalmaRuntimeException(ExceptionType type, Throwable throwable) {
14 | super(type.getMessage(),throwable);
15 | }
16 |
17 | public CalmaRuntimeException(ExceptionType type) {
18 | super(type.getMessage());
19 | }
20 | }
21 |
--------------------------------------------------------------------------------
/src/main/java/com/marvin/common/exception/IGException.java:
--------------------------------------------------------------------------------
1 | package com.marvin.common.exception;
2 |
3 | import com.marvin.config.anno.WebIGExceptionListener;
4 | import org.springframework.lang.Nullable;
5 |
6 | /**
7 | * 标记不需要通知的异常,该异常被抛出的时候,calma将会忽略不纳入通知范围
8 | * 而只将其计入统计(以方便在您需要的时候将其情况叙述出来),
9 | * 用于项目中您觉得不重要的异常的情况.
10 | *
11 | * 例如:
12 | *