update front development guide

This commit is contained in:
CaiHQ 2023-03-18 21:57:34 +08:00
parent acc103e6a4
commit adcb9d40a5
18 changed files with 2400 additions and 151 deletions

View File

@ -93,14 +93,13 @@ NodePortal.html可参考[BDContract管理页面](https://public.internetapi.c
部署至远程服务端执行":backend:deploy"任务:
即执行./backend/build.gradle 中的 deploy。
## 前端sdk说明
1. 如何使用javascript sdk
2. 如何使用typescript sdk
3. 示例使用vite/vue/...等框架
3. 如何配置成前后端独立连接的
4. 如何配置成前后端一体化
## 前端开发说明
详见[front/README.md](./front/README.md)
启动好之后,可通过以下路径访问前端:
```json
http://127.0.0.1:21030/DOIP/ContractExample/assets/vite/dist/index.html
http://127.0.0.1:21030/DOIP/ContractExample/assets/html/index.html
```
## 模拟后端数据
## 后端常用方法说明

View File

@ -39,7 +39,7 @@ sourceSets {
dependencies {
api 'org.apache.logging.log4j:log4j-core:2.17.2'
api 'org.apache.logging.log4j:log4j-api:2.17.2'
implementation 'org.bdware.sc:cp:1.6.8'
implementation 'org.bdware.sc:cp:1.8.0'
testImplementation 'junit:junit:4.13.2'
}
@ -52,7 +52,12 @@ task copyYJS(type: Copy) {
from "./yjs"
into "./build/output/"
}
//TODO
// from "../front/vite/dist"
task copyFront(type: Copy) {
from "../front"
into "./build/output/assets"
}
task sourcesJar(type: Jar) {
from sourceSets.main.allJava
archiveClassifier = 'sources'
@ -72,7 +77,7 @@ task copyJar(type: Copy, dependsOn: [":backend:jar", ":backend:copyLibs"]) {
}
def reltivePath = "./backend"
//reltivePath="."
def currVersion = "1.3.2"
def currVersion = "1.3.3"
task grepCP(dependsOn: ["copyJar"]) {
doLast {
org.bdware.datanet.YPKPacker.grepJarByCPVersion("${reltivePath}/build/output/libs", org.bdware.datanet.CPVersion.cp_1_6_8)
@ -83,7 +88,7 @@ task grepCP(dependsOn: ["copyJar"]) {
tasks.processResources.setDuplicatesStrategy(DuplicatesStrategy.INCLUDE)
tasks.processTestResources.setDuplicatesStrategy(DuplicatesStrategy.INCLUDE)
task buildZip(type: Zip, dependsOn: ["copyAssets", "copyJar", "copyYJS", "grepCP"]) {
task buildZip(type: Zip, dependsOn: ["copyAssets", "copyJar", "copyYJS", "grepCP", "copyFront"]) {
from './build/output/'
duplicatesStrategy = DuplicatesStrategy.INCLUDE
archiveFileName = 'contractexample.zip'
@ -95,6 +100,7 @@ task buildYPK(dependsOn: ["buildZip"]) {
org.bdware.datanet.YPKPacker.staticPack("${reltivePath}/build/contractexample.zip", "${reltivePath}/build/contractexample-${currVersion}.ypk")
}
}
task deploy(dependsOn: ["buildYPK"]) {
doLast {
org.bdware.ypkdeploy.HTTPTool.deployWithYpk("${reltivePath}/debugconf.json", "${reltivePath}/build/contractexample-${currVersion}.ypk")

View File

@ -2,7 +2,7 @@
"agentAddress": "127.0.0.1:21030",
"publicKey": "04180354fdb6507f8ab98ccfbe165ce11da74ba733f81af86ad6d32216b32cf4f797c559d50ceeefbf4c760c3483840471c67471b90acdffb388cd7d496d9a1610",
"privateKey": "1d4196947f59532db6f8f4055e58474a48db8f30b476ae3edc66406464521b3b",
"ypkPath": "./build/contractexample-1.3.0.ypk",
"ypkPath": "./build/contractexample-1.3.3.ypk",
"killBeforeStart": "ContractExample",
"createParam": {
},

View File

@ -23,9 +23,11 @@ services:
- ./bdcontract/ContractManagerDB:/bdcontract/ContractManagerDB
- ./bdcontract/BDWareProjectDir:/bdcontract/BDWareProjectDir
- ./bdcontract/cmconfig.json:/bdcontract/cmconfig.json:ro
# - ./bdcontract/cp:/bdcontract/cp
#- ./bdcontract/cp:/bdcontract/cp
- ./bdcontract/tls:/bdcontract/tls:ro
- ./bdcontract/manager.key:/bdcontract/manager.key:ro
# mapping the backend/build dir into docker, to support debug ypk
- ../backend/build:/bdcontract/build
ports:
- "21030:21030" # Contract manager API
- "21031:21031" # Contract manager master

View File

@ -1,127 +0,0 @@
木兰宽松许可证, 第2版
木兰宽松许可证, 第2版
2020年1月 http://license.coscl.org.cn/MulanPSL2
您对“软件”的复制、使用、修改及分发受木兰宽松许可证第2版“本许可证”的如下条款的约束
0. 定义
“软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。
“贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。
“贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。
“法人实体”是指提交贡献的机构及其“关联实体”。
“关联实体”是指对“本许可证”下的行为方而言控制、受控制或与其共同受控制的机构此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。
1. 授予版权许可
每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。
2. 授予专利许可
每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。
3. 无商标许可
“本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可但您为满足第4条规定的声明义务而必须使用除外。
4. 分发限制
您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。
5. 免责声明与责任限制
“软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。
6. 语言
“本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。
条款结束
如何将木兰宽松许可证第2版应用到您的软件
如果您希望将木兰宽松许可证第2版应用到您的新软件为了方便接收者查阅建议您完成如下三步
1 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字;
2 请您在软件包的一级目录下创建以“LICENSE”为名的文件将整个许可证文本放入该文件中
3 请将如下声明文本放入每个源文件的头部注释中。
Copyright (c) [2021] [BDWare Group]
[Software Name] is licensed under Mulan PSL v2.
You can use this software according to the terms and conditions of the Mulan PSL v2.
You may obtain a copy of Mulan PSL v2 at:
http://license.coscl.org.cn/MulanPSL2
THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
See the Mulan PSL v2 for more details.
Mulan Permissive Software LicenseVersion 2
Mulan Permissive Software LicenseVersion 2 (Mulan PSL v2)
January 2020 http://license.coscl.org.cn/MulanPSL2
Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions:
0. Definition
Software means the program and related documents which are licensed under this License and comprise all Contribution(s).
Contribution means the copyrightable work licensed by a particular Contributor under this License.
Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License.
Legal Entity means the entity making a Contribution and all its Affiliates.
Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, control means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity.
1. Grant of Copyright License
Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not.
2. Grant of Patent License
Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken.
3. No Trademark License
No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4.
4. Distribution Restriction
You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software.
5. Disclaimer of Warranty and Limitation of Liability
THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW ITS CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
6. Language
THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL.
END OF THE TERMS AND CONDITIONS
How to Apply the Mulan Permissive Software LicenseVersion 2 (Mulan PSL v2) to Your Software
To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps:
i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner;
ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package;
iii Attach the statement to the appropriate annotated syntax at the beginning of each source file.
Copyright (c) [Year] [name of copyright holder]
[Software Name] is licensed under Mulan PSL v2.
You can use this software according to the terms and conditions of the Mulan PSL v2.
You may obtain a copy of Mulan PSL v2 at:
http://license.coscl.org.cn/MulanPSL2
THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
See the Mulan PSL v2 for more details.

57
front/README.md Normal file
View File

@ -0,0 +1,57 @@
# contract-java-example 前端开发说明
前端与后端支持分离开发。注意启动好docker与后端之后可单独对前端进行调试和开发。
注意在单独开发前端时,需将后端地址设置为可配置的选项。
当前端代码与后端代码打包到一起之后,前端中的`./index.html`文件会映射为`http://host:port/DOIP/ContractExample/assets/index.html`。
因此,后端的地址可通过以下代码计算得出:
```javascript
var url = document.location.href.replaceAll(/\/DOIP.*$/g,'/SCIDE')
// 对应后端地址为url = 'http://host:port/SCIDE';
```
前端代码成功打包之后,可通过以下路径分访问前端页面。
```json
http://127.0.0.1:21030/DOIP/ContractExample/assets/vite/dist/index.html
http://127.0.0.1:21030/DOIP/ContractExample/assets/html/index.html
```
## 使用html/js
见`html/index.html`。
引用sdk及其依赖的js文件。
```
<script src="./cryptico.iife.js"></script>
<script src="./sm2.js"></script>
<script src="./axios-fetch.iife.js"></script>
<script src="./axios.min.js"></script>
<script src="./bdcontract-sdk.iife.js"></script>
```
### 调试与开发
可在本地安装npm利用`npm install -g http-server`来安装一个简单的httpserver。
在命令行中可启动该服务器,托管前端代码。
```
cd ./front/html
http-server
```
后续仅需修改`front/html`下的前端文件即可。
## 使用ts+vite等框架开发前端
[前端sdk](https://www.npmjs.com/package/@bdware/bdcontract-sdk) 在npm仓库中。
调用示例参考:`front/vite/src/main.ts`。
```javascript
const url = 'http://127.0.0.1:21030/SCIDE';
var sm2Key = {"publicKey": "04180354fdb6507f8ab98ccfbe165ce11da74ba733f81af86ad6d32216b32cf4f797c559d50ceeefbf4c760c3483840471c67471b90acdffb388cd7d496d9a1610",
"privateKey": "1d4196947f59532db6f8f4055e58474a48db8f30b476ae3edc66406464521b3b"};
const client = new HttpClient(url, sm2Key);
const data = await client.executeContract(
'ContractExample',
'callHello',
'abc');
alert(data.data);
```
### 调试与开发
打开命令行,在`front/vite`目录下,使用`npm run dev`,开启调试,
打开按命令行中的提示地下,打开浏览器页面,如`http://localhost:3000/`即可。

View File

@ -0,0 +1,114 @@
var axiosFetch = (function (exports) {
'use strict';
var src = {};
var typeUtils = {};
Object.defineProperty(typeUtils, "__esModule", { value: true });
typeUtils.getUrl = typeUtils.createAxiosHeaders = typeUtils.createFetchHeaders = void 0;
function createFetchHeaders(axiosHeaders = {}) {
const headers = [];
Object.entries(axiosHeaders).forEach(([name, value]) => {
headers.push([name, value]);
});
return headers;
}
typeUtils.createFetchHeaders = createFetchHeaders;
const isHeaders = (headers) => { var _a; return ((_a = headers.constructor) === null || _a === void 0 ? void 0 : _a.name) === 'Headers'; };
function createAxiosHeaders(headers = {}) {
const rawHeaders = {};
if (isHeaders(headers)) {
headers.forEach((value, name) => {
rawHeaders[name] = value;
});
}
else if (Array.isArray(headers)) {
headers.forEach(([name, value]) => {
if (value) {
rawHeaders[name] = value;
}
});
}
else {
Object.entries(headers).forEach(([name, value]) => {
if (value) {
rawHeaders[name] = value;
}
});
}
return rawHeaders;
}
typeUtils.createAxiosHeaders = createAxiosHeaders;
function getUrl(input) {
let url;
if (typeof input === 'string') {
url = input;
}
else if (input === null || input === void 0 ? void 0 : input.href) {
url = input.href;
}
else if (input === null || input === void 0 ? void 0 : input.url) {
url = input.url;
}
return url;
}
typeUtils.getUrl = getUrl;
Object.defineProperty(src, "__esModule", { value: true });
exports.buildAxiosFetch = src.buildAxiosFetch = void 0;
const typeUtils_1 = typeUtils;
/**
* A Fetch WebAPI implementation based on the Axios client
*/
const axiosFetch = (axios,
// Convert the `fetch` style arguments into a Axios style config
transformer = (config) => config) => async (input, init) => {
const rawHeaders = (0, typeUtils_1.createAxiosHeaders)(init === null || init === void 0 ? void 0 : init.headers);
const lowerCasedHeaders = {};
Object.entries(rawHeaders).forEach(([name, value]) => {
lowerCasedHeaders[name.toLowerCase()] = value;
});
if (!('content-type' in lowerCasedHeaders)) {
lowerCasedHeaders['content-type'] = 'text/plain;charset=UTF-8';
}
const rawConfig = {
url: (0, typeUtils_1.getUrl)(input),
method: (init === null || init === void 0 ? void 0 : init.method) || 'GET',
data: init === null || init === void 0 ? void 0 : init.body,
headers: lowerCasedHeaders,
// Force the response to an arraybuffer type. Without this, the Response
// object will try to guess the content type and add headers that weren't in
// the response.
// NOTE: Don't use 'stream' because it's not supported in the browser
responseType: 'arraybuffer'
};
const config = transformer(rawConfig, input, init);
let result;
try {
result = await axios.request(config);
}
catch (err) {
if (err.response) {
result = err.response;
}
else {
throw err;
}
}
return new Response(result.data, {
status: result.status,
statusText: result.statusText,
headers: (0, typeUtils_1.createFetchHeaders)(result.headers)
});
};
const buildAxiosFetch = (axios, transformer) => axiosFetch(axios, transformer);
exports.buildAxiosFetch = src.buildAxiosFetch = buildAxiosFetch;
exports["default"] = src;
Object.defineProperty(exports, '__esModule', { value: true });
return exports;
})({});

2
front/html/axios.min.js vendored Normal file

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

28
front/html/index.html Normal file
View File

@ -0,0 +1,28 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8"/>
<script src="./cryptico.iife.js"></script>
<script src="./sm2.js"></script>
<script src="./axios-fetch.iife.js"></script>
<script src="./axios.min.js"></script>
<script src="./bdcontract-sdk.iife.js"></script>
<script>
async function run(){
const url = 'http://127.0.0.1:21030/SCIDE';
var sm2Key = {"publicKey": "04180354fdb6507f8ab98ccfbe165ce11da74ba733f81af86ad6d32216b32cf4f797c559d50ceeefbf4c760c3483840471c67471b90acdffb388cd7d496d9a1610",
"privateKey": "1d4196947f59532db6f8f4055e58474a48db8f30b476ae3edc66406464521b3b"};
const client = new bdcontract.HttpClient(url, sm2Key);
const data = await client.executeContract(
'ContractExample',
'callHello',
'abc');
alert(data.data);
};
run();
</script>
<title>Example</title>
</head>
<body></body>
</html>

2102
front/html/sm2.js Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,10 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Index.html</title>
</head>
<body>
Hello.
</body>
</html>

4
front/vite/.gitignore vendored Normal file
View File

@ -0,0 +1,4 @@
.husky
dist
package-lock.json
node_modules

13
front/vite/index.html Normal file
View File

@ -0,0 +1,13 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" href="/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>vite template</title>
</head>
<body>
<div id="app"></div>
<script type="module" src="./src/main.ts"></script>
</body>
</html>

29
front/vite/package.json Normal file
View File

@ -0,0 +1,29 @@
{
"name": "example-front",
"version": "0.0.1",
"scripts": {
"dev": "vite --host",
"build": "vite build",
"prod": " vue-tsc --noEmit &&vite build",
"serve": "vite preview",
"lint": "eslint --ext .vue,.js,.ts ./",
"prepare": "cd ../../ && husky install front/vite/.husky"
},
"lint-staged": {
"*.{vue,js,ts}": "eslint --fix"
},
"dependencies": {
"@bdware/bdcontract-sdk": "^0.4.0-beta",
"husky": "^6.0.0",
"vite": "^3.0.0",
"@vitejs/plugin-vue": "3.2.0"
},
"devDependencies": {
"husky": "^6.0.0"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-customizable"
}
}
}

13
front/vite/src/main.ts Normal file
View File

@ -0,0 +1,13 @@
import {HttpClient} from '@bdware/bdcontract-sdk'
async function run(){
const url = 'http://127.0.0.1:21030/SCIDE';
var sm2Key = {"publicKey": "04180354fdb6507f8ab98ccfbe165ce11da74ba733f81af86ad6d32216b32cf4f797c559d50ceeefbf4c760c3483840471c67471b90acdffb388cd7d496d9a1610",
"privateKey": "1d4196947f59532db6f8f4055e58474a48db8f30b476ae3edc66406464521b3b"};
const client = new HttpClient(url, sm2Key);
const data = await client.executeContract(
'ContractExample',
'callHello',
'abc');
alert(data.data);
}
run();

13
front/vite/vite.config.ts Normal file
View File

@ -0,0 +1,13 @@
import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
export default defineConfig({
base: './', // 设开发或生产环境服务的 公共基础路径
define: { // 类型: Record<string, string> 定义全局变量替换方式。每项在开发时会被定义为全局变量,而在构建时则是静态替换。
'process.platform': null,
'process.version': null,
},
plugins: [ // 类型: (Plugin | Plugin[])[] 将要用到的插件数组
vue()
],
});