当前位置: 首页 > java >正文

【Java项目脚手架系列】第三篇:Spring MVC基础项目脚手架

【Java项目脚手架系列】第三篇:Spring MVC基础项目脚手架

前言

在前面的文章中,我们介绍了Maven基础项目脚手架和JavaWeb基础项目脚手架。今天,我们将介绍Spring MVC项目脚手架,这是一个用于快速搭建Web应用的框架。

什么是Spring MVC?

Spring MVC是Spring框架的一个模块,它实现了MVC(Model-View-Controller)设计模式,用于构建Web应用程序。它提供了:

  1. 强大的控制器机制
  2. 灵活的视图解析
  3. 丰富的注解支持
  4. 完善的请求处理

Spring MVC项目脚手架

1. 项目结构

springmvc-scaffold/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── example/
│   │   │           ├── controller/
│   │   │           │   └── HomeController.java
│   │   │           └── service/
│   │   │               ├── HelloService.java
│   │   │               ├── MessageFormatter.java
│   │   │               └── DefaultMessageFormatter.java
│   │   └── webapp/
│   │       └── WEB-INF/
│   │           ├── views/
│   │           │   └── home.jsp
│   │           ├── spring-mvc.xml
│   │           └── web.xml
│   └── test/
│       └── java/
│           └── com/
│               └── example/
│                   ├── controller/
│                   │   └── HomeControllerTest.java
│                   └── service/
│                       └── HelloServiceTest.java
├── docs/
│   └── 03-springmvc-scaffold.md
├── pom.xml
└── README.md

2. 核心文件内容

2.1 pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.example</groupId><artifactId>springmvc-scaffold</artifactId><version>1.0-SNAPSHOT</version><packaging>war</packaging><properties><maven.compiler.source>1.8</maven.compiler.source><maven.compiler.target>1.8</maven.compiler.target><spring.version>5.3.20</spring.version><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties><dependencies><!-- Spring MVC --><dependency><groupId>org.springframework</groupId><artifactId>spring-webmvc</artifactId><version>${spring.version}</version></dependency><!-- Servlet API --><dependency><groupId>javax.servlet</groupId><artifactId>javax.servlet-api</artifactId><version>4.0.1</version><scope>provided</scope></dependency><!-- JSTL --><dependency><groupId>javax.servlet</groupId><artifactId>jstl</artifactId><version>1.2</version></dependency><!-- Jackson for JSON --><dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>2.13.3</version></dependency></dependencies><build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-war-plugin</artifactId><version>3.3.2</version></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.8.1</version><configuration><source>${maven.compiler.source}</source><target>${maven.compiler.target}</target></configuration></plugin></plugins></build>
</project>
2.2 web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaeehttp://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"version="4.0"><display-name>Spring MVC Application</display-name><!-- Spring MVC Dispatcher Servlet --><servlet><servlet-name>dispatcher</servlet-name><servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class><init-param><param-name>contextConfigLocation</param-name><param-value>/WEB-INF/spring-mvc.xml</param-value></init-param><load-on-startup>1</load-on-startup></servlet><servlet-mapping><servlet-name>dispatcher</servlet-name><url-pattern>/</url-pattern></servlet-mapping><!-- Character Encoding Filter --><filter><filter-name>characterEncodingFilter</filter-name><filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class><init-param><param-name>encoding</param-name><param-value>UTF-8</param-value></init-param><init-param><param-name>forceEncoding</param-name><param-value>true</param-value></init-param></filter><filter-mapping><filter-name>characterEncodingFilter</filter-name><url-pattern>/*</url-pattern></filter-mapping>
</web-app>
2.3 spring-mvc.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:context="http://www.springframework.org/schema/context"xmlns:mvc="http://www.springframework.org/schema/mvc"xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans.xsdhttp://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context.xsdhttp://www.springframework.org/schema/mvchttp://www.springframework.org/schema/mvc/spring-mvc.xsd"><!-- Enable component scanning --><context:component-scan base-package="com.example.controller"/><!-- Enable Spring MVC annotations --><mvc:annotation-driven/><!-- Static Resources --><mvc:resources mapping="/resources/**" location="/resources/"/><!-- View Resolver --><bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"><property name="prefix" value="/WEB-INF/views/"/><property name="suffix" value=".jsp"/></bean>
</beans>
2.4 HomeController.java
package com.example.controller;import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;@Controller
public class HomeController {@GetMapping("/")public String home(Model model) {model.addAttribute("message", "Welcome to Spring MVC!");return "home";}
}
2.5 HelloService.java
package com.example.service;import org.springframework.stereotype.Service;
import org.springframework.beans.factory.annotation.Autowired;@Service
public class HelloService {private final MessageFormatter messageFormatter;@Autowiredpublic HelloService(MessageFormatter messageFormatter) {this.messageFormatter = messageFormatter;}public String getGreeting(String name) {if (name == null || name.trim().isEmpty()) {return messageFormatter.format("Hello, World!");}return messageFormatter.format("Hello, " + name + "!");}public int add(int a, int b) {return a + b;}
}
2.6 MessageFormatter.java
package com.example.service;public interface MessageFormatter {String format(String message);
}
2.7 DefaultMessageFormatter.java
package com.example.service;import org.springframework.stereotype.Component;@Component
public class DefaultMessageFormatter implements MessageFormatter {@Overridepublic String format(String message) {return message;}
}
2.8 HelloServiceTest.java
package com.example.service;import org.junit.Before;
import org.junit.Test;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import static org.junit.Assert.*;
import static org.mockito.Mockito.*;public class HelloServiceTest {private HelloService helloService;@Mockprivate MessageFormatter messageFormatter;@Beforepublic void setUp() {MockitoAnnotations.openMocks(this);helloService = new HelloService(messageFormatter);// 设置模拟对象的行为when(messageFormatter.format(anyString())).thenAnswer(invocation -> invocation.getArgument(0));}@Testpublic void testGetGreetingWithName() {String result = helloService.getGreeting("John");assertEquals("Hello, John!", result);verify(messageFormatter).format("Hello, John!");}@Testpublic void testGetGreetingWithNull() {String result = helloService.getGreeting(null);assertEquals("Hello, World!", result);verify(messageFormatter).format("Hello, World!");}@Testpublic void testGetGreetingWithEmptyString() {String result = helloService.getGreeting("");assertEquals("Hello, World!", result);verify(messageFormatter).format("Hello, World!");}@Testpublic void testAdd() {int result = helloService.add(2, 3);assertEquals(5, result);}
}
2.9 home.jsp
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<!DOCTYPE html>
<html>
<head><meta charset="UTF-8"><title>Spring MVC Example</title><style>body {font-family: Arial, sans-serif;margin: 40px;line-height: 1.6;}.container {max-width: 800px;margin: 0 auto;padding: 20px;border: 1px solid #ddd;border-radius: 5px;}h1 {color: #333;}</style>
</head>
<body><div class="container"><h1>${message}</h1><p>This is a basic Spring MVC application.</p></div>
</body>
</html>

3. 使用说明

  1. 克隆项目

    git clone git@gitee.com:zengqiang_wang/leecode-inteview-questions-journal.git
    
  2. 导入IDE

    • 推荐使用IntelliJ IDEA
    • 选择"Open as Maven Project"
  3. 配置Tomcat

    • 添加Tomcat服务器
    • 配置部署选项
    • 设置上下文路径
  4. 运行项目

    • 启动Tomcat服务器
    • 访问 http://localhost:8080/springmvc-scaffold/

4. 单元测试

项目包含了完整的单元测试示例,展示了如何测试Spring MVC应用的不同组件:

  1. 服务层测试

    • 使用JUnit 4进行基础单元测试
    • 测试正常和边界情况
    • 示例:HelloServiceTest.java
  2. 控制器测试

    • 使用Spring Test框架
    • 使用MockMvc模拟HTTP请求
    • 测试视图解析和模型属性
    • 示例:HomeControllerTest.java
  3. 运行测试

    mvn test
    

5. 最佳实践

  1. 控制器设计

    • 保持控制器简洁
    • 使用RESTful风格
    • 合理使用请求方法
  2. 视图管理

    • 使用JSTL标签
    • 抽取公共模板
    • 使用CSS框架
  3. 静态资源

    • 合理组织目录
    • 使用版本号
    • 考虑CDN
  4. 安全性

    • 配置字符编码
    • 防止XSS攻击
    • 控制文件上传

6. 常见问题

  1. 404错误

    • 检查URL映射
    • 确认视图位置
    • 检查包扫描
  2. 中文乱码

    • 检查编码配置
    • 确认JSP编码
    • 检查数据库编码
  3. 静态资源访问

    • 检查资源映射
    • 确认目录结构
    • 检查权限设置

总结

Spring MVC脚手架提供了一个完整的Web应用开发基础,包含了必要的配置和示例代码。通过这个项目,你可以:

  • 快速开始Spring MVC开发
  • 学习Spring MVC的最佳实践
  • 基于此扩展更多功能

参考资源

  • Spring MVC官方文档
  • Maven官方文档
  • JSTL标签库文档

下期预告

在下一篇中,我们将介绍SpringBoot基础项目脚手架,这是一个更加现代化的Web应用开发框架。SpringBoot通过自动配置和约定优于配置的原则,大大简化了Spring应用的开发流程。我们将详细讲解:

  1. SpringBoot的核心特性
  2. 项目结构设计
  3. 常用配置说明
  4. 开发最佳实践

敬请期待!

http://www.xdnf.cn/news/4399.html

相关文章:

  • blender云渲染指南2025版
  • 【Rust模块管理】Rust包、crate与模块管理
  • WSL 的 Ubuntu 子系统中启用图形化界面
  • 处理PostgreSQL数据库事务死锁过程
  • 极狐Gitlab 如何创建并使用子群组?
  • 5月7号.
  • ESP32- 开发笔记- 软件开发 6 蓝牙协议栈 1
  • console-chat-gpt开源程序是用于 AI Chat API 的 Python CLI
  • 屏幕炫光也能轻松应对,远程控制电脑可以避免裂痕碍眼
  • 白杨SEO:如何查看百度、抖音、微信、微博、小红书、知乎、B站、视频号、快手等7天内最热门话题及流量关键词有哪些?使用方法和免费工具推荐以及注意事项【干货】
  • NX二次开发——BlockUI 弹出另一个BlockUI对话框
  • 深入了解linux系统—— 进程控制
  • PPT 制作难题迎刃而解,影刀 RPA 开启自动化创作时代
  • Kotlin 中实现单例模式的几种常见模式
  • 用R语言+随机森林玩转遥感空间预测-基于R语言机器学习遥感数据处理与模型空间预测技术及实际项目案例分析
  • 全局网络:重构数字时代的连接范式
  • 【Hive入门】Hive增量数据导入:基于Sqoop的关系型数据库同步方案深度解析
  • 汽车服务小程序功能点开发
  • 康养休闲旅游住宿服务实训室:构建产教融合新标杆
  • JVM的双亲委派模型
  • 基于RK3568多功能车载定位导航智能信息终端
  • 【IP101】图像分割技术全解析:从传统算法到深度学习的进阶之路
  • 【图书管理系统】详细讲解用户登录:后端代码实现及讲解、前端代码讲解
  • vue2开发者sass预处理注意
  • 关于STM32 SPI收发数据异常
  • 日常开发中,iOS 性能调优我们怎么做?
  • ISCC 2025练武题 WP部分
  • DELL R770 服务器,更换OCP模块!
  • (九)PMSM驱动控制学习---分流电阻采样及重构
  • 密码学系列 - SR25519与ED25519