这个项目旨在自动检查从互联网上托管的 JSON 文件中的链接的可访问性。它利用 GitHub Actions 来定期调度检查，并将结果输出为 JSON 文件，可以部署到如 Vercel 等平台以便于访问。该项目基于并改进了 butterfly-check-links 项目。
- 使用 GitHub Actions 进行自动链接检查
- 支持使用
HEAD和GET请求进行链接验证 - 并发处理以提高链接检查效率
- 结果输出为 JSON 格式，便于与 Web 应用集成
- 使用 cron 作业进行定时执行
.
├── .github
│ └── workflows
│ └── check_links.yml
├── test-friend.py
├── test-friend-in-txt.py
├── result.json
├── link.csv
└── README.md
.github/workflows/check_links.yml: GitHub Actions 的工作流配置文件，用于定时执行链接检查脚本。test-friend.py: 主链接检查脚本，负责检查 JSON 数据中的链接可访问性并生成结果。test-friend-in-txt.py: 从link.txt文件中读取链接并进行可访问性检查，生成结果。result.json: 链接检查结果的输出文件。link.csv: 存放待检查链接的文本文件(可选方式之一)。README.md: 项目说明文件。
首先，复刻这个仓库到你的 GitHub 账户，命名随意。
在 GitHub 仓库的设置中，确保 Actions 有写权限，步骤如下：
- 打开你的 GitHub 仓库，点击右上角的“Settings”。
- 在左侧栏中找到并点击“Actions”。
- 选择“General”。
- 在“Workflow permissions”部分，选择“Read and write permissions”。
- 点击“Save”按钮保存设置。
-
修改
test-friend.py文件内的 JSON 文件地址。# 目标JSON数据的URL json_url = 'https://blog.example.com/flink_count.json'
-
具体所需JSON文件格式示例：
{ "link_list": [ { "name": "String", "link": "String", "avatar": "String", "descr": "String", "siteshot": "String" },{ "name": "String", "link": "String", "avatar": "String", "descr": "String", "siteshot": "String" }, ], "length": 100 } -
JSON 具体生成教程请看详细教程。
-
修改
link.csv中的内容，格式如下，请修改为你自己的数据：清羽飞扬,https://blog.qyliu.top/ ChrisKim,https://www.zouht.com/ Akilar,https://akilar.top/ 张洪Heo,https://blog.zhheo.com/ -
修改 Action 任务中，运行 Python 脚本部分，改为运行 TXT 脚本文件：
- name: Run Python script to check frined-links env: LIJIANGAPI_TOKEN: ${{ secrets.LIJIANGAPI_TOKEN }} PROXY_URL: ${{ secrets.PROXY_URL }} run: python test-friend-in-txt.py
注：两种抓取方式最终获得结果相同，所以不影响后面的操作。
尝试运行action后，如果没有问题，结果应该出现在 page 分支。
由于该脚本通过action进行，可能会出现由于各种原因导致准确率极低的现象发生，此时我们需要通过各种方式提升检测的准确率，本脚本内置了通过梨酱API和CloudFlare Worker转发的方式，可以分别应对屏蔽国外，以及使用国外CDN且防火墙屏蔽Github的两种情况，经过实测，最终准确率基本达到100%。
启用两种方式非常简单，仅需要设置对应的环境变量即可。
-
梨酱API:
打开梨酱API并在右上角注册完成，进入控制台。进入控制台后，点击左边的密钥管理，生成密钥。
然后再在仓库设置->secret->action中，添加
LIJIANGAPI_TOKEN的密钥即可自动启用。 -
CloudFlare Worker：
其实上面的梨酱api就可以达到很高的准确率了，如果仍然有部分站本身能访问却无法检测，你可以尝试使用下面的方式进行检测：
首先部署转发代理，具体教程可以点击查看文章，不需要绑定域名，因为github action本身就是国外环境。
然后添加密钥
PROXY_URL，设置密钥即自动启用。
在 Vercel 或 Zeabur 选择对应仓库，按照以下步骤进行操作：
-
登录 Vercel 或 Zeabur：
- 如果还没有账户，请先注册一个 Vercel 或 Zeabur 账户。
- 登录后进入仪表板。
-
导入 GitHub 仓库：
- 点击“New Project”或“Import Project”按钮。
- 选择“Import Git Repository”。
- 连接到您的 GitHub 账户，并选择该链接检查项目的仓库。
-
配置项目：
- 确保选择正确的分支（page）。
- 对于 Vercel，在“Build and Output Settings”中，确保
output.json文件在构建输出目录中。
-
部署项目：
- 点击“Deploy”按钮开始部署。
- 部署完成后，Vercel 或 Zeabur 会生成一个 URL，您可以使用这个 URL 访问部署的网页。
使用zeabur或者vercel部署的目的是加快结果文件国内访问并且展示最终结果， Vercel 或 Zeabur 平台可以跟随仓库更新实时同步内容，配合上前端的缓存和异步加载，哪怕是国内访问也可以得到非常好的体验，可以在我的友链页面测试。
该项目最终文件结果为 JSON 格式，通过该文件可以获取最新的链接检查结果。您可以使用任何支持 HTTP(S) 请求的编程语言或工具来获取此 JSON 数据，API 地址如下（用本站部署的作为示例）：
https://check.zeabur.app/result.json{
"timestamp": "2024-09-19 09:18:49",
"accessible_count": 64,
"inaccessible_count": 12,
"total_count": 76,
"link_status": [
{
"name": "清羽飞扬",
"link": "https://blog.qyliu.top/",
"latency": -1,
},
{
"name": "ChrisKim",
"link": "https://www.zouht.com/",
"latency": 0.76,
},
{
"name": "Akilar",
"link": "https://akilar.top/",
"latency": 3.31,
}
]
}通过 Javascript 获取无法访问链接数据的简单页面示例（代码仅供参考，可以参考展示页面的js代码实现或自行实现）：
fetch('./result.json')
.then(response => response.json())
.then(data => {
// 提取整体统计信息
const summary = `总数: ${data.total_count} | 可访问: ${data.accessible_count} | 不可访问: ${data.inaccessible_count}`;
document.getElementById('summary').textContent = summary + ` | 检测时间: ${data.timestamp}`;
// 动态生成表格数据
const tbody = document.getElementById('link-table-body');
data.link_status.forEach(item => {
const row = document.createElement('tr');
// 名称列
const nameCell = document.createElement('td');
nameCell.textContent = item.name;
row.appendChild(nameCell);
// 链接列
const linkCell = document.createElement('td');
const linkElement = document.createElement('a');
linkElement.href = item.link;
linkElement.target = "_blank";
linkElement.textContent = item.link;
linkCell.appendChild(linkElement);
row.appendChild(linkCell);
// 时延列
const latencyCell = document.createElement('td');
latencyCell.textContent = item.latency >= 0 ? item.latency.toFixed(2) : '不可达';
row.appendChild(latencyCell);
// SSL 状态列
const sslCell = document.createElement('td');
sslCell.textContent = item.ssl_status ? '✔️' : '❌';
row.appendChild(sslCell);
tbody.appendChild(row);
});
})
.catch(error => {
console.error('Error loading JSON data:', error);
const tbody = document.getElementById('link-table-body');
const row = document.createElement('tr');
const cell = document.createElement('td');
cell.colSpan = 4;
cell.textContent = '无法加载数据';
cell.style.textAlign = 'center';
row.appendChild(cell);
tbody.appendChild(row);
});除以上展示为单独页面之外，还可以通过JavaScript对比友链结果，生成友链卡片小标签，大致效果可以看清羽飞扬の友链页面，示例代码如下：
<style>
.status-tag {
position: absolute;
top: 0px;
left: 0px;
padding: 3px 8px;
border-radius: 12px 0px 12px 0px;
font-size: 12px;
color: white;
font-weight: bold;
transition: font-size 0.3s ease-out, width 0.3s ease-out, opacity 0.3s ease-out;
}
.flink-list-item:hover .status-tag {
font-size: 0px;
opacity: 0;
}
/* 固态颜色 */
.status-tag-green {
background-color: #005E00; /* 绿色 */
}
.status-tag-light-yellow {
background-color: #FED101; /* 浅黄色 */
}
.status-tag-dark-yellow {
background-color: #F0B606; /* 深黄色 */
}
.status-tag-red {
background-color: #B90000; /* 红色 */
}
</style>
<script>
function addStatusTagsWithCache(jsonUrl) {
const cacheKey = "statusTagsData";
const cacheExpirationTime = 30 * 60 * 1000; // 半小时
function applyStatusTags(data) {
const linkStatus = data.link_status;
document.querySelectorAll('.flink-list-item').forEach(card => {
if (!card.href) return;
const link = card.href.replace(/\/$/, '');
const statusTag = document.createElement('div');
statusTag.classList.add('status-tag');
let matched = false;
// 查找链接状态
const status = linkStatus.find(item => item.link.replace(/\/$/, '') === link);
if (status) {
let latencyText = '未知';
let className = 'status-tag-red'; // 默认红色
if (status.latency === -1) {
latencyText = '未知';
} else {
latencyText = status.latency.toFixed(2) + ' s';
if (status.latency <= 2) {
className = 'status-tag-green';
} else if (status.latency <= 5) {
className = 'status-tag-light-yellow';
} else if (status.latency <= 10) {
className = 'status-tag-dark-yellow';
}
}
statusTag.textContent = latencyText;
statusTag.classList.add(className);
matched = true;
}
if (matched) {
card.style.position = 'relative';
card.appendChild(statusTag);
}
});
}
function fetchDataAndUpdateUI() {
fetch(jsonUrl)
.then(response => response.json())
.then(data => {
applyStatusTags(data);
const cacheData = {
data: data,
timestamp: Date.now()
};
localStorage.setItem(cacheKey, JSON.stringify(cacheData));
})
.catch(error => console.error('Error fetching test-flink result.json:', error));
}
const cachedData = localStorage.getItem(cacheKey);
if (cachedData) {
const { data, timestamp } = JSON.parse(cachedData);
if (Date.now() - timestamp < cacheExpirationTime) {
applyStatusTags(data);
return;
}
}
fetchDataAndUpdateUI();
}
setTimeout(() => {
addStatusTagsWithCache('https://check.zeabur.app/result.json');
}, 0);
</script>如果有疑问可通过个人主页或者提 issue 进行联系，非常欢迎。
