SpringBoot1.5以上版本自定义配置文件

最近在学习SpringBoot方面的知识，基本的框架已经了解的差不多了，今天在搭框架的时候，想到了一个使用场景：在一个Web平台上，如果没有登录该平台，那么访问的界面是有限的，这样我就需要做一个白名单，未登录的用户如果访问的是白名单中的页面，是可以不需要验证其登陆的。
这样问题的解决思路是我需要一个List来放置我的白名单路径，但是我有又不想将这个白名单放置在静态变量中，所以想到了SpringBoot支持自定义配置文件，而我只要维护一个配置文件，在每次过滤器调用的时候将白名单读出来就可以了，这样项目中的开发人员只要维护一个配置文件即可，既然有了思路，那么就可以开始实现了。

读取自定义配置文件

学习过SpringBoot的朋友们应该都知道，Spb的项目配置文件主要是application.properties，当然你也可以自定义生产环境和开发环境的配置文件，具体的方法可以百度，这里不是讨论的重点，现在我们讨论的是在自定义的配置文件中读取配置信息的方法：

1. 创建配置文件
   在resources/目录下创建config文件夹，并在该文件夹下创建"visit_white_list.properties"文件。
2. 填写配置文件内容
   既然是一个白名单，那肯定用List来存放数据是最合适不过得了，配置文件中，创建List的方法很简单，其配置文件的内容如下：

web.whitelist[0]=/hello 
web.whitelist[1]=/hello1
web.whitelist[2]=/hello2

先不说具体的意义，单从语法来看，这段代码就是一个数组形式的定义，当然你也可以定义字符串类型或者数字类型的属性值，这里我就不多做赘述了，现在进入下一步。

3. 创建管理配置的实体类
   其实这篇文章存在的意义就在于，1.5之后和1.5之前，管理配置的实体类是有变化的
   首先我们来看看1.5之前实体类的写法：

@ConfigurationProperties(locations = "classpath:config/visit_white_list.properties", prefix = "web")
@Component
public class WhiteListConfig {

    public List getWhitelist() {
        return whitelist;
    }

    public void setWhitelist(List whitelist) {
        this.whitelist = whitelist;
    }

    private List  whitelist;
}

再看看1.5之后的写法

@Component
@PropertySource(value = "classpath:config/visit_white_list.properties")
@ConfigurationProperties(prefix = "web")
public class WhiteListConfig {

    public List getWhitelist() {
        return whitelist;
    }

    public void setWhitelist(List whitelist) {
        this.whitelist = whitelist;
    }

    private List  whitelist;
}

在@ConfigurationProperties注释中有两个属性：

locations：指定配置文件的所在位置
prefix：指定配置文件中键名称的前缀（我这里配置文件中所有键名都是以web.开头）

使用@Component是让该类能够在其他地方被依赖使用，即使用@Autowired注释来创建实例。
但是1.5之后取消了 @ConfigurationProperties 的 locations属性，所以在1.5之后 需要加入@PropertySource 属性来指定自定义配置文件的相对路径，以便系统加载。

4. 创建过滤器
   过滤器的内容：

/**
 * 使用注解标注过滤器
 *
 * @version v.0.1
 * @WebFilter将一个实现了javax.servlet.Filter接口的类定义为过滤器 属性filterName声明过滤器的名称, 可选
 * 属性urlPatterns指定要过滤的URL模式,也可使用属性value来声明.(指定要过滤的URL模式是必选属性)
 */
@WebFilter(filterName = "AuthFilter", urlPatterns = "/*")
public class AuthFilter implements Filter {
    @Autowired
    private WhiteListConfig myWebConfig;
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

        System.out.println("访问路径权限过滤器初始化");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("访问路径权限开始执行过滤器");
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        HttpSession session = request.getSession(true);
        String usercode = (String) request.getRemoteUser();// 登录人
        String user_role = (String) session.getAttribute("role");//登录人角色
        String url = request.getRequestURI();

        if (usercode == null || "".equals(usercode) || user_role == null || "".equals(user_role)) {
            //判断获取的路径不为空且不是访问登录页面或执行登录操作时跳转
            if (!myWebConfig.getWhitelist().contains(url) &&url != null && !url.equals("") && (url.indexOf("Login") < 0 && url.indexOf("login") < 0)) {
                //无权限时跳转到登录界面
                response.sendRedirect(request.getContextPath() + "/login.dhcc");
                return;
            }
        }
        filterChain.doFilter(servletRequest, servletResponse);
        return;


    }

    @Override
    public void destroy() {
        System.out.println("访问路径权限过滤器销毁");
    }
}

使用

 @Autowired
    private WhiteListConfig myWebConfig;

获取到白名单配置文件并获取其list对象来判断当前Url是否在白名单范围内即可。

总结

网上查了很多资料，关于SpringBoot读取自定义配置文件的方法都是属于1.5之前的读取方式，而我的项目属于1.5之后的，于是搜了很多资料才找到1.5之后的配置方式，在此分享给大家，希望大家少走弯路吧。

相关资料

1. Springboot 之 自定义配置文件及读取配置文件
2. spring boot1.5以上版本@ConfigurationProperties取消location注解后的替代方案

作者：贾亦真亦贾
链接：https://www.jianshu.com/p/b7946633d6e4
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。