SpringMVC结构简介及常用注解汇总

以下是关于“SpringMVC结构简介及常用注解汇总”的完整攻略，其中包含两个示例。

SpringMVC结构简介

SpringMVC是一个基于MVC架构的Web框架，它提供了一种灵活、高效的方式来开发Web应用程序。在SpringMVC中，请求的处理流程可以分为以下几个步：

1. 客户端发送请求到DispatcherServlet。
2. DispatcherServlet将请求交给HandlerMapping进行处理，找到对应的HandlerAdapter。
3. HandlerAdapter将请求交给Controller进行处理。
4. Controller处理请求并返回ModelAndView。
5. HandlerAdapter将ModelAndView交给ViewResolver进行解析，找到对应的View。
6. View渲染ModelAndView并返回响应结果。
7. DispatcherServlet将响应结果返回给客户端。

在SpringMVC中，我们可以使用注解来简化开发，提高开发效率。下面是一些常用的注解。

常用注解汇总

@Controller

@Controller注解用于标识一个类为控制器，它通常与@RequestMapping注解一起使用。在SpringMVC中，控制器用于处理客户端的请求，并返回响应结果。

@RequestMapping

@RequestMapping注解用于将请求映射到对应的控制器方法上。它可以用于类级别和方法级别，用于指定请求的URL路径、请求方法、请求参数等信息。

以下是一个使用@RequestMapping注解的示例：

@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping("/list")
    public String list(Model model) {
        List<User> userList = userService.getUserList();
        model.addAttribute("userList", userList);
        return "userList";
    }
}

在本示例中，我们使用@Controller注解标识UserController类为控制器，并使用@RequestMapping注解指定了请求路径。在list()方法中，我们返回了一个名为"userList"的视图名称。

@RequestParam

@RequestParam注解用于将请求参数绑定到控制器方法的参数上。它可以用于指定请求参数的名称、是否必须、默认值等信息。

以下是一个使用@RequestParam注解的示例：

@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping("/detail")
    public String detail(@RequestParam("id") Long userId, Model model) {
        User user = userService.getUserById(userId);
        model.addAttribute("user", user);
        return "userDetail";
    }
}

在本示例中，我们使用@RequestParam注解将请求参数"id"绑定到控制器方法的参数userId上。

@PathVariable

@PathVariable注解用于将请求路径中的占位符绑定到控制器方法的参数上。它可以用于指定占位符的名称、是否必须等信息。

以下是一个使用@PathVariable注解的示例：

@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping("/{id}")
    public String detail(@PathVariable("id") Long userId, Model model) {
        User user = userService.getUserById(userId);
        model.addAttribute("user", user);
        return "userDetail";
    }
}

在本示例中，我们使用@PathVariable注解将请求路径中的占位符"id"绑定到控制器方法的参数userId上。

@ResponseBody

@ResponseBody注解用于将控制器方法的返回值直接作为响应结果返回给客户端。它可以用于指定响应结果的格式、编码等信息。

以下是一个使用@ResponseBody注解的示例：

@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping("/list")
    @ResponseBody
    public List<User> list() {
        return userService.getUserList();
    }
}

在本示例中，我们使用@ResponseBody注解将控制器方法的返回值直接作为响应结果返回给客户端。

示例1

以下是一个使用注解的SpringMVC示例：

@Controller
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;

    @RequestMapping("/list")
    public String list(Model model) {
        List<User> userList = userService.getUserList();
        model.addAttribute("userList", userList);
        return "userList";
    }

    @RequestMapping("/{id}")
    public String detail(@PathVariable("id") Long userId, Model model) {
        User user = userService.getUserById(userId);
        model.addAttribute("user", user);
        return "userDetail";
    }
}

在本示例中，我们定义了一个名为UserController的控制器，并使用@Controller注解标识它。我们使用@RequestMapping注解指定了请求路径，并在list()方法和detail()方法中使用了@RequestParam注解和@PathVariable注解。

示例2

以下是另一个使用注解的SpringMVC示例：

@RestController
@RequestMapping("/api/user")
public class UserApiController {
    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public User getUserById(@PathVariable("id") Long userId) {
        return userService.getUserById(userId);
    }

    @PostMapping("/")
    public User addUser(@RequestBody User user) {
        return userService.addUser(user);
    }
}

在本示例中，我们定义了一个名为UserApiController的控制器，并使用@RestController注解标识它。我们使用@RequestMapping注解指定了请求路径，并在getUserById()方法和addUser()方法中使用了@PathVariable注解和@RequestBody注解。