不使用Spring Boot创建Spring REST服务

89

我已经按照spring.io上的"入门教程"构建了REST服务https://spring.io/guides/gs/rest-service/。问题是这个教程只解释了如何使用Spring Boot嵌入Tomcat来生成一个独立运行的可执行jar包。

有没有一种方法可以从头开始创建项目,以生产war文件并部署在现有的Tomcat实例上?

PS:我在stackoverflow上找到了一个关于相同问题的先前帖子Spring RESTful Service as a WAR instead of JAR in Tomcat。问题是所接受的答案和建议并没有完全解决我的问题,因为我不想寻找修改独立应用Spring Boot项目以使其在外部Tomcat容器中工作的方法,而希望找到一种更加"清洁"的解决方案,不涉及Spring Boot。(我不确定如何操作,在stackoverflow上还很新,请指教是否打开一个新的问题是正确的做法)。


1
您认为 Spring Boot 的哪些部分是“不干净”的?了解您反感的部分将有助于获得更好的答案。 - digitaljoel
3
好的,我只是在谈论一个“更简洁”的解决方案,这与不必使用某个库(在这种情况下是boot,但也可能是其他任何东西),然后不得不找到一些解决方法使代码在没有它的情况下正常工作有关;我并没有指涉Spring Boot的某个特定部分不够简洁。 - chrx
@digitaljoel 我也同意这个问题,boot太过简化了。我熟悉maven、tomcat等工具 - 我不想部署一个jar包,希望pom文件尽可能精简(依赖的插件越少越好)。我发现几乎不可能找到我需要的DI和MVC注解(以及可能的Spring Data)的最新版本所需的少量jar包。 - NimChimpsky
3
Spring Boot引入了很多依赖,真的是很多很多。而且在一些人眼中,这太多了。 - granadaCoder
任何新的框架,如Spring Boot,理想情况下应该减少复杂性。我很惊讶为什么他们引入了额外的复杂性。 - Stunner
2个回答

75

你不需要使用Spring Boot来创建一个REST Controller。

请按照Spring框架文档设置MVC: https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#spring-web

MVC设置(DispatcherServlet)取决于您的Spring版本,您可以使用XML或以编程方式进行设置: https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#mvc-servlet

一旦完成这个设置,您就可以向应用程序添加一个REST Controller。注意,REST Controller (@RestController注释) 是一个构造型注释,它将@ResponseBody和@Controller组合在一起,换句话说,Controller会在响应体中返回一个对象而不是返回视图。

以下是一个很好的例子,解释了我上面所说的内容: http://www.programming-free.com/2014/01/spring-mvc-40-restful-web-services.html


4
你提供的链接恰好是我在寻找的那种说明。非常感谢! - chrx
46
这表明了Spring框架方向的明显问题。现在几乎所有都使用Spring Boot,很难找到不使用它的东西。在我看来,Spring Boot 做了太多神奇的事情... - R. van Twisk
6
@R.vanTwisk 完全同意。 - Koray Tugay
3
Spring Boot 应该改名为“Spring Ball and Chain”。 - Adam

19

这里是另一个例子:

目录结构:

.
├── ./pom.xml
└── ./src
    └── ./src/main
        ├── ./src/main/java
        │   └── ./src/main/java/biz
        │       └── ./src/main/java/biz/tugay
        │           └── ./src/main/java/biz/tugay/restfulspring
        │               └── ./src/main/java/biz/tugay/restfulspring/config
        │                   ├── ./src/main/java/biz/tugay/restfulspring/config/RestfulHello.java
        │                   └── ./src/main/java/biz/tugay/restfulspring/config/WebAppInitalizer.java
        └── ./src/main/webapp
            └── ./src/main/webapp/WEB-INF
                └── ./src/main/webapp/WEB-INF/web.xml

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

    <modelVersion>4.0.0</modelVersion>
    <groupId>biz.tugay</groupId>
    <artifactId>restfulSpring</artifactId>

    <packaging>war</packaging>
    <version>1.0-SNAPSHOT</version>
    <name>restfulSpring Maven Webapp</name>

    <url>http://maven.apache.org</url>

    <dependencies>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.0.1</version>
            <scope>provided</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>4.3.16.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>4.3.16.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>4.3.16.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>4.3.16.RELEASE</version>
        </dependency>
    </dependencies>

    <build>
        <finalName>restfulSpring</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.1</version>
                <configuration>
                    <source>1.7</source>
                    <target>1.7</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.eclipse.jetty</groupId>
                <artifactId>jetty-maven-plugin</artifactId>
                <version>9.2.1.v20140609</version>
            </plugin>
        </plugins>
    </build>

</project>

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
                             http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
         version="3.0">
</web-app>

WebAppInitalizer.java

package biz.tugay.restfulspring.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

@Configuration
@EnableWebMvc
@ComponentScan("biz.tugay.restfulspring")
public class WebAppInitalizer extends AbstractAnnotationConfigDispatcherServletInitializer {

    @Override
    protected String[] getServletMappings() {
        return new String[]{"/*"};
    }

    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class<?>[]{WebAppInitalizer.class};
    }

    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[0];
    }
}

RestfulHello.java

package biz.tugay.restfulspring.config;

import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping(value = "/")
public class RestfulHello {

    @RequestMapping(value = "hello")
    public ResponseEntity<String> sayHello() {
        final HttpHeaders httpHeaders= new HttpHeaders();
        httpHeaders.setContentType(MediaType.APPLICATION_JSON);
        return new ResponseEntity<String>("{\"msg\": \"Hello World\"}", httpHeaders, HttpStatus.OK);
    }
}

构建和运行:

mvn clean install
mvn jetty:start

测试:

> GET /hello HTTP/1.1
> Host: localhost:8080
> User-Agent: insomnia/5.15.0
> Accept: */*
< HTTP/1.1 200 OK
< Date: Fri, 27 Apr 2018 00:06:07 GMT
< Content-Type: application/json
< Content-Length: 22
< Server: Jetty(9.2.1.v20140609)

收到的内容:

{
    "msg": "Hello World"
}

1
你可以通过添加Maven War插件来完全避免创建web.xml文件: <plugin> <artifactId>maven-war-plugin</artifactId> <version>3.1.0</version> </plugin> - Dmitry Avgustis

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接