SpringBoot實現(xiàn)二維碼掃碼登錄的原理及項目實踐

更新時間：2023年04月02日 15:29:20 作者：hhzz

本文主要介紹了SpringBoot實現(xiàn)二維碼掃碼登錄的原理及項目實踐，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

手機二維碼掃碼登錄已經(jīng)成為了現(xiàn)代互聯(lián)網(wǎng)時代的一種普遍的登錄方式。它的出現(xiàn)，極大地方便了用戶登錄的流程，減少了用戶輸入用戶名和密碼的麻煩。在二維碼掃碼登錄流程中，用戶只需要通過掃描二維碼的方式即可完成登錄，免去了許多繁瑣的操作。而在這篇文章中，我將為大家介紹二維碼掃碼登錄的原理，并提供一種使用SpringBoot框架實現(xiàn)該功能的具體方法。

一、手機掃二維碼登錄的原理

二維碼掃碼登錄是一種基于OAuth2.0協(xié)議的授權(quán)登錄方式。在這種方式下，應用程序不需要獲取用戶的用戶名和密碼，只需要獲取用戶的授權(quán)即可。二維碼掃碼登錄主要有以下幾個步驟：

應用程序生成一個二維碼，并將該二維碼展示給用戶。
用戶使用掃碼工具掃描該二維碼，并在授權(quán)頁面中授權(quán)。
用戶授權(quán)后，應用程序會獲取一個授權(quán)碼。
應用程序使用該授權(quán)碼向授權(quán)服務器請求訪問令牌。
授權(quán)服務器返回一個訪問令牌給應用程序。
應用程序使用該訪問令牌訪問資源服務器。

在這里插入圖片描述

通過以上步驟，二維碼掃碼登錄可以實現(xiàn)用戶的快速登錄，并保證了用戶的安全性和隱私性。

二、SpringBoot如何實現(xiàn)二維碼掃碼登錄

在SpringBoot中，可以使用Spring Security OAuth2.0來實現(xiàn)二維碼掃碼登錄功能。Spring Security OAuth2.0是一個基于OAuth2.0協(xié)議的安全框架，它提供了授權(quán)服務器和資源服務器的實現(xiàn)。下面，我將為大家介紹如何使用Spring Security OAuth2.0實現(xiàn)二維碼掃碼登錄。

添加依賴
首先，需要在pom.xml文件中添加Spring Security OAuth2.0的依賴：

<dependency>
    <groupId>org.springframework.security.oauth</groupId>
    <artifactId>spring-security-oauth2</artifactId>
    <version>2.4.0</version>
</dependency>

配置授權(quán)服務器
在SpringBoot中，可以通過@Configuration注解來配置授權(quán)服務器。下面是一個簡單的授權(quán)服務器配置示例：

@Configuration
@EnableAuthorizationServer
public class AuthorizationServerConfig extends AuthorizationServerConfigurerAdapter {

    @Autowired
    private AuthenticationManager authenticationManager;

    @Override
    public void configure(ClientDetailsServiceConfigurer clients) throws Exception {
        clients.inMemory()
                .withClient("client")
                .secret("{noop}secret")
                .authorizedGrantTypes("authorization_code")
                .scopes("read", "write")
                .redirectUris("http://localhost:8080/callback");
    }

    @Override
    public void configure(AuthorizationServerEndpoints endpoints) throws Exception {
    endpoints.authenticationManager(authenticationManager);
}
}

在上面的代碼中，使用@EnableAuthorizationServer注解來啟用授權(quán)服務器。然后，通過@Configuration注解來指定該類為一個配置類。在configure()方法中，配置了一個授權(quán)客戶端，并指定了授權(quán)類型為authorization_code。授權(quán)服務器通過inMemory()方法來指定客戶端的信息，包括客戶端ID、客戶端秘鑰、授權(quán)類型、授權(quán)范圍以及重定向地址等信息。在configure()方法中，還需要配置AuthenticationManager，用于驗證用戶的身份信息。

配置資源服務器

在SpringBoot中，可以通過@Configuration注解來配置資源服務器。下面是一個簡單的資源服務器配置示例：

@Configuration
@EnableResourceServer
public class ResourceServerConfig extends ResourceServerConfigurerAdapter {
  @Override
public void configure(HttpSecurity http) throws Exception {
    http.authorizeRequests()
            .antMatchers("/api/**").authenticated()
            .anyRequest().permitAll();
}

@Override
public void configure(ResourceServerSecurityConfigurer resources) throws Exception {
    resources.resourceId("resource");
}
}

在上面的代碼中，使用@EnableResourceServer注解來啟用資源服務器。然后，通過@Configuration注解來指定該類為一個配置類。在configure()方法中，配置了資源服務器的安全策略，使用antMatchers()方法指定了需要認證的接口，使用permitAll()方法指定了其他接口可以被匿名訪問。在configure()方法中，還需要配置資源服務器的資源ID。

配置客戶端

在SpringBoot中，可以通過配置文件來配置客戶端。下面是一個簡單的客戶端配置示例：

security:
oauth2:
client:
clientId: client
clientSecret: secret
accessTokenUri: http://localhost:8080/oauth/token
userAuthorizationUri: http://localhost:8080/oauth/authorize
scope: read,write
redirectUri: http://localhost:8080/callback

在上面的代碼中，通過security.oauth2.client前綴來指定客戶端的配置信息，包括客戶端ID、客戶端秘鑰、訪問令牌URI、用戶授權(quán)URI、授權(quán)范圍、重定向地址等信息。

生成二維碼

在SpringBoot中，可以使用第三方庫來生成二維碼。下面是一個簡單的二維碼生成示例：

@GetMapping("/qrcode")
public ResponseEntity<byte[]> getQRCode() throws IOException, WriterException {
String codeUrl = "http://localhost:8080/oauth/authorize?response_type=code&client_id=client&redirect_uri=http://localhost:8080/callback";
ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
BitMatrix bitMatrix = new MultiFormatWriter().encode(codeUrl, BarcodeFormat.QR_CODE, 200, 200);
MatrixToImageWriter.writeToStream(bitMatrix, "png", outputStream);
return ResponseEntity.ok().contentType(MediaType.IMAGE_PNG).body(outputStream.toByteArray());
}

在上面的代碼中，使用@GetMapping注解來指定該方法為一個GET請求處理方法，通過指定請求路徑"/qrcode"來映射該方法。在getQRCode()方法中，首先生成授權(quán)請求的URL，并使用第三方庫生成二維碼圖片。最后，將生成的二維碼圖片以byte數(shù)組的形式返回給客戶端。

掃碼登錄
在SpringBoot中，可以使用WebSocket來實現(xiàn)掃碼登錄功能。下面是一個簡單的掃碼登錄示例：

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new QRCodeHandler(), "/qrcodeHandler");
    }

    class QRCodeHandler extends TextWebSocketHandler {

        private final Map<String, WebSocketSession> sessions = new ConcurrentHashMap<>();

        @Override
        public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
            String token = message.getPayload();
            if (sessions.containsKey(token)) {
                WebSocketSession clientSession = sessions.get(token);
                clientSession.sendMessage(new TextMessage("authenticated"));
                session.sendMessage(new TextMessage("authenticated"));
            } else {
                sessions.put(token, session);
            }
        }

        @Override
        public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
            sessions.values().remove(session);
        }
    }
}

在上面的代碼中，使用@EnableWebSocket注解來啟用WebSocket支持。然后，通過@Configuration注解來指定該類為一個配置類。在registerWebSocketHandlers()方法中，注冊了一個WebSocket處理器，并指定了處理器的請求路徑。在QRCodeHandler類中，實現(xiàn)了WebSocket處理器的業(yè)務邏輯。在handleTextMessage()方法中，將二維碼掃描后生成的token作為key，將WebSocket會話對象保存在Map中。如果同一個token對應的WebSocket會話對象已存在，則表示該用戶已經(jīng)掃碼并且已經(jīng)認證通過，此時需要將兩個WebSocket會話對象互相通知認證通過。如果同一個token對應的WebSocket會話對象不存在，則將該WebSocket會話對象保存在Map中。在afterConnectionClosed()方法中，移除已關(guān)閉的WebSocket會話對象。

客戶端回調(diào)
在SpringBoot中，可以使用@Controller注解來實現(xiàn)客戶端的回調(diào)功能。下面是一個簡單的回調(diào)示例：

@Controller
public class CallbackController {

    @Autowired
    private OAuth2RestTemplate restTemplate;

    @GetMapping("/callback")
    public String callback(@RequestParam("code") String code) {
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
        MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
        params.add("grant_type", "authorization_code");
        params.add("code", code);
        params.add("redirect_uri", "http://localhost:8080/callback");
        params.add("client_id", "client");
        params.add("client_secret", "secret");
        HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(params, headers);
        OAuth2AccessToken token = restTemplate.postForObject("http://localhost:8080/oauth/token", request, OAuth2AccessToken.class);
        return "redirect:/home";
    }
}

在上面的代碼中，使用@Controller注解來指定該類為一個控制器。在callback()方法中，首先使用OAuth2RestTemplate來發(fā)送POST請求獲取訪問令牌，并將授權(quán)碼、回調(diào)URL、客戶端ID和客戶端秘鑰等參數(shù)作為請求體發(fā)送。在獲取到訪問令牌之后，重定向到應用程序的主頁。