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){
        ......
    }


相关文章
|
18天前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
|
7天前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
28 4
SpringBoot必须掌握的常用注解!
|
9天前
|
存储 缓存 Java
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
44 2
|
9天前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
26 1
|
17天前
|
存储 安全 Java
|
23天前
|
架构师 Java 开发者
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
在40岁老架构师尼恩的读者交流群中,近期多位读者成功获得了知名互联网企业的面试机会,如得物、阿里、滴滴等。然而,面对“Spring Boot自动装配机制”等核心面试题,部分读者因准备不足而未能顺利通过。为此,尼恩团队将系统化梳理和总结这一主题,帮助大家全面提升技术水平,让面试官“爱到不能自已”。
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
|
3天前
|
存储 安全 Java
springboot当中ConfigurationProperties注解作用跟数据库存入有啥区别
`@ConfigurationProperties`注解和数据库存储配置信息各有优劣,适用于不同的应用场景。`@ConfigurationProperties`提供了类型安全和模块化的配置管理方式,适合静态和简单配置。而数据库存储配置信息提供了动态更新和集中管理的能力,适合需要频繁变化和集中管理的配置需求。在实际项目中,可以根据具体需求选择合适的配置管理方式,或者结合使用这两种方式,实现灵活高效的配置管理。
8 0
|
28天前
|
XML Java 数据库
Spring boot的最全注解
Spring boot的最全注解
|
29天前
|
JSON NoSQL Java
springBoot:jwt&redis&文件操作&常见请求错误代码&参数注解 (九)
该文档涵盖JWT(JSON Web Token)的组成、依赖、工具类创建及拦截器配置,并介绍了Redis的依赖配置与文件操作相关功能,包括文件上传、下载、删除及批量删除的方法。同时,文档还列举了常见的HTTP请求错误代码及其含义,并详细解释了@RequestParam与@PathVariable等参数注解的区别与用法。
|
16天前
|
存储 Java 数据管理
强大!用 @Audited 注解增强 Spring Boot 应用,打造健壮的数据审计功能
本文深入介绍了如何在Spring Boot应用中使用`@Audited`注解和`spring-data-envers`实现数据审计功能,涵盖从添加依赖、配置实体类到查询审计数据的具体步骤,助力开发人员构建更加透明、合规的应用系统。