在Android ExoPlayer2中配置Referer请求头

本教程详细介绍了如何在android exoplayer2播放器中为http请求添加referer请求头。通过自定义`httpdatasource.factory`并利用`setdefaultrequestproperties`方法，开发者可以轻松地为m3u8等流媒体url设置指定的referer值，以解决特定服务器的访问限制问题，确保媒体内容正常播放。

引言

在Android应用开发中，使用ExoPlayer2播放流媒体内容（如M3U8）时，有时会遇到服务器对请求来源进行验证的情况。为了防止未经授权的访问或满足特定的内容分发策略，服务器可能要求HTTP请求中包含一个有效的Referer请求头。如果缺少或Referer值不正确，媒体内容可能无法加载或播放。本教程将详细指导您如何在ExoPlayer2中正确配置和添加Referer请求头。

ExoPlayer2网络请求机制概览

ExoPlayer2通过一系列工厂类来构建数据源，从而处理媒体内容的加载。核心组件包括：

• DataSource.Factory: 负责创建DataSource实例，用于读取数据。
• HttpDataSource.Factory: DataSource.Factory的子类，专门用于HTTP(S)网络请求，它创建HttpDataSource实例。
• DefaultHttpDataSource.Factory: HttpDataSource.Factory的默认实现，提供了配置HTTP请求的各种选项。

要添加自定义的HTTP请求头（如Referer），我们需要对HttpDataSource.Factory进行配置。

配置Referer请求头

正确的做法是创建一个Map来存储所有需要添加的自定义请求头，然后将其传递给DefaultHttpDataSource.Factory的setDefaultRequestProperties()方法。

以下是实现这一功能的示例代码：

Powtoon

AI创建令人惊叹的动画短片及简报

下载

import android.content.Context;
import com.google.android.exoplayer2.MediaItem;
import com.google.android.exoplayer2.SimpleExoPlayer;
import com.google.android.exoplayer2.source.MediaSource;
import com.google.android.exoplayer2.source.hls.HlsMediaSource;
import com.google.android.exoplayer2.upstream.DataSource;
import com.google.android.exoplayer2.upstream.DefaultDataSourceFactory;
import com.google.android.exoplayer2.upstream.DefaultHttpDataSource;
import com.google.android.exoplayer2.upstream.HttpDataSource;
import com.google.android.exoplayer2.util.Util;
import java.util.HashMap;
import java.util.Map;

public class ExoPlayerRefererConfig {

    /**
     * 构建一个包含自定义Referer请求头的HttpDataSource.Factory
     *
     * @param context 应用上下文，用于获取UserAgent
     * @param refererValue 要设置的Referer值，例如 "http://www.example.com/player"
     * @return 配置好的HttpDataSource.Factory实例
     */
    public static HttpDataSource.Factory buildHttpDataSourceFactory(Context context, String refererValue) {
        // 创建一个HashMap来存储请求头
        Map defaultRequestProperties = new HashMap<>();
        // 添加Referer请求头。注意：Referer的键名是大小写敏感的。
        defaultRequestProperties.put("Referer", refererValue);

        return new DefaultHttpDataSource.Factory()
                // 设置User-Agent，这是良好的实践，有助于服务器识别客户端类型
                .setUserAgent(Util.getUserAgent(context, "YourExoPlayerApp"))
                // 设置默认请求头，包括我们添加的Referer
                .setDefaultRequestProperties(defaultRequestProperties)
                // 允许跨协议重定向，例如从HTTP重定向到HTTPS
                .setAllowCrossProtocolRedirects(true);
    }

    /**
     * 示例：如何将自定义的HttpDataSource.Factory应用于ExoPlayer
     * 假设您在某个Activity或Fragment中调用此方法
     *
     * @param context 应用上下文
     * @param mediaUrl 要播放的媒体URL，例如M3U8链接
     * @param refererUrl 用于Referer请求头的值
     */
    public static void setupExoPlayerWithReferer(Context context, String mediaUrl, String refererUrl) {
        // 1. 构建HttpDataSource.Factory，传入自定义的Referer值
        HttpDataSource.Factory httpDataSourceFactory = buildHttpDataSourceFactory(context, refererUrl);

        // 2. 构建DefaultDataSourceFactory。
        //    DefaultDataSourceFactory可以处理各种数据源，并允许我们将自定义的httpDataSourceFactory传递进去
        DataSource.Factory dataSourceFactory = new DefaultDataSourceFactory(context, httpDataSourceFactory);

        // 3. 构建MediaSource。这里以HLS为例。
        MediaSource mediaSource = new HlsMediaSource.Factory(dataSourceFactory)
                .createMediaSource(MediaItem.fromUri(mediaUrl));

        // 4. 初始化ExoPlayer并设置MediaSource
        SimpleExoPlayer player = new SimpleExoPlayer.Builder(context).build();
        player.setMediaSource(mediaSource);
        player.prepare(); // 准备播放器
        player.play();   // 开始播放
    }
}

代码解析：

1. Map defaultRequestProperties = new HashMap();: 我们首先创建一个HashMap实例。HTTP请求头是以键值对的形式存在的，Map非常适合存储这些信息。
2. defaultRequestProperties.put("Referer", refererValue);: 将Referer键及其对应的值（例如"http://www.my-app.com/player"）放入Map中。请确保Referer的拼写正确，大小写敏感，并且值符合服务器的预期。
3. new DefaultHttpDataSource.Factory(): 创建DefaultHttpDataSource.Factory的实例。
4. .setUserAgent(Util.getUserAgent(context, "YourExoPlayerApp")): 设置User-Agent请求头。这是一个标准做法，可以帮助服务器识别客户端类型。Util.getUserAgent()会根据设备信息生成一个默认的User-Agent字符串。
5. .setDefaultRequestProperties(defaultRequestProperties): 这是关键一步。它将我们准备好的包含Referer的Map设置给HttpDataSource.Factory，这样所有由该工厂创建的HttpDataSource实例都会包含这些默认请求头。
6. .setAllowCrossProtocolRedirects(true): 这是一个可选配置，如果您的媒体URL可能涉及从HTTP到HTTPS的重定向，或者反之，开启此选项可以确保重定向正常工作。

错误尝试分析

在问题描述中，用户尝试了以下方式：

public HttpDataSource.Factory buildHttpDataSourceFactory(DefaultBandwidthMeter bandwidthMeter) {
    return new DefaultHttpDataSource.Factory(isUserAgent ? userAgentName : Util.getUserAgent(requireActivity(), "ExoPlayerDemo"), bandwidthMeter).getDefaultRequestProperties().set("referer","myrefererer");
}

这个尝试失败的原因在于：

• 返回值类型不匹配：getDefaultRequestProperties()方法返回的是一个Map对象（或其实现），而不是DefaultHttpDataSource.Factory实例本身。因此，在其后面继续链式调用DefaultHttpDataSource.Factory的其他方法（如.setAllowCrossProtocolRedirects())会导致编译错误。
• Map操作方法错误：Map接口并没有名为set的方法来添加键值对，而是应该使用put方法。

正确的做法是先构建Map，然后将Map作为参数传递给setDefaultRequestProperties()方法，如上文所示。

注意事项与最佳实践

• Referer值的准确性：Referer的值必须与服务器期望的格式和内容完全匹配。通常，它是一个完整的URL，表示请求的来源页面。不匹配的值可能导致服务器拒绝请求。
• 安全性考虑：硬编码Referer值可能不是最灵活或最安全的做法，尤其是在应用需要支持多种内容源或动态Referer时。如果Referer值是敏感信息，应考虑加密或从安全配置中动态获取。
• User-Agent：始终建议设置一个有意义的User-Agent，这有助于服务器日志分析和问题排查。
• 上下文管理：在buildHttpDataSourceFactory方法中传递Context参数是推荐的做法，确保Util.getUserAgent()能够正确获取应用上下文。
• 调试：如果Referer配置后仍然无法播放，可以使用网络抓包工具（如Wireshark、Fiddler或Android Studio的Network Inspector）检查实际发出的HTTP请求头，确认Referer是否已正确添加。

总结

通过本教程，您应该已经掌握了如何在Android ExoPlayer2中为HTTP请求添加自定义的Referer请求头。核心在于利用DefaultHttpDataSource.Factory的setDefaultRequestProperties()方法，结合HashMap来灵活地配置所需的请求头。正确配置Referer是解决特定服务器内容访问限制的关键一步，确保您的ExoPlayer应用能够顺畅播放各类流媒体内容。