Spring Boot整合OAuth2實現(xiàn)GitHub第三方登錄

這篇具有很好參考價值的文章主要介紹了Spring Boot整合OAuth2實現(xiàn)GitHub第三方登錄。希望對大家有所幫助。如果存在錯誤或未考慮完全的地方，請大家不吝賜教，您也可以點擊"舉報違法"按鈕提交疑問。

Github OAuth 第三方登錄示例

1、第三方登錄原理

第三方登錄的原理是借助OAuth授權(quán)來實現(xiàn)，首先用戶先向客戶端提供第三方網(wǎng)站的數(shù)據(jù)證明自己的身份獲取授權(quán)碼，然后客戶端拿著授權(quán)碼與授權(quán)服務(wù)器建立連接獲得一個Access Token，之后客戶端就可以通過Access Token來與資源服務(wù)器進行交互。

使用OAuth的好處是提供給用戶一個特定的密鑰，用戶持有這個密鑰可以訪問應(yīng)用中的任何信息，而不需要向網(wǎng)站提供用戶名&密碼，可以實現(xiàn)跨系統(tǒng)共享用戶授權(quán)協(xié)議。

通過控制用戶持有的密鑰，可以很方便的控制用戶可以訪問的資源，以及控制密鑰的過期時間。

以下是來自維基百科對于OAuth的介紹

開放授權(quán)（OAuth）是一個開放標準，允許用戶讓第三方應(yīng)用訪問該用戶在某一網(wǎng)站上存儲的私密的資源（如照片，視頻，聯(lián)系人列表），而無需將用戶名和密碼提供給第三方應(yīng)用。

OAuth允許用戶提供一個令牌，而不是用戶名和密碼來訪問他們存放在特定服務(wù)提供者的數(shù)據(jù)。每一個令牌授權(quán)一個特定的網(wǎng)站（例如，視頻編輯網(wǎng)站)在特定的時段（例如，接下來的2小時內(nèi)）內(nèi)訪問特定的資源（例如僅僅是某一相冊中的視頻）。這樣，OAuth讓用戶可以授權(quán)第三方網(wǎng)站訪問他們存儲在另外服務(wù)提供者的某些特定信息，而非所有內(nèi)容。

OAuth是OpenID的一個補充，但是完全不同的服務(wù)。

交互流程如下：

2、GitHub實現(xiàn)第三方登錄

首先需要在github中對應(yīng)用進行登記，讓Github知道誰在發(fā)送請求。

訪問這個網(wǎng)址，填寫登記表

提交成功之后，GitHub會返回Client ID & Client Secrets ，這是應(yīng)用的身份識別碼

創(chuàng)建一個SpringBoot工程，pom.xml文件內(nèi)容如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.17</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>org.pp</groupId>
    <artifactId>springboot-oauth2-api</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-oauth2-api</name>
    <description>springboot整合oauth2，實現(xiàn)GitHub第三方登錄</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

將ID和密鑰添加到配置文件application.yml中：

# 項目端口號
server:
  port: 8080
#  GitHub認證相關(guān)參數(shù)
github:
    client:
      id: xxx
      secret: xxx

創(chuàng)建一個實體類，用于映射授權(quán)成功產(chǎn)生的Token令牌：

import com.fasterxml.jackson.annotation.JsonProperty;
/**
 *
 * Token令牌 - 響應(yīng)參數(shù)
 *
 * @author supanpan
 * @date 2023/10/25
 */
public class AccessTokenResponse {

    @JsonProperty("access_token")
    private String accessToken;

    public String getAccessToken() {
        return accessToken;
    }

    public void setAccessToken(String accessToken) {
        this.accessToken = accessToken;
    }
}

OAuthController如下：

**
 * @author supanpan
 * @date 2023/10/25
 */
@Controller
public class OAuthController {

    @Value("${github.client.id}")
    private String clientId;

    @Value("${github.client.secret}")
    private String clientSecret;

    @GetMapping("/oauth/redirect")
    public String handleRedirect(@RequestParam("code") String requestToken, Model model) {
        // 使用RestTemplate來發(fā)送HTTP請求
        RestTemplate restTemplate = new RestTemplate();

        // 獲取Token的Url
        String tokenUrl = "https://github.com/login/oauth/access_token" +
                "?client_id=" + clientId +
                "&client_secret=" + clientSecret +
                "&code=" + requestToken;

        // 使用restTemplate向GitHub發(fā)送請求，獲取Token
        AccessTokenResponse tokenResponse = restTemplate.postForObject(tokenUrl, null, AccessTokenResponse.class);

        // 從響應(yīng)體中獲取Token數(shù)據(jù)
        String accessToken = tokenResponse.getAccessToken();

        // 攜帶Token向GitHub發(fā)送請求
        String apiUrl = "https://api.github.com/user";
        HttpHeaders headers = new HttpHeaders();
        headers.set("Authorization", "token " + accessToken);
        HttpEntity<String> entity = new HttpEntity<>("parameters", headers);
        ResponseEntity<String> response = restTemplate.exchange(apiUrl, HttpMethod.GET, entity, String.class);
        model.addAttribute("userData", response.getBody());

        return "welcome";
    }
}

SpringBoot啟動器

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SpringbootOauth2ApiApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootOauth2ApiApplication.class, args);
    }

}

還需要編寫兩個html頁面，index.html和welcome.html

index.html

<!DOCTYPE html>
<html>

<head>
    <meta charset="utf-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <title>OAuth2 Demo</title>
    <meta name="viewport" content="width=device-width, initial-scale=1">
</head>

<body>
<a id="login">Login with GitHub</a>

<script>
    const client_id = 'xxxx';

    const authorize_uri = 'https://github.com/login/oauth/authorize';
    const redirect_uri = 'http://localhost:8080/oauth/redirect';

    const link = document.getElementById('login');
    link.href = `${authorize_uri}?client_id=${client_id}&redirect_uri=${redirect_uri}`;
</script>

</body>

</html>

welcome.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Hello</title>
</head>

<body>
    <h1>Welcome</h1>
    <div th:text="${userData}"></div>
</body>

</html>

啟動項目，瀏覽器訪問localhost:8080，會跳轉(zhuǎn)到index頁面，點擊鏈接會跳轉(zhuǎn)到GitHub應(yīng)用授權(quán)頁面

點擊跳轉(zhuǎn)到GitHub授權(quán)之后，GitHub會詢問示例代碼正在請求數(shù)據(jù)，您是否同意授權(quán)。

用戶同意授權(quán)， GitHub 就會跳轉(zhuǎn)到redirect_uri指定的跳轉(zhuǎn)網(wǎng)址，并且?guī)鲜跈?quán)碼，跳轉(zhuǎn)回來的 URL 就是下面的樣子

// code參數(shù)就是授權(quán)碼
http://localhost:8080/oauth/redirect?code:4ea423f2ec1e04c6376a

如下是服務(wù)的響應(yīng)數(shù)據(jù)：

access token: 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
{
  login: 'AtwoodPa',
  id: 110728122,
  node_id: 'U_kgDOBpmTug',
  avatar_url: 'https://avatars.githubusercontent.com/u/110728122?v=4',
  gravatar_id: '',
  url: 'https://api.github.com/users/AtwoodPa',
  html_url: 'https://github.com/AtwoodPa',
  followers_url: 'https://api.github.com/users/AtwoodPa/followers',
  following_url: 'https://api.github.com/users/AtwoodPa/following{/other_user}',
  gists_url: 'https://api.github.com/users/AtwoodPa/gists{/gist_id}',
  starred_url: 'https://api.github.com/users/AtwoodPa/starred{/owner}{/repo}',
  subscriptions_url: 'https://api.github.com/users/AtwoodPa/subscriptions',
  organizations_url: 'https://api.github.com/users/AtwoodPa/orgs',
  repos_url: 'https://api.github.com/users/AtwoodPa/repos',
  events_url: 'https://api.github.com/users/AtwoodPa/events{/privacy}',
  received_events_url: 'https://api.github.com/users/AtwoodPa/received_events',
  type: 'User',
  site_admin: false,
  name: null,
  company: null,
  blog: '',
  location: null,
  email: null,
  hireable: null,
  bio: null,
  twitter_username: null,
  public_repos: 6,
  public_gists: 0,
  followers: 0,
  following: 3,
  created_at: '2022-08-06T13:02:16Z',
  updated_at: '2023-09-03T00:15:55Z'
}
authorization code: 4ea423f2ec1e04c6376a

成功執(zhí)行上述流程，最終展示示例的welcome頁面

到這里，Spring Boot整合GitHub實現(xiàn)第三方登錄的實現(xiàn)就結(jié)束了，以此類推其他廠商的第三方登錄實現(xiàn)流程也大概是這樣。文章來源地址http://www.zghlxwxcb.cn/news/detail-711405.html

到了這里，關(guān)于Spring Boot整合OAuth2實現(xiàn)GitHub第三方登錄的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！