Skip to content

io microsphere spring web rule WebRequestParamsRule

github-actions[bot] edited this page Jun 18, 2026 · 18 revisions

WebRequestParamsRule

Type: Class | Module: microsphere-spring-web | Package: io.microsphere.spring.web.rule | Since: 1.0.0

Source: microsphere-spring-web/src/main/java/io/microsphere/spring/web/rule/WebRequestParamsRule.java

Overview

A WebRequestRule that matches requests based on parameter expressions.

This class extends AbstractWebRequestRule with support for WebRequestParamExpression to define conditions on request parameters.

Example Usage

`// Create a rule that matches requests with the parameter "foo" set to "bar"
WebRequestParamsRule rule = new WebRequestParamsRule("foo=bar");

// Create a rule that matches requests with both "foo=bar" and "baz"
WebRequestParamsRule rule = new WebRequestParamsRule("foo=bar", "baz");
`

Declaration

public class WebRequestParamsRule extends AbstractWebRequestRule<WebRequestParamExpression>

Author: Mercy

Version Information

  • Introduced in: 1.0.0
  • Current Project Version: 0.2.27-SNAPSHOT

Version Compatibility

This component is tested and compatible with the following Java versions:

Java Version Status
Java 17 ✅ Compatible
Java 21 ✅ Compatible
Java 25 ✅ Compatible

Examples

// Create a rule that matches requests with the parameter "foo" set to "bar"
WebRequestParamsRule rule = new WebRequestParamsRule("foo=bar");

// Create a rule that matches requests with both "foo=bar" and "baz"
WebRequestParamsRule rule = new WebRequestParamsRule("foo=bar", "baz");

Usage

Maven Dependency

Add the following dependency to your pom.xml:

<dependency>
    <groupId>io.github.microsphere-projects</groupId>
    <artifactId>microsphere-spring-web</artifactId>
    <version>${microsphere-spring.version}</version>
</dependency>

Tip: Use the BOM (microsphere-spring-dependencies) for consistent version management. See the Getting Started guide.

Import

import io.microsphere.spring.web.rule.WebRequestParamsRule;

API Reference

Public Methods

Method Description
matches

See Also

  • WebRequestParamExpression
  • AbstractWebRequestRule
  • org.springframework.web.servlet.mvc.condition.ParamsRequestCondition
  • org.springframework.web.reactive.result.condition.ParamsRequestCondition

This documentation was auto-generated from the source code of microsphere-spring.

Home

spring-context

spring-guice

spring-jdbc

spring-test

spring-web

spring-webflux

spring-webmvc

Clone this wiki locally