Selenium RemoteWebDriver 利用CDP修改User-Agent

地球人都知道，如果使用selenium时要修改user-agent可以在启动浏览器时添加配置项，如chromeOptions.addArguments("user-agent=xxx");。但是如何在每次请求的时候动态更改user-agent呢？

经过我的不懈努力，终于在网上找到一个相关的信息使用python3和selenium4修改chrome的user-agent。
这里面提到了使用driver.execute_cdp_cmd来切换，这让我了解了一下cdp命令。简单的来说，cdp命令时chrome支持的一种基于websocket的协议，通过这个协议可以与浏览器内核通信。平常使用的F12浏览器开发工具就是基于cdp的。cpd命令可以实现的功能很多，可以参考Chrome DevTools Protocol。再这里面我找到了一个Network.setUserAgentOverride命令可以修改请求user-agent。
命令的参数如下：

但是，在我的项目中目前使用的selenium-java的版本是3.141.59，这个版本还没用提供对于cdp命令的支持，前面信息中提到了是在selenium4中使用使用的cdp命令。于是我又去maven仓库搜索有没有selenium4的jar包可以用。

这里面已经有5个alpha测试的版本了，虽然还不是稳定版本，但是为了实现新功能先试一试，在maven中添加依赖：

    org.seleniumhq.selenium
    selenium-java
    4.0.0-alpha-5

然后尝试调用ChromeDriver的executeCdpCommand方法

可以看到，第一个参数是commandName，对于修改user-agent的需求，这个地方应该填写Network.setUserAgentOverride，后面是参数的键值对，现在只需要填写userAgent就可以了，其他都是不需要的可选参数。

一般情况下，问题到这里就解决了，但是在我的项目中却没有这么简单。因为各种原因，我的项目中使用的是Selenium-Server来提供浏览器环境的，也就是说，创建的都是RemoteWebDriver，虽然ChromeDriver是继承自RemoteWebDriver的，但是cdp命令是chrome浏览器独有的， 因此RemoteWebDriver也就没有提供相关的支持了。那么如何在确定RemoteWebDriver调用chrome浏览器的情况下提供cpd命令的支持呢？为了实现这个功能还是费了一些时间，因此在这里把过程记录下来。
首先看一下ChromeWebDriver是如何实现cdp命令的：

public Map executeCdpCommand(String commandName, Map parameters) {
    Objects.requireNonNull(commandName, "Command name must be set.");
    Objects.requireNonNull(parameters, "Parameters for command must be set.");
    Map toReturn = (Map)this.getExecuteMethod().execute("executeCdpCommand", ImmutableMap.of("cmd", commandName, "params", parameters));
    return ImmutableMap.copyOf(toReturn);
}

在Selenium4中，ChromeDriver继承自ChromiumDriver，二者其实是一模一样的。ChromiumDriver提供了cdp命令的支持，利用executeMethod运行命令executeCdpCommand，将要运行的具体命令和参数一并传入。于是我又开始找这个ExecuteMethod是什么东西，发现ChromiumWebDriver并没有对这个参数进行任何设置，因此应该是在ChromiumDriver继承的RemoteWebDriver来设置的。果然，在RemoteWebDriver中有this.executeMethod = new RemoteExecuteMethod(this);，在ChromiumWebDriver中获取到的一定也是这个对象。那么很容易想到，继承一个RemoteWebDriver并编写一个方法调用这个executeMethod不就行了吗？

public class CdpRemoteWebDriver extends RemoteWebDriver {

    public CdpRemoteWebDriver(URL remoteAddress, Capabilities capabilities) {
        super(remoteAddress, capabilities);
    }

    public Map executeCdpCommand(String commandName, Map parameters) {
        Objects.requireNonNull(commandName, "Command name must be set.");
        Objects.requireNonNull(parameters, "Parameters for command must be set.");
        Map toReturn = (Map)this.getExecuteMethod().execute("executeCdpCommand", ImmutableMap.of("cmd", commandName, "params", parameters));
        return ImmutableMap.copyOf(toReturn);
    }
    
}

然后再创建CdpRemoteWebDriver实例，在访问网页之前设置user-agent

Map uaMap = new HashMap(){{
    put("userAgent", "customUserAgent");
}};
((CdpRemoteWebDriver) driver).executeCdpCommand("Network.setUserAgentOverride",
        uaMap
        );
driver.get(url);

运行试一下！

org.openqa.selenium.UnsupportedCommandException: executeCdpCommand
Build info: version: '4.0.0-alpha-5', revision: 'b3a0d621cc'
System info: host: 'DESKTOP-BM176Q1', ip: '192.168.137.1', os.name: 'Windows 10', os.arch: 'amd64', os.version: '10.0', java.version: '1.8.0_161'
Driver info: driver.version: CdpRemoteWebDriver
	at org.openqa.selenium.remote.codec.AbstractHttpCommandCodec.encode(AbstractHttpCommandCodec.java:246)
	at org.openqa.selenium.remote.codec.AbstractHttpCommandCodec.encode(AbstractHttpCommandCodec.java:129)
	at org.openqa.selenium.remote.HttpCommandExecutor.execute(HttpCommandExecutor.java:155)
	at org.openqa.selenium.remote.RemoteWebDriver.execute(RemoteWebDriver.java:582)
	at org.openqa.selenium.remote.RemoteWebDriver.execute(RemoteWebDriver.java:639)
	at org.openqa.selenium.remote.RemoteExecuteMethod.execute(RemoteExecuteMethod.java:36)
	at com.zju.edu.eagle.accessibilitycheck.a11ycheck.executor.impl.CdpRemoteWebDriver.executeCdpCommand(CdpRemoteWebDriver.java:24)

结果不行，说executeCdpCommand是不支持的命令，为什么一样的executeMethod结果不一样呢？定位到错误的地方看一下

public HttpRequest encode(Command command) {
    String name = (String)this.aliases.getOrDefault(command.getName(), command.getName());
    AbstractHttpCommandCodec.CommandSpec spec = (AbstractHttpCommandCodec.CommandSpec)this.nameToSpec.get(name);
    if (spec == null) {
        throw new UnsupportedCommandException(command.getName());
    }
    ...
}

运行命令时，先从(AbstractHttpCommandCodec.CommandSpec)this.nameToSpec中获取命令的相关信息了，而要运行的executeCdpCommand没有事先定义，所以就出现异常了。

public AbstractHttpCommandCodec() {
    this.defineCommand("status", get("/status"));
    this.defineCommand("getAllSessions", get("/sessions"));
    this.defineCommand("newSession", post("/session"));
    this.defineCommand("getCapabilities", get("/session/:sessionId"));
    ...
}

这些命令是在AbstractHttpCommandCodec中定义的，而executeCdpCommand不在其中。这说明虽然ChromeDriver和RemoteWebDriver有相同的executeMethod，但后续调用还是涉及到了不同的类，于是我又回头查看ChromeDriver中的代码，发现有这样一个构造函数

public ChromeDriver(ChromeDriverService service, Capabilities capabilities) {
    super(new ChromiumDriverCommandExecutor(service), capabilities, "goog:chromeOptions");
}

这里面创建了一个ChromiumDriverCommandExecutor，再点进来看一下

static {
    CHROME_COMMAND_NAME_TO_URL.put("launchApp", new CommandInfo("/session/:sessionId/chromium/launch_app", HttpMethod.POST));
    CHROME_COMMAND_NAME_TO_URL.put("getNetworkConditions", new CommandInfo("/session/:sessionId/chromium/network_conditions", HttpMethod.GET));
    CHROME_COMMAND_NAME_TO_URL.put("setNetworkConditions", new CommandInfo("/session/:sessionId/chromium/network_conditions", HttpMethod.POST));
    CHROME_COMMAND_NAME_TO_URL.put("deleteNetworkConditions", new CommandInfo("/session/:sessionId/chromium/network_conditions", HttpMethod.DELETE));
    CHROME_COMMAND_NAME_TO_URL.put("executeCdpCommand", new CommandInfo("/session/:sessionId/goog/cdp/execute", HttpMethod.POST));
    CHROME_COMMAND_NAME_TO_URL.put("getCastSinks", new CommandInfo("/session/:sessionId/goog/cast/get_sinks", HttpMethod.GET));
    CHROME_COMMAND_NAME_TO_URL.put("selectCastSink", new CommandInfo("/session/:sessionId/goog/cast/set_sink_to_use", HttpMethod.POST));
    CHROME_COMMAND_NAME_TO_URL.put("startCastTabMirroring", new CommandInfo("/session/:sessionId/goog/cast/start_tab_mirroring", HttpMethod.POST));
    CHROME_COMMAND_NAME_TO_URL.put("getCastIssueMessage", new CommandInfo("/session/:sessionId/goog/cast/get_issue_message", HttpMethod.GET));
    CHROME_COMMAND_NAME_TO_URL.put("stopCasting", new CommandInfo("/session/:sessionId/goog/cast/stop_casting", HttpMethod.POST));
    CHROME_COMMAND_NAME_TO_URL.put("setPermission", new CommandInfo("/session/:sessionId/permissions", HttpMethod.POST));
}

可以看到这里面也定义了一些命令，executeCdpCommand也在其中。而RemoteWebDriver没有这个命令的信息，自然也就无法执行了。经过进一步查看源码，我发现ChromiumDriverCommandExecutor是HttpCommandExecutor的子类，HttpCommandExecutor是RemoteWebDriver中真正的命令执行者。

ChromeWebDriver能够提供自定义的CommandExecutor来增加额外命令，自然我们自己继承的类也可以。在HttpCommandExecutor中有这样一个构造函数HttpCommandExecutor(Map additionalCommands, URL addressOfRemoteServer)，只要把添加的命令的键值对传入，就可以支持额外的命令了。

最终版本的代码如下

public class CdpRemoteWebDriver extends RemoteWebDriver {

    private static final HashMap CHROME_COMMAND_NAME_TO_URL = new HashMap();

    public CdpRemoteWebDriver(URL remoteAddress, Capabilities capabilities) {
        super((CommandExecutor)(new HttpCommandExecutor(ImmutableMap.copyOf(CHROME_COMMAND_NAME_TO_URL), remoteAddress)), capabilities);
    }

    public Map executeCdpCommand(String commandName, Map parameters) {
        Objects.requireNonNull(commandName, "Command name must be set.");
        Objects.requireNonNull(parameters, "Parameters for command must be set.");
        Map toReturn = (Map)this.getExecuteMethod().execute("executeCdpCommand", ImmutableMap.of("cmd", commandName, "params", parameters));
        return ImmutableMap.copyOf(toReturn);
    }

    static {
        CHROME_COMMAND_NAME_TO_URL.put("launchApp", new CommandInfo("/session/:sessionId/chromium/launch_app", HttpMethod.POST));
        CHROME_COMMAND_NAME_TO_URL.put("getNetworkConditions", new CommandInfo("/session/:sessionId/chromium/network_conditions", HttpMethod.GET));
        CHROME_COMMAND_NAME_TO_URL.put("setNetworkConditions", new CommandInfo("/session/:sessionId/chromium/network_conditions", HttpMethod.POST));
        CHROME_COMMAND_NAME_TO_URL.put("deleteNetworkConditions", new CommandInfo("/session/:sessionId/chromium/network_conditions", HttpMethod.DELETE));
        CHROME_COMMAND_NAME_TO_URL.put("executeCdpCommand", new CommandInfo("/session/:sessionId/goog/cdp/execute", HttpMethod.POST));
        CHROME_COMMAND_NAME_TO_URL.put("getCastSinks", new CommandInfo("/session/:sessionId/goog/cast/get_sinks", HttpMethod.GET));
        CHROME_COMMAND_NAME_TO_URL.put("selectCastSink", new CommandInfo("/session/:sessionId/goog/cast/set_sink_to_use", HttpMethod.POST));
        CHROME_COMMAND_NAME_TO_URL.put("startCastTabMirroring", new CommandInfo("/session/:sessionId/goog/cast/start_tab_mirroring", HttpMethod.POST));
        CHROME_COMMAND_NAME_TO_URL.put("getCastIssueMessage", new CommandInfo("/session/:sessionId/goog/cast/get_issue_message", HttpMethod.GET));
        CHROME_COMMAND_NAME_TO_URL.put("stopCasting", new CommandInfo("/session/:sessionId/goog/cast/stop_casting", HttpMethod.POST));
        CHROME_COMMAND_NAME_TO_URL.put("setPermission", new CommandInfo("/session/:sessionId/permissions", HttpMethod.POST));
    }
    
}

再测试一下效果

可以看到user-agent已经被成功替换了。

总结一下解决问题的流程

1. 继承RemoteWebDriver类
2. 参考ChromeDriver实现executeCdpCommand方法
3. 参考ChromeDriver创建自定义的commandExecutor增加命令

事实上，因为cdp命令是chrome浏览器提供的支持，与selenium无关，在selenium4中只是内置了这个命令的参数和地址，调用的原理与原来支持的方法是一样的。在自己实现的CdpRemoteWebDriver中已经自己添加了参数，并不需要将依赖升级到4.0.0就可以调用cdp命令了。