快速开始

1. 基础配置

<dependency>  <groupId>com.xkcoding</groupId>  <artifactId>justauth-spring-boot-starter</artifactId>  <version>1.3.2</version></dependency>

justauth:enabled:truetype:QQ:client-id:10**********6client-secret:1f7d08**********5b7**********29eredirect-uri:http://oauth.xkcoding.com/demo/oauth/qq/callbackcache:type:default

@Slf4j@RestController@RequestMapping("/oauth")@RequiredArgsConstructor(onConstructor_ =@Autowired)publicclassTestController {privatefinalAuthRequestFactoryfactory;@GetMappingpublicList<String>list() {returnfactory.oauthList();    }@GetMapping("/login/{type}")publicvoidlogin(@PathVariableStringtype,HttpServletResponseresponse)throwsIOException {AuthRequestauthRequest =factory.get(type);response.sendRedirect(authRequest.authorize(AuthStateUtils.createState()));    }@RequestMapping("/{type}/callback")publicAuthResponselogin(@PathVariableStringtype,AuthCallbackcallback) {AuthRequestauthRequest =factory.get(type);AuthResponseresponse =authRequest.login(callback);log.info("【response】= {}",JSONUtil.toJsonStr(response));returnresponse;    }}

2. 缓存配置

2.1. 默认缓存实现

justauth:cache:type:default

2.2. Redis 缓存实现

<dependency>  <groupId>org.springframework.boot</groupId>  <artifactId>spring-boot-starter-data-redis</artifactId></dependency><!-- 对象池，使用redis时必须引入--><dependency>  <groupId>org.apache.commons</groupId>  <artifactId>commons-pool2</artifactId></dependency>

justauth:cache:type:redis# 缓存前缀，目前只对redis缓存生效，默认 JUSTAUTH::STATE::prefix:''# 超时时长，目前只对redis缓存生效，默认3分钟timeout:1hspring:redis:host:localhost# 连接超时时间（记得添加单位，Duration）timeout:10000ms# Redis默认情况下有16个分片，这里配置具体使用的分片# database: 0lettuce:pool:# 连接池最大连接数（使用负值表示没有限制） 默认 8max-active:8# 连接池最大阻塞等待时间（使用负值表示没有限制） 默认 -1max-wait:-1ms# 连接池中的最大空闲连接 默认 8max-idle:8# 连接池中的最小空闲连接 默认 0min-idle:0

2.3. 自定义缓存实现

justauth:cache:type:custom

/** * <p> * 自定义缓存实现 * </p> * * @author yangkai.shen * @date Created in 2019/8/31 12:53 */publicclassMyAuthStateCacheimplementsAuthStateCache {/**     * 存入缓存     *     * @param key   缓存key     * @param value 缓存内容     */@Overridepublicvoidcache(Stringkey,Stringvalue) {// TODO: 自定义存入缓存    }/**     * 存入缓存     *     * @param key     缓存key     * @param value   缓存内容     * @param timeout 指定缓存过期时间（毫秒）     */@Overridepublicvoidcache(Stringkey,Stringvalue,longtimeout) {// TODO: 自定义存入缓存    }/**     * 获取缓存内容     *     * @param key 缓存key     * @return 缓存内容     */@OverridepublicStringget(Stringkey) {// TODO: 自定义获取缓存内容returnnull;    }/**     * 是否存在key，如果对应key的value值已过期，也返回false     *     * @param key 缓存key     * @return true：存在key，并且value没过期；false：key不存在或者已过期     */@OverridepublicbooleancontainsKey(Stringkey) {// TODO: 自定义判断key是否存在returnfalse;    }}

/** * <p> * 自定义缓存装配 * </p> * * @author yangkai.shen * @date Created in 2019/8/31 12:29 */@ConfigurationpublicclassAuthStateConfiguration {@BeanpublicAuthStateCacheauthStateCache() {returnnewMyAuthStateCache();    }}

3. 自定义第三方平台配置

/** * <p> * 扩展的自定义 source * </p> * * @author yangkai.shen * @date Created in 2019/10/9 14:14 */publicenumExtendSourceimplementsAuthSource {/**     * 测试     */TEST {/**         * 授权的api         *         * @return url         */@OverridepublicStringauthorize() {return"http://authorize";        }/**         * 获取accessToken的api         *         * @return url         */@OverridepublicStringaccessToken() {return"http://accessToken";        }/**         * 获取用户信息的api         *         * @return url         */@OverridepublicStringuserInfo() {returnnull;        }/**         * 取消授权的api         *         * @return url         */@OverridepublicStringrevoke() {returnnull;        }/**         * 刷新授权的api         *         * @return url         */@OverridepublicStringrefresh() {returnnull;        }    }}

/** * <p> * 测试用自定义扩展的第三方request * </p> * * @author yangkai.shen * @date Created in 2019/10/9 14:19 */publicclassExtendTestRequestextendsAuthDefaultRequest {publicExtendTestRequest(AuthConfigconfig) {super(config,ExtendSource.TEST);    }publicExtendTestRequest(AuthConfigconfig,AuthStateCacheauthStateCache) {super(config,ExtendSource.TEST,authStateCache);    }/**     * 获取access token     *     * @param authCallback 授权成功后的回调参数     * @return token     * @see AuthDefaultRequest#authorize()     * @see AuthDefaultRequest#authorize(String)     */@OverrideprotectedAuthTokengetAccessToken(AuthCallbackauthCallback) {returnAuthToken.builder().openId("openId").expireIn(1000).idToken("idToken").scope("scope").refreshToken("refreshToken").accessToken("accessToken").code("code").build();    }/**     * 使用token换取用户信息     *     * @param authToken token信息     * @return 用户信息     * @see AuthDefaultRequest#getAccessToken(AuthCallback)     */@OverrideprotectedAuthUsergetUserInfo(AuthTokenauthToken) {returnAuthUser.builder().username("test").nickname("test").gender(AuthUserGender.MALE).token(authToken).source(this.source.toString()).build();    }/**     * 撤销授权     *     * @param authToken 登录成功后返回的Token信息     * @return AuthResponse     */@OverridepublicAuthResponserevoke(AuthTokenauthToken) {returnAuthResponse.builder().code(AuthResponseStatus.SUCCESS.getCode()).msg(AuthResponseStatus.SUCCESS.getMsg()).build();    }/**     * 刷新access token （续期）     *     * @param authToken 登录成功后返回的Token信息     * @return AuthResponse     */@OverridepublicAuthResponserefresh(AuthTokenauthToken) {returnAuthResponse.builder().code(AuthResponseStatus.SUCCESS.getCode()).data(AuthToken.builder().openId("openId").expireIn(1000).idToken("idToken").scope("scope").refreshToken("refreshToken").accessToken("accessToken").code("code").build()).build();    }}

justauth:enabled:trueextend:enum-class:com.xkcoding.justauthspringbootstarterdemo.extend.ExtendSourceconfig:TEST:request-class:com.xkcoding.justauthspringbootstarterdemo.extend.ExtendTestRequestclient-id:xxxxxxclient-secret:xxxxxxxxredirect-uri:http://oauth.xkcoding.com/demo/oauth/test/callback

附录

1. 基础配置

2. SNAPSHOT版本

<repositories><!--阿里云私服-->    <repository>      <id>aliyun</id>      <name>aliyun</name>      <url>http://maven.aliyun.com/nexus/content/groups/public</url>    </repository><!--中央仓库-->    <repository>      <id>oss</id>      <name>oss</name>      <url>http://oss.sonatype.org/content/repositories/snapshots</url>      <releases>        <enabled>true</enabled>      </releases>      <snapshots>        <enabled>true</enabled>      </snapshots>    </repository></repositories>