veProxy 是一款客户端网络代理服务工具。通过集成 veProxy SDK，您可在 Android 设备上快速开启网络代理服务。结合云手机 SDK 和云手机 Pod 网络重定向能力，您可以实现对 Pod 内第三方应用的网络流量进行客户端终端代理。该方案可实现高网络仿真，提高云手机 Pod 的仿真能力。 ## 接入步骤 ### 步骤一：配置 Maven 依赖在项目根目录的 build.gradle（或 settings.gradle）文件中，添加火山引擎的 Maven 仓库地址： ```Groovy allprojects { repositories { maven { url 'https://artifact.bytedance.com/repository/Volcengine/' } google() mavenCentral() } } ``` ### 步骤二：引入 SDK 在应用模块的 build.gradle 文件中，添加 veProxy 的依赖配置： ```Groovy // 建议从火山引擎云手机官网获取并替换为您需要的最新版本号 def latest_version="1.0.10" implementation "com.volcengine.vephone:veproxy:$latest_version" ``` ### 步骤三：初始化 SDK（可选）建议您在应用进程启动（如 Application.onCreate）时进行初始化 SDK，以便进行全局配置。 :::warning * **默认通知**：默认使用 DefaultNotificationCreator 作为实现自定义通知的创建器。为了提高代理服务在后台运行的可靠性，推荐保持启用通知功能。 * **禁用通知**：若业务要求在代理运行时不弹出任何通知，可传入 new DefaultNotificationCreator(false) 禁用通知功能。 * **自定义通知**：业务可以通过实现 NotificationCreator 接口，返回自定义的通知对象。 ::: ```Java public class App extends Application { @Override public void onCreate() { super.onCreate(); VeProxyClient.init( new InitParam.Builder(this) // 可选：设置是否为调试模式，默认 false。开启后将影响日志输出等行为 .debug(BuildConfig.DEBUG) // 可选：设置消息通知创建器。业务可在此实现自定义的通知样式 .notificationCreator(new DefaultNotificationCreator()) .build() ); } } ``` ## 核心功能 ### 1. 代理状态监听 SDK 提供了从启动到终止各个状态的回调接口，业务可根据自身需求处理实时状态逻辑。 ```Java private void initListeners() { VeProxyClient.getInstance().setProxyStateListener((profile, state) -> { List list = CollectionUtils.map(profile.getProxies(), p -> p.getName() + "->" + profile.getServerAddr() + ":" + p.getRealRemotePort()); Log.w(TAG, "onProxyStateUpdated: " + list + ", state:" + state); }); } // 停止使用时，请解除相关监听以防止内存泄漏 private void uninitListeners() { VeProxyClient.getInstance().setProxyStateListener(null); } ``` ### 2. 创建代理配置在启动代理之前，需要先构建一个代理配置对象（ProxyProfile）。以下是一个基础代理配置的示例： ```Java public static ProxyProfile createSimpleProfile() { return new ProxyProfile.Builder() .serverAddr(SERVER_ADDR) .serverPort(SERVER_PORT) .proxy( new ProxyConfig.Builder() .name("your_proxy_name") .type(ProxyType.TCP) .plugin(new Socks5Plugin()) .build() ) .build(); } ``` ### 3. 控制代理启停通过 VeProxyClient 实例，您可以对创建好的代理服务进行启停操作。 **启动代理：** ```Java VeProxyClient.getInstance().start(context, proxyProfile); ``` **停止代理：** ```Java // 停止指定的代理 VeProxyClient.getInstance().stop(context, proxyProfile); // 停止所有正在运行的代理 VeProxyClient.getInstance().stop(context); ``` ### 4. 获取代理运行状态在业务运行中，您可以随时查询当前活跃的代理列表及特定代理的运行状态。 ```Java // 获取当前所有正在运行的代理集合，常用于启动前防止重复创建 Set profiles = VeProxyClient.getInstance().getActiveProxies(); // 获取指定 proxyProfile 对象的当前运行状态 ProxyState state = VeProxyClient.getInstance().getProxyState(proxyProfile); ``` ## 其他功能 ### 监听代理运行日志如果您需要进行问题排查或记录代理的详细运行日志，可以通过以下接口监听日志输出： ```Java // 设置日志监听器 VeProxyClient.getInstance().setProxyLogListener((profile, msg) -> { Log.d(TAG, "onLogMessage: " + msg); }); // 停止监听时解除回调以防止内存泄漏 VeProxyClient.getInstance().setProxyLogListener(null); ```