# 对接企业微信接口封装服务

**Repository Path**: xiongwei-jiang/wxwork-spring-boot-starter

## Basic Information

- **Project Name**: 对接企业微信接口封装服务
- **Description**: 这是一个 Spring Boot 自定义 starter 项目，使用 Maven 引入自己项目后，通过配置 yaml 文件，以及在启动类上加上一个启用注解 @EnableWXWork，即可调用企业微信接口服务。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: http://www.aptx-4869.xyz/
- **GVP Project**: No

## Statistics

- **Stars**: 15
- **Forks**: 8
- **Created**: 2020-07-29
- **Last Updated**: 2024-07-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 对接企业微信接口封装服务

#### 总体介绍

这是一个 `Spring Boot` 自定义 `starter` 项目，使用 `Maven` 引入自己项目后，通过配置 `yaml` 文件，以及在启动类上加上一个启用注解 `@EnableWXWork`，即可调用企业微信接口服务。

#### 项目依赖

```
org.springframework.boot:spring-boot-starter-web:2.5.2
org.springframework.boot:spring-boot-configuration-processor:2.5.2
org.projectlombok:lombok:1.18.20
org.ehcache:ehcache:3.9.4
org.dom4j:dom4j:2.1.3
```

#### 编译等级

```
JDK8
```

#### 使用说明

1. 使用 Maven 引入项目
2. 配置 yaml 文件
3. 启动类上加注解 @EnableWXWork
4. 注入 WXWorkService 接口
5. 如果需要使用缓存服务，注入 EhcacheService 接口

#### Maven 坐标

```xml

<dependency>
    <groupId>xyz.aptx-4869</groupId>
    <artifactId>wxwork-spring-boot-starter</artifactId>
    <version>LATEST</version>
</dependency>
```

#### Yaml 文件配置示例

1. 关于 `wxwork` 配置

```yaml
# 企业微信
wxwork:
  # 通讯录同步应用
  contact:
    # 自定义名称
    name_0x00:
      corp-id: "企业编号"
      secret: "通讯录同步应用密钥"
    # 自定义名称
    name_0x01:
      corp-id: "企业编号"
      secret: "通讯录同步应用密钥"
  # 打卡应用
  checkin:
    # 自定义名称
    name_0x00:
      corp-id: "企业编号"
      secret: "打卡应用密钥"
    # 自定义名称
    name_0x01:
      corp-id: "企业编号"
      secret: "打卡应用密钥"
  # 打卡应用
  app:
    # 自定义名称
    name_0x00:
      corp-id: "企业编号"
      agent-id: 自建应用编号
      secret: "自建应用密钥"
    # 自定义名称
    name_0x01:
      corp-id: "企业编号"
      agent-id: 自建应用编号
      secret: "自建应用密钥"
  # 回调
  callback:
    # 自定义名称
    name_0x00:
      corp-id: "企业编号"
      token: "回调令牌"
      encoding-aes-key: "回调密钥"
    # 自定义名称
    name_0x01:
      corp-id: "企业编号"
      token: "回调令牌"
      encoding-aes-key: "回调密钥"
  # 机器人
  bot:
    # 自定义名称
    name_0x00:
      webhook-url: "机器人消息推送地址"
    # 自定义名称
    name_0x01:
      webhook-url: "机器人消息推送地址"
```

2. 关于 `ehcache` 配置

```yaml
# 缓存
ehcache:
  # JVM 堆内存中缓存 key 的数量（默认 32 个）
  heap: 32
  # 堆外缓存大小，必须小于磁盘缓存大小，单位：MB（默认 32 MB）
  off-heap: 32
  # 磁盘缓存目录（支持相对路径，默认 ehcache）
  disk-dir: "ehcache"
  # 磁盘缓存大小，单位：MB（默认 64 MB）
  disk: 64
  # 是否持久化到磁盘（默认：否）
  persistent: false
  # 缓存过期时间，单位：秒（0-永不过期，默认 7200 秒）
  ttl: 7200
```

3. 关于 `RestTemplate` 配置

```yaml
rest-template:
  connect-timeout: 30000 # 连接超时，单位：毫秒
  read-timeout: 30000 # 读超时，单位：毫秒
```

#### 关于作者

1. 作者：天之蓝
2. 邮箱：<1305611946@qq.com>
3. 主页：[欣然之韵](http://www.aptx-4869.xyz/)

> Q：为什么取名欣然之韵？
> A：欣然，愉快的样子；韵，优雅。