写点什么

简单地聊一聊 Spring Boot 的构架

  • 2023-11-14
    福建
  • 本文字数:7479 字

    阅读完需:约 25 分钟

前言


本文小编将详细解析 Spring Boot 框架,并通过代码举例说明每个层的作用。我们将深入探讨 Spring Boot 的整体架构,包括展示层、业务逻辑层和数据访问层。通过这些例子,读者将更加清晰地了解每个层在应用程序中的具体作用。通过代码实例,我们将帮助读者更好地理解和应用 Spring Boot 框架,从而提高应用程序的可维护性和可扩展性。


什么是 Spring Boot


在介绍 Spring Boot 框架的分层之前,小编先为大家介绍一下什么是 Spring Boot:


Spring Boot 是一个基于 Spring 框架的开发框架,旨在简化 Spring 应用程序的搭建和开发。Spring Boot 提供了很多自动化配置的功能,可以快速地搭建一个基于 Spring 的 Web 应用程序,而不需要手动进行繁琐的配置。


Spring Boot 可以帮助开发人员快速构建各种类型的应用程序,包括 Web 应用程序、RESTful 服务、批处理应用程序和基于消息的应用程序等。它采用 Java 编程语言,并且可以与各种其他技术集成,例如 Thymeleaf、MongoDB、Redis 等。


Spring Boot 还提供了很多有用的工具和插件,例如 Spring Boot CLI(命令行界面),可以帮助开发人员更加便捷地创建、运行和测试 Spring Boot 应用程序。此外,Spring Boot 还支持各种构建工具,例如 Maven 和 Gradle,以及各种开发环境,例如 Eclipse 和 IntelliJ IDEA。



Spring Boot 分层:


Spring Boot 主要分为 4 层:Controller 层、Service 层、Repository/DAO 层和 Model 层。



1. Controller 层


在 SpringBoot 中,Controller 层是 MVC(Model-View-Controller)模式中的控制器部分,负责处理来自用户发起的 HTTP 请求,并返回相应的响应结果。Controller 层接收到请求后,通常会调用 Service 层进行业务逻辑处理,最后再将处理结果封装成响应对象并返回给前端。


一个 Controller 类通常包含多个方法,每个方法对应一个不同的 HTTP 请求路径,并使用特定的注解来标识。例如,使用 @GetMapping 注解表示该方法处理 GET 请求,@PostMapping 表示该方法处理 POST 请求。同时,通过 @RequestParam 注解可以获取请求参数,@PathVariable 注解可以获取 URL 路径参数,@RequestBody 注解可以获取请求体中的数据。


2. Service 层


在 Spring Boot 中,Service 层是应用程序的一部分,负责处理业务逻辑和协调不同的组件。它是控制器(Controller)和数据访问层(Repository)之间的中间层,用于将业务逻辑与数据操作解耦。


Service 层的主要职责可以总结如下:


  1. 执行业务逻辑:Service 层负责实现应用程序的业务逻辑。它包含了具体的业务规则和操作流程,以满足需求和业务规定。例如,对于电子商务应用程序,Service 层可能会包含创建订单、处理支付、验证库存等业务逻辑的实现。


  1. 协调数据访问:Service 层充当控制器和数据访问层之间的桥梁。它通过调用相应的 Repository 接口来执行数据操作,如查询数据库、保存数据、更新数据等。Service 层可以组织和协调多个 Repository 操作,以完成复杂的业务需求。


  1. 提供业务接口:Service 层可以定义一些公共接口或方法,供其他组件(如控制器、其他 Service 等)使用。这样可以封装底层的业务逻辑实现,使其对外提供统一的接口。这种封装有助于提高代码的可维护性和重用性。


  1. 处理事务管理:Service 层通常涉及到数据库的读写操作,需要保证数据的一致性和完整性。通过使用 Spring 框架提供的事务管理机制,Service 层可以确保多个数据库操作在一个事务中执行。它可以定义事务的边界、隔离级别、回滚策略等,以确保数据操作的正确性和可靠性。


  1. 实现业务规则和验证:Service 层可以包含对传入数据的验证和处理逻辑。例如,对于用户注册操作,Service 层可能会对输入的用户名进行唯一性检查,对密码进行加密等。这样可以保证应用程序的安全性和数据的有效性。


3. Repository/DAO 层


DAO 全称是 Data Access Object,其主要目标是从数据库高效获取(查询)数据,并为 service 层提供服务。



Repository/DAO 层的主要职责可以总结如下:


  1. 定义数据访问接口:Repository 或 DAO 层定义了访问数据库的接口,它们通常包括各种读、写、更新、删除等操作。这些操作通过方法调用来实现,使得业务逻辑可以轻松地使用这些操作。


  1. 提供数据映射:Repository 或 DAO 层负责将数据库中的数据映射到 Java 类或对象中。这种映射可以是简单的一对一关系,也可以是复杂的关联关系。通常情况下,开发人员会使用 ORM 框架(如 Hibernate)来自动完成数据映射。


  1. 处理数据访问异常:Repository 或 DAO 层负责处理与数据访问相关的异常情况,例如数据库连接失败、SQL 语句执行错误等。它们可以捕获这些异常并进行相应的处理,以保证应用程序的稳定性和可靠性。


  1. 支持数据源配置:Repository 或 DAO 层支持不同类型的数据源配置,例如关系型数据库、NoSQL 数据库、文件系统等。它们可以根据不同的数据源类型,提供相应的数据访问接口和数据映射策略。


  1. 提供数据缓存:Repository 或 DAO 层可以缓存已经读取的数据,以提高应用程序的性能。它们可以使用内存缓存、分布式缓存等不同类型的缓存机制,根据业务需求进行选择。


4. Model 层


在 Spring Boot 中,Model 层对象是用于封装和传递数据的 Java 对象。它表示应用程序中的业务数据,并负责处理数据的获取、保存和修改等操作。Model 层对象通常具有以下特点:


  1. 实体类(Entity Class):Model 层对象通常是实体类或 POJO(Plain Old Java Object),用于表示业务数据的结构。实体类的属性对应数据库表的字段,通过 ORM(Object-Relational Mapping)框架可以将实体类与数据库进行映射。


  1. 数据传输对象(Data Transfer Object,DTO):在一些场景下,为了满足特定的需求,可能需要使用 DTO 来封装数据。DTO 是一个简单的 Java 对象,用于在不同的层之间传输数据。DTO 通常只包含必要的属性,以减少数据传输的大小和复杂性。


  1. 数据校验(Data Validation):Model 层对象可以用于数据校验,确保传入的数据符合特定的规则和要求。可以使用注解(如 javax.validation.constraints)或其他验证框架(如 Hibernate Validator)对属性进行校验。


  1. 业务逻辑(Business Logic):Model 层对象可以包含一些业务逻辑的方法,用于处理数据的计算、转换和操作等。这些方法可以在 Model 层对象中定义,或者在服务层(Service Layer)中进行实现。


代码示例:


1.Controller 层:


ProjectController.java


package com.example.Controller;//import statements goes here@RestControllerpublic class UserController {       //List all the available projects    @GetMapping(path = "/projects", produces = MediaType.APPLICATION_JSON_VALUE)    public ResponseEntity<List<Project>> getProjects() {         // perform validation checks    // return the services provided by service layer    }    //Apply for the project    @PostMapping(path = "/apply-project", consumes = MediaType.APPLICATION_JSON_VALUE)    public ResponseEntity<HttpStatus> applyProject(@RequestBody Map<String,String> json) {    // perform validation checks    // return the services provided by service layer    }        //Upload resume    @PostMapping(path = "/upload-resume/{usn}")    public ResponseEntity<List<Object>> uploadToDB(@RequestParam("file") MultipartFile[] file,@PathVariable String usn) {        // perform validation checks    // return the services provided by service layer    }    //Download resume    @GetMapping("/files/download/{fileName:.+}")    public ResponseEntity downloadFromDB(@PathVariable String fileName) {    // perform validation checks    // return the services provided by service layer    }}
复制代码


上面例子使用了 @GetMapping 和 @PostMapping:


@GetMapping 注解用于将一个方法映射到指定的 HTTP GET 请求。它可以用于处理浏览器直接访问某个 URL 或者其他应用程序发起 GET 请求的情况。通过在方法上添加 @GetMapping,我们可以定义一个处理该请求的方法,并在方法中编写相应的业务逻辑。


@PostMapping 注解用于将一个方法映射到指定的 HTTP POST 请求。它可以用于处理表单提交、客户端数据上传等操作。通过在方法上添加 @PostMapping,我们可以定义一个处理该请求的方法,并在方法中编写相应的业务逻辑。


2.Service 层:


下面这段定义了项目相关的服务方法,并规定这些方法的输入参数和返回值。


在代码示例中,ProjectService 接口声明了三个方法:


  1. getProjects() 方法返回一个 List<Project> 对象作为响应体(ResponseEntity),用于获取所有项目信息。


  1. applyProject(String USN,int project_id) 方法返回 HttpStatus 枚举值,表示申请参与某个项目的状态。


  1. uploadProjectDocument(MultipartFile[] files,int project_id) 方法返回 List<Object> 对象作为响应体,用于上传项目文档。


ProjectService.java


package com.example.Service;
// import statements
public interface ProjectService {
ResponseEntity<List<Project>> getProjects();
HttpStatus applyProject(String USN,int project_id);
ResponseEntity<List<Object>> uploadProjectDocument(MultipartFile[] files,int project_id);
}
复制代码


ProjectServiceImpl.java


package com.example.Service;
//import statements@Servicepublic class ProjectServiceImpl implements ProjectService {//dependency injection of DAO to be gone here (Autowire) @Override public ResponseEntity<List<Project>> getProjects() { try { //Business logic implementation using DAO services } catch (Exception e) { return new ResponseEntity<>(null,HttpStatus.INTERNAL_SERVER_ERROR) ; } } @Override public HttpStatus applyProject(String USN, int project_id) { //Business logic implementation using DAO services } //helper functions public ResponseEntity uploadToLocalFileSystem(MultipartFile file,int project_id) { } @Override public ResponseEntity<List<Object>> uploadProjectDocument(MultipartFile[] files,int project_id) { //Business logic implementation using DAO services }
}
复制代码


3.Repository/DAO 层:


下面的这段代码是一个接口类,属于包名为"com.example.Dao"的项目数据访问对象(DAO)。它扩展了 JpaRepository<Project, Integer> 接口,该接口提供了基本的 CRUD(创建、读取、更新、删除)操作方法,用于对数据库中的 "Project" 实体进行操作。


ProjectDAO.java


package com.example.Dao;
//import statements
public interface ProjectDao extends JpaRepository<Project,Integer> {
//You can also include native queries on top of CRUD operations provided by JPA// Add queries here using @Query annotations and corresponding functions
@Query(value = "Your SQL query ",nativeQuery = true) public List<Project> getProjects();
}
}
复制代码


4.Model 层:


下面这段代码定义了一个名为 "Project" 的实体类,表示一个项目。它包含了项目的各个属性(如项目 ID、公司名称、描述、要求等),并与其他实体类(如员工、学生、文档、资金等)之间建立了关联关系。通过使用 JPA 注解,该类可以方便地进行数据库操作和查询。


代码中的各个部分的含义如下:


  1. @Entity 注解表示该类是一个实体类,与数据库中的表进行映射。


  1. @Table(name = "project") 注解指定了对应的数据库表名为 "project"。


  1. @Id 注解表示该字段是主键。


  1. @GeneratedValue(strategy = GenerationType.IDENTITY) 注解指定了主键的生成策略为自增长。


  1. @Column 注解用于指定该属性与数据库表中的列的映射关系,其中 nullable 属性表示该列是否允许为空,name 属性指定了对应的数据库列名。


  1. @JsonIgnore 注解用于忽略该属性在序列化和反序列化过程中的处理。


  1. @ManyToMany(mappedBy="funded_projects") 注解表示当前实体与另一个实体 Fund 之间存在多对多的关联关系,通过 mappedBy 属性指定了在 Fund 实体中维护关联关系的属性名为


  1. "funded_projects"。


  1. Set<Staff>, Set<Student>, Set<Document>, Set<Fund> 表示与其他实体之间的关联关系,通过集合类型的属性来表示多对多关系或一对多关系。


Project.java


package com.example.Entity;
//import statements
@Entity@Table(name = "project")public class Project { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private int project_id; @Column(nullable = false, name = "company_name") private String company_name;
@Column(nullable = false, name = "description") private String description;
@Column(nullable = false, name = "requirements") private String requirements;
@Column(nullable = false, name = "manager") private String manager; @Column(nullable = false, name = "start_date") private Date start_date = new Date();
@Column( name = "end_date") private Date end_date = new Date(); @Column(nullable = false,name = "opening") private int opening; @Column(name = "resources") private String resources; public Set<Staff> getStaff_incharge() { return staff_incharge; } public void setStaff_incharge(Set<Staff> staff_incharge) { this.staff_incharge = staff_incharge; } public Set<Student> getApplied_students() { return applied_students; } public Set<Document> getDocuments() { return documents; } public void setDocuments(Set<Document> documents) { this.documents = documents; } @JsonIgnore @ManyToMany(mappedBy="funded_projects") private Set<Fund> funds; public Set<Fund> getFunds() { return funds; } public void setFunds(Set<Fund> funds) { this.funds = funds; } public void setApplied_students(Set<Student> applied_students) { this.applied_students = applied_students; } public Set<Student> getWorking_students() { return working_students; } public void setWorking_students(Set<Student> working_students) { this.working_students = working_students; }//constructors public Project() { super(); } public Project(int project_id, String company_name, String description, String requirements, String manager, Date start_date, Date end_date, int opening, String resources) { super(); this.project_id = project_id; this.company_name = company_name; this.description = description; this.requirements = requirements; this.manager = manager; this.start_date = start_date; this.end_date = end_date; this.opening = opening; this.resources = resources; } public int getProject_id() { return project_id; } public void setProject_id(int project_id) { this.project_id = project_id; } public String getCompany_name() { return company_name; } public void setCompany_name(String company_name) { this.company_name = company_name; }
public String getDescription() { return description; } public void setDescription(String description) { this.description = description; } public String getRequirements() { return requirements; } public void setRequirements(String requirements) { this.requirements = requirements; } public String getManager() { return manager; } public void setManager(String manager) { this.manager = manager; } public Date getStart_date() { return start_date; } public void setStart_date(Date start_date) { this.start_date = start_date; } public Date getEnd_date() { return end_date; } public void setEnd_date(Date end_date) { this.end_date = end_date; } public int getOpening() { return opening; } public void setOpening(int opening) { this.opening = opening; } public String getResources() { return resources; } public void setResources(String resources) { this.resources = resources; } @Override public String toString() { return "Project{" + "project_id=" + project_id + ", company_name='" + company_name + '\'' + ", description='" + description + '\'' + ", requirements='" + requirements + '\'' + ", manager='" + manager + '\'' + ", start_date=" + start_date + ", end_date=" + end_date + ", opening=" + opening + ", resources='" + resources + '\'' + '}'; }}
复制代码


总结

本文为读者详细介绍了 Spring Boot 框架的四层构架,以及如何使用各种技术和工具来进行开发。通过阅读本文,希望可以帮助读者可以更好地理解 Spring Boot 框架的工作原理和应用场景,并能够利用所学知识来实现自己的项目。


参考资料:《Understanding Spring Boot Architecture》


扩展链接:


Redis从入门到实践


一节课带你搞懂数据库事务!


Chrome开发者工具使用教程


从表单驱动到模型驱动,解读低代码开发平台的发展趋势


低代码开发平台是什么?


基于分支的版本管理,帮助低代码从项目交付走向定制化产品开发


文章转载自:葡萄城技术团队

原文链接:https://www.cnblogs.com/powertoolsteam/p/17816504.html

用户头像

还未添加个人签名 2023-06-19 加入

还未添加个人简介

评论

发布
暂无评论
简单地聊一聊Spring Boot的构架_前端_快乐非自愿限量之名_InfoQ写作社区