Support serving static assets from src/main/resources/public (GRAILS-12096)

Author: graemerocher

grails-core/src/main/groovy/grails/config/Settings.groovy

@@ -137,4 +137,14 @@ interface Settings {
      * The suffix used during scaffolding for the domain
      */
     String SCAFFOLDING_DOMAIN_SUFFIX = 'grails.scaffolding.templates.domainSuffix'
+
+    /**
+     * The amount of time to cache static resource requests
+     */
+    String RESOURCES_CACHE_PERIOD = 'grails.resources.cachePeriod'
+
+    /**
+     * Whether serving static HTML pages from src/main/resources/public is enabled
+     */
+    String RESOURCES_ENABLED = 'grails.resources.enabled'
 }

grails-plugin-controllers/src/main/groovy/org/grails/plugins/web/controllers/ControllersGrailsPlugin.groovy

@@ -21,6 +21,7 @@ import grails.core.support.GrailsApplicationAware
 import grails.plugins.Plugin
 import grails.util.Environment
 import grails.util.GrailsUtil
+import groovy.transform.CompileStatic
 import groovy.util.logging.Commons
 import org.grails.core.artefact.ControllerArtefactHandler
 import org.grails.plugins.web.servlet.context.BootStrapClassRunner
@@ -38,6 +39,8 @@ import org.springframework.core.Ordered
 import org.springframework.util.ClassUtils
 import org.springframework.web.filter.CharacterEncodingFilter
 import org.springframework.web.multipart.support.StandardServletMultipartResolver
+import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter
 import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter
 import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping
 import org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator
@@ -73,6 +76,8 @@ class ControllersGrailsPlugin extends Plugin {
         def filtersEncoding = config.getProperty(Settings.FILTER_ENCODING, 'utf-8')
         boolean dbConsoleEnabled = config.getProperty(Settings.DBCONSOLE_ENABLED, Boolean, Environment.current == Environment.DEVELOPMENT)
 
+        int resourcesCachePeriod = config.getProperty(Settings.RESOURCES_CACHE_PERIOD, Integer, 0)
+        boolean resourcesEnabled = config.getProperty(Settings.RESOURCES_ENABLED, Boolean, true)
 
         bootStrapClassRunner(BootStrapClassRunner)
         tokenResponseActionResultTransformer(TokenResponseActionResultTransformer)
@@ -126,6 +131,9 @@ class ControllersGrailsPlugin extends Plugin {
         annotationHandlerMapping(RequestMappingHandlerMapping, interceptorsClosure)
         annotationHandlerAdapter(RequestMappingHandlerAdapter)
 
+        // add Grails webmvc config
+        webMvcConfig(GrailsWebMvcConfigurer, resourcesCachePeriod, resourcesEnabled)
+
         // add the dispatcher servlet
         dispatcherServlet(GrailsDispatcherServlet)
         dispatcherServletRegistration(ServletRegistrationBean, ref("dispatcherServlet"), "/*") {
@@ -191,5 +199,51 @@ class ControllersGrailsPlugin extends Plugin {
     }
 
 
+    @CompileStatic
+    static class GrailsWebMvcConfigurer extends WebMvcConfigurerAdapter {
+
+        private static final String[] SERVLET_RESOURCE_LOCATIONS = [ "/" ]
+
+        private static final String[] CLASSPATH_RESOURCE_LOCATIONS = [
+            "classpath:/META-INF/resources/", "classpath:/resources/",
+            "classpath:/static/", "classpath:/public/" ]
+
+        private static final String[] RESOURCE_LOCATIONS
+        static {
+            RESOURCE_LOCATIONS = new String[CLASSPATH_RESOURCE_LOCATIONS.length
+                    + SERVLET_RESOURCE_LOCATIONS.length]
+            System.arraycopy(SERVLET_RESOURCE_LOCATIONS, 0, RESOURCE_LOCATIONS, 0,
+                    SERVLET_RESOURCE_LOCATIONS.length)
+            System.arraycopy(CLASSPATH_RESOURCE_LOCATIONS, 0, RESOURCE_LOCATIONS,
+                    SERVLET_RESOURCE_LOCATIONS.length, CLASSPATH_RESOURCE_LOCATIONS.length);
+        }
+
+        boolean addMappings = true
+        Integer cachePeriod
+
+        GrailsWebMvcConfigurer(Integer cachePeriod, boolean addMappings = true) {
+            this.addMappings = addMappings
+            this.cachePeriod = cachePeriod
+        }
+
+        @Override
+        @Override
+        public void addResourceHandlers(ResourceHandlerRegistry registry) {
+            if (!addMappings) {
+                return
+            }
+
+            if (!registry.hasMappingForPattern("/webjars/**")) {
+                registry.addResourceHandler("/webjars/**")
+                        .addResourceLocations("classpath:/META-INF/resources/webjars/")
+                        .setCachePeriod(cachePeriod)
+            }
+            if (!registry.hasMappingForPattern("/**")) {
+                registry.addResourceHandler("/**")
+                        .addResourceLocations(RESOURCE_LOCATIONS)
+                        .setCachePeriod(cachePeriod)
+            }
+        }
+    }
 
 }