springboot如何獲取登錄用戶的個人信息
在Spring Boot中,獲取登錄用戶的個人信息通常需要使用Spring Security框架來進行身份認證和授權。Spring Security提供了一個名為SecurityContextHolder的上下文對象,它包含了當前請求的身份認證信息。通過SecurityContextHolder,可以訪問當前已認證的用戶的信息。
1.Pojo實體類
當使用 Spring Boot + Spring Security 構建 Web 應用程序時,我們需要定義用戶實體類來存儲用戶信息。以下是一個基本的 User
實體類
@Entity @Table(name = "users") public class User implements UserDetails { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; @Column(nullable = false, unique = true) private String username; @Column(nullable = false) private String password; @Column(nullable = false) private String fullName; @Column(nullable = false, unique = true) private String email; // 用戶角色定義為一個字符串,用逗號分隔 @Column(nullable = false) private String roles; // 其他字段和方法 // UserDetails 方法的實現 @Override public Collection<? extends GrantedAuthority> getAuthorities() { return Arrays.stream(roles.split(",")) .map(SimpleGrantedAuthority::new) .collect(Collectors.toList()); } @Override public boolean isAccountNonExpired() { return true; } @Override public boolean isAccountNonLocked() { return true; } @Override public boolean isCredentialsNonExpired() { return true; } @Override public boolean isEnabled() { return true; } }
在這個例子中,User
實體類使用 @Entity
和 @Table
注解進行了標記,表明它是一個 JPA 實體類,并且對應了一個名為 users
的數據庫表。實體類中包含了一些基本的屬性,例如 id
、username
、password
、fullName
和 email
。另外,roles
屬性定義了用戶的角色,這是一個字符串,多個角色之間用逗號分隔。
User
實體類實現了 UserDetails
接口,該接口包含了一些必須實現的方法,用于獲取用戶的授權信息。在 getAuthorities()
方法中,我們將用戶的角色字符串分割成多個角色,并將其轉換為 Spring Security 中的 GrantedAuthority
對象。其余的方法返回的都是 true
,表示這些限制條件都沒有被啟用。
你還可以根據你的業(yè)務需求對 User
實體類進行擴展或修改。
要獲取已認證用戶的信息,可以在控制器方法中注入Authentication對象,然后從該對象中獲取用戶信息。例如:
2. Controller層
import org.springframework.security.core.Authentication; import org.springframework.security.core.userdetails.UserDetails; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class UserController { @GetMapping("/me") public UserDetails getUserDetails(Authentication authentication) { return (UserDetails) authentication.getPrincipal(); } }
在上面的代碼中,使用@GetMapping注解將控制器方法映射到“/me”路徑。方法中注入Authentication對象,并從該對象中獲取Principal,即已認證用戶的信息。由于Spring Security默認使用UserDetailsService來加載用戶信息,因此Principal通常是UserDetails對象。
如果您想要訪問更多的用戶信息,可以自定義一個UserDetailsService,通過UserDetailsService從數據庫或其他數據源中加載用戶信息。然后,您可以通過從Principal中獲取用戶名或其他標識符來檢索用戶信息。
當使用Spring Security進行身份認證時,需要實現UserDetailsService接口來加載用戶信息。UserDetailsService接口只有一個方法:loadUserByUsername,該方法返回一個實現了UserDetails接口的對象,該對象包含有關用戶的信息。
下面是一個簡單的UserDetailsService類的示例,它從內存中的用戶列表中加載用戶信息:
3. Service層
import java.util.ArrayList; import java.util.List; import org.springframework.security.core.GrantedAuthority; import org.springframework.security.core.authority.SimpleGrantedAuthority; import org.springframework.security.core.userdetails.User; import org.springframework.security.core.userdetails.UserDetails; import org.springframework.security.core.userdetails.UserDetailsService; import org.springframework.security.core.userdetails.UsernameNotFoundException; public class MyUserDetailsService implements UserDetailsService { private List<User> users = new ArrayList<>(); public MyUserDetailsService() { users.add(new User("user1", "password1", getAuthorityList("ROLE_USER"))); users.add(new User("user2", "password2", getAuthorityList("ROLE_USER"))); users.add(new User("admin", "password", getAuthorityList("ROLE_USER", "ROLE_ADMIN"))); } @Override public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException { for (User user : users) { if (user.getUsername().equals(username)) { return user; } } throw new UsernameNotFoundException("User not found with username: " + username); } private List<GrantedAuthority> getAuthorityList(String... roles) { List<GrantedAuthority> authorityList = new ArrayList<>(); for (String role : roles) { authorityList.add(new SimpleGrantedAuthority(role)); } return authorityList; } }
在上面的代碼中,MyUserDetailsService類實現了UserDetailsService接口,并重寫了loadUserByUsername方法。該方法首先檢查用戶列表中是否存在與傳遞的用戶名匹配的用戶,如果找到該用戶,則將其作為UserDetails對象返回。否則,拋出UsernameNotFoundException異常。
4. Spring Security配置類
在這個例子中,用戶列表是硬編碼在MyUserDetailsService類中的。在實際應用中,您將從數據庫或其他數據源中獲取用戶信息,并在loadUserByUsername方法中使用它。此外,您還可以根據需要添加更多的用戶屬性,例如電子郵件地址、電話號碼等。
最后,值得一提的是,在實現UserDetailsService接口時,請務必確保密碼已被加密并保存為哈希值。在本示例中,密碼是明文存儲的,但在實際應用中,應使用Spring Security提供的密碼編碼器來對密碼進行加密。
以下是一份完整的示例代碼,包括一個自定義的UserDetailsService和Spring Security配置類:
import java.util.ArrayList; import java.util.List; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Configuration; import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder; import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter; import org.springframework.security.core.GrantedAuthority; import org.springframework.security.core.authority.SimpleGrantedAuthority; import org.springframework.security.core.userdetails.User; import org.springframework.security.core.userdetails.UserDetails; import org.springframework.security.core.userdetails.UserDetailsService; import org.springframework.security.core.userdetails.UsernameNotFoundException; import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; @Configuration @EnableWebSecurity @EnableGlobalMethodSecurity(prePostEnabled = true) public class SecurityConfig extends WebSecurityConfigurerAdapter { @Autowired private UserDetailsService userDetailsService; @Override protected void configure(AuthenticationManagerBuilder auth) throws Exception { auth.userDetailsService(userDetailsService).passwordEncoder(new BCryptPasswordEncoder()); } @Override protected void configure(HttpSecurity http) throws Exception { http.authorizeRequests() .antMatchers("/admin/**").hasRole("ADMIN") .antMatchers("/user/**").hasAnyRole("ADMIN", "USER") .antMatchers("/").permitAll() .and().formLogin() .and().logout().logoutSuccessUrl("/login").permitAll(); } } class MyUserDetailsService implements UserDetailsService { private List<User> users = new ArrayList<>(); public MyUserDetailsService() { users.add(new User("user1", "$2a$10$HKV7WJB/FNH8/3wXXtGB0.bDrxPlheBlsHSDkOizQ94RyL5v5n5oy", getAuthorityList("ROLE_USER"))); users.add(new User("user2", "$2a$10$L9.Jir1vH6Wjtr8ZnI6FseV6rHdLWnV7yI0g1lV7vLmFFopW8VzU6", getAuthorityList("ROLE_USER"))); users.add(new User("admin", "$2a$10$5aJN5O5pyrgQMDR.Ta5/0.hxOeSw/3nm3q9XcVvBIzDdtyA8DPZ3C", getAuthorityList("ROLE_USER", "ROLE_ADMIN"))); } @Override public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException { for (User user : users) { if (user.getUsername().equals(username)) { return user; } } throw new UsernameNotFoundException("User not found with username: " + username); } private List<GrantedAuthority> getAuthorityList(String... roles) { List<GrantedAuthority> authorityList = new ArrayList<>(); for (String role : roles) { authorityList.add(new SimpleGrantedAuthority(role)); } return authorityList; } }
上面的代碼包含了一個自定義的UserDetailsService實現類和一個Spring Security配置類。以下是代碼中的一些要點:
5. 測試注意事項
MyUserDetailsService類:這是一個自定義的UserDetailsService實現類,用于從硬編碼的用戶列表中加載用戶信息。在loadUserByUsername方法中,根據傳遞的用戶名
以下是使用Postman測試API接口的步驟:
- 打開Postman軟件并創(chuàng)建一個新的請求。在請求的URL地址欄中輸入API接口的URL,例如
http://localhost:8080/user/info
- 點擊請求方式旁邊的下拉菜單,選擇HTTP請求方法,例如GET方法。
- 在請求頭(Headers)中添加必要的認證信息,例如添加一個Authorization頭,其值為Bearer加上訪問令牌(access token),例如
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMSIsInJvbGUiOiJVU0VSIiwiaWF0IjoxNTE2MjM5MDIyfQ.kNqr5ZCw5vFh1dW8Kq3t_ZL-3q_kh12VTWg_w8mZisI
- 如果API接口需要傳遞請求參數,可以在請求參數(Params)中添加參數名和參數值。
- 點擊發(fā)送按鈕,發(fā)送請求并查看響應結果。
- 如果請求成功,可以在響應結果中看到API接口返回的數據,如果請求失敗,可以查看響應狀態(tài)碼和錯誤信息來定位問題。
需要注意的是,在測試API接口時,需要了解API接口的請求參數、請求方式、認證方式等信息,并在請求頭和請求參數中正確傳遞信息。另外,為了避免誤操作,建議在測試環(huán)境中測試API接口,不要在生產環(huán)境中測試API接口
根據上面提供的代碼,如果在Postman中成功請求 /user/info
接口,將會收到類似下面的 JSON 格式響應數據:
{ "id": 1, "username": "user1", "fullName": "User One", "email": "user1@example.com" }
其中,id
是用戶ID,username
是用戶名,fullName
是用戶的全名,email
是用戶的電子郵件地址。這些數據是在 UserInfo
類中定義的。
需要注意的是,如果沒有授權訪問該接口或者用戶不存在,那么響應數據中將不會包含這些信息。如果出現這種情況,響應數據中可能會包含錯誤消息。
6. Controller層代碼改造
當使用 Spring Boot + Spring Security 構建 Web 應用程序時,可以使用 ResponseEntity
類來設置響應的 HTTP 狀態(tài)碼。ResponseEntity
類包裝了 HTTP 響應的正文、HTTP 狀態(tài)碼以及響應頭信息。它允許我們返回自定義響應實體,而不是使用默認的響應實體。
在你的代碼中,你可以使用 ResponseEntity<UserInfo>
替換原本的 UserInfo
返回類型。這樣,就可以將 HTTP 狀態(tài)碼作為 ResponseEntity
的一部分返回到客戶端。在 getUserInfo()
方法中,你可以使用以下代碼返回帶有狀態(tài)碼的響應:
@GetMapping("/user/info") public ResponseEntity<UserInfo> getUserInfo() { // 獲取當前登錄用戶 Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); if (authentication == null || !authentication.isAuthenticated()) { return ResponseEntity.status(HttpStatus.UNAUTHORIZED).build(); } // 獲取用戶信息并返回 String username = authentication.getName(); UserInfo userInfo = userService.getUserInfoByUsername(username); return ResponseEntity.ok(userInfo); }
在這個例子中,如果用戶未授權或未經身份驗證,則將返回 HTTP 401 狀態(tài)碼。如果用戶已經經過身份驗證,將返回 HTTP 200 狀態(tài)碼,并帶有用戶信息。
如果需要在 Postman 中測試 API 的響應狀態(tài)碼,可以在請求完成后查看響應面板的右上角,顯示的是響應的狀態(tài)碼和消息。
在我上面已經回答針對如何使用 ResponseEntity
設置 HTTP 狀態(tài)碼做了說明,同時也提到了如何在 Postman 中查看響應的狀態(tài)碼。
在 Spring Boot 應用程序中,我們可以使用 ResponseEntity
類來包裝響應實體,并指定返回的 HTTP 狀態(tài)碼。例如,在 getUserInfo()
方法中,我們可以使用以下代碼返回帶有
@GetMapping("/user/info") public ResponseEntity<UserInfo> getUserInfo() { // 獲取當前登錄用戶 Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); if (authentication == null || !authentication.isAuthenticated()) { return ResponseEntity.status(HttpStatus.UNAUTHORIZED).build(); } // 獲取用戶信息并返回 String username = authentication.getName(); UserInfo userInfo = userService.getUserInfoByUsername(username); return ResponseEntity.ok(userInfo); }
在這個例子中,如果用戶未授權或未經身份驗證,則將返回 HTTP 401 狀態(tài)碼。如果用戶已經經過身份驗證,將返回 HTTP 200 狀態(tài)碼,并帶有用戶信息。
在 Postman 中查看響應的狀態(tài)碼,可以在請求完成后查看響應面板的右上角,顯示的是響應的狀態(tài)碼和消息。如果返回的狀態(tài)碼為200,則表示請求成功,其他狀態(tài)碼則表示請求失敗。
7. sql腳本
CREATE TABLE `users` ( `id` BIGINT(20) NOT NULL AUTO_INCREMENT, `username` VARCHAR(50) NOT NULL, `password` VARCHAR(100) NOT NULL, `full_name` VARCHAR(100) NOT NULL, `email` VARCHAR(100) NOT NULL, `roles` VARCHAR(100) NOT NULL, PRIMARY KEY (`id`), UNIQUE KEY `UK_username` (`username`), UNIQUE KEY `UK_email` (`email`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
在這個例子中,我們定義了一個名為 users
的表,它包含了以下字段:
id
:用戶的唯一標識符,使用自增長的方式生成。username
:用戶的登錄名,必須是唯一的。password
:用戶的登錄密碼,存儲加密后的密碼。full_name
:用戶的全名,用于顯示用戶的真實姓名。email
:用戶的電子郵件地址,必須是唯一的。roles
:用戶的角色,以逗號分隔多個角色。
在實際應用中,你可以根據需要對數據表進行修改和擴展。
到此這篇關于springboot獲取登錄用戶的個人信息的文章就介紹到這了,更多相關springboot登錄用戶的個人信息內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
Java如何優(yōu)雅地避免空指針異常(NullPointerException)
這篇文章主要給大家介紹了關于Java如何優(yōu)雅地避免空指針異常(NullPointerException)的相關資料,空指針異常(NullPointerException)是一種常見的運行時異常,它在Java編程中經常出現,需要的朋友可以參考下2024-03-03簡單談談Java遍歷樹深度優(yōu)先和廣度優(yōu)先的操作方式
這篇文章主要介紹了簡單談談Java遍歷樹深度優(yōu)先和廣度優(yōu)先的操作方式的相關資料,需要的朋友可以參考下2023-03-03Spring實戰(zhàn)之使用ClassPathResource加載xml資源示例
這篇文章主要介紹了Spring實戰(zhàn)之使用ClassPathResource加載xml資源,結合實例形式分析了Spring使用ClassPathResource加載xml資源的具體實現步驟與相關操作技巧,需要的朋友可以參考下2019-12-12