如果需要使用GitHub账号登录个人网站,需要在GitHub上添加OAuth应用,位置在头像的setting里,点击Developer settings,选择OAuth Apps
主要是填写第四个回调网址,当你发送登录请求后,会把需要的参数通过回调网址返回
构建好后我们需要添加项目登录跳转的链接https://github.com/login/oauth/authorize
其中需要添加
名称 | 类型 | 描述 |
---|---|---|
client_id |
string |
必填项。注册时从GitHub收到的客户端ID 。 |
redirect_uri |
string |
授权后将用户发送到应用程序中的URL。请参阅以下有关重定向网址的详细信息。 |
login |
string |
建议用于登录和授权应用程序的特定帐户。 |
scope |
string |
以空格分隔的范围列表。如果未提供,则scope 对于未授权该应用程序任何作用域的用户,默认为空列表。对于拥有应用程序范围的授权用户,将不会向用户显示带有范围列表的OAuth授权页面。取而代之的是,流程的这一步将自动完成用户已为应用程序授权的一组作用域。例如,如果用户已经执行了两次Web流程并授权了一个具有user 范围的令牌和另一个具有repo 范围的令牌,则不提供的第三个Web流程scope 将收到具有user 和repo 范围的令牌。 |
state |
string |
不可猜测的随机字符串。它用于防止跨站点请求伪造攻击。 |
allow_signup |
string |
在OAuth流程中,是否向未认证的用户提供注册GitHub的选项。默认值为true 。false 在策略禁止注册的情况下使用。 |
这里需要添加client_id
,redirect_uri
,scope
和state
client_id:
可以在构建好的OAuth应用中拿到
redirect_uri:
是参数返回时接受请求的路径
完整的路径就是这样(client_id
和redirect_uri
需要替换为自己的参数和自己项目回调路径)
https://github.com/login/oauth/authorize?client_id=client_id&redirect_uri=redirect_uri&scope=user&state=1
在后台接受请求,返回的请求带有 code
和state
构建一个Java类,有如下参数,并提供 get
set
方法
public class AccessTokenDTO {
private String client_id;
private String client_secret;
private String code;
private String redirect_uri;
private String state;
}
其中client_secret
获取地址和client_id
一样,代码如下
@GetMapping("/callback")
public String callback(@RequestParam(name = "code") String code,
@RequestParam(name = "state") String state,
HttpServletResponse response) {
AccessTokenDTO accessTokenDTO = new AccessTokenDTO();
accessTokenDTO.setCode(code);
accessTokenDTO.setRedirect_uri(redirectUri);
accessTokenDTO.setState(state);
accessTokenDTO.setClient_id(clientId);
accessTokenDTO.setClient_secret(clientSecret);
之后向GitHub发起请求
String accessToken = githubProvider.getAccessToken(accessTokenDTO);
我这里使用的是OkHttp进行发送请求,以json格式
public String getAccessToken(AccessTokenDTO accessTokenDTO) {
MediaType mediaType = MediaType.get("application/json; charset=utf-8");
OkHttpClient client = new OkHttpClient();
RequestBody body = RequestBody.create(mediaType, JSON.toJSONString(accessTokenDTO));
System.out.println(body.toString());
Request request = new Request.Builder()
.url("https://github.com/login/oauth/access_token")
.post(body)
.build();
try (Response response = client.newCall(request).execute()) {
assert response.body() != null;
String string = response.body().string();
return string.split("&")[0].split("=")[1];
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
会返回一个字符串,并且带有随机的access_token
,所以我将其截取出来后进行返回
access_token=3ab1f55a1093e60027bb3ed3c9b209e16850883c&scope=user&token_type=bearer
创建一个用户类保存数据
@Data
public class GithubUser {
private Long id;
private String name;
private String avatarUrl;
}
当然,你也可以依据自己的情况选择需要保存哪一些数据
可以通过直接访问以下路径来查询需要保存的数据
https://api.github.com/user?access_token=获取到的access_token
然后将截取出来的access_token
通过请求发送给GitHub,并以用户类类型进行返回
public GithubUser getUser(String accessToken) {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.github.com/user?access_token=" + accessToken)
.build();
try {
Response response = client.newCall(request).execute();
assert response.body() != null;
String string = response.body().string();
return JSON.parseObject(string, GithubUser.class);
} catch (IOException ignored) {
}
return null;
}
这样就获取到用户对象了,接下来将对象保存进数据库即可
这就是通过GitHub账号登录个人网站的实现