README.md 4.0 KB
Newer Older
如梦技术's avatar
如梦技术 已提交
1 2 3
## 说明
jfinal weixin 的 spring boot starter,这个starter是为了方便boot用户使用。

如梦技术's avatar
如梦技术 已提交
4
具体demo请查看:`spring-boot-weixin-demo`[JFinal-weixin文档](https://gitee.com/jfinal/jfinal-weixin/wikis/pages?title=Home)
如梦技术's avatar
如梦技术 已提交
5

如梦技术's avatar
如梦技术 已提交
6
## 开源推荐
如梦技术's avatar
如梦技术 已提交
7
- Spring boot 微服务,高效开发之 mica 工具集:https://gitee.com/596392912/mica
如梦技术's avatar
如梦技术 已提交
8 9 10 11 12
- `Avue` 一款基于vue可配置化的神奇框架:[https://gitee.com/smallweigit/avue](https://gitee.com/smallweigit/avue)
- `pig` 宇宙最强微服务(架构师必备):[https://gitee.com/log4j/pig](https://gitee.com/log4j/pig)
- `SpringBlade` 完整的线上解决方案(企业开发必备):[https://gitee.com/smallc/SpringBlade](https://gitee.com/smallc/SpringBlade)
- `IJPay` 支付SDK让支付触手可及:[https://gitee.com/javen205/IJPay](https://gitee.com/javen205/IJPay)
- 加入【如梦技术】Spring QQ群:479710041,了解更多。
如梦技术's avatar
如梦技术 已提交
13 14

## Jar包依赖(最新)
如梦技术's avatar
如梦技术 已提交
15 16 17 18
```xml
<dependency>
    <groupId>net.dreamlu</groupId>
    <artifactId>spring-boot-starter-weixin</artifactId>
如梦技术's avatar
如梦技术 已提交
19
    <version>1.4.0</version>
如梦技术's avatar
如梦技术 已提交
20 21 22 23 24 25
</dependency>
```

## 使用
### 消息
#### 公众号
如梦技术's avatar
v1.3.0  
如梦技术 已提交
26
1. 继承`DreamMsgControllerAdapter`,实现需要重写的消息。
如梦技术's avatar
如梦技术 已提交
27

如梦技术's avatar
v1.3.0  
如梦技术 已提交
28
2. 类添加注解`@WxMsgController`,注解value为你的消息地址,使用/weixin/wx,已经组合[@RequestMapping和@Controller]
如梦技术's avatar
如梦技术 已提交
29 30

### 小程序
如梦技术's avatar
v1.3.0  
如梦技术 已提交
31
1. 继承`DreamWxaMsgController`,实现需要重写的消息。
如梦技术's avatar
如梦技术 已提交
32

如梦技术's avatar
v1.3.0  
如梦技术 已提交
33
2. 添加注解`@WxMsgController`,注解value为你的消息地址,使用/weixin/wxa,已经组合[@RequestMapping和@Controller]
如梦技术's avatar
如梦技术 已提交
34 35

### Api
如梦技术's avatar
v1.3.0  
如梦技术 已提交
36
- 类添加`@WxApi`,注解value为你的消息地址,使用/weixin/api,已经组合[@RequestMapping和@Controller]
如梦技术's avatar
如梦技术 已提交
37 38

### 配置
如梦技术's avatar
如梦技术 已提交
39 40
| 配置项 | 默认值 | 说明 |
| ----- | ------ | ------ |
如梦技术's avatar
如梦技术 已提交
41
| dream.weixin.access-token-cache | dreamWeixinCache | 缓存名,需要开启spring cache |
如梦技术's avatar
如梦技术 已提交
42
| dream.weixin.app-id-key | appId | 多公众号参数名,如:/weixin/wx?appId=xxx |
如梦技术's avatar
如梦技术 已提交
43
| dream.weixin.dev-mode | false | 开发模式 |
如梦技术's avatar
v1.3.0  
如梦技术 已提交
44
| dream.weixin.url-patterns | /weixin/* | weixin 消息处理spring拦截器url前缀 |
如梦技术's avatar
如梦技术 已提交
45
| dream.weixin.wx-configs | 公众号的配置 | 多公众号配置 |
如梦技术's avatar
如梦技术 已提交
46
| dream.weixin.wxa-configs | 小程序配置 | 小程序配置 |
如梦技术's avatar
如梦技术 已提交
47

如梦技术's avatar
如梦技术 已提交
48
`注意`
49 50 51 52 53 54 55 56 57 58 59
- demo中的`application.yml`
```yml
dream:
  weixin:
    dev-mode: true
    wx-configs:
      - appId: wx9803d1188fa5fbda
        appSecret: db859c968763c582794e7c3d003c3d87
      - appId: wxc03edcd008ad1e70
        appSecret: 11ed9e2b8e3e3c131e7be320a42b2b5a
        token: 123456
如梦技术's avatar
如梦技术 已提交
60 61
        encodingAesKey: xxx
        messageEncrypt: true
如梦技术's avatar
如梦技术 已提交
62 63 64
    wxa-configs:
      - app-id: wx4f53594f9a6b3dcb
        app-secret: eec6482ba3804df05bd10895bace0579
65 66
```

如梦技术's avatar
如梦技术 已提交
67 68 69
- cache使用spring的cache,需要`@EnableCaching`开启。
- `access-token-cache`建议配置有效时间7100秒。

如梦技术's avatar
v1.3.0  
如梦技术 已提交
70
## 更新说明
如梦技术's avatar
如梦技术 已提交
71 72 73 74 75
>## 2020-05-01 v1.4.0
> 支持多小程序消息,**注意:** yml 配置 key 由 dream.weixin.wxa-config 改为 dream.weixin.wxa-configs。
> 支持自定义公众号和小程序配置加载,可用于从数据库等加载配置。
> 升级 jfinal、jfinal-weixin 版本。

如梦技术's avatar
如梦技术 已提交
76 77 78
>## 2019-08-01 v1.3.6
> 升级 jfinal、jfinal-weixin、okhttp 版本。

如梦技术's avatar
如梦技术 已提交
79 80 81
>## 2019-03-17 v1.3.5
> 解决单公众号下消息报错

82 83 84
>## 2019-03-17 v1.3.4
> 解决小程序,启用并设置消息推送配置校验不通过的问题。

如梦技术's avatar
如梦技术 已提交
85 86
>## 2019-03-07 v1.3.3
> 升级到 `gradle 5.2.1`。
如梦技术's avatar
如梦技术 已提交
87

如梦技术's avatar
如梦技术 已提交
88
> 升级 `JFinal` 到 `3.6`。
如梦技术's avatar
如梦技术 已提交
89

如梦技术's avatar
如梦技术 已提交
90
> 升级 `JFinal Weixin` 到 `2.3`。
如梦技术's avatar
如梦技术 已提交
91

如梦技术's avatar
如梦技术 已提交
92
> 使用 `mica-auto` 生成 `spring.factories`、`devtools` 配置。
如梦技术's avatar
如梦技术 已提交
93 94

> `InMsg` 消息对象采用 `request` 存储,去掉 `@WxMsgController` 中的 Scope 配置,将消息控制器还原为单例。
如梦技术's avatar
如梦技术 已提交
95

如梦技术's avatar
v1.3.2  
如梦技术 已提交
96 97 98
>## 2018-12-23 v1.3.2
> 修复 `SpringAccessTokenCache` 没有配置的问题,感谢 qq:`A梦的小C` 反馈。

如梦技术's avatar
v1.3.1  
如梦技术 已提交
99 100 101
>## 2018-12-23 v1.3.1
> `WeixinAppConfig` 改为实现 `SmartInitializingSingleton`。

如梦技术's avatar
v1.3.0  
如梦技术 已提交
102 103 104 105
>## 2018-05-03 v1.3.0
> 弃用`@EnableDreamWeixin`,导入jar包即可享用。
> 将消息路由改为spring接管。

如梦技术's avatar
如梦技术 已提交
106 107 108 109 110
## 微信公众号

![如梦技术](docs/dreamlu-weixin.jpg)

精彩内容每日推荐!