mica-xss/README.md · donggunche55/mica

forked from 如梦技术/mica

加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

免费加入

文件

克隆/下载

README.md 999 Bytes

一键复制编辑原始数据按行查看历史

提交于 2020-12-02 09:57 .

依赖升级和完善文档。

# mica-xss 组件

## 说明
- 对表单绑定的字符串类型进行 xss 处理。
- 对 json 字符串数据进行 xss 处理。
- 提供路由和控制器方法级别的放行规则。

## 使用
### maven
```xml
<dependency>
  <groupId>net.dreamlu</groupId>
  <artifactId>mica-xss</artifactId>
  <version>${version}</version>
</dependency>
```

### gradle
```groovy
compile("net.dreamlu:mica-xss:${version}")
```

## 配置
| 配置项 | 默认值 | 说明 |
| ----- | ------ | ------ |
| mica.xss.enabled | true | 开启xss |
| mica.xss.path-patterns | /** | 拦截的路由，必须配置，例如: /api/order/** |
| mica.xss.exclude-patterns |  | 放行的规则，默认为空 |

## 注解
可以使用 `@XssCleanIgnore` 注解对方法和类级别进行忽略。

## 自定义 xss 清理
如果内置的 xss 清理规则不满足需求，可以自己实现 `XssCleaner`，注册成 Spring bean 即可。

```java
@Bean
public XssCleaner xssCleaner() {
    return new MyXssCleaner();
}
```

马建仓 AI 助手

尝试更多

代码解读

代码找茬

代码优化

Java

https://gitee.com/donggunche55/mica.git

git@gitee.com:donggunche55/mica.git

donggunche55

mica

master

donggunche55/mica

简介

发行版

贡献者

近期动态

donggunche55/mica .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

donggunche55/mica