Web开发Controller层中的http路由注解

目录

一、创建地址:

1、ApiConstant类中创建

二、构造器注入

1、@Autowired

三、使用路由注解:

1、@Controller和@RestController

2、@RequestMapping

3、@GetMapping

4、@PostMapping


一、创建地址:

1、ApiConstant类中创建

         首先在ApiConstant类中创建路由地址,命名尽量全部大写,例如:

public final class ApiConstant {
    private ApiConstant(){}
    public static final String API_PRODUCES="application/json";
    public static final String ROUTE_AUTH_ROOT="api/v1";
    public static final String ROUTE_AUTH_LOGIN="/login";
    public static final String ROUTE_AUTH_EXISTS="/exists/{user}";
    public static final String ROUTE_AUTH_REGISTER="/register";
    public static final String ROUTE_UPLOAD="/upload";
    public static final String ROUTE_USER_ROOT="api/v1/admin";
    public static final String ROUTE_USER_ALL="/";
    public static final String ROUTE_USER_PAGE="/page";
    public static final String ROUTE_USER_SEARCH="/search/{kw}";
    public static final String ROUTE_USER_APPLY="/apply";
    public static final String ROUTE_USER_APPROVE="/approve";
    public static final String ROUTE_USER_DECLINE="/decline";
    public static final String ROUTE_USER_BAN="/ban";
    public static final String ROUTE_COURSE_ROOT="api/v1/course";
    public static final String ROUTE_COURSE_ALL="/";
    public static final String ROUTE_COURSE_PAGE="/page";
    public static final String ROUTE_COURSE_OPEN="/open";
    public static final String ROUTE_COURSE_OPEN_PAGE="/open/page";
    public static final String ROUTE_COURSE_TEACHER="/teacher";
    public static final String ROUTE_COURSE_STUDENT="/student";
    public static final String ROUTE_COURSE_ADD="/add";
    public static final String ROUTE_COURSE_PUT="/put/{id}";
    public static final String ROUTE_COURSE_OPEN_CLOSE="/oc";
    public static final String ROUTE_COURSE_DELETE="/del";
}

二、构造器注入

1、@Autowired

        它可以对类成员变量、方法及构造函数进行标注,让 spring 完成 bean 自动装配的工作。

使用方法:常用的是使用构造方法注入,例如:

@Autowired
    public CourseApiController(CourseService service, UserService uService){
        this.service=service;
        this.uService = uService;
    }

三、使用路由注解:

1、@Controller和@RestController

        区别:@Controller 包括了 @RestController。@RestController 是 Spring4 后新加的注解,从 RestController 类源码可以看出 @RestController 是 @Controller 和 @ResponseBody 两个注解的结合体

  • @Controller 一般应用在有返回界面的应用场景下.

    例如,管理后台使用了 thymeleaf 作为模板开发,需要从后台直接返回 Model 对象到前台,那么这时候就需要使用 @Controller 来注解。

  • @RestController 如果只是接口,那么就用 RestController 来注解.

    例如前端页面全部使用了 Html、Jquery来开发,通过 Ajax 请求服务端接口,那么接口就使用 @RestController 统一注解。

使用方法:直接在主类上引入使用,例如:

@RestController
public class CourseApiController {
}

2、@RequestMapping

        用于将任意HTTP 请求映射到控制器方法上。注解在类上,表示类中的所有响应请求的方法都是以该地址作为父路径。

使用方法:在注解后输入路由地址,例如:

@RequestMapping(ApiConstant.ROUTE_USER_ROOT)
public class UserApiController {
}

3、@GetMapping

        用于将HTTP GET请求映射到特定处理程序方法的注释,无参,@RequestParam 和@PathVaiable的情况下使用GetMapping,用于定义HTTP GET请求的URL路径。当客户端发送HTTP GET请求时,Spring Boot会自动将请求映射到具有相应URL路径的控制器方法上。

使用方法:在注解后输入路由地址,例如:

@GetMapping(ApiConstant.ROUTE_USER_ALL)
    public ApiResult getUser(@RequestParam String token){
        List<VmUser> users=new ArrayList<>();
        service.get().forEach(user -> users.add(VmUser.create(user,true)));
        return new ApiResult(true,users.size()+"",users);
    }

4、@PostMapping

        用于将HTTP POST请求映射到特定处理程序方法的注释,如果传的参数是@RequestBody ,多参或者传对象的情况下使用@PostMapping注解。

使用方法:在注解后输入路由地址,例如:

@PostMapping(ApiConstant.ROUTE_COURSE_OPEN_CLOSE)
    public ApiResult openClose(@RequestBody CourseOpenInfo info){
        String token=info.getToken();
        String strCourseId=info.getCourse_id();
        boolean open=info.isOpen();
        if (StringUtil.isEmpty(token)||StringUtil.isEmpty(strCourseId)){
            return new ApiResult(false,Messages.MISS_ARGS.toString(), null);
        }
        Course course=service.openCloseCourse(UUID.fromString(strCourseId),open,token);
        if (course==null){
            return new ApiResult(false,Messages.NO_PERMISSION.toString(), null);
        }
        return new ApiResult(true,Messages.SUCCESS.toString(), VmCourse.create(course,true));
    }
  • 8
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
#AisMVC,一款仿SpringMVC框架的轻便快捷的Java MVC开发框架 ####前言 * 写这个框架的意义在于过去使用springmvc框架作为项目中的Controller层,springmvc的简洁配置和使用让我们选择了它,但这个框架我用着也发现了它也有很多冗余功能的地方。我们团队开发web项目一般采用前后端分离,所以后端的的Controller层的功能仅仅只有提供ajax接口,页面集成后的跳转,过滤器和拦截器,所以我就想着自己写一款仿springmvc的mvc框架作为自己和团队以后的开发中小型项目的框架,舍掉冗余的部分,只要项目中实际需要的功能 ####这个框架暂时还没有经过严密的测试,所以想使用的同学我在这里说声抱歉,虽然我自己通过maven打成jar包测试过,但暂时没有用于实际开发的打算,第一是自己一个人的实力有限还是怕真实运用中出现自己不能解决的问题,其实我目前内心的真实想法是告诉大家一个mvc框架到底是怎么实现的,springmvc框架想一下吃透也不现实,如果通过我的这个框架大家也有写框架的动力和思路我也是我想看到的,也想告诉大家只要动起手来自己也能写框架,有些东西不是说说而已。很多人或许会说现在mvc框架这么多,你的这个算什么啊?但我想说现在很多时候我们百度搜索的资料来自前人,很多都是5,6年前的老资料了,我也不想以后我们的后辈通过搜索引擎搜出来的还是我们这个时候搜出来的前人总结,开发的资料。我想我也应该留点东西了。 ####框架流程图 ![me](http://o9beglkd1.bkt.clouddn.com/B21B9E90-F3A9-4C2D-8BEA-A0375CE87CD8.jpg) ####功能代码演示 ```Java /** * Created by gaorui on 16/6/14. */ @Controller public class test { /** * @author gaorui * @param s1 * @param s2 * @param request * @param response * @param session * 普通url处理 */ @MapURL(value = "get",RequestMethod = RequestMethod.GET) public void get(String s1,String s2,HttpServletRequest request, HttpServletResponse response, HttpSession session){ return; } /** * @author gaorui * @return String * 服务端跳转页面处理,默认 web-inf下所有 .html文件 */ @MapURL(value="foward") public String foward(){ return "page/succ"; } /** * @author gaorui * @param userid * @return Object * 服务端处理前端ajax请求,返回json数据 */ @MapURL(value = "getUser", RequestMethod = RequestMethod.GET) @ResponseBody public JSONObject getUser(int userid){ JSONObject jsonObject = new JSONObject(); jsonObject.put("userid",userid); return jsonObject; } } ``` ####mvc框架功能介绍 * 注解实现 * @MapURL注解实现http请求路由 * 反射实现方法参数注入 * String返回类型方法转发请求 * @ResponseBody注解实现ajax接口 * 增加config.ini配置文件,实现定向动态扫描项目中的@Controller 类 * 增加注解参数RequestMethod 默认http请求类型,请求类型不合法返回405状态码 ####commit log * 1.0 初始化项目 * 1.1 dhy join * 1.2 mvc框架功能雏形 * 1.3 增加handlerMapping处理器映射,控制器卸耦 * 1.4 增加config.ini配置文件,实现定向动态扫描项目中的@Controller 类 * 1.5 增加注解参数RequestMethod 默认http请求类型,请求类型不合法返回405状态码 * 1.6 下一步准备做项目的容错处理,过滤器准备用原生的不准备加入框架 * 1.7 修改部分目录结构,画框架整体流程图,后面继续做容错处理和性能优化
自己做的乐优商城的XMIND文件,学习分享下。乐优商城 搭建父工程 pom.xml 添加依赖 springCloud mybatis启动器 通用Mapper启动器 mysql驱动 分页助手启动器 FastDFS客户端 其他配置 构建设置 环境设置 EurekaServer注册中心 添加的依赖 启动类 application.yml 创建Zuul网关 依赖 启动类 application.yml 创建商品微服务 ly-item-interface:主要是对外暴露的API接口及相关实体类 ly-item-service:所有业务逻辑及内部使用接口 创建父工程ly-item ly-item-interface ly-item-service 依赖 启动器 application.yml 添加商品微服务的路由规则 通用工具模块Common utils CookieUtils IdWorker JsonUtils NumberUtils 依赖 通用异常处理 测试结构 pojo service @Service web @RestController @RequestMapping @Autowired @PostMapping 引入Common依赖 Common advice 拦截异常、 CommonExceptionHandler ResponseEntity @ControllerAdvice @ExceptionHandler enums 异常的枚举 、ExceptionEnum exception 自定义异常、LyException 接口RuntimeException @Getter @NoArgsConstructor @AllArgsConstructor vo 异常结果处理对象、ExceptionResult @Data 构造方法ExceptionResult ly-item-service CategoryQuery 分类查询 实体类 @Table(name="tb_category") 声明此对象映射到数据库的数据表,通过它可以为实体指定表(talbe) @Data 注解在类上, 为类提供读写属性, 此外还提供了 equals()、hashCode()、toString() 方法 @Id & @GeneratedValue(strategy= GenerationType.IDENTITY) 自动增长,适用于支持自增字段的数据库 mapper Mapper IdListMapper 根据id操作数据库 @RequestMapping("category") Controller @RestController @Controller 处理HTTP请求 @ResponseBody 返回 json 数据 @GetMapping("list") ResponseEntity @ResponseBody可以直接返回Json结果 不仅可以返回json结果,还可以定义返回的HttpHeaders和HttpStatus service @Service 自动注册到Spring容器,不需要再在applicationContext.xml文件定义bean了 @Autowired 它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。 select select * from category c where c.pid = #{pid} CollectionUtils.isnotblank 判断集合是否为空 测试 可以利用url直接查询数据库,能否访问得到数据 报错 启动类 没有扫描到 @MapperScan("com.leyou.item.mapper") ,目录结构关系 访问网页报错 CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource. 跨域问题 浏览器对于ajax请求的一种安全限制:一个页面发起的ajax请求,只能是于当前页同域名的路径,这能有效的阻止跨站攻击。因此:跨域问题 是针对ajax的一种限制。 解决跨域问题的方案 CORS 规范化的跨域请求解决方案,安全可靠 什么是cors 它允许浏览器向跨源服务器,发出XMLHttpRequest请求,从而克服了AJAX只能同源使用的限制。 原理 简单请求 当浏览器发现发现的ajax请求是简单请求时,会在请求头中携带一个字段:Origin 如果服务器允许跨域,需要在返回的响应头中携带下面信息 Access-Control-Allow-Origin:可接受的域,是一个具体域名或者*,代表任意 Access-Control-Allow-Credentials:是否允许携带cookie,默认情况下,cors不会携带cookie,除非这个值是true 实现非常简单 gateway网关中编写一个配置类 GlobalCorsConfig 添加CORS配置信息 允许的域,不要写*,否则cookie就无法使用了 是否发送Cookie信息 允许的请求方式 允许的头信息 有效时长 添加映射路径,我们拦截一切请求 返回新的CorsFilter 提交方式 GET 用来获取资源,POST 用来新建资源,PUT 用来更新资源,DELETE 用来删除资源 BUG 分类不能打开,当添加后却能打开。 修改一天的BUG 最后发现是实体类里属性大小写的问题引起。 注意 Bule_bird 就必须写成 BlueBird Brand 查询 实体类 PageResult 响应结果 分页结果一般至少需要两个数据 总条数 total 当前页数据 items 有些还需要总页数 总页数 totalPage Controller @RequestParam(value = "page",defaultValue = "1") Integer page GET和POST请求传的参数会自动转换赋值到@RequestParam 所注解的变量上 defaultValue 默认值 required 默认值为true , 当为false时 这个注解可以不传这个参数 null || .size()==0 ResponseEntity(HttpStatus.NOT_FOUND) 返回404没找到 ResponseEntity.ok 返回ok状态 service 开始分页 通用分页拦截器 PageHelper.startPage(page,row); 过滤 Example查询 Example example = new Example(Brand.class); mybatis的逆向工程中会生成实例及实例对应的example,example用于添加条件,相当where后面的部分 xxxExample example = new xxxExample(); Criteria criteria = new Example().createCriteria(); StringUtils.isNotBlank isNotBlank(str) 等价于 str != null && str.length > 0 && str.trim().length > 0 str.trim() 去掉字符串头尾的空格 测试 报错500 com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: Unknown column 'idASC' in 'order clause' 错误:(desc ? "DESC" : "ASC"); 正确:(desc ? " DESC" : " ASC"); 字符串空格问题 新增 Controller (Brand brand,@RequestParam("cids") List cids) ResponseEntity 无返回值 new ResponseEntity(HttpStatus.CREATED); 201成功 service @Transactional 自动纳入 Spring 的事务管理 使用默认配置,抛出异常之后,事务会自动回滚,数据不会插入到数据库。 setId(null) insert(brand) 新增中间表 mapper @Insert (#{cid},#{bid}) @Param 表示给参数命名,名称就是括号中的内容 name 命名为aa,然后sql语句....where s_name= #{aa} 中就可以根据aa得到参数值 修改 回显 Controller @PathVariable("bid") 通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中:URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的入参中。 select * from tb_category where id in (select category_id from tb_category_brand where brand_id = #{bid}) 测试 报错500 空指针异常 调用Service时候 忘记@Autowired 保存 VO视图对象 @NoArgsConstructor 生成一个无参数的构造方法 @AllArgsConstructor 会生成一个包含所有变量 Controller @PutMapping 添加信息,倾向于用@PostMapping,如果是更新信息,倾向于用@PutMapping。两者差别不是很明显 return ResponseEntity.ok().build(); 无返回值 service 根据id修改 先删除后新增 删除(前端有问题,待完善) spec Group 品牌分类id查询 实体类 @Transient 指定该属性或字段不是永久的。 它用于注释实体类,映射超类或可嵌入类的属性或字段。 @Column(name = "'numeric'") 用来标识实体类中属性与数据表中字段的对应关系 name 定义了被标注字段在数据库表中所对应字段的名称; mapper service Controller 测试 报错500 实体类@table路径写错 新增 Controller @RequestBody 常用其来处理application/json类型 子主题 2 将请求体中的JSON字符串绑定到相应的bean上 修改 Controller @PutMapping service updateByPrimaryKey 删除 Controller @DeleteMapping @PathVariable Param 规格组id查询规格 url:params?gid=14 @GetMapping("params") Controller @RequestParam 新增 @PostMapping("param") @RequestBody ResponseEntity.status(HttpStatus.CREATED).build(); 修改 @RequestBody 删除 @PathVariable 分支主题 3 遇到的问题 pom.xml 文件未下载完整,删掉后重新下载 能存在重复文件,IDEA不能确定文件路径,需要搜索删掉多余的 Param 删除 小问题:数据库删除后页面没有立即显示 Brand 删除(前端有问题,待完善)

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值