Description: Upload Readme

Signed-off-by: N 王琪 <wangqi327@huawei.com>

Description: Upload Readme
Signed-off-by: N 王琪 <wangqi327@huawei.com>
45aae75b · wangqi · c0722413 · 45aae75b
显示空白变更内容
内联并排

Showing with 149 addition and 150 deletion

zh-cn/application-dev/device/sample-server-guidelines.md zh-cn/application-dev/device/sample-server-guidelines.md +149 -150

未找到文件。
--- a/zh-cn/application-dev/device/sample-server-guidelines.md
+++ b/zh-cn/application-dev/device/sample-server-guidelines.md
@@ -8,65 +8,65 @@

 1. 生成SSL证书

-生成serverKey.pem和serverCert.cer两个文件，用于示例服务器的SSL协议通信。
+	生成serverKey.pem和serverCert.cer两个文件，用于示例服务器的SSL协议通信。

-```bash
-openssl req -newkey rsa:2048 -nodes -keyout serverKey.pem -x509 -days 365 -out serverCert.cer -subj "/C=CN/ST=GD/L=GZ/O=abc/OU=defg/CN=hijk/emailAddress=test.com"
-```
+	```bash
+	openssl req -newkey rsa:2048 -nodes -keyout serverKey.pem -x509 -days 365 -out serverCert.cer -subj "/C=CN/ST=GD/L=GZ/O=abc/OU=defg/CN=hijk/emailAddress=test.com"
+	```



 2. 修改bundle.json

-在build字段的sub_component字段中开始位置新增一行。
+	在build字段的sub_component字段中开始位置新增一行。

-```cmake
-"sub_component": [
+	```cmake
+	"sub_component": [
 		"//base/update/updateservice/server_sample:testserver",
 		...
-],
-```
+	],
+	```

 3. 下载代码仓

-repo方式下载OpenHarmony全仓
+	repo方式下载OpenHarmony全仓

-```bash
-repo init -u https://gitee.com/openharmony/manifest.git -b master --no-repo-verify
-repo sync -c
-repo forall -c 'git lfs pull'
-```
+	```bash
+	repo init -u https://gitee.com/openharmony/manifest.git -b master --no-repo-verify
+	repo sync -c
+	repo forall -c 'git lfs pull'
+	```

-git clone方式下载本代码仓
+	git clone方式下载本代码仓

-```bash
-git clone https://gitee.com/openharmony/update_updateservice.git -b master
-```
+	```bash
+	git clone https://gitee.com/openharmony/update_updateservice.git -b master
+	```



 4. 建立代码目录

-进入到update_updateservice目录下，执行以下命令，建立代码目录。
+	进入到update_updateservice目录下，执行以下命令，建立代码目录。

-```bash
-mkdir server_sample							// 建立示例服务器server_sample目录
-touch server_sample/BUILD.gn				 // 创建BUILD.gn编译文件
-mkdir server_sample/include					 // 建立示例服务器头文件include目录
-touch server_process.h						// 创建server_process.h头文件
-mkdir server_sample/src						// 建立示例服务器c/c++文件src目录
-touch server_sample/src/server_process.c	  // 创建server_process.c文件
-touch server_sample/src/main.cpp			 // 创建main.cpp文件
-```
+	```bash
+	mkdir server_sample                            // 建立示例服务器server_sample目录
+	touch server_sample/BUILD.gn                 // 创建BUILD.gn编译文件
+	mkdir server_sample/include                     // 建立示例服务器头文件include目录
+	touch server_process.h                        // 创建server_process.h头文件
+	mkdir server_sample/src                        // 建立示例服务器c/c++文件src目录
+	touch server_sample/src/server_process.c      // 创建server_process.c文件
+	touch server_sample/src/main.cpp             // 创建main.cpp文件
+	```

 5. 编译文件BUILD.gn编写

-文件BUILD.gn一共编译两个ohos组件，一个是ohos_shared_library库文件libserver_process.z.so，另一个是ohos_executable可执行文件testserver。
+	文件BUILD.gn一共编译两个ohos组件，一个是ohos_shared_library库文件libserver_process.z.so，另一个是ohos_executable可执行文件testserver。

-```cmake
-import("//build/ohos.gni")
+	```cmake
+	import("//build/ohos.gni")

-ohos_shared_library("server_process") {
+	ohos_shared_library("server_process") {
 		sources = [
 			"//base/update/updateservice/./src/server_process.c",
 		]
@@ -85,9 +85,9 @@ ohos_shared_library("server_process") {
 		]

 		part_name = "update_service"
-}
+	}

-ohos_executable("testserver") {
+	ohos_executable("testserver") {
 		source = [
 			"//base/update/updateservice/server_sample/src/main.cpp",
 		]
@@ -101,87 +101,87 @@ ohos_executable("testserver") {
 		]

 		part_name = "update_service"
-}
-```
+	}
+	```

 6. 头文件server_process.h编写

-文件server_process.h声明了示例服务器的接口。
+	文件server_process.h声明了示例服务器的接口。

-```c++
-#ifndef __SERVER_PROCESS_H__
-#define __SERVER_PROCESS_H__
+	```c++
+	#ifndef __SERVER_PROCESS_H__
+	#define __SERVER_PROCESS_H__

-/*
-Init函数：用于创建socket环境，并预设置一些属性
-*/
-int Init();
+	/*
+	Init函数：用于创建socket环境，并预设置一些属性
+	*/
+	int Init();

-/*
-SetParam函数：所有插件参数设置的统一接口
-*/
-int SetParam(const char *key, const char *value);
+	/*
+	SetParam函数：所有插件参数设置的统一接口
+	*/
+	int SetParam(const char *key, const char *value);

-/*
-GetParam函数：所有插件参数获取的统一接口
-*/
-int GetParam(const char *key, char *value);
+	/*
+	GetParam函数：所有插件参数获取的统一接口
+	*/
+	int GetParam(const char *key, char *value);

-/*
-ReverseSetParamCallback函数：回调
-*/
-int ReverseSetParamCallback(int(*setParam)(const char *key, const char *value));
+	/*
+	ReverseSetParamCallback函数：回调
+	*/
+	int ReverseSetParamCallback(int(*setParam)(const char *key, const char *value));

-/*
-Open函数：用于服务打开的接口
-*/
-int Open();
+	/*
+	Open函数：用于服务打开的接口
+	*/
+	int Open();

-/*
-MainLoop函数：每隔100ms调用一次
-*/
-int MainLoop();
+	/*
+	MainLoop函数：每隔100ms调用一次
+	*/
+	int MainLoop();

-/*
-Close函数，用于关闭服务并释放资源
-*/
-int Close();
+	/*
+	Close函数，用于关闭服务并释放资源
+	*/
+	int Close();

-#endif //__SERVER_PROCESS_H__
-```
+	#endif //__SERVER_PROCESS_H__
+	```

 7. server_process.c、main.cpp编写

-文件server_process.c主要声明了服务器的返回报文格式respondContent，main.cpp可参考普通SSL协议的服务器编写，注意包含相关头文件，同时加载serverKey.pem和serverCert.cer两个证书。
+	文件server_process.c主要声明了服务器的返回报文格式respondContent，main.cpp可参考普通SSL协议的服务器编写，注意包含相关头文件，同时加载serverKey.pem和serverCert.cer两个证书。

-```c
-#include "server_process.h"
+	```c
+	#include "server_process.h"

-#include <netinet/in.h>
-#include <sys/types.h>
-#include <sys/socket.h>
-#include <arpa/inet.h>
-#include <unistd.h>
-#include <stdlib.h>
-#include <string.h>
-#include <stdio.h>
+	#include <netinet/in.h>
+	#include <sys/types.h>
+	#include <sys/socket.h>
+	#include <arpa/inet.h>
+	#include <unistd.h>
+	#include <stdlib.h>
+	#include <string.h>
+	#include <stdio.h>

-#include "openssl/err.h"
-#include "openssl/ssl.h"
+	#include "openssl/err.h"
+	#include "openssl/ssl.h"

-#define SERVER_PEM "/data/sdcard/serverKey.pem"  //使用绝对路径
-#define SERVER_CER "/data/sdcard/serverCert.cer" //使用绝对路径
+	#define SERVER_PEM "/data/sdcard/serverKey.pem"  //使用绝对路径
+	#define SERVER_CER "/data/sdcard/serverCert.cer" //使用绝对路径

-#define LOG_PRINT(fmt, ...) printf("[ServerProcess][%s:%d] " fmt "\n", __func__, __LINE__, ##__VA_ARGS__)
-#define DO_CHECK(cond, log, ...) \
+	#define LOG_PRINT(fmt, ...) printf("[ServerProcess][%s:%d] " fmt "\n", __func__, __LINE__, ##__VA_ARGS__)
+	#define DO_CHECK(cond, log, ...) \
 		if (!(cond)) {\
 			LOG_PRINT(log);\
 			__VA_ARGS__;\
 			return -1;\
 		}

-// 请参考server_process.h的接口予以实现，注意服务器返回的内容格式。
-respondContent = "{"
+	// 请参考server_process.h的接口予以实现，注意服务器返回的内容格式。
+	respondContent = "{"
 		"\"searchStatus\": 0,"
 		"\"errMsg\": \"success\","
 		"\"checkResults\": [{"
@@ -197,22 +197,21 @@ respondContent = "{"
 			"\"content\": \"This package message is used for sampleContent\""
 		"}]"
 	"}";
-```
+	```

 8. 编译输出产物

-编译输出目录会新增testserver和libserver_process.z.so两个文件。
+	编译输出目录会新增testserver和libserver_process.z.so两个文件。

 9. 升级包制作

-[参考OpenHarmony的update_packaging_tools仓制作升级包。](https://gitee.com/openharmony/update_packaging_tools)
+	[参考OpenHarmony的update_packaging_tools仓制作升级包。](https://gitee.com/openharmony/update_packaging_tools)

 10. 启动搜包服务器

+	建议在开发板上新建一个纯英文路径，然后将testserver、libserver_process.z.so、serverCert.cer和serverKey.pem放到同一个目录下，进入该目录，执行以下启动命令即可启动搜包服务器。

-建议在开发板上新建一个纯英文路径，然后将testserver、libserver_process.z.so、serverCert.cer和serverKey.pem放到同一个目录下，进入该目录，执行以下启动命令即可启动搜包服务器。
-
-```bash
-./testserver ./libserver_process.z.so &
-```
+	```bash
+	./testserver ./libserver_process.z.so &
+	```