Web后端-请求响应-二、响应

2024-04-24 14:40:59

（1）@ResponseBody

类型：方法注解、类注解
位置：Controller方法上/类上
作用：将方法返回值直接响应，如果返回值类型是实体对象/集合，将会转换为JSON格式响应
说明：@RequestController+@RequestBody

（2）统一响应结果

在pojo目录下新增类Result，代码如下

package com.itheima.pojo;

/**
 * 统一响应结果封装类
 */
public class Result {
    private Integer code ;//1 成功 , 0 失败
    private String msg; //提示信息
    private Object data; //数据 data

    public Result() {
    }
    public Result(Integer code, String msg, Object data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    public Object getData() {
        return data;
    }
    public void setData(Object data) {
        this.data = data;
    }

    public static Result success(Object data){
        return new Result(1, "success", data);
    }
    public static Result success(){
        return new Result(1, "success", null);
    }
    public static Result error(String msg){
        return new Result(0, msg, null);
    }

    @Override
    public String toString() {
        return "Result{" +
                "code=" + code +
                ", msg='" + msg + '\'' +
                ", data=" + data +
                '}';
    }
}

之后所有的方法都返回Result类型的数据，新建TestController类代码如下

package com.itheima.conttoller;

import com.itheima.pojo.Address;
import com.itheima.pojo.Result;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

@RestController
public class TestController {
    @RequestMapping("/helloworld")
    public Result hello() {
        System.out.println("Hello world~");
        return Result.success("OK");
    }

    @RequestMapping("/getAddr")
    public Result getAddr() {
        Address addr = new Address();
        addr.setProvince("广东");
        addr.setCity("深圳");
        return Result.success(addr);
    }

    @RequestMapping("/listAddr")
    public Result listAddr() {
        List<Address> list = new ArrayList<>();
        Address addr = new Address();
        addr.setProvince("广东");
        addr.setCity("深圳");

        Address addr1 = new Address();
        addr1.setProvince("陕西");
        addr1.setCity("西安");

        list.add(addr);
        list.add(addr);
        return Result.success(list);

    }

}

在postman中配置测试

（3）案例

获取员工数据，返回统一响应结果，在页面渲染展示

加载并解析emp.xml文件中的数据，完成数据处理，并在页面展示
步骤（操作在详解中解释）
- 在pom.xml文件中引入dom4j的依赖，用于解析xml文件
- 引入解析XML的工具类XMLParserUtils、对应的实体类Emp、XML文件emp.xml
- 引入静态页面文件，放在resources下的static目录下
- 编写Controller程序，处理请求，响应数据

案例详解

在pom.xml文件中引入dom4j的依赖，用于解析xml文件。

dom4j的坐标

<!-- 解析XML -->
<dependency>
    <groupId>org.dom4j</groupId>
    <artifactId>dom4j</artifactId>
    <version>2.1.3</version>
</dependency>

2. 引入解析XML的工具类XMLParserUtils、对应的实体类Emp、XML文件emp.xml
（1）引入解析XML的工具类XMLParserUtils

XmlParserUtils的代码如下：

package com.itheima.utils;

import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import java.io.File;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;

public class XmlParserUtils {

    public static <T> List<T> parse(String file , Class<T> targetClass)  {
        ArrayList<T> list = new ArrayList<T>(); //封装解析出来的数据
        try {
            //1.获取一个解析器对象
            SAXReader saxReader = new SAXReader();
            //2.利用解析器把xml文件加载到内存中,并返回一个文档对象
            Document document = saxReader.read(new File(file));
            //3.获取到根标签
            Element rootElement = document.getRootElement();
            //4.通过根标签来获取 user 标签
            List<Element> elements = rootElement.elements("emp");

            //5.遍历集合,得到每一个 user 标签
            for (Element element : elements) {
                //获取 name 属性
                String name = element.element("name").getText();
                //获取 age 属性
                String age = element.element("age").getText();
                //获取 image 属性
                String image = element.element("image").getText();
                //获取 gender 属性
                String gender = element.element("gender").getText();
                //获取 job 属性
                String job = element.element("job").getText();

                //组装数据
                Constructor<T> constructor = targetClass.getDeclaredConstructor(String.class, Integer.class, String.class, String.class, String.class);
                constructor.setAccessible(true);
                T object = constructor.newInstance(name, Integer.parseInt(age), image, gender, job);

                list.add(object);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return list;
    }

}

（2）引入对应的实体类Emp

Emp类的代码如下

package com.itheima.pojo;

public class Emp {
    private String name;
    private Integer age;
    private String image;
    private String gender;
    private String job;

    public Emp() {
    }

    public Emp(String name, Integer age, String image, String gender, String job) {
        this.name = name;
        this.age = age;
        this.image = image;
        this.gender = gender;
        this.job = job;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public String getImage() {
        return image;
    }

    public void setImage(String image) {
        this.image = image;
    }

    public String getGender() {
        return gender;
    }

    public void setGender(String gender) {
        this.gender = gender;
    }

    public String getJob() {
        return job;
    }

    public void setJob(String job) {
        this.job = job;
    }

    @Override
    public String toString() {
        return "Emp{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", image='" + image + '\'' +
                ", gender='" + gender + '\'' +
                ", job='" + job + '\'' +
                '}';
    }
}

（3）引入XML文件emp.xml

将emp.xml文件放到resources目录下

emp.xml文件中的代码如下：

<?xml version="1.0" encoding="UTF-8" ?>
<emps>
    <emp>
        <name>金毛狮王</name>
        <age>55</age>
        <image>https://web-framework.oss-cn-hangzhou.aliyuncs.com/web/1.jpg</image>
        <!-- 1: 男, 2: 女 -->
        <gender>1</gender>
        <!-- 1: 讲师, 2: 班主任 , 3: 就业指导 -->
        <job>1</job>
    </emp>

    <emp>
        <name>白眉鹰王</name>
        <age>65</age>
        <image>https://web-framework.oss-cn-hangzhou.aliyuncs.com/web/2.jpg</image>
        <gender>1</gender>
        <job>1</job>
    </emp>

    <emp>
        <name>青翼蝠王</name>
        <age>45</age>
        <image>https://web-framework.oss-cn-hangzhou.aliyuncs.com/web/3.jpg</image>
        <gender>1</gender>
        <job>2</job>
    </emp>

    <emp>
        <name>紫衫龙王</name>
        <age>38</age>
        <image>https://web-framework.oss-cn-hangzhou.aliyuncs.com/web/4.jpg</image>
        <gender>2</gender>
        <job>3</job>
    </emp>
</emps>

引入静态页面文件，放在resources下的static目录下（前端静态页面存放在资料中）

Springboot项目的静态资源（html，css，js等前端资源）默认存放目录为：classpath://static、classpath://public、classpath://resources。其中的classpath指的就是resources文件夹
（1）另外，想要返回同意结果，还需要将Result.java放到pojo目录下

Result的代码文章上方有

编写Controller程序，处理请求，响应数据
（1）在controller目录下，新建类EmpController 用于加载员工数据

EmpController中的代码：

package com.itheima.controller;

import com.itheima.pojo.Emp;
import com.itheima.pojo.Result;
import com.itheima.utils.XmlParserUtils;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class EmpController {
    @RequestMapping("/listEmp")//路径，看前端页面emp.html中的钩子方法
    public Result list() {//前端页面emp.html的钩子方法没有返回数据，也就不需要有参数
        // 1、加载并解析xml文件
        // （1）获得xml文件地址
        String file = this.getClass().getClassLoader().getResource("emp.xml").getFile();
        System.out.println("emp.xml文件地址：" + file);
        // （2）使用之前引入的工具类XmlParserUtils解析xml文件
        List<Emp> empList = XmlParserUtils.parse(file, Emp.class);
        // 2、对数据进行转换（将1,2转换成男女等）
        for (Emp emp : empList) {
            // (1)处理gender- 1：男， 2：女
            String gender = emp.getGender();
            if ("1".equals(gender)) {
                emp.setGender("男");
            } else if ("2".equals(gender)) {
                emp.setGender("女");
            }
            // （2）处理job- 1：讲师， 2：班主任， 3：就业指导
            String job = emp.getJob();
            if ("1".equals(job)) {
                emp.setJob("讲师");
            } else if ("2".equals(job)) {
                emp.setJob("班主任");
            } else if ("3".equals(job)) {
                emp.setJob("就业指导");
            }
        }

        // 3、响应数据
        return Result.success(empList);
    }
}

结果
（1）postman响应结果

（2）浏览器访问前端页面结果:http://localhost:8080/emp.html

最终项目结构

码农公寓

（1）@ResponseBody

（2）统一响应结果

（3）案例

案例详解

相关文章