Skip to content

Latest commit

 

History

History
215 lines (157 loc) · 6.96 KB

README.md

File metadata and controls

215 lines (157 loc) · 6.96 KB

基于SpringAOP的异常通知spring-boot-starter

介绍

本项目是适用于企业开发，个人开发者，在平时开发中这个项目可能一点忙都帮不上你，但是当你的项目开发完成并且上线之后，它的作用就发挥出来了，因为它将代替你监控你的工程 ，在你不想去24小时不停盯着日志看是否报错的时候，在你下班或者休息的时间帮你照看你的项目， 直到它发生异常的时候，它将精准的把异常通过手机短信/钉钉来通知你项目的异常情况，这让你可以 在项目上线之后无需在让人一直守着它，甚至如果项目出问题的时候可以将锅直接甩到负责人身上， 而无需在它出异常的时候再去定位异常找出是谁写的，然后再通知他，这样效率很低，而本项目可以 自动化的将所有这一切令人不爽的工作自动化的处理，省时省力。

系统需求： Java Version Maven SpringBoot

快速入门

1.在你的工程的pom文件中将以下依赖加入

<dependency>
    <groupId>com.marvin</groupId>
    <artifactId>spring-boot-starter-calma</artifactId>
    <version>1.0.5</version>
</dependency>

2.在SpringBoot的配置文件：application.yml中做如下的配置：

spring:
  application:
    name: #项目名称，这里和project-name都可以给项目配置名称
calma:
  exceptionnotice:
    enabled: true #开启异常通知
    listen-type: common #普通模式
    project-name: a example project #项目名称
#Sms配置
#  sms:
#    enable: true #开启短信通知
#    regionId: 阿里云短信的regionId
#    accessKey: 阿里云短信的accessKey
#    secret: 阿里云短信的密钥
#    phoneNumbers: 你的手机号
#    signName: 阿里云短信的签名
#    templateCode: 阿里云短信的模板码
#钉钉
  dingding:
    enable: true #开启钉钉通知
    msgtype: text #发送的消息格式,text将通过普通文本方式发送，markdown将会将异常信息用markdown语法转化后发送
    phoneNumbers: #要@的人的手机号,格式为：136xxxxxxxx,159xxxxxxxx
    userIds: #要@的人的钉钉id，格式为：xxx,xxxx
    isAtAll: true #true 通知全体成员，false则不
    access_token: #钉钉机器人的token
    secret: #钉钉机器人的密钥

3.首先在你的项目中写如下案例

@Component//由于common方式通知实现是由spring aop方式实现，这里它必须被装载到spring中
@CalmaExceptionListener // 异常通知的监控来自这个注解
public class ExceptionTest {

    //@CalmaExceptionListener当然标注在某个方法上面就只监控被标注的方法
    public void testException(String param) {
        System.out.println("参数：" + param);
        throw new IllegalArgumentException("异常");
    }

}

4.测试

@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {

    @Autowired
    private ExceptionTest exceptionTest;

    @Test
    public void contextLoads() {
        exceptionTest.testException("冲冲冲！");
    }
}

然后你的钉钉就会钉d=====(￣▽￣*)b的一声 img.png

到这里测试就完成了，可以快乐的当一个帅锅侠了

从这开始讲解如何在web模式下使用本框架

1.在你的工程的pom文件中将以下依赖加入

<dependency>
    <groupId>com.marvin</groupId>
    <artifactId>spring-boot-starter-calma</artifactId>
    <version>1.0.5</version>
</dependency>

2.在SpringBoot的配置文件：application.yml中做如下的配置：

spring:
  application:
    name: #这里和project-name都可以配置项目名称
calma:
  exceptionnotice:
    enabled: true #开启异常通知
    listen-type: web #区别是这里是web，开启了web模式的征途了
    project-name: a example project #项目名称
  #Sms配置
  #  sms:
  #    enable: true #开启短信通知
  #    regionId: 阿里云短信的regionId
  #    accessKey: 阿里云短信的accessKey
  #    secret: 阿里云短信的密钥
  #    phoneNumbers: 你的手机号
  #    signName: 阿里云短信的签名
  #    templateCode: 阿里云短信的模板码
  #钉钉
  dingding:
    enable: true #开启钉钉通知
    msgtype: text #发送的消息格式,text将通过普通文本方式发送，markdown将会将异常信息用markdown语法转化后发送
    phoneNumbers: #要@的人的手机号,格式为：136xxxxxxxx,159xxxxxxxx
    userIds: #要@的人的钉钉id，格式为：xxx,xxxx
    isAtAll: true #true 通知全体成员，false则不
    access_token: #钉钉机器人的token
    secret: #钉钉机器人的密钥

3.当然是像上面一样写个模拟的控制器了，你还在期待什么

@RestController//web方式只需要将其声明为控制器就可以例如：@Controller
@CalmaExceptionListener//写在这里可以让所有的方法都被监控
public class ExampleController{

  @GetMapping("/testFoo")
  //@CalmaExceptionListener当然标注在某个方法上面就只监控被标注的方法
  public void foo(String param){
    int i = 1/0;
  }
  
  @PostMapping("/testFoo")
  public void foo(Integer param){
    param = param/0;
  }
  
}

4.请求它，无所谓用httpclient或者postman或者其他方式，这里由于我懒得截图，，就没图了

然后你的钉钉再一次钉d=====(￣▽￣*)b img_1.png 到这里为止，web模式的这个测试也完了，还不快点去试试？

关于钉钉机器人的配置：
1.找到你所需要通知的群

ding0.png

2.点击群设置，在pc端，它通常在右上角的位置

ding1.png

3.在群设置中找到机器人选项，进入

ding2.png

4.点击添加机器人

ding3.png

5.继续点击机器人

ding4.png

6.选中自定义机器人

ding5.png

7.给你的机器人取个名字并找到安全设置，勾选加签作为认证方式，点击复制，将签名复制到你的项目中的ding.secret的值的位置

ding6.png

8.在上一步中，点击完成后，你需要将钉钉的access token同样复制到你的配置文件中的ding.access_token的值的位置中

ding7.png

9.到这一步钉钉机器人的配置就完成了

ding8-1.png

未完待续.............

(有问题请联系我的Email：1261626796@qq.com，我会很快回复的)

下个版本的期待：

1.支持微服务的监控通知

_ps:终于吧markdown补充好了，之前一直有其他事情没空搞