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

**Repository Path**: pf121x/wxwork-spring-boot-starter

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 8
- **Created**: 2021-12-27
- **Last Updated**: 2022-05-24

## 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:
  # 1.企业 corpId
  corp-id: "corp-id"
  addr-book:
    # 2.通讯录 secret，appIndex 为 -1
    secret: "addr-book-secret"
  checkin:
    # 3.打卡 secret，appIndex 为 -2
    secret: "checkin-secret"
  app:
    # 4.自建应用 agentId，支持多个，agentId 和 secret 必须成对出现，appIndex 从 0 开始
    agent-id: [ 1000000, 1000001 ]
    # 5.自建应用 secret，支持多个，agentId 和 secret 必须成对出现，appIndex 从 0 开始
    secret: [ "app-secret-1000000", "app-secret-1000001" ]
  callback:
    # 6.自建应用回调 token，支持多个，token 和 encodingAesKey 必须成对出现，callbackIndex 从 0 开始
    token: [ "callback-token", "token" ]
    # 7.自建应用回调 encodingAesKey，支持多个，token 和 encodingAesKey 必须成对出现，callbackIndex 从 0 开始
    encoding-aes-key: [ "callback-encoding-aes-key", "encoding-aes-key" ]
  bot:
    # 8.机器人 webhook 地址，支持多个，botIndex 从 0 开始
    webhook-url: [ "bot-webhook-url", "webhook-url" ]
```

2. 关于 ehcache 配置

```yaml
# 缓存
ehcache:
  # 1.JVM 内存中缓存的 key 数量（默认 1024 个）
  heap: 1024
  # 2.堆外内存大小，单位：MB（默认 128 MB）
  off-heap: 128
  # 3.磁盘持久化目录（支持相对路径，若值为空，则不进行持久化）
  disk-dir: "ehcache"
  # 4.持久化到磁盘的大小，单位：MB（当且仅当 diskDir 不为空时生效，默认 512 MB）
  disk: 512
  # 5.缓存过期时间，单位：秒（0-永不过期，默认 7200 秒）
  ttl: 7200
```

#### 关于作者

1. 作者：天之蓝
2. 个人主页：[欣然之韵](http://www.aptx-4869.xyz/)

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

3. 邮箱：<1305611946@qq.com>