README.md · Halo SIGs/plugin-trailing-slash

<div align="center" style="text-align: center">
    <img alt="logo" width="96px" src="src/main/resources/logo.svg" style="border-radius: 15px">
    <h1>Trailing Slash</h1>
    <p>重写请求去除尾部斜杠，以保证 URL 规范化, 例如: /path/ -> /path</p>
    <p align="center" style="text-align: center">
        <a href="https://www.halo.run/store/apps/app-KOQzV?tab=readme"><img alt="Halo App Store" src="https://img.shields.io/badge/Halo-%E5%BA%94%E7%94%A8%E5%B8%82%E5%9C%BA-%230A81F5?style=flat-square&logo=appstore&logoColor=%23fff" /></a>
        <a href="https://github.com/halo-sigs/plugin-trailing-slash/releases"><img alt="GitHub Release" src="https://img.shields.io/github/v/release/halo-sigs/plugin-trailing-slash?style=flat-square&logo=github" /></a>
        <a href="https://github.com/halo-sigs/plugin-trailing-slash/actions/workflows/ci.yaml"><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/halo-sigs/plugin-trailing-slash/ci.yaml?style=flat-square&label=build" /></a>
        <a href="./LICENSE"><img alt="GitHub License" src="https://img.shields.io/github/license/halo-sigs/plugin-trailing-slash?style=flat-square" /></a>
    </p>
</div>

## 简介

`Trailing Slash` 插件用于处理请求 URL 尾部斜杠问题。在 Spring Framework 3.0
及以上版本中，[尾部斜杠的路由支持被弃用](https://github.com/spring-projects/spring-framework/issues/28552)
，可能导致一些低版本 Halo 或者从其他应用如 Wordpress 等迁移过来的数据的请求路径无法正确处理。该插件旨在通过重写请求路径，移除
URL 尾部的斜杠，使其能够被正确匹配和处理。

## 问题背景

在 Spring Framework 3.0 之前，框架对 URL 尾部斜杠的路由进行了较宽松的处理。如果一个路由定义为 `/example`，访问 `/example/`
也能成功匹配并返回结果。然而，从 Spring Framework 3.0 开始，为了提高路由规则的一致性和准确性，框架不再支持尾部斜杠的自动匹配行为。
这导致一些依赖尾部斜杠的用户在升级到 Halo 2.x 后出现 404 错误。

## 插件解决方案

`Trailing Slash` 插件通过拦截请求 URL，并移除尾部的斜杠，使请求能够与定义的路由匹配。它适用于以下场景：

- **兼容性**：保持旧版本 Halo 在升级到 Halo 2.x 或者从其他应用迁移到 Halo 2.x 后仍然能够处理带尾部斜杠的请求。
- **一致性**：统一路由风格，使所有路由都保持一致的 URL 结构。

### 插件功能

- **尾部斜杠处理**：自动移除请求 URL 中的尾部斜杠
- **主题端过滤**：作为主题端 WebFilter 适用于所有主题端请求路径(`/apis`,`/api` 开头的请求除外)

## 使用建议

尽管该插件可以帮助解决尾部斜杠问题，但从长期来看，不建议在生产环境中依赖尾部斜杠路由。
为了获得更好的兼容性和可维护性，建议逐步过渡到标准化的无尾部斜杠路由风格。

Halo SIGs/plugin-trailing-slash

简介

发行版

贡献者

近期动态

Halo SIGs/plugin-trailing-slash .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

Halo SIGs/plugin-trailing-slash