Skip to content

Commit

Permalink
done
Browse files Browse the repository at this point in the history
  • Loading branch information
@pretty66
pretty66 committed Sep 5, 2023
0 parents commit 7ff40ed
Show file tree
Hide file tree
Showing 12 changed files with 702 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
fastcar
.idea
.DS_Store
201 changes: 201 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
8 changes: 8 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
NAME = "fastcar"

BUILD_DATE=$(shell date '+%Y-%m-%d %H:%M:%S')

CFLAGS = -ldflags "-s -w -X \"main.BuildDate=$(BUILD_DATE)\""

build:
go build $(CFLAGS) -o $(NAME) ./
99 changes: 99 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
![logo](./docs/fastcar-logo.png)

[中文](./README_ZH.md)      [English](./README.md)
---

# Fastcar - PHP 长连接代理

Fastcar 是使用 Go 语言编写的代理程序，旨在为 PHP 程序在网络请求时提供长连接支持。通过 Unix 域套接字通信，Fastcar 可以为 PHP 程序赋能，让它们能够保持长连接，从而提升网络请求性能。
```text
+---------------------+ +----------------------+ +---------------------+
| | | | | |
| PHP Program | <-------> | FastCar | <------> | Remote Server |
| | unix | | HTTP/HTTPS | |
| Network Request | domain | +--------------+ | Request | Network Request |
| | socket | | | | | |
+---------------------+ | | Connection | | +---------------------+
| | Pool | |
| +--------------+ |
+----------------------+
```
## 简介与技术原理

Fastcar 部署在 PHP 程序所在的服务器上，通过 Unix 域套接字与 PHP 程序进行通信，实现高效的连接。其核心能力包括：

- **通信方式**：使用 Unix 域套接字（unix domain socket）进行高效通信，降低了网络开销。

- **判断请求协议**：Fastcar 从 Unix 域套接字接收 PHP 程序的网络请求，根据请求协议判断是 HTTP 请求还是 HTTPS 请求;
对于 HTTP 请求，Fastcar 直接转发给远程服务器; 对于 HTTPS 请求，Fastcar 会暂时伪装成服务端，与 PHP 程序在内存通信中完成 TLS 握手，然后再与远程服务器建立 TLS 连接，实现请求转发。

- **连接池**：Fastcar 维护连接池，将与远程服务器的连接回收，实现连接的复用，降低资源消耗。

## PHP 网络请求的挑战
在传统的网络请求中，PHP 程序使用短连接模式，这可能导致以下问题：
- 性能问题：频繁的连接建立和关闭导致性能下降，影响 PHP 程序的整体响应速度。
- 延迟增加：短连接模式会增加请求的延迟，尤其在高并发场景下，连接开销变得显著。
- 资源浪费：频繁的连接开销和关闭会浪费服务器和网络资源，影响资源的有效利用。

## Fastcar 的优势

Fastcar 提供了多重优势，使其成为 PHP 长连接代理的理想选择：

- **HTTPS 伪装握手**：针对https服务的访问Fastcar会伪装服务端进行 TLS 握手，代替php程序同目标服务建立tls连接，并保持连接复用，能显著降低php短连接频繁握手导致的请求延迟。

- **长连接支持**：通过维护连接池，Fastcar 提供长连接支持，可以接管节点上所有的php程序网络请求，达到多服务连接共用；例如k8s形式单台节点上部署多个pod形式的业务能大大降低连接建立的开销。

- **资源优化**：Fastcar本身非常轻量，只占用很少的系统资源，同时通过连接池的复用，降低了服务器和网络资源的消耗。

## 效果对比
分别请求百度翻译api的http和https地址，对比使用fastcar和php直接请求的延迟对比，如下图所示：

### http请求延迟对比
直接请求和通过fastcar请求各100次，使用fastcar后，平均延迟降低了约34.8%
![http延迟](./docs/http_delay.png)

### https请求延迟对比
直接请求和通过fastcar请求各100次，使用fastcar后，平均延迟降低了约48.4%
![https延迟](./docs/https_delay.png)

**测试发现，fastcar可以显著降低php程序的网络请求延迟，使请求的延迟趋于更加稳定的状态；在https请求模式下，fastcar的优势更加明显。**

## 快速开始
### 部署fastcar
```shell
$ git clone https://github.com/pretty66/fastcar.git
$ cd fastcar
$ make build
$
$ ./fastcar -h
Usage of ./fastcar:
-cert string
tls cert file, empty auto create
-key string
tls key file, empty auto create
-proxy string
proxy url: scheme://user:password@host:port
-unix string
unix socket addr (default "/tmp/fastcar.sock")
```
```shell
# run
nohup ./fastcar -unix /tmp/fastcar.sock > debug.log 2>&1 &
```

### php程序配置
```php
// Disable certificate validation
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
// Set Unix socket file path
curl_setopt($ch, CURLOPT_UNIX_SOCKET_PATH, '/tmp/fastcar.sock');
```
参考示例：[访问百度翻译api](./example/curl.php)

## 贡献

欢迎对 Fastcar 提出问题、报告 Bug 或者提供改进建议。你可以通过 GitHub Issues 来与我交流。

## License
Fastcar is under the Apache 2.0 license. See the [LICENSE](./LICENSE) directory for details.
Loading

0 comments on commit 7ff40ed

Please sign in to comment.