README.md 3.2 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 7 8 9 10 11
## 推荐
- Spring boot 微服务,高效开发之 mica 工具集:https://gitee.com/596392912/mica

- `pig` 宇宙最强微服务(架构师必备):https://gitee.com/log4j/pig

- `SpringBlade` 完整的线上解决方案(系统生产必备):https://gitee.com/smallc/SpringBlade
如梦技术's avatar
v1.3.1  
如梦技术 已提交
12

如梦技术's avatar
如梦技术 已提交
13 14 15
加入【如梦技术】Spring QQ群:479710041,了解更多。

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

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

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

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

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

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

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

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

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

如梦技术's avatar
v1.3.0  
如梦技术 已提交
69
## 更新说明
如梦技术's avatar
如梦技术 已提交
70 71
>## 2019-03-07 v1.3.3
> 升级到 `gradle 5.2.1`。
如梦技术's avatar
如梦技术 已提交
72

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

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

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

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

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

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

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

如梦技术's avatar
如梦技术 已提交
91 92 93
## 捐助共勉
 <img src="https://gitee.com/uploads/images/2018/0311/153544_5afb12b1_372.jpeg" width="250px"/>
 <img src="https://gitee.com/uploads/images/2018/0311/153556_679db579_372.jpeg" width="250px"/>