首頁 > Java > java教程 > 主體

Spring Boot中怎麼使用Spring MVC

王林
發布: 2023-05-15 14:04:06
轉載
1971 人瀏覽過

1.MVC

MVC 是一種常見的軟體設計模式,用於分離應用程式的不同部分以實現鬆散耦合和高內聚性。 MVC 模式由三個核心元件組成:

  • 模型(Model):表示應用程式的資料和業務邏輯。模型處理應用程式的數據,並根據控制器的指令執行相應的操作。

  • 視圖(View):提供模型資料的使用者介面。視圖通常是範本、HTML 頁面、XML 檔案或其他格式,可以呈現模型資料給使用者。

  • 控制器(Controller):處理使用者互動並更新模型和視圖。控制器負責接收來自視圖的使用者輸入,對模型進行相應的操作,並更新視圖以反映變更。

MVC 模式的優點是可以將程式碼分離成三個獨立的元件,使得應用程式更容易維護和擴展。例如,如果要變更視圖的外觀,可以修改視圖而不影響模型和控制器;如果要變更資料儲存方式,可以修改模型而不影響視圖和控制器。同時,MVC 模式也有助於降低應用程式中的耦合度,使得各元件更獨立且可重複使用。

2.Spring MVC

在Spring體系下的MVC架構中一次請求處理的流程如下:

請求到控制器(controller),經過業務模型(model )處理後返回響應給識圖層。

Spring Boot中怎麼使用Spring MVC

整個流程裡面Spring MVC乾了些啥:

整個Spring MVC的核心是DispatcherServlet,圍繞DispatcherServlet SpringMVC提供了一套元件配合DispatcherServlet完成整個工作流程。

DispatcherServlet 先收到請求,將請求對應到對應的處理器(controller)上,對應到controller的時候會觸發攔截器;處理器處理完後封裝資料模型,交給視圖解析器將資料模型解析為對應的視圖傳回給前端。

Spring Boot中怎麼使用Spring MVC

當然有時候以上流程不會全部走完,例如使用@RestController或@ResponseBody的時候由於直接回傳回應了,不會轉跳識圖,所以不會走視圖解析器。

3.Spring Boot中使用Spring MVC

3.1.配置

因為Spring Boot自動組裝機制的存在,一般來說我們不需要對Spring MVC進行配置,如果要進行特別客製化的配置,Spring Boot也支援設定檔或編寫程式碼的兩種方式來進行配置。

3.1.1.檔案設定

# 啟用Spring MVC
spring.mvc.enabled=true

# 設定靜態資源路徑
spring .mvc.static-path-pattern=/static/**
spring.resources.static-locations=classpath:/static/

# 設定視圖解析器
spring.mvc.view. prefix=/WEB-INF/views/
spring.mvc.view.suffix=.jsp

# 設定HTTP快取
spring.resources.cache.period=3600

# 設定檔上傳
spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=10MB

## 設定JSON序列化
spring.jackson.serialization.indent_output=true
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss

# 設定異常處理
server.error.whitelabel.enabled =false

# 配置攔截器
spring.mvc.interceptor.exclude-path-patterns=/login,/logout
spring.mvc.interceptor.include-path-patterns=/admin/ **

# 設定會話管理
server.session.timeout=1800
server.session.cookie.max-age=1800

3.1.2.程式碼設定
@Configuration
public class MyWebMvcConfig implements WebMvcConfigurer {
 
    // 配置视图解析器
    @Override
    public void configureViewResolvers(ViewResolverRegistry registry) {
        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setPrefix("/WEB-INF/views/");
        resolver.setSuffix(".jsp");
        registry.viewResolver(resolver);
    }
 
    // 配置静态资源
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**").addResourceLocations("/static/");
    }
 
    // 配置拦截器
    @Autowired
    private MyInterceptor myInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor).addPathPatterns("/**");
    }
 
    // 配置消息转换器
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        List<MediaType> supportedMediaTypes = new ArrayList<MediaType>();
        supportedMediaTypes.add(MediaType.APPLICATION_JSON);
        converter.setSupportedMediaTypes(supportedMediaTypes);
        converters.add(converter);
    }
 
    // 配置异常处理器
    @ControllerAdvice
    public class GlobalExceptionHandler {
        @ExceptionHandler(value = Exception.class)
        public ModelAndView handleException(HttpServletRequest req, Exception e) {
            ModelAndView mav = new ModelAndView();
            mav.addObject("exception", e);
            mav.addObject("url", req.getRequestURL());
            mav.setViewName("error");
            return mav;
        }
    }
 
    // 配置跨域资源共享(CORS)
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/api/**").allowedOrigins("http://localhost:8080");
    }
 
    // 配置文件上传
    @Bean
    public MultipartResolver multipartResolver() {
        CommonsMultipartResolver resolver = new CommonsMultipartResolver();
        resolver.setMaxUploadSize(10485760);
        resolver.setMaxInMemorySize(4096);
        return resolver;
    }
 
    // 配置请求缓存
    @Bean
    public KeyGenerator keyGenerator() {
        return new DefaultKeyGenerator();
    }
 
    @Bean
    public RequestCache requestCache() {
        return new HttpSessionRequestCache();
    }
 
    // 配置视图控制器
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("index");
        registry.addViewController("/login").setViewName("login");
    }
}
登入後複製

3.2.使用

3.2.1.映射處理器

這裡只介紹@RequestMapping,@GETMapping和@PostMapping類似。

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
	
    String name() default "";
    
    @AliasFor("path")
    String[] value() default {};
	
    @AliasFor("value")
    String[] path() default {};
 
    RequestMethod[] method() default {};
 
    String[] params() default {};
 
    String[] headers() default {};
 
    String[] consumes() default {};
 
    String[] produces() default {};
}
登入後複製

各參數的作用如下:

  • value和path:用於指定請求的URL路徑,可以使用佔位符和正規表示式。

  • method:指定HTTP請求方法,可以是GET、POST、PUT、DELETE等。

  • params:指定請求參數的條件,支援表達式、多個參數和邏輯運算。

  • headers:指定請求頭的條件,支援表達式、多個頭和邏輯運算。

  • consumes:指定請求的MIME類型,用於限制請求內容類型。

  • produces:指定回應的MIME類型,用於限制回應內容類型。

  • name:指定請求參數的名稱,用於自動綁定參數值。

  • defaultValue:指定請求參數的預設值。

  • pathVariable:用來綁定URL路徑中的佔位符。

  • required:指定請求參數是否為必須的。

  • value、method、params、headers、consumes和produces屬性都支援陣列形式,可以符合多個條件。

3.2.2.傳參

1.依參數名稱匹配

@Controller
@RequestMapping("/user")
public class UserController {
    
    @RequestMapping("/info")
    public String getUserInfo(Integer userId, Model model) {
        // 根据用户ID查询用户信息并返回
        User user = userService.getUserById(userId);
        model.addAttribute("user", user);
        return "user_info";
    }
}
登入後複製

URL:

ip:port/info?userId=1

2.@RequestParam

#

通过@RequestParam注解可以指定匹配的参数.

@Controller
@RequestMapping("/user")
public class UserController {
    
    @RequestMapping(value = "/search", method = RequestMethod.GET, params = "keyword")
    public String searchUser(@RequestParam("keyword") String keyword, Model model) {
        // 根据关键词查询用户信息并返回
        List<User> userList = userService.searchUser(keyword);
        model.addAttribute("userList", userList);
        return "user_list";
    }
}
登入後複製

3.传数组

@RequestMapping("/delete")
public String deleteUsers(int[] userIds, Model model) {
    // 根据用户ID数组删除多个用户,并返回用户列表页面
    userService.deleteUsers(userIds);
    List<User> userList = userService.getUserList();
    model.addAttribute("userList", userList);
    return "user_list";
}
登入後複製

4.传JSON

传JSON只能用POST方法,使用@ResponseBody注解参数列表中的参数,就可以用来接收JSON,如果被注解的参数是个对象那么会将JSON自动转化为改对象。

@RequestMapping(value = "/save", method = RequestMethod.POST)
@ResponseBody
public Map<String, Object> saveUser(@RequestBody User user) {
    // 保存用户信息,并返回成功的响应
    userService.saveUser(user);
    return Collections.singletonMap("success", true);
}
登入後複製

注意传参的时候要将设置好contentType: "application/json"

5.Restful

@Controller
@RequestMapping("/user")
public class UserController {
    
    @RequestMapping("/info/{id}")
    public String getUserInfo(@PathVariable("id") Integer userId, Model model) {
        // 根据用户ID查询用户信息并返回
        User user = userService.getUserById(userId);
        model.addAttribute("user", user);
        return "user_info";
    }
}
登入後複製

前端URL为:

ip:port/info/1

3.2.3.参数转换

当后端接口的参数列表是对象类型时,Spring MVC会自动按照参数名完成参数的转换和填充,当然这种转化规则也可以由我们自己定义,Spring MVC为我们准备了转换接口,以下是一个完整示例:

实体对象:

public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
    // 省略 getter 和 setter 方法
}
登入後複製

参数转换器:

public class UserConverter implements Converter<String, User> {
 
    @Override
    public User convert(String source) {
        // 将请求参数解析为User对象
        String[] values = source.split(",");
        User user = new User();
        user.setId(Long.parseLong(values[0]));
        user.setName(values[1]);
        user.setAge(Integer.parseInt(values[2]));
        user.setEmail(values[3]);
        return user;
    }
}
登入後複製

注册参数转换器:

@Configuration
public class WebConfig implements WebMvcConfigurer {
 
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new UserConverter());
    }
}
登入後複製

以后再传对应类型的参数时,会用我们自定义的转换规则来进行转换:

@RequestMapping(value = "/save", method = RequestMethod.POST)
@ResponseBody
public Map<String, Object> saveUser(User user) {
    // 保存用户信息,并返回成功的响应
    userService.saveUser(user);
    return Collections.singletonMap("success", true);
}
登入後複製
3.2.4.数据校验

有时候我们希望前端传过来的参数是满足一定格式的,Spring MVC也考虑到了这一点,为我们提供了基于注解的参数校验功能。

public class User {
    @NotNull(message = "id不能为空")
    private Long id;
 
    @NotBlank(message = "name不能为空")
    private String name;
 
    @Min(value = 0, message = "age不能小于0")
    @Max(value = 150, message = "age不能大于150")
    private Integer age;
 
    @Email(message = "email格式不正确")
    private String email;
 
    // 省略 getter 和 setter 方法
}
登入後複製
登入後複製

只是使用了注解,校验并不会生效,还需要在想要进行校验的地方配上@Validated开启校验:

public class User {
    @NotNull(message = "id不能为空")
    private Long id;
 
    @NotBlank(message = "name不能为空")
    private String name;
 
    @Min(value = 0, message = "age不能小于0")
    @Max(value = 150, message = "age不能大于150")
    private Integer age;
 
    @Email(message = "email格式不正确")
    private String email;
 
    // 省略 getter 和 setter 方法
}
登入後複製
登入後複製
3.2.5.数据模型

Spring MVC 中的数据模型用于在处理器方法(Controller)和视图之间传递数,有三种:

  • Model

  • ModelMap

  • ModelAndView

Model:

只能承载参数

@GetMapping("/hello")
public String hello(Model model) {
    model.addAttribute("message", "Hello, world!");
    return "hello";
}
登入後複製

ModelMap:

和Model功能相似。

@GetMapping("/hello")
public String hello(ModelMap model) {
    model.put("message", "Hello, world!");
    return "hello";
}
登入後複製

ModelAndView:

既能承载参数也能承载视图名。

@GetMapping("/hello")
public ModelAndView hello() {
    ModelAndView mav = new ModelAndView("hello");
    mav.addObject("message", "Hello, world!");
    return mav;
}
登入後複製
3.2.6.视图和解析器

1.视图

Spring MVC的视图可以理解为最终返给前端的东西,分为两类:

  • 逻辑视图

  • 非逻辑视图

逻辑视图:

逻辑视图是指一个字符串,它代表了一个视图的逻辑名称,与实际的视图实现解耦合,而是通过视图解析器将其映射为实际的视图。在 Spring MVC 中,处理器方法可以返回逻辑视图名,由 DispatcherServlet 根据视图解析器的配置,将其映射为实际的视图。

常用的逻辑视图包括:

  • JSP 视图:使用 InternalResourceViewResolver 视图解析器,将逻辑视图名映射为 JSP 文件名。

  • Velocity 视图:使用 VelocityViewResolver 视图解析器,将逻辑视图名映射为 Velocity 模板文件名。

  • Thymeleaf 视图:使用 ThymeleafViewResolver 视图解析器,将逻辑视图名映射为 Thymeleaf 模板文件名。

非逻辑视图:

非逻辑视图是指一个具体的视图实现,通常是一个视图类或者一个 RESTful Web Service。在处理器方法中,可以直接返回一个非逻辑视图,它会被直接渲染,而不需要通过视图解析器进行转换。

常用的非逻辑视图包括:

  • JSON 视图:使用 MappingJackson2JsonView 视图实现,将模型数据转换为 JSON 格式返回给客户端。

  • XML 视图:使用 MappingJackson2XmlView 视图实现,将模型数据转换为 XML 格式返回给客户端。

  • PDF 视图:使用 iText PDF 库和 AbstractPdfView 视图实现,将模型数据转换为 PDF 格式返回给客户端。

需要注意的是,非逻辑视图通常需要进行额外的配置和处理,比如 JSON 视图需要添加 Jackson 依赖库,并在 Spring 配置文件中配置 MappingJackson2JsonView 视图解析器。

2.视图解析器

视图解析器决定@Controller的return具体映射到什么类型的视图上,默认是使用InternalResourceViewResolver视图解析器,也就是JSP视图解析器,当我们配置好前缀、后缀后,它会自动将@Controller的return映射到对应的jsp上去。

spring.mvc.view.prefix=/WEB-INF/views/
spring.mvc.view.suffix=.jsp

当然在Spring Boot中也支持我们切换视图解析器,以下是切换为JSON视图解析器的示例,切换为JSON视图解析器后return会直接返回JSON给前端:

@Configuration
@EnableWebMvc
public class AppConfig implements WebMvcConfigurer {
 
    @Bean
    public ViewResolver viewResolver() {
        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setPrefix("/WEB-INF/views/");
        resolver.setSuffix(".jsp");
        return resolver;
    }
}
登入後複製
3.2.7.拦截器

Spring Boot中使用自定义Spring MVC拦截器链的代码如下:

@Configuration
public class WebConfig implements WebMvcConfigurer {
    
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new FirstInterceptor());
        registry.addInterceptor(new SecondInterceptor());
    }
}
 
public class FirstInterceptor implements HandlerInterceptor {
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        // 在处理器处理请求之前执行
        return true;
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        // 在处理器处理请求之后,渲染视图之前执行
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
            Exception ex) throws Exception {
        // 在渲染视图之后执行
    }
}
 
public class SecondInterceptor implements HandlerInterceptor {
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        // 在处理器处理请求之前执行
        return true;
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        // 在处理器处理请求之后,渲染视图之前执行
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
            Exception ex) throws Exception {
        // 在渲染视图之后执行
    }
}
登入後複製

以上是Spring Boot中怎麼使用Spring MVC的詳細內容。更多資訊請關注PHP中文網其他相關文章!

來源:yisu.com
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板