回顾
上一篇笔者创建了一个简单的web服务，但是因为前后端路径不一致导致很难实现一个servlet处理并分发所有的url请求。不过好在struts2、SpringMVC等框架已经帮我们实现了这个功能。在这一篇中笔者将尝试用SpringMVC来改造之前的项目。
环境
- Spring MVC：5.1.5
- Tomcat：9.0.16
- Maven：3.6.0
- Git：2.20
- 操作系统：windows10
改造
- 在pom.xml中加入springMVC包依赖
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.1.5.RELEASE</version>
</dependency>
- web.xml中配置
DispatcherServlet - WEB-INF目录下创建bean的配置文件dispatcher-servlet.xml
- 将原来的处理逻辑放在Controller中
路径
在开始测试之前先说一下在servlet中获取路径的相关方法，对于http://localhost:8080/project_name/resource_name
-
getContextPath返回/project_name -
getServletPath+getPathInfo返回/resource_name，其中getServletPath返回与url-pattern匹配的部分 -
getRequestURI返回/project_name/resource_name
requestURI = contextPath + servletPath + pathInfo
测试
将war包部署到Tomcat然后启动测试，结果提示
org.springframework.web.servlet.DispatcherServlet.noHandlerFound
No mapping for GET /dizzydwarf-0.0.1-SNAPSHOT/login
居然说找不到/login的映射方法，仔细检查了下代码，Controller类中的@Controller和@RequestMapping("/login")都没什么问题，web.xml中的url-pattern也是/login，html表单中的action是login也没问题。试着把@RequestMapping中的/login改成login，居然成功了，但是这也不科学啊。为了解答这个疑惑，笔者决定对Tomcat进行远程调试。
Tomcat远程调试
因为是第一次对Tomcat进行远程调试，这里简单介绍下配置方法
- 在Tomcat的启动文件startup.bat开头加入以下这行
SET CATALINA_OPTS=-server -Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=8000
- 在eclipse中通过Debug Configurations->Remote Java Application启动调试
- 需要注意的是要先启动Tomcat然后再进行连接
笔者在DispatcherServlet.getHandler和AbstractHandlerMethodMapping.getMappingsByUrl两个方法中设置了断点，然后在浏览器中输入地址发送请求以触发断点。结果出人意料的是问题居然平白无故消失了，两个地方都正常返回了那个/login映射的方法。
返回text或者json数据
这里我们不想用jsp，暂时只希望返回text或者json数据。有几种方法可以实现这个需求
方法一
给Controller方法传递HttpServletRequest和HttpServletResponse，按照传统的处理思路，最后返回void。但是因为我们已经用了SpringMVC，所以还是希望以SpringMVC的方式处理
方法二
在方法前面加上一个@RequestBody，则方法的返回值将直接作为body的内容。比如说我们返回的是一个字符串，那么body里面就是一个字符串。但是如果我们返回的是一个复杂对象呢？对于复杂对象，这里希望以json格式序列化后返回。笔者试着只返回一个复杂对象，不做任何其他处理，结果提示No converter found for return value of type，看来该配置的还是不能省。
- pom.xml加入对jackson包的依赖
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.8</version>
</dependency>
- 配置文件中加入
<mvc:annotation-driven>
为什么要加入<mvc:annotation-driven>呢？因为SpringMVC在5.x版本中默认用的是RequestMappingHandlerMapping和RequestMappingHandlerAdapter，而在RequestMappingHandlerAdapter的构造函数中只加入了如下几种messageConverter
public RequestMappingHandlerAdapter() {
StringHttpMessageConverter stringHttpMessageConverter = new StringHttpMessageConverter();
stringHttpMessageConverter.setWriteAcceptCharset(false); // see SPR-7316
this.messageConverters = new ArrayList<>(4);
this.messageConverters.add(new ByteArrayHttpMessageConverter());
this.messageConverters.add(stringHttpMessageConverter);
try {
this.messageConverters.add(new SourceHttpMessageConverter<>());
}
catch (Error err) {
// Ignore when no TransformerFactory implementation is available
}
this.messageConverters.add(new AllEncompassingFormHttpMessageConverter());
}
<mvc:annotation-driven>可以使Spring调用WebMvcConfigurationSupport的addDefaultHttpMessageConverters方法
protected final void addDefaultHttpMessageConverters(List<HttpMessageConverter<?>> messageConverters) {
StringHttpMessageConverter stringHttpMessageConverter = new StringHttpMessageConverter();
stringHttpMessageConverter.setWriteAcceptCharset(false); // see SPR-7316
messageConverters.add(new ByteArrayHttpMessageConverter());
messageConverters.add(stringHttpMessageConverter);
messageConverters.add(new ResourceHttpMessageConverter());
messageConverters.add(new ResourceRegionHttpMessageConverter());
try {
messageConverters.add(new SourceHttpMessageConverter<>());
}
catch (Throwable ex) {
// Ignore when no TransformerFactory implementation is available...
}
messageConverters.add(new AllEncompassingFormHttpMessageConverter());
......
if (jackson2Present) {
Jackson2ObjectMapperBuilder builder = Jackson2ObjectMapperBuilder.json();
if (this.applicationContext != null) {
builder.applicationContext(this.applicationContext);
}
messageConverters.add(new MappingJackson2HttpMessageConverter(builder.build()));
}
......
}
在这个方法中除了注册之前默认的messageConverter，还会加入支持json转换的messageConverter
禁用后缀模式
笔者增加了一个register.html用来注册新用户，这个页面中有一个action等于/register的表单，同时在Controller中加了一个处理方法，这个方法的@RequestMapping值是/register。结果当访问/register.html时，却发现请求直接被发送到了这个处理方法，而不是显示一个静态页面。之前笔者在配置文件中是否配置过静态资源的映射的。
<mvc:resources location="/" mapping="*.html"></mvc:resources>
一查资料，发现在SpringMVC中默认支持后缀模式，也就是说@RequestMapping("/register")会被当成/register.*来匹配。解决方法是在配置文件中加入以下内容
<mvc:annotation-driven>
<mvc:path-matching suffix-pattern="false" />
</mvc:annotation-driven>
总结
- 可以在eclipse中对Tomcat进行远程调试
-
@RequestBody可以使Controller方法返回的值直接作为响应的body部分，SpringMVC会根据类型自动选择messageConverter进行转换 -
<mvc:annotation-driven>可以使SpringMVC增加支持json格式转换的messageConverter -
@RequestMapping默认支持后缀模式
网友评论