Springboot常用注解

已于 2023-03-30 12:22:50 修改
阅读量442 收藏
点赞数 1
分类专栏： Java SpringBoot 文章标签： spring boot java spring
于 2023-03-29 22:23:42 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/flow_camphor/article/details/129846978
版权

Controller

@Controller

处理器可以直接返回页面，需要和其他得注解一起使用

@RequestMapping

不带数据返回页面

@Controller
public class ViewController {
	
    @RequestMapping("home") // url: http://localhost:8080/home
    public String view() {
        // 在resources里面创建一个home.html页面
        return "home.html";
    }
}

如果想要省掉.html的后缀，可以在recources文件夹下application.properties中添加配置：

spring.mvc.view.prefix=/
spring.mvc.view.suffix=.html

带数据返回页面

package com.springbootlearn.annotation.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller
public class ViewController {
    public static final String PAGE = "home";
    /**
    * 不带数据直接返回页面
    * */
    @RequestMapping("/home") // url: http://localhost:8080/home
    public String view() {
        // 在resources里面创建一个home.html页面
        return PAGE;
    }

    /**
     * 带数据直接返回页面，以ModelAndView的形式
     * */
    @RequestMapping("/data")
    public ModelAndView data() {
        ModelAndView view = new ModelAndView(PAGE);
        view.addObject("str1", "hello");
        view.addObject("str2", "world");
        return view;
    }
}

这里需要安装一些依赖，并更改配置。

<!-- html 模板引擎-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

application.properties下：

#freemarker
spring.freemarker.suffix=.html
spring.freemarker.template-loader-path=classpath:/static/

@RequestParam

@Controller
public class ParamsController {
    public static final String PAGE = "param";

    /**
     * 获取路由传递过来的params
     */
    // http://localhost:8080/param?id=1902
    @RequestMapping("/param")
    public ModelAndView param(@RequestParam(value="id", required = false, defaultValue = "0") int id,
                              @RequestParam(value="type", required = false) String type){
        // 若无参传递，默认为null || 添加defaultValue = ""
        if(type!=null && type == "morning"){
            // ...
        }
        ModelAndView view = new ModelAndView(PAGE);
        view.addObject("id",id);
        return view;
    }
}

@PathVariable

替换@RequestParam的写法

@RequestMapping("/path/{id}/{type}")
public ModelAndView path(@PathVariable int id,
                         @PathVariable(required = false) String type){
    ModelAndView view = new ModelAndView(PAGE);
    view.addObject("id",id);
    return view;
}

@RestController

@GetMapping

@RestController
@RequestMapping("rest")
public class RestfulController {

    // http://localhost:8080/rest/get
    @GetMapping("get")
    public User get(){
        User user = new User(1,"ryuko");
        return user;
    }
}

请求这个接口将会收到以下格式的数据：

{"id": 1, "name": "ryuko"}

@RestController
@RequestMapping("rest")
public class RestfulController {

    // http://localhost:8080/rest
    @GetMapping
    public String get(){
        return "get success";
    }
	
    // http://localhost:8080/rest?id=1902
    @GetMapping("{id}")
    public String getById(@PathVariable("id") int id){
        return "getById success";
    }
}

@PostMapping

@RequestBody

如果希望前端以对象的方式将数据传递给后端，后端以对象的方式接收

需要添加@RequestBody修饰

@PostMapping
public User addUser(@RequestBody User user){
    return user;
}

@ResponseBody

@Controller + @ResponseBody 等同于 @RestController

@Controller返回的是页面

@RestController返回的是输出结果，可以和@RequestMapping、@GetMapping一起使用

@CrossOrigin

解决跨域

不过有更好的解决办法：过滤器

Service

@Service

@Autowired

一般写代码的时候，肯定不能将内容杂糅在Controller里面，具体的逻辑应该交到专门的逻辑处理部分进行，所以先将逻辑处理抽离出来：

package com.springbootlearn.annotation.impl;

import com.springbootlearn.annotation.service.UserService;
import org.springframework.web.bind.annotation.PathVariable;

public class UserServiceImpl implements UserService {
    @Override
    public User get() {
        User user = new User(1, "ryuko");
        return user;
    }
    @Override
    public User getById(@PathVariable("id") int id) {
        User user = new User(1, "ryuko");
        return user;
    }
}

此时，在Controller层中可以将逻辑处理部分摘除，并引入UserServiceImpl实体类：

package com.springbootlearn.annotation.controller;

import com.springbootlearn.annotation.impl.UserServiceImpl;
import com.springbootlearn.annotation.service.UserService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("action")
public class ActionController {

    private UserService userService;

    @GetMapping
    public User get(){
        userService = new UserServiceImpl();
        return userService.get();
    }

    @GetMapping("{id}")
    public User getById(@PathVariable("id") int id){
        userService = new UserServiceImpl();
        return userService.getById(id);
    }

}

注意看这里，进行了两次new UserServiceImpl();的操作，为了解决这个问题，回到UserServiceImpl类。

注意：需要在实现类中设置@Service：

@Service
public class UserServiceImpl implements UserService {   
	// ...
}

然后在ActionController类中进行自动装配，获取到bean：

package com.springbootlearn.annotation.controller;

import com.springbootlearn.annotation.impl.UserServiceImpl;
import com.springbootlearn.annotation.service.UserService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("action")
public class ActionController {
	@Autowired
    private UserService userService;

    @GetMapping
    public User get(){
        return userService.get();
    }

    @GetMapping("{id}")
    public User getById(@PathVariable("id") int id){
        return userService.getById(id);
    }

}

@Component

和Service类似，不过它的用处更广，Service是用来处理逻辑的，Component既可以用来处理逻辑，也可以在Controller中被调用。

@Resource

如果接口实现只有一个，那么用@Autowired就可以了，也不需要指定名字。

如果接口有多个实现，那么，用@Resource，并指定name(建议)
或者使用@Autowired+@Qualifier+Qualifier的value值

现在有两个类，都继承自UserService接口：

@Service
public class UserServiceImpl implements UserService {   
	// ...
}

@Service
public class AdminServiceImpl implements UserService {   
	// ...
}

那么，在UserActionController类中，采用Autowired自动装配的方式将会报错，在编译的时候，无法判断这里的对象在后期，具体要用哪个子类的方法：

@Autowired
private UserService userService;

所以需要采用@Resource方法表明：

// 这里的 a 需要小写
@Recource(name = "adminServiceImpl")
private UserService adminService;

如果后期需要在UserActionController类中采用UserService的两个子类，可以这样定义：

@Recource(name = "adminServiceImpl")
private UserService adminService;

@Recource(name = "userServiceImpl")
private UserService userService;

@Qualifier

@Recource == @Qualifier + @Autowired

@Recource(name = "adminServiceImpl")
private UserService adminService;

// 等价

@Autowired
@Qualifier ("adminServiceImpl")
private UserService adminService;

@Configuration

@Configuration
public class MyBeans {
    @Bean
    public UserService adminServiceImpl() {
        return new AdminServiceImpl();
    }
    
    // 也可以更换bean的名字
    @Bean
    public UserService admin() {
        return new AdminServiceImpl();
    }
    
    // 也可以手动声明bean的名字
    @Bean(name = 'adminServiceImpl')
    public UserService admin() {
        return new AdminServiceImpl();
    }
   
    @Bean
    public UserService userServiceImpl()  {
        return new UserServiceImpl();
    )
)

在自定义bean以后，自动装配依据这里的代码来进行：

@Autowired
@Qualifier ("admin")
private UserService adminService;

Value

@Value

在properties配置文件中添加如下配置：

local.username=ryuko
local.password=123456

然后在逻辑代码中使用配置中的变量：

@Value("${local.username}")
private String username;

@Value("${local.password}")
private String password;

// 在具体方法中使用这些值
@GetMapping("val")
public String getValue(){
    System.out.println("passwprd = " + password);
}
黑猫几绛
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
postmapping注解_Spring注解介绍
weixin_39538693的博客
12-06 2669
本文主要介绍Spring中一些常见注解的部分属性配置介绍以及一些不常用注解的简单介绍。下面让我们直接进入主题吧。@RequestMapping @RequestMapping可以说是SpringMVC以及OpenFeign中最常用的注解，其主要用于映射Web请求。produces属性配置 当前主流服务大部分都是使用JSON作为数据交换格式，即通过配置MappingJa...
springboot常用注解
12-28
"SpringBoot常用注解" SpringBoot框架中，注解（Annotation）是一种Metadata形式的描述，它可以在编译器或 runtime 时提供信息，用于配置 SpringBoot 应用程序。在本文中，我们将详细介绍 SpringBoot 中的常用注解...
【动态拦截@PostMapping注解,并且修改或新增value属性】
pysnl的博客
08-07 455
动态拦截注解并修改属性
Spring Boot@PostMapping
matthewchen123的博客
02-04 8491
@PostMapping 映射一个POST请求 Spring MVC新特性 提供了对Restful风格的支持 @PostMapping(value = "/user/login") //等价于 @RequestMapping(value = "/user/login",method = RequestMethod.POST) 扩展 @GetMapping，处理get请求 @PostMapping，处理post请求 @PutMapping，处理put请求 @DeleteMapping，处理delete请求
@PostMapping和@GetMapping使用详解
热门推荐
weixin_44860226的博客
03-18 1万+
后端的参数接收就需要使用 也是使用@RequestParam(“id”) String id。后端的参数接收就需要使用 @RequestParam(“id”) String id。后端参数接收的话，需要使用@PathVariable String id。如 xxx/generatedData/id ,id中放置的是具体的值。如{id:‘1’,name:‘2222’}如{id:‘1’,name:‘2222’}后端参数接收的话，里面放置的是一个实体类。
SpringBoot常用注解
evilmoon8256的博客
10-12 198
注解 @SpringBootApplication 此注解是Spring Boot项目的基石，创建SpringBoot项目的Application时会默认加上 @SpringBootApplication public class SpringSecurityApplication{ public static void main(Strings[] args){ SpringApplication.run(SpringSecurityApplication,args); } } 我们可以把@Sp
springboot常用注解说明
04-27
springboot常用注解说明springboot常用注解说明springboot常用注解说明springboot常用注解说明springboot常用注解说明springboot常用注解说明springboot常用注解说明springboot常用注解说明springboot常用注解说明...
SpringBoot 中常用注解及各种注解作用
08-27
SpringBoot 中常用注解及各种注解作用 SpringBoot 框架中，注解扮演着非常重要的角色，它们可以帮助开发者快速构建应用程序，提高开发效率。下面将对 SpringBoot 中常用注解进行详细的介绍，并解释每个注解的作用。...
SpringBoot常用注解详解含使用示例（值得珍藏）
最新发布
02-01
Spring Boot是一个开源框架，旨在简化Spring应用程序的创建和部署。它通过提供自动配置和约定优于配置的...通过了解这些常用注解的特性和使用方法，读者可以更有效地利用Spring Boot框架的功能，提高开发效率和质量。
springboot常用注解.markdown
01-23
springboot常用注解.markdown
集成验证框架实现统一参数校验
Hank的专栏
11-24 1004
前言 在我们实际项目开发过程中，避免不了的就是参数的校验，一般参数的校验，分为如下几种情况；1.前端直接验证；2. 在Controller层单独验证；3. 通过集成验证框架验证；显然3种里面，我们一般建议1+3结合的方式进行参数的校验比较合理和安全。在本章我们将围绕HTTP请求中参数校验的应用 Controller的几种接收参数的方式 在介绍验证框架之前，我们来介绍下通过Controller接收参数的方式；现在大部分都是通过注解的方式进行参数的接收，主流的有如下几种 请求路径参数 @PathVar
注解RequestMapping中的URI路径最前面到底需不需要加斜线？
慧写代码
05-28 8691
注解RequestMapping中的URL路径最前面到底需不需要加斜线? 您有没有这样的困惑：在协同开发过程中，使用RequestMapping，或者是GetMapping，或者是PostMapping这类注解时，有的程序员加了斜线，有的程序员没有加斜线，实际好像都能访问到，那么到底需不需要加呢？ 举例 以上路径写法都是可以访问的 加不加都可以访问，从这一点可以推断出结论：RequestMapping最前面的斜线可加可不加（这里只是说最前面，如果是/a/b/c中间的斜线分隔符是一定要加的） 所谓知其然
springboot中@PostMapping常用说明
weixin_45738731的博客
07-01 3208
springboot中@PostMapping常用说明。PostMapping属性。
Springboot之PostMapping无法获取数据
小乔美哒哒
07-01 6019
在使用SpringBoot的PostMapping注解的时候，发现无法获取数据（get方法可行），经过一番查证，发现需要添加新的注解，举例如下： //接受单个参数，使用RequestParam，并且添加上name属性，保证前后端的参数名称一致 @PostMapping(value = "/users") public RestfulResponse postUser(@RequestParam("id") Integer id, @RequestParam("u
postmapping注解参数说明_解析JWT+SpringBoot+SpringMVC参数解析器
weixin_39562752的博客
12-03 590
简介大家以前都使用过session存储信息,有的交给容器创建,有的存储到mysql或者redis,这次项目用到了JWT，我们把用户的信息和登录的过期时间都封装到一个token字符串里,客户端每次请求只需要在头信息里携带token即可,话不多说,下面是目录结构.一.annonation注解package com.demo.annotation;import java.lang.annotation....
1-3年的java面试题，持续更新中ing
qq_2662385590的博客
11-21 2097
java面试题，面试题

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值