Blade (blade 2.0.11.ALPHA API)

java.lang.Object
- com.blade.Blade

```
public class Blade
extends Object
```
Blade Core
The Blade is the core operating class of the framework, which can be used to register routes, modify the template engine, set the file list display, static resource directory, and so on.

作者:

biezhi 2017/5/31

构造器概要

构造器
构造器和说明

Blade()

构造器
构造器和说明
`Blade()`

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`Blade`	`addLoader(BladeLoader loader)` Add blade loader
`Blade`	`addStatics(String... folders)` Add multiple static resource file the default provides the static, upload
`Blade`	`after(String path, RouteHandler handler)` Add a after route to routes, the before route will be executed after matching route
`Blade`	`after(String path, RouteHandler0 handler)` 已过时。
`boolean`	`allowCost()`
`Blade`	`appName(String appName)` Set in the name of the app blade application
`Blade`	`await()` Await web server started
`String`	`bannerText()` Get banner text
`Blade`	`bannerText(String bannerText)` Set blade start banner text
`Blade`	`before(String path, RouteHandler handler)` Add a before route to routes, the before route will be executed before matching route
`Blade`	`before(String path, RouteHandler0 handler)` 已过时。
`Class<?>`	`bootClass()`
`Blade`	`bootConf(String bootConf)` Set to start blade configuration file by default Boot config properties file in classpath directory.
`Blade`	`contextPath(String contextPath)` Set context path, default is "/"
`Blade`	`delete(String path, RouteHandler handler)` Add a delete route to routes
`Blade`	`delete(String path, RouteHandler0 handler)` 已过时。
`boolean`	`devMode()` Get current is developer mode
`Blade`	`devMode(boolean devMode)` Whether encoding setting mode for developers The default mode is developers
`Blade`	`disableCost()`
`Blade`	`disableSession()` Disable session, default is open
`Blade`	`enableCors(boolean enableCors)` Set whether to enable cors
`Optional<String>`	`env(String key)` Get application environment information.
`String`	`env(String key, String defaultValue)` Get application environment information.
`Environment`	`environment()` Return the application's environment configuration information.
`Blade`	`environment(Environment environment)` 已过时。
`Blade`	`environment(String key, Object value)` 已过时。
`Blade`	`event(EventType eventType, EventListener eventListener)` Add a event watcher When the trigger event is executed eventListener
`EventManager`	`eventManager()` Get EventManager
`ExceptionHandler`	`exceptionHandler()` Get ExceptionHandler
`Blade`	`exceptionHandler(ExceptionHandler exceptionHandler)` Set ExceptionHandler, when you need a custom exception handling
`Blade`	`get(String path, RouteHandler handler)` Add a get route to routes
`Blade`	`get(String path, RouteHandler0 handler)` 已过时。
`<T> T`	`getBean(Class<T> cls)` Get ioc bean
`Set<String>`	`getStatics()` Get blade statics list.
`Blade`	`gzip(boolean gzipEnable)` Set whether open gzip, default disabled
`Ioc`	`ioc()` Get blade ioc container, default is SimpleIoc implement.
`boolean`	`isAutoRefreshDir()`
`Blade`	`listen(int port)` Set to start the web server to monitor port, the default is 9000
`Blade`	`listen(String address, int port)` Set to start the web server to listen the IP address and port The default will listen 0.0.0.0:9000
`List<BladeLoader>`	`loaders()`
`static Blade`	`me()` 已过时。
`List<WebHook>`	`middleware()` Get middleware list
`static Blade`	`of()` Give your blade instance, from then on will get the energy
`Blade`	`on(EventType eventType, EventListener eventListener)` Add a event watcher When the trigger event is executed eventListener
`Blade`	`onStarted(BeanProcessor processor)` 已过时。
`Blade`	`post(String path, RouteHandler handler)` Add a post route to routes
`Blade`	`post(String path, RouteHandler0 handler)` 已过时。
`List<BeanProcessor>`	`processors()` 已过时。
`Blade`	`put(String path, RouteHandler handler)` Add a put route to routes
`Blade`	`put(String path, RouteHandler0 handler)` 已过时。
`Blade`	`register(Class<?> cls)` Register bean to ioc container
`Blade`	`register(Object bean)` Register bean to ioc container
`RouteMatcher`	`routeMatcher()` Get RouteMatcher
`Set<String>`	`scanPackages()` Get scan the package set.
`Blade`	`scanPackages(String... packages)` When set to start blade scan packages
`SessionManager`	`sessionManager()` Get SessionManager
`Class<? extends Session>`	`sessionType()` Get session implements Class Type
`Blade`	`sessionType(Class<? extends Session> sessionImplType)` Set session implements Class Type, e.g: RedisSession
`void`	`setAutoRefreshDir(String dir)`
`Blade`	`showFileList(boolean fileList)` Set whether to show the file directory, default doesn't show
`Blade`	`start()` Start blade application.
`Blade`	`start(Class<?> mainCls, String... args)` Start blade application
`Blade`	`start(Class<?> bootClass, String address, int port, String... args)` Start the blade web server
`void`	`stop()` Stop current blade application Will stop synchronization waiting netty service
`TemplateEngine`	`templateEngine()` Get TemplateEngine, default is DefaultEngine
`Blade`	`templateEngine(TemplateEngine templateEngine)` Setting blade mvc default templateEngine
`Blade`	`threadName(String threadName)` Set blade start thread name
`Blade`	`use(WebHook... middleware)` The use of multiple middleware, if any
`Blade`	`watchEnvChange(boolean watchEnvChange)`
`Blade`	`webSocket(String path, WebSocketHandler handler)` Register WebSocket path
`WebSocketHandler`	`webSocketHandler()` Get WebSocket Handler
`String`	`webSocketPath()` Get webSocket path

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - Blade
```
public Blade()
```
- 方法详细资料
  - me
```
@Deprecated
public static Blade me()
```
    已过时。
    
    Give your blade instance, from then on will get the energy
    
    返回:
    
    return blade instance of()
  - of
```
public static Blade of()
```
    Give your blade instance, from then on will get the energy
    
    返回:
    
    return blade instance
  - ioc
```
public Ioc ioc()
```
    Get blade ioc container, default is SimpleIoc implement.
    IOC container will help you hosting Bean or component, it is actually a Map inside. In the blade in a single way to make objects reuse, you can save resources, to avoid the terrible memory leak
    
    返回:
    
    return ioc container
  - get
```
@Deprecated
public Blade get(@NonNull
                             String path,
                             @NonNull
                             RouteHandler0 handler)
```
    已过时。
    
    Add a get route to routes
    
    参数:
    
    path - your route path
    
    handler - route implement
    
    返回:
    
    return blade instance
    
    另请参阅:
    
    get(String, RouteHandler)
  - get
```
public Blade get(@NonNull
                 String path,
                 @NonNull
                 RouteHandler handler)
```
    Add a get route to routes
    
    参数:
    
    path - your route path
    
    handler - route implement
    
    返回:
    
    return blade instance
  - post
```
@Deprecated
public Blade post(@NonNull
                              String path,
                              @NonNull
                              RouteHandler0 handler)
```
    已过时。
    
    Add a post route to routes
    
    参数:
    
    path - your route path
    
    handler - route implement
    
    返回:
    
    return blade instance
    
    另请参阅:
    
    post(String, RouteHandler)
  - post
```
public Blade post(@NonNull
                  String path,
                  @NonNull
                  RouteHandler handler)
```
    Add a post route to routes
    
    参数:
    
    path - your route path
    
    handler - route implement
    
    返回:
    
    return blade instance
  - put
```
@Deprecated
public Blade put(@NonNull
                             String path,
                             @NonNull
                             RouteHandler0 handler)
```
    已过时。
    
    Add a put route to routes
    
    参数:
    
    path - your route path
    
    handler - route implement
    
    返回:
    
    return blade instance
    
    另请参阅:
    
    put(String, RouteHandler)
  - put
```
public Blade put(@NonNull
                 String path,
                 @NonNull
                 RouteHandler handler)
```
    Add a put route to routes
    
    参数:
    
    path - your route path
    
    handler - route implement
    
    返回:
    
    return blade instance
  - delete
```
@Deprecated
public Blade delete(@NonNull
                                String path,
                                @NonNull
                                RouteHandler0 handler)
```
    已过时。
    
    Add a delete route to routes
    
    参数:
    
    path - your route path
    
    handler - route implement
    
    返回:
    
    return blade instance
    
    另请参阅:
    
    delete(String, RouteHandler)
  - delete
```
public Blade delete(@NonNull
                    String path,
                    @NonNull
                    RouteHandler handler)
```
    Add a delete route to routes
    
    参数:
    
    path - your route path
    
    handler - route implement
    
    返回:
    
    return blade instance
  - before
```
@Deprecated
public Blade before(@NonNull
                                String path,
                                @NonNull
                                RouteHandler0 handler)
```
    已过时。
    
    Add a before route to routes, the before route will be executed before matching route
    
    参数:
    
    path - your route path
    
    handler - route implement
    
    返回:
    
    return blade instance
    
    另请参阅:
    
    before(String, RouteHandler)
  - before
```
public Blade before(@NonNull
                    String path,
                    @NonNull
                    RouteHandler handler)
```
    Add a before route to routes, the before route will be executed before matching route
    
    参数:
    
    path - your route path
    
    handler - route implement
    
    返回:
    
    return blade instance
  - after
```
@Deprecated
public Blade after(@NonNull
                               String path,
                               @NonNull
                               RouteHandler0 handler)
```
    已过时。
    
    Add a after route to routes, the before route will be executed after matching route
    
    参数:
    
    path - your route path
    
    handler - route implement
    
    返回:
    
    return blade instance
    
    另请参阅:
    
    after(String, RouteHandler)
  - after
```
public Blade after(@NonNull
                   String path,
                   @NonNull
                   RouteHandler handler)
```
    Add a after route to routes, the before route will be executed after matching route
    
    参数:
    
    path - your route path
    
    handler - route implement
    
    返回:
    
    return blade instance
  - templateEngine
```
public Blade templateEngine(@NonNull
                            TemplateEngine templateEngine)
```
    Setting blade mvc default templateEngine
    
    参数:
    
    templateEngine - TemplateEngine object
    
    返回:
    
    blade
  - templateEngine
```
public TemplateEngine templateEngine()
```
    Get TemplateEngine, default is DefaultEngine
    
    返回:
    
    return TemplateEngine
  - routeMatcher
```
public RouteMatcher routeMatcher()
```
    Get RouteMatcher
    
    返回:
    
    return RouteMatcher
  - register
```
public Blade register(@NonNull
                      Object bean)
```
    Register bean to ioc container
    
    参数:
    
    bean - bean object
    
    返回:
    
    blade
  - register
```
public Blade register(@NonNull
                      Class<?> cls)
```
    Register bean to ioc container
    
    参数:
    
    cls - bean class, the class must provide a no args constructor
    
    返回:
    
    blade
  - addStatics
```
public Blade addStatics(@NonNull
                        String... folders)
```
    Add multiple static resource file the default provides the static, upload
    
    参数:
    
    folders - static resource directory
    
    返回:
    
    blade
  - showFileList
```
public Blade showFileList(boolean fileList)
```
    Set whether to show the file directory, default doesn't show
    
    参数:
    
    fileList - show the file directory
    
    返回:
    
    blade
  - gzip
```
public Blade gzip(boolean gzipEnable)
```
    Set whether open gzip, default disabled
    
    参数:
    
    gzipEnable - enabled gzip
    
    返回:
    
    blade
  - getBean
```
public <T> T getBean(@NonNull
                     Class<T> cls)
```
    Get ioc bean
    
    参数:
    
    cls - bean class type
    
    返回:
    
    return bean instance
  - exceptionHandler
```
public ExceptionHandler exceptionHandler()
```
    Get ExceptionHandler
    
    返回:
    
    return ExceptionHandler
  - exceptionHandler
```
public Blade exceptionHandler(ExceptionHandler exceptionHandler)
```
    Set ExceptionHandler, when you need a custom exception handling
    
    参数:
    
    exceptionHandler - your ExceptionHandler instance
    
    返回:
    
    return blade instance
  - devMode
```
public boolean devMode()
```
    Get current is developer mode
    
    返回:
    
    return true is developer mode, else not.
  - devMode
```
public Blade devMode(boolean devMode)
```
    Whether encoding setting mode for developers The default mode is developers
    
    参数:
    
    devMode - developer mode
    
    返回:
    
    blade
  - isAutoRefreshDir
```
public boolean isAutoRefreshDir()
```
  - setAutoRefreshDir
```
public void setAutoRefreshDir(String dir)
```
  - bootClass
```
public Class<?> bootClass()
```
  - enableCors
```
public Blade enableCors(boolean enableCors)
```
    Set whether to enable cors
    
    参数:
    
    enableCors - enable cors
    
    返回:
    
    blade
  - getStatics
```
public Set<String> getStatics()
```
    Get blade statics list. e.g: "/favicon.ico", "/robots.txt", "/static/", "/upload/", "/webjars/"
    
    返回:
    
    return statics
  - scanPackages
```
public Blade scanPackages(@NonNull
                          String... packages)
```
    When set to start blade scan packages
    
    参数:
    
    packages - package name
    
    返回:
    
    blade
  - scanPackages
```
public Set<String> scanPackages()
```
    Get scan the package set.
    
    返回:
    
    return packages set
  - bootConf
```
public Blade bootConf(@NonNull
                      String bootConf)
```
    Set to start blade configuration file by default Boot config properties file in classpath directory.
    Without setting will read the classpath -> application.properties
    
    参数:
    
    bootConf - boot config file name
    
    返回:
    
    blade
  - environment
```
@Deprecated
public Blade environment(@NonNull
                                     String key,
                                     @NonNull
                                     Object value)
```
    已过时。
    
    Set the environment variable for global use here
    env(String, String)
    
    参数:
    
    key - environment key
    
    value - environment value
    
    返回:
    
    blade
  - environment
```
public Environment environment()
```
    Return the application's environment configuration information.
    
    返回:
    
    Environment
  - environment
```
@Deprecated
public Blade environment(Environment environment)
```
    已过时。
  - env
```
public Optional<String> env(String key)
```
    Get application environment information.
    
    参数:
    
    key - environment key
    
    返回:
    
    environment optional value
  - env
```
public String env(String key,
                  String defaultValue)
```
    Get application environment information.
    
    参数:
    
    key - environment key
    
    defaultValue - default value, if value is null
    
    返回:
    
    environment optional value
  - listen
```
public Blade listen(int port)
```
    Set to start the web server to monitor port, the default is 9000
    
    参数:
    
    port - web server port, default is 9000
    
    返回:
    
    blade
  - listen
```
public Blade listen(@NonNull
                    String address,
                    int port)
```
    Set to start the web server to listen the IP address and port The default will listen 0.0.0.0:9000
    
    参数:
    
    address - ip address
    
    port - web server port
    
    返回:
    
    blade
  - use
```
public Blade use(@NonNull
                 WebHook... middleware)
```
    The use of multiple middleware, if any
    
    参数:
    
    middleware - middleware object array
    
    返回:
    
    blade
  - middleware
```
public List<WebHook> middleware()
```
    Get middleware list
    
    返回:
    
    return middleware list
  - appName
```
public Blade appName(@NonNull
                     String appName)
```
    Set in the name of the app blade application
    
    参数:
    
    appName - application name
    
    返回:
    
    blade
  - event
```
public Blade event(@NonNull
                   EventType eventType,
                   @NonNull
                   EventListener eventListener)
```
    Add a event watcher When the trigger event is executed eventListener
    
    参数:
    
    eventType - event type
    
    eventListener - event watcher
    
    返回:
    
    blade
  - on
```
public Blade on(@NonNull
                EventType eventType,
                @NonNull
                EventListener eventListener)
```
    Add a event watcher When the trigger event is executed eventListener
    
    参数:
    
    eventType - event type
    
    eventListener - event watcher
    
    返回:
    
    blade
  - sessionType
```
public Class<? extends Session> sessionType()
```
    Get session implements Class Type
    
    返回:
    
    return blade Session Type
  - sessionType
```
public Blade sessionType(Class<? extends Session> sessionImplType)
```
    Set session implements Class Type, e.g: RedisSession
    
    参数:
    
    sessionImplType - Session Type implement
    
    返回:
    
    return blade instance
  - onStarted
```
@Deprecated
public Blade onStarted(@NonNull
                                   BeanProcessor processor)
```
    已过时。
    
    Event on started
    
    参数:
    
    processor - bean processor
    
    返回:
    
    return blade instance
  - addLoader
```
public Blade addLoader(@NonNull
                       BladeLoader loader)
```
    Add blade loader
    
    参数:
    
    loader -
    
    返回:
  - processors
```
@Deprecated
public List<BeanProcessor> processors()
```
    已过时。
    
    Get processors
    
    返回:
    
    return processors
  - loaders
```
public List<BladeLoader> loaders()
```
  - eventManager
```
public EventManager eventManager()
```
    Get EventManager
    
    返回:
    
    return EventManager
  - sessionManager
```
public SessionManager sessionManager()
```
    Get SessionManager
    
    返回:
    
    return SessionManager
  - disableSession
```
public Blade disableSession()
```
    Disable session, default is open
    
    返回:
    
    return blade instance
  - disableCost
```
public Blade disableCost()
```
  - allowCost
```
public boolean allowCost()
```
  - watchEnvChange
```
public Blade watchEnvChange(boolean watchEnvChange)
```
  - start
```
public Blade start()
```
    Start blade application.
    When all the routing in the main function of situations you can use, Otherwise please do not call this method.
    
    返回:
    
    return blade instance
  - start
```
public Blade start(Class<?> mainCls,
                   String... args)
```
    Start blade application
    
    参数:
    
    mainCls - main Class, the main class bag is basic package
    
    args - command arguments
    
    返回:
    
    return blade instance
  - start
```
public Blade start(Class<?> bootClass,
                   @NonNull
                   String address,
                   int port,
                   String... args)
```
    Start the blade web server
    
    参数:
    
    bootClass - Start the boot class, used to scan the class in all of the packages
    
    address - web server bind ip address
    
    port - web server bind port
    
    args - launch parameters
    
    返回:
    
    blade
  - await
```
public Blade await()
```
    Await web server started
    
    返回:
    
    return blade instance
  - stop
```
public void stop()
```
    Stop current blade application
    Will stop synchronization waiting netty service
  - webSocket
```
public Blade webSocket(@NonNull
                       String path,
                       @NonNull
                       WebSocketHandler handler)
```
    Register WebSocket path
    
    参数:
    
    path - websocket path
    
    handler - websocket handler
    
    返回:
    
    return blade instance
  - webSocketPath
```
public String webSocketPath()
```
    Get webSocket path
    
    返回:
    
    return websocket path
  - bannerText
```
public Blade bannerText(String bannerText)
```
    Set blade start banner text
    
    参数:
    
    bannerText - banner text
    
    返回:
    
    return blade instance
  - bannerText
```
public String bannerText()
```
    Get banner text
    
    返回:
    
    return blade start banner text
  - threadName
```
public Blade threadName(String threadName)
```
    Set blade start thread name
    
    参数:
    
    threadName - thread name
    
    返回:
    
    return blade instance
  - contextPath
```
public Blade contextPath(String contextPath)
```
    Set context path, default is "/"
    
    参数:
    
    contextPath - context path
    
    返回:
    
    return blade instance
    
    从以下版本开始:
    
    2.0.8-RELEASE
  - webSocketHandler
```
public WebSocketHandler webSocketHandler()
```
    Get WebSocket Handler
    
    返回:
    
    return websocket handler

类 Blade

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

Blade

方法详细资料

me

of

ioc

get

get

post

post

put

put

delete

delete

before

before

after

after

templateEngine

templateEngine

routeMatcher

register

register

addStatics

showFileList

gzip

getBean

exceptionHandler

exceptionHandler

devMode

devMode

isAutoRefreshDir

setAutoRefreshDir

bootClass

enableCors

getStatics

scanPackages

scanPackages

bootConf

environment

environment

environment

env

env

listen

listen

use

middleware

appName

event

on

sessionType

sessionType

onStarted

addLoader

processors

loaders

eventManager

sessionManager

disableSession

disableCost

allowCost

watchEnvChange

start

start

start

await

stop

webSocket

webSocketPath

bannerText

bannerText

threadName

contextPath

webSocketHandler