SpringMVC注解式开发

1.1 @Controller

​ 传统的配置式开发中的控制器Controller类必须实现Controller接口，并实现接口中的HandleRequest()方法，还需要再配置文件中配置处理器映射，且一个处理器（控制器）只能有一个方法，为了实现程序功能，不得不创建大量的处理器（控制器）类，不够方便灵活。

​ 而，注解开发中，将一个普通的类转化为控制器类只需要在该类的声明上添加@Controller注解即可。一个基于注解的控制器可以有多个方法，能大大减少处理器（控制器）类的数量。

​ 要使注解被扫描到，必须在springmvc.xml中配置组件扫描器，代码如下：

<context:component-scan base-package="com.deepfal.controller" />

1.2 @RequestMapping定义请求规则

​ 基于注解的控制器无须在xml配置文件中配置处理器映射器，仅需要用@RequestMapping对应控制器类中任意一个方法进行注解即可建立“请求/响应”映射关系，将客户端请求与处理器的方法一一对应。

​ 通过@RequestMapping 注解可以定义处理器对于请求的映射规则。该注解可以注解在方法上，也可以注解在类上，但意义是不同的。value 属性值常以“/”开始。@RequestMapping 的 value 属性用于定义所匹配请求的 URI。

1.2.1 指定模块名称

​ 一个@Controller 所注解的类中，可以定义多个处理器方法。当然，不同的处理器方法所匹配的 URI 是不同的。这些不同的 URI 被指定在注解于方法之上的@RequestMapping 的value 属性中。但若这些请求具有相同的 URI 部分，则这些相同的 URI部分可以被抽取到注解在类之上的@RequestMapping 的 value 属性中。此时的这个 URI 表示模块（相当于包）的名称。URI 的请求是相对于 Web 的根目录。换个角度说，要访问处理器的指定方法，必须要在方法指定 URI 之前加上处理器类前定义的模块名称。

示例：

image-20230809190109518

提取后

@Controller
@RequestMapping("/zar")
public class HelloSpringMvc {
    //相当于一个控制器处理的方法
    @RequestMapping("/hello")
    public String one() {
        return "main";
    }
    @RequestMapping("/two")
    public String two() {
        return "main";
    }
//客户端的请求：
// <form action="${pageContext.request.contextPath}/zar/hello.action">
    // <form action="${pageContext.request.contextPath}/zar/two.action">
}

1.2.2 对请求提交方式的定义

​ 对于@RequestMapping，其有一个属性 method，用于对被注解方法所处理请求的提交方式进行限制，即只有满足该 method 属性指定的提交方式的请求，才会执行该被注解方法。Method 属性的取值为 RequestMethod 枚举常量。常用的为 RequestMethod.GET 与RequestMethod.POST，分别表示提交方式的匹配规则为 GET 与 POST 提交。

@RequestMapping(value = "/hello",method = RequestMethod.POST)
public String one() {
    return "main";
}

以上处理器方法只能处理 POST 方式提交的请求。

客户端浏览器常用的请求方式，及其提交方式有以下几种：

image-20230809191023348

也就是说，只要指定了处理器方法匹配的请求提交方式为 POST，则相当于指定了请求发送的方式：要么使用表单请求，要么使用 AJAX 请求。其它请求方式被禁用。

当然，若不指定 method 属性，则无论是 GET 还是 POST 提交方式，均可匹配。即对于请求的提交方式无要求。

（1）post提交方式

image-20230809191042859

（2）get提交方式

image-20230809191116363

1.3 数据提交的方式

前四种数据注入的方式，会自动进行类型转换。但无法自动转换日期类型。

（1）单个数据（基本数据类型）注入

在方法中声明一个和表单提交的参数名称相同的参数，由框架按照名称直接注入。

image-20230810074040690

（2）对象封装注入

在方法中声明一个自定义的实体类参数，框架调用实体类中相应的setter方法注入属性值，只要保证实体类中成员变量的名称与提交请求的name属性值一致即可。

image-20230810074110392

  • 实体Bean含对象属性

比如：Student对象，其中有一个Address的对象属性，在Address对象中有country和city两个基本类型的属性。

    <form action="${pageContext.request.contextPath}/objectParam" method="post">
        <fieldset>
            <legend>对象数据提交</legend>
            姓名：<input type="text" name="stuname" /> <br />
            年龄：<input type="text" name="stuage" /> <br />
            国家：<input type="text" name="address.country" /> <br />
            城市：<input type="text" name="address.city" /> <br />
            <input type="submit" value="提交">
        </fieldset>
    </form>

（3）动态占位符提交/路径变量（仅用于超链接）

​ 使用框架提供的一个注解@PathVariable，将请求url中的值作为参数进行提取，只能是超链接。restful风格下的数据提取方式。restful是一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。

image-20230810074125186

​ RESTful风格是把请求参数变为请求路径的一种编程风格。通过路径变量的使用，可以实现RESTful风格的编程。

​

中文乱码：

​ 由于tomcat默认使用ISO-8859-1对接收的文本编码，因此要获得正确中文有两种解决方式：

  1. 自己转码

使用如下转码方式。先把name以ISO-8859-1再编码，还原成字节数组，再用UTF-8进行解码，即可获得正确中文。

String newName=new String(name.getBytes("ISO-8859-1"),"UTF-8");
  1. 修改tomcat | conf | server.xml

在server.xml的Connect中添加URIEncoding="utf-8"，这样默认就是用utf-8解码了，参数绑定中文也可以正确显示：

<Connector port="8080" protocol="HTTP/1.1"
           connectionTimeout="20000"
           redirectPort="8443" URIEncoding="utf-8"/>

对于maven中的tomcat插件，需要添加如下配置：

<plugin>
    <groupId>org.apache.tomcat.maven</groupId>
    <artifactId>tomcat7-maven-plugin</artifactId>
    <version>2.2</version>
    <configuration>
        <!--修改tomcat的URIEncoding-->
        <uriEncoding>UTF-8</uriEncoding> 
    </configuration>
</plugin>

另，web.xml配置的filter只对post请求有效,因此对此问题不是解决之道。

（4）请求参数名称与形参名称不一致

请求与形参中的名字不对应，可以使用

@RequestParam(value="name1",required=true) String namea来进行参数名称绑定。

image-20230810074136716

（5）数组类型的请求参数

@RequestMapping("/arrayParam")
public String arrayParam(String[] hobby){
    System.out.println("我的爱好：");
    for(String s:hobby){
        System.out.println(s);
    }
    return "main";
}

（6）使用HttpServletRequest对象提取

在方法参数中声明一个request对象，使用request的getParameter()获取表单提交的数据，这样得到的数据还要手工进行数据类型的转换。

public String five(HttpServletRequest request){
    int age=new Integer(request.getParameter("stuage"));
    String name=request.getParameter("stuname");
    System.out.println(age+"*********"+name);
    return "main";
}

1.4 请求参数中文乱码解决

​ 对于前面所接收的请求参数，若含有中文，则会出现中文乱码问题。Spring 对于请求参数中的中文乱码问题，给出了专门的字符集过滤器： spring-web-5.2.5.RELEASE.jar 的org.springframework.web.filter 包下的 CharacterEncodingFilter 类。

image-20230810074224631

（1）解决方案

​ 在 web.xml 中注册字符集过滤器，即可解决 Spring 的请求参数的中文乱码问题。不过，最好将该过滤器注册在其它过滤器之前。因为过滤器的执行是按照其注册顺序进行的。

image-20230810074239488

（2）源码分析

image-20230810074252361

1.5 处理器方法的返回值

使用@Controller 注解的处理器的方法，其返回值常用的有四种类型：

Ø 第一种：ModelAndView

Ø 第二种：String

Ø 第三种：无返回值void

Ø 第四种：返回对象类型

1.4.1 返回 ModelAndView

​ 若处理器方法处理完后，需要跳转到其它资源，且又要在跳转的资源间传递数据，此时处理器方法返回 ModelAndView 比较好。当然，若要返回 ModelAndView，则处理器方法中需要定义 ModelAndView 对象。在使用时，若该处理器方法只是进行跳转而不传递数据，或只是传递数据而并不向任何资源跳转（如对页面的 Ajax 异步响应），此时若返回 ModelAndView，则将总是有一部分多余：要么 Model 多余，要么 View 多余。即此时返回 ModelAndView 将不合适。较少使用。

1.4.2 返回 String

​ 处理器方法返回的字符串可以指定逻辑视图名，通过视图解析器解析可以将其转换为物理视图地址。

image-20230810074354609

image-20230810074405606

当然，也可以直接返回资源的物理视图名。不过，此时就不需要再在视图解析器中再配置前辍与后辍了。

image-20230810074419525

​ 使用ModelAndView对象作为控制器方法的返回值类型，可以很好地同时解决跳转路径和携带数据的问题，但String作为控制器方法的返回值类型只解决了跳转路径问题，如果跳转到目标页面同时还需要携带数据怎么办呢？有3个解决方案：

  1. 使用方法中的Model参数
  2. 使用方法中的HttpServletRequest对象
  3. 使用方法中的HttpSession对象

1.4.3 无返回值void

​ 对于处理器方法返回 void 的应用场景，应用在AJAX 响应处理。若处理器对请求处理后，无需跳转到其它任何资源，此时可以让处理器方法返回 void。我们SSM整合案例中的分页使用的就是无返回值。代码见后面。

通过jackson-databind把对象转换为json字符串。

1.4.4 返回对象Object

​ 处理器方法也可以返回 Object 对象。这个 Object 可以是 Integer，自定义对象，Map，List 等。但返回的对象不是作为逻辑视图出现的，而是作为直接在页面显示的数据出现的。返回对象，需要使用@ResponseBody 注解，将转换后的 JSON 数据放入到响应体中。Ajax请求多用于Object返回值类型。由于转换器底层使用了Jackson 转换方式将对象转换为JSON 数据，所以需要添加Jackson的相关依赖。

项目案例:使用ajax请求返回一个JSON结构的学生.

实现步骤:

A.在pom.xml文件中添加依赖

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId
    <version>2.9.8</version>
</dependency>

B.在页面添加jQuery的函数库的引用

<head>
<script src="https://cdn.staticfile.org/jquery/1.10.2/jquery.min.js" >
</script>
</head>

C.发送ajax请求

function show() {
    $.ajax({
        url:"${pageContext.request.contextPath}/ajax",
        type:"post",
        dataType:"json",
        success:function (stu) {
            $("#oneStu").html(stu.name+"------"+stu.age);
        }
    });
}

D.开发action

 @Controller
 public class AjaxDemo {
     @RequestMapping("/ajax")
     @ResponseBody  //此注解用来解析ajax请求
     public Object ajax(){
         Student stu = new Student("张三",22);
         return stu;
     }
 }

E.在springmvc.xml文件中添加注解驱动

  <mvc:annotation-driven />

F.index.jsp页面

  <a href="javascript:show()">ajax访问服务器,返回一个学生</a>
  <br>
  <div id="oneStu"></div>

Ajax/JSON专项突破：

  1. 服务端接收对象返回 JSON 字符串 objectMapper.writeValueAsString(user);

  2. 服务端接收Bean返回 JSON 对象 @ResponseBody

  3. 服务端接收属性返回 JSON 对象

  4. 客户端发送 JSON 字符串返回 JSON 字符串

  5. 数据接收与返回的限制 @RequestMapping(consumes="application/json",produces="application/json")

    consumes限制前台传递过来的数据格式必须是JSON

    produces设置返回的数据要转成JSON对象并回传给客户端

  6. 直接输出响应字符串

前端JSON字符串和对象的相互转换：

//1.用于将服务端传回来的JSON字符串解释转化为JSON对象

var jsonobject = JSON.parse(data);

//2.JSON对象转化为字符串

var jsonObj = {username:"张三",password:"123"};//定义一个JSON对象

var jsonStr = JSON.stringify(jsonObj);

1.6 SpringMVC的四种跳转方式

​ 默认的跳转是请求转发，直接跳转到jsp页面展示，还可以使用框架提供的关键字redirect:，进行一个重定向操作，包括重定向页面和重定向action，使用框架提供的关键字forward:，进行服务器内部转发操作，包括转发页面和转发action。当使用redirect:和forward:关键字时，视图解析器中前缀后缀的拼接就无效了。

页面部分：

<!--ctrl+d:复制当前行-->
<a href="${pageContext.request.contextPath}/one.action">请求转发页面(默认)</a><br>
<a href="${pageContext.request.contextPath}/two.action">请求转发action</a><br>
<a href="${pageContext.request.contextPath}/three.action">重定向页面</a><br>
<a href="${pageContext.request.contextPath}/four.action">重定向action</a><br>

Controller部分：

@Controller
public class JumpAction {
    @RequestMapping("/one")
    public String one(){
        System.out.println("请求转发页面(默认)");
        //以前的访问方式
        //request.getRequestDispatcher("/admin/main.jsp").forward(request,response);
        //观察地址栏的变化:  http://localhost:8080/one.action
        //return "main"; //默认的访问方式是自动拼接前缀和后缀进行跳转
        return "forward:/fore/user.jsp";//只要使用了forward:就可以屏蔽前缀和后缀的拼接,自己手工构建返回的全部路径+.jsp
    }
    @RequestMapping("/two")
    public String two(){
        System.out.println("请求转发action");
        //观察地址栏的变化:  http://localhost:8080/two.action
        return "forward:/other.action";   //不使用forward:,就会是这样的路径  /admin/other.action/.jsp
    }
    @RequestMapping("/three")
    public String three(){
        System.out.println("重定向页面");
        //观察地址栏的变化  http://localhost:8080/admin/main.jsp
        return "redirect:/admin/main.jsp";//只要使用了redirect:就可以屏蔽前缀和后缀的拼接
    }
    @RequestMapping("/four")
    public String four(){
        System.out.println("重定向action");
        //观察地址栏的变化  http://localhost:8080/other.action
        return "redirect:/other.action";//只要使用了redirect:就可以屏蔽前缀和后缀的拼接
    }
}

1.7 SpringMVC支持的默认参数类型

这些类型只要写在方法参数中就可以使用了。

1）HttpServletRequest 对象

2）HttpServletResponse 对象

3）HttpSession 对象

4）Model/ModelMap 对象　

5）Map<String,Object>对象

示例：

@Controller
public class ParamAction {
    @RequestMapping("/param")
    public String param(HttpServletRequest request,
                        HttpServletResponse response,
                        HttpSession session,
                        Model model,
                        ModelMap modelMap,
                        Map map){
        //Map ,Model,ModelMap,request都使用请求作用域进行传值,
        //所以必须使用请求转发的方式进行跳转,否则丢失数据
        Student stu = new Student("张三",22);
        request.setAttribute("requestStu",stu);
        session.setAttribute("sessionStu",stu);
        modelMap.addAttribute("modelMapStu",stu);
        model.addAttribute("modelStu",stu);
        map.put("mapStu",stu);
        return "main"; //切记请求转发跳
       // return "redirect:/admin/main.jsp";//会丢失数据
    }
}

注意Model,Map,ModelMap都使用的是request请求作用域,意味着只能是请求转发后,页面才可以得到值。

1.8 日期处理

1.8.1 日期注入

日期类型不能自动注入到方法的参数中。需要单独做转换处理。使用@DateTimeFormat注解，需要在springmvc.xml文件中添加标签。

（1）在方法的参数上使用@DateTimeFormat注解

@RequestMapping("/submitone")
public String submitdateone(
@DateTimeFormat(pattern="yyyy-MM-dd")
        Date mydate){
    System.out.println(mydate);
    return "dateShow";
}

（2）在类的成员setXXX()方法上使用@DateTimeFormat注解

@DateTimeFormat(pattern="yyyy-MM-dd")
public void setDate(Date date) {
    this.date = date;
}

但这种解决方案要在每个使用日期类型的地方都去添加使用@DateTimeFormat注解，比较麻烦，我们可以使用@InitBinder注解来进行类中统一日期类型的处理。

（3）@InitBinder注解解决类中日期问题

@InitBinder
public void initBinder(WebDataBinder dataBinder) {
    SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd");
dataBinder.registerCustomEditor(Date.class, new CustomDateEditor(sf, true));
}

这样在类中出现的所有日期都可以进行转换了。

1.8.2 日期显示

（1）JSON中的日期显示

需要在类中的成员变量的getXXX方法上加注解.

@JsonFormat(pattern="yyyy-MM-dd HH:mm:ss")
public Date getDate() {
    return date;
}

（2）JSP页面的日期显示

需要使用国际化标签，先添加依赖

<dependency>
    <groupId>jstl</groupId>
    <artifactId>jstl</artifactId>
    <version>1.2</version>
</dependency>

导入国际化的标签库

<%@taglib prefix="fmt" uri="http://java.sun.com/jsp/jstl/fmt" %>

再使用标签显示日期

<div id="stulistgood">
    <c:forEach items="${list}" var="stu">
    <p>${stu.name}-------${stu.age}-------<fmt:formatDate value="${stu.date}" pattern="yyyy-MM-dd"></fmt:formatDate></p>
    </c:forEach>
</div>

1.9 < mvc:annotation-driven/>标签的使用

< mvc:annotation-driven/>会自动注册两个bean，分别为DefaultAnnotationHandlerMapping和AnnotationMethodHandlerAdapter。是springmvc为@Controller分发请求所必须的。除了注册了这两个bean，还提供了很多支持。

1）支持使用ConversionService 实例对表单参数进行类型转换；

2）支持使用 @NumberFormat 、@DateTimeFormat；

3）注解完成数据类型的格式化；

4）支持使用 @RequestBody 和 @ResponseBody 注解；

5）静态资源的分流也使用这个标签;

1.10 资源在WEB-INF目录下

​ 很多企业会将动态资源放在WEB-INF目录下，这样可以保证资源的安全性。在WEB-INF目录下的动态资源不可以直接访问，必须要通过请求转发的方式进行访问。这样避免了通过地址栏直接对资源的访问。重定向也无法访问动态资源。

项目案例：

页面结构图：

image-20230811083945670

action:

@Controller
public class ShowAction {
    @RequestMapping("/showIndex")
    public String showIndex(){
        System.out.println("index.............");
        return "index";
    }
    @RequestMapping("/showMain")
    public String showMain(){
        System.out.println("main.............");
        return "main";
    }
    @RequestMapping("/showLogin")
    public String showLogin(){
        System.out.println("login.............");
        return "login";
    }
    @RequestMapping("/login")
    public String login(String name, String pwd, HttpServletRequest request){
        if("admin".equals(name) && "123".equals(pwd)){
            return "main";
        }
        request.setAttribute("msg","用户名或密码不正确!");
        return "login";
    }
}

运行结果：

image-20230811084015397

版权属于：DeepFal

本文链接：https://blog.deepfal.cn/index.php/archives/941/

转载时须注明出处及本声明

最后修改：2023 年 08 月 18 日
© 允许规范转载
如果觉得我的文章对你有用，请随意赞赏~