# web-router

**Repository Path**: backpackerxl/web-router

## Basic Information

- **Project Name**: web-router
- **Description**: java web router
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2022-04-17
- **Last Updated**: 2022-05-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### Web-Router让Web 接口变得简单起来

#### 快速上手

- 下载 [`web-router-0.0.1.jar`](out/artifacts/web/web-router-0.0.1.jar)
  导入到Web项目中

- 配置文件 config.properties 配置Controller在项目中的位置，非常重要

```properties
controller=cn.backpackerxl.web
```

- 第三方依赖 由于项目较小 只有servlet-api-3.1.0.jar包

- 编写Controller

```java

@WebController //标识此组件为Controller组件
@RequestMapping("/comment") //定义一级级路由
public class CommentController {

    private final CommentService commentService = new CommentServiceImpl();


    @GetMapping("/all") // 定义通过Get请求实现请求数据  浏览器访问地址 http://localhost:端口号/项目上下文名称/comment/all
    public String allData() {
        List<Comment> comments = commentService.allComment();
        return ListDataToJSON(comments); // 将List的数据转化为json数据并返回
    }

    @GetMapping("/hi") // 浏览器访问地址 http://localhost:端口号/项目上下文名称/comment/hi?username=xxx&content=xxx
    /**
     * 注意：@Ref 注解为获得提交数据，若想此注解生效，需要做如下配置
     * 1. 若为maven项目，在pom.xml中加入
     * <build>
     <finalName>xxx-xxx</finalName>
     <plugins>
     <plugin>
     <groupId>org.apache.maven.plugins</groupId>
     <artifactId>maven-compiler-plugin</artifactId>
     <version>3.8.0</version>
     <configuration>
     <source>1.8</source>
     <target>1.8</target>
     <encoding>utf8</encoding>
     <compilerArgs>
     <arg>-parameters</arg>
     </compilerArgs>
     </configuration>
     </plugin>
     </plugins>
     </build>
     * 2.若为普通JAVAWeb项目,eclipse 自行百度, idea配置过程
     * File -> Settings -> Build, Exception, Deployment -> Compiler -> java Compiler 
     * 在右侧操作面板中找到 Additional command line parameters 中加入 -parameters
     * 3. 线上部署。如果开发时配置好了，打包后运行应该没有太大的问题，
     * 因为前面两部操作已经将Java方法的形参变量名一块打包进了class文件了
     */
    public String sayHi(@Ref String content, @Ref String username, HttpServletResponse resp) {
        resp.setStatus(200);
        return "hello " + content + " " + username;
    }
}

```

```java

@WebController
public class UserController {

    @PostMapping("/login") //Post 请求 。浏览器访问地址 http://localhost:端口号/项目上下文名称/login
    public String login() {
        return "login success"; //页面中可以看到此消息
    }

    @PostMapping("/register") // 浏览器访问地址 http://localhost:端口号/项目上下文名称/register
    public String register() {
        return "register success";
    }
}

/**
 * 注意本插件十分小巧，所以不提供页面控制,有兴趣的盆友可以下载源码，自己DIY,本插件只是做了对Servlet的简单封装
 * 若有特殊需求，可以一起参与开发。
 */
```

#### 希望大家喜欢，并参与进来