微信小程序開發最基礎的功能就是用戶的認證過程,在使用spring cloud微服務架構進行開發時為了簡化開發周期,我們參考Wafer的架構,實現了java版本的會話服務器,由于目前wafer1官方已經停止更新,Wafer2服務器端完全托管在騰訊云,不對外公開會話服務器的實現,因此我們開發了wxss-spring-boot-starter項目,項目實現的會話服務器接口參考了Wafer2的小程序客戶端wafer2-client-sdk的代碼,目前與其完全兼容(僅登錄接口)。
使用方法目前只支持Spring Boot 2.0以上版本。 在您的spring boot項目中引入本項目依賴,然后增加相應功能注解和配置即可。
maven: <dependency> <groupId>com.venusource.ms.base</groupId> <artifactId>wxss-spring-boot-starter</artifactId> <version>1.0.0</version> </dependency>
gradle: compile('com.venusource.ms.base:wxss-spring-boot-starter:1.0.0')
會話服務器
實現參考php版本 wafer-session-server ,使用前請詳細閱讀。 package com.venusource.ms.base.wxssdemo; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import com.venusource.ms.base.wxss.EnableWeChatSessionServer; @SpringBootApplication @EnableWeChatSessionServer //啟用會話服務器 public class WxssSpringBootStarterDemoApplication { public static void main(String[] args) { SpringApplication.run(WxssSpringBootStarterDemoApplication.class, args); } }
在spring的配置文件application.properties中配置小程序的appid和secret,如下所示: weixin.app.appid= yourappid weixin.app.secret= yoursecret
啟動服務后,會自動在服務內對外暴露/mina_auth 會話服務接口。 接口與php版本完全相同,見wafer-session-server。 注:會話服務會和微信的服務器進行通信,獲取session_key,需要能訪問外網,同時為了安全性會話服務一般只對內部服務提供服務,不對外暴露接口,因此如果使用Spring Cloud的服務網關,需要把它忽略。
Session數據的存儲 默認情況下,所有的用戶數據存儲在內存內(不推薦),您需要實現如下接口來存儲自己的數據: package com.venusource.ms.base.wxss.service; import com.venusource.ms.base.wxss.domain.CSessionInfo; public interface SessionInfoStoreService { CSessionInfo add(CSessionInfo sessionInfo); void remove(CSessionInfo sessionInfo); CSessionInfo update(CSessionInfo sessionInfo); CSessionInfo get(String skey); } 在實現類內注解@Service即可,系統會自動替換session存儲類型。
登錄入口登錄入口是為wafer2客戶端提供的用戶授權登錄地址,您可以自己基于上面的會話服務器單獨開發,也可以在服務內增加注解@EnableWeChatWaferLoginEndpoint,自動提供登錄入口/login,如下所示: package com.venusource.ms.base.wxssdemo; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import com.venusource.ms.base.wxss.EnableWeChatWaferLoginEndpoint; @SpringBootApplication @EnableWeChatWaferLoginEndpoint //啟用wafer2登錄入口 public class WxssSpringBootStarterDemoApplication { public static void main(String[] args) { SpringApplication.run(WxssSpringBootStarterDemoApplication.class, args); } }
在spring的配置文件application.properties中配置會話服務器地址,如下所示: weixin.wafer.authServerUrl = http://ms-session-server/mina_auth/
ms-session-server為在Eureka中注冊的服務名,因為我們使用ribbon作客戶端負載,可以部署多個ms-session-server服務。
業務服務用戶信息 基于Spring Cloud微服務架構開發時,業務服務需要獲取用戶信息時,starter可提供自動的參數注入功能,只需要在業務服務內增加注解@EnableWeChatUserInfoArgumentInjection即可,如下所示: package com.venusource.app.oa.microserviceprovideruser; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; import com.venusource.ms.base.wxss.EnableWeChatUserInfoArgumentInjection; @SpringBootApplication @EnableDiscoveryClient @EnableWeChatUserInfoArgumentInjection //啟用微信用戶信息注入。 public class MicroserviceProviderUserApplication { public static void main(String[] args) { SpringApplication.run(MicroserviceProviderUserApplication.class, args); } }
在spring的配置文件application.properties中配置會話服務器地址,如下所示: weixin.wafer.authServerUrl = http://ms-session-server/mina_auth/
ms-session-server為在Eureka中注冊的服務名,因為我們使用ribbon作客戶端負載,可以部署多個ms-session-server服務。
在controller的方法參數中,會自動注入UserInfo類,可以直接獲取登錄用戶的信息,如下所示: @GetMapping("/product/{id}") public Product showInfo(@PathParam Long id, UserInfo userInfo) { String uid = userInfo.getOpenId(); ... } 項目目前代碼還很丑陋,測試還不全面,如您在使用中發現問題,請及時告訴我們,或直接pull request。 |