mirror of
https://gitee.com/energye/energy.git
synced 2024-12-04 12:47:57 +08:00
184 lines
8.2 KiB
Markdown
184 lines
8.2 KiB
Markdown
<p align="center">
|
||
<img src="https://assets.yanghy.cn/energy-doc/energy-icon.png">
|
||
</p>
|
||
|
||
# Energy 是Go基于CEF构建桌面应用的框架
|
||
|
||
中文 |
|
||
[English](README.md)
|
||
|
||
---
|
||
|
||
[](https://github.com/energye/energy)
|
||
[](https://github.com/energye/energy/releases)
|
||
[](http://www.apache.org/licenses/LICENSE-2.0)
|
||
|
||
|
||
|
||
---
|
||
|
||
### [项目简介](https://energy.yanghy.cn/#/course/6342d92c401bfe4d0cdf6065/6350f94ca749ba0318943f25)
|
||
|
||
> [energy](https://github.com/energye/energy) 是 Go 基于 CEF(Chromium Embedded Framework)
|
||
> 开发的框架，内嵌 [CEF](https://bitbucket.org/chromiumembedded/cef) 二进制
|
||
>
|
||
> 使用 Go 和 Web 端技术 ( HTML + CSS + JavaScript ) 构建支持Windows, Linux, MacOS跨平台桌面应用
|
||
>
|
||
> 需要会前端技术栈和略懂Go语言
|
||
|
||
### 特性
|
||
|
||
> - 开发环境简单,编译速度快,只需要Go开发环境和Energy依赖的CEF二进制框架
|
||
> - 跨平台: 一套代码可以打包成 Windows, 国产UOS、Deepin、Kylin, MacOS, Linux
|
||
> - 语言职责
|
||
>> - Go: Go负责窗口创建、CEF配置和功能实现、各种UI组件创建、系统低层调用，和JS处理不了的功能如: 文件流、安全加密、高性能处理等等，可作为纯后端开发
|
||
>> - Web: HTML + CSS + JavaScript 负责客户端界面的功能, 做出任意你想要的界面，可作为纯前端开发
|
||
> - 前端技术: 支持主流前端框架例如：Vue、React、Angular, 或纯HTML+CSS等等
|
||
> - 事件驱动: 高性能事件驱动, 基于IPC通信，实现Go和Web端很方便功能调用以及数据交互
|
||
|
||
#### 事件驱动 Go和Web交互
|
||
|
||
> - 在Go和Web技术基于IPC通信，可以在Go和Web交互数据、事件触发, 可以不使用 http 接口，就像调用语言本身函数一样简单
|
||
> - 在Go中定义JS绑定类型变量，提供给Web端JS使用，实现Go变量或结构对象数据同步
|
||
> - 在JS监听事件，在Go中触发JS事件，以达到Go调用JS函数和数据传递
|
||
> - 在Go监听事件，在JS中触发Go事件，以达到JS调用Go函数和数据传递
|
||
|
||
### 内置依赖&集成
|
||
|
||
- [](https://github.com/energye/golcl)
|
||
- [](https://github.com/energye/liblcl)
|
||
- [](https://github.com/salvadordf/CEF4Delphi)
|
||
- [-green)](https://bitbucket.org/chromiumembedded/cef)
|
||
|
||
### [开发环境](https://energy.yanghy.cn/#/course/6342d92c401bfe4d0cdf6065/63511b14a749ba0318943f3a)
|
||
|
||
#### 基本需求
|
||
|
||
> - golang >= 1.18
|
||
> - energy 开发环境
|
||
>
|
||
> 使用 energy 命令行工具自动安装开发环境
|
||
>
|
||
> 获取 [energy](https://github.com/energye/energy)
|
||
> 项目，或直接使用预编译命令行工具 [下载地址](https://energy.yanghy.cn/#/course/6342d92c401bfe4d0cdf6065/63511b14a749ba0318943f3a)
|
||
> 1. go get github.com/energye/energy
|
||
>
|
||
> 进入 [energy](https://github.com/energye/energy) 命令行目录
|
||
> 2. cd energy/cmd/energy
|
||
>
|
||
> 安装命令行工具
|
||
> 3. go install
|
||
>
|
||
> 执行安装命令
|
||
> 4. energy install .
|
||
|
||
### 入门指南 - [传送门](https://energy.yanghy.cn)
|
||
|
||
* [教程](https://energy.yanghy.cn/#/course/6342d92c401bfe4d0cdf6065/6350f94ca749ba0318943f25)
|
||
* [示例](https://energy.yanghy.cn/#/example/6342d986401bfe4d0cdf6067/634d3bd5a749ba0318943eb6)
|
||
* [文档](https://energy.yanghy.cn/#/document/6342d9a4401bfe4d0cdf6069/0)
|
||
|
||
### 快速入门
|
||
|
||
> 使用 [energy](https://github.com/energye/energy) 命令行工具自动安装环境依赖 `energy install .`
|
||
>
|
||
> 以example/simple示例为例
|
||
>
|
||
> 更新最新发布版本依赖
|
||
>
|
||
> 2. go mod tidy
|
||
>
|
||
> 在IDE中运行simple 或 go run simple.go
|
||
|
||
### example/simple 示例代码
|
||
|
||
```go
|
||
package main
|
||
|
||
import (
|
||
"github.com/energye/energy/cef"
|
||
)
|
||
|
||
func main() {
|
||
//全局初始化 每个应用都必须调用的
|
||
cef.GlobalInit(nil, nil)
|
||
//创建应用
|
||
cefApp := cef.NewApplication(nil)
|
||
//指定一个URL地址，或本地html文件目录
|
||
cef.BrowserWindow.Config.Url = "https://energy.yanghy.cn"
|
||
//运行应用
|
||
cef.Run(cefApp)
|
||
}
|
||
```
|
||
---
|
||
|
||
### 项目打包 [参考](https://energy.yanghy.cn/#/course/6342d92c401bfe4d0cdf6065/636e397ba749ba01d04ff595)
|
||
1. 编译：Go 程序编译`go build xxx.go` 如果使用资源内置(HTML、CSS、JavaScript、Image等等)会把资源编译到执行文件内
|
||
2. 复制：把执行文件复制到ENERGY环境的CEF目录中即可
|
||
3. 打包：使用制作安装包工具将其制作为安装包, 查阅各系统平台安装包制作
|
||
4. 最后：编译后的程序或安装包和CEF目录不再需要配置环境,在CEF根目录可直接运行
|
||
|
||
#### Go编译命令
|
||
1. 压缩并隐藏cmd窗口 `go build -ldflags "-H windowsgui -s -w"`, 注意: windows需要隐藏CMD窗口
|
||
2. 会压缩 不隐藏cmd窗口 `go build -ldflags "-s -w"`
|
||
2. 不压缩 不隐藏cmd窗口 `go build`
|
||
|
||
---
|
||
|
||
### 系统支持
|
||
|
||
|
||
|
||
|
||
|
||
|
||
| | 32位 | 64位 | 测试系统版本 |
|
||
|-----------|---------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|--------------------------------------|
|
||
| Windows |  |  | Windows 7、Windows 10 |
|
||
| MacOSX |  |  | MacOSX 10.15 |
|
||
| Linux |  |  | Deepin20.8、Ubuntu18.04、LinuxMint21 |
|
||
| Linux ARM |  |  | Kylin-V10-SP1-2107 |
|
||
|
||
---
|
||
|
||
### QQ交流群
|
||
|
||
[](https://jq.qq.com/?_wv=1027&k=YgFjCGJX)
|
||
|
||
<img src="https://assets.yanghy.cn/energy-doc/qq-group.jpg" width="300">
|
||
|
||
---
|
||
|
||
### 项目截图
|
||
##### Windows-10
|
||
<img src="https://assets.yanghy.cn/energy-doc/frameless-windows-10.png">
|
||
|
||
##### Windows-7 32 & 64
|
||
<img src="https://assets.yanghy.cn/energy-doc/frameless-windows-7-64.png">
|
||
<img src="https://assets.yanghy.cn/energy-doc/frameless-windows-7-32.png">
|
||
|
||
##### Linux - 国产 Deepin
|
||
<img src="https://assets.yanghy.cn/energy-doc/frameless-deepin-20.8.png">
|
||
<img src="https://assets.yanghy.cn/energy-doc/frameless-deepin-hide-20.8.png">
|
||
|
||
##### Linux - 国产 Kylin ARM
|
||
<img src="https://assets.yanghy.cn/energy-doc/frameless-kylin-arm-V10-SP1.png">
|
||
<img src="https://assets.yanghy.cn/energy-doc/frameless-kylin-arm-hide-V10-SP1.png">
|
||
|
||
##### Linux - Ubuntu
|
||
<img src="https://assets.yanghy.cn/energy-doc/frameless-ubuntu-18.04.6.png">
|
||
<img src="https://assets.yanghy.cn/energy-doc/frameless-ubuntu-hide-18.04.6.png">
|
||
|
||
##### MacOSX
|
||
<img src="https://assets.yanghy.cn/energy-doc/frameless-macos.png">
|
||
|
||
|
||
----
|
||
|
||
### 开源协议
|
||
|
||
[](http://www.apache.org/licenses/LICENSE-2.0)
|
||
|
||
|
||
|