java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > java @RestController和@Controller

Java中@RestController和@Controller的使用区别解析

作者：CC大煊

本文给大家介绍Java中@RestController和@Controller的使用区别解析,本文结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧

1. 引言

常用Web开发注解

@Controller 与 @RestController 的定位

在开发中，我们经常会遇到两种不同的业务场景，这时我们需要根据实际需求选择不同的注解：

2. @Controller详解

在Spring MVC框架中，@Controller主要用于标记一个类为控制器，从而接收和处理来自客户端的请求，返回视图名称或ModelAndView对象，供视图解析器解析后生成最终页面。

2.1 概念解析及使用场景

2.2 核心原理及底层实现

在Spring MVC架构中，DispatcherServlet扮演了前端控制器的角色，整个请求处理流程如下：

  1. 客户端发起请求，DispatcherServlet接收该请求。
  2. DispatcherServlet根据请求URL通过HandlerMapping查找对应的@Controller。
  3. 找到某个方法后，通过反射调用该方法，执行完后获得返回值。
  4. 如果方法返回的是视图名称，将根据配置的ViewResolver解析视图（例如将字符串"home"映射到/home.jsp或home.html）。
  5. 最后ViewResolver将返回的Model数据与视图模板合并，生成最终HTML页面返回给客户端。

这种流程就类似于一个快递分拣中心：DispatcherServlet是分拣中心，通过查找和分发将包裹（请求）分发到正确的分拣员（Controller），最终将包裹送达收件人（客户端）。

2.3 示例代码及必需的import展示

下面是一个简单的@Controller示例代码，展示如何处理一个GET请求并返回一个视图页面：

package com.example.demo.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.ui.Model;
@Controller
public class SampleController {
    // 处理GET请求，访问网址：http://localhost:8080/hello
    @GetMapping("/hello")
    public String hello(Model model) {
        // 添加数据到Model，供前端页面使用
        model.addAttribute("message", "Hello, World!");
        // 返回视图名称，视图解析器将根据该名称查找实际视图（例如hello.jsp、hello.html）
        return "hello";
    }
}

在上面的代码中，需要注意：

2.4 使用注意事项

3. @RestController详解

在现代Web开发中，@RestController注解为构建RESTful API提供了极大的便利，使得Controller中的方法可以直接返回数据而无需额外的视图解析处理。下面我们详细讲解@RestController的概念、优势、内部原理以及使用中的注意事项。

3.1 概念解析及使用场景

3.2 相较@Controller的便捷性

3.3 内部原理及@ResponseBody的自动注入机制

3.4 示例代码及必需的import展示

下面提供一段使用@RestController构建RESTful API接口的示例代码，展示如何返回JSON数据以及必须的import包信息：

package com.example.demo.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
// @RestController组合了@Controller和@ResponseBody
@RestController
public class UserController {
    // 处理 GET 请求，并返回一个用户示例（自动转换为JSON格式输出）
    @GetMapping("/user")
    public User getUser() {
        return new User(1, "Alice");
    }
}
// 示例用户实体类
package com.example.demo.model;
public class User {
    private int id;
    private String name;
    // 必须的无参构造器
    public User() {}
    public User(int id, String name) {
        this.id = id;
        this.name = name;
    }
    // Getter和Setter方法
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

在上述代码中，注意以下几点：

3.5 使用注意事项

4. @Controller vs @RestController对比分析

在Spring MVC开发中，@Controller和@RestController都是用来标识控制器类，但它们在功能和底层实现上存在一定的差异，适用于不同的业务场景。下面对两者进行详细的对比分析。

4.1 功能及底层实现的异同

4.2 使用场景和业务需求解读

4.3 注意事项总结

5. 实战案例分析

在实际开发中，我们经常面临两类不同需求：一类是传统的页面渲染应用，另一类是RESTful API服务。下面分别通过案例展示如何使用@Controller和@RestController，并对比其代码结构及开发体验。

5.1 使用@Controller构建传统Web应用案例

场景描述：构建一个简单的用户登录页面。Controller接收到请求后返回一个JSP或Thymeleaf页面，页面上包含一个表单，用户提交登录数据后服务器进行相应处理。

示例代码：

// 文件路径：com.example.demo.controller.LoginController.java

package com.example.demo.controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
@Controller
public class LoginController {
    // 展示登录页面
    @GetMapping("/login")
    public String showLoginPage() {
        // 返回视图名称，视图解析器将查找对应的login.html或login.jsp
        return "login";
    }
    // 处理登录请求
    @PostMapping("/login")
    public String processLogin(@RequestParam("username") String username,
                               @RequestParam("password") String password,
                               Model model) {
        // 简单的用户名和密码校验（示例场景，实际应用需更安全的处理）
        if("admin".equals(username) && "123456".equals(password)) {
            model.addAttribute("message", "登录成功！");
            return "welcome"; // 返回欢迎页视图
        } else {
            model.addAttribute("error", "用户名或密码错误！");
            return "login";  // 返回登录页以便重新登录
        }
    }
}

在上面的@Controller案例中：

5.2 使用@RestController构建RESTful API案例

场景描述：构建一个简单的用户信息查询API。请求接口返回JSON格式的用户数据，供前端或其他服务调用。

示例代码：

// 文件路径：com.example.demo.controller.UserApiController.java

package com.example.demo.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
import com.example.demo.model.User;
@RestController
public class UserApiController {
    // API接口：通过用户id查询用户信息并以JSON格式返回
    @GetMapping("/api/users/{id}")
    public User getUserById(@PathVariable("id") int id) {
        // 示例：构建一个用户对象，实际中可能通过数据库查询返回用户数据
        return new User(id, "User" + id);
    }
}

// 文件路径：com.example.demo/model/User.java

package com.example.demo.model;
public class User {
    private int id;
    private String name;
    public User() {}
    public User(int id, String name) {
        this.id = id;
        this.name = name;
    }
    // Getter和Setter
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

在上面的@RestController案例中：

5.3 对比代码结构及开发体验

总体来说：

6. 常见问题与解决方案

在开发过程中，使用@Controller和@RestController可能会遇到一些常见问题。下面列出几种常见场景及相应的解决方案和调试技巧。

6.1 两种注解混用时的注意点

6.2 JSON返回格式和页面解析的常见问题

6.3 多模块项目中使用的坑和调试技巧

到此这篇关于Java中@RestController和@Controller的使用区别解析的文章就介绍到这了,更多相关java @RestController和@Controller内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文