项目维护小计-异常、拦截器、配置类、分页插件

本篇随笔的内容涉及到几种工具与框架应用技术，其实每一种都可以无限拓展出来单独讲。以后会认真琢磨研究之后再做记录。

异常处理

原系统里对异常没有做任何处理（显然也没有任何事务处理），系统出错直接不响应任何页面。于是便增加如下异常处理方案：

@ControllerAdvice
public class ExceptionHandleAdvice {
    @ExceptionHandler(Exception.class)
    public ModelAndView exception(Exception e) {
        ModelAndView mav = new ModelAndView("errorpage/500");
        mav.addObject("exception", e);
        mav.addObject("type", "Exception");
        return mav;
    }

    @ExceptionHandler(ServiceException.class)
    public ModelAndView serviceException(ServiceException e) {
        ModelAndView mav = new ModelAndView("errorpage/500");
        mav.addObject("exception", e);
        mav.addObject("type", "ServiceException");
        return mav;
    }
}

在errorpage/500.jsp中，可在文本框中输出异常堆栈：

<textarea style="width: 100%" id="error-info" rows="20" class="form-control">错误信息：${exception.message}
            <c:forEach var="trace" items="${exception.stackTrace}">${trace}
            </c:forEach>

全局配置信息拦截器

需要在每个页面输入当前运行环境的配置信息，可通过拦截器在ModelAndView里注入配置。

定义拦截器

@Component
public class EnvInterceptor implements HandlerInterceptor {
    @Autowired
    private SystemConfig systemConfig;
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        if (modelAndView != null) {
            modelAndView.getModelMap().addAttribute("CONFIG", systemConfig);
        }
    }
}

配置拦截器

其中通过 mvc:exclude-mapping去除不要拦截的路径，如：静态资源文件。

<mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <mvc:exclude-mapping path="/assets/**"/>
            <bean class="com.xyz.intercept.EnvInterceptor">
            </bean>
        </mvc:interceptor>
    </mvc:interceptors>

配置完成后，可在jsp页面中可以通过${CONFIG.fieldName}取注入的配置信息。

环境参数与配置类

最开始项目是基于xml进行配置的，不吹不黑，在配置类已经出现那么多年的情况下，还在坚持用xml配置感觉真是一件挺扯淡的事。反正xml给本人的第一感觉是相当的不干净，java需要纯粹的配置类。例如nodejs的配置就直接可是js文件，看上去非常统一。

配置文件目录结构如下，不同环境的配置处于不同的文件下：

src
  main
  resources
    conf
      application-default.properties
      application-local.properties
      application-test.properties
      application-prod.properties

如果是在SpringBoot 项目下，文件会被默认读取，但是对于普通的SpringMVC项目来说，需要如下配置配置文件的读取方式：

 <context:property-placeholder
            location="classpath:conf/application-default.properties,classpath:conf/application-${spring.profiles.active}.properties"
            ignore-unresolvable="true"/>

其中${spring.profiles.active}表示当前profiles，需要从java启动参数里加入。文件会按照配置顺序读取，如果多个文件中含有同名配置，后者会覆盖前者。
之后可以已配置类的形式读取配置文件:

@Configuration
public class SystemConfig {
    @Value("${businessHost}")
    private String businessHost;  
}

这里的businessHost会自动从载入的配置文件中提取。

mybatis分页插件

PageHelper是很常用的mybatis分页插件。

maven配置

<dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>4.1.6</version>
</dependency>

插件配置

在mybatis的配置文件的plugins节点下加入如下配置：

      <!-- com.github.pagehelper为PageHelper类所在包名 -->
        <plugin interceptor="com.github.pagehelper.PageHelper">
            <!-- 4.0.0以后版本可以不设置该参数 -->
            <property name="dialect" value="mysql"/>
            <!-- 该参数默认为false -->
            <!-- 设置为true时，会将RowBounds第一个参数offset当成pageNum页码使用 -->
            <!-- 和startPage中的pageNum效果一样-->
            <property name="offsetAsPageNum" value="true"/>
            <!-- 该参数默认为false -->
            <!-- 设置为true时，使用RowBounds分页会进行count查询 -->
            <property name="rowBoundsWithCount" value="true"/>
            <!-- 设置为true时，如果pageSize=0或者RowBounds.limit = 0就会查询出全部的结果 -->
            <!-- （相当于没有执行分页查询，但是返回结果仍然是Page类型）-->
            <property name="pageSizeZero" value="true"/>
            <!-- 3.3.0版本可用 - 分页参数合理化，默认false禁用 -->
            <!-- 启用合理化时，如果pageNum<1会查询第一页，如果pageNum>pages会查询最后一页 -->
            <!-- 禁用合理化时，如果pageNum<1或pageNum>pages会返回空数据 -->
            <property name="reasonable" value="false"/>
            <!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 -->
            <!-- 增加了一个`params`参数来配置参数映射，用于从Map或ServletRequest中取值 -->
            <!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,orderBy,不配置映射的用默认值 -->
            <!-- 不理解该含义的前提下，不要随便复制该配置 -->
            <!--<property name="params" value="pageNum=pageHelperStart;pageSize=pageHelperRows;"/>-->
            <!-- 支持通过Mapper接口参数来传递分页参数 -->
            <property name="supportMethodsArguments" value="false"/>
            <!-- always总是返回PageInfo类型,check检查返回类型是否为PageInfo,none返回Page -->
            <property name="returnPageInfo" value="none"/>
        </plugin>

使用方式

下边是一种使用示例，其他使用方式参考源码文档，其基本原理是在通过硬编码在ThreadLocal加入分页信息，之后根据存储的ThreadLocal信息构建分页sql。

PageHelper.startPage(pageNum,pageSize);
List<SomeModel> list=dao.query();
PageInfo<SomeModel> page=new PageInfo<Goods>(list);

总结

本篇设涉及到的几种技术、工具为项目优化的一部分，有的确实必要引入，有的是为了偷懒加入的。有点意思，本篇只是蜻蜓点水似的做使用记录，接下来会记录一些详细的使用与研究心得。