后端接收响应+三层架构

发布时间:2024年01月24日

Controller程序,除了接收请求外,还可以进行响应

1.@ResponseBody

上篇所编写的controller方法中,都已经设置了响应数据

注:controller方法中的return的结果,使用@ResponseBody注解就可以响应给浏览器

接下来说@ResponseBody注解

@ResponseBody注解:? 一般增加? ?修改的第一部分 都用此注解!!!!!!

  • 类型:方法注解、类注解

  • 位置:在Controller方法上或类上

  • 作用:将方法返回值直接响应给浏览器

    • 如果返回值类型是实体对象/集合,将会转换为JSON格式后在响应给浏览器

但是在我们所书写的Controller中,只在类上添加了@RestController注解、方法添加了@RequestMapping注解,并没有使用@ResponseBody注解,怎么给浏览器响应呢?

@RestController
public class HelloController {
    @RequestMapping("/hello")
    public String hello(){
        System.out.println("Hello World ~");
        return "Hello World ~";
    }
}

原因:在类上添加的@RestController注解,是一个组合注解。

  • @RestController = @Controller + @ResponseBody

@RestController源码:

@Target({ElementType.TYPE})   //元注解(修饰注解的注解)
@Retention(RetentionPolicy.RUNTIME)  //元注解
@Documented    //元注解
@Controller   
@ResponseBody 
public @interface RestController {
    @AliasFor(
        annotation = Controller.class
    )
    String value() default "";
}

结论:在类上添加@RestController就相当于添加了@ResponseBody注解。

  • 类上有@RestController注解或@ResponseBody注解时:表示当前类下所有的方法返回值做为响应数据

    • 方法的返回值,如果是一个POJO对象或集合时,会先转换为JSON格式,在响应给浏览器

测试下响应数据:

@RestController
public class ResponseController {
    //响应字符串
    @RequestMapping("/hello")
    public String hello(){
        System.out.println("Hello World ~");
        return "Hello World ~";
    }
    //响应实体对象
    @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发送请求来测试下。测试效果如下

1.1统一响应结果

在前面所编写的这些Controller方法中,返回值各种各样,没有任何的规范。

前端:只需要按照统一格式的返回结果进行解析(仅一种解析方案),就可以拿到数据。

统一的返回结果使用类来描述,在这个结果中包含:

  • 响应状态码:当前请求是成功,还是失败

  • 状态码信息:给页面的提示信息

  • 返回的数据:给前端响应的数据(字符串、对象、集合)

定义在一个实体类Result来包含以上信息。代码如下:

public class Result {
    private Integer code;//响应码,1 代表成功; 0 代表失败
    private String msg;  //响应码 描述字符串
    private Object 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(){
        return new Result(1,"success",null);
    }
    //查询 成功响应(把查询结果做为返回数据响应给前端)
    public static Result success(Object data){
        return new Result(1,"success",data);
    }
    //失败响应
    public static Result error(String msg){
        return new Result(0,msg,null);
    }
}

改造Controller:

@RestController
public class ResponseController { 
    //响应统一格式的结果
    @RequestMapping("/hello")
    public Result hello(){
        System.out.println("Hello World ~");
        //return new Result(1,"success","Hello World ~");
        return Result.success("Hello World ~");
    }

    //响应统一格式的结果
    @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 addr2 = new Address();
        addr2.setProvince("陕西");
        addr2.setCity("西安");

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

使用Postman测试:

2.三层架构

在我们进行程序设计以及程序开发时,尽可能让每一个接口、类、方法的职责更单一些(单一职责原则)。

单一职责原则:一个类或一个方法,就只做一件事情,只管一块功能。

这样就可以让类、接口、方法的复杂度更低,可读性更强,扩展性更好,也更利用后期的维护。

开发的程序呢,并不满足单一职责原则。下面我们来分析下 下面的程序:

那其实上述的处理逻辑呢,从组成上看可以分为三个部分:

- 数据访问:负责业务数据的维护操作,包括增、删、改、查等操作。
- 逻辑处理:负责业务逻辑处理的代码。
- 请求处理、响应数据:负责,接收页面的请求,给页面响应数据。

按照上述的三个组成部分,在项目开发中,可以将代码分为三层:

  • Controller:控制层。接收前端发送的请求,对请求进行处理,并响应数据。

  • Service:业务逻辑层。处理具体的业务逻辑。

  • Dao:数据访问层(Data Access Object),也称为持久层。负责数据访问操作,包括数据的增、删、改、查。

基于三层架构的程序执行流程:

前端发起的请求,由Controller层接收(Controller响应数据给前端)
Controller层调用Service层来进行逻辑处理(Service层处理完后,把处理结果返回给Controller层)
Serivce层调用Dao层(逻辑处理过程中需要用到的一些数据要从Dao层获取)
Dao层操作文件中的数据(Dao拿到的数据会返回给Service层)

按照三层架构的思想,会使?程序的扩展性、维护性变得更好了!

2.1 代码拆分

我们使用三层架构思想,来改造下之前的程序:

控制层包名:xxxx.controller
业务逻辑层包名:xxxx.service
数据访问层包名:xxxx.dao

控制层:接收前端发送的请求,对请求进行处理,并响应数据

@RestController
public class EmpController {
    //业务层对象
    private EmpService empService = new EmpServiceA();

    @RequestMapping("/listEmp")
    public Result list(){
        //1. 调用service层, 获取数据
        List<Emp> empList = empService.listEmp();

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

2.2业务逻辑层:

处理具体的业务逻辑

3.分层解耦

  • 业务接口

    //业务逻辑接口(制定业务标准)
    public interface EmpService {
        //获取员工列表
        public List<Emp> listEmp();
    }

    业务实现类

    //业务逻辑实现类(按照业务标准实现)
    public class EmpServiceA implements EmpService {
        //dao层对象
        private EmpDao empDao = new EmpDaoA();
    
        @Override
        public List<Emp> listEmp() {
            //1. 调用dao, 获取数据
            List<Emp> empList = empDao.listEmp();
    
            //2. 对数据进行转换处理 - gender, job
            empList.stream().forEach(emp -> {
                //处理 gender 1: 男, 2: 女
                String gender = emp.getGender();
                if("1".equals(gender)){
                    emp.setGender("男");
                }else if("2".equals(gender)){
                    emp.setGender("女");
                }
    
                //处理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("就业指导");
                }
            });
            return empList;
        }
    }

    数据访问层:负责数据的访问操作,包含数据的增、删、改、查

  • 数据访问接口

    //数据访问层接口(制定标准)
    public interface EmpDao {
        //获取员工列表数据
        public List<Emp> listEmp();
    }

    数据访问实现类·

    //数据访问实现类
    public class EmpDaoA implements EmpDao {
        @Override
        public List<Emp> listEmp() {
            //1. 加载并解析emp.xml
            String file = this.getClass().getClassLoader().getResource("emp.xml").getFile();
            System.out.println(file);
            List<Emp> empList = XmlParserUtils.parse(file, Emp.class);
            return empList;
        }
    }

    三层架构的好处:

  • 复用性强

  • 便于维护

  • 利用扩展

内聚和耦合。

- 内聚:软件中各个功能模块内部的功能联系。

- 耦合:衡量软件中各个层/模块之间的依赖、关联的程度。

软件设计原则:高内聚低耦合

高内聚指的是:一个模块中各个元素之间的联系的紧密程度,如果各个元素(语句、程序段)之间的联系程度越高,则内聚性越高,即 "高内聚"。

低耦合指的是:软件中各个层、模块之间的依赖关联程序越低越好。

程序中高内聚的体现:

  • EmpServiceA类中只编写了和员工相关的逻辑处理代码

高内聚、低耦合的目的是使程序模块的可重用性、移植性大大增强。

解耦思路

在编写代码时,需要什么对象,就直接new一个就可以了。 这种做法呢,层与层之间代码就耦合了,当service层的实现变了之后, 还需要修改controller层的代码。

那应该怎么解耦呢?

  • 首先不能在EmpController中使用new对象。代码如下:

    此时,就存在另一个问题了,不能new,就意味着没有业务层对象(程序运行就报错),怎么办
    ? ?解决思路是:
    ? ?提供一个容器,容器中存储一些对象(例:EmpService对象)
    ? ? controller程序从容器中获取EmpService类型的对象

    想要实现上述解耦操作,就涉及到Spring中的两个核心概念:

    控制反转:Inversion Of Control,简称IOC。对象的创建控制权由程序自身转移到外部(容器),这种思想称为控制反转。

    ?对象的创建权由程序员主动创建转移到容器(由容器创建、管理对象)。这个容器称为:IOC容器或Spring容器

    依赖注入:Dependency Injection,简称DI。容器为应用程序提供运行时,所依赖的资源,称之为依赖注入。

    程序运行时需要某个资源,此时容器就为其提供这个资源。
    ??
    ?例:EmpController程序运行时需要EmpService对象,Spring容器就为其提供并注入EmpService对象

    IOC容器中创建、管理的对象,称之为:bean对象? ?豆子意思? 我理解是? 外国人把豆子放在容器里 所有这样起名。。。

完整的三层代码:

Controller层:

@RestController
public class EmpController {
?
 ? ?@Autowired //运行时,从IOC容器中获取该类型对象,赋值给该变量
 ? ?private EmpService empService ;
?
 ? ?@RequestMapping("/listEmp")
 ? ?public Result list(){
 ? ? ? ?//1. 调用service, 获取数据
 ? ? ? ?List<Emp> empList = empService.listEmp();
?
 ? ? ? ?//3. 响应数据
 ? ? ? ?return Result.success(empList);
 ?  }
}

Service层:

@Component //将当前对象交给IOC容器管理,成为IOC容器的bean
public class EmpServiceA implements EmpService {
?
 ? ?@Autowired //运行时,从IOC容器中获取该类型对象,赋值给该变量
 ? ?private EmpDao empDao ;
?
 ? ?@Override
 ? ?public List<Emp> listEmp() {
 ? ? ? ?//1. 调用dao, 获取数据
 ? ? ? ?List<Emp> empList = empDao.listEmp();
?
 ? ? ? ?//2. 对数据进行转换处理 - gender, job
 ? ? ? ?empList.stream().forEach(emp -> {
 ? ? ? ? ? ?//处理 gender 1: 男, 2: 女
 ? ? ? ? ? ?String gender = emp.getGender();
 ? ? ? ? ? ?if("1".equals(gender)){
 ? ? ? ? ? ? ? ?emp.setGender("男");
 ? ? ? ? ?  }else if("2".equals(gender)){
 ? ? ? ? ? ? ? ?emp.setGender("女");
 ? ? ? ? ?  }
?
 ? ? ? ? ? ?//处理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("就业指导");
 ? ? ? ? ?  }
 ? ? ?  });
 ? ? ? ?return empList;
 ?  }
}

Dao层:

@Component //将当前对象交给IOC容器管理,成为IOC容器的bean
public class EmpDaoA implements EmpDao {
 ? ?@Override
 ? ?public List<Emp> listEmp() {
 ? ? ? ?//1. 加载并解析emp.xml
 ? ? ? ?String file = this.getClass().getClassLoader().getResource("emp.xml").getFile();
 ? ? ? ?System.out.println(file);
 ? ? ? ?List<Emp> empList = XmlParserUtils.parse(file, Emp.class);
 ? ? ? ?return empList;
 ?  }
}

要把某个对象交给IOC容器管理,需要在对应的类上加上如下注解之一:

注解说明位置
@Controller@Component的衍生注解标注在控制器类上
@Service@Component的衍生注解标注在业务类上
@Repository@Component的衍生注解标注在数据访问类上(由于与mybatis整合,用的少)
@Component声明bean的基础注解不属于以上三类时,用此注解

最后

@Autowird 与 @Resource的区别!!

@Autowired 是spring框架提供的注解,而@Resource是JDK提供的注解
@Autowired 默认是按照类型注入,而@Resource是按照名称注入

文章来源:https://blog.csdn.net/eeeeeeeeei/article/details/135756063
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。