SpringBoot请求与响应实例全解析_Java

spring boot请求与响应

一、请求

1.简单参数

1.1请求参数名称与方法形参名称一致

@restcontroller
public class requestcontroller {
     @requestmapping("/easyparam")
    public string simpleparam(string name ,integer age){
        //获取请求参数
        return name+":::"+age;
    }
}

postman测试( get 请求)

postman测试( post请求 )

结论：不论是get请求还是post请求，对于简单参数来讲，只要保证请求参数名和controller方法中的形参名保持一致，就可以获取到请求参数中的数据值。

1.2请求参数名称与方法形参名称一致

@requestmapping("/simpleparam")
public string simpleparam(string username , integer age ){//请求参数名和形参名不相同
    return username+"  :  "+age;
}

结论：对于简单参数来讲，请求参数名和controller方法中的形参名不一致时，无法接收到请求数据。

解决方案：可以使用spring提供的@requestparam注解完成映射

    public string simpleparam(@requestparam("name") string username , integer age ){//请求参数名和形参名不相同
    return username+"  :  "+age;
}

如果该参数是可选的，可以将required属性设置为false

@requestmapping("/easyparam")
    public string simpleparam(@requestparam(value = "name",required = false) string username , integer age ){//请求参数名和形参名不相同
        return username+"  :  "+age;
    }

2.实体参数

请求参数封装到一个实体类对象中。请求参数名与实体类的属性名相同

2.1 简单实体对象

定义pojo实体类：

@data
@allargsconstructor
@noargsconstructor
public class student {
    private string name;
    private integer age;      
}

controller方法：

@requestmapping("/easypojo")
    public string simplepojo(student student){
        return "name = "+student.getname()+", age = "+student.getage()+";
    }

[说明]参数名和实体类属性名一致时,参数值才会传递，参数名和实体类属性名不一致时,不传递值2.2 复杂实体对象

复杂实体对象指的是，在实体类中有一个或多个属性，也是实体对象类型的。如下：

student类中有一个address类型的属性（address是一个实体类）

复杂实体对象的封装，需要遵守如下规则：

请求参数名与形参对象属性名相同，按照对象层次结构关系即可接收嵌套实体类属性参数。

定义pojo实体类：

address实体类

@data
@allargsconstructor
@noargsconstructor
public class address {
    private string province;
    private string city;
}

student实体类

@data
@allargsconstructor
@noargsconstructor
public class student {
private string name;
private integer age;
private address address;
}

controller方法：

@restcontroller
public class requestcontroller {
    //实体参数：复杂实体对象
    @requestmapping("/complexpojo")
    public string complexpojo(student student){
        return "name = "+student.getname()+
                ", age = "+student.getage()+
                ", job = "+student.getjob()+
        ", address.city = "+student.getaddress().getcity()+
        ", address.province = "+student.getaddress().getprovince();
    }
}

postman测试：

3.数组集合参数

数组集合参数的使用场景：在html的表单中，有一个表单项是支持多选的(复选框)，可以提交选择的多个值。

后端程序接收上述多个值的方式有两种：数组、集合 3.1 数组

数组参数：请求参数名与形参数组名称相同且请求参数为多个，定义数组类型形参即可接收参数

controller方法：

    //数组集合参数
    @requestmapping("/arrayparam")
    public string arrayparam(string[] course){
        system.out.println(arrays.tostring(course));
        return "课程: "+arrays.tostring(course);
    }

postman测试：

3.2 集合

默认情况下，请求中参数名相同的多个值，是封装到数组。如果要封装到集合，要使用@requestparam绑定参数关系

controller方法：

 //数组集合参数
    @requestmapping("/listparam")
    public string listparam(@requestparam list<string> course){
        return "课程: "+course;
    }

postman测试：

3日期参数

日期类型的参数在进行封装的时候，需要通过@datetimeformat注解，以及其pattern属性来设置日期的格式。

使用@datetimeformat注解设置日期类型数据格式，默认格式yyyy/mm/dd。

@datetimeformat注解的pattern属性中指定了哪种日期格式，前端的日期参数就必须按照指定的格式传递。后端controller方法中，需要使用date类型或localdatetime类型，来封装传递的参数。

controller方法：

//日期时间参数
    @requestmapping("/dataparam")
    public string dataparam(date date,
                            @datetimeformat(pattern="yyyy-mm-dd") date date1,
                            @datetimeformat(pattern="yyyy/mm/dd hh:mm:ss") date date2){
        system.out.println("参数传递 date ==> "+date);
        system.out.println("参数传递 date1(yyyy-mm-dd) ==> "+date1);
        system.out.println("参数传递 date2(yyyy/mm/dd hh:mm:ss) ==> "+date2);
        return "{'module':'data param'}";
    }

postman测试：

3.4 json参数前后端分离后，前端向后台会传递json格式数据,进行交互。 postman发送json格式数据：

服务端controller方法接收json格式数据：

传递json格式的参数，在controller中会使用实体类进行封装。封装规则：json数据键名与形参对象属性名相同，定义pojo类型形参即可接收参数。需要使用 @requestbody标识。 @requestbody注解：将json数据映射到形参的实体类对象中（json中的key和实体类中的属性名保持一致） controller方法：

//5. json参数
    @requestmapping("/jsonparam")
    public string jsonparam(@requestbody student student){
        return "name = "+student.getname()+
                ", age = "+student.getage()+               
                ", address.city = "+student.getaddress().getcity()+
                ", address.province = "+student.getaddress().getprovince();
    }

postman测试：

3.5路径参数传统的开发中请求参数是放在请求体(post请求)传递或跟在url后面通过?key=value的形式传递(get请求)。

在现在的开发中，经常还会直接在请求的url中传递参数。例如：

http://localhost:8080/path/1  
http://localhost:880/path/1/0

路径参数：

前端：通过请求url直接传递参数后端：使用{…}来标识该路径参数，需要使用@pathvariable获取路径参数

controller方法：

//路径参数
    @requestmapping("/path/{id}")
    public string pathparam(@pathvariable integer id){
        return "id = "+id;
    }

postman测试：

传递多个路径参数：

controller方法：

二、响应

2.1 @responsebody 前面所编写的controller方法中，都已经设置了响应数据。

思考：controller方法中的return的结果，怎么就可以响应给浏览器呢？

答案：使用@responsebody注解

@responsebody注解：

类型：方法注解、类注解位置：书写在controller方法上或类上作用：将方法返回值直接响应给浏览器如果返回值类型是实体对象/集合，将会转换为json格式后在响应给浏览器但是在controller中，只在类上添加了@restcontroller注解、方法添加了@requestmapping注解，并没有使用@responsebody注解，怎么给浏览器响应呢？

原因是在类上添加的@restcontroller注解，是一个组合注解。

@restcontroller = @controller + @responsebody 在类上添加@restcontroller就相当于添加了@responsebody注解。

类上有@restcontroller注解或@responsebody注解时：表示当前类下所有的方法返回值做为响应数据方法的返回值，如果是一个pojo对象或集合时，会先转换为json格式，在响应给浏览器。下面测试响应数据：

@restcontroller
public class responsecontroller {
@requestmapping("/study")
public string study(){
    return "根据springboot开发实战学习springboot";
}
//响应实体对象
@requestmapping("/getaddr")
public address getaddr(){
    address addr = new address();//创建实体类对象
    addr.setprovince("湖南");
    addr.setcity("衡阳");
    return addr;
}
//响应集合数据
@requestmapping("/listaddr")
public list<address> listaddr(){
    list<address> list = new arraylist<>();//集合对象
    address addr = new address();
    addr.setprovince("湖南");
    addr.setcity("衡阳");
    address addr2 = new address();
    addr2.setprovince("湖南");
    addr2.setcity("长沙");
    list.add(addr);
    list.add(addr2);
    return list;
}
}

postman测试：

2.2 统一响应结果开发项目中，controller方法会定义一个统一的返回结果。方案如下：

统一的返回结果使用类来描述，包含：

响应状态码：当前请求是成功，还是失败状态码信息：给页面的提示信息返回的数据：给前端响应的数据（字符串、对象、集合）定义在一个实体类result来统一响应结果，代码如下：

@data
@noargsconstructor
@allargsconstructor
public class result {
    private integer code;
    private string message;
    private object data;
    public static result success(object data) {
        return new result(200, "success", data);
    }
    public static result success() {
        return new result(200, "success", null);
    }
    public static result error(string message) {
        return new result(500, message, null);
    }
    public static result error(integer code, string message) {
        return new result(code, message, null);
    }
}

改造controller：

@restcontroller
public class studentcontroller {
    @requestmapping("/stu_study")
    public result study(){
        return result.success( "根据springboot开发实战学习springboot");
    }
    //响应实体对象
    @requestmapping("/stu_getaddr")
    public result getaddr(){
        address addr = new address();//创建实体类对象
        addr.setprovince("湖南");
        addr.setcity("衡阳");
        return result.success(addr);
    }
    //响应集合数据
    @requestmapping("/stu_listaddr")
    public result listaddr(){
        list<address> list = new arraylist<>();//集合对象
        address addr = new address();
        addr.setprovince("湖南");
        addr.setcity("衡阳");
        address addr2 = new address();
        addr2.setprovince("湖南");
        addr2.setcity("长沙");
        list.add(addr);
        list.add(addr2);
        return  result.success(list);
    }
}

使用postman测试：