您的位置: 首页  >  文章  >  Spring Boot实战之Filter实现简单的Http Basic认证

Spring Boot实战之Filter实现简单的Http Basic认证

分类: 文章 • 2025-04-17 16:05:45

Spring Boot实战之Filter


本文在上一篇文章http://blog.****.net/sun_t89/article/details/51912905 的基础上，给每个rest接口上添加过滤器，使用过滤器实现简单的Http Basic认证


1、Filter功能

filter功能，它使用户可以改变一个 request和修改一个response. Filter 不是一个servlet,它不能产生一个response,它能够在一个request到达servlet之前预处理request,也可以在离开 servlet时处理response.换种说法,filter其实是一个”servlet chaining”(servlet 链).
一个Filter包括：
1）、在servlet被调用之前截获;
2）、在servlet被调用之前检查servlet request;
3）、根据需要修改request头和request数据;
4）、根据需要修改response头和response数据;
5）、在servlet被调用之后截获.


2、定义自己的过滤器

新增HTTPBasicAuthorizeAttribute.java

如果请求的Header中存在Authorization: Basic 头信息，且用户名密码正确，则继续原来的请求，否则返回没有权限的错误信息

[java] view plain copy
  1. package com.xiaofangtech.sunt.filter;  
  2.   
  3. import java.io.IOException;  
  4.   
  5. import javax.servlet.Filter;  
  6. import javax.servlet.FilterChain;  
  7. import javax.servlet.FilterConfig;  
  8. import javax.servlet.ServletException;  
  9. import javax.servlet.ServletRequest;  
  10. import javax.servlet.ServletResponse;  
  11. import javax.servlet.http.HttpServletRequest;  
  12. import javax.servlet.http.HttpServletResponse;  
  13.   
  14. import com.fasterxml.jackson.databind.ObjectMapper;  
  15. import com.xiaofangtech.sunt.utils.ResultMsg;  
  16. import com.xiaofangtech.sunt.utils.ResultStatusCode;  
  17. import sun.misc.BASE64Decoder;  
  18.   
  19. @SuppressWarnings("restriction")  
  20. public class HTTPBasicAuthorizeAttribute implements Filter{  
  21.       
  22.     private static String Name = "test";  
  23.     private static String Password = "test";  
  24.   
  25.     @Override  
  26.     public void destroy() {  
  27.         // TODO Auto-generated method stub  
  28.           
  29.     }  
  30.   
  31.     @Override  
  32.     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)  
  33.             throws IOException, ServletException {  
  34.         // TODO Auto-generated method stub  
  35.           
  36.         ResultStatusCode resultStatusCode = checkHTTPBasicAuthorize(request);  
  37.         if (resultStatusCode != ResultStatusCode.OK)  
  38.         {  
  39.             HttpServletResponse httpResponse = (HttpServletResponse) response;  
  40.             httpResponse.setCharacterEncoding("UTF-8");    
  41.             httpResponse.setContentType("application/json; charset=utf-8");   
  42.             httpResponse.setStatus(HttpServletResponse.SC_UNAUTHORIZED);  
  43.   
  44.             ObjectMapper mapper = new ObjectMapper();  
  45.               
  46.             ResultMsg resultMsg = new ResultMsg(ResultStatusCode.PERMISSION_DENIED.getErrcode(), ResultStatusCode.PERMISSION_DENIED.getErrmsg(), null);  
  47.             httpResponse.getWriter().write(mapper.writeValueAsString(resultMsg));  
  48.             return;  
  49.         }  
  50.         else  
  51.         {  
  52.             chain.doFilter(request, response);  
  53.         }  
  54.     }  
  55.   
  56.     @Override  
  57.     public void init(FilterConfig arg0) throws ServletException {  
  58.         // TODO Auto-generated method stub  
  59.           
  60.     }  
  61.       
  62.     private ResultStatusCode checkHTTPBasicAuthorize(ServletRequest request)  
  63.     {  
  64.         try  
  65.         {  
  66.             HttpServletRequest httpRequest = (HttpServletRequest)request;  
  67.             String auth = httpRequest.getHeader("Authorization");  
  68.             if ((auth != null) && (auth.length() > 6))  
  69.             {  
  70.                 String HeadStr = auth.substring(0, 5).toLowerCase();  
  71.                 if (HeadStr.compareTo("basic") == 0)  
  72.                 {  
  73.                     auth = auth.substring(6, auth.length());    
  74.                     String decodedAuth = getFromBASE64(auth);  
  75.                     if (decodedAuth != null)  
  76.                     {  
  77.                         String[] UserArray = decodedAuth.split(":");  
  78.                           
  79.                         if (UserArray != null && UserArray.length == 2)  
  80.                         {  
  81.                             if (UserArray[0].compareTo(Name) == 0  
  82.                                     && UserArray[1].compareTo(Password) == 0)  
  83.                             {  
  84.                                 return ResultStatusCode.OK;  
  85.                             }  
  86.                         }  
  87.                     }  
  88.                 }  
  89.             }  
  90.             return ResultStatusCode.PERMISSION_DENIED;  
  91.         }  
  92.         catch(Exception ex)  
  93.         {  
  94.             return ResultStatusCode.PERMISSION_DENIED;  
  95.         }  
  96.           
  97.     }  
  98.       
  99.     private String getFromBASE64(String s) {    
  100.         if (s == null)    
  101.             return null;    
  102.         BASE64Decoder decoder = new BASE64Decoder();    
  103.         try {    
  104.             byte[] b = decoder.decodeBuffer(s);    
  105.             return new String(b);    
  106.         } catch (Exception e) {    
  107.             return null;    
  108.         }    
  109.     }  
  110.   
  111. }  


3、在SpringRestApplication类中注册过滤器，给user/*都加上http basic认证过滤器

[java] view plain copy
  1. package com.xiaofangtech.sunt;  
  2.   
  3. import java.util.ArrayList;  
  4. import java.util.List;  
  5.   
  6. import org.springframework.boot.SpringApplication;  
  7. import org.springframework.boot.autoconfigure.SpringBootApplication;  
  8. import org.springframework.boot.context.embedded.FilterRegistrationBean;  
  9. import org.springframework.context.annotation.Bean;  
  10.   
  11. import com.xiaofangtech.sunt.filter.HTTPBasicAuthorizeAttribute;  
  12.   
  13. @SpringBootApplication  
  14. public class SpringRestApplication {  
  15.   
  16.     public static void main(String[] args) {  
  17.         SpringApplication.run(SpringRestApplication.class, args);  
  18.     }  
  19.       
  20.     @Bean  
  21.     public FilterRegistrationBean  filterRegistrationBean() {  
  22.         FilterRegistrationBean registrationBean = new FilterRegistrationBean();  
  23.         HTTPBasicAuthorizeAttribute httpBasicFilter = new HTTPBasicAuthorizeAttribute();  
  24.         registrationBean.setFilter(httpBasicFilter);  
  25.         List<String> urlPatterns = new ArrayList<String>();  
  26.         urlPatterns.add("/user/*");  
  27.         registrationBean.setUrlPatterns(urlPatterns);  
  28.         return registrationBean;  
  29.     }  
  30. }  


4、测试

代码中固定用户名密码都为test，所以对接口进行请求时，需要添加以下认证头信息

Authorization: Basic dGVzdDp0ZXN0

dGVzdDp0ZXN0 为 test:test 经过base64编码后的结果


如果未添加认证信息或者认证信息错误，返回没有权限的错误信息

Spring Boot实战之Filter实现简单的Http Basic认证



当认证信息正确，返回请求结果

Spring Boot实战之Filter实现简单的Http Basic认证


相关推荐