以编程方式确定我们是使用CSOM API连接到SharePoint Online还是本地

确定连接到SharePoint Online还是本地的编程方法

基础概念

在SharePoint开发中，CSOM (Client Side Object Model) 是一个常用的API，用于从客户端应用程序与SharePoint进行交互。区分连接目标是SharePoint Online还是本地(On-Premises)对于正确处理认证、URL结构和功能差异非常重要。

检测方法

方法1：通过URL分析

public bool IsSharePointOnline(string siteUrl)
{
    try
    {
        Uri uri = new Uri(siteUrl);
        string host = uri.Host.ToLower();
        
        // SharePoint Online通常包含sharepoint.com或特定租户名称
        return host.Contains(".sharepoint.com") || 
               host.Contains("-my.sharepoint.com") || 
               host.Contains(".sharepoint.cn");
    }
    catch
    {
        return false;
    }
}

方法2：通过认证方式检测

public bool IsSharePointOnline(ClientContext context)
{
    try
    {
        // SharePoint Online通常使用OAuth或Azure AD认证
        if (context.Credentials is SharePointOnlineCredentials)
        {
            return true;
        }
        
        // 本地通常使用NetworkCredential或Windows认证
        return false;
    }
    catch
    {
        return false;
    }
}

方法3：通过API版本检测

public bool IsSharePointOnline(ClientContext context)
{
    try
    {
        // SharePoint Online通常使用较新的API版本
        var version = context.ServerLibraryVersion;
        return version.Major >= 16; // SPO通常使用16.x或更高版本
    }
    catch
    {
        return false;
    }
}

优势与限制

优势：

简单易实现
不需要额外权限
可以提前判断连接类型

限制：

URL分析可能不适用于所有自定义域名情况
认证方式检测需要在建立连接后进行
API版本检测需要成功建立连接

应用场景

认证流程选择：根据连接类型选择适当的认证方式
功能可用性检查：某些功能在Online和本地版本中表现不同
错误处理：针对不同环境提供特定的错误处理逻辑
性能优化：针对不同环境调整请求频率和批处理策略

完整示例

using Microsoft.SharePoint.Client;
using System;

public class SharePointEnvironmentDetector
{
    public enum SharePointEnvironment
    {
        Online,
        OnPremises,
        Unknown
    }

    public SharePointEnvironment DetectEnvironment(string siteUrl, ClientContext context = null)
    {
        // 首先通过URL检测
        if (IsSharePointOnlineByUrl(siteUrl))
        {
            return SharePointEnvironment.Online;
        }

        // 如果提供了context，尝试通过其他方法检测
        if (context != null)
        {
            if (IsSharePointOnlineByAuthentication(context))
            {
                return SharePointEnvironment.Online;
            }

            if (IsSharePointOnlineByApiVersion(context))
            {
                return SharePointEnvironment.Online;
            }
        }

        // 如果所有检测都失败，假设是本地环境
        return SharePointEnvironment.OnPremises;
    }

    private bool IsSharePointOnlineByUrl(string siteUrl)
    {
        try
        {
            Uri uri = new Uri(siteUrl);
            string host = uri.Host.ToLower();
            
            return host.Contains(".sharepoint.com") || 
                   host.Contains("-my.sharepoint.com") || 
                   host.Contains(".sharepoint.cn");
        }
        catch
        {
            return false;
        }
    }

    private bool IsSharePointOnlineByAuthentication(ClientContext context)
    {
        try
        {
            return context.Credentials is SharePointOnlineCredentials;
        }
        catch
        {
            return false;
        }
    }

    private bool IsSharePointOnlineByApiVersion(ClientContext context)
    {
        try
        {
            var version = context.ServerLibraryVersion;
            return version.Major >= 16;
        }
        catch
        {
            return false;
        }
    }
}

使用示例

string siteUrl = "https://contoso.sharepoint.com/sites/mysite";
using (var context = new ClientContext(siteUrl))
{
    context.Credentials = new SharePointOnlineCredentials(username, securePassword);
    
    var detector = new SharePointEnvironmentDetector();
    var env = detector.DetectEnvironment(siteUrl, context);
    
    Console.WriteLine($"Environment: {env}");
}

通过组合多种检测方法，可以更可靠地确定连接的是SharePoint Online还是本地环境。