springboot基本项目结构和常用的注解简单使用方法

简介: springboot

1. 项目结构

1.1 结构图

1.2 介绍

  • src
  • main
  • java
  • com.cheng.ai 包名
  • controller 控制层
  • service 服务层
  • mapper dao层
  • entity 实体类文件夹
  • rescources
  • application.yaml
  • templates
  • test 测试文件包

大体可以分为上面这种结构,控制层主要写跟前端交互的代码,服务层主要写业务代码供控制层调用,dao层写操作数据库的代码供服务层调用,实体类主要写数据库表对应的关系模型,将数据库中数据和代码关联供dao层调用

  • 这些文件结构以及关系是

控制层------>服务层------->dao层-------->实体类,一层层调用。

1.3 为什么要这样分

  • 假设我们做一个商城程序
  • 需要查询商品的列表
  • 需要返回一个商品列表的数据

那么按照一个文件写,我把控制层、服务层等写在一个文件里面,这样就可以让项目结构清晰简单了。

但是随之而来的问题,你的这个查询商品列表的业务要是太复杂了,可能整个流程写下来有几百上千行代码了,而且代码依赖性太强了,突然有个地方出了bug你找出来麻烦,就算很简单找出来,但是前面代码一动后面代码万一全跟着错了怎么办,这改下来不得掉一斤头发,万一改好一个又一个怎么办,为了避免这样的事情出现所以分文件写,错了也不会导致这样雪崩式的错误出现。


      但是还有人杠,我写的代码不可能有错的,好!代码没有错,万一要是前端要你把接口改一下呢,数据库表有点细微的变化呢、返回的数据要你改改呢。我知道你没有错,但是这还是得改,总不可能把他们打了说不改吧。所以这样一改,还是会导致各种问题出现。

你以多文件的方式去暴露方法接口,就算你某个层要修改也仅仅只是某个层的代码要改,不会影响其他层的代码,其他层只是调用了方法并不关心内部代码如何,这样使代码大大解耦合,使可用性更高。

2. 常用注解

2.1 程序启动 @SpringBootApplication

@SpringBootApplication// 将此类标记为程序启动类,程序将从此进入启动publicclassAiApplication {
publicstaticvoidmain(String[] args) {
SpringApplication.run(AiApplication.class, args);
    }
}

2.2 配置类 @Configuration

@Configuration// 将此文件标记为配置类,跟随程序启动加载@MapperScan({"com.cheng.ai.mapper"}) // 后面mybatis一起讲publicclassMybatisConfig {
}

2.3@component、@Service、@Controller、@Respository

  • 这几个注解功能基本上一样,用在不同的地方

注解

说明

@Component

普通实体注入spring容器

@Repository

dao层注入spring容器

@Service

服务层注入spring容器

@Controller

控制层注入spring容器

在前后端分离项目中一般使用@RestController代替@Controller,因为@RestController包含了@Controller等注解,以下是他的代码

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented@Controller@ResponseBodypublic@interfaceRestController {
@AliasFor(
annotation=Controller.class    )
Stringvalue() default"";
}

2.4 @ResponseBody

@ResponseBody可以作用在方法上或类上,表示该方法的返回结果直接写入 HTTP response body 中,而不会被解析为跳转路径,即不会经过视图解析器,返回什么数据即在页面输入什么数据。下面是@ResponseBody注解源码

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documentedpublic@interfaceResponseBody {
}

2.5 @Autowired

此注解会自动在spring容器中找到bean进行自动装配,如果发现找到多个bean,则按照name方式比对,如果还有多个,则报出异常

@Service// 在实现类注入publicclassAiLogServiceImplextendsServiceImpl<AiLogMapper, AiLog>implementsAiLogService {
}
@RestController@RequestMapping("/aiLog")
publicclassAiLogController {
@AutowiredprivateAiLogServiceaiLogService; // 装配@GetMapping("test")
publicCommonResultgetlist(){
List<AiLog>list=aiLogService.list();
returnCommonResult.success(list);
    }
}

2.6 @RequestMapping、@GetMapping、@PostMapping......

这些注解定义请求的url,@RequestMapping可以用在类上或者方法上

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented@Mappingpublic@interfaceRequestMapping {
    ......
}
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented@RequestMapping(
method= {RequestMethod.POST}
)
public@interfacePostMapping{
    ......
}

可以看到PostMapping仅仅只是RequestMapping限定methon(请求方法的注解),并且只可以用于方法上,PostMapping限定的请求只能以POST方式,GetMapping限定GET方式请求,其他XXXMapping就是限定XXX请求方式

2.7 @Value

可以注入在配置文件中的值到实体类,注意此类要加入到sping容器此注解才有效

2.8 @Bean

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documentedpublic@interfaceBean {
    ......
}

作用于方法上,将方法的返回值注入到spring容器中

@Configuration@EnableSwagger2WebMvcpublicclassSwaggerConfig {
// 创建Docket存入容器,Docket代表一个接口文档@BeanpublicDocketwebApiConfig(){
returnnewDocket(DocumentationType.SWAGGER_2)
// 创建接口文档的具体信息                .apiInfo(webApiInfo())
// 创建选择器,控制哪些接口被加入文档                .select()
// 指定@ApiOperation标注的接口被加入文档                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .build();
    }
}

2.9@RequestParam@RequestBody@PathVariable@RequestHeader、@CookieValue

这些注解用来接收前端参数的

@ResquestParam

get请求获取参数的注解

@PathVariable

获取路径参数

@ResquestHeader

获取请求头的信息

@CookieValue

获取Cookie的信息

示例:

@GetMapping("/list/{pageNum}/{pageSize}")
publicCommonResult<List<Brand>>getList(@PathVariable("pageNum") intpageNum,
@PathVariable("pageSize") intpageSize){
        ......
    }


相关文章
|
1月前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
52 0
|
27天前
|
前端开发 Java Spring
Spring MVC核心:深入理解@RequestMapping注解
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的核心,它将HTTP请求映射到控制器的处理方法上。本文将深入探讨`@RequestMapping`注解的各个方面,包括其注解的使用方法、如何与Spring MVC的其他组件协同工作,以及在实际开发中的应用案例。
41 4
|
1月前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
65 4
SpringBoot必须掌握的常用注解!
|
27天前
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
99 2
|
27天前
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
46 2
|
1月前
|
消息中间件 Java 数据库
解密Spring Boot:深入理解条件装配与条件注解
Spring Boot中的条件装配与条件注解提供了强大的工具,使得应用程序可以根据不同的条件动态装配Bean,从而实现灵活的配置和管理。通过合理使用这些条件注解,开发者可以根据实际需求动态调整应用的行为,提升代码的可维护性和可扩展性。希望本文能够帮助你深入理解Spring Boot中的条件装配与条件注解,在实际开发中更好地应用这些功能。
36 2
|
1月前
|
JSON Java 数据格式
springboot常用注解
@RestController :修饰类,该控制器会返回Json数据 @RequestMapping(“/path”) :修饰类,该控制器的请求路径 @Autowired : 修饰属性,按照类型进行依赖注入 @PathVariable : 修饰参数,将路径值映射到参数上 @ResponseBody :修饰方法,该方法会返回Json数据 @RequestBody(需要使用Post提交方式) :修饰参数,将Json数据封装到对应参数中 @Controller@Service@Compont: 将类注册到ioc容器
|
1月前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
43 2
|
27天前
|
前端开发 Java 开发者
Spring MVC中的控制器:@Controller注解全解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序控制层的核心。它不仅简化了控制器的定义,还提供了灵活的请求映射和处理机制。本文将深入探讨`@Controller`注解的用法、特点以及在实际开发中的应用。
67 0
|
1月前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
53 1