草庐IT

java - 如何在 Spring MVC 中将请求映射到 HTML 文件?

coder 2023-05-17 原文

基本配置文件看起来不直观。

如果我创建简单的 hello world 示例,然后重命名 home.jsphome.html并编辑 servlet-context.xml文件来自

<beans:bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <beans:property name="prefix" value="/WEB-INF/views/" />
    <beans:property name="suffix" value=".jsp" />
</beans:bean> 


<beans:bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <beans:property name="prefix" value="/WEB-INF/views/" />
    <beans:property name="suffix" value=".html" />
</beans:bean>

我开始出错
WARN : org.springframework.web.servlet.PageNotFound - No mapping found for HTTP request with URI [/myapp/WEB-INF/views/home.html] in DispatcherServlet with name 'appServlet'

为什么?什么 suffix属性(property)是什么意思?

更新

我的 Controller 如下。如您所见,它不包含文件扩展名
@Controller
public class HomeController {

    private static final Logger logger = LoggerFactory.getLogger(HomeController.class);

    /**
     * Simply selects the home view to render by returning its name.
     */
    @RequestMapping(value = "/", method = RequestMethod.GET)
    public String home(Locale locale, Model model) {
        logger.info("Welcome home! The client locale is {}.", locale);

        Date date = new Date();
        DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.LONG, locale);

        String formattedDate = dateFormat.format(date);

        model.addAttribute("serverTime", formattedDate );

        return "home";
    }

}

最佳答案

问题背景

首先要理解的是:呈现jsp文件的不是spring。它是 JspServlet (org.apache.jasper.servlet.JspServlet) 做的。这个 servlet 带有 Tomcat(jasper 编译器)而不是 spring。这个 JspServlet 知道如何编译 jsp 页面以及如何将它作为 html 文本返回给客户端。 tomcat 中的 JspServlet 默认只处理匹配两种模式的请求:*.jsp 和 *.jspx。

现在,当 spring 使用 InternalResourceView 呈现 View 时(或 JstlView ),确实发生了三件事:

  • 从模型中获取所有模型参数(由 Controller 处理程序方法返回,即 "public ModelAndView doSomething() { return new ModelAndView("home") }" )
  • 将这些模型参数公开为请求属性(以便它可以被 JspServlet 读取)
  • 将请求转发到 JspServlet。 RequestDispatcher知道每个 *.jsp 请求都应该转发到 JspServlet(因为这是 tomcat 的默认配置)

  • 当您简单地将 View 名称更改为 home.html 时,tomcat 将不知道如何处理请求。这是因为没有 servlet 处理 *.html 请求。

    解决方案

    如何解决这个问题。最明显的解决方案有以下三种:
  • 将 html 公开为资源文件
  • 指示 JspServlet 也处理 *.html 请求
  • 编写您自己的 servlet(或将另一个现有的 servlet 请求传递给 *.html)。

  • 初始配置 (只处理jsp)

    首先假设我们在没有xml文件的情况下配置spring(仅基于@Configuration注解和spring的WebApplicationInitializer接口(interface))。

    基本配置如下
    public class MyWebApplicationContext extends AnnotationConfigWebApplicationContext {
      private static final String CONFIG_FILES_LOCATION = "my.application.root.config";
    
      public MyWebApplicationContext() {
        super();
        setConfigLocation(CONFIG_FILES_LOCATION);
      }
    
    }
    
    public class AppInitializer implements WebApplicationInitializer {
    
      @Override
      public void onStartup(ServletContext servletContext) throws ServletException {
        WebApplicationContext context = new MyWebApplicationContext();
        servletContext.addListener(new ContextLoaderListener(context));
    
        addSpringDispatcherServlet(servletContext, context);
    
      }
    
      private void addSpringDispatcherServlet(ServletContext servletContext, WebApplicationContext context) {
        ServletRegistration.Dynamic dispatcher = servletContext.addServlet("DispatcherServlet",
          new DispatcherServlet(context));
        dispatcher.setLoadOnStartup(2);
        dispatcher.addMapping("/");
        dispatcher.setInitParameter("throwExceptionIfNoHandlerFound", "true");
      }
    }
    
    package my.application.root.config
    // (...)
    
    @Configuration
    @EnableWebMvc
    public class WebConfig extends WebMvcConfigurerAdapter {
      @Autowired
      @Qualifier("jstlViewResolver")
      private ViewResolver jstlViewResolver;
    
      @Bean
      @DependsOn({ "jstlViewResolver" })
      public ViewResolver viewResolver() {
        return jstlViewResolver;
      }
    
      @Bean(name = "jstlViewResolver")
      public ViewResolver jstlViewResolver() {
        UrlBasedViewResolver resolver = new UrlBasedViewResolver();
        resolver.setPrefix("/WEB-INF/internal/");
        resolver.setViewClass(JstlView.class);
        resolver.setSuffix(".jsp");
        return resolver;
      }
    
    }
    

    在上面的示例中,我将 UrlBasedViewResolver 与支持 View 类 JSTLView 一起使用,但是您可以像在示例中一样使用 InternalResourceViewResolver,这无关紧要。

    上面的例子只配置了一个 View 解析器来处理以 .jsp 结尾的 jsp 文件的应用程序。 .注意:正如开头所说,JSTLView 确实使用了tomcat 的RequestDispatcher 将请求转发到JspSevlet 以将jsp 编译为html。

    解决方案 1 上的实现 - 将 html 公开为资源文件:

    我们修改 WebConfig 类以添加新的资源匹配。我们还需要修改 jSTLViewResolver 使其既不带前缀也不带后缀:
    @Configuration
    @EnableWebMvc
    public class WebConfig extends WebMvcConfigurerAdapter {
      @Autowired
      @Qualifier("jstlViewResolver")
      private ViewResolver jstlViewResolver;
    
      @Override
      public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/someurl/resources/**").addResourceLocations("/resources/");
    
      }
    
      @Bean
      @DependsOn({ "jstlViewResolver" })
      public ViewResolver viewResolver() {
        return jstlViewResolver;
      }
    
      @Bean(name = "jstlViewResolver")
      public ViewResolver jstlViewResolver() {
        UrlBasedViewResolver resolver = new UrlBasedViewResolver();
        resolver.setPrefix(""); // NOTE: no prefix here
        resolver.setViewClass(JstlView.class);
        resolver.setSuffix(""); // NOTE: no suffix here
        return resolver;
      }
    
    // NOTE: you can use InternalResourceViewResolver it does not matter 
    //  @Bean(name = "internalResolver")
    //  public ViewResolver internalViewResolver() {
    //    InternalResourceViewResolver resolver = new InternalResourceViewResolver();
    //    resolver.setPrefix("");
    //    resolver.setSuffix("");
    //    return resolver;
    //  }
    }
    

    通过添加这个,我们说每一个请求去http://my.server/someurl/resources/映射到您的 web 目录下的资源目录。因此,如果您将 home.html 放在资源目录中并将浏览器指向 http://my.server/someurl/resources/home.html该文件将被送达。要由您的 Controller 处理此问题,您可以返回资源的完整路径:
    @Controller
    public class HomeController {
    
        @RequestMapping(value = "/", method = RequestMethod.GET)
        public ModelAndView home(Locale locale, Model model) {
            // (...)
    
            return new ModelAndView("/someurl/resources/home.html"); // NOTE here there is /someurl/resources
        }
    
    }
    

    如果你把一些jsp文件(不仅仅是*.html文件)放在同一个目录下,比如说home_dynamic.jsp放在同一个资源目录中,你可以用类似的方式访问它,但你需要使用服务器上的实际路径。该路径不以/someurl/开头,因为这是仅适用于以 .html 结尾的 html 资源的映射)。在这种情况下,jsp 是动态资源,最终由 JspServlet 使用磁盘上的实际路径访问。所以访问jsp的正确方法是:
    @Controller
    public class HomeController {
    
        @RequestMapping(value = "/", method = RequestMethod.GET)
        public ModelAndView home(Locale locale, Model model) {
            // (...)
    
            return new ModelAndView("/resources/home_dynamic.jsp"); // NOTE here there is /resources (there is no /someurl/ because "someurl" is only for static resources 
    
    }
    

    要在基于 xml 的配置中实现这一点,您需要使用:
    <mvc:resources mapping="/someurl/resources/**" location="/resources/" />
    

    并修改您的 jSTL View 解析器:
    <beans:bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <!-- Please NOTE that it does not matter if you use InternalResourceViewResolver or UrlBasedViewResolver as in annotations example -->
        <beans:property name="prefix" value="" />
        <beans:property name="suffix" value="" />
    </beans:bean>
    

    解决方案 2 上的实现 :

    在这个选项中,我们使用 tomcat 的 JspServlet 来处理静态文件。因此,您可以在您的 html 文件中使用 jsp 标签:) 当然,您是否这样做是您的选择。很可能您想使用纯 html,所以不要使用 jsp 标签,内容将被视为静态 html。

    首先,我们删除 View 解析器的前缀和后缀,如上例所示:
    @Configuration
    @EnableWebMvc
    public class WebConfig extends WebMvcConfigurerAdapter {
      @Autowired
      @Qualifier("jstlViewResolver")
      private ViewResolver jstlViewResolver;
    
      @Bean
      @DependsOn({ "jstlViewResolver" })
      public ViewResolver viewResolver() {
        return jstlViewResolver;
      }
    
      @Bean(name = "jstlViewResolver")
      public ViewResolver jstlViewResolver() {
        InternalResourceViewResolver resolver = new InternalResourceViewResolver(); // NOTE: this time I'm using InternalResourceViewResolver and again it does not matter :)
        resolver.setPrefix("");
        resolver.setSuffix("");
        return resolver;
      }
    
    }
    

    现在我们添加 JspServlet 来处理 *.html 文件:
    public class AppInitializer implements WebApplicationInitializer {
    
      @Override
      public void onStartup(ServletContext servletContext) throws ServletException {
        WebApplicationContext context = new MyWebApplicationContext();
        servletContext.addListener(new ContextLoaderListener(context));
    
        addStaticHtmlFilesHandlingServlet(servletContext);
        addSpringDispatcherServlet(servletContext, context);
    
      }
    
     // (...)
    
      private void addStaticHtmlFilesHandlingServlet(ServletContext servletContext) {
        ServletRegistration.Dynamic servlet = servletContext.addServlet("HtmlsServlet", new JspServlet()); // org.apache.jasper.servlet.JspServlet
        servlet.setLoadOnStartup(1);
        servlet.addMapping("*.html");
      }
    
    }
    

    重要的是,要使这个类可用,您需要从 tomcat 的安装中添加 jasper.jar,仅用于编译时间。如果你有 maven 应用程序,这真的很容易通过使用为 jar 提供的 scope=provided。 Maven 中的依赖项如下所示:
    <dependency>
        <groupId>org.apache.tomcat</groupId>
        <artifactId>tomcat-jasper</artifactId>
        <version>${tomcat.libs.version}</version>
        <scope>provided</scope> <!--- NOTE: scope provided! -->
    </dependency>
    <dependency>
        <groupId>org.apache.tomcat</groupId>
        <artifactId>tomcat-jsp-api</artifactId>
        <version>${tomcat.libs.version}</version>
        <scope>provided</scope>
    </dependency>
    

    如果你想以xml方式进行。您需要注册 jsp servlet 来处理 *.html 请求,因此您需要将以下条目添加到您的 web.xml
    <servlet>
        <servlet-name>htmlServlet</servlet-name>
        <servlet-class>org.apache.jasper.servlet.JspServlet</servlet-class>
        <load-on-startup>3</load-on-startup>
    </servlet>
    
    <servlet-mapping>
        <servlet-name>htmlServlet</servlet-name>
        <url-pattern>*.html</url-pattern>
    </servlet-mapping>
    

    现在在您的 Controller 中,您可以像前面的示例一样访问 html 和 jsp 文件。优点是没有解决方案 1 中所需的“/someurl/”额外映射。您的 Controller 将如下所示:
    @Controller
    public class HomeController {
    
        @RequestMapping(value = "/", method = RequestMethod.GET)
        public ModelAndView home(Locale locale, Model model) {
            // (...)
    
            return new ModelAndView("/resources/home.html"); 
    
    }
    

    要指向您的 jsp,您正在做完全相同的事情:
    @Controller
    public class HomeController {
    
        @RequestMapping(value = "/", method = RequestMethod.GET)
        public ModelAndView home(Locale locale, Model model) {
            // (...)
    
            return new ModelAndView("/resources/home_dynamic.jsp");
    
    }
    

    解决方案 3 上的实现 :

    第三个解决方案有点像解决方案 1 和解决方案 2 的组合。所以在这里我们希望将所有对 *.html 的请求传递给其他一些 servlet。您可以编写自己的或寻找现有 servlet 的一些好的候选者。

    如上所述,首先我们清理 View 解析器的前缀和后缀:
    @Configuration
    @EnableWebMvc
    public class WebConfig extends WebMvcConfigurerAdapter {
      @Autowired
      @Qualifier("jstlViewResolver")
      private ViewResolver jstlViewResolver;
    
      @Bean
      @DependsOn({ "jstlViewResolver" })
      public ViewResolver viewResolver() {
        return jstlViewResolver;
      }
    
      @Bean(name = "jstlViewResolver")
      public ViewResolver jstlViewResolver() {
        InternalResourceViewResolver resolver = new InternalResourceViewResolver(); // NOTE: this time I'm using InternalResourceViewResolver and again it does not matter :)
        resolver.setPrefix("");
        resolver.setSuffix("");
        return resolver;
      }
    
    }
    

    现在我们不再使用 tomcat 的 JspServlet,而是编写我们自己的 servlet(或重用一些现有的):
    public class StaticFilesServlet extends HttpServlet {
      @Override
      protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        response.setCharacterEncoding("UTF-8");
    
        String resourcePath = request.getRequestURI();
        if (resourcePath != null) {
          FileReader reader = null;
          try {
            URL fileResourceUrl = request.getServletContext().getResource(resourcePath);
            String filePath = fileResourceUrl.getPath();
    
            if (!new File(filePath).exists()) {
              throw new IllegalArgumentException("Resource can not be found: " + filePath);
            }
            reader = new FileReader(filePath);
    
            int c = 0;
            while (c != -1) {
              c = reader.read();
              if (c != -1) {
                response.getWriter().write(c);
              }
            }
    
          } finally {
            if (reader != null) {
              reader.close();
            }
          }
        }
      }
    }
    

    我们现在指示 spring 将所有对 *.html 的请求传递给我们的 servlet
    public class AppInitializer implements WebApplicationInitializer {
    
      @Override
      public void onStartup(ServletContext servletContext) throws ServletException {
        WebApplicationContext context = new MyWebApplicationContext();
        servletContext.addListener(new ContextLoaderListener(context));
    
        addStaticHtmlFilesHandlingServlet(servletContext);
        addSpringDispatcherServlet(servletContext, context);
    
      }
    
     // (...)
    
      private void addStaticHtmlFilesHandlingServlet(ServletContext servletContext) {
        ServletRegistration.Dynamic servlet = servletContext.addServlet("HtmlsServlet", new StaticFilesServlet());
        servlet.setLoadOnStartup(1);
        servlet.addMapping("*.html");
    
      }
    
    }
    

    优点(或缺点,取决于你想要什么)是 jsp 标签显然不会被处理。您的 Controller 看起来像往常一样:
    @Controller
    public class HomeController {
    
        @RequestMapping(value = "/", method = RequestMethod.GET)
        public ModelAndView home(Locale locale, Model model) {
            // (...)
    
            return new ModelAndView("/resources/home.html");
    
    }
    

    而对于jsp:
    @Controller
    public class HomeController {
    
        @RequestMapping(value = "/", method = RequestMethod.GET)
        public ModelAndView home(Locale locale, Model model) {
            // (...)
    
            return new ModelAndView("/resources/home_dynamic.jsp");
    
    }
    

    关于java - 如何在 Spring MVC 中将请求映射到 HTML 文件?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/16598594/

    有关java - 如何在 Spring MVC 中将请求映射到 HTML 文件?的更多相关文章

    1. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

      我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

    2. ruby - 其他文件中的 Rake 任务 - 2

      我试图在一个项目中使用rake,如果我把所有东西都放到Rakefile中,它会很大并且很难读取/找到东西,所以我试着将每个命名空间放在lib/rake中它自己的文件中,我添加了这个到我的rake文件的顶部:Dir['#{File.dirname(__FILE__)}/lib/rake/*.rake'].map{|f|requiref}它加载文件没问题,但没有任务。我现在只有一个.rake文件作为测试,名为“servers.rake”,它看起来像这样:namespace:serverdotask:testdoputs"test"endend所以当我运行rakeserver:testid时

    3. ruby - 如何在 Ruby 中顺序创建 PI - 2

      出于纯粹的兴趣,我很好奇如何按顺序创建PI,而不是在过程结果之后生成数字,而是让数字在过程本身生成时显示。如果是这种情况,那么数字可以自行产生,我可以对以前看到的数字实现垃圾收集,从而创建一个无限系列。结果只是在Pi系列之后每秒生成一个数字。这是我通过互联网筛选的结果:这是流行的计算机友好算法,类机器算法:defarccot(x,unity)xpow=unity/xn=1sign=1sum=0loopdoterm=xpow/nbreakifterm==0sum+=sign*(xpow/n)xpow/=x*xn+=2sign=-signendsumenddefcalc_pi(digits

    4. ruby-on-rails - 在 Rails 中将文件大小字符串转换为等效千字节 - 2

      我的目标是转换表单输入,例如“100兆字节”或“1GB”,并将其转换为我可以存储在数据库中的文件大小(以千字节为单位)。目前,我有这个:defquota_convert@regex=/([0-9]+)(.*)s/@sizes=%w{kilobytemegabytegigabyte}m=self.quota.match(@regex)if@sizes.include?m[2]eval("self.quota=#{m[1]}.#{m[2]}")endend这有效,但前提是输入是倍数(“gigabytes”,而不是“gigabyte”)并且由于使用了eval看起来疯狂不安全。所以,功能正常,

    5. ruby-on-rails - Rails 3 中的多个路由文件 - 2

      Rails2.3可以选择随时使用RouteSet#add_configuration_file添加更多路由。是否可以在Rails3项目中做同样的事情? 最佳答案 在config/application.rb中:config.paths.config.routes在Rails3.2(也可能是Rails3.1)中,使用:config.paths["config/routes"] 关于ruby-on-rails-Rails3中的多个路由文件,我们在StackOverflow上找到一个类似的问题

    6. ruby - 将差异补丁应用于字符串/文件 - 2

      对于具有离线功能的智能手机应用程序,我正在为Xml文件创建单向文本同步。我希望我的服务器将增量/差异(例如GNU差异补丁)发送到目标设备。这是计划:Time=0Server:hasversion_1ofXmlfile(~800kiB)Client:hasversion_1ofXmlfile(~800kiB)Time=1Server:hasversion_1andversion_2ofXmlfile(each~800kiB)computesdeltaoftheseversions(=patch)(~10kiB)sendspatchtoClient(~10kiBtransferred)Cl

    7. ruby - 使用 ruby​​ 将 HTML 转换为纯文本并维护结构/格式 - 2

      我想将html转换为纯文本。不过,我不想只删除标签,我想智能地保留尽可能多的格式。为插入换行符标签,检测段落并格式化它们等。输入非常简单,通常是格式良好的html(不是整个文档,只是一堆内容,通常没有anchor或图像)。我可以将几个正则表达式放在一起,让我达到80%,但我认为可能有一些现有的解决方案更智能。 最佳答案 首先,不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案,它会随着HTML的变化而崩溃,或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

    8. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

      我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

    9. ruby - 如何在 buildr 项目中使用 Ruby 代码? - 2

      如何在buildr项目中使用Ruby?我在很多不同的项目中使用过Ruby、JRuby、Java和Clojure。我目前正在使用我的标准Ruby开发一个模拟应用程序,我想尝试使用Clojure后端(我确实喜欢功能代码)以及JRubygui和测试套件。我还可以看到在未来的不同项目中使用Scala作为后端。我想我要为我的项目尝试一下buildr(http://buildr.apache.org/),但我注意到buildr似乎没有设置为在项目中使用JRuby代码本身!这看起来有点傻,因为该工具旨在统一通用的JVM语言并且是在ruby中构建的。除了将输出的jar包含在一个独特的、仅限ruby​​

    10. ruby - 什么是填充的 Base64 编码字符串以及如何在 ruby​​ 中生成它们? - 2

      我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案 他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%

    随机推荐