spring boot 2 集成JWT實現api介面認證

来源:https://www.cnblogs.com/gdjlc/archive/2019/12/22/12081701.html
-Advertisement-
Play Games

JSON Web Token（JWT）是目前流行的跨域身份驗證解決方案。 官網：https://jwt.io/ 本文spring boot 2 集成JWT實現api介面驗證。 ...


JSON Web Token（JWT）是目前流行的跨域身份驗證解決方案。
官網：https://jwt.io/
本文使用spring boot 2 集成JWT實現api介面驗證。

一、JWT的數據結構

JWT由header（頭信息）、payload（有效載荷）和signature（簽名）三部分組成的，用“.”連接起來的字元串。
JWT的計算邏輯如下：
（1）signature = HMACSHA256(base64UrlEncode(header) + "." + base64UrlEncode(payload), secret)
其中私鑰secret保存於伺服器端，不能泄露出去。
（2）JWT = base64UrlEncode(header) + "." + base64UrlEncode(payload) + signature

下麵截圖以官網的例子，簡單說明

二、JWT工作機制

客戶端使用其憑據成功登錄時，伺服器生成JWT並返回給客戶端。
當客戶端訪問受保護的資源時，用戶代理使用Bearer模式發送JWT，通常在Authorization header中，如下所示：
Authorization: Bearer <token>
伺服器檢查Authorization header中的有效JWT ，如果有效，則允許用戶訪問受保護資源。JWT包含必要的數據，還可以減少查詢資料庫或緩存信息。

三、spring boot集成JWT實現api介面驗證

開發環境：
IntelliJ IDEA 2019.2.2
jdk1.8
Spring Boot 2.1.11

1、創建一個SpringBoot項目，pom.xml引用的依賴包如下

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.auth0</groupId>
            <artifactId>java-jwt</artifactId>
            <version>3.8.3</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.10</version>
            <scope>provided</scope>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.62</version>
        </dependency>

2、定義一個介面的返回類

package com.example.jwtdemo.entity;


import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;

import java.io.Serializable;

@Data
@NoArgsConstructor
@ToString
public class ResponseData<T> implements Serializable {
    /**
     * 狀態碼：0-成功，1-失敗
     * */
    private int code;

    /**
     * 錯誤消息，如果成功可為空或SUCCESS
     * */
    private String msg;

    /**
     * 返回結果數據
     * */
    private T data;

    public static ResponseData success() {
        return success(null);
    }

    public static ResponseData success(Object data) {
        ResponseData result = new ResponseData();
        result.setCode(0);
        result.setMsg("SUCCESS");
        result.setData(data);
        return result;
    }

    public static ResponseData fail(String msg) {
        return fail(msg,null);
    }

    public static ResponseData fail(String msg, Object data) {
        ResponseData result = new ResponseData();
        result.setCode(1);
        result.setMsg(msg);
        result.setData(data);
        return result;
    }
}

3、統一攔截介面返回數據

package com.example.jwtdemo.config;


import com.alibaba.fastjson.JSON;
import com.example.jwtdemo.entity.ResponseData;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

/**
 * 實現ResponseBodyAdvice介面，可以對返回值在輸出之前進行修改
 */
@RestControllerAdvice
public class GlobalResponseHandler implements ResponseBodyAdvice<Object> {

    //判斷支持的類型
    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        // 判斷為null構建ResponseData對象進行返回
        if (o == null) {
            return ResponseData.success();
        }
        // 判斷是ResponseData子類或其本身就返回Object o本身，因為有可能是介面返回時創建了ResponseData,這裡避免再次封裝
        if (o instanceof ResponseData) {
            return (ResponseData<Object>) o;
        }
        // String特殊處理，否則會拋異常
        if (o instanceof String) {
            return JSON.toJSON(ResponseData.success(o)).toString();
        }
        return ResponseData.success(o);
    }
}

4、統一異常處理

package com.example.jwtdemo.exception;

import com.example.jwtdemo.entity.ResponseData;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ResponseData exceptionHandler(Exception e) {
        e.printStackTrace();
        return ResponseData.fail(e.getMessage());
    }
}

5、創建一個JWT工具類

package com.example.jwtdemo.common;

import com.auth0.jwt.JWTVerifier;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.interfaces.DecodedJWT;
import com.auth0.jwt.JWT;

import java.util.Date;

public class JwtUtils {
    public static final String TOKEN_HEADER = "Authorization";
    public static final String TOKEN_PREFIX = "Bearer ";
    // 過期時間，這裡設為5分鐘
    private static final long EXPIRE_TIME = 5 * 60 * 1000;
    // 密鑰
    private static final String SECRET = "jwtsecretdemo";

    /**
     * 生成簽名,5分鐘後過期
     *
     * @param name 名稱
     * @param secret 密碼
     * @return 加密後的token
     */
    public static String sign(String name) {
        Date date = new Date(System.currentTimeMillis() + EXPIRE_TIME);
        Algorithm algorithm = Algorithm.HMAC256(SECRET); //使用HS256演算法
        String token = JWT.create() //創建令牌實例
                .withClaim("name", name) //指定自定義聲明，保存一些信息
                //.withSubject(name) //信息直接放在這裡也行
                .withExpiresAt(date) //過期時間
                .sign(algorithm); //簽名
        return token;
    }

    /**
     * 校驗token是否正確
     *
     * @param token 令牌
     * @param secret 密鑰
     * @return 是否正確
     */
    public static boolean verify(String token) {
        try{
            String name = getName(token);
            Algorithm algorithm = Algorithm.HMAC256(SECRET);
            JWTVerifier verifier = JWT.require(algorithm)
                    .withClaim("name", name)
                    //.withSubject(name)
                    .build();
            DecodedJWT jwt = verifier.verify(token);
            return true;
        } catch (Exception e){
            return false;
        }
    }

    /**
     * 獲得token中的信息
     *
     * @return token中包含的名稱
     */
    public static String getName(String token) {
        try {
            DecodedJWT jwt = JWT.decode(token);
            return jwt.getClaim("name").asString();
        }catch(Exception e){
            return null;
        }
    }
}

6、新建兩個自定義註解：一個需要認證、另一個不需要認證

package com.example.jwtdemo.config;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface LoginToken {
    boolean required() default true;
}
package com.example.jwtdemo.config;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface PassToken {
    boolean required() default true;
}

7、新建攔截器並驗證token

package com.example.jwtdemo.config;

import com.example.jwtdemo.common.JwtUtils;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;

public class AuthenticationInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 如果不是映射到方法直接通過
        if(!(handler instanceof HandlerMethod)){
            return true;
        }
        HandlerMethod handlerMethod=(HandlerMethod)handler;
        Method method=handlerMethod.getMethod();
        //檢查是否有passtoken註釋，有則跳過認證
        if (method.isAnnotationPresent(PassToken.class)) {
            PassToken passToken = method.getAnnotation(PassToken.class);
            if (passToken.required()) {
                return true;
            }
        }
        //檢查有沒有需要用戶許可權的註解
        if (method.isAnnotationPresent(LoginToken.class)) {
            LoginToken loginToken = method.getAnnotation(LoginToken.class);
            if (loginToken.required()) {
                // 執行認證
                String tokenHeader = request.getHeader(JwtUtils.TOKEN_HEADER);// 從 http 請求頭中取出 token
                if(tokenHeader == null){
                    throw new RuntimeException("沒有token");
                }
                String token = tokenHeader.replace(JwtUtils.TOKEN_PREFIX, "");
                if (token == null) {
                    throw new RuntimeException("沒有token");
                }
                boolean b = JwtUtils.verify(token);
                if (b == false) {
                    throw new RuntimeException("token不存在或已失效，請重新獲取token");
                }
                return true;
            }
        }
        return false;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

8、配置攔截器

package com.example.jwtdemo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(authenticationInterceptor())
                .addPathPatterns("/**");
    }
    @Bean
    public AuthenticationInterceptor authenticationInterceptor() {
        return new AuthenticationInterceptor();
    }
}

9、新建一個測試的控制器

package com.example.jwtdemo.controller;

import com.example.jwtdemo.common.JwtUtils;
import com.example.jwtdemo.config.LoginToken;
import com.example.jwtdemo.config.PassToken;
import org.springframework.web.bind.annotation.*;

@RestController
public class DemoController {
    @PassToken
    @PostMapping("getToken")
    public String getToken(@RequestParam String userName, @RequestParam String password){
        if(userName.equals("admin") && password.equals("123456")){
            String token = JwtUtils.sign("admin");
            return token;
        }
        return "用戶名或密碼錯誤";
    }

    @LoginToken
    @GetMapping("getData")
    public String getData() {
        return "獲取數據...";
    }

}

10、Postman測試

（1）GET請求：http://localhost:8080/getData，返回如下

 （2）GET請求：http://localhost:8080/getData，在token中隨便輸入字元串，返回如下

 （3）POST請求：http://localhost:8080/getToken，並設置用戶名和密碼參數，返回如下

 （4）GET請求：http://localhost:8080/getData，在token中輸入上面token字元串，返回如下

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Provider模式應用demo
    參考ObjectPool對象池設計原理還原一個簡易的Provider模式。 存儲對象的數組ObjectWrapper內元素的取、還操作通過Interlock.CompareExchange巧妙的實現，並且是線程安全的。 取操作： 。取完後將元素置為null 還操作： 如果元素為null，則賦值 設計 ...
  • 分庫分表之第二篇
    分庫分表之第二篇 2. Sharding-JDBC快速入門 2.1需求說明 2.2. 環境建設 2.2.1環境說明 2.2.2創建資料庫 2.2.3約會maven依賴 2.3 編寫程式 2.3.1 分片規則配置 2.3.2 數據操作 2.3.3 測試 2.4. 流程分析 2.5 其他集成方式 2. ...
  • 軟體設計的哲學：第十一章 兩次設計
    兩次設計的方法不僅提高了你的設計，也提高了你的設計能力。設計和比較多種方法的過程將教會您使設計更好或更差的因素。隨著時間的推移，這將使你更容易排除糟糕的設計，並專註於真正偉大的設計。 ...
  • go 語言實現棧原理
    package main import "fmt" type StackNode struct { Data interface{} //數據 Next *StackNode //下一個節點 } //創建鏈棧 func CreateStack(Data ...interface{}) *StackN... ...
  • 迴圈鏈表實現原理及運用約瑟夫環實例
    package main import "fmt" type LinkNode struct { Data interface{} Next *LinkNode } //創建迴圈鏈表 func (node *LinkNode) Create(Data ...interface{}) { if nod... ...
  • 雙向鏈表實現原理
    package main import "fmt" type LinkNode struct { Data interface{} //數據 Prev *LinkNode //上一個指針 Next *LinkNode //下一個指針 } //創建雙向鏈表 （數據集合） func (node *Lin... ...
  • 單向鏈表實現原理
    package main import ( "fmt" "reflect" ) //通過結構體嵌套本結構體指針來實現鏈表 //結構體可以嵌套本結構體指針, 但不能嵌套本結構體本身, 長度不能超過 1024 type LinkNode struct { Data interface{} Next *L... ...
  • slice 實現原理
    package main /* #include <stdlib.h> */ import "C" import ( "unsafe" "fmt" ) type Slice struct { Data unsafe.Pointer //萬能指針類型 對應C語言中的void* len int //有效... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類