SSM框架常用注解分享

版权声明:杨杨杨~~的版权 https://blog.csdn.net/weixin_38316697/article/details/82769671

SSM框架常用注解分享

1、@Controller                               [汉译英 :管理者]

    只是定义了一个控制器类,而使用@RequestMapping 注解的方法才是真正处理请求的处理器    @Controller 的使用方法

(1)在SpringMVC 的配置文件中定义MyController 的bean 对象。

   <bean class="com.host.app.web.controller.MyController"/>

(2)在SpringMVC 的配置文件中告诉Spring 该到哪里去找标记为@Controller 的Controller 控制器。

   < context:component-scan base-package = "com.host.app.web" />

    //路径写到controller的上一层(扫描包详解见下面浅析)

spring-mvc.xml的配置

<!-- 使用Annotation自动注册Bean,只扫描@Controller -->

  <context:component-scan

   base-package="com.thinkgem.jeesite" use-default-filters="false">

   <!-- base-package 如果多个,用“,”分隔 -->

  <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>

  </context:component-scan>


2、@RequestMapping                      [汉译英 :请求映射]

作用:处理请求映射,用于类或方法上,

         用于类时,表示类中的所有响应请求的方法都是以该地址作为父路径。

6个属性:

1、 value, method;

value:     指定请求的实际地址,指定的地址可以是URI Template 模式(后面将会说明);

method:  指定请求的method类型, GET、POST、PUT、DELETE等;

2、consumes,produces

consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;

produces:    指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;

3、params,headers

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

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

例如:

@Controller

@RequestMapping(value = "${adminPath}/sys/log")

public class LogController extends BaseController {

    @Autowired

    private LogService logService;

...


3、@Resource和@Autowired                 [汉译英 :@资源和@自动装配]

都是做bean的注入时使用

@Resource并不是Spring的注解,它的包是javax.annotation.Resource,需要导入,但是Spring支持该注解的注入。

1、共同点

 两者都可以写在字段和setter方法上。两者如果都写在字段上,那么就不需要再写setter方法。

2、不同点

@Autowired  只按照类型注入

@Resource    默认按照名称注入

@Autowired  的目的:

      使用Spring时,通过Spring注入的Bean一般都被定义成private,并且要有getter和setter方法,显得比较繁琐,增加了代码量,使用@Autowired可以减少代码量。

      标注可以放在成员变量上,也可以放在成员变量的set方法上。前者,Spring会直接将UserDao类型的唯一一个bean赋值给userDao这个成员变量;后者,Spring会调用setUserDao方法来将UserDao类型的唯一一个bean装配到userDao这个属性。

例如:

public class TestServiceImpl {

    // 下面两种@Autowired只要使用一种即可

    @Autowired

    private UserDao userDao; // 用于字段上

    

    @Autowired

    public void setUserDao(UserDao userDao) { // 用于属性的方法上

        this.userDao = userDao;

    }

}


4、@PathVariable                                     [汉译英 :@路径可变]

用处:请求URL中的模板变量映射到功能处理方法的参数上,即取出uri模板中的变量作为参数

例子:

    @RequestMapping(value = "treeList/{typeAlias}.xml")

    @ResponseBody

    public TreeList treeList(@PathVariable("typeAlias") String typeAlias) {

        

        // 如果使用Cache,并且在Cache里存在,则直接返回。

        boolean useCache = Global.getConfig("supcan.useCache") == "true";

        if (useCache){

            Object object = CacheUtils.get(SUPCAN_CACHE, typeAlias);

            if (object != null){

                return (TreeList)object;

            }

        }

    ...


5、@requestParam                                [汉译英 :@参数要求]

@requestParam主要用于在SpringMVC后台控制层获取参数,

类似一种是request.getParameter("name")

它有三个常用参数:defaultValue = "0",  //defaultValue 表示设置默认值。

                                  required = false,      //required 通过boolean设置是否是必须要传入的参数。

                                  value = "isApp";   //value 值表示接受的传入的参数类型。

例如:

    @ModelAttribute

    public CbrcLogData get(@RequestParam(required = false) String id) {

        CbrcLogData entity = null;

        if (StringUtils.isNotBlank(id)) {

            entity = cbrcLogDataService.get(id);

        }   

        return entity;

    }


6、@ResponseBody                              [汉译英 :@主体结果]

作用: 该注解用于将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式后,

入到Response对象的body数据区。

使用时机:返回的数据不是html标签的页面,而是其他某种格式的数据时(如json、xml等)使用;

【详解】

HttpMessageConverter 消息转换器 和 @ResponseBody联合使用

@responsebody表示该方法的返回结果直接写入HTTP response body

一般在异步获取数据时使用,在使用@RequestMapping后,返回值通常解析为跳转路径,加上@responsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中。比如异步获取json数据,加上@responsebody后,会直接返回json数据。

Spring3 MVC的@ResponseBody 的作用是把返回值直接写到HTTP response body里。

HttpMessageConverter类封装在spring-web-*.RELEASE.jar包中

例如:

@RequestMapping(value = "treeList/{typeAlias}.xml")

    @ResponseBody

    public TreeList treeList(@PathVariable("typeAlias") String typeAlias) {

        // 如果使用Cache,并且在Cache里存在,则直接返回。

        boolean useCache = Global.getConfig("supcan.useCache") == "true";

    ...


7、Repository                                  [汉译英 :@仓库]

作用:应用在导层,在daoImpl类上面注解。

例如:

@Repository

public class ActMyBusinessDao extends BaseHibernateDao<ActMyBusiness,String>{

    public Class getEntityClass() {

        return ActMyBusiness.class;

    }

...


8、@ModelAttribute和 @SessionAttributes  

(1)@ModelAttribute的作用

该Controller的所有方法在调用前,先执行此@ModelAttribute方法

(2)@SessionAttributes的作用

使属性进行跨属性访问

例如:    

          @Controller  

          @RequestMapping("/bbtForum.do")  

           <span style="color: #008000;">@SessionAttributes("currUser"

            //①将ModelMap中属性名为          currUser的属性 

            //放到Session属性列表中,以便这个属性可以跨请求访问

            </span>  

          public class BbtForumController {   

           …  

          @RequestMapping(params = "method=listBoardTopic")  

           public String listBoardTopic(@RequestParam("id")int topicId, User user,  ModelMap model) {  

                 bbtForumService.getBoardTopics(topicId);  

                 System.out.println("topicId:" + topicId);  

                 System.out.println("user:" + user);  

                 model.addAttribute("currUser",user);

                 <span style="color: #008000;">

                  //②向ModelMap中添加一个属性,其属性名为currUser

                 </span>  

                return "listTopic";  

           }  

           }  


9、@Service   

声明Service组件


10、@RequestParam

返回叁数@RequestParam(value = "fileUpload", required = false)


11、@RequiresPermissions权限注解

@RequiresPermissions("yzy:eaparam:eaparam:edit")


12、@Param()

叁数与对应xml里的#{}里的内容一致

-----------------------------------------------------------------------

13、@postmapping

    是一个组合注解,是@RequestMapping(method = RequestMethod.POST)的缩写。

---------------------------------------------------------------------------------

14、@GetMapping()

是一个组合注解,是@RequestMapping(method = RequestMethod.GET)的缩写。

------------------------------------------------------------------------

15、@Transactional

在service层加载事务,目的在于关于操作数据库的操作由事务来管理

猜你喜欢

转载自blog.csdn.net/weixin_38316697/article/details/82769671