sannilake
/
phizclip-android-demo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

英文版readme翻译

master
sannilake 2023-11-09 15:29:32 +08:00
parent cbf7e51d2e
commit 4686469eec
3 changed files with 232 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,18 +1,18 @@
<p align="center">
<a href="https://www.finclip.com?from=github">
<img width="auto" src="https://www.finclip.com/mop/document/images/logo.png">
<img width="auto" src="./phizlogo.png">
</a>
</p>
<p align="center">
<strong>FinClip Android DEMO</strong></br>
<strong>PhizClip Android DEMO</strong></br>
<p>
<p align="center">
本项目提供在 Android 环境中运行小程序的 DEMO 样例
<p>
<p align="center">
👉 <a href="https://www.finclip.com?from=github">https://www.finclip.com/</a> 👈
👉 <a href="https://www.finclip.com?from=github">https://www.phizclip.com/</a> 👈
</p>
<div align="center">
@ -22,8 +22,7 @@
<a href="#"><img src="https://img.shields.io/badge/%E5%B7%B2%E9%9B%86%E6%88%90%E5%B0%8F%E7%A8%8B%E5%BA%8F%E5%BA%94%E7%94%A8-75%2B-yellow"></a>
<a href="#"><img src="https://img.shields.io/badge/%E5%AE%9E%E9%99%85%E8%A6%86%E7%9B%96%E7%94%A8%E6%88%B7-2500%20%E4%B8%87%2B-orange"></a>
<a href="https://www.zhihu.com/org/finchat"><img src="https://img.shields.io/badge/FinClip--lightgrey?logo=zhihu&style=social"></a>
<a href="https://www.finclip.com/blog/"><img src="https://img.shields.io/badge/FinClip%20Blog--lightgrey?logo=ghost&style=social"></a>
@ -38,13 +37,13 @@
</div>
-----
## 🤔 FinClip 是什么?
## 🤔 PhizClip 是什么?
有没有**想过**，开发好的微信小程序能放在自己的 APP 里直接运行，只需要开发一次小程序，就能在不同的应用中打开它，是不是很不可思议？
有没有**试过**，在自己的 APP 中引入一个 SDK ，应用中不仅可以打开小程序，还能自定义小程序接口，修改小程序样式，是不是觉得更不可思议？
这就是 FinClip ，就是有这么多不可思议！
这就是 PhizClip ，就是有这么多不可思议！
## ⚙️ 操作步骤
### 第一步 配置 build.gradle 文件
@ -130,11 +129,11 @@ FinAppClient.INSTANCE.getAppletApiManager().startApplet(this, "appid");
```
- **SDK KEY** 和 **SDK SECRET** 可以从 [FinClip](https://finclip.com/#/home) 获取，点 [这里](https://finclip.com/#/register) 注册账号；
- **SDK KEY** 和 **SDK SECRET** 可以从 [PhizClip](https://finclip.com/#/home) 获取，点 [这里](https://finclip.com/#/register) 注册账号；
- 进入平台后，在「应用管理」页面添加你自己的包名后，点击「复制」即可获得 key\secret\apisever 字段；
- **apiServer** 和 **apiPrefix** 是固定字段，请直接参考本 DEMO ；
- **小程序 ID** 是管理后台上架的小程序 APP ID，需要在「小程序管理」中创建并在「应用管理」中关联；
> 小程序 ID 与 微信小程序ID 不一样哦！（这里是特指 FinClip 平台的 ID ）
> 小程序 ID 与 微信小程序ID 不一样哦！（这里是特指 PhizClip 平台的 ID ）
## 📋 集成文档
@ -191,9 +190,9 @@ FinAppClient.INSTANCE.getAppletApiManager().startApplet(this, "appid");
```
## 🔗 常用链接
以下内容是您在 FinClip 进行开发与体验时，常见的问题与指引信息
以下内容是您在 PhizClip 进行开发与体验时，常见的问题与指引信息
- [FinClip 官网](https://www.finclip.com/#/home)
- [PhizClip 官网](https://www.finclip.com/#/home)
- [示例小程序](https://www.finclip.com/#/market)
- [文档中心](https://www.finclip.com/mop/document/)
- [SDK 部署指南](https://www.finclip.com/mop/document/introduce/quickStart/intergration-guide.html)
@ -214,3 +213,8 @@ FinAppClient.INSTANCE.getAppletApiManager().startApplet(this, "appid");
## Forkers
[![Forkers repo roster for @finogeeks/finclip-android-demo](https://reporoster.com/forks/finogeeks/finclip-android-demo)](https://github.com/finogeeks/finclip-android-demo/network/members)
## 🌏 多语言文档
- [简体中文](./README.md)
- [English](./readme_en.md)
- [Português](./readme_pt.md)

BIN
phizlogo.png 100644
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.8 KiB

217
readme_en.md 100644
View File

@ -0,0 +1,217 @@
<p align="center">
<a href="https://www.finclip.com?from=github">
<img width="auto" src="./phizlogo.png">
</a>
</p>
<p align="center">
<strong>PhizClip Android DEMO</strong></br>
<p>
<p align="center">
👉 <a href="https://www.finclip.com?from=github">https://www.phizclip.com/</a> 👈
</p>
<div align="center">
<a href="#"><img src="https://img.shields.io/badge/Developers-20,000%2B-brightgreen"></a>
<a href="#"><img src="https://img.shields.io/badge/Uploaded&nbsp;Mini&nbsp;Programs-6,000%2B-blue"></a>
<a href="#"><img src="https://img.shields.io/badge/Apps&nbsp;with&nbsp;FinClip-75%2b-yellow"></a>
<a href="#"><img src="https://img.shields.io/badge/Covered&nbsp;Users-25Million-orange"></a>
</div>
<p align="center">
<div align="center">
[Home Page](https://www.finclip.com/) | [Example Mini-App](https://www.finclip.com/#/market) | [Documentation](https://www.finclip.com/mop/document/) | [Deployment Guide](https://www.finclip.com/mop/document/introduce/quickStart/cloud-server-deployment-guide.html) <br> [SDK Integration Guide](https://www.finclip.com/mop/document/introduce/quickStart/intergration-guide.html) | [API List](https://www.finclip.com/mop/document/develop/api/overview.html) | [Component List](https://www.finclip.com/mop/document/develop/component/overview.html) | [Privacy Commitment](https://www.finclip.com/mop/document/operate/safety.html)
</div>
-----
## 🤔 What is PhizClip?
Have you ever **thought** that the developed WeChat Mini-App can be put in your own APP to run directly, and you only need to develop the Mini-App once, and then you can open it in different applications, isn't it incredible?
Have you ever **tried** to introduce an SDK in your own APP, and you can not only open the Mini-App in the app, but also customize the Mini-App interface and modify the Mini-App style, don't you think it is more incredible?
**This is PhizClip, with much INCREDIBLE !**
## ⚙️ Steps
### The first step is to configure the build.gradle file
Add the address of the maven warehouse in the project's `build.gradle`:
```bash
buildscript {
repositories {
google()
jcenter()
}
dependencies {
classpath "com.android.tools.build:gradle:3.5.2"
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.60"
}
}
allprojects {
repositories {
google()
jcenter()
maven { url "https://jitpack.io" }
maven {
url "https://gradle.finogeeks.club/repository/applet/"
credentials {
username "applet"
password "123321"
}
}
}
}
```
### Step 2 Depend on SDK in gradle
`implementation 'com.finogeeks.lib:finapplet:+'`
### Step 3 Configure obfuscation rules
After integrating the SDK, in order to avoid obfuscation of some codes in the SDK that cannot be obfuscated, the following configuration needs to be added to the obfuscation rule configuration file of the project:
``-keep class com.finogeeks.** {*;}``
### Step 4 SDK initialization
We strongly recommend initializing the SDK in `Application`. The parameters that need to be passed in to initialize the SDK are as follows:
```java
FinAppConfig config = new FinAppConfig.Builder()
.setAppKey("SDKKEY")
.setAppSecret("SECRET")
.setApiUrl("https://api.finclip.com")
.setApiPrefix("/api/v1/mop/")
.setGlideWithJWT(false)
.build();
FinCallback<Object> callback = new FinCallback<Object>() {
@Override
public void onSuccess(Object result) {
// SDK initialization successful
}
@Override
public void onError(int code, String error) {
// SDK initialization failed
Toast.makeText(AppletApplication.this, "SDK initialization failed", Toast.LENGTH_SHORT).show();
}
@Override
public void onProgress(int status, String error) {
}
};
FinAppClient.INSTANCE.init(this, config, callback);
```
The SDK is implemented using a multi-process mechanism. Each applet runs in an independent process, that is, one applet corresponds to one process. When initializing the SDK, special attention should be paid to the following: **When the mini program process is created, there is no need to perform any initialization operations. Even the initialization of the mini program SDK does not need to be performed in the mini program process.**
> Give an example🌰<br>
The application uses some third-party libraries. These libraries need to be initialized when the application starts. When initializing in Application, these third-party libraries only need to be initialized when the current process is the host process. Mini program processes do not need to initialize these libraries. of. <br>
Therefore, before initializing the SDK, you must determine which process the current process is. If it is a small program process, no operations will be performed:
```java
if (FinAppClient.INSTANCE.isFinAppProcess(this)) {
return;
}
```
### Step 5: Open the mini program
```java
FinAppClient.INSTANCE.getAppletApiManager().startApplet(this, "appid");
```
- **SDK KEY** and **SDK SECRET** can be obtained from [PhizClip](https://finclip.com/#/home), click [here](https://finclip.com/#/register ) Register an account;
- After entering the platform, add your own package name on the "Application Management" page and click "Copy" to get the key\secret\apisever field;
- **apiServer** and **apiPrefix** are fixed fields, please refer to this DEMO directly;
- **Mini Program ID** is the Mini Program APP ID listed in the management background. It needs to be created in "Mini Program Management" and associated in "Application Management";
> The Mini Program ID is different from the WeChat Mini Program ID! (This refers specifically to the ID of the PhizClip platform)
## 📋 Integrated documentation
[Click here](https://www.finclip.com/mop/document/introduce/quickStart/intergration-guide.html#_2-android-%E5%BF%AB%E9%80%9F%E9%9B%86%E6%88%90) View the Android Quick Integration documentation
## 📘 Directory Structure
```
.
├─.github
│
├─.idea Automatically generated by the IDE, no need to pay attention
│
├─app Project source code main directory
│ │
│ │ build.gradle Apply build configuration
│ │
│ │ proguard-rules.pro Obfuscated configuration
│ │
│ ├─release Build the apk directory generated by the application
│ │
│ └─src
│ ├─androidTest Unit test directory, automatically generated by the IDE, no need to pay attention
│ │
│ ├─main Application source code main directory
│ │ │ AndroidManifest.xml application manifest file
│ │ │
│ │ ├─java Application source code directory
│ │ │
│ │ └─res Resource file directory
│ │ ├─drawable darwable resource directory
│ │ │
│ │ ├─drawable-v24 darwable resource directory
│ │ │
│ │ ├─layout Layout file directory
│ │ │
│ │ ├─mipmap-anydpi-v26 Picture resource directory
│ │ │
│ │ ├─mipmap-hdpi Picture resource directory
│ │ │
│ │ ├─mipmap-mdpi Picture resource directory
│ │ │
│ │ ├─mipmap-xhdpi Picture resource directory
│ │ │
│ │ ├─mipmap-xxhdpi Picture resource directory
│ │ │
│ │ ├─mipmap-xxxhdpi Picture resource directory
│ │ │
│ │ └─values Configuration directory of various resource values
│ │
│ └─test Unit test directory, automatically generated by the IDE, no need to pay attention
│
└─gradle Gradle version configuration directory, generally no need to pay attention to it
```
## 🔗 Links
The following is information on common questions and guidelines for your development and experience with PhizClip
- [Home Page](https://www.finclip.com/#/home)
- [Example Mini-App](https://www.finclip.com/#/market)
- [Documentation](https://www.finclip.com/mop/document/)
- [SDK Integration Guide](https://www.finclip.com/mop/document/introduce/quickStart/intergration-guide.html)
- [Structure of PhizClip](https://www.finclip.com/mop/document/develop/guide/structure.html)
- [Integration Guidelines(iOS)](https://www.finclip.com/mop/document/runtime-sdk/ios/ios-integrate.html)
- [Integration Guidelines(Android)](https://www.finclip.com/mop/document/runtime-sdk/android/android-integrate.html)
- [Integration Guidelines(Flutter)](https://www.finclip.com/mop/document/runtime-sdk/flutter/flutter-integrate.html)
## ☎️ Contact
Scan the QR code below with WeChat and follow the official public number **Finogeeks** for more exciting content.<br>
<img width="150px" src="https://www.finclip.com/mop/document/images/ic_qr.svg">
Scan the QR code below with WeChat and invite into the official WeChat exchange group (add friend note: **finclip consulting**) to get more exciting content.<br>
<img width="150px" src="https://finclip-homeweb-1251849568.cos.ap-guangzhou.myqcloud.com/images/ldy111.jpg">
## Stargazers
[![Stargazers repo roster for @finogeeks/finclip-android-demo](https://reporoster.com/stars/finogeeks/finclip-android-demo)](https://github.com/finogeeks/finclip-android-demo/stargazers)
## Forkers
[![Forkers repo roster for @finogeeks/finclip-android-demo](https://reporoster.com/forks/finogeeks/finclip-android-demo)](https://github.com/finogeeks/finclip-android-demo/network/members)
## 🌏 Languages
- [简体中文](./README.md)
- [English](./readme_en.md)
- [Português](./readme_pt.md)