Java EE应用与开发-课件第10讲：Controller层与RESTful API

10Controller层与RESTfulAPI构建优雅的Web服务接口Controller层是处理用户HTTP请求的核心入口，负责接收参数、调用业务逻辑并返回响应。RESTfulAPI则通过标准化的资源定位与操作规范，实现系统的高内聚、低耦合，是现代Web服务架构的基石。请求入口与分发精准路由用户请求，协调Service层完成业务处理，把控交互流程。RESTful架构规范利用HTTP方法语义定义资源操作，统一接口风格，提升系统可维护性。接口设计最佳实践规范参数校验、异常处理与响应封装，打造健壮、易用的后端接口服务。本讲目标掌握Controller层设计学会使用`@RestController`、`@RequestMapping`等核心注解，高效处理HTTP请求，合理调用Service层业务逻辑，并规范返回JSON格式的响应数据。掌握RESTfulAPI设计原则深入理解RESTful架构风格，规范使用GET、POST、PUT、DELETE等HTTP方法，通过资源路径和状态码设计语义清晰、可扩展且符合行业标准的API接口。掌握请求参数处理熟练运用`@PathVariable`、`@RequestParam`、`@RequestBody`等注解，精准处理路径参数、查询参数和请求体参数，适配不同业务场景的参数传递需求。掌握响应结果封装设计统一的通用响应结果类，封装状态码、提示信息和数据体，为前端提供一致的返回格式，提升接口的易用性和可维护性，简化异常处理逻辑。Controller层核心注解@RestController组合注解，等价于@Controller+@ResponseBody。标记类为控制器，且所有方法的返回值会自动序列化为JSON并写入HTTP响应体，是RESTful接口开发的基础注解。@RequestMapping用于映射HTTP请求到处理方法，可作用于类和方法级。核心属性：value/path指定URL路径；method指定请求方式(GET/POST等)；produces指定响应的媒体类型(如JSON)。@GetMapping/@PostMapping等快捷注解是@RequestMapping的派生注解，分别限定了GET、POST、PUT、DELETE等请求方法，使代码语义更清晰，减少了重复的method属性配置，是日常开发的首选。@PathVariable-获取路径变量用于绑定URL路径中的占位符变量。例如在路径/users/{id}中，通过@PathVariableLongid可以获取URL中的id值，常用于RESTful风格的资源定位。@RequestParam-获取请求参数用于获取HTTP请求中的查询参数或表单参数。支持设置默认值（如defaultValue="0"）、是否必传（required）等属性，适用于分页、筛选等业务场景。@RequestBody-绑定请求体数据用于读取HTTP请求体中的JSON/XML数据，并自动将其反序列化为对应的Java对象。主要用于处理POST、PUT等请求中包含的复杂数据，是接收前端复杂数据的核心注解。RESTfulAPI设计原则01资源命名规范统一使用名词复数表示资源集合，例如`/users`、`/orders`，使URL语义更清晰，直观体现资源类型。02接口版本控制在URL路径中嵌入版本号（如`/v1/users`），有效隔离新旧功能迭代，保障不同客户端的兼容性与平滑过渡。03HTTP方法语义化GET：安全地获取资源，无副作用。POST：提交数据，用于创建新资源。PUT/PATCH：分别用于资源的全量更新与部分更新。DELETE：请求服务器删除指定的资源。04状态码精准反馈成功类(2xx)：200表示请求成功，201表示资源创建成功，语义明确。客户端错误(4xx)：400参数错误，404资源不存在，提示客户端修正请求。服务端错误(5xx)：500为服务器内部异常，需服务端排查修复。05灵活的查询能力：通过查询参数实现过滤、排序与分页，如`/users?page=0&size=10&sort=name`，让接口具备更强大的数据交互能力。案例：用户管理RESTfulAPIUserController.java@RestController@RequestMapping("/api/v1/users")publicclassUserController{@AutowiredprivateUserServiceuserService;//获取所有用户：分页查询@GetMappingpublicResponseEntity<List<User>>getAllUsers(@RequestParam("0")intpage,intsize){//业务逻辑与响应封装...returnResponseEntity.ok(users.getContent());}//省略Post/Put/Delete核心方法实现...}标准CRUD方法映射设计严格遵循REST规范，使用GET查询、POST创建、PUT更新、DELETE删除，将操作语义与HTTP方法深度绑定，接口直观易懂。规范的HTTP状态码响应创建成功返回201Created，删除成功返回204NoContent，查询成功返回200OK，通过标准化状态码让客户端精准判断请求结果。资源分层与高可扩展性通过/api/v1/users版本化路径管理资源，利用SpringBoot的依赖注入和解耦特性，可轻松扩展分页、过滤、排序等复杂业务逻辑。统一响应结果封装前端处理标准化前端可基于统一格式规范处理成功与失败响应，无需为不同接口编写差异化解析逻辑，大幅降低对接成本，提升开发与维护效率。响应信息完备化封装状态码、提示消息及业务数据，不仅满足功能需求，更便于后端排查接口异常，同时为前端提供友好的用户反馈依据。架构扩展高弹性采用泛型设计预留灵活的扩展空间，可无缝新增请求追踪ID、时间戳、签名信息等字段，轻松适配系统长期演进与迭代需求。01.定义通用泛型响应类publicclassApiResponse<T>{

privateintcode;privateStringmessage;privateTdata;

//提供success(data)与error(code,msg)静态工厂方法封装响应

}02.在业务接口中直接集成@GetMapping("/{id}")

publicApiResponse<User>getUserById(@PathVariableLongid){

Useruser=userService.getUserById(id);

returnApiResponse.success(user);//一行代码完成结果包装

}03.标准JSON响应输出示例{"code":200,"message":"Success","data":{"id":1,"name":"testuser"}}//结构清晰，前端可直接解析code判断状态，渲染data数据课后作业核心任务：实现商品管理RESTfulAPI为商品管理功能设计并实现一套完整的RESTfulAPI，涵盖接口设计、控制器实现、参数处理及统一响应封装的全流程实践。01.设计RESTfulAPI接口为商品资源规划标准的CRUD接口，严格遵循RESTful架构风格，合理定义资源路径、HTTP方法与资源标识，确保接口语义清晰、规范统一。02.编写ProductController控制器创建核心控制器类，映射各类HTTP请求路径，负责接收前端请求，调用业务层Service完成逻辑处理，并组织数据返回，实现请求与业务的解耦。03.灵活处理