JWT整合Springboot的方法步驟
1.基於JWT認證
1.1 認證流程
- 首先,前端通過Web表單將自己的用戶名和密碼發送到後端的接口。這一過程一般是一個HTTP
POST
請求。建議的方式是通過SSL加密的傳輸(https協議),從而避免敏感信息被嗅探。 - 後端核對用戶名和密碼成功後,將用戶的id等其他信息作為JWT
Payload
(負載),將其與頭部分別進行Base64
編碼拼接後簽名,形成一個JWT(Token
)。形成的JWT就是一個形同lll.zzz.xxx
的字符串。 tokenhead.payload.singurater
- 後端將JWT字符串作為登錄成功的返回結果返回給前端。前端可以將返回的結果保存在
localStorage
或sessionStorage
上,退出登錄時前端刪除保存的JWT即可。 - 前端在每次請求時將JWT放入HTTP Header中的
Authorization
位。(解決XSS和XSRF問題) HEADER - 後端檢查是否存在,如存在驗證JWT的有效性。例如,檢查簽名是否正確;檢查Token是否過期;檢查Token的接收方是否是自己(可選)。
- 驗證通過後,後端使用JWT中包含的用戶信息進行其他邏輯操作,返回相應結果。
1.2 JWT優勢
- 簡潔(Compact): 可以通過URL,POST參數或者在HTTP header發送,因為數據量小,傳輸速度也很快
- 自包含(Self-contained):負載中包含瞭所有用戶所需要的信息,避免瞭多次查詢數據庫
- 因為Token是以JSON加密的形式保存在客戶端的,所以JWT是跨語言的,原則上任何web形式都支持
- 不需要在服務端保存會話信息,特別適用於分佈式微服務
1.3 JWT的結構是什麼
token string ====> header.payload.singnature token
令牌組成
- 標頭(Header)
- 有效載荷(Payload)
- 簽名(Signature)
因此,JWT通常如下所示:xxxxx.yyyyy.zzzzz Header.Payload.Signature
Header
標頭通常由兩部分組成:令牌的類型(即JWT)
和所使用的簽名算法
,例如HMAC SHA256或RSA。它會使用 Base64 編碼組成 JWT 結構的第一部分。
註意:Base64是一種編碼,也就是說,它是可以被翻譯回原來的樣子來的。它並不是一種加密過程。
{ "alg": "HS256", "typ": "JWT" }
Payload
令牌的第二部分是有效負載,其中包含聲明。聲明是有關實體(通常是用戶)和其他數據的聲明
。同樣的,它會使用 Base64 編碼組成 JWT 結構的第二部分
{ "sub": "1234567890", "name": "John Doe", "admin": true }
Signature
前面兩部分都是使用 Base64 進行編碼的,即前端可以解開知道裡面的信息。Signature 需要使用編碼後的 header 和 payload以及我們提供的一個密鑰
,然後使用 header 中指定的簽名算法(HS256)進行簽名。簽名的作用是保證 JWT 沒有被篡改過如:HMACSHA256(base64UrlEncode(header) + “.” + base64UrlEncode(payload),secret);
簽名目的
最後一步簽名的過程,實際上是對頭部以及負載內容進行簽名,防止內容被竄改。如果有人對頭部以及負載的內容解碼之後進行修改,再進行編碼,最後加上之前的簽名組合形成新的JWT的話,那麼服務器端會判斷出新的頭部和負載形成的簽名和JWT附帶上的簽名是不一樣的。如果要對新的頭部和負載進行簽名,在不知道服務器加密時用的密鑰的話,得出來的簽名也是不一樣的。
信息安全問題
在這裡大傢一定會問一個問題:Base64是一種編碼,是可逆的,那麼我的信息不就被暴露瞭嗎?
是的。所以,在JWT中,
不應該在負載裡面加入任何敏感的數據
。在上面的例子中,我們傳輸的是用戶的User ID。這個值實際上不是什麼敏感內容,一般情況下被知道也是安全的。但是像密碼這樣的內容就不能被放在JWT中瞭。如果將用戶的密碼放在瞭JWT中,那麼懷有惡意的第三方通過Base64解碼就能很快地知道你的密碼瞭。因此JWT適合用於向Web應用傳遞一些非敏感信息。JWT還經常用於設計用戶認證和授權系統,甚至
實現Web應用的單點登錄。
2.使用JWT
引入依賴
<!--引入jwt--> <dependency> <groupId>com.auth0</groupId> <artifactId>java-jwt</artifactId> <version>3.4.0</version> </dependency>
生成token
@Test void contextLoads() { HashMap<String, Object> map = new HashMap<>(); Calendar instance=Calendar.getInstance(); instance.add(Calendar.SECOND,200); //獲取token String token = JWT.create().withHeader(map) //header,默認,可以不寫 .withClaim("userId", 23) .withClaim("username", "xpp") //palyload .withExpiresAt(instance.getTime()) //指定令牌的過期時間 .sign(Algorithm.HMAC256("xpp@ll"));//簽名,指定秘鑰 System.out.println(token); }
生成結果
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2Mzc5MDM2OTksInVzZXJJZCI6MjMsInVzZXJuYW1lIjoieHBwIn0.dnWldEBILZpt7Upz762VcMm-uTU9HI5jK-AHk3XyX0s
根據令牌和簽名解析數據
@Test public void test(){ //創建驗證對象 JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256("xpp@ll")).build(); //驗證token DecodedJWT verify = jwtVerifier.verify("eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2Mzc5MDM2OTksInVzZXJJZCI6MjMsInVzZXJuYW1lIjoieHBwIn0.dnWldEBILZpt7Upz762VcMm-uTU9HI5jK-AHk3XyX0s"); //獲取存入palyload的信息 Date expiresAt = verify.getExpiresAt(); System.out.println(expiresAt); System.out.println(verify.getClaim("userId").asInt()); }
常見異常信息
SignatureVerificationException
: 簽名不一致異常TokenExpiredException
: 令牌過期異常AlgorithmMismatchException
: 算法不匹配異常InvalidClaimException
: 失效的payload異常
3.整合Springboot
引入依賴
<!--引入jwt--> <dependency> <groupId>com.auth0</groupId> <artifactId>java-jwt</artifactId> <version>3.4.0</version> </dependency> <!--引入mybatis--> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.1.3</version> </dependency> <!--引入lombok--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.12</version> </dependency> <!--引入druid--> <dependency> <groupId>com.alibaba</groupId> <artifactId>druid</artifactId> <version>1.1.19</version> </dependency> <!--引入mysql--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.38</version> </dependency>
配置
server.port=8989 spring.application.name=jwt spring.datasource.type=com.alibaba.druid.pool.DruidDataSource spring.datasource.driver-class-name=com.mysql.jdbc.Driver spring.datasource.url=jdbc:mysql://localhost:3306/jwt?characterEncoding=UTF-8 spring.datasource.username=root spring.datasource.password=root mybatis.type-aliases-package=com.baizhi.entity mybatis.mapper-locations=classpath:com/baizhi/mapper/*.xml logging.level.com.baizhi.dao=debug
數據庫表
DROP TABLE IF EXISTS `user`; CREATE TABLE `user` ( `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主鍵', `name` varchar(80) DEFAULT NULL COMMENT '用戶名', `password` varchar(40) DEFAULT NULL COMMENT '用戶密碼', PRIMARY KEY (`id`) ) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;
實體類
@Data @Accessors(chain=true) public class User { private String id; private String name; private String password; }
開發DAO接口和mapper.xml
@Mapper public interface UserDAO { User login(User user); }
<mapper namespace="com.baizhi.dao.UserDAO"> <!--這裡就寫的簡單點瞭畢竟不是重點--> <select id="login" parameterType="User" resultType="User"> select * from user where name=#{name} and password = #{password} </select> </mapper>
開發Service 接口以及實現類
public interface UserService { User login(User user);//登錄接口 }
@Service @Transactional public class UserServiceImpl implements UserService { @Autowired private UserDAO userDAO; @Override @Transactional(propagation = Propagation.SUPPORTS) public User login(User user) { User userDB = userDAO.login(user); if(userDB!=null){ return userDB; } throw new RuntimeException("登錄失敗~~"); } }
編寫JWT工具類
/** * @Auther: xppll * @Date: 2021/11/26 13:25 */ public class JWTUtils { //秘鑰 private static final String TOKEN = "xpp@ll"; /** * 生成token(head.playload.sing) * * @param map 用戶傳過瞭的信息,例如id等 * @return */ public static String getToken(Map<String, String> map) { Calendar instance = Calendar.getInstance(); //設置默認7天過期 instance.add(Calendar.DATE, 7); //創建jwt builder JWTCreator.Builder builder = JWT.create(); //payload map.forEach((k, v) -> { builder.withClaim(k, v); }); //指定令牌過期時間 String token = builder.withExpiresAt(instance.getTime()) //sign,傳入加密鹽 .sign(Algorithm.HMAC256(TOKEN)); return token; } /** * 驗證token合法性 * * @param token */ public static void verify(String token) { JWT.require(Algorithm.HMAC256(TOKEN)).build().verify(token); } /** * 獲取token信息方法 * * @param token * @return */ public static DecodedJWT getTokenInfo(String token) { DecodedJWT verify = JWT.require(Algorithm.HMAC256(TOKEN)).build().verify(token); return verify; } }
開發controller
/** * @Auther: xppll * @Date: 2021/11/26 14:07 */ @RestController @Slf4j public class UserController { @Autowired private UserService userService; @GetMapping("/user/login") public Map<String, Object> login(User user) { Map<String, Object> map = new HashMap<>(); try { User userDB = userService.login(user); //用來存放payload Map<String, String> payload = new HashMap<>(); payload.put("id", userDB.getId()); payload.put("name", userDB.getName()); //生成JWT的令牌 String token = JWTUtils.getToken(payload); map.put("state", true); map.put("msg", "成功"); //成功返回token信息 map.put("token", token); } catch (Exception e) { map.put("state", false); map.put("msg", e.getMessage()); } return map; } }
數據庫添加測試數據啟動項目
通過postman模擬登錄失敗
通過postman模擬登錄成功
編寫測試接口
@PostMapping("user/test") public Map<String, Object> test(String token) { //通過攔截器驗證瞭,token驗證成功 Map<String, Object> map = new HashMap<>(); map.put("state", true); map.put("msg", "請求成功!"); return map; }
使用攔截器驗證toke
/** * @Auther: xppll * @Date: 2021/11/26 15:20 */ @Component public class JWTInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { //獲取請求頭中存放的令牌token String token = request.getHeader("token"); Map<String, Object> map = new HashMap<>(); try { //驗證令牌 JWTUtils.verify(token); return true; } catch (SignatureVerificationException e) { e.printStackTrace(); map.put("msg", "無效簽名"); } catch (AlgorithmMismatchException e) { e.printStackTrace(); map.put("msg", "token算法不一致"); } catch (TokenExpiredException e) { e.printStackTrace(); map.put("msg", "token過期"); } catch (Exception e) { e.printStackTrace(); map.put("msg", "token無效"); } map.put("state", false); //將map轉為json,返回給前端 String json = new ObjectMapper().writeValueAsString(map); response.setContentType("application/json;charset=utf-8"); response.getWriter().print(json); return false; } }
使攔截器生效
/**
* @Auther: xppll
* @Date: 2021/11/26 15:28
*/
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
@Autowired
private JWTInterceptor jwtInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(jwtInterceptor)
//其他接口需要token驗證,攔截器攔截
.addPathPatterns("/user/test")
.excludePathPatterns("/user/login");
}
}
到此這篇關於JWT整合Springboot的方法步驟的文章就介紹到這瞭,更多相關JWT整合Springboot內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- Spring Boot詳解整合JWT教程
- 實戰SpringBoot集成JWT實現token驗證
- Java Jwt庫的簡介及使用詳解
- 關於JWT與cookie和token的區別說明
- SpringBoot整合JWT Token的完整步驟