libjson-rpc-cpp 项目教程
1. 项目的目录结构及介绍
libjson-rpc-cpp 是一个用于 JSON-RPC 的 C++ 框架。项目的目录结构如下:
libjson-rpc-cpp/
├── CMakeLists.txt
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── include/
│ └── jsonrpccpp/
│ ├── client.h
│ ├── common.h
│ ├── server.h
│ └── ...
├── src/
│ ├── client/
│ ├── common/
│ ├── server/
│ └── ...
├── examples/
│ ├── stubclient.cpp
│ ├── stubserver.cpp
│ └── ...
├── tests/
│ └── ...
└── tools/
└── jsonrpcstub/
└── ...
目录介绍
- CMakeLists.txt: 用于构建项目的 CMake 配置文件。
- CONTRIBUTING.md: 贡献指南。
- LICENSE: 项目许可证(MIT)。
- README.md: 项目介绍和使用说明。
- include/: 包含项目的头文件。
- src/: 包含项目的源代码。
- examples/: 包含示例代码,如
stubclient.cpp
和stubserver.cpp
。 - tests/: 包含测试代码。
- tools/: 包含工具代码,如
jsonrpcstub
。
2. 项目的启动文件介绍
项目的启动文件通常是 examples/
目录下的示例代码。以下是两个关键的启动文件:
stubserver.cpp
#include <jsonrpccpp/server.h>
#include <jsonrpccpp/server/connectors/httpserver.h>
class MyStubServer : public jsonrpc::AbstractServer<MyStubServer> {
public:
MyStubServer(jsonrpc::HttpServer &server) : jsonrpc::AbstractServer<MyStubServer>(server) {
bindAndAddMethod(jsonrpc::Procedure("sayHello", jsonrpc::PARAMS_BY_NAME, jsonrpc::JSON_STRING, "name", jsonrpc::JSON_STRING, NULL), &MyStubServer::sayHello);
}
void sayHello(const Json::Value &request, Json::Value &response) {
response = "Hello " + request["name"].asString();
}
};
int main() {
jsonrpc::HttpServer httpServer(8383);
MyStubServer server(httpServer);
server.StartListening();
getchar();
server.StopListening();
return 0;
}
stubclient.cpp
#include <jsonrpccpp/client.h>
#include <jsonrpccpp/client/connectors/httpclient.h>
int main() {
jsonrpc::HttpClient httpClient("http://localhost:8383");
jsonrpc::Client client(httpClient);
Json::Value params;
params["name"] = "World";
Json::Value response = client.CallMethod("sayHello", params);
std::cout << "Response: " << response.asString() << std::endl;
return 0;
}
3. 项目的配置文件介绍
libjson-rpc-cpp 项目本身没有特定的配置文件,但可以通过 CMake 配置文件 CMakeLists.txt
进行构建配置。以下是 CMakeLists.txt
的部分内容:
cmake_minimum_required(VERSION 2.8.12)
project(libjson-rpc-cpp)
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/")
find_package(JsonCpp REQUIRED)
find_package(libmicrohttpd REQUIRED)
find_package(libcurl REQUIRED)
find_package(Argtable2 REQUIRED)
find_package(Hiredis REQUIRED)
include_directories(${JSONCPP_INCLUDE_DIR} ${LIBMICROHTTPD_INCLUDE_DIR} ${LIBCURL_INCLUDE_DIR} ${ARGTABLE2_INCLUDE_DIR} ${HIREDIS_INCLUDE_DIR})
add_subdirectory(src)
add_subdirectory(examples)
add_subdirectory(tests)
add_subdirectory(tools)