feat: 新增通过对比resource.yaml文件hash值的方式实现网关部署优化

Xinkai Yi · Xinkai Yi · commit 77f32ddcf776 · 2026-01-08T15:45:33.000+08:00
diff --git a/bk-plugin-framework/bk_plugin_framework/services/bpf_service/management/__init__.py b/bk-plugin-framework/bk_plugin_framework/services/bpf_service/management/__init__.py
@@ -0,0 +1,10 @@
+"""
+Tencent is pleased to support the open source community by making 蓝鲸智云 - PaaS平台 (BlueKing - PaaS System) available.
+Copyright (C) 2022 THL A29 Limited, a Tencent company. All rights reserved.
+Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://opensource.org/licenses/MIT
+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.
+"""
diff --git a/bk-plugin-framework/bk_plugin_framework/services/bpf_service/management/commands/__init__.py b/bk-plugin-framework/bk_plugin_framework/services/bpf_service/management/commands/__init__.py
@@ -0,0 +1,10 @@
+"""
+Tencent is pleased to support the open source community by making 蓝鲸智云 - PaaS平台 (BlueKing - PaaS System) available.
+Copyright (C) 2022 THL A29 Limited, a Tencent company. All rights reserved.
+Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://opensource.org/licenses/MIT
+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.
+"""
diff --git a/bk-plugin-framework/bk_plugin_framework/services/bpf_service/management/commands/sync_apigateway_if_changed.py b/bk-plugin-framework/bk_plugin_framework/services/bpf_service/management/commands/sync_apigateway_if_changed.py
@@ -0,0 +1,150 @@
+"""
+Tencent is pleased to support the open source community by making 蓝鲸智云 - PaaS平台 (BlueKing - PaaS System) available.
+Copyright (C) 2022 THL A29 Limited, a Tencent company. All rights reserved.
+Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://opensource.org/licenses/MIT
+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.
+"""
+
+import hashlib
+import os
+
+from django.core.management import call_command
+from django.core.management.base import BaseCommand
+
+
+class Command(BaseCommand):
+    help = "仅在接口定义发生变化时同步到API网关"
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "--force",
+            action="store_true",
+            default=False,
+            help="强制同步，忽略哈希值对比",
+        )
+
+    def handle(self, *args, **options):
+        force_sync = options.get("force", False)
+
+        # 1. 生成 yaml 文件
+        self.stdout.write("[Sync] generate definition.yaml")
+        try:
+            call_command("generate_definition_yaml")
+        except Exception as e:
+            self.stderr.write(
+                self.style.ERROR(
+                    f"run generate_definition_yaml fail: {e}, "
+                    "please run this command on your development env to find out the reason"
+                )
+            )
+            raise SystemExit(1)
+
+        self.stdout.write("[Sync] generate resources.yaml")
+        try:
+            call_command("generate_resources_yaml")
+        except Exception as e:
+            self.stderr.write(
+                self.style.ERROR(
+                    f"run generate_resources_yaml fail: {e}, "
+                    "please run this command on your development env to find out the reason"
+                )
+            )
+            raise SystemExit(1)
+
+        # 2. 计算当前哈希值（仅计算 resources.yaml）
+        current_hash = self._calculate_resources_hash()
+        self.stdout.write(f"[Sync] Current resources.yaml hash: {current_hash[:16]}...")
+
+        # 3. 获取上次同步的哈希值
+        last_hash = self._get_last_sync_hash()
+        if last_hash:
+            self.stdout.write(f"[Sync] Last sync hash: {last_hash[:16]}...")
+        else:
+            self.stdout.write("[Sync] No previous sync record found")
+
+        # 4. 对比决定是否同步
+        if not force_sync and current_hash == last_hash:
+            self.stdout.write(self.style.SUCCESS("[Sync] API definition unchanged, skip sync to apigateway"))
+            # 仍然获取公钥，确保公钥是最新的
+            self._fetch_public_key()
+            return
+
+        if force_sync:
+            self.stdout.write(self.style.WARNING("[Sync] Force sync enabled"))
+        else:
+            self.stdout.write(self.style.WARNING("[Sync] API definition changed, start syncing..."))
+
+        # 5. 执行同步
+        self.stdout.write("[Sync] sync to apigateway")
+        try:
+            call_command("sync_drf_apigateway")
+        except Exception as e:
+            self.stderr.write(self.style.ERROR(f"run sync_drf_apigateway fail: {e}"))
+            # 同步失败时更新状态
+            self._save_sync_hash(current_hash, success=False)
+            raise SystemExit(1)
+
+        # 6. 获取公钥
+        self._fetch_public_key()
+
+        # 7. 更新哈希值
+        self._save_sync_hash(current_hash, success=True)
+        self.stdout.write(self.style.SUCCESS("[Sync] API gateway sync completed successfully"))
+
+    def _print_yaml_content(self, filepath, name):
+        """打印 YAML 文件内容"""
+        if os.path.exists(filepath):
+            self.stdout.write(f"[Sync] the {filepath} content:")
+            with open(filepath) as f:
+                self.stdout.write(f.read())
+            self.stdout.write("====================")
+
+    def _calculate_resources_hash(self):
+        """计算 resources.yaml 的哈希值"""
+        filepath = "/app/bk_plugin_runtime/resources.yaml"
+        if os.path.exists(filepath):
+            with open(filepath) as f:
+                content = f.read()
+            return hashlib.sha256(content.encode()).hexdigest()
+        return ""
+
+    def _get_last_sync_hash(self):
+        """从数据库获取上次同步的哈希值"""
+        try:
+            from bk_plugin_framework.services.bpf_service.models import (
+                APIGatewaySyncState,
+            )
+
+            state = APIGatewaySyncState.objects.filter(sync_success=True).first()
+            return state.api_hash if state else ""
+        except Exception as e:
+            self.stdout.write(self.style.WARNING(f"[Sync] Failed to get last sync hash: {e}"))
+            return ""
+
+    def _save_sync_hash(self, hash_value, success=True):
+        """保存哈希值到数据库"""
+        try:
+            from bk_plugin_framework.services.bpf_service.models import (
+                APIGatewaySyncState,
+            )
+
+            # 使用 update_or_create，保证只有一条记录
+            APIGatewaySyncState.objects.update_or_create(
+                pk=1, defaults={"api_hash": hash_value, "sync_success": success}
+            )
+            self.stdout.write(f"[Sync] Sync state saved (success={success})")
+        except Exception as e:
+            self.stdout.write(self.style.WARNING(f"[Sync] Failed to save sync hash: {e}"))
+
+    def _fetch_public_key(self):
+        """获取 API 网关公钥"""
+        self.stdout.write("[Sync] fetch the public key")
+        try:
+            call_command("fetch_apigw_public_key")
+        except Exception as e:
+            self.stderr.write(self.style.ERROR(f"run fetch_apigw_public_key fail: {e}"))
+            raise SystemExit(1)
diff --git a/bk-plugin-framework/bk_plugin_framework/services/bpf_service/models.py b/bk-plugin-framework/bk_plugin_framework/services/bpf_service/models.py
@@ -0,0 +1,35 @@
+"""
+Tencent is pleased to support the open source community by making 蓝鲸智云 - PaaS平台 (BlueKing - PaaS System) available.
+Copyright (C) 2022 THL A29 Limited, a Tencent company. All rights reserved.
+Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://opensource.org/licenses/MIT
+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.
+"""
+
+from django.db import models
+
+
+class APIGatewaySyncState(models.Model):
+    """API网关同步状态记录
+
+    用于存储上次成功同步时的接口定义哈希值，
+    通过对比哈希值判断是否需要重新同步。
+    """
+
+    # resources.yaml 的哈希值
+    api_hash = models.CharField(max_length=64, default="", verbose_name="接口定义哈希值")
+    # 上次同步时间
+    last_sync_at = models.DateTimeField(auto_now=True, verbose_name="上次同步时间")
+    # 同步是否成功
+    sync_success = models.BooleanField(default=False, verbose_name="同步是否成功")
+
+    class Meta:
+        db_table = "bpf_apigateway_sync_state"
+        verbose_name = "API网关同步状态"
+        verbose_name_plural = "API网关同步状态"
+
+    def __str__(self):
+        return f"APIGatewaySyncState(hash={self.api_hash[:16]}..., success={self.sync_success})"
