【Java代码审计 | 第十四篇】MVC模型、项目结构、依赖管理及配置文件概念详解

未经许可，不得转载。

文章目录

- MVC模型
- - 模型（Model）
  - 视图（View）
  - 控制器（controller）
  - MVC工作流程
- 项目结构
- - java目录
  - resources目录
  - webapp目录
- 依赖管理
- 配置文件

在这里插入图片描述

MVC模型

MVC（Model-View-Controller）是一种经典的软件设计模式，广泛应用于Web开发中。它将应用程序分为三个核心组件：模型（Model）、视图（View）和控制器（Controller）。每个组件有明确的职责，使得代码更易于维护和扩展。

模型（Model）

模型是应用程序的核心部分，负责处理数据和业务逻辑。它直接与数据库或其他数据源交互，并封装数据的存取操作（即增删改查等）。模型不关心数据的展示方式，只负责提供数据。

在Java中，模型通常是一个POJO（Plain Old Java Object）类，或者是一个实体类（Entity）。例如：

public class User {
    private int id;
    private String name;
    private String email;

    // Getters and Setters
    public int getId() { return id; }
    public void setId(int id) { this.id = id; }

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

    public String getEmail() { return email; }
    public void setEmail(String email) { this.email = email; }
}

视图（View）

视图负责数据的展示和用户界面的呈现（如表单、按钮等）。它从模型中获取数据，并将其以用户友好的方式展示出来。视图不处理业务逻辑，只负责显示数据、接收用户输入并传递给控制器。

在Java Web开发中，视图通常是HTML、JSP、Thymeleaf、Freemarker等模板文件。例如，一个简单的JSP视图：

<html>
<head>
    <title>User Profile</title>
</head>
<body>
    <h1>User Information</h1>
    <p>ID: ${user.id}</p>
    <p>Name: ${user.name}</p>
    <p>Email: ${user.email}</p>
</body>
</html>

控制器（controller）

控制器是模型和视图之间的桥梁。它接收用户的请求，调用模型处理数据，并将结果传递给视图进行展示。控制器负责协调模型和视图的交互。

在Spring MVC中，控制器通常是一个带有@Controller注解的类。例如：

@Controller
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/user/{id}")
    public String getUserProfile(@PathVariable int id, Model model) {
        User user = userService.getUserById(id);
        model.addAttribute("user", user);
        return "userProfile"; // 返回视图名称
    }
}

MVC工作流程

1、用户通过浏览器或其他客户端发送请求（如点击链接或提交表单）。

2、控制器接收、解析请求，确定需要执行的操作。

3、控制器调用模型获取或处理数据。

4、模型将处理后的数据返回给控制器。

5、控制器根据模型返回的数据选择合适的视图。

6、视图从模型中获取数据并生成最终的HTML页面。

7、视图将生成的HTML返回给用户。

项目结构

在Java Web项目中，项目结构的设计对于代码的可维护性和可扩展性至关重要。一个典型的Java Web项目的src/main下通常包含以下几个核心目录：java目录、resources目录、webapp目录，以及test目录。

java目录

java目录是项目的源代码目录，存放所有的Java类文件。通常按照包（package）的结构组织，包名通常与项目的域名反向对应（如com.example.project）。

java目录中的常见子目录有以下几种：

1、util：存放工具类，提供通用的工具方法。工具类通常包含静态方法，用于处理字符串、日期、文件操作等通用功能。

2、exception：存放自定义异常类。自定义异常通常用于处理特定的业务逻辑错误，使异常信息更加清晰和具体。

3、config：存放配置类，如Spring的配置类。配置类用于定义Bean、配置组件扫描、设置属性等。

4、model/entity：存放实体类，通常与数据库表对应。实体类用于表示业务领域中的核心数据模型。

5、存放数据访问对象（DAO）类，负责与数据库交互。在Spring Data JPA中，通常使用接口定义Repository。

6、service：存放业务逻辑类，处理具体的业务逻辑。Service层通常分为接口（Service）和实现类，接口（Servicelmpl）用于定义业务方法，实现类用于具体实现。

7、annotation：存放项目自定义注解。自定义注解可以用于简化代码或实现特定的功能。

8、controller：存放控制器类，负责接收前端请求，进行参数校验、业务逻辑转发等操作。控制器是MVC模式中的核心组件之一。

9、interceptor：存放拦截器类。拦截器用于在请求处理前后执行特定的逻辑，如权限验证、日志记录等。

10、dto：存放数据传输对象（Data Transfer Object），用于封装请求参数或返回结果。DTO通常用于在不同层之间传递数据，避免直接暴露实体类。

11、vo：存放视图对象（View Object），用于封装客户端请求的数据或返回结果。VO通常用于展示层，确保数据的安全性。

12、constant：存放常量类，用于定义项目中使用的常量值。

13、filter：存放过滤器类。过滤器用于在请求到达Servlet之前或响应返回客户端之前执行特定的逻辑。

因此以下是一个典型的java目录结构示例：

src/main/java
└── com
    └── example
        └── project
            ├── util
            ├── exception
            ├── config
            ├── model
            ├── repository
            ├── service
            ├── annotation
            ├── controller
            ├── interceptor
            ├── dto
            ├── vo
            ├── constant
            └── filter

resources目录

resources目录是Java项目中用于存放资源文件的核心目录。这些资源文件包括配置文件、静态资源、模板文件等，通常会被打包到最终的应用程序中，供运行时使用。

常见子目录：

static：存放静态资源文件，如CSS、JavaScript、图片等。该目录中的文件可以直接通过URL访问。

templates：存放模板文件，如Thymeleaf、Freemarker、Velocity等模板引擎的文件。模板文件通常用于动态生成HTML页面。

config：存放配置文件，如application.properties或application.yml。这些文件用于配置应用程序的行为，如数据库连接、日志级别等。

mapper：存放MyBatis的mapper.xml文件。这些文件定义了SQL语句与Java方法的映射关系。

i18n：存放国际化资源文件（如messages.properties），用于支持多语言功能。

data：存放初始化数据文件，如SQL脚本或JSON数据。这些文件通常用于数据库初始化或测试数据的加载。

webapp目录

webapp目录是传统Java Web项目的Web资源目录，通常用于存放JSP文件、WEB-INF配置等。在现代Spring Boot项目中，这个目录的功能通常被resources/static和resources/templates取代。

常见子目录：

1、WEB-INF：存放Web应用的配置文件和受保护的资源。该目录下的资源无法直接通过URL访问，通常用于存放安全相关的文件。包括：

web.xml：Web应用的配置文件（在Spring Boot中通常不需要）。
classes：编译后的类文件（通常由构建工具自动生成）。
lib：存放依赖的JAR文件（通常由构建工具管理）。

2、存放JSP视图文件。JSP文件用于动态生成HTML页面，通常与Servlet结合使用。

src/main/webapp
├── WEB-INF
│   ├── web.xml
│   ├── classes
│   └── lib
└── index.jsp

一个典型的resources和webapp目录结构示例：

src/main
├── resources
│   ├── static
│   │   ├── css
│   │   ├── js
│   │   └── images
│   ├── templates
│   │   └── userProfile.html
│   ├── config
│   │   └── application.properties
│   ├── mapper
│   │   └── UserMapper.xml
│   ├── i18n
│   │   ├── messages_en.properties
│   │   └── messages_zh.properties
│   └── data
│       └── init.sql
└── webapp
    ├── WEB-INF
    │   ├── web.xml
    │   ├── classes
    │   └── lib
    └── index.jsp

依赖管理

依赖管理是Java项目开发中的关键环节，它决定了项目如何引入和管理第三方库。

为什么要引入第三方库呢？

许多通用的功能（如日志记录、数据库连接、JSON解析等）已经被优秀的第三方库实现。直接使用这些库可以避免重复开发，节省大量时间和精力。

现代Java项目通常使用构建工具（如Maven）来管理依赖。

Maven通过pom.xml文件管理依赖。每个依赖由groupId、artifactId和version唯一标识。

依赖范围（Scope）：

compile：默认范围，依赖在编译、测试和运行时都可用。
provided：依赖由JDK或容器提供，仅在编译和测试时使用。
test：依赖仅在测试时使用。
runtime：依赖在运行时使用，但在编译时不需要。

配置文件

配置文件用于定义应用程序的行为和参数。常见的配置文件格式包括properties和YAML。

1、application.properties是Spring Boot中常用的配置文件格式，采用键值对的形式。

# 数据库配置
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=123456

# 服务器端口
server.port=8080

# 日志级别
logging.level.root=INFO
logging.level.com.example=DEBUG

2、application.yml是另一种常见的配置文件格式，结构更清晰，适合复杂配置。

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: 123456
server:
  port: 8080
logging:
  level:
    root: INFO
    com.example: DEBUG