Spring @GetMapping 教程展示了如何使用@GetMapping 注解将 HTTP GET 请求映射到特定的处理程序方法。
Spring 是用于创建企业应用的流行 Java 应用框架。
@GetMapping
@GetMapping注释将 HTTP GET 请求映射到特定的处理程序方法。 它是一个组合的注释，用作@RequestMapping(method = RequestMethod.GET)的快捷方式。
Spring @GetMapping示例
以下应用使用@GetMapping将两个请求路径映射到处理程序方法。 在此示例中，我们使用注解来设置 Spring Web 应用。
pom.xmlsrc├───main│ ├───java│ │ └───com│ │ └───zetcode│ │ ├───config│ │ │ MyWebInitializer.java│ │ │ WebConfig.java│ │ └───controller│ │ MyController.java│ └───resources│ logback.xml└───test └───java └───com └───zetcode └───controller MyControllerTest.java
这是项目结构。
pom.xml
<?xml version="1.0" encoding="UTF-8"?><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/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.zetcode</groupId> <artifactId>getmapping</artifactId> <version>1.0-SNAPSHOT</version> <packaging>war</packaging> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>11</maven.compiler.source> <maven.compiler.target>11</maven.compiler.target> <spring-version>5.1.3.RELEASE</spring-version> </properties> <dependencies> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.2.3</version> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>4.0.1</version> <scope>provided</scope> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>{spring-version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <version>{spring-version}</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-war-plugin</artifactId> <version>3.2.2</version> </plugin> <plugin> <groupId>org.eclipse.jetty</groupId> <artifactId>jetty-maven-plugin</artifactId> <version>9.4.14.v20181114</version> </plugin> </plugins> </build></project>在pom.xml文件中，我们具有以下依存关系：logback-classic，javax.servlet-api，junit，spring-webmvc和spring-test。
resources/logback.xml
<?xml version="1.0" encoding="UTF-8"?><configuration> <logger name="org.springframework" level="ERROR"/> <logger name="com.zetcode" level="INFO"/> <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <Pattern>%d{HH:mm:ss.SSS} %blue(%-5level) %magenta(%logger{36}) - %msg %n </Pattern> </encoder> </appender> <root> <level value="INFO" /> <appender-ref ref="consoleAppender" /> </root></configuration>logback.xml是 Logback 日志库的配置文件。
com/zetcode/config/MyWebInitializer.java
package com.zetcode.config;import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;@Configurationpublic class MyWebInitializer extends AbstractAnnotationConfigDispatcherServletInitializer { @Override protected Class<?>[] getRootConfigClasses() { return null; } @Override protected Class<?>[] getServletConfigClasses() { return new Class[]{WebConfig.class}; } @Override protected String[] getServletMappings() { return new String[]{"/"}; }}MyWebInitializer注册 Spring DispatcherServlet，它是 Spring Web 应用的前端控制器。
@Overrideprotected Class<?>[] getServletConfigClasses() { return new Class[]{WebConfig.class};}getServletConfigClasses()返回 Web 配置类。
com/zetcode/config/WebConfig.java
package com.zetcode.config;import org.springframework.context.annotation.ComponentScan;import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.config.annotation.EnableWebMvc;@Configuration@EnableWebMvc@ComponentScan(basePackages = {"com.zetcode"})public class WebConfig {}WebConfig通过@EnableWebMvc启用 Spring MVC 注解，并为com.zetcode软件包配置组件扫描。
com/zetcode/controller/MyController.java
package com.zetcode.controller;import org.springframework.http.MediaType;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RestController;@RestControllerpublic class MyController { @GetMapping(value="/", produces = MediaType.TEXT_PLAIN_VALUE) public String index() { return "This is Home page"; } @GetMapping(value="/hello", produces = MediaType.TEXT_PLAIN_VALUE) public String sayHello() { return "Hello there!"; }}MyController提供请求路径和处理程序方法之间的映射。
@RestControllerpublic class MyController {@RestController用于创建不使用视图技术的静态控制器。 这些方法通常返回 XML，JSON 或纯文本。
@GetMapping(value="/", produces = MediaType.TEXT_PLAIN_VALUE)public String index() { return "This is Home page";}@GetMapping将从 GET 请求到index()方法的/根路径映射。 它返回纯文本。
com/zetcode/controller/MyControllerTest.java
package com.zetcode.controller;import org.junit.Before;import org.junit.Test;import org.springframework.test.web.servlet.MockMvc;import org.springframework.test.web.servlet.setup.MockMvcBuilders;import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;public class MyControllerTest { private MockMvc mockMvc; @Before public void setup() { this.mockMvc = MockMvcBuilders.standaloneSetup(new MyController()).build(); } @Test public void testHomePage() throws Exception { this.mockMvc.perform(get("/")).andExpect(status().isOk()) .andExpect(content().string("This is Home page")); } @Test public void testHelloPage() throws Exception { this.mockMvc.perform(get("/hello")).andExpect(status().isOk()) .andExpect(content().string("Hello there!")); }}MyControllerTest测试两个页面。
$ curl localhost:8080This is Home page$ curl localhost:8080/helloHello there!
我们运行该应用，并使用curl工具创建两个 GET 请求。
在本教程中，我们介绍了@GetMapping注解。
