java开发者一行代码搞定微信小程序用户认证

微信小程序开发最基础的功能就是用户的认证过程,在使用spring cloud微服务架构进行开发时为了简化开发周期,我们参考Wafer的架构,实现了java版本的会话服务器,由于目前wafer1官方已经停止更新,Wafer2服务器端完全托管在腾讯云,不对外公开会话服务器的实现,因此我们开发了wxss-spring-boot-starter项目,项目实现的会话服务器接口参考了Wafer2的小程序客户端wafer2-client-sdk的代码,目前与其完全兼容(仅登录接口)。

项目地址:https://github.com/ChangjunZhao/wxss-spring-boot-starter

使用方法

目前只支持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 ,使用前请详细阅读。

在Spring Boot的入口类中加入@EnableWeChatSessionServer注解即可。如下所示:

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。

LICENSE

MIT


看完文章有收获的话记得打赏、关注、点赞!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容