SSM中常用注解（逐渐补充）

最新推荐文章于 2023-12-26 17:46:26 发布

kjshuan

最新推荐文章于 2023-12-26 17:46:26 发布

阅读量519

点赞数 1

分类专栏： Java 文章标签： java 开发语言 SSM 注解

本文链接：https://blog.csdn.net/just_learing/article/details/124568044

版权

Java 专栏收录该内容

111 篇文章 6 订阅

订阅专栏

title: SSM注解
categories: 注解
tags: 注解
SSM注解详细介绍
@Controller
通过@Controller注解说明该类非普通类，而是一个控制器类,这一个注解一般使用在SpringMvc层

@RequestMapping
是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。用于方法上表示请求的方法是该地址的子路径。

@RequestMapping注解有六个属性，分成三类进行说明:

value ，method；
value：指定请求的实际地址，指定的地址可以是URI Template 模式；

method：指定请求的method类型， GET、POST、PUT、DELETE等；

consumes，produces
consumes：指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;

produces: 指定返回的内容类型，仅当request请求头中的)类型中包含该指定类型才返回；

params，headers
params：指定request中必须包含某些参数值是，才让该方法处理。

params 只是判断url 或者 form data 中的参数是否复合params的定义，并不会直接绑定数据到方法的参数中！

headers：指定request中必须包含某些指定的header值，才能让该方法处理请求。

@Controller
@RequestMapping("/dept")
public class DeptHandler {
@Autowired
IDeptService deptService;

@RequestMapping("/findDept.do")
public String findDept(@RequestParam(defaultValue = "1") int pageIndex, String name, Model model){

PageModel pageModel = new PageModel();
pageModel.setPageIndex(pageIndex);
List<Dept> depts = deptService.findDept(name,pageModel);

//查询部门记录数
int recordCount = deptService.findDeptCount(name);
pageModel.setRocordCount(recordCount);
model.addAttribute("pageModel",pageModel);
model.addAttribute("depts",depts);
model.addAttribute("name",name);
for (Dept d:depts){
System.out.println(d);
}
return "/jsp/dept/dept.jsp";
}

@Resource和@Autowired
@Autowired顾名思义，就是自动装配。其作用是为了消除代码Java代码里面的getter/setter与bean属性中的property。当然，getter看个人需求，如果私有属性需要对外提供的话，应当予以保留。@Autowired默认按类型匹配的方式，在容器查找匹配的Bean，当有且仅有一个匹配的Bean时，Spring将其注入@Autowired标注的变量中。
@Autowired默认按照byType方式进行bean匹配，@Resource默认按照byName方式进行bean匹配@Autowired是Spring的注解，@Resource是J2EE的注解。在SSM框架的Service层使用@Autowired注解自动导入Dao包容易爆红，虽然代码可以运行但是使用@Resourse就不会出现报错的现象

@Service
@Service用于标注业务层组件

@Service
public class DeptServiceImpl implements IDeptService {
@Resource //自动注入但不会报错
IDeptDao deptDao;
@ResponseBody
作用：该注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区。
使用时机：返回的数据不是html标签的页面，而是其他某种格式的数据时（如json、xml等）使用；

@RequestMapping("/addDept.do")
@ResponseBody
public Object addDept(Dept dept){
int rows = deptService.addDept(dept);
if(rows > 0){
int recordCount = deptService.findDeptCount(null);
PageModel pageModel = new PageModel();
pageModel.setRocordCount(recordCount);
int totalSize = pageModel.getTotalSize();
System.out.println(totalSize);
return totalSize;
}else{
return "FAIL";
}
}
@RestController
这个注解是@RequestBody和@Controller的合体，作用也是两个注解的合并。
1)如果只是使用@RestController注解Controller，则Controller中的方法无法返回jsp页面，配置的视图解析器InternalResourceViewResolver不起作用，返回的内容就是Return 里的内容。
例如：本来应该到success.jsp页面的，则其显示success.
2) 如果需要返回到指定页面，则需要用 @Controller配合视图解析器InternalResourceViewResolver才行。
3)如果需要返回JSON，XML或自定义mediaType内容到页面，则需要在对应的方法上加上@ResponseBody注解。

@Param
不使用@Param注解时，参数只能有一个，并且是Javabean。在SQL语句里可以引用JavaBean的属性，而且只能引用JavaBean的属性
一般在Dao接口传递两个或三个较少的参数时可以使用@Param注解，如果涉及的参数较多，可以把所有参数进行Map封装，然后传递Map就可以了

@RequestParam
在springMVC中使用RequestParam注解映射请求参数，@RequestParam有三个属性，分别如下：
(1) value 请求参数的参数名,作为参数映射名称；
(2) required ，默认为true(必填)，当设置成必填时，如果没有传入参数，报错；
(3) defaultValue 设置请求参数的默认值；

@requestParam主要用于在SpringMVC后台控制层获取参数，类似一种是request.getParameter(“name”)，它有三个常用参数：defaultValue = “0”, required = false, value = “isApp”；defaultValue 表示设置默认值，required 铜过boolean设置是否是必须要传入的参数，value 值表示接受的传入的参数类型。

value：参数key，可以不写；
required：默认值为true，可以不写；

Spring其它常用注解汇总
使用注解之前要开启自动扫描功能，其中base-package为需要扫描的包(含子包)。

@Configuration把一个类作为一个IoC容器，它的某个方法头上如果注册了@Bean，就会作为这个Spring容器中的Bean。
@Scope注解作用域
@Lazy(true) 表示延迟初始化
@Service用于标注业务层组件、
@Controller用于标注控制层组件（如struts中的action）
@Repository用于标注数据访问组件，即DAO组件。
@Component泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。
@Scope用于指定scope作用域的（用在类上）
@PostConstruct用于指定初始化方法（用在方法上）
@PreDestory用于指定销毁方法（用在方法上）
@DependsOn：定义Bean初始化及销毁时的顺序
@Primary：自动装配时当出现多个Bean候选者时，被注解为@Primary的Bean将作为首选者，否则将抛出异常
@Autowired 默认按类型装配，如果我们想使用按名称装配，可以结合@Qualifier注解一起使用。如下：@Autowired @Qualifier(“personDaoBean”) 存在多个实例配合使用
@Resource默认按名称装配，当找不到与名称匹配的bean才会按类型装配。
@PostConstruct 初始化注解
@PreDestroy 摧毁注解默认单例启动就加载
@Async异步方法调用

1、@Controller、@Service、@Component注解，都相当于是配置了一个bean标签，分别应用于控制层，服务层，第三个都可以使用(在不知道属于哪层的时候使用)

2、@RequestMapping 该注解描述请求路径和当前方法的映射

属性value -- 代表当前方法处理的请求路径地址，假设为@RequestMapping(“/login”)，会默认发布三个映射地址，分别是/login,/login.*,/login/。

属性method -- 定义方法处理的请求方式，如果请求方式不支持，则页面报405错误，提示请求方式不支持，method是RequestMethod[]类型的属性，在注解中使用{}定义数组数据

属性produces – 设置响应类型只在服务方法返回类型为字符串，并提供ResponseBody注解时生效

@RequestMapping(value=”/login”,method={RequestMethod.GET},produces=”application/json;charset=UTF-8”)

3、@RequestParam 该注解处理不友好的请求参数

属性value – 请求参数的名称，没有默认值(该名称为页面中的name)

属性defaultValue– 如果没有传递请求参数，使用什么默认值

属性required – 是否是一个必要的请求参数，默认值是true，如果必要参数没有传递，

页面显示400错误，是请求错误

@RequestParam(value=”TXT_PWD”,defaultValue=”123123”,required=”true”)Stringpassword

4、@PathVariable 获取restful风格传参定义的变量数据

属性value – 用于设置变量命名，如果变量名和方法参数名一致，可以省略

Restful风格传参 @RequestMapping(“/testRestful/{username}/{password}”)

@PathVariable(@PathVariable(“username”)Stringusername,@PathVariable String password)

5、@ResponseBody 实现异步访问的json数据返回

6、@Param 一般用在mapper层，简单类型（八种基本数据类型+包装类+String）传值的时候，会忽略占位符个数和命名，传给所有的占位符，使用@param注解，可以构建一个key-value键值对

属性value --- 创建的键值对的key

如：@Param(value="key")String value

7、读取properties配置文件的时候，如果是写在其他配置文件中，如：applicaitonContext-mybatis.xml文件中配置datasource时读取properties文件，value中直接使用${key}格式，如：<property name=“url” value="${mysql.url}">(mysql.url为properties文件中的一个key值，使用之前需要先读取该properties文件，需要注意的是读取的properties文件只在当前容器中有效<context:property-placeholder location="classpath:com/cms/config/commons/db.properties">)

如果是在java文件中需要使用到properties中配置的信息（如：serviceImpl文件中），前提是当前容器已经读取properties文件，使用标签来读取value值格式为 @Value("${key}") 如: @Value("${FTP_HOST}")

8、@JsonProperty 将对象转换成json字符串的时候，对应的key值，使用注解中的value属性值

结果为{"name":"张三"} 注解是jackson包提供

9、@RequestBody 将json格式的请求参数转化成java对象，需要注意的是，json对象的中key必须是java对象中的属性，否则传不过去 public Object login(@RequestBody User user){}

个人笔记，不对的望指教，谢谢