refactor:Refactor project structure

Author: seymourtang

README.md

@@ -53,15 +53,15 @@ API 接口的包装和内部实现，可以帮助开发者更加方便的集成
 package com.company.example;
 
 import io.agora.rest.AgoraException;
-import io.agora.rest.AgoraService;
-import io.agora.rest.core.AgoraProperty;
+import io.agora.rest.core.AgoraConfig;
 import io.agora.rest.core.BasicAuthCredential;
 import io.agora.rest.core.Credential;
 import io.agora.rest.core.RegionArea;
 import io.agora.rest.services.cloudrecording.api.req.StartResourceReq;
 import io.agora.rest.services.cloudrecording.api.res.AcquireResourceRes;
 import io.agora.rest.services.cloudrecording.api.res.StartResourceRes;
 import io.agora.rest.services.cloudrecording.api.res.StopResourceRes;
+import io.agora.rest.services.cloudrecording.CloudRecordingService;
 import io.agora.rest.services.cloudrecording.scenario.mix.req.AcquireMixRecordingResourceClientReq;
 import io.agora.rest.services.cloudrecording.scenario.mix.req.StartMixRecordingResourceClientReq;
 import io.agora.rest.services.cloudrecording.scenario.mix.res.QueryMixHLSAndMP4RecordingResourceRes;
@@ -94,26 +94,28 @@ public class Main {
 
   public static void main(String[] args) throws Exception {
 
-    Credential basicAuthCredential = new BasicAuthCredential(username, password);
+    Credential credential = new BasicAuthCredential(username, password);
 
-    // Initialize AgoraService
-    AgoraService agoraService = new AgoraService(
-            AgoraProperty.builder()
-                    .appId(appId)
-                    .credential(basicAuthCredential)
-                    // Specify the region where the server is located. 
-                    // Optional values are CN, NA, EU, AP, and the client will automatically
-                    // switch to use the best domain name according to the configured region
-                    .regionArea(RegionArea.CNRegionArea)
-                    .build()
-    );
+    // Initialize AgoraConfig
+    AgoraConfig agoraConfig = AgoraConfig.builder()
+            .appId(appId)
+            .credential(credential)
+            // Specify the region where the server is located.
+            // Optional values are CN, NA, EU, AP, and the client will automatically
+            // switch to use the best domain name according to the configured region
+            .regionArea(RegionArea.CNRegionArea)
+            .build();
+
+    // Initialize CloudRecordingService
+
+    CloudRecordingService cloudRecordingService = CloudRecordingService.create(agoraConfig);
 
 
     AcquireResourceRes acquireResourceRes;
 
     // Acquire resource
     try {
-      acquireResourceRes = agoraService.cloudRecording()
+      acquireResourceRes = cloudRecordingService
               .mixScenario()
               .acquire(cname, uid, AcquireMixRecordingResourceClientReq.builder()
                       .build())
@@ -176,7 +178,7 @@ public class Main {
 
     // Start resource
     try {
-      startResourceRes = agoraService.cloudRecording()
+      startResourceRes = cloudRecordingService
               .mixScenario()
               .start(cname, uid,
                       acquireResourceRes.getResourceId(),
@@ -203,11 +205,11 @@ public class Main {
 
     Thread.sleep(3000);
 
-    QueryMixHLSAndMP4RecordingResourceRes queryResourceResp;
+    QueryMixHLSAndMP4RecordingResourceRes queryResourceRes;
 
     // Query resource
     try {
-      queryResourceRes = agoraService.cloudRecording()
+      queryResourceRes = cloudRecordingService
               .mixScenario()
               .queryHLSAndMP4(startResourceRes.getResourceId(), startResourceRes.getSid())
               .block();
@@ -220,7 +222,7 @@ public class Main {
       return;
     }
 
-    if (queryResourceRes == null || queryResourceResp.getServerResponse() == null) {
+    if (queryResourceRes == null || queryResourceRes.getServerResponse() == null) {
       System.out.println("failed to query resource");
       return;
     }
@@ -233,7 +235,7 @@ public class Main {
 
     // Stop resource
     try {
-      stopResourceRes = agoraService.cloudRecording()
+      stopResourceRes = cloudRecordingService
               .mixScenario()
               .stop(cname, uid, startResourceRes.getResourceId(), startResourceRes.getSid(),
                       true)
@@ -256,7 +258,6 @@ public class Main {
   }
 }
 
-
 ```
 
 更多的示例可在 [Example](./examples) 查看

agora-rest-client-core/src/main/java/io/agora/rest/AgoraService.java

@@ -1,6 +1,6 @@
 package io.agora.rest.core;
 
-public class AgoraProperty {
+public class AgoraConfig {
     private final String appId;
 
     private final Credential credential;
@@ -9,7 +9,7 @@ public class AgoraProperty {
 
     private final HttpProperty httpProperty;
 
-    private AgoraProperty(Builder builder) {
+    private AgoraConfig(Builder builder) {
         this.appId = builder.appId;
         this.credential = builder.credential;
         this.regionArea = builder.regionArea;
@@ -38,7 +38,7 @@ public HttpProperty getHttpProperty() {
 
     @Override
     public String toString() {
-        return "AgoraProperty{" +
+        return "AgoraConfig{" +
                 "appId='" + appId + '\'' +
                 ", credential=" + credential +
                 ", regionArea=" + regionArea +
@@ -79,11 +79,11 @@ private Builder httpProperty(HttpProperty httpProperty) {
             return this;
         }
 
-        public AgoraProperty build() {
+        public AgoraConfig build() {
             if (httpProperty == null) {
                 this.httpProperty = HttpProperty.builder().build();
             }
-            return new AgoraProperty(this);
+            return new AgoraConfig(this);
         }
     }
 }

agora-rest-client-core/src/main/java/io/agora/rest/core/AgoraProperty.java renamed to agora-rest-client-core/src/main/java/io/agora/rest/core/AgoraConfig.java

@@ -7,5 +7,5 @@ public interface Context {
 
     <T> Mono<T> sendRequest(String path, HttpMethod method, Object requestBody, Class<T> clazz);
 
-    AgoraProperty getProperty();
+    AgoraConfig getAgoraConfig();
 }

agora-rest-client-core/src/main/java/io/agora/rest/core/Context.java

@@ -16,18 +16,18 @@ public class DefaultContext implements Context {
 
     private static final Logger logger = LoggerFactory.getLogger(DefaultContext.class);
 
-    private final AgoraProperty property;
+    private final AgoraConfig agoraConfig;
 
     private final HttpClient httpClient;
 
     private final Codec codec;
 
     private final DomainPool domainPool;
 
-    public DefaultContext(AgoraProperty property) {
-        this.property = property;
-        this.httpClient = HttpClientFactory.createHttpClient(property);
-        this.domainPool = new DomainPool(property.getRegionArea());
+    public DefaultContext(AgoraConfig agoraConfig) {
+        this.agoraConfig = agoraConfig;
+        this.httpClient = HttpClientFactory.createHttpClient(agoraConfig);
+        this.domainPool = new DomainPool(agoraConfig.getRegionArea());
         this.codec = new JsonCodec();
     }
 
@@ -73,7 +73,7 @@ public <T> Mono<T> sendRequest(String path, HttpMethod method, Object requestBod
     }
 
     @Override
-    public AgoraProperty getProperty() {
-        return this.property;
+    public AgoraConfig getAgoraConfig() {
+        return this.agoraConfig;
     }
 }

agora-rest-client-core/src/main/java/io/agora/rest/core/DefaultContext.java

@@ -13,14 +13,14 @@ public class HttpClientFactory {
 
     private static final Logger logger = LoggerFactory.getLogger(HttpClientFactory.class);
 
-    public static HttpClient createHttpClient(AgoraProperty agoraProperty) {
+    public static HttpClient createHttpClient(AgoraConfig agoraConfig) {
         ConnectionProvider connectionProvider = ConnectionProvider.builder("agora-rest-client")
-                .maxConnections(agoraProperty.getHttpProperty().getHttpConnectionPoolSize())
-                .pendingAcquireTimeout(Duration.ofMillis(agoraProperty.getHttpProperty().getHttpConnectionPendingAcquireTimout()))
-                .maxIdleTime(Duration.ofMillis(agoraProperty.getHttpProperty().getHttpConnectionMaxIdleTime()))
-                .maxLifeTime(Duration.ofMillis(agoraProperty.getHttpProperty().getHttpConnectionMaxLifeTime()))
-                .evictInBackground(Duration.ofMillis(agoraProperty.getHttpProperty().getHttpConnectionEvictInBackground()))
-                .pendingAcquireMaxCount(agoraProperty.getHttpProperty().getHttpConnectionPendingAcquireMaxCount())
+                .maxConnections(agoraConfig.getHttpProperty().getHttpConnectionPoolSize())
+                .pendingAcquireTimeout(Duration.ofMillis(agoraConfig.getHttpProperty().getHttpConnectionPendingAcquireTimout()))
+                .maxIdleTime(Duration.ofMillis(agoraConfig.getHttpProperty().getHttpConnectionMaxIdleTime()))
+                .maxLifeTime(Duration.ofMillis(agoraConfig.getHttpProperty().getHttpConnectionMaxLifeTime()))
+                .evictInBackground(Duration.ofMillis(agoraConfig.getHttpProperty().getHttpConnectionEvictInBackground()))
+                .pendingAcquireMaxCount(agoraConfig.getHttpProperty().getHttpConnectionPendingAcquireMaxCount())
                 .lifo()
                 .build();
 
@@ -32,11 +32,11 @@ public static HttpClient createHttpClient(AgoraProperty agoraProperty) {
                             System.getProperty("os.arch"),
                             System.getProperty("os.name"),
                             AgoraVersion.getVersion()));
-                    if (agoraProperty.getCredential() != null) {
-                        agoraProperty.getCredential().setAuthorization(h);
+                    if (agoraConfig.getCredential() != null) {
+                        agoraConfig.getCredential().setAuthorization(h);
                     }
                 })
-                .wiretap("io.agora.rest.core.http", LogLevel.DEBUG, agoraProperty.getHttpProperty().getHttpLogFormat())
+                .wiretap("io.agora.rest.core.http", LogLevel.DEBUG, agoraConfig.getHttpProperty().getHttpLogFormat())
                 .doOnRequestError((req, t) -> logger.error("request error:{}", t.getMessage()));
 
     }

agora-rest-client-core/src/main/java/io/agora/rest/core/HttpClientFactory.java

@@ -1,6 +1,8 @@
 package io.agora.rest.services.cloudrecording;
 
+import io.agora.rest.core.AgoraConfig;
 import io.agora.rest.core.Context;
+import io.agora.rest.core.DefaultContext;
 import io.agora.rest.services.cloudrecording.api.*;
 import io.agora.rest.services.cloudrecording.api.req.*;
 import io.agora.rest.services.cloudrecording.api.res.*;
@@ -10,7 +12,7 @@
 import io.agora.rest.services.cloudrecording.scenario.web.WebScenario;
 import reactor.core.publisher.Mono;
 
-public class CloudRecordingApi {
+public class CloudRecordingService {
 
     private final AcquireResourceAPI acquireResourceAPI;
 
@@ -28,7 +30,11 @@ public class CloudRecordingApi {
 
     private final MixScenario mixScenario;
 
-    public CloudRecordingApi(Context context) {
+    public static CloudRecordingService create(AgoraConfig agoraConfig) {
+        return new CloudRecordingService(new DefaultContext(agoraConfig));
+    }
+
+    protected CloudRecordingService(Context context) {
         this.acquireResourceAPI = new AcquireResourceAPI(context);
         this.queryResourceAPI = new QueryResourceAPI(context);
         this.startResourceAPI = new StartResourceAPI(context);

agora-rest-client-core/src/main/java/io/agora/rest/services/cloudrecording/CloudRecordingApi.java renamed to agora-rest-client-core/src/main/java/io/agora/rest/services/cloudrecording/CloudRecordingService.java

@@ -26,7 +26,7 @@
   > ![](https://fullapp.oss-cn-beijing.aliyuncs.com/scenario_api/callapi/config/rtm_config2.jpg)  
   > ![](https://fullapp.oss-cn-beijing.aliyuncs.com/agora-rest-client/go/open_cloud_recording.png)
 
-## API V1 接口调用示例
+## API 接口调用示例
 ### 获取云端录制资源
 > 在开始云端录制之前，你需要调用 acquire 方法获取一个 Resource ID。一个 Resource ID 只能用于一次云端录制服务。
 
@@ -38,7 +38,7 @@
 - uid: 用户 UID
 - 更多 clientRequest中的参数见 [Acquire](https://doc.shengwang.cn/doc/cloud-recording/restful/cloud-recording/operations/post-v1-apps-appid-cloud_recording-acquire) 接口文档
 
-通过调用`Acquire().Do`方法来实现获取云端录制资源
+通过调用`acquire`方法来实现获取云端录制资源
 ```java
         String appId = "";
         String cname = "";
@@ -47,13 +47,20 @@
         String password = "";
 
         Credential basicAuthCredential = new BasicAuthCredential(username, password);
-        AgoraService agoraService = new AgoraService(
-                AgoraProperty.builder()
-                        .appId(appId)
-                        .credential(basicAuthCredential)
-                        .regionArea(RegionArea.CNRegionArea)
-                        .build()
-        );
+        
+        // Initialize AgoraConfig
+        AgoraConfig agoraConfig = AgoraConfig.builder()
+                .appId(appId)
+                .credential(credential)
+                // Specify the region where the server is located. 
+                // Optional values are CN, NA, EU, AP, and the client will automatically
+                // switch to use the best domain name according to the configured region
+                .regionArea(region)
+                .build();
+
+        // Initialize CloudRecordingService
+
+        CloudRecordingService cloudRecordingService = CloudRecordingService.create(agoraConfig);
 
         AcquireResourceReq acquireResourceReq = AcquireResourceReq.builder().cname(cname).uid(uid)
                 .clientRequest(AcquireResourceReq.ClientRequest.builder().scene(1)
@@ -64,7 +71,7 @@
 
         AcquireResourceRes acquireResourceRes = null;
         try {
-            acquireResourceRes = agoraService.cloudRecording().acquire(acquireResourceReq).block();
+            acquireResourceRes = cloudRecordingService.acquire(acquireResourceReq).block();
 
             assertNotNull(acquireResourceResp);
             logger.info("acquire resource response:{}", acquireResourceRes);
@@ -146,7 +153,7 @@
         StartResourceRes startResourceRes = null;
 
         try {
-            startResourceRes = agoraService.cloudRecording()
+            startResourceRes = cloudRecordingService
                     .start(resourceId,mode, startResourceReq)
                     .block();
             logger.info("start resource response:{}", startResourceRes);
@@ -184,7 +191,7 @@
 
         StopResourceRes stopResourceRes;
         try {
-            stopResourceRes = agoraService.cloudRecording()
+            stopResourceRes = cloudRecordingService
                     .stop(resourceId, sid, mode, stopResourceReq)
                     .block();
             logger.info("stop resource response:{}", stopResourceRes);
@@ -214,7 +221,7 @@
         QueryResourceRes queryResourceRes = null;
 
         try {
-            queryResourceRes = agoraService.cloudRecording()
+            queryResourceRes = cloudRecordingService
                     .query(resourceId, sid,mode)
                     .block();
 
@@ -284,7 +291,7 @@
 
         UpdateResourceRes updateResourceRes;
         try {
-            updateResourceRes = agoraService.cloudRecording()
+            updateResourceRes = cloudRecordingService
                     .update(resourceId, sid, mode, updateResourceReq)
                     .block();
             logger.info("update resource response:{}", updateResourceRes);

agora-rest-client-core/src/main/java/io/agora/rest/services/cloudrecording/README.md

@@ -16,7 +16,7 @@ public AcquireResourceAPI(Context context) {
 
     public Mono<AcquireResourceRes> handle(AcquireResourceReq request) {
         String path = String.format("/v1/apps/%s/cloud_recording/acquire",
-                this.context.getProperty().getAppId());
+                this.context.getAgoraConfig().getAppId());
         return this.context.sendRequest(path, HttpMethod.POST, request, AcquireResourceRes.class);
     }
 }