接下來，讓我們看看一些方法，以瞭解它們的工作原理。

4.1. Create

讓我們看看 create() 方法：

public SampleOidEntity create(Request request, Response response) {
    SampleOidEntity entity = request.getBodyAs(SampleOidEntity.class, "Resource details not provided");
    SampleOidEntity saved = service.create(entity);

    // Construct the response for create...
    response.setResponseCreated();

    // Include the Location header...
    String locationPattern = request.getNamedUrl(HttpMethod.GET, Constants.Routes.SINGLE_OID_SAMPLE);
    response.addLocationHeader(LOCATION_BUILDER.build(locationPattern, new DefaultTokenResolver()));

    // Return the newly-created resource...
    return saved;
}

上面的代碼:

• 讀取請求主體，並將其轉換為 SampleOidEntity 對象
• 調用服務類中的 create() 方法，並傳遞實體對象
• 將響應代碼設置為 201 – created
• 向響應添加位置標頭
• 返回新創建的實體

如果我們查看服務類，我們會看到它執行驗證並調用存儲類的 create() 方法。

SampleOidEntityRepository 類繼承 MongodbEntityRepository 類，該類內部使用 Mongo Java 驅動程序來執行數據庫操作：

public class SampleOidEntityRepository extends MongodbEntityRepository<SampleOidEntity> {
    @SuppressWarnings("unchecked")
    public SampleOidEntityRepository(MongoClient mongo, String dbName) {
        super(mongo, dbName, SampleOidEntity.class);
    }
}

4.2. Read

現在，讓我們看看 read() 方法：

public SampleOidEntity read(Request request, Response response) {
    String id = request.getHeader(Constants.Url.SAMPLE_ID, "No resource ID supplied");
    SampleOidEntity entity = service.read(Identifiers.MONGOID.parse(id));

    return entity;
}

該方法從請求標頭解析 ID，並調用服務類中的 read() 方法。服務類隨後調用存儲類中的 read() 方法。存儲類檢索並返回數據庫中的實體。

5. Server and Routing

最後，讓我們看一下 Server 類。Server 類啓動應用程序。它定義了路由和路由上的控制器。它還使用指標和其他插件配置了服務器。

5.1. 創建服務器

讓我們看一下 Server 類的構造函數：

public Server(Configuration config) {
    this.config = config;
    RestExpress.setDefaultSerializationProvider(new SerializationProvider());
    Identifiers.UUID.useShortUUID(true);

    this.server = new RestExpress()
      .setName(SERVICE_NAME)
      .setBaseUrl(config.getBaseUrl())
      .setExecutorThreadCount(config.getExecutorThreadPoolSize())
      .addMessageObserver(new SimpleConsoleLogMessageObserver());

    Routes.define(config,server);
    Relationships.define(server);
    configurePlugins(config,server);
    mapExceptions(server);
}

構造函數執行一些步驟：

• 它創建一個 RestExpress 對象，並設置名稱、基本 URL、執行線程池大小和控制枱日誌觀察者。 RestExpress 內部創建一個 Netty 服務器。 此服務器將在我們調用 start() 方法在 Main 類中啓動時啓動。
• 它調用 Routes.define() 方法來定義路由。 我們在下一部分中將查看 Routes 類。
• 它為實體定義關係，配置插件，基於提供的屬性進行配置，並映射某些內部異常到應用程序處理的異常。

5.2. 路由

Routes.define() 方法定義路由和為每個路由調用的控制器方法。

讓我們看一下 SampleOidEntityController 的路由：

public static void define(Configuration config, RestExpress server) {
    // other routes omitted for brevity...
        
    server.uri("/samples/oid/{uuid}.{format}", config.getSampleOidEntityController())
      .method(HttpMethod.GET, HttpMethod.PUT, HttpMethod.DELETE)
      .name(Constants.Routes.SINGLE_OID_SAMPLE);
  
    server.uri("/samples/oid.{format}", config.getSampleOidEntityController())
      .action("readAll", HttpMethod.GET)
      .method(HttpMethod.POST)
      .name(Constants.Routes.SAMPLE_OID_COLLECTION);
}

讓我們詳細查看第一個路由定義。 uri() 方法將模式 /samples/oid/{uuid}.{format} 映射到 SampleOidEntityController。 {uuid} 和 {format} 是 URL 中路徑參數。

GET、PUT 和 DELETE 方法映射到控制器的 read()、update() 和 delete() 方法， respectively。 這是 Netty 服務器的默認行為。

為路由分配名稱，以便可以使用 server.getRouteUrlsByName() 方法（如果需要）通過名稱檢索路由。

對於 create() 和 readAll()，我們需要使用不要求 ID 的不同模式。

讓我們看一下第二個路由定義。 模式 /samples/oid.{format} 映射到 SampleOidEntityController。

action() 方法用於將方法名稱映射到 HTTP 方法。 在這種情況下，readAll() 方法映射到 GET 方法。

POST 方法允許在模式上，並映射到控制器的 create() 方法，默認情況下。 並且，如之前所述，為路由分配名稱。

請注意，如果定義更多方法或更改控制器的標準方法名稱，則需要使用 action() 方法將它們映射到各自的 HTTP 方法。

必須將需要定義的任何其他 URL 模式添加到 Routes.define() 方法中。

6. 運行應用程序

讓我們運行應用程序並對實體執行一些操作。 我們將使用 curl 命令來執行這些操作。

讓我們通過運行 Main 類來啓動應用程序。 應用程序在端口 8081 上啓動。

默認情況下，SampleOidEntity 沒有除了 ID 和時間戳之外的任何字段。 讓我們向實體添加一個名為 name 的字段：

public class SampleOidEntity extends AbstractMongodbEntity implements Linkable {
    private String name;

    // constructors, getters and setters 
}

6.1. 測試 API

讓我們通過運行 curl 命令來創建一個新的實體：

$ curl -X POST -H "Content-Type: application/json" -d "{\"name\":\"test\"}" http://localhost:8081/samples/oid.json

這應該返回具有 ID 的新創建的實體：

{
  "_links": {
    "self": {
      "href": "http://localhost:8081/samples/oid/63a5d983ef1e572664c148fd"
    },
    "up": {
      "href": "http://localhost:8081/samples/oid"
    }
  },
  "name": "test",
  "id": "63a5d983ef1e572664c148fd",
  "createdAt": "2022-12-23T16:38:27.733Z",
  "updatedAt": "2022-12-23T16:38:27.733Z"
}

接下來，讓我們使用上面返回的 id 通過 curl 命令讀取創建的實體：

$ curl -X GET http://localhost:8081/samples/oid/63a5d983ef1e572664c148fd.json

這應該返回之前相同的實體。

7. 結論

在本文中，我們探討了如何使用 RestExpress 創建 REST API。

我們使用 RestExpress mongodb 模式創建了一個項目。然後，我們查看了項目結構和生成的類。最後，我們運行了應用程序並執行了一些操作以測試 API。