JustAuth/docs/oauth/twitter.md
yadong.zhang 6ea1d41211 📝 更新文档
2020-06-29 00:44:04 +08:00

4.5 KiB
Raw Blame History

1. 申请应用

参考文章:twitter三方登录的实现,只需关注创建应用部分即可。

copy以下三个信息App IDApp Key网站回调域

友情提示twitter现不支持个人用户创建应用

重要提示:“应用密钥”可保护你应用程序的安全,因此请确保其不会泄露!也不要与任何人共享你的“应用密钥”!!!

2. 集成JustAuth

2.1 引入依赖

<dependency>
  <groupId>me.zhyd.oauth</groupId>
  <artifactId>JustAuth</artifactId>
  <version>${latest.version}</version>
</dependency>

${latest.version}表示当前最新的版本,可以在这儿获取最新的版本信息。

2.2 创建Request

// 国外平台 目前必须要手动配置代理
System.setProperty("proxyPort", "10080");
System.setProperty("proxyHost", "127.0.0.1");
AuthRequest authRequest = new AuthTwitterRequest(AuthConfig.builder()
                .clientId("App ID")
                .clientSecret("App Key")
                .redirectUri("网站回调域")
                .build());

特别注意所有国外平台都无法直接通过java进行访问API目前simple-http Release版本暂不支持添加代理所以目前需要手动开启代理。

代理开启的方式:

System.setProperty("proxyPort", "10080");
System.setProperty("proxyHost", "127.0.0.1");

以上代码可以在声明 AuthRequest 时创建,也可以全局执行。

本地如果支持科学上网就用自己本地的代理端口即可如果不支持科学上网可以去网上找一些免费的代理IP进行测试请自行操作

2.3 生成授权地址

我们可以直接使用以下方式生成第三方平台的授权链接:

String authorizeUrl = authRequest.authorize(AuthStateUtils.createState());

这个链接我们可以直接后台重定向跳转也可以返回到前端后前端控制跳转。前端控制的好处就是可以将第三方的授权页嵌入到iframe中适配网站设计。

2.4 以上完整代码如下

import me.zhyd.oauth.config.AuthConfig;
import me.zhyd.oauth.request.AuthTwitterRequest;
import me.zhyd.oauth.model.AuthCallback;
import me.zhyd.oauth.request.AuthRequest;
import me.zhyd.oauth.utils.AuthStateUtils;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;


@RestController
@RequestMapping("/oauth")
public class RestAuthController {

    @RequestMapping("/render")
    public void renderAuth(HttpServletResponse response) throws IOException {
        AuthRequest authRequest = getAuthRequest();
        response.sendRedirect(authRequest.authorize(AuthStateUtils.createState()));
    }

    @RequestMapping("/callback")
    public Object login(AuthCallback callback) {
        AuthRequest authRequest = getAuthRequest();
        return authRequest.login(callback);
    }

    private AuthRequest getAuthRequest() {
        // 国外平台 目前必须要手动配置代理
        System.setProperty("proxyPort", "10080");
        System.setProperty("proxyHost", "127.0.0.1");
        return new AuthTwitterRequest(AuthConfig.builder()
                .clientId("App ID")
                .clientSecret("App Key")
                .redirectUri("网站回调域")
                .build());
    }
}

3. 推荐

官方推荐使用 JustAuth-demo 示例项目进行测试。

使用步骤:

  1. clone https://github.com/justauth/JustAuth-demo.git
  2. 将上面申请的应用信息填入到RestAuthController#getAuthRequest方法的对应位置中:
  3. 启动项目,访问 http://localhost:8443
  4. 选择对应的平台进行授权登录
  5. 登录完成后,可以访问http://localhost:8443/users查看已授权的用户

注:

  1. 如果直接使用 JustAuth-demo 项目进行测试,那么在配置测试应用的“回调地址”时要严格按照以下格式配置:http://localhost:8443/oauth/callback/{平台名}
  2. 平台名参考 JustAuthPlatformInfo 枚举类 names