APIJSON的使用

时间：2024-10-21 10:46:04

APIJSON是一个用于简化后端接口开发的工具，在Java中可以按照以下步骤使用：

1. 引入依赖

在Java项目中，需要引入APIJSON的相关依赖。如果使用Maven，可以在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>com.github.TommyLemon</groupId>
    <artifactId>APIJSON</artifactId>
    <version>具体版本号</version>
</dependency>

2. 定义实体类并配置权限

  • 以操作用户表User为例，定义实体类并添加权限配置。
//注册表并添加权限，用默认配置
@MethodAccess
public class User {
//内容一般仅供表字段说明及Android App开发使用，服务端不用的可不写。
}
//Verifier内添加权限
accessMap.put(User.class.getSimpleName(), getAccessMap(User.class.getAnnotation(MethodAccess.class)));

还可以定制POST请求的角色权限，如只允许未登录角色和管理员角色新增User：

@MethodAccess(
  POST = {UNKNOWN, ADMIN} //只允许未登录角色和管理员角色新增User，默认配置是{LOGIN, ADMIN}
)
public class User {}

3. 进行数据操作

  • 查询操作
    • 查询单个用户
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

public class APISample {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();
        String url = "http://apijson.cn:8080/get";
        JSONObject requestBody = new JSONObject();
        requestBody.put("User", new JSONObject().fluentPut("id", 82001));
        String requestJson = requestBody.toJSONString();
        Request request = new Request.Builder()
              .url(url)
              .post(RequestBody.create(MediaType.parse("application/json"), requestJson))
              .build();
        Response response = client.newCall(request).execute();
        String responseJson = response.body().string();
        JSONObject responseBody = JSON.parseObject(responseJson);
        System.out.println(responseBody);
    }
}
  • 新增操作
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;

public class APISample {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();
        String url = "http://apijson.cn:8080/post";
        JSONObject requestBody = new JSONObject();
        requestBody.put("Comment", new JSONObject()
              .fluentPut("userId", 82001)
              .fluentPut("momentId", 15)
              .fluentPut("content", "测试新增评论"));
        requestBody.put("tag", "Comment");
        String requestJson = requestBody.toJSONString();
        Request request = new Request.Builder()
              .url(url)
              .post(RequestBody.create(MediaType.parse("application/json"), requestJson))
              .build();
        Response response = client.newCall(request).execute();
        String responseJson = response.body().string();
        JSONObject responseBody = JSON.parseObject(responseJson);
        System.out.println(responseBody);
    }
}
  • 删除操作
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;

public class APISample {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();
        String url = "http://apijson.cn:8080/delete";
        JSONObject requestBody = new JSONObject();
        requestBody.put("Comment", new JSONObject().fluentPut("id", 1510394480987));
        requestBody.put("tag", "Comment");
        String requestJson = requestBody.toJSONString();
        Request request = new Request.Builder()
              .url(url)
              .post(RequestBody.create(MediaType.parse("application/json"), requestJson))
              .build();
        Response response = client.newCall(request).execute();
        String responseJson = response.body().string();
        JSONObject responseBody = JSON.parseObject(responseJson);
        System.out.println(responseBody);
    }
}
  • 修改操作
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;

public class APISample {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();
        String url = "http://apijson.cn:8080/put";
        JSONObject requestBody = new JSONObject();
        requestBody.put("Comment", new JSONObject()
              .fluentPut("id", 22)
              .fluentPut("content", "测试修改评论"));
        requestBody.put("tag", "Comment");
        String requestJson = requestBody.toJSONString();
        Request request = new Request.Builder()
              .url(url)
              .post(RequestBody.create(MediaType.parse("application/json"), requestJson))
              .build();
        Response response = client.newCall(request).execute();
        String responseJson = response.body().string();
        JSONObject responseBody = JSON.parseObject(responseJson);
        System.out.println(responseBody);
    }
}

上述代码展示了在Java中如何使用APIJSON进行常见的数据操作，包括查询、新增、删除和修改。在实际使用中，需要根据具体的业务需求和项目结构进行适当调整。

类似APIJSON的工具

除了 APIJSON，还有以下类似的工具：

一、GraphQL

  • 特点：

    • 允许客户端精确指定所需的数据，避免了传统 RESTful API 中可能出现的过度获取或不足获取数据的问题。
    • 强类型系统确保数据的准确性和一致性。通过定义清晰的类型和关系，GraphQL 使得数据的结构更加明确，减少了数据不一致和错误的可能性。
    • 支持灵活的查询和变更操作，可以通过一个请求获取多个资源的数据，并且可以对数据进行复杂的筛选、排序和分页等操作。

  • 适用场景：

    • 适用于复杂的前端应用，特别是需要频繁获取不同类型数据并进行组合展示的场景。例如，社交网络应用中，用户可能需要同时获取自己的个人信息、关注列表、发布的内容以及评论等数据，GraphQL 可以通过一个请求满足这种需求。
    • 对于需要频繁迭代和变更 API 的项目也非常适合，因为它可以通过修改 schema 来快速适应业务需求的变化，而不需要像传统 API 那样修改多个端点。

二、Falcor

  • 特点：

    • 采用虚拟 JSON 图的概念，可以将多个数据源整合到一个统一的、可遍历的 JSON 对象中。这种方式使得客户端可以像访问本地数据一样访问远程数据，无需关心数据的具体来源和获取方式。
    • 支持高效的数据缓存和更新机制。当部分数据发生变化时，Falcor 可以只更新变化的部分，而不是重新获取整个数据集，从而提高了数据的访问效率和响应速度。
    • 与现代前端框架（如 React 和 Angular）配合良好，可以方便地集成到前端应用中，实现高效的数据管理和展示。

  • 适用场景：

    • 适用于大型企业级应用，特别是那些需要整合多个不同数据源的场景。例如，在金融行业中，可能需要从多个数据库、外部服务和文件系统中获取数据，Falcor 可以将这些数据源统一起来，为前端提供一致的数据访问接口。
    • 对于需要实时更新数据的应用也很有优势，如在线协作工具、实时监控系统等，Falcor 的高效更新机制可以确保数据的及时性和准确性。

三、OData

  • 特点：

    • 基于 RESTful 架构，提供了一套标准化的查询和操作语言，使得不同的系统之间可以更容易地进行数据交互。
    • 支持丰富的查询选项，包括筛选、排序、分页、投影等，可以满足各种复杂的查询需求。
    • 提供了元数据服务，使得客户端可以了解数据的结构和关系，从而更加方便地进行数据访问和操作。

  • 适用场景：

    • 适用于企业级应用集成，特别是需要与多个不同系统进行数据交互的场景。例如，在企业内部，不同的部门可能使用不同的系统来管理数据，OData 可以作为一个统一的数据访问接口，方便各个系统之间的数据共享和集成。
    • 对于需要遵循一定标准和规范的项目也非常适合，因为 OData 是一个被广泛认可的标准，具有良好的兼容性和可扩展性。

相关文章