diff --git a/README.md b/README.md index 9a36613..20f1a24 100644 --- a/README.md +++ b/README.md @@ -16,55 +16,63 @@ Spring Boot API Project for WeChat-J library. 我们旨在提供一个初始化的开发框架,能够让应用在使用 Spring Boot 框架的基础上让你的微信公众号快速接入微信平台。 # 项目配置 + 和所有的 Java 项目的标准配置一样,你首先需要把依赖添加到你的项目中,然后完成属性文件配置。 在这个基础上,需要有一些先决条件。 ## 先决条件 -需要对微信公众号进行测试,你首先需要有一个微信公众号,如果没有的话,你可以使用微信提供的测试公众号来获得需要的 appID 和 appsecret。 + +需要对微信公众号进行测试,你首先需要有一个微信公众号,如果没有的话,你可以使用微信提供的测试公众号来获得需要的 appID 和 +appsecret。 + * [微信测试平台获得测试账号](https://www.ossez.com/t/topic/14281) - ## 依赖 + 项目使用的是 Maven,如果你只希望使用 WeChat-J,你只需要往你的项目中添加依赖即可。 因为我们目前还在对项目进行整理,所以还是使用的 SNAPSHOT 版本。 ```xml - - com.ossez.wechat - wechat-j-oa - 0.0.1-SNAPSHOT - + + + com.ossez.wechat + wechat-j-oa + 0.0.1-SNAPSHOT + ``` ## 修改配置文件 - ```properties - # 公众号配置(必填) - wx.mp.appId = appId - wx.mp.secret = @secret - wx.mp.token = @token - wx.mp.aesKey = @aesKey - # 存储配置redis(可选) - wx.mp.config-storage.type = Jedis # 配置类型: Memory(默认), Jedis, RedisTemplate - wx.mp.config-storage.key-prefix = wx # 相关redis前缀配置: wx(默认) - wx.mp.config-storage.redis.host = 127.0.0.1 - wx.mp.config-storage.redis.port = 6379 - #单机和sentinel同时存在时,优先使用sentinel配置 - #wx.mp.config-storage.redis.sentinel-ips=127.0.0.1:16379,127.0.0.1:26379 - #wx.mp.config-storage.redis.sentinel-name=mymaster - # http客户端配置 - wx.mp.config-storage.http-client-type=httpclient # http客户端类型: HttpClient(默认), OkHttp, JoddHttp - wx.mp.config-storage.http-proxy-host= - wx.mp.config-storage.http-proxy-port= - wx.mp.config-storage.http-proxy-username= - wx.mp.config-storage.http-proxy-password= - # 公众号地址host配置 - #wx.mp.hosts.api-host=http://proxy.com/ - #wx.mp.hosts.open-host=http://proxy.com/ - #wx.mp.hosts.mp-host=http://proxy.com/ - ``` + +```properties +# WeChat Official Cccount Conf +wechat.official-account.app-id=appId +wechat.official-account.secret=secret +wechat.official-account.token=token +wechat.official-account.aes-key=aesKey +# 存储配置redis(可选) +wx.mp.config-storage.type=Jedis # 配置类型: Memory(默认), Jedis, RedisTemplate +wx.mp.config-storage.key-prefix=wx # 相关redis前缀配置: wx(默认) +wx.mp.config-storage.redis.host=127.0.0.1 +wx.mp.config-storage.redis.port=6379 +#单机和sentinel同时存在时,优先使用sentinel配置 +#wx.mp.config-storage.redis.sentinel-ips=127.0.0.1:16379,127.0.0.1:26379 +#wx.mp.config-storage.redis.sentinel-name=mymaster +# http客户端配置 +wx.mp.config-storage.http-client-type=httpclient # http客户端类型: HttpClient(默认), OkHttp, JoddHttp +wx.mp.config-storage.http-proxy-host= +wx.mp.config-storage.http-proxy-port= +wx.mp.config-storage.http-proxy-username= +wx.mp.config-storage.http-proxy-password= +# 公众号地址host配置 +#wx.mp.hosts.api-host=http://proxy.com/ +#wx.mp.hosts.open-host=http://proxy.com/ +#wx.mp.hosts.mp-host=http://proxy.com/ +``` + ## 自动注入的类型 + - `WxMpService` - `WxMpConfigStorage`