Router (solon 3.7.1 API)

All Known Implementing Classes:: RouterDefault

public interface Router

通用路由器

 public class DemoApp{
     public static void main(String[] args){
         Solon.start(DemoApp.class, args,app->{
             //
             //路由手写模式
             //
             app.router().get("/hello/*",c->coutput("heollo world;"));
         });
     }
 }

 //
 //容器自动模式
 //

Since:: 1.0, 3.0
Author:: noear

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default void`	`add(BeanWrap bw)` 添加控制器
`default void`	`add(Class<?> clz)` 添加控制器类
`default void`	`add(String pathPrefix, BeanWrap bw)` 添加控制器
`void`	`add(String pathPrefix, BeanWrap bw, boolean remoting)` 添加路由关系 for Handler
`default void`	`add(String pathPrefix, Class<?> clz)` 添加控制器类
`default void`	`add(String pathPrefix, Class<?> clz, boolean remoting)` 添加控制器类
`default void`	`add(String path, Handler handler)` 添加路径处理
`default void`	`add(String path, MethodType method, Handler handler)` 添加路径处理
`void`	`add(String path, MethodType method, int index, Handler handler)` 添加路由关系 for Handler
`void`	`addPathPrefix(String pathPrefix, Predicate<Class<?>> tester)` 添加路径前缀
`default void`	`all(String path, Handler handler)` 添加所有方法处理
`void`	`caseSensitive(boolean caseSensitive)` 区分大小写（默认区分）
`void`	`clear()` 清空路由关系
`default void`	`delete(String path, Handler handler)` 添加DELETE方法的处理（REST.delete 从服务端删除资源）
`default void`	`filter(Filter filter)` 添加过滤器（按先进后出策略执行）
`void`	`filter(int index, Filter filter)` 添加过滤器（按先进后出策略执行）
`void`	`filterIfAbsent(int index, Filter filter)` 添加过滤器（按先进后出策略执行）,如果有相同类的则不加
`Collection<Routing<Handler>>`	`findAll()` 获取某个处理点的所有路由记录（管理用）
`Collection<Routing<Handler>>`	`findBy(Class<?> controllerClz)` 获取某个控制器的路由记录（管理用）
`Collection<Routing<Handler>>`	`findBy(String pathPrefix)` 获取某个路径的某个处理点的路由记录（管理用）
`default void`	`get(String path, Handler handler)` 添加GET方法的处理（REST.select 从服务端获取一或多项资源）
`default Collection<Routing<Handler>>`	`getAll()` Deprecated. 3.7 避免与 get(path,hander) 疑似冲突 `findAll()`
`default Collection<Routing<Handler>>`	`getBy(Class<?> controllerClz)` Deprecated. 3.7 避免与 get(path,hander) 疑似冲突 `findBy(Class)`
`default Collection<Routing<Handler>>`	`getBy(String pathPrefix)` Deprecated. 3.7 避免与 get(path,hander) 疑似冲突 `findBy(String)`
`default void`	`head(String path, Handler handler)` 添加HEAD方法的处理
`default void`	`http(String path, Handler handler)` 添加HTTP所有方法的处理（GET,POST,PUT,PATCH,DELETE,HEAD）
`Handler`	`matchMain(Context ctx)` 区配一个主处理（根据上下文）
`Result<Handler>`	`matchMainAndStatus(Context ctx)` 区配一个主处理，并获取状态（根据上下文）
`default void`	`patch(String path, Handler handler)` 添加PATCH方法的处理（REST.update 客户端提供改变的属性）
`default void`	`post(String path, Handler handler)` 添加POST方法的处理（REST.create 在服务端新建一项资源）
`default void`	`put(String path, Handler handler)` 添加PUT方法的处理（REST.update 客户端提供改变后的完整资源）
`void`	`remove(Class<?> controllerClz)` 移除路由关系
`void`	`remove(String pathPrefix)` 移除路由关系
`void`	`routerInterceptor(int index, RouterInterceptor interceptor)` 添加路由拦截器（按先进后出策略执行）
`default void`	`routerInterceptor(RouterInterceptor interceptor)` 添加路由拦截器（按先进后出策略执行）
`void`	`routerInterceptorIfAbsent(int index, RouterInterceptor interceptor)` 添加路由拦截器（按先进后出策略执行）,如果有相同类的则不加
`default void`	`socketd(String path, Handler handler)` 添加socket方法的监听

- Method Detail
  - caseSensitive
```
void caseSensitive(boolean caseSensitive)
```
    区分大小写（默认区分）
    
    Parameters:
    
    caseSensitive - 区分大小写
  - addPathPrefix
```
void addPathPrefix(String pathPrefix,
                   Predicate<Class<?>> tester)
```
    添加路径前缀
  - add
```
void add(String path,
         MethodType method,
         int index,
         Handler handler)
```
    添加路由关系 for Handler
    
    Parameters:
    
    path - 路径
    
    method - 方法
    
    index - 顺序位
    
    handler - 处理接口
  - add
```
void add(String pathPrefix,
         BeanWrap bw,
         boolean remoting)
```
    添加路由关系 for Handler
    
    Parameters:
    
    pathPrefix - 路径前缀
    
    bw - Bean 包装
    
    remoting - 是否为远程处理
  - matchMainAndStatus
```
Result<Handler> matchMainAndStatus(Context ctx)
```
    区配一个主处理，并获取状态（根据上下文）
    
    Parameters:
    
    ctx - 上下文
    
    Returns:
    
    一个匹配的处理结果
  - matchMain
```
Handler matchMain(Context ctx)
```
    区配一个主处理（根据上下文）
    
    Parameters:
    
    ctx - 上下文
    
    Returns:
    
    一个匹配的处理
  - findAll
```
Collection<Routing<Handler>> findAll()
```
    获取某个处理点的所有路由记录（管理用）
    
    Returns:
    
    处理点的所有路由记录
  - findBy
```
Collection<Routing<Handler>> findBy(String pathPrefix)
```
    获取某个路径的某个处理点的路由记录（管理用）
    
    Parameters:
    
    pathPrefix - 路径前缀
    
    Returns:
    
    路径处理点的路由记录
    
    Since:
    
    2.6
  - findBy
```
Collection<Routing<Handler>> findBy(Class<?> controllerClz)
```
    获取某个控制器的路由记录（管理用）
    
    Parameters:
    
    controllerClz - 控制器类
    
    Returns:
    
    控制器处理点的路由记录
  - remove
```
void remove(String pathPrefix)
```
    移除路由关系
    
    Parameters:
    
    pathPrefix - 路径前缀
  - remove
```
void remove(Class<?> controllerClz)
```
    移除路由关系
    
    Parameters:
    
    controllerClz - 控制器类
  - clear
```
void clear()
```
    清空路由关系
  - filter
```
void filter(int index,
            Filter filter)
```
    添加过滤器（按先进后出策略执行）
    
    Parameters:
    
    index - 顺序位
    
    filter - 过滤器
    
    Since:
    
    1.5, 3.7
  - filterIfAbsent
```
void filterIfAbsent(int index,
                    Filter filter)
```
    添加过滤器（按先进后出策略执行）,如果有相同类的则不加
    
    Parameters:
    
    index - 顺序位
    
    filter - 过滤器
    
    Since:
    
    2.6, 3.7
  - filter
```
default void filter(Filter filter)
```
    添加过滤器（按先进后出策略执行）
    
    Parameters:
    
    filter - 过滤器
    
    Since:
    
    3.7
  - routerInterceptor
```
void routerInterceptor(int index,
                       RouterInterceptor interceptor)
```
    添加路由拦截器（按先进后出策略执行）
    
    Parameters:
    
    index - 顺序位
    
    interceptor - 路由拦截器
    
    Since:
    
    3.7
  - routerInterceptorIfAbsent
```
void routerInterceptorIfAbsent(int index,
                               RouterInterceptor interceptor)
```
    添加路由拦截器（按先进后出策略执行）,如果有相同类的则不加
    
    Parameters:
    
    index - 顺序位
    
    interceptor - 路由拦截器
    
    Since:
    
    3.7
  - routerInterceptor
```
default void routerInterceptor(RouterInterceptor interceptor)
```
    添加路由拦截器（按先进后出策略执行）
    
    Parameters:
    
    interceptor - 路由拦截器
    
    Since:
    
    3.7
  - add
```
default void add(String path,
                 Handler handler)
```
    添加路径处理
    
    Parameters:
    
    path - 路径
    
    handler - 处理接口
  - add
```
default void add(String path,
                 MethodType method,
                 Handler handler)
```
    添加路径处理
    
    Parameters:
    
    path - 路径
    
    method - 方法
    
    handler - 处理接口
  - add
```
default void add(BeanWrap bw)
```
    添加控制器
    
    Parameters:
    
    bw - Bean 包装
  - add
```
default void add(String pathPrefix,
                 BeanWrap bw)
```
    添加控制器
    
    Parameters:
    
    pathPrefix - 路径前缀
    
    bw - Bean 包装
  - add
```
default void add(Class<?> clz)
```
    添加控制器类
    
    Since:
    
    3.7.1
  - add
```
default void add(String pathPrefix,
                 Class<?> clz)
```
    添加控制器类
  - add
```
default void add(String pathPrefix,
                 Class<?> clz,
                 boolean remoting)
```
    添加控制器类
  - all
```
default void all(String path,
                 Handler handler)
```
    添加所有方法处理
  - http
```
default void http(String path,
                  Handler handler)
```
    添加HTTP所有方法的处理（GET,POST,PUT,PATCH,DELETE,HEAD）
  - head
```
default void head(String path,
                  Handler handler)
```
    添加HEAD方法的处理
  - get
```
default void get(String path,
                 Handler handler)
```
    添加GET方法的处理（REST.select 从服务端获取一或多项资源）
  - post
```
default void post(String path,
                  Handler handler)
```
    添加POST方法的处理（REST.create 在服务端新建一项资源）
  - put
```
default void put(String path,
                 Handler handler)
```
    添加PUT方法的处理（REST.update 客户端提供改变后的完整资源）
  - patch
```
default void patch(String path,
                   Handler handler)
```
    添加PATCH方法的处理（REST.update 客户端提供改变的属性）
  - delete
```
default void delete(String path,
                    Handler handler)
```
    添加DELETE方法的处理（REST.delete 从服务端删除资源）
  - socketd
```
default void socketd(String path,
                     Handler handler)
```
    添加socket方法的监听
  - getAll
```
@Deprecated
default Collection<Routing<Handler>> getAll()
```
    Deprecated. 3.7 避免与 get(path,hander) 疑似冲突 findAll()
    
    获取某个处理点的所有路由记录（管理用）
    
    Returns:
    
    处理点的所有路由记录
  - getBy
```
@Deprecated
default Collection<Routing<Handler>> getBy(String pathPrefix)
```
    Deprecated. 3.7 避免与 get(path,hander) 疑似冲突 findBy(String)
    
    获取某个路径的某个处理点的路由记录（管理用）
    
    Parameters:
    
    pathPrefix - 路径前缀
    
    Returns:
    
    路径处理点的路由记录
    
    Since:
    
    2.6
  - getBy
```
@Deprecated
default Collection<Routing<Handler>> getBy(Class<?> controllerClz)
```
    Deprecated. 3.7 避免与 get(path,hander) 疑似冲突 findBy(Class)
    
    获取某个控制器的路由记录（管理用）
    
    Parameters:
    
    controllerClz - 控制器类
    
    Returns:
    
    控制器处理点的路由记录

Interface Router

Method Summary

Method Detail

caseSensitive

addPathPrefix

add

add

matchMainAndStatus

matchMain

findAll

findBy

findBy

remove

remove

clear

filter

filterIfAbsent

filter

routerInterceptor

routerInterceptorIfAbsent

routerInterceptor

add

add

add

add

add

add

add

all

http

head

get

post

put

patch

delete

socketd

getAll

getBy

getBy