Spring MVC核心技術

目錄

• 異常處理
• 類型轉換器
• 數據驗證
• 文件上傳與下載
• 攔截器

---

 異常處理

Spring MVC中, 系統的DAO, Service, Controller層出現異常, 均通過throw Exception向上拋出,

最后由中央處理器DispatchServlet交由全局異常處理器進行異常處理, 如下圖所示

常用的Spring MVC異常處理方式主要有三種:

• 使用系統定義好的異常處理器SimpleMappingExceptionResolver
• 使用自定義異常處理器
• 使用異常注解

SimpleMappingExceptionResolver

只需要在配置文件中注冊該異常處理器Bean即可, 無需顯式調用, 當異常發生時會自動執行該類.

    <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
        <property name="defaultErrorView" value="/errors/error.jsp"/>
    </bean>

(1) 聲明一個自定義的異常類

public class NameException extends Exception {

    public NameException() {
        super();
    }

    public NameException(String message) {
        super(message);
    }
    
}

(2) 注冊異常處理器

    <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
        <property name="defaultErrorView" value="/errors/error.jsp"/>
        <property name="exceptionAttribute" value="ex"/>
        <property name="exceptionMappings">
            <props>
                <prop key="com.test.exceptions.NameException">/errors/nameError.jsp</prop>
            </props>
        </property>
    </bean>

exceptionMapping: Properties類型屬性, 用於指定具體的不同類型異常對應的響應頁面.

defaultErrorView: 默認的異常響應頁面, 若發生的異常不是自定義的異常, 則使用默認響應頁面.

exceptionAttribute: 捕獲到的異常對象, 一般異常響應頁面中使用.

自定義異常處理器

SimpleMappingExceptionResolver可以在發生異常的時候進行頁面跳轉, 但是如果想要在捕獲到特定異常后, 

執行一些操作, 則需要自定義異常. 自定義異常處理器需要實現HandlerExceptionResolver接口, 並且該類

需要在配置文件中進行注冊.

(1) 定義異常處理器

當一個類實現了HandlerExceptionResolver接口后, 只要有異常發生, 都會執行resolveException方法.

public class MyHandlerExceptionResolver implements HandlerExceptionResolver {

    public ModelAndView resolveException(HttpServletRequest request,
            HttpServletResponse response, Object handler, Exception ex) {
        
        ModelAndView mv = new ModelAndView();
        mv.addObject("ex", ex);
        mv.setViewName("/errors/error.jsp");
        
        if(ex instanceof NameException) {
            // 執行一些操作
            mv.setViewName("/errors/nameError.jsp");
        }
        
        return mv;
    }

}

(2) 注冊異常處理器

    <!-- 注冊異常處理器 -->
    <bean class="com.test.resolvers.MyHandlerExceptionResolver"/>

異常處理注解

使用注解@ExceptionHandler可以將一個方法指定為異常處理方法, 該注解有一個可選屬性value,

可用於指定該注解方法所需要處理的異常類. 

定義一個頂層Controller, 處理所有異常, 其他Controller繼承該類即可實現異常集中管理.

@Controller    
public class BaseController {

    // 處理NameException異常
    @ExceptionHandler(NameException.class)
    public ModelAndView handlerNameException(Exception ex) {
        ModelAndView mv = new ModelAndView();
        mv.addObject("ex", ex);
        // 執行一些操作
        mv.setViewName("/errors/nameError.jsp");
        return mv;
    }

}

類型轉換器

可以將用戶web端提交的數據, 在后台轉為需要的數據類型.

自定義類型轉換器

若要定義類型轉換器, 則需要實現Converter接口, 該Convert接口有兩個泛型:

第一個為待轉換類型, 第二個為目標類型, 該接口方法convert用於實現轉換.

public class MyDateConverter implements Converter<String, Date> {

    public Date convert(String source) {
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
        try {
            return sdf.parse(source);
        } catch (ParseException e) {   
            e.printStackTrace();
        }
        return null;
    }

}

類型轉換器定義完畢后, 需要在配置文件中進行注冊, 然后注冊一個轉換服務Bean, 將轉換器注入給該Bean, 

最后由處理器適配器來使用該轉換服務器Bean. 該Bean由ConversionServiceFactory工廠創建, 工廠有Set集合屬性, 

可以提供多種轉換功能的Bean來處理多種數據類型轉換.

    <!-- 注冊類型轉換器 -->
    <bean id="myDateConverter" class="com.test.converters.MyDateConverter"/>
    
    <!-- 注冊轉換服務對象 -->
    <bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
        <property name="converters" ref="myDateConverter"/>
    </bean>
    
    <!-- 注冊mvc注解驅動 -->
    <mvc:annotation-driven conversion-service="conversionService"/>

數據驗證

主要是校驗客戶端發來的數據是否合法, 例如不能為空, 或者長度不符合等等. Spring MVC沒有校驗功能,

但是支持JSR303-Bean Validation, 可以用實現該規范的Hibernate Validator校驗框架.

(1) 配置驗證器

    <!-- 生成驗證器 -->
    <bean id="myValidator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
        <property name="providerClass" value="org.hibernate.validator.HibernateValidator"/>
    </bean>

(2) 在Bean上添加驗證注解

public class Student {
    
    @NotNull(message="姓名不能為空")
    @Size(min=3, max=6, message="姓名長度應在{min}-{max}個字符")
    private String name;
    
    @Min(value=0, message="成績不能小於{value}")
    @Max(value=100, message="成績不能大於{value}")
    private double score;
    
    
    @NotNull(message="電話不能為空")
    @Pattern(regexp="^1[34578]\\d{9}$", message="手機號格式不正確")
    private String mobile;

        ......
}

(3) 修改Controller

在需要校驗的參數前面加上@Validated注解, 同時追加一個BindingResult參數, 用於獲取驗證異常信息.

@Controller    
@RequestMapping("/test")    
public class MyController {

    @RequestMapping("/register.do")
    public ModelAndView doRegister(@Validated Student student, BindingResult br) {
        
        ModelAndView mv = new ModelAndView();
        mv.addObject("student", student);
        mv.setViewName("/WEB-INF/jsp/welcome.jsp");
        
        int errorCount = br.getErrorCount();
        if(errorCount > 0) {
            FieldError nameError = br.getFieldError("name");
            
            if (nameError != null) {
                String nameErrorMSG = nameError.getDefaultMessage();
                mv.addObject("nameErrorMSG", nameErrorMSG);
            }
            mv.setViewName("/index.jsp");
        }
        
        return mv;
    }
}

文件上傳與下載

上傳

Spring MVC中文件上傳需要添加Apache Commons FileUpload相關的jar包,

基於該jar, Spring中提供了MultipartResolver實現類: CommonsMultipartResolver.

注冊該Bean到配置文件中

   <bean id="multipartResolver"  
        class="org.springframework.web.multipart.commons.CommonsMultipartResolver">  
        <!-- 上傳文件大小上限，單位為字節（10MB） -->
        <property name="maxUploadSize">  
            <value>10485760</value>  
        </property>  
        <!-- 請求的編碼格式，必須和jSP的pageEncoding屬性一致，以便正確讀取表單的內容，默認為ISO-8859-1 -->
        <property name="defaultEncoding">
            <value>UTF-8</value>
        </property>
    </bean>

Spring MVC會將上傳的文件綁定到MultipartFile對象, 該對象提供獲取內容, 文件名等方法.

通過transferTo方法可以將文件存儲到磁盤.

     //上傳文件會自動綁定到MultipartFile中
     @RequestMapping(value="/upload",method=RequestMethod.POST)
     public String upload(HttpServletRequest request,
            @RequestParam("description") String description,
            @RequestParam("file") MultipartFile file) throws Exception {

        System.out.println(description);
        //如果文件不為空，寫入上傳路徑
        if(!file.isEmpty()) {
            //上傳文件路徑
            String path = request.getServletContext().getRealPath("/images/");
            //上傳文件名
            String filename = file.getOriginalFilename();
            File filepath = new File(path,filename);
            //判斷路徑是否存在，如果不存在就創建一個
            if (!filepath.getParentFile().exists()) { 
                filepath.getParentFile().mkdirs();
            }
            //將上傳文件保存到一個目標文件當中
            file.transferTo(new File(path + File.separator + filename));
            return "success";
        } else {
            return "error";
        }

     }

下載

下載比較簡單, Spring MVC中提供了ResponseEntity類型, 可以很方便的返回HTTPHeaders, HttpStatus.

     @RequestMapping(value="/download")
     public ResponseEntity<byte[]> download(HttpServletRequest request,
             @RequestParam("filename") String filename,
             Model model)throws Exception {
        //下載文件路徑
        String path = request.getServletContext().getRealPath("/images/");
        File file = new File(path + File.separator + filename);
        HttpHeaders headers = new HttpHeaders();  
        //下載顯示的文件名，解決中文名稱亂碼問題  
        String downloadFielName = new String(filename.getBytes("UTF-8"),"iso-8859-1");
        //通知瀏覽器以attachment（下載方式）打開圖片
        headers.setContentDispositionFormData("attachment", downloadFielName); 
        //application/octet-stream ： 二進制流數據（最常見的文件下載）。
        headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
        return new ResponseEntity<byte[]>(FileUtils.readFileToByteArray(file),    
                headers, HttpStatus.CREATED);  
     }

攔截器

攔截器注冊與使用

Spring MVC中攔截器需要實現HandlerInterceptor接口, 該接口包含三個方法

preHandle(req, res, handler)

在處理器方法之前執行, 返回boolean, 若為true, 則緊接着執行處理器方法, 且會將

afterCompletion()方法放入一個專門的方法棧中等待執行.

postHandler(req, res, handler, ModelAndView)

在處理器方法之后執行, 處理器方法若未執行, 則該方法不執行.

該方法可以修改處理器方法返回的結果, 並可以跳轉到其他頁面.

afterCompletion(req, res, handler, exception)

當preHandle返回ture后, 會將該方法放入等待區, 等所有請求響應結束, 執行該方法.

即中央處理器渲染了響應頁面之后執行, 此時對ModelAndView修改也不會影響到頁面結果.

public class OneInterceptor implements HandlerInterceptor {

    public boolean preHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler) throws Exception {
        System.out.println("執行OneIntercepor ---- preHandle() ------");
        return false;
    }

    public void postHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        System.out.println("執行OneIntercepor ---- postHandle() ------");
    }

    public void afterCompletion(HttpServletRequest request,
            HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        System.out.println("執行OneIntercepor ---- afterCompletion() ------");
    }

}

在配置文件中注冊

    <!-- 注冊攔截器 -->
    <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.test.interceptors.OneInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

 

<mvc:mapping/>用於指定當前攔截器攔截的請求路徑, /**表示攔截所有請求.

多個攔截器

當有多個攔截器時, 形成攔截器鏈, 攔截器鏈執行順序與注冊順序一致, 需要注意的是,

當一個攔截器preHandle()返回false時, 上部的攔截器鏈將被斷開, 后續的處理器以及對於的postHandle()

都無法執行, 只有已經執行通過的攔截器的afterCompletion()方法會執行.

實際運用

• 權限校驗: 判斷當前請求是否登陸, 若未登錄或者無權限, 返回對應的界面.
• 性能監控: 監控系統指定方法執行的時間, 尋找系統性能調優點.
• 日志打印: 記錄請求日志, 用於系統監控, 信息統計與分析等等.
• ......