只有一個依賴包的Dockerized容器的簡單的Http REST API

banq發表於2019-06-29
DockerZedHTTPRESTAPI

有時我們需要做一個很簡單的Http Rest API，但是不想使用Spring Boot過重的框架，其依賴包太多，這裡展示在在Docker中使用Java執行API端點其實並不需要這些框架，只要一個依賴包就好，非常輕量。

實際上，我們只使用單個庫作為依賴：HttpMate核心。對於此示例，我們將使用HttpMate的LowLevel構建器和單個HTTP處理程式。

本例中使用的環境
  • Java 11+
  • Maven 3.5+
  • Java友好的IDE
  • Docker版本18+
  • 基本瞭解HTTP / bash / Java

最終結果可以在這個git repo中找到。

組織專案
讓我們建立我們的初始專案結構：

mkdir -p simple-java-http-docker/src/main/java/com/envimate/examples/http


pom檔案：

<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
         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>com.envimate.examples</groupId>
    <artifactId>simple-java-http-docker</artifactId>
    <version>0.0.1</version>

    <dependencies>
        <dependency>
            <groupId>com.envimate.httpmate</groupId>
            <artifactId>core</artifactId>
            <version>1.0.21</version>
        </dependency>
    </dependencies>
</project>


在這裡：
  • 我們專案的標準groupId / artifactId / version定義
  • 對HttpMate核心庫的單一依賴

這足以在選擇的IDE中開始開發我們的API端點。其中大多數都支援基於Maven的Java專案。

應用程式入口點
要啟動我們的小伺服器，我們將使用一個簡單的main方法。讓我們將應用程式的條目建立為Application.java目錄src/main/java/com/envimate/examples/http中的檔案，現在只需將時間輸出到控制檯。


public final class Application {
    public static void main(String[] args) {
        final LocalDateTime time = LocalDateTime.now();
        final String dateFormatted = time.format(DateTimeFormatter.ISO_TIME);
        System.out.println("current time is " + dateFormatted);
    }
}


嘗試執行此類，您將看到列印的當前時間。

將列印出時間的部分分離成一個沒有引數的lambda函式:Supplier


public final class Application {
    public static void main(String[] args) {
        Supplier handler = () -> {
            final LocalDateTime time = LocalDateTime.now();
            final String dateFormatted = time.format(DateTimeFormatter.ISO_TIME);
            return "current time is " + dateFormatted;
        };

        System.out.println(handler.get());
    }
}


低階HttpMate提供的便利介面看起來並沒有太大的不同，除了返回一個String，String設定為響應，以及一切順利的指示（也就是響應程式碼200）。

final HttpHandler httpHandler = (request, response) -> {
    final LocalDateTime time = LocalDateTime.now();
    final String dateFormatted = time.format(DateTimeFormatter.ISO_TIME);

    response.setStatus(200);
    response.setBody("current time is " + dateFormatted);
};


HttpMate還提供了一個簡單的Java HttpServer包裝器 - PureJavaEndpoint它允許您在沒有任何進一步依賴的情況下啟動端點。
我們需要做的就是給它HttpMate的例項：


import com.envimate.httpmate.HttpMate;
import com.envimate.httpmate.convenience.endpoints.PureJavaEndpoint;
import com.envimate.httpmate.convenience.handler.HttpHandler;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

import static com.envimate.httpmate.HttpMate.anHttpMateConfiguredAs;
import static com.envimate.httpmate.LowLevelBuilder.LOW_LEVEL;

public final class Application {
    public static void main(String[] args) {
        final HttpHandler httpHandler = (request, response) -> {
            final LocalDateTime time = LocalDateTime.now();
            final String dateFormatted = time.format(DateTimeFormatter.ISO_TIME);

            response.setStatus(200);
            response.setBody("current time is " + dateFormatted);
        };

        final HttpMate httpMate = anHttpMateConfiguredAs(LOW_LEVEL)
                .get("/time", httpHandler)
                .build();
        PureJavaEndpoint.pureJavaEndpointFor(httpMate).listeningOnThePort(1337);
    }
}


請注意/time，當使用方法GET呼叫時，我們已將httpHandler配置為提供路徑。

客戶端訪問測試：

curl http://localhost:1337/time
current time is 15:09:34.458756

在我們將這個全部放入Dockerfile之前，我們需要將它打包為一個jar。

建立JAR
我們需要兩個maven外掛：maven-compiler-plugin和maven-assembly-plugin來構建可執行jar。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
         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>com.envimate.examples</groupId>
    <artifactId>simple-java-http-docker</artifactId>
    <version>0.0.1</version>

    <dependencies>
        <dependency>
            <groupId>com.envimate.httpmate</groupId>
            <artifactId>core</artifactId>
            <version>1.0.21</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <release>${java.version}</release>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <archive>
                                <manifest>
                                    <mainClass>
                                        com.envimate.examples.http.Application
                                    </mainClass>
                                </manifest>
                            </archive>
                            <descriptorRefs>
                                <descriptorRef>jar-with-dependencies</descriptorRef>
                            </descriptorRefs>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>


構建我們的jar：
mvn clean verify

並執行生成的jar：

java -jar target/simple-java-http-docker-0.0.1-jar-with-dependencies.jar

放入Docker容器
Dockerfile看起來很簡單：

FROM openjdk:12

ADD target/simple-java-http-docker-0.0.1-jar-with-dependencies.jar /opt/application.jar

EXPOSE 1337

ENTRYPOINT exec java -jar /opt/application.jar


它指定
  • FROM：用作基礎的影像。我們將使用openjdk影像。
  • ADD：我們想要的jar我們想要的目錄
  • EXPOSE：我們正在收聽的埠
  • ENTRYPOINT：對於命令，我們要執行

要構建和標記我們的docker映象，我們從目錄的根目錄執行以下命令：
docker build --tag simple-java-http-docker .

這將生成我們可以執行的docker映象：
docker run --publish 1337:1337 simple-java-http-docker

訪問測試：
curl http://localhost:1337/time
current time is 15:23:04.275515

結論
當然，這是一個簡化的例子，我們寫的端點並不完全有用。它證明了你不需要大量的庫只是為了擁有一個正在執行的HTTP端點，包裝一個可執行的jar是多麼容易，使用docker和你的java應用程式以及低階HttpMate的基本用法。

 

相關文章