Excel插件日志系统：无需打开文件向SharePoint在线.txt追加内容

针对你开发Excel插件时遇到的SharePoint在线TXT文件写入问题，不用本地映射驱动器也不用打开文件的核心方案是利用SharePoint REST API来完成操作——因为直接通过文件URL进行普通IO操作会被SharePoint的权限机制拦截，而REST API是官方支持的、无需本地映射的在线操作方式。

下面是具体的实现步骤和代码示例：

核心思路 #

SharePoint没有提供直接追加文本的API端点，所以我们需要分两步走：

1. 获取目标TXT文件的当前内容和ETag（用于处理并发冲突）
2. 将新日志内容追加到原有内容后，再通过API覆盖更新文件

实现步骤 #

1. 认证获取访问令牌 #

作为Excel插件，你可以直接使用Office.js提供的身份认证能力获取SharePoint的访问令牌，无需额外处理登录逻辑：

function getAccessToken() {
  return new Promise((resolve, reject) => {
    Office.context.auth.getAccessTokenAsync({
      allowSignInPrompt: true,
      forMSGraphAccess: false // 这里我们只需要SharePoint API权限
    }, function(result) {
      if (result.status === "succeeded") {
        resolve(result.value);
      } else {
        reject(new Error(`获取令牌失败: ${result.error.message}`));
      }
    });
  });
}

2. 读取现有文件内容 #

通过SharePoint REST API的$value端点获取文件的文本内容：

async function getSharePointFileContent(siteUrl, fileRelativeUrl, accessToken) {
  const apiUrl = `${siteUrl}/_api/web/getfilebyserverrelativeurl('${fileRelativeUrl}')/$value`;
  
  const response = await fetch(apiUrl, {
    method: 'GET',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Accept': 'text/plain'
    }
  });
  
  if (!response.ok) {
    throw new Error(`读取文件失败: ${response.statusText}`);
  }
  
  // 获取响应的ETag（用于后续更新时的并发校验）
  const eTag = response.headers.get('ETag');
  const content = await response.text();
  
  return { content, eTag };
}

3. 追加日志并更新文件 #

将新日志内容拼接后，通过PUT请求更新文件：

async function appendLogToSharePointFile(siteUrl, fileRelativeUrl, newLog, accessToken) {
  try {
    // 先读取现有内容和ETag
    const { content, eTag } = await getSharePointFileContent(siteUrl, fileRelativeUrl, accessToken);
    
    // 拼接新日志（可以加上时间戳等信息）
    const updatedContent = content + `\n${new Date().toISOString()}: ${newLog}`;
    
    // 构造更新请求的API端点
    const updateApiUrl = `${siteUrl}/_api/web/getfilebyserverrelativeurl('${fileRelativeUrl}')/$value`;
    
    const response = await fetch(updateApiUrl, {
      method: 'PUT',
      headers: {
        'Authorization': `Bearer ${accessToken}`,
        'Content-Type': 'text/plain',
        'If-Match': eTag // 带上ETag避免并发覆盖
      },
      body: updatedContent
    });
    
    if (!response.ok) {
      throw new Error(`更新文件失败: ${response.statusText}`);
    }
    
    console.log('日志追加成功');
  } catch (error) {
    // 如果文件不存在，可以尝试创建新文件
    if (error.message.includes('404')) {
      await createSharePointFile(siteUrl, fileRelativeUrl, newLog, accessToken);
    } else {
      console.error('追加日志出错:', error);
    }
  }
}

// 辅助函数：创建新的TXT文件
async function createSharePointFile(siteUrl, fileRelativeUrl, initialContent, accessToken) {
  // 拆分文件夹路径和文件名
  const folderRelativeUrl = fileRelativeUrl.substring(0, fileRelativeUrl.lastIndexOf('/'));
  const fileName = fileRelativeUrl.substring(fileRelativeUrl.lastIndexOf('/') + 1);
  
  const createApiUrl = `${siteUrl}/_api/web/getfolderbyserverrelativeurl('${folderRelativeUrl}')/files/add(overwrite=true, url='${fileName}')`;
  
  const response = await fetch(createApiUrl, {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'text/plain'
    },
    body: initialContent
  });
  
  if (!response.ok) {
    throw new Error(`创建文件失败: ${response.statusText}`);
  }
  
  console.log('新日志文件创建并写入成功');
}

4. 在Excel关闭事件中调用 #

你可以监听Excel的DocumentBeforeClose事件，在触发时调用上述函数：

// 初始化插件时注册关闭事件
Office.initialize = function() {
  // 假设你已经收集了日志内容到logs数组中
  const collectedLogs = [];
  
  // 收集日志的函数
  function collectLog(logText) {
    collectedLogs.push(logText);
  }
  
  // 监听关闭事件
  Office.context.document.addHandlerAsync(Office.EventType.DocumentBeforeClose, async function(eventArgs) {
    if (collectedLogs.length === 0) return;
    
    try {
      const accessToken = await getAccessToken();
      const siteUrl = 'https://your-tenant.sharepoint.com/sites/your-team-site'; // 替换成你的站点URL
      const fileRelativeUrl = '/sites/your-team-site/Shared Documents/plugin-logs.txt'; // 替换成文件的服务器相对路径
      
      // 将所有收集的日志合并成一个字符串
      const logContent = collectedLogs.join('\n');
      await appendLogToSharePointFile(siteUrl, fileRelativeUrl, logContent, accessToken);
      
      // 清除已写入的日志
      collectedLogs.length = 0;
    } catch (error) {
      console.error('写入日志失败:', error);
      // 如果写入失败，可以选择提示用户，或者缓存日志到本地下次再试
      eventArgs.cancel = true; // 可选：阻止Excel关闭，直到日志写入完成
    }
  });
};

关键注意事项 #

• 权限配置：确保你的Excel插件已经申请了SharePoint的Files.ReadWrite.All或者更精细的权限（比如针对特定站点的权限），否则会出现403错误。
• 并发处理：使用If-Match头部带上ETag，可以避免多个用户同时写入时的内容覆盖问题。
• 错误处理：要考虑文件不存在的情况（首次写入）、网络异常、权限不足等场景，必要时可以将日志缓存到本地（比如用Office.context.document.settings），下次插件启动时再尝试同步。

内容的提问来源于stack exchange，提问作者user9553563