ExoPlayer2 Android：配置HTTP请求头以支持Referer

本教程详细介绍了如何在android exoplayer2应用中为http数据源配置referer请求头。通过修改`httpdatasource.factory`的构建逻辑，利用`setdefaultrequestproperties`方法设置自定义referer值，可以有效解决播放需要特定referer验证的m3u8流或其他媒体资源的问题，确保内容正常加载和播放。

理解Referer请求头及其在ExoPlayer中的作用

在Web通信中，Referer（尽管拼写错误，但已成为标准）是一个HTTP请求头，用于指示当前请求的来源页面URL。服务器可以利用这个信息来识别请求的来源，常用于：

• 防盗链机制： 阻止未经授权的网站直接链接到受保护的媒体资源。
• 内容访问控制： 确保只有特定来源的请求才能访问某些内容。
• 日志分析： 记录用户访问路径。

在Android的ExoPlayer应用中播放M3U8流、MPD文件或其他需要特定HTTP头的媒体资源时，如果服务器配置了基于Referer头的访问限制，那么ExoPlayer发出的请求就必须包含一个有效的Referer头，否则服务器将拒绝服务，导致播放失败。

配置ExoPlayer的HttpDataSource以添加Referer头

ExoPlayer通过DataSource.Factory接口来创建用于加载媒体数据的数据源。对于HTTP/HTTPS协议，通常会使用HttpDataSource.Factory的实现，最常见的是DefaultHttpDataSource.Factory。这个工厂类提供了灵活的配置选项，包括设置默认的HTTP请求头。

DefaultHttpDataSource.Factory提供了一个关键方法：

public DefaultHttpDataSource.Factory setDefaultRequestProperties(Map defaultRequestProperties)

此方法允许开发者传入一个Map，其中包含所有需要在HTTP请求中默认添加的头部键值对。

陌言AI

陌言AI是一个一站式AI创作平台，支持在线AI写作，AI对话，AI绘画等功能

下载

错误尝试分析： 在开发过程中，有时会遇到类似以下的代码尝试：

return new DefaultHttpDataSource.Factory(...)
       .getDefaultRequestProperties().set("referer","myrefererer");

这种尝试通常会导致编译错误或运行时异常。原因在于getDefaultRequestProperties()方法返回的是一个Map对象，而不是DefaultHttpDataSource.Factory实例本身。因此，在其上调用set()方法（如果Map接口有这样的方法）并不能将配置链式地返回给DefaultHttpDataSource.Factory以继续构建。正确的做法是先构建好包含所有请求头的Map，然后将这个Map整体传递给setDefaultRequestProperties()方法。

示例代码：正确添加Referer头

以下是构建一个配置了Referer请求头的HttpDataSource.Factory的正确方法。这个工厂可以随后传递给DefaultDataSourceFactory，进而用于构建ExoPlayer实例。

import android.content.Context;
import com.google.android.exoplayer2.upstream.HttpDataSource;
import com.google.android.exoplayer2.upstream.DefaultHttpDataSource;
import com.google.android.exoplayer2.util.Util;
import java.util.HashMap;
import java.util.Map;

/**
 * 辅助类，用于构建配置了自定义HTTP请求头的ExoPlayer数据源工厂。
 */
public class ExoPlayerHttpDataSourceBuilder {

    private final Context context;
    private final String customUserAgent; // 可选：用于自定义User-Agent

    /**
     * 构造函数。
     * @param context 应用上下文。
     * @param customUserAgent 自定义的User-Agent字符串，如果为null则使用ExoPlayer默认值。
     */
    public ExoPlayerHttpDataSourceBuilder(Context context, String customUserAgent) {
        this.context = context;
        this.customUserAgent = customUserAgent;
    }

    /**
     * 构建一个配置了Referer请求头的HttpDataSource.Factory。
     *
     * @param refererValue 要设置的Referer值，例如 "https://your-app-domain.com/"。
     * @return 配置好的HttpDataSource.Factory实例。
     */
    public HttpDataSource.Factory buildHttpDataSourceFactoryWithReferer(String refererValue) {
        Map defaultRequestProperties = new HashMap<>();
        // 添加Referer请求头
        // 注意：HTTP头名通常是大小写不敏感的，但为了兼容性，建议使用标准拼写"Referer"。
        defaultRequestProperties.put("Referer", refererValue);

        // 构建DefaultHttpDataSource.Factory
        return new DefaultHttpDataSource.Factory()
                // 设置User-Agent。推荐使用Util.getUserAgent获取默认值或自定义。
                .setUserAgent(customUserAgent != null ? customUserAgent : Util.getUserAgent(context, "YourExoPlayerApp"))
                // 设置默认请求头，包括我们添加的Referer
                .setDefaultRequestProperties(defaultRequestProperties)
                // 根据需要配置是否允许跨协议重定向（例如从HTTP重定向到HTTPS）
                .setAllowCrossProtocolRedirects(true);
    }

    /**
     * 示例：如何将构建的HttpDataSource.Factory集成到DefaultDataSourceFactory中。
     * 通常，DefaultDataSourceFactory会封装HttpDataSource.Factory，并处理本地文件等数据源。
     *
     * @param bandwidthMeter 带宽计量器，用于监控网络带宽。
     * @param refererValue 要设置的Referer值。
     * @return 配置好的DataSource.Factory实例。
     */
    /*
    public DataSource.Factory buildDataSourceFactory(DefaultBandwidthMeter bandwidthMeter, String refererValue) {
        // 首先构建配置好Referer的HttpDataSource.Factory
        HttpDataSource.Factory httpDataSourceFactory = buildHttpDataSourceFactoryWithReferer(refererValue);

        // 然后将它传递给DefaultDataSourceFactory
        return new DefaultDataSourceFactory(context, bandwidthMeter, httpDataSourceFactory);
    }
    */
}

如何使用上述ExoPlayerHttpDataSourceBuilder：

1. 在你的Activity或Fragment中实例化ExoPlayerHttpDataSourceBuilder。
2. 调用buildHttpDataSourceFactoryWithReferer()方法获取一个配置好的HttpDataSource.Factory。
3. 将这个HttpDataSource.Factory传递给DefaultDataSourceFactory的构造函数。
4. 使用DefaultDataSourceFactory来构建ExoPlayer的MediaSource。

// 示例用法（在你的Activity或Fragment中）
// ...
// DefaultBandwidthMeter bandwidthMeter = new DefaultBandwidthMeter.Builder(context).build();
// String referer = "https://my.awesome.app/"; // 根据实际需求设置Referer值
//
// ExoPlayerHttpDataSourceBuilder builder = new ExoPlayerHttpDataSourceBuilder(context, null); // null表示使用默认User-Agent
// HttpDataSource.Factory httpDataSourceFactory = builder.buildHttpDataSourceFactoryWithReferer(referer);
//
// DataSource.Factory dataSourceFactory = new DefaultDataSourceFactory(context, bandwidthMeter, httpDataSourceFactory);
//
// MediaSource mediaSource = new HlsMediaSource.Factory(dataSourceFactory)
//                                   .createMediaSource(MediaItem.fromUri(Uri.parse("your_m3u8_url")));
//
// exoPlayer.setMediaSource(mediaSource);
// exoPlayer.prepare();
// ...

注意事项与最佳实践

1. Referer值的精确性： 服务器通常会严格校验Referer值。确保你提供的Referer值与服务器期望的完全匹配，包括协议（http/https）、域名和路径。一个字符的差异都可能导致验证失败。
2. 动态Referer： 如果你的应用需要根据不同的播放内容或用户状态动态设置Referer，你可以在每次构建HttpDataSource.Factory时，根据当前情况传入不同的Referer值。
3. 其他请求头： 除了Referer，你可能还需要设置Authorization、Cookie等其他HTTP请求头。添加它们的方法与Referer类似，只需在HashMap中添加对应的键值对即可。
4. 安全性： 避免在公共代码或版本控制中硬编码敏感的Referer值或其他认证信息。如果Referer值是敏感的，考虑从安全的配置源（如服务器端API、加密的本地存储）动态获取。
5. ExoPlayer版本兼容性： setDefaultRequestProperties方法在ExoPlayer 2.x的大多数版本中都可用。但始终建议查阅ExoPlayer的官方文档，以确保所用版本支持相关API。
6. User-Agent： 始终建议设置一个有意义的User-Agent。这不仅有助于服务器识别客户端类型，进行统计分析，有时也是服务器验证的一部分。如果未设置，ExoPlayer会使用一个默认的User-Agent。

总结

通过DefaultHttpDataSource.Factory的setDefaultRequestProperties方法，开发者可以灵活且有效地为ExoPlayer配置自定义HTTP请求头，包括Referer。这对于解决因服务器防盗链或内容访问限制导致的媒体播放问题至关重要。理解其工作原理，并遵循最佳实践，能够确保ExoPlayer应用在处理各种媒体资源时具有更强的兼容性和稳定性。