Spring Boot で Spring MVC を使用する方法

1.MVC

MVC は、アプリケーションのさまざまな部分を分離して疎結合と高い凝集性を実現するために使用される一般的なソフトウェア設計パターンです。 MVC パターンは 3 つのコア コンポーネントで構成されます。

• モデル: アプリケーションのデータとビジネス ロジックを表します。モデルはアプリケーションのデータを処理し、コントローラーの命令に基づいて対応する操作を実行します。

• View: モデル データのユーザー インターフェイスを提供します。ビューは通常、テンプレート、HTML ページ、XML ファイル、またはモデル データをユーザーに提示するその他の形式です。

• コントローラー: ユーザー操作を処理し、モデルとビューを更新します。コントローラーは、ビューからユーザー入力を受け取り、モデル上で対応する操作を実行し、変更を反映するためにビューを更新する責任があります。

MVC パターンの利点は、コードを 3 つの独立したコンポーネントに分離できるため、アプリケーションの保守と拡張が容易になることです。たとえば、ビューの外観を変更したい場合は、モデルとコントローラーに影響を与えずにビューを変更できます。データの保存方法を変更したい場合は、ビューとコントローラーに影響を与えずにモデルを変更できます。同時に、MVC パターンはアプリケーション内の結合を軽減し、各コンポーネントの独立性と再利用性を高めるのにも役立ちます。

2.Spring MVC

Spring システムの MVC アーキテクチャでリクエストを処理するプロセスは次のとおりです。

リクエストはコントローラー (コントローラー) に送信されます。 、ビジネス モデル (model ) を通じて、処理後に応答を認識層に返します。

Spring MVC はプロセス全体で何をしますか:

Spring MVC 全体のコアは DispatcherServlet であり、DispatcherServlet の周りに SpringMVC は一連のコンポーネントを提供します。 DispatcherServlet で完了する ワークフロー全体。

DispatcherServlet は最初にリクエストを受信し、そのリクエストを対応するプロセッサ (コントローラ) にマップします。コントローラにマップされると、インターセプタがトリガーされます。プロセッサが処理された後、データ モデルがカプセル化されて、ビュー パーサー データ モデルは対応するビューに解析され、フロント エンドに返されます。

もちろん、@RestController や @ResponseBody を使用した場合、画像が返されずに直接レスポンスが返されるなど、上記の処理が完了しない場合もあります。リダイレクトされるため、ビュー パーサーの使用方法を知る必要はありません。

3. Spring Boot での Spring MVC の使用

3.1. 設定

Spring Boot 自動アセンブリメカニズムが存在するため、一般的に Spring MVC を設定する必要はありません。特別にカスタマイズされた構成を実行する場合、Spring Boot は構成ファイルまたはコードの作成という 2 つの構成方法もサポートしています。

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 {};
}

各パラメータの機能は次のとおりです:

値とパス: リクエストの URL パスを指定するために使用され、プレースホルダーと正規表現を使用できます。

• method: HTTP リクエスト メソッド (GET、POST、PUT、DELETE など) を指定します。

• params: リクエストパラメータ、サポート式、複数パラメータ、論理演算の条件を指定します。

• headers: リクエスト ヘッダー、サポートされる式、複数のヘッダー、および論理演算の条件を指定します。

• consumes: 要求された MIME タイプを指定します。これは、要求のコンテンツ タイプを制限するために使用されます。

• 生成: 応答のコンテンツ タイプを制限するために使用される応答の MIME タイプを指定します。

• name: パラメーター値を自動的にバインドするために使用されるリクエスト パラメーターの名前を指定します。

• defaultValue: リクエストパラメータのデフォルト値を指定します。

• pathVariable: URL パス内のプレースホルダーをバインドするために使用されます。

• required: リクエストパラメータが必須かどうかを指定します。

• 値、メソッド、パラメータ、ヘッダー、属性の消費と生成はすべて配列形式をサポートしており、複数の条件に一致できます。

• #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 中国語 Web サイトの他の関連記事を参照してください。