Open Source Repository

Home /spring/spring-web-servlet-3.0.5 | Repository Home


org/springframework/web/servlet/mvc/support/ControllerClassNameHandlerMapping.java
/*
 * Copyright 2002-2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.web.servlet.mvc.support;

import org.springframework.util.ClassUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.mvc.multiaction.MultiActionController;

/**
 * Implementation of {@link org.springframework.web.servlet.HandlerMapping} that
 * follows a simple convention for generating URL path mappings from the <i>class names</i>
 * of registered {@link org.springframework.web.servlet.mvc.Controller} beans
 * as well as <code>@Controller</code> annotated beans.
 *
 <p>For simple {@link org.springframework.web.servlet.mvc.Controller} implementations
 * (those that handle a single request type), the convention is to take the
 {@link ClassUtils#getShortName short name} of the <code>Class</code>,
 * remove the 'Controller' suffix if it exists and return the remaining text, lower-cased,
 * as the mapping, with a leading <code>/</code>. For example:
 <ul>
 <li><code>WelcomeController</code> -> <code>/welcome*</code></li>
 <li><code>HomeController</code> -> <code>/home*</code></li>
 </ul>
 *
 <p>For {@link MultiActionController MultiActionControllers} and <code>@Controller</code>
 * beans, a similar mapping is registered, except that all sub-paths are registered
 * using the trailing wildcard pattern <code>/*</code>. For example:
 <ul>
 <li><code>WelcomeController</code> -> <code>/welcome</code><code>/welcome/*</code></li>
 <li><code>CatalogController</code> -> <code>/catalog</code><code>/catalog/*</code></li>
 </ul>
 *
 <p>For {@link MultiActionController} it is often useful to use
 * this mapping strategy in conjunction with the
 {@link org.springframework.web.servlet.mvc.multiaction.InternalPathMethodNameResolver}.
 *
 <p>Thanks to Warren Oliver for suggesting the "caseSensitive", "pathPrefix"
 * and "basePackage" properties which have been added in Spring 2.5.
 *
 @author Rob Harrop
 @author Juergen Hoeller
 @since 2.0
 @see org.springframework.web.servlet.mvc.Controller
 @see org.springframework.web.servlet.mvc.multiaction.MultiActionController
 */
public class ControllerClassNameHandlerMapping extends AbstractControllerUrlHandlerMapping {

  /**
   * Common suffix at the end of controller implementation classes.
   * Removed when generating the URL path.
   */
  private static final String CONTROLLER_SUFFIX = "Controller";


  private boolean caseSensitive = false;

  private String pathPrefix;

  private String basePackage;


  /**
   * Set whether to apply case sensitivity to the generated paths,
   * e.g. turning the class name "BuyForm" into "buyForm".
   <p>Default is "false", using pure lower case paths,
   * e.g. turning the class name "BuyForm" into "buyform".
   */
  public void setCaseSensitive(boolean caseSensitive) {
    this.caseSensitive = caseSensitive;
  }

  /**
   * Specify a prefix to prepend to the path generated from the controller name.
   <p>Default is a plain slash ("/"). A path like "/mymodule" can be specified
   * in order to have controller path mappings prefixed with that path, e.g.
   * "/mymodule/buyform" instead of "/buyform" for the class name "BuyForm".
   */
  public void setPathPrefix(String prefixPath) {
    this.pathPrefix = prefixPath;
    if (StringUtils.hasLength(this.pathPrefix)) {
      if (!this.pathPrefix.startsWith("/")) {
        this.pathPrefix = "/" this.pathPrefix;
      }
      if (this.pathPrefix.endsWith("/")) {
        this.pathPrefix = this.pathPrefix.substring(0this.pathPrefix.length() 1);
      }
    }
  }

  /**
   * Set the base package to be used for generating path mappings,
   * including all subpackages underneath this packages as path elements.
   <p>Default is <code>null</code>, using the short class name for the
   * generated path, with the controller's package not represented in the path.
   * Specify a base package like "com.mycompany.myapp" to include subpackages
   * within that base package as path elements, e.g. generating the path
   * "/mymodule/buyform" for the class name "com.mycompany.myapp.mymodule.BuyForm".
   * Subpackage hierarchies are represented as individual path elements,
   * e.g. "/mymodule/mysubmodule/buyform" for the class name
   * "com.mycompany.myapp.mymodule.mysubmodule.BuyForm".
   */
  public void setBasePackage(String basePackage) {
    this.basePackage = basePackage;
    if (StringUtils.hasLength(this.basePackage&& !this.basePackage.endsWith(".")) {
      this.basePackage = this.basePackage + ".";
    }
  }


  @Override
  protected String[] buildUrlsForHandler(String beanName, Class beanClass) {
    return generatePathMappings(beanClass);
  }

  /**
   * Generate the actual URL paths for the given controller class.
   <p>Subclasses may choose to customize the paths that are generated
   * by overriding this method.
   @param beanClass the controller bean class to generate a mapping for
   @return the URL path mappings for the given controller
   */
  protected String[] generatePathMappings(Class beanClass) {
    StringBuilder pathMapping = buildPathPrefix(beanClass);
    String className = ClassUtils.getShortName(beanClass);
    String path = (className.endsWith(CONTROLLER_SUFFIX?
        className.substring(0, className.lastIndexOf(CONTROLLER_SUFFIX)) : className);
    if (path.length() 0) {
      if (this.caseSensitive) {
        pathMapping.append(path.substring(01).toLowerCase()).append(path.substring(1));
      }
      else {
        pathMapping.append(path.toLowerCase());
      }
    }
    if (isMultiActionControllerType(beanClass)) {
      return new String[] {pathMapping.toString(), pathMapping.toString() "/*"};
    }
    else {
      return new String[] {pathMapping.toString() "*"};
    }
  }

  /**
   * Build a path prefix for the given controller bean class.
   @param beanClass the controller bean class to generate a mapping for
   @return the path prefix, potentially including subpackage names as path elements
   */
  private StringBuilder buildPathPrefix(Class beanClass) {
    StringBuilder pathMapping = new StringBuilder();
    if (this.pathPrefix != null) {
      pathMapping.append(this.pathPrefix);
      pathMapping.append("/");
    }
    else {
      pathMapping.append("/");
    }
    if (this.basePackage != null) {
      String packageName = ClassUtils.getPackageName(beanClass);
      if (packageName.startsWith(this.basePackage)) {
        String subPackage = packageName.substring(this.basePackage.length()).replace('.''/');
        pathMapping.append(this.caseSensitive ? subPackage : subPackage.toLowerCase());
        pathMapping.append("/");
      }
    }
    return pathMapping;
  }

}