SpringMVC注解全攻略之从请求到响应的过程详解_Java

咱们学习spring mvc,就是学习spring mvc的各种注解。使用重点也就是学习如何通过浏览器和用户程序进行交互. 主要分以下三个方面:

1. 建立连接：将用户（浏览器）和java程序连接起来，也就是访问⼀个地址能够调⽤到我们的spring程序。

2. 请求:用户请求的时候会带⼀些参数，在程序中要想办法获取到参数,所以请求这块主要是获取参数的功能。

3. 响应:执行了业务逻辑之后，要把程序执行的结果返回给用户,也就是响应.

spring mvc注解

一. 建立连接

1.1 @requestmapping

@requestmapping：url路由映射

路径映射（path mapping）就是把浏览器访问的 url 地址，和后端代码里处理请求的方法（controller 方法）对应起来的规则。

资源路径：类路径+方法路径（如果一个方法路径它有类路径就必须加上）

注意：@requestmapping括号中的 / 可加可不加

@requestmapping既是类注解（对应类路径）也是方法注解（对应方法路径）（既可以加在类上也可以加在方法上）

@request mapping对于请求方法来说，默认既支持get也支持post方法（通过浏览器发起的请求都是默认get请求，并且请求方式是由客户端决定，服务端进行支持的

如何让它只支持某一种请求：

@requestmapping(value = "/hello",method = requestmethod.get)

当只支持这一种请求方法时，用另一种请求就会请求失败

也可以加更多的请求方式：

如：

 @requestmapping(value = "/hello",method = {requestmethod.get,requestmethod.post,requestmethod.delete})

还可以用其它的注解来指定请求方式（这里只写一部分，其它的类似）：

@getmapping（）：仅支持get请求
@postmapping（）：仅支持post请求
@deletemapping（）：仅支持delete请求

注意：

@getmapping（“/hello”）=@requestmapping(value = "/hello",method = requestmethod.get)
如果类注解有method规定请求方法，而方法注解没有--则“继承类”的。如果方法注解有加，则支持方法自己的

其余类似

1.2 @restcontroller

@restcontroller是类注解

在上面这个代码中@restcontroller的主要作用：告诉spring，这个类中有处理http请求的能力（有处理http请求的接口类），请求来了就到我这里来查-----相当于spring的查找范围（没有就不会查）

二. 请求

访问不同的路径,就是发送不同的请求.在发送请求时,可能会带⼀些参数,所以学习spring的请求,主要是学习如何传递参数到后端以及后端如何接收. 传递参数,咱们主要是使⽤浏览器和postman来模拟.

2.1 传递单个参数

当参数为boolean类型时，可以传1/0也可以传true/false（springmvc会帮我们转换），其余的数字不可以

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/r1")
    public  string r1(boolean flag) {
         return "接收到参数:"+flag;
    }
}

参数重命名：使用@requestparam注解（使用了@requestparam注解的参数默认为必传参数-------如何修改--@requestparam（value="number",required=false）即可）

实际上：我们服务器在spring框架下接收到的数据都是string类型，它会根据你服务器方法实际要的数据类型进行转换（string类型转换成实际需要接收的参数类型，且转化成java基础数据类型是转换成功后直接赋值，而转化为对象时spring还会帮我们new对象）

注意：有的时候spring在进行转换时也会转换失败，如：

2.2 传递多个参数

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/r1")
    public  string r1(string name,integer num) {
         return "接收到参数:"+name+" "+num;
    }
}

在传递时顺序可以不保持一致，但是参数名要保持一致

在传递参数时：

多传参数---不会报错，多的会被忽略

少传参数---可能会报错---原因：未传的参数spring就会设为null，如果方法参数为基本数据类型（如 int，double，boolean等）就不能接收，就会报错。如果是其它的参数就不会报错（可以被赋值为null）

2.3 传递对象

package com.example.demo;
import org.springframework.web.bind.annotation.*;
class person{
    string name;
    int num;
    public string getname() {
        return name;
    }
    public void setname(string name) {
        this.name = name;
    }
    public int getnum() {
        return num;
    }
    public void setnum(int num) {
        this.num = num;
    }
    @override
    public string tostring() {
        return "person{" +
                "name='" + name + '\'' +
                ", num=" + num +
                '}';
    }
}
@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/r1")
    public  string r1(person person) {
         return person.tostring();
    }
}

在spring代码中定义的类必须要有一个无参的构造方法和setter/getter，不然会报错

为什么必须要 setter？
spring 底层是这么干的：

// 1. 调用无参构造
user user = new user();

// 2. 赋值！必须靠 set 方法！
user.setname("张三");
user.setage(20);
没有 setxxx()，spring 根本没法给对象赋值！

注意：

对于对象来说，不传参数给java基础类型的变量，不会报错---因为类中的变量都有对应的初始值（如int的初始值就是0）
在没加其它注解的情况下，对象的传参只能在url上（有一种注解可以使对象在body在进行传参，下面会讲到）

2.4 传递数组

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/r1")
    public  string r1(string[] arr) {
         return arrays.tostring(arr);
    }
}

传递数组有两种方法：

2.5 传递集合

传递集合必须要使用注解 @requestparam

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/r1")
    public  list<string> r1(@requestparam list<string> list) {
         return list;
    }
}

注意：注意：参数为数组/集合类时，对于客户端来说，传递参数时的格式都是一样的；但对于服务端来说，如果不加 @requestparam，spring 只能直接接收数组，集合必须加上这个注解才能正常接收。

2.6 传递json数据

json概念：

json（javascript object notation）
是一种轻量级、纯文本、跨语言的数据交换格式。
- 本质：字符串格式的结构化数据
- 作用：前后端、不同语言之间传递数据
- 特点：简单、易读、体积小、几乎所有语言都支持，且空行与换行无效

json 语法：
1. 对象用 { } ，键值对结构（其中key对应于一个对象中的一个属性，value则对应属性的值）
2. 键必须用双引号 "key" （不能单引号、不能省略）
3. 键值之间用冒号 :
4. 多组用逗号 , 分隔
5. 数组/集合用 [ ]
6. 值支持：
- 字符串（双引号）
- 数字
- 布尔 true / false
- null
- 对象 {}
- 数组/集合 []
7. 最后一个成员后面不能加逗号

下面就是一个json格式的数据：

{
 "squadname": "super hero squad",
 "hometown": "metro city",
 "formed": 2016,
 "secretbase": "super tower",
 "active": true,
 "members": [{
 "name": "molecule man",
 "age": 29,
 "secretidentity": "dan jukes",
 "powers": ["radiation resistance", "turning tiny", "radiation 
blast"]
 }, {
 "name": "madame uppercut",
 "age": 39,
 "secretidentity": "jane wilson",
 "powers": ["million tonne punch", "damage resistance", "superhuman 
reflexes"]
 }, {
 "name": "eternal flame",
 "age": 1000000,
 "secretidentity": "unknown",
 "powers": ["immortality", "heat immunity", "inferno", 
"teleportation", "interdimensional travel"]
 }]
}

json有两种格式：

对象格式：最外层用 { } 包裹键值对
数组格式：最外层用 [ ] 包裹对象/字符串/数字.....

可以使⽤在线json格式化⼯具来进行校验和书写:在线json校验格式化⼯具（https://www.bejson.com/）

json和java对象可以相互转换---转换工具：常见有三种：

1. gson 2.fastjson 3.jackson（由于jackson是spring框架本身引入的，下面就以jackson演示）

使用到objectmapper这个类

@springboottest
class demoapplicationtests {
	@test
	void contextloads() throws jsonprocessingexception {
		//对象转json
		objectmapper objectmapper = new objectmapper();
        person person=new person();
		person.setname("zhangsan");
		person.setnum(21);
       string json=objectmapper.writevalueasstring(person);
		system.out.println(json);
		//json转对象
		person p=objectmapper.readvalue(json, com.example.demo.person.class);
		system.out.println(p);
	}
}

注意：json 实际上就是一个具有特定格式的字符串，用来表示结构化数据。

我们在接收json对象时。有两种方式：

使用string来接收
使用自定义类来接收

这两种方式都要用到注解 @requestbody，由于我们把json数据都是放在body中的，@requestbody就是在告诉spring，参数在body中，如果不加@requestbody，spring只会在url中查找参数。

使用自定义类来接收：@requestbody还会自动将json数据转化为person对象

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/r1")
    public string r1(@requestbody person person) {
        return person.tostring();
    }
}

使用string来接收：@requestbody不会将json数据转化为person对象（如果想要这个sting数据转化为对象可以借助objectmapper这个类来实现）

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/r1")
    public string r1(@requestbody string json) throws jsonprocessingexception {
        //将拿到的json原始数据转化为对象
        objectmapper objectmapper=new objectmapper();
        person person=objectmapper.readvalue(json, com.example.demo.person.class);
        return person.tostring();
    }
}

2.7 获取url中的参数

使用@pathvariable注解：spring mvc 中用于从 url 路径中提取变量值的注解，它将 url 中的占位符参数绑定到控制器方法的形参上。

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/r1/{articleid}/{username}")
    public string r1(@pathvariable integer articleid,@pathvariable("username") string name){
        return "接收到参数"+" "+articleid+" "+name;
    }
}

注意:虽然 @pathvariable 本身不要求参数顺序，但路径变量的类型和位置必须严格对应。

2.8 上传文件

使用注解 @requestpart

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/r1")
    public string r1(@requestpart multipartfile file) throws ioexception {
        file.transferto(new file("d:\\新建文件夹\\"+file.getoriginalfilename()));//将文件拷贝到改路径下
        return file.getoriginalfilename();//返回文件名
    }
}

2.9 获取cookie

获取cookie有两种方法：

传统servl方式：

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/r1")
    public string r1(httpservletrequest request, httpservletresponse response) {
        cookie[] cookies = request.getcookies();//获取一个cookie数组
if(cookies!=null){
    for (cookie cookie : cookies) {
        if (cookie != null) {
            system.out.println(cookie.getname() + "=" + cookie.getvalue());//循环遍历打印每一个cookie键值对
        }
    }
}
        return "获取cookie成功";
    }
}

如果我们的请求没有cookie，我们可以手动设置cookie（cookie是可以伪造的）

注意：当一个 http 请求到达时，spring 会自动创建一个 httpservletrequest 对象，封装了本次请求的所有信息（如 url、请求头、参数、cookie 等）。

用注解获取cookie：（这个方法只能逐个获取单个cookie键值对，不能一下子获取所有cookie）

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/getcookie")
    public string getcookie(@cookievalue("name") string name) {
        return "获取cookie成功,name:"+name;
    }
}

注意：获取cookie的前提是要有cookie

2.10 获取session

在获取session之前要先获取session1对象然后再设置session才能获取得到

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/getsession")
    public string getsession(httpservletrequest request) {
        httpsession session=request.getsession();//拿到session对象后，我们才能往session中存数据
        session.setattribute("name","zhangsan");
        session.setattribute("age","22");
        return "设置session成功";//我们设置的session数据只是保存在服务器中，不会外传
    }
}

当客户端向服务器发送请求并且代码主动要session服务器才会第一次创建session对象

每创建一个 session 对象，服务器都会通过响应发送一个 sessionid 给客户端。

request.getsession() : 如果客户端发送的请求中带有一个有效的sessionid，服务器就会依据这个sessionid找到对应的session对象并返回。如果没有sessionid/没有找到sessionid对应的session对象，服务器就会创建出一个新的session对象，并且返回客户端一个sessionid。

总之：每一个客户端对应的session对象是不同的，通过session对象对应的sessionid来识别

注意：

session默认存储在内存中，服务器重启后session会丢失
服务器可以存放并生成多个session对象
如果我们将自己的携带的sessionid改为其它的sessionid（cookie是可以伪造的）---身份改变

获取session有三种方式（如果没有session，都要先设置session信息*）：

法一：

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/setsession")//设置session
    public string setsession(httpservletrequest request,string name) {
        httpsession session=request.getsession();
        session.setattribute("name",name);
        return "设置session成功";
    }
    @requestmapping("/getsession1")//获取session
    public string getsession(httpservletrequest request) {
        httpsession session=request.getsession();//先获取session对象再获取其参数
        return "获取session成功"+"name: "+session.getattribute("name");
    }
}

法二：（spring获取session的方式）：通过@sessionattribute注解

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/setsession")//设置session
    public string setsession(httpservletrequest request,string name) {
        httpsession session=request.getsession();
        session.setattribute("name",name);
        return "设置session成功";
    }
   @requestmapping("/getsession2")//获取session
    public string getsession(@sessionattribute("name") string name) {
        return "获取session成功"+"name: "+name;
    }
}

法三：

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/setsession")
    public string setsession(httpservletrequest request,string name) {
        httpsession session=request.getsession();
        session.setattribute("name",name);
        return "设置session成功";
    }
    @requestmapping("/getsession3")
    public string getsession(httpsession session) {
        return "获取session成功"+"name: "+session.getattribute("name");
    }
}

2.11 获取header

获取header有两种方式

法一:

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/getheader")
    public string getsession(httpservletrequest request) {
       string user_agent=request.getheader("user-agent");
        return "获取header成功：user-agent= "+user_agent;
    }
}

通过查看fiddler判断获取到的数据是否正确

法二：使用 @requestheader 注解

@restcontroller
@requestmapping("/r")
public class test {
    @requestmapping("/getheader")
    public string getsession(@requestheader("user-agent") string user_agent) {
        return "获取header成功：user-agent= "+user_agent;
    }
}

三. 响应

3.1 返回静态页面

使用 @controller 注解（标明我们返回的是一个视图）

- @restcontroller ：类级别注解，所有方法默认返回数据，不返回视图。

（@restcontroller =@controller+@responsebody）
- @controller ：类级别注解，方法默认返回视图，如需返回数据需添加 @responsebody 。
- @responsebody ：方法级别注解，使单个方法直接返回数据，不返回视图。

@controller
@requestmapping("/r")
public class test {
    @requestmapping("/html")
    public string getsession() {
        return "/aaa.html"; //注意前面要加 /
    }
}

注意我们要把要返回的静态页面放在静态资源下面的文件中

3.2 返回html代码片段

后端返回数据（不是视图）时,如果数据中有html代码,也会被浏览器解析。

@controller
@requestmapping("/r")
public class test {
    @requestmapping("/html")
    @responsebody
    public string getsession() {
        return "<h1> html</h1>";
    }
}

3.3 返回json

当我们返回的数据是对象/map/list等，spring会自动将响应头中的content-type设置为application/json，并返回json数据

返回对象：

@controller
@requestmapping("/r")
public class test {
    @requestmapping("/returnjson")
    @responsebody
    public person returnjson() {
     person person=new person();
     person.setnum(21);
     person.setname("zhangsan");
        return person;
    }
}

返回map：

@controller
@requestmapping("/r")
public class test {
    @requestmapping("/returnjson")
    @responsebody
    public map<string,string> returnjson() {
    map<string,string> map=new hashmap<>();
    map.put("old","29");
    map.put("name","zhangsan");
     return map;
    }
}

3.4 设置状态码

@controller
@requestmapping("/r")
public class test {
    @requestmapping("/setstatus")
    @responsebody
    public string setstatus(httpservletresponse response) {
        response.setstatus(400);
        return "设置状态码成功";
    }
}

3.5 设置 header

http响应报头也会向客⼾端传递⼀些附加信息,⽐如服务程序的名称,请求的资源已移动到新地址等,如: content-type,local等. 这些信息通过 @requestmapping 注解的属性来实现先来看 @requestmapping 的源码:

1.value:指定映射的url

2. method：指定请求的method类型,如get,post等

3. consumes:指定处理请求(request)的提交内容类型(content-type)，例如application/json, text/html;

4. produces:指定返回的内容类型，还可以同时设置返回值的字符编码

5. params:指定request中必须包含某些参数值时，才让该⽅法处理

6. headers:指定request中必须包含某些指定的header值，才能让该⽅法处理请求

设置 content-type：

设置content-type：通过@requestmapping的produces属性设置

@controller
@requestmapping("/r")
public class test {
    @requestmapping(value = "/setcontenttype",produces = "application/json")
    @responsebody
    public string setstatus(httpservletresponse response) {
        return "{\"name\":\"zhangsan \"}";
    }
}

如果不手动设置content-type，spring会根据方法的返回参数自动设置，返回类型为spring---设置为text/plain（返回类型是对象/map等---设置为application/json）

@controller
@requestmapping("/r")
public class test {
    @requestmapping(value = "/setcontenttype")
    @responsebody
    public string setstatus(httpservletresponse response) {
        return "{\"name\":\"zhangsan \"}";
    }
}

设置其它header

@controller
@requestmapping("/r")
public class test {
    @requestmapping(value = "/setheader")
    @responsebody
    public string setheader(httpservletresponse response) {
       response.setheader("myheader","header");
       return "设置header成功";
    }
}