diff --git a/docs/_media/oauth/github_01.png b/docs/_media/oauth/github_01.png new file mode 100644 index 0000000..d664cfc Binary files /dev/null and b/docs/_media/oauth/github_01.png differ diff --git a/docs/_media/oauth/github_02.png b/docs/_media/oauth/github_02.png new file mode 100644 index 0000000..8514bbd Binary files /dev/null and b/docs/_media/oauth/github_02.png differ diff --git a/docs/_media/oauth/github_03.png b/docs/_media/oauth/github_03.png new file mode 100644 index 0000000..1bdc1ec Binary files /dev/null and b/docs/_media/oauth/github_03.png differ diff --git a/docs/_media/oauth/github_04.png b/docs/_media/oauth/github_04.png new file mode 100644 index 0000000..14548fb Binary files /dev/null and b/docs/_media/oauth/github_04.png differ diff --git a/docs/_media/oauth/github_05.png b/docs/_media/oauth/github_05.png new file mode 100644 index 0000000..e7ccb53 Binary files /dev/null and b/docs/_media/oauth/github_05.png differ diff --git a/docs/_media/oauth/github_06.png b/docs/_media/oauth/github_06.png new file mode 100644 index 0000000..06cd6a7 Binary files /dev/null and b/docs/_media/oauth/github_06.png differ diff --git a/docs/index.html b/docs/index.html index 35f09f5..e456ad7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -15,16 +15,7 @@ - - +
Please wait...
@@ -76,5 +67,26 @@ + + + + + + + diff --git a/docs/oauth/github.md b/docs/oauth/github.md index 00ff6e4..fe70b26 100644 --- a/docs/oauth/github.md +++ b/docs/oauth/github.md @@ -1,7 +1,143 @@ -（敬请期待...） - ## 1. 申请应用 +### 1.注册Github账号 +https://github.com/。如果已有则忽略该步骤，直接进入第二步。 +### 2.创建第三方应用 +进入通过右上角进入个人设置页：https://github.com/settings/profile +![file](../_media/oauth/github_01.png) +然后进入第三方应用页面：https://github.com/settings/developers +![file](../_media/oauth/github_02.png) + +在应用管理页面，选择`OAuth App`，然后点击右上方的`New OAuth App`按钮进入新建应用页面 + +![file](../_media/oauth/github_03.png) + +`Application name` 一般填写自己的网站名称即可 +`Application description` 一般填写自己的应用描述即可 +`Homepage URL` 填写自己的网站首页地址 +`Authorization callback URL` **重点**，该地址为用户授权后需要跳转到的自己网站的地址，默认携带一个`code`参数 + +以上信息输入完成后，点击下方绿色的`Register applaction`按钮创建应用。创建完成后，点击进入应用详情页，可以看到应用的密钥等信息 + +![file](../_media/oauth/github_04.png) + +copy以下三个信息：`Client ID`、`Client Secret`和`Authorization callback URL`。 + ## 2. 集成JustAuth -## 3. 授权结果 \ No newline at end of file + +### 2.1 引入依赖 + +```xml + + me.zhyd.oauth + JustAuth + ${latest.version} + +``` + +`${latest.version}`表示当前最新的版本，可以在[这儿](https://github.com/justauth/JustAuth/releases)获取最新的版本信息。 + +### 2.2 创建Request + +```java +AuthRequest authRequest = new AuthGithubRequest(AuthConfig.builder() + .clientId("Client ID") + .clientSecret("Client Secret") + .redirectUri("应用回调地址") + .build()); +``` + +### 2.3 生成授权地址 + +我们可以直接使用以下方式生成第三方平台的授权链接： +```java +String authorizeUrl = authRequest.authorize(); +``` +这个链接我们可以直接后台重定向跳转，也可以返回到前端后，前端控制跳转。前端控制的好处就是，可以将第三方的授权页嵌入到iframe中，适配网站设计。 + + +### 2.4 以上完整代码如下 + +```java +import me.zhyd.oauth.config.AuthConfig; +import me.zhyd.oauth.request.AuthGiteeRequest; +import me.zhyd.oauth.request.AuthRequest; +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()); + } + + @RequestMapping("/callback") + public Object login(String code) { + AuthRequest authRequest = getAuthRequest(); + return authRequest.login(code); + } + + private AuthRequest getAuthRequest() { + return new AuthGithubRequest(AuthConfig.builder() + .clientId("Client ID") + .clientSecret("Client Secret") + .redirectUri("应用回调地址") + .build()); + } +} +``` +授权链接访问成功后会看到以下页面内容： +![授权登录](../_media/oauth/github_05.png) + +输入账号密码登录完成后将会进入授权页面 + +![授权登录](../_media/oauth/github_06.png) + +点击同意授权即可完成github的oauth登录。 + +## 3. 授权结果 + +```json +{ + "code": 2000, + "msg": null, + "data": { + "uuid": "xxx", + "username": "zhangyd-c", + "nickname": "yadong.zhang", + "avatar": "https://avatars3.githubusercontent.com/u/12689082?v=4", + "blog": "https://www.zhyd.me", + "company": "", + "location": "Beijing", + "email": "yadong.zhang0415@gmail.com", + "remark": "心之所向，无所不能", + "gender": "UNKNOWN", + "source": "GITHUB", + "token": { + "accessToken": "6bb4228efdxxxxxx578148e3", + "expireIn": 0, + "refreshToken": null, + "uid": null, + "openId": null, + "accessCode": null, + "unionId": null, + "scope": null, + "tokenType": "bearer", + "idToken": null, + "macAlgorithm": null, + "macKey": null, + "code": null + } + } +} +``` \ No newline at end of file