目錄

1. RESTful API 設計規范
2. Spring MVC 核心注解解析
3. 靜態資源處理策略
4. JSON 數據交互全解
5. 高頻問題與最佳實踐

---

一、RESTful API 設計規范

1.1 核心原則

原則	說明	示例 URI
資源為中心	URI 使用名詞（復數形式）	/users ?? /getUser ?
HTTP 方法語義化	GET（查）、POST（增）、PUT（改）、DELETE（刪）	DELETE /users/1
無狀態通信	服務端不保存客戶端會話狀態	每次請求攜帶完整認證信息

1.2 完整代碼示例

@RestController
@RequestMapping("/api/v1/users")
public class UserController {@GetMapping("/{id}")public ResponseEntity<User> getUser(@PathVariable Long id) {User user = userService.findById(id);return user != null ? ResponseEntity.ok(user) : ResponseEntity.notFound().build();}@PostMappingpublic ResponseEntity<User> createUser(@Valid @RequestBody User user) {User savedUser = userService.save(user);URI location = ServletUriComponentsBuilder.fromCurrentRequest().path("/{id}").buildAndExpand(savedUser.getId());return ResponseEntity.created(location).body(savedUser);}
}

1.3 高級技巧

• HATEOAS 實現（響應中嵌入資源鏈接）：

@GetMapping("/{id}/orders")
public CollectionModel<Order> getUserOrders(@PathVariable Long id) {List<Order> orders = orderService.findByUserId(id);Link selfLink = linkTo(methodOn(UserController.class).getUserOrders(id)).withSelfRel();return CollectionModel.of(orders, selfLink);
}

• 響應示例：

{"content": [ ... ],"_links": {"self": { "href": "/users/1/orders" }}
}

---

二、Spring MVC 核心注解解析

2.1 參數綁定注解

注解	作用場景	示例代碼
@PathVariable	從 URI 路徑提取變量	@GetMapping("/{id}") → id=1
@RequestParam	綁定查詢參數（支持默認值）	@RequestParam(name="page", defaultValue="1")
@RequestBody	將請求體 JSON 映射到 Java 對象	public User createUser(@RequestBody User user)

2.2 元數據獲取注解

// 獲取 Cookie 值
@GetMapping("/session")
public String getSession(@CookieValue("JSESSIONID") String sessionId) { ... }// 讀取請求頭
@GetMapping("/headers")
public String getHeader(@RequestHeader("User-Agent") String userAgent) { ... }

2.3 作用域注解

注解	作用域	生命周期
@SessionAttribute	讀取 Session 屬性	用戶會話期間有效
@ModelAttribute	預加載模型數據	每次請求前執行

---

三、靜態資源處理策略

3.1 配置方式對比

方式	配置示例	適用場景
缺省 Servlet 放行	web.xml 配置 <servlet-mapping>	傳統項目兼容
resources 標簽	<mvc:resources mapping="/img/**" location="/img/"/>	明確指定資源目錄
default-servlet-handler	<mvc:default-servlet-handler/>	快速放行所有靜態資源

3.2 常見問題

• JSP 未被放行：需通過視圖解析器處理，不屬于靜態資源。
• 路徑沖突：避免控制器映射與靜態資源路徑重疊（如 /js/** 與 /js/controller）。

---

四、JSON 數據交互全解

4.1 響應 JSON 配置

@RestController // = @Controller + @ResponseBody
public class ApiController {@GetMapping("/city/{id}")public City getCity(@PathVariable int id) {return cityService.findById(id);}
}

4.2 序列化控制

@Data
public class Product {@JsonIgnoreprivate String internalCode; // 不序列化@JsonFormat(pattern = "yyyy-MM-dd")private Date createTime;     // 日期格式化
}

4.3 依賴配置

<dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>2.14.0</version>
</dependency>

---

五、高頻問題與最佳實踐

5.1 常見錯誤

1. RESTful 路徑設計混亂
   • ? /getUserOrders?userId=1 → ? GET /users/1/orders
2. HTTP 方法誤用
   • ? 用 POST 請求更新資源 → ? 使用 PUT/PATCH
3. JSON 日期序列化錯誤
   • 解決方案：@JsonFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8")

5.2 性能優化

• 靜態資源緩存：配置 Cache-Control 頭減少重復請求。
• Jackson 延遲加載：對大數據集使用 @JsonView 控制序列化字段。