Retrieve User Information in Spring Security – 在Spring Security中检索用户信息

最后修改: 2013年 7月 16日

1. Overview


This tutorial will show how to retrieve the user details in Spring Security.

本教程将展示如何在Spring Security中检索用户详情。

The currently authenticated user is available through a number of different mechanisms in Spring. Let’s cover the most common solution first — programmatic access.


2. Get the User in a Bean


The simplest way to retrieve the currently authenticated principal is via a static call to the SecurityContextHolder:


Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
String currentPrincipalName = authentication.getName();

An improvement to this snippet is first checking if there is an authenticated user before trying to access it:


Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
if (!(authentication instanceof AnonymousAuthenticationToken)) {
    String currentUserName = authentication.getName();
    return currentUserName;

There are of course downsides to having a static call like this, and decreased testability of the code is one of the more obvious. Instead, we’ll explore alternative solutions for this very common requirement.


3. Get the User in a Controller


We have additional options in a @Controller annotated bean.


We can define the principal directly as a method argument, and it will be correctly resolved by the framework:


public class SecurityController {

    @RequestMapping(value = "/username", method = RequestMethod.GET)
    public String currentUserName(Principal principal) {
        return principal.getName();

Alternatively, we can also use the authentication token:


public class SecurityController {

    @RequestMapping(value = "/username", method = RequestMethod.GET)
    public String currentUserName(Authentication authentication) {
        return authentication.getName();

The API of the Authentication class is very open so that the framework remains as flexible as possible. Because of this, the Spring Security principal can only be retrieved as an Object and needs to be cast to the correct UserDetails instance:

Authentication类的API是非常开放的,以便框架尽可能地保持灵活性。正因为如此,Spring Security principal只能以Object的形式被检索,并且需要被转换为正确的UserDetails实例

UserDetails userDetails = (UserDetails) authentication.getPrincipal();
System.out.println("User has authorities: " + userDetails.getAuthorities());

And finally, here’s directly from the HTTP request:


public class GetUserWithHTTPServletRequestController {

    @RequestMapping(value = "/username", method = RequestMethod.GET)
    public String currentUserNameSimple(HttpServletRequest request) {
        Principal principal = request.getUserPrincipal();
        return principal.getName();

4. Get the User via a Custom Interface


To fully leverage the Spring dependency injection and be able to retrieve the authentication everywhere, not just in @Controller beans, we need to hide the static access behind a simple facade:

为了充分利用Spring的依赖注入,并且能够在任何地方检索认证,而不仅仅是在@Controller Bean中,我们需要将静态访问隐藏在一个简单的facade后面。

public interface IAuthenticationFacade {
    Authentication getAuthentication();
public class AuthenticationFacade implements IAuthenticationFacade {

    public Authentication getAuthentication() {
        return SecurityContextHolder.getContext().getAuthentication();

The facade exposes the Authentication object while hiding the static state and keeping the code decoupled and fully testable:


public class GetUserWithCustomInterfaceController {
    private IAuthenticationFacade authenticationFacade;

    @RequestMapping(value = "/username", method = RequestMethod.GET)
    public String currentUserNameSimple() {
        Authentication authentication = authenticationFacade.getAuthentication();
        return authentication.getName();

5. Get the User in JSP


The currently authenticated principal can also be accessed in JSP pages, by leveraging the Spring Security Taglib support.

通过利用Spring Security Taglib支持,当前认证的委托人也可以在JSP页面中访问

First, we need to define the tag in the page:


<%@ taglib prefix="security" uri="" %>

Next, we can refer to the principal:


<security:authorize access="isAuthenticated()">
    authenticated as <security:authentication property="principal.username" /> 

6. Get the User in Thymeleaf


Thymeleaf is a modern, server-side web templating engine, with good integration with the Spring MVC framework.

Thymeleaf是一个现代的服务器端Web模板引擎,具有良好的与Spring MVC框架的集成性。

Let’s see how to access the currently authenticated principal in a page with Thymeleaf engine.


First, we need to add the thymeleaf-spring5 and the thymeleaf-extras-springsecurity5 dependencies to integrate Thymeleaf with Spring Security:

首先,我们需要添加thymeleaf-spring5thymeleaf-extras-springsecurity5依赖项,以便将Thymeleaf与Spring Security集成。


Now we can refer to the principal in the HTML page using the sec:authorize attribute:


<html xmlns:th="" 
    <div sec:authorize="isAuthenticated()">
      Authenticated as <span sec:authentication="name"></span></div>

7. Conclusion


This article showed how to get the user information in a Spring application, starting with the common static access mechanism, followed by several better ways to inject the principal.


The implementation of these examples can be found in the GitHub project. This is an Eclipse-based project, so it should be easy to import and run as it is. When running the project locally, we can access the homepage HTML here:

这些示例的实现可以在GitHub项目中找到。这是一个基于 Eclipse 的项目,因此应该很容易导入并按原样运行。在本地运行该项目时,我们可以在这里访问主页的HTML。