• Dorado
  • Features
  • Maven
  • Quick start
  • 注解ちゅうかい说明
    • 类注解ちゅうかい
    • 方法ほうほう注解ちゅうかい
    • 方法ほうほう参さん数すう注解ちゅうかい
  • 内うち置おけ服ふく务
  • SpringBoot集成しゅうせい
  • swagger集成しゅうせい
  • 性能せいのう测试

简单、快速かいそく、轻量级的http restful server实现，基き于Netty4和わJDK1.8+

• HTTP/1.1 and HTTP/1.0协议支持しじ
• 内うち置おけJSON/Protobuf序列じょれつ化か支持しじ，JSON序列じょれつ化か框かまち架か使用しようFastjson, 依よ赖内置おけ；
  如果使用しようprotobuf序列じょれつ化か，需要じゅよう自じ行くだり添加てんかprotobuf依よ赖, protobuf版本はんぽん2.x
• 基もと于Trie数すう据すえ结构实现的てきHttp路ろ由よし支持しじ 路ろ由よしpath支持しじ任意にんい的てきjava正せい则表达式，通つう过{pathVariable:regex}这种方式ほうしき支持しじ路ろ径みち变量
• 支持しじ文ぶん件けん上じょう传
• Spring框かまち架か支持しじ，默だま认支持しじ注解ちゅうかい方式ほうしき初はつ始はじめ化かspring容器ようき
• SpringBoot集成しゅうせい
• 集成しゅうせいswagger restful API文ぶん档生成せいせい工具こうぐ
• 过滤器き支持しじ，实现类似于spring mvc的てきinterceptor功こう能のう
• 支持しじ全局ぜんきょく异常处理
• 支持しじ统一响应格式处理

0.0.56

<dependency>
    <groupId>io.github.javagossip</groupId>
    <artifactId>dorado-core</artifactId>
    <version>0.0.56</version>
</dependency>

• 最さい简单的てきDorado rest server

public class Application {

    public static void main(String[] args) throws Exception {
        // create simple rest server, scanPackages现在可か选，如果不ふ设置
        //系けい统默认会自じ动找到main主ぬし类所在しょざい的てき包つつみ作さく为basePackage进行扫描
        DoradoServerBuilder.forPort(18888).build().start();
    }
}

• 更さら多た定じょう制せい化か参さん数すう服ふく务器

public class Application {

    public static void main(String[] args) throws Exception {
        DoradoServerBuilder.forPort(18888).acceptors(2).ioWorkers(4)
                .minWorkers(10).maxWorkers(100)
                .backlog(1024)
                .maxConnection(500).maxPendingRequest(10000)
                .maxIdleTime(120).sendBuffer(256 * 1024)
                .recvBuffer(256 * 1024)
                .scanPackages("com.rtbstack.demo.controller",
                        "com.rtbstack.demo.controller1")
               .build().start();
    }
}

• spring框かまち架か支持しじ

  DoradoServerBuilder.forPort(port).springOn()

  由よし于框架か本身ほんみ不ふ直接ちょくせつ依よ赖spring框かまち架か，如果启用spring之の后きさき，务必自じ行くだり添加てんかspring框かまち架か相しょう关依赖到项目中ちゅう，否いや则系统启动会出で现ClassNotFoundException

public class Application {

    public static void main(String[] args) throws Exception {
        DoradoServerBuilder.forPort(18888).springOn()
                .scanPackages("com.rtbstack.demo",
                        "com.rtbstack.demo.controller1")
               .build().start();
    }
}

• Rest Controller

@Controller
@Path("/campaign")
public class CampaignController {

    @Path("/{id:[0-9]+}")
    @GET
    public Campaign newCampaign(int id) {
        Campaign campaign = new Campaign();
        campaign.setId(id);
        campaign.setName("test campaign");

        return campaign;
    }

    @Path("/name")
    public String campaignName() {
        return String.format("hello_campaign", "");
    }

    @POST
    public Campaign save(Campaign campaign) {
        System.out.println(campaign);
        return campaign;
    }

    @Path("/{id}")
    @DELETE
    public void deleteCampaign(int id) {
        System.out.println("delete campaign, id: " + id);
    }

    @GET
    @Path("/{id}")
    public Campaign getCampaign(int id) {
        return Campaign.builder().withId(12)
                .withName("网易考こう拉ひしげ推广计划")
                .build();
    }
}

• Filter

@FilterPath(include = "/campaign/*")
public class DemoFilter implements Filter {

    @Override
    public boolean preFilter(HttpRequest request, HttpResponse response) {
        System.out.println("execute demo filter");
        response.sendError(403, "Forbidden");
        return false;
    }
}

• 文ぶん件けん上じょう传支持しじ
  支持しじ文ぶん件けん上じょう传很简单，只ただ需要じゅよう将はたcontroller方法ほうほう的てき参まいり数すう设置未みMultipartFile或ある者ものMultipartFile[]即そく可か，单文件けん用ようMultipartFile,
  多た文ぶん件けん用ようMultipartFile[]

@Path("/file/upload")
@POST
public String uploadFile(MultipartFile[] fs,String name) {
    for(MultipartFile f:fs) {
        System.out.println(f.getName());
        System.out.println(f.getContentType());
        System.out.println(f.getSize());
    }
    return String.format("name: %s, file info: %s", name,f.toString());
}

• 全局ぜんきょく异常处理
  dorado支持しじ用よう户通过自定てい义的类来进行全局ぜんきょく异常处理，处理异常的てき方法ほうほう名めい必须是ぜhandleException，类上面めん增加ぞうかExceptionAdvice注解ちゅうかい

  @ExceptionAdvice
  public class TestExceptionAdvice {
  
  	@ExceptionType(MyException.class)
  	@Status(400) //Status注解ちゅうかい来らい指定していhttp响应状じょう态码
  	public String handleException(MyException ex) {
  		return "cause: " + ex.getClass().getName() + "," + ex.getMessage();
  	}
  
  	@ExceptionType(Exception.class)
  	public String handleException(Exception ex) {
  		return "use default exception handler,cause: " + ex.getClass().getName() + "," + ex.getMessage();
  	}
  }

• 全局ぜんきょく统一响应格式处理
  在ざい实际项目开发中ちゅう，基もと于rest的てき服ふく务一般都会定义统一的响应格式，如下面めん所しょ示しめせ格式かくしき：

  {
  	"code": 0,
  	"data": data,
  	"msg": "OK"
  }

  为了避免在ざい每まい个方法的ほうてき时候都と要よう执行相しょう同どう的てき处理操作そうさ，dorado支持しじ定てい义一个io.github.javagossip.dorado.rest.http.MethodReturnValueHandler来らい
  实现这个功こう能のう

  public class TestMethodReturnValueHandler implements MethodReturnValueHandler {
  
  	@Override
  	public Object handleMethodReturnValue(Object value, MethodDescriptor methodDescriptor) {
  		return TestResp.builder().withCode(0).withMsg("OK").withData(value).build();
  	}
  	
  	//自じ定てい义这个方法ほう实现，用よう来らい控ひかえ制せい哪些返かえし回かい值需要よう被ひ这个类进行ぎょう处理
  	public boolean supportsReturnType(MethodDescriptor returnType) {
  	    return true;
  	}
  }

• More examples

Please visit https://github.com/javagossip/dorado-examples

• Get Server configuration: http://{ip}:{port}/config
• Get Server status: http://{ip}:{port}/status
• List All services: http://{ip}:{port}/services

• 添加てんかdorado-spring-boot-starter核心かくしん依よ赖

  <dependency>
      <groupId>io.github.javagossip</groupId>
      <artifactId>dorado-spring-boot-starter</artifactId>
      <version>${dorado.version}</version>
  </dependency>

• 基もと于springboot的てきdorado应用

  @SpringBootApplication
  @EnableDorado       //用よう这个注解ちゅうかい开启dorado server
  public class SpringBootApplication {
  
      public static void main(String[] args) throws Exception {
          SpringApplication.run(SpringBootApplication.class, args);
      }
  }

  或ある者もの直接ちょくせつ使用しようDoradoSpringBootApplication来らい替がえ换SpringBootApplication和わEnableDorado,如下：

    @DoradoSpringBootApplication
    public class SpringBootApplication {
  
          public static void main(String[] args) throws Exception {
              SpringApplication.run(SpringBootApplication.class, args);
          }
     }

• Dorado框かまち架か的てきspring-boot配置はいち参さん数すう

  参まいり数すう名めい	描述	默だま认值
  dorado.port	dorado server监听端はし口こう	18888
  dorado.backlog	backlog队列大小だいしょう	10000
  dorado.acceptors	dorado acceptor count	cpu核心かくしん数すう*2
  dorado.io-workers	dorado io worker count	cpu核心かくしん数すう*2
  dorado.min-workers	业务线程池ち最小さいしょう线程数すう	100
  dorado.max-workers	业务线程池ち最大さいだい线程数すう	100
  dorado.max-connections	服ふく务器最大さいだい连接数すう	100000
  dorado.max-pending-request	业务线程池ち队列长度	10000
  dorado.send-buffer	send buffer size	256k
  dorado.recv-buffer	recv buffer size	256k
  dorado.max-idle-time	连接最大さいだい空そら闲时间	8h
  dorado.max-packet-length	http请求包つつみ体たい大小だいしょう	1M

如果对swagger还不了解りょうかい的てき话，参考さんこう：https://swagger.io/

• 添加てんかdorado-swagger-ui依よ赖

   <dependency>
       <groupId>io.github.javagossip</groupId>
       <artifactId>dorado-swagger-ui</artifactId>
       <version>${dorado.version}</version>
   </dependency>

• 项目启动类中使用しようEnableSwagger注解ちゅうかい启用swagger

@EnableSwagger
public class Application {
    public static void main(String[] args) throws Exception {
        // create simple rest server
        DoradoServerBuilder.forPort(18888).maxPacketLength(1024*1024*10)
           .build().start();
    }
}

• 设置Api文ぶん档全局きょく信しん息いき
  实现io.github.javagossip.dorado.swagger.ext.ApiContextBuilder接せっ口こう

@Component //如果是ぜ集成しゅうせいspring或あるspringboot环境的てき话，直接ちょくせつ增加ぞうかcomponent注解ちゅうかい即そく可か
@Override
// 这里定じょう制せいApi全局ぜんきょく信しん息いき，如文档描述じゅつ、license,contact等とう信しん息いき
public ApiContext buildApiContext() {
	Info info = new Info()
			.contact(new Contact().email("javagossip@gmail.com").name("weiping wang")
					.url("http://github.com/javagossip/dorado"))
			.license(new License().name("apache v2.0").url("http://www.apache.org"))
			.termsOfService("http://swagger.io/terms/").description("Dorado服ふく务框架かapi接せっ口こう文ぶん档")
			.title("dorado demo api接せっ口こう文ぶん档").version("1.0.0");

	//构造api访问授权的てきapiKey
	ApiKey apiKey = ApiKey.builder().withName("Authorization").withIn("header").build();
	ApiContext apiContext = ApiContext.builder().withApiKey(apiKey)
			.withInfo(info).build();

	return apiContext;
}

非ひspring环境需要じゅよう在ざいresources/META-INF/services下か的てきio.github.javagossip.dorado.swagger.ext.ApiContextBuilder文ぶん件けん中ちゅう增加ぞうか如下配置はいち：
io.github.javagossip.dorado.demo.ApiContextBuilderImpl

• 在ざいcontroller实现里さと面めん增加ぞうかswagger相しょう关的注解ちゅうかい即そく可か自じ动生成せいせい在ざい线的api doc

@Controller
@Path("/campaign")
@Api(tags = { "营销活かつ动管理かんり" })
public class CampaignController {
    @Autowired
    private CampaignService campaignService;

    @Path("/{id:[0-9]+}")
    @GET
    @ApiOperation("新建しんたけcampaign")
    public Campaign newCampaign(@PathVariable("id") int id) {
        Campaign campaign = new Campaign();
        campaign.setId(id);
        campaign.setName("test campaign");

        return campaign;
    }
}

• spring-boot环境，可か以直接ちょくせつ引入dorado-swagger-spring-boot-starter依よ赖来进一いち步ほ简化swagger的てき使用しよう

   <dependency>
   	<groupId>io.github.javagossip</groupId>
   	<artifactId>dorado-swagger-spring-boot-starter</artifactId>
   	<version>${dorado.version}</version>
   </dependency> 

  然しか后きさき在ざいapplication.properties配置はいち文ぶん件けん中ちゅう增加ぞうか如下配置はいち即そく可か：

   dorado.swagger.title=Zhuque's dashboard api
   dorado.swagger.description=${dorado.swagger.title}
   dorado.swagger.license=Apache License
   dorado.swagger.licenseUrl=http://www.apache.org/licenses/LICENSE-2.0
   dorado.swagger.contact.name=weiping wang
   dorado.swagger.contact.email=javagossip@gmail.com
   dorado.swagger.contact.url=https://github.com/javagossip
   
   //API全局ぜんきょく认证配置はいち
   dorado.swagger.apiKey.name=Authorization
   dorado.swagger.apiKey.in=header or query

• 浏览器き访问如下地ち址し即そく可か
  http://{host}:{port}/swagger-ui.html