From e844101e69dcf2878f9ac83f83e8f7fe2112ac67 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=8E=E4=B8=9C=E4=BD=B3?= <14614659+dongjia-li@user.noreply.gitee.com> Date: Sat, 10 Aug 2024 17:44:09 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=BB=BAtokenResp?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../muyu/auth/controller/TokenController.java | 27 ++++++++--- .../com/muyu/auth/domain/LoginUserReq.java | 42 +++++++++++++++++ .../com/muyu/auth/domain/RegisterBody.java | 10 +++++ .../java/com/muyu/auth/domain/TokenResp.java | 45 +++++++++++++++++++ .../java/com/muyu/auth/form/LoginBody.java | 34 -------------- .../java/com/muyu/auth/form/RegisterBody.java | 10 ----- 6 files changed, 119 insertions(+), 49 deletions(-) create mode 100644 src/main/java/com/muyu/auth/domain/LoginUserReq.java create mode 100644 src/main/java/com/muyu/auth/domain/RegisterBody.java create mode 100644 src/main/java/com/muyu/auth/domain/TokenResp.java delete mode 100644 src/main/java/com/muyu/auth/form/LoginBody.java delete mode 100644 src/main/java/com/muyu/auth/form/RegisterBody.java diff --git a/src/main/java/com/muyu/auth/controller/TokenController.java b/src/main/java/com/muyu/auth/controller/TokenController.java index d870762..822e2c9 100644 --- a/src/main/java/com/muyu/auth/controller/TokenController.java +++ b/src/main/java/com/muyu/auth/controller/TokenController.java @@ -1,22 +1,28 @@ package com.muyu.auth.controller; -import com.muyu.auth.form.LoginBody; -import com.muyu.auth.form.RegisterBody; +import com.muyu.auth.domain.LoginUserReq; +import com.muyu.auth.domain.RegisterBody; +import com.muyu.auth.domain.TokenResp; import com.muyu.auth.service.SysLoginService; import com.muyu.common.core.domain.Result; +import com.muyu.common.core.text.Convert; import com.muyu.common.core.utils.JwtUtils; import com.muyu.common.core.utils.StringUtils; import com.muyu.common.security.auth.AuthUtil; import com.muyu.common.security.service.TokenService; import com.muyu.common.security.utils.SecurityUtils; import com.muyu.common.system.domain.LoginUser; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.tags.Tag; +import jakarta.servlet.http.HttpServletRequest; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.DeleteMapping; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RestController; -import jakarta.servlet.http.HttpServletRequest; +import java.util.Map; /** * token 控制 @@ -24,6 +30,7 @@ import jakarta.servlet.http.HttpServletRequest; * @author muyu */ @RestController +@Tag(name = "鉴权接口", description = "鉴权相关控制层") public class TokenController { @Autowired private TokenService tokenService; @@ -32,14 +39,23 @@ public class TokenController { private SysLoginService sysLoginService; @PostMapping("login") - public Result login (@RequestBody LoginBody form) { + @Operation(summary = "登录接口", description = "登录鉴权接口") + @Schema + public Result login (@RequestBody LoginUserReq form) { // 用户登录 LoginUser userInfo = sysLoginService.login(form.getUsername(), form.getPassword()); // 获取登录token - return Result.success(tokenService.createToken(userInfo)); + Map tokenMap = tokenService.createToken(userInfo); + return Result.success( + TokenResp.builder() + .accessToken(Convert.toStr(tokenMap.get("access_token"))) + .expiresIn(Convert.toLong(tokenMap.get("expires_in"))) + .build() + ); } @DeleteMapping("logout") + @Operation(summary = "登出接口", description = "用户登出接口") public Result logout (HttpServletRequest request) { String token = SecurityUtils.getToken(request); if (StringUtils.isNotEmpty(token)) { @@ -53,6 +69,7 @@ public class TokenController { } @PostMapping("refresh") + @Operation(summary = "用户登录时间刷新", description = "用户登录时间刷新接口, 可进行用户token续约") public Result refresh (HttpServletRequest request) { LoginUser loginUser = tokenService.getLoginUser(request); if (StringUtils.isNotNull(loginUser)) { diff --git a/src/main/java/com/muyu/auth/domain/LoginUserReq.java b/src/main/java/com/muyu/auth/domain/LoginUserReq.java new file mode 100644 index 0000000..3681f35 --- /dev/null +++ b/src/main/java/com/muyu/auth/domain/LoginUserReq.java @@ -0,0 +1,42 @@ +package com.muyu.auth.domain; + +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.tags.Tag; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +/** + * 用户登录对象 + * + * @author muyu + */ +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +@Tag(name = "登录请求实体类") +public class LoginUserReq { + /** + * 用户名 + */ + @Schema( + title = "用户名", + type = "String", + defaultValue = "admin", + description = "登录用户名" + ) + private String username; + + /** + * 用户密码 + */ + @Schema( + title = "用户密码", + type = "String", + defaultValue = "admin123", + description = "登录用户密码" + ) + private String password; +} diff --git a/src/main/java/com/muyu/auth/domain/RegisterBody.java b/src/main/java/com/muyu/auth/domain/RegisterBody.java new file mode 100644 index 0000000..141062c --- /dev/null +++ b/src/main/java/com/muyu/auth/domain/RegisterBody.java @@ -0,0 +1,10 @@ +package com.muyu.auth.domain; + +/** + * 用户注册对象 + * + * @author muyu + */ +public class RegisterBody extends LoginUserReq { + +} diff --git a/src/main/java/com/muyu/auth/domain/TokenResp.java b/src/main/java/com/muyu/auth/domain/TokenResp.java new file mode 100644 index 0000000..7be3697 --- /dev/null +++ b/src/main/java/com/muyu/auth/domain/TokenResp.java @@ -0,0 +1,45 @@ +package com.muyu.auth.domain; + +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.tags.Tag; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +/** + * @Author:LiDongJia + * @Package:com.muyu.auth.domain + * @Project:cloud-auth + * @name:TokenResp + * @Date:2024/8/10 17:28 + */ +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +@Tag(name = "token响应结果集", description = "包含token和token有效时间") +public class TokenResp { + + /** + * token令牌 + */ + @Schema( + title = "token令牌", + type = "String", + defaultValue = "eyJ0eXAiOiJKV1Q.eyJ1c2VyX2lk.vPD0JEZeOfi49e", + description = "JWT令牌, 包含头, 载体, 尾" + ) + private String accessToken; + + /** + * 有效时间 + */ + @Schema( + title = "令牌有效时间", + type = "Long", + defaultValue = "720", + description = "过期时间, 时间单位尾分钟(MIN)" + ) + private Long expiresIn; +} diff --git a/src/main/java/com/muyu/auth/form/LoginBody.java b/src/main/java/com/muyu/auth/form/LoginBody.java deleted file mode 100644 index 999ad44..0000000 --- a/src/main/java/com/muyu/auth/form/LoginBody.java +++ /dev/null @@ -1,34 +0,0 @@ -package com.muyu.auth.form; - -/** - * 用户登录对象 - * - * @author muyu - */ -public class LoginBody { - /** - * 用户名 - */ - private String username; - - /** - * 用户密码 - */ - private String password; - - public String getUsername () { - return username; - } - - public void setUsername (String username) { - this.username = username; - } - - public String getPassword () { - return password; - } - - public void setPassword (String password) { - this.password = password; - } -} diff --git a/src/main/java/com/muyu/auth/form/RegisterBody.java b/src/main/java/com/muyu/auth/form/RegisterBody.java deleted file mode 100644 index c2a4d5a..0000000 --- a/src/main/java/com/muyu/auth/form/RegisterBody.java +++ /dev/null @@ -1,10 +0,0 @@ -package com.muyu.auth.form; - -/** - * 用户注册对象 - * - * @author muyu - */ -public class RegisterBody extends LoginBody { - -}