Spring Boot WEB服务的 Hello World!

意图

使用Spring Boot创建最简化的WEB服务以加深理解。

实现

在本地环境（Ubuntu）上构建和启动一个Spring Boot jar文件形式的应用程序。

技術背景:
技術背景是指一個人或組織在技術方面的知識、經驗和能力。

Spring Boot 是什么？

开发环境

• Windows 11 Home 22H2 を使用しています。

WSL の Ubuntu を操作していきますので macOS の方も参考にして頂けます。

※ 本文中将主要使用Ubuntu终端进行操作。

显示“Hello World”的步骤

创建项目文件夹

假设 ‘~/tmp/hello-spring-boot’ 是项目文件夹。

$ cd ~
$ mkdir -p tmp/hello-spring-boot
$ cd ~/tmp/hello-spring-boot

创建应用程序类

$ mkdir -p src/main/java/com/example/springboot
$ vim src/main/java/com/example/springboot/Application.java

文件的内容 de

package com.example.springboot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

创建控制器类

$ mkdir -p src/main/java/com/example/springboot/controller
$ vim src/main/java/com/example/springboot/controller/HelloController.java

文件的内容

package com.example.springboot.controller;

import java.util.Map;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class HelloController {

    @GetMapping("/data")
    public Map<String, String> getData() {
        Map<String, String> map = Map.of("message", "Hello World!");
        return map;
    }
}

创建pom.xml 文件

$ vim 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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.8</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>hello-spring-boot</artifactId>
    <version>1.0</version>
    <name>hello-spring-boot</name>

    <properties>
        <java.version>11</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <finalName>app</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

目录文件结构

$ tree
.
├── pom.xml
└── src
    └── main
        └── java
            └── com
                └── example
                    └── springboot
                        ├── Application.java
                        └── controller
                            └── HelloController.java

运行Spring Boot应用程序

应用程序构建
※ 将创建target/app.jar。

$ mvn clean install

启动应用程序（按Ctrl + C停止）

$ mvn spring-boot:run

请使用网络浏览器进行确认。

http://localhost:8080/api/data

在WEB浏览器中，成功显示了{“message”:”你好，世界！”} 并且成功获取了JSON数据。

请用其他终端命令进行确认

$ curl -v http://localhost:8080/api/data
*   Trying 127.0.0.1:8080...
* Connected to localhost (127.0.0.1) port 8080 (#0)
> GET /api/data HTTP/1.1
> Host: localhost:8080
> User-Agent: curl/7.81.0
> Accept: */*
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 200
< Content-Type: application/json
< Transfer-Encoding: chunked
< Date: Sat, 25 Feb 2023 05:13:10 GMT
<
* Connection #0 to host localhost left intact
{"message":"Hello World!"}

在终端上显示了 {“message”:”你好世界！”} 并成功获取到了 JSON 数据。

总结

• Ubuntu のシンプルな構成の Java 開発環境で、Spring Boot WEBサービスを実行することが出来ました。

また、Spring Boot を使用しない素の Spring MVC REST WEBサービスの Hello World!と比較すると、少ない記述で同じ動作を実装することが出来ました。