Skip to content

Latest commit

 

History

History
126 lines (84 loc) · 5.86 KB

Note.md

File metadata and controls

126 lines (84 loc) · 5.86 KB
Raw

Note

由于个人并未学过go，看代码需要做下笔记。仅为个人参考。

处理订阅源：getter类

有关订阅源的package位于pkg/getter。

订阅源的类型为接口Getter，实现Getter至少需要实现Get()和Get2chan()。

  • Get() 返回一个ProxyList
  • Get2chan() Send proxy to Channel用于并发抓取

已实现的Getter（以sourceType命名）

  • subscribe（该实现比接口Getter多了个url）
  • tgchannel
  • web_fanqiangdang
  • web_fuzz
  • web_fuzz_sub

接口Getter与err状态组成一个creator，方便错误处理。 为了方便外部程序辨认creator类型，在init()中初始化一个map，key为sourceType字符串，value为creator。

程序运行时，package app由配置文件读取到source.yaml，由sourceType map到对应的creator类型，同时使用sourceOption(通常是url)初始化一个creator。

所有Getter最后存于package app的Getters中。

proxy类

节点的接口为Proxy，由struct Base实现其基类，Vmess等实现多态。

所有字段名依据clash的配置文件标准设计。比如

type ShadowsocksR struct {
	Base          // 节点基本信息
	Password      string `yaml:"password" json:"password"`
	Cipher        string `yaml:"cipher" json:"cipher"`
	Protocol      string `yaml:"protocol" json:"protocol"`
	ProtocolParam string `yaml:"protocol-param,omitempty" json:"protocol_param,omitempty"`
	Obfs          string `yaml:"obfs" json:"obfs"`
	ObfsParam     string `yaml:"obfs-param,omitempty" json:"obfs_param,omitempty"`
	Group         string `yaml:"group,omitempty" json:"group,omitempty"`
}

Proxylist是proxy数组加上一系列批量处理proxy的方法。

不知道是否是有意为之，基类的Base的方法的传入参数全部用的指针，因为Base变成了Proxy的指针实现。因此Vmess等对于接口Proxy而言也是Proxy的指针，type assertion应该写为 proxy.(*Vmess)。

抓取

task.go的Crawl.go实现抓取。

  1. 并发抓取订阅源，加载历史节点
  2. 节点去重，去除Clash不支持的类型，重命名
  3. 存储所有节点（包括不可用节点）到database和cache
  4. 检测IP可用性
    尽管已经对IP的有效性测试过，但并不保证节点在客户端上可用，特别是封IP和端口的时期，不可用的比例接近100%。可以使用proxypoolCheck进行本地检测。
  5. 存储可用的节点到cache

存储

所有节点存储到cache中。

cache中的key设计有：

  • allproxies: 所有节点（包括不可用节点）
  • proxies: 可用节点
  • clashproxies: clash支持的节点。第一次运行时是把proxies复制过来的。

问题是对于失效的节点也存储，运行时间久了无用的cache会非常多。可以考虑删除对失效节点的存放。

使用数据库

远程运行时添加add即可，heroku自己会添加DATABASE_URL环境变量到provision，无需其他配置。

本地运行时安装postgresql，建立相应user和database。

dsn := "user=proxypool password=proxypool dbname=proxypool port=5432 sslmode=disable TimeZone=Asia/Shanghai"

程序运行时建立会proxies表。每次运行时读出节点，爬虫完成后再存储可用的节点进去。

更新时会Update所有数据库上次可用节点的usable为false（此时useable全是false），然后存储新节点，已有的条目则Update usable。最后再自动清除7天未更新且不可用的节点。

重点在于，失效的条目不能更新。

Health Check

分为延迟测试、测速（带宽测试）与中转检测。

延迟测试用于筛选掉无效的节点。

已经重写测速。单线程测速，失败请求3次。需要在配置文件中依据带宽调整connection与timeout。不同的网络环境下测速结果可能有着巨大的差别。

中转检测完全根据原作者频道里的说明来写的。带Relay的是中转，Pool是出入口同一网段。不过设定的“同一网段”的子网掩码是前24位为1，超出此范围的Pool可能会误判断成Relay。但99%的情况没问题。

Web界面

为了方便打包，原作者将静态的assets文件模板由zip压缩后存为字符串的形式，如

var _assetsHtmlSurgeHtml="[]byte("\x1f\x8b\x...")"

以上字节解压后是一个go的HTML模板。解压时，由gzip的reader写入byte.Buffer，再转换为Bytes写入相应文件。

静态文件打包工具见：这里 或 这里 。请在修改后html文件后执行docs里的shell脚本

根据原作者要求，请勿修改原作者版权信息。

Web数据是Get一次更新一次。但是貌似在cache改变前不会重复读取cache中的内容（还是说是时间间隔没到？没有看gin-cache的源码，有待验证）。

关于页面端口，有时候会遇到web端口时proxypool服务端口不一致的情况（如heroku和内网穿透)。web页面上的端口显示和config文件保持一致，实际的服务端口由配置文件或环境变量决定，环境变量优先级更高。

一般情况下，部署到自己的机器上时，需要确保没有PORT环境变量（除非你明白其中的原理且知道自己在做什么）

本地测试

需要注意：

  • 修改config的domain
  • 修改source，注释掉较慢的源

增加了对config-local文件的解析。url为/clash/localconfig

Github Action Release和源码自行make版本的区别

Release版本在make之前还打包了所有的静态文件，其中包括了一个60M的GeoIP数据库。
缺点是打包体积相对较大，因为geoip.go经过gobindata打包后的文件是120。且第一次部署运行时会占用较多内存。
优点是不需要额外自行下载数据库。打包的体积也比自己下载数据库的体积小太多。

自行源码make版本在不修改bindata/GeoIP的情况下，不包含数据库，打包程序较小。缺点是要自已下载数据库（源码都有了这不算是问题）