Spring MVC是基于Java实现MVC模型的轻量级Web框架,其核心优势在于简化Web开发、灵活性强和与Spring生态无缝集成。通过分层设计,它将应用分为:
Controller层:处理请求和响应
Service层:业务逻辑处理
Dao层:数据持久化操作
// UserDao.java(接口)
@Mapper
public interface UserDao {
// 根据ID查询用户
User getUserById(Long id);
// 创建用户
int createUser(User user);
// 更新用户
int updateUser(User user);
// 删除用户
int deleteUser(Long id);
}
INSERT INTO users(name, email) VALUES(#{name}, #{email})
UPDATE users SET name=#{name}, email=#{email} WHERE id=#{id}
DELETE FROM users WHERE id = #{id}
// UserService.java
@Service
public class UserService {
@Autowired
private UserDao userDao;
public User getUserById(Long id) {
// 可添加业务逻辑(如缓存、权限校验等)
return userDao.getUserById(id);
}
public User createUser(UserCreateRequest request) {
// 业务逻辑验证(如邮箱格式校验)
User user = new User();
user.setName(request.getName());
user.setEmail(request.getEmail());
userDao.createUser(user);
return user;
}
public User updateUser(Long id, UserUpdateRequest request) {
User user = userDao.getUserById(id);
if (user == null) throw new ResourceNotFoundException("User not found");
user.setName(request.getName());
user.setEmail(request.getEmail());
userDao.updateUser(user);
return user;
}
public void deleteUser(Long id) {
userDao.deleteUser(id);
}
}
// UserController.java
@RestController
@RequestMapping("/api/users") // 资源基础路径
public class UserController {
@Autowired
private UserService userService;
// GET /api/users/123 -> 获取ID为123的用户
@GetMapping("/{id}")
public ResponseEntity getUser(@PathVariable Long id) {
User user = userService.getUserById(id);
return ResponseEntity.ok(user);
}
// POST /api/users -> 创建新用户
@PostMapping
public ResponseEntity createUser(@Valid @RequestBody UserCreateRequest request) {
User user = userService.createUser(request);
return ResponseEntity.created(URI.create("/api/users/" + user.getId())).body(user);
}
// PUT /api/users/123 -> 全量更新用户
@PutMapping("/{id}")
public ResponseEntity updateUser(
@PathVariable Long id,
@Valid @RequestBody UserUpdateRequest request) {
User user = userService.updateUser(id, request);
return ResponseEntity.ok(user);
}
// DELETE /api/users/123 -> 删除用户
@DeleteMapping("/{id}")
public ResponseEntity deleteUser(@PathVariable Long id) {
userService.deleteUser(id);
return ResponseEntity.noContent().build(); // 返回204状态码
}
}
注解 | 作用 | 使用位置 | 示例 |
---|---|---|---|
@Controller |
声明 MVC 控制器 | 类上方 | @Controller class UserCtrl |
@RequestMapping |
定义类/方法级别的请求路径 | 类/方法上方 | @RequestMapping("/api") |
@GetMapping |
映射 GET 请求 | 方法上方 | @GetMapping("/users") |
@PostMapping |
映射 POST 请求 | 方法上方 | @PostMapping("/users") |
@PutMapping |
映射 PUT 请求 | 方法上方 | @PutMapping("/users/{id}") |
@DeleteMapping |
映射 DELETE 请求 | 方法上方 | @DeleteMapping("/users/{id}") |
@ResponseBody |
将返回值直接写入响应体 | 方法上方 | @ResponseBody User getUser() |
路径映射:@RequestMapping
支持类/方法级映射
RESTful支持:@GetMapping
, @PostMapping
等简化HTTP方法映射
路径变量:@PathVariable
获取URI动态参数
@DeleteMapping("/{id}")
public boolean delete(@PathVariable Integer id) {
return bookService.delete(id);
}
注解 | 数据来源 | 适用场景 |
---|---|---|
@RequestParam | URL 查询字符串 | ?name=John&age=30 |
@PathVariable | URL 路径片段 | /users/{id} |
@RequestBody | HTTP 请求体 | JSON/XML 格式数据 |
支持多种参数类型自动绑定:
参数类型 | 注解/用法 | 示例 |
---|---|---|
普通参数 | @RequestParam |
?name=value |
POJO对象 | 直接声明对象类型 | 表单字段匹配对象属性 |
JSON数据 | @RequestBody |
接收JSON请求体 |
数组/集合 | @RequestParam List<> |
?likes=game&likes=music |
维度 | @RequestParam | @RequestBody |
---|---|---|
数据位置 | URL 查询参数(?key=value ) |
HTTP 请求体(JSON/XML 数据) |
适用场景 | GET 请求的简单参数 | POST/PUT 的复杂对象传输 |
数据类型 | 基本类型(String/int/boolean) | 对象/集合(DTO/List/Map) |
必传性 | 默认必传,可设 required=false |
默认必传,可设 required=false |
示例 | /users?name=John |
{"name":"John","age":30} |
通过@RestControllerAdvice
实现全局异常处理:
@RestControllerAdvice
public class ProjectExceptionAdvice {
@ExceptionHandler(BusinessException.class)
public Result handleBusinessException(BusinessException ex) {
return new Result(ex.getCode(), null, ex.getMessage());
}
@ExceptionHandler(Exception.class)
public Result handleException(Exception ex) {
return new Result(500, null, "系统繁忙");
}
}
实现HandlerInterceptor
接口创建拦截器:
@Component
public class AuthInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response,
Object handler) {
// 权限验证逻辑
if(!checkAuth(request)) {
response.sendError(403);
return false;
}
return true;
}
}
注解 | RESTful 专用功能 | 使用示例 |
---|---|---|
@RestController | =@Controller+@ResponseBody | @RestController class UserAPI |
@PathVariable | 获取 URI 中的动态变量 | getUser(@PathVariable Long id) |
URI即资源标识符
每个URI对应唯一资源:/api/users/123
表示ID为123的用户
资源使用名词/users
而非动词 /getUsers
HTTP方法定义操作
方法 | 操作 | 示例 |
---|---|---|
GET | 查询 | GET /users/123 |
POST | 创建 | POST /users |
PUT | 全量更新 | PUT /users/123 |
PATCH | 部分更新 | PATCH /users/123 |
DELETE | 删除 | DELETE /users/123 |
状态码表示结果
200 OK:成功
201 Created:资源创建成功
204 No Content:操作成功无返回体
404 Not Found:资源不存在
// Spring配置类
@Configuration
@ComponentScan({"com.service", "com.dao"})
@PropertySource("classpath:jdbc.properties")
@Import({JdbcConfig.class, MybatisConfig.class})
@EnableTransactionManagement
public class SpringConfig {}
// SpringMVC配置类
@Configuration
@ComponentScan("com.controller")
@EnableWebMvc
public class SpringMvcConfig {}
注解 | 整合作用 | 使用场景 |
---|---|---|
@ComponentScan | 配置 Spring 组件扫描路径 | @ComponentScan("com.app") |
@EnableWebMvc | 启用 Spring MVC 特性 | @Configuration @EnableWebMvc |
public class Result {
private Object data;
private Integer code;
private String msg;
// 成功静态方法
public static Result success(Object data) {
return new Result(200, data, "操作成功");
}
}
@Service
@Transactional(rollbackFor = Exception.class)
public class BookServiceImpl implements BookService {
// 业务方法自动具备事务
}
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/static/**")
.addResourceLocations("/static/");
}
com.fasterxml.jackson.core
jackson-databind
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(logInterceptor).order(1);
registry.addInterceptor(authInterceptor).order(2);
}
protected Filter[] getServletFilters() {
CharacterEncodingFilter filter = new CharacterEncodingFilter();
filter.setEncoding("UTF-8");
return new Filter[]{filter};
}
@Bean
public CorsFilter corsFilter() {
CorsConfiguration config = new CorsConfiguration();
config.addAllowedOrigin("*");
config.addAllowedMethod("*");
config.addAllowedHeader("*");
UrlBasedCorsConfigurationSource source =
new UrlBasedCorsConfigurationSource();
source.registerCorsConfiguration("/**", config);
return new CorsFilter(source);
}
注解 | 整合作用 | 使用场景 |
---|---|---|
@DateTimeFormat | 日期参数格式化(基础用法) | 方法参数或 DTO 字段 |
@RequestMapping("/date")
public String dateParam(@DateTimeFormat(pattern="yyyy-MM-dd") Date date) {
// 处理日期
}
DateTimeFormat 深度解析
属性 | 作用 | 示例值 |
---|---|---|
pattern | 自定义日期格式 | "yyyy-MM-dd HH:mm:ss" |
iso | 使用 ISO 标准格式 | ISO.DATE (yyyy-MM-dd) |
timezone | 设置时区 | "GMT+8" |
public List getEvents(
@RequestParam @DateTimeFormat(pattern="yyyy-MM-dd") Date startDate
) {
// 处理日期参数
}
Spring MVC通过其优雅的设计和强大的扩展能力,成为构建Java Web应用的首选框架。关键优势包括:
清晰的MVC分层架构
灵活的请求处理机制
强大的数据绑定能力
完善的异常处理体系
深度整合Spring生态