# dingtalk-robot

**Repository Path**: leebing/dingtalk-robot

## Basic Information

- **Project Name**: dingtalk-robot
- **Description**: 一个用Java打造的方便钉钉群机器人推送消息的轮子
- **Primary Language**: Java
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 54
- **Created**: 2018-04-08
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### dingtalk-robot

一个用Java打造的方便钉钉群机器人推送消息的轮子，其实并没有多大的创新，只是把我们常用的一些场景给集成封装了下。设计的时候参考了下面几个开源项目的设计思路

- [小柒2012/spring-boot-webhook](https://gitee.com/52itstyle/spring-boot-webhook)
- [xiaoyixie/spring-boot-dingtalk-robot-starter](https://gitee.com/xiaoyixie/spring-boot-dingtalk-robot-starter)
- [钉钉官方JavaSDK 0.9.0](https://download.alicdn.com/dingtalk-desktop/sdk/dingtalk-chatbot-sdk-0.9.0.zip)

### API文档
- [钉钉官方Wiki文档](https://open-doc.dingtalk.com/docs/doc.htm?spm=a219a.7629140.0.0.7b1HKw&treeId=257&articleId=105735&docType=1)
- [本程序API文档，待继续完善](./docs/javadocs/index.html)

### HelloWorld
starter工程仅依赖SpringBoot的`spring-boot-autoconfigure`和`spring-boot-starter-web`模块，使用方法同样简单。

1.在pom文件中引入依赖，当前版本`1.0.0.RELEASE`
```        
<dependency>
   <groupId>cn.snowheart</groupId>
   <artifactId>spring-boot-dingtalk-robot-starter</artifactId>
   <version>${dingtalk-robot-version}</version>
</dependency>
```

2.在application.properties中配置钉钉机器人的WebHook地址
```
dingtalk.robot.webhook=https://oapi.dingtalk.com/robot/send?access_token=7eb0673858d5b8636cc4189a708517478d3444f25fe887aef73c7bf99756127f
```

3.在应用Application启动类上加`@EnabledDingTalkRobot`注解之后，即可启动调用钉钉机器人的WebHook服务了。
```
@EnabledDingTalkRobot
@SpringBootApplication
public class DemoApplication {

   public static void main(String[] args) {
       SpringApplication.run(DemoApplication.class, args);
   }

}
```

### TODO List
1. 补充完善使用手册及API文档
2. 支持通过配置方式创建多个`DingTalkRobotClient`
3. 完善Demo模块程序，做一个可视化页面
...

### Note
如果你发现了程序BUG或者有其他好的建议，可以通过发邮件[**sxjwzxlwx@yeah.net**]或者Issues的方式联系我，不胜感激。

- 折腾了小半天，实在没办法提交到中央仓库，总是报错。无奈只能现行发布到自己的[私服](http://nexus.snowheart.cn/nexus)，之后再研究怎么往中央仓库发布。