1、關(guān)于Controller層的一些注解。
@ResponseBody 注解
@RequestBody注解
@RequestMapping注解
@RequestParam注解
@Controller注解
@ResponseBody 注解:將內(nèi)容或?qū)ο笞鳛?HTTP 響應(yīng)正文(即響應(yīng)體)返回,并調(diào)用適合HttpMessageConverter的Adapter轉(zhuǎn)換對象,寫入輸出流。一般注釋在方法上,意思就是將方法的返回值通過一定的轉(zhuǎn)換發(fā)送給前端頁面。
@RequestBody 注解:將HTTP請求正文(即請求體,post請求的內(nèi)容)轉(zhuǎn)換為適合的HttpMessageConverter對象。
@RequestMapping 注解:用來處理請求地址映射的注解,可用于類或方法上。用于類上,表示類中的所有響應(yīng)請求的方法都是以該地址作為父路徑。
例子如下:
@RequestMapping("/create")
@ResponseBody
public Result createProject(@RequestBody DevopsGitlabProject project) {
try {
Result<GitlabProject> result = new Result<>();
result.setResult(gitProjectService.createProject(project));
return result;
} catch (Exception e) {
logger.info(ErrorInfo.errorInfo(e));
return ErrorInfo.handError(e);
}
}
@RequestParam注解:匹配前臺傳來的參數(shù)給注解參數(shù)。比如下面前臺傳來的是project_id,匹配到projectId參數(shù)上。
例子如下:
@RequestMapping(“/project")
@ResponseBody
public Result deleteProject(@RequestParam(name = "project_id") Integer projectId) {
try {
Result<String> result = new Result<>();
gitProjectService.deleteProject(projectId);
result.setResult("分支已刪除!");
return result;
} catch (IOException e) {
logger.info(ErrorInfo.errorInfo(e));
return ErrorInfo.handError(e);
}
}
關(guān)于Controller 類以及 @Controller 注解
1:spring mvc 中將 controller 認(rèn)為是 MVC中的C --控制層
2:規(guī)范命名 類名 xxxController
3:如果不基于注解:該類需要繼承 CommandController
如果基于注解: 在類名前加上 @controller
4:補(bǔ)充:將類名前加上該注解,當(dāng)spring啟動 或者web服務(wù)啟動 spring會自動掃描所有包(當(dāng)然,這個(gè)可以設(shè)置)
作用: 就是告訴服務(wù)器 這個(gè)類是MVC中的C 這個(gè)類可以接收用戶請求 處理用戶請求
備注:
@RequestMapping 注解的詳解
理解:用來處理請求地址映射的注解,可用于類或方法上。用于類上,表示類中的所有響應(yīng)請求的方法都是以該地址作為父路徑。
RequestMapping注解有六個(gè)屬性,下面我們把她分成三類進(jìn)行說明。
附注:屬性就是指指寫在注解后面括號里面的內(nèi)容,即:@RequestMapping(屬性1=屬性值,屬性2=屬性值....)
1、 value, method;
value: 指定請求的實(shí)際地址,指定的地址可以是URI Template 模式(后面將會說明);默認(rèn)RequestMapping("....str...")即為value的值;
method: 指定請求的method類型, GET、POST、PUT、DELETE等;
2、 consumes,produces;
consumes: 指定處理請求的提交內(nèi)容類型(Content-Type),例如application/json, text/html;
produces: 指定返回的內(nèi)容類型,僅當(dāng)request請求頭中的(Accept)類型中包含該指定類型才返回;
3、 params,headers;
params: 指定request中必須包含某些參數(shù)值是,才讓該方法處理。
headers: 指定request中必須包含某些指定的header值,才能讓該方法處理請求。
2、@Service層常用的注解
@Service注解
@Resource注解
@Autowired注解
@Resource注解
@Value注解
@Service注解:將service層對象注入到spring容器中,和xml配置文件中的<bean></bean>標(biāo)簽作用一樣。
@Resource注解:注入bean對象
如果同時(shí)指定了name和type,則從Spring上下文中找到唯一匹配的bean進(jìn)行裝配,找不到則拋出異常
如果指定了name,則從上下文中查找名稱(id)匹配的bean進(jìn)行裝配,找不到則拋出異常
如果指定了type,則從上下文中找到類型匹配的唯一bean進(jìn)行裝配,找不到或者找到多個(gè),都會拋出異常
如果既沒有指定name,又沒有指定type,則自動按照byName方式進(jìn)行裝配;如果沒有匹配,則回退為一個(gè)原始類型進(jìn)行匹配,如果匹配則自動裝配;
@Autowired:按byType自動注入對象
@Autowired 與@Resource的區(qū)別:
1、 @Autowired與@Resource都可以用來裝配bean. 都可以寫在字段上,或?qū)懺趕etter方法上。
2、 @Autowired默認(rèn)按類型裝配(這個(gè)注解是屬業(yè)spring的),默認(rèn)情況下必須要求依賴對象必須存在,如果要允許null值,可以設(shè)置它的required屬性為false,如:@Autowired(required=false) ,如果我們想使用名稱裝配可以結(jié)合@Qualifier注解進(jìn)行使用,如下:
@Autowired()
@Qualifier("baseDao”)
private BaseDao baseDao;
附注:關(guān)于ByName和Bytype的使用,ByName的意思是在容器中找到與注釋下的變量名一致的對象注入給變量。ByType就是找到上下文與注釋下的變量類型一致的類對象的類型,注入給注釋下的變量。
推薦使用:@Resource注解在字段上,這樣就不用寫setter方法了,并且這個(gè)注解是屬于J2EE的,減少了與spring的耦合。這樣代碼看起就比較優(yōu)雅。
@Value注解意思:在connection中有的,指定資源文件中的某個(gè)變量值。
例子如下:
@Value("${git_host}")private String HOSTNAME;
@Transactional注解的作用:事務(wù)處理,當(dāng)刪除出現(xiàn)異常,回滾之前刪除的。
注意:刪除的操作必須要有@ Transactional注解,添加和修改也要有這個(gè)注解
例子如下:
@Override
@Transactional
public void deleteUser(Integer userId) throws IOException {
aclUserRepository.deleteUser(userId);
gitlabAPI.deleteUser(userId);
}
3、持久化層的相關(guān)注解
@Repository注解
@Query注解
@Param注解
@Repository注解意思:操作表的接口。@Query注解表示:下面的方法執(zhí)行的就是該注解中的查詢的sql語句,方法的返回值就是對應(yīng)的查詢結(jié)果,@Param注解表示
@Query:方法執(zhí)行的查詢語句,查詢的結(jié)果就是方法的返回值(刪除修改等無返回值不返回結(jié)果)
@Param:將方法中的參數(shù)值賦給注解中的參數(shù),再將注解的參數(shù)放入查詢語句的與注解同名的參數(shù)中。
例子如下:
@Repository
public interface AclExaminationRepository extends JpaRepository<AclExamination, Integer>, JpaSpecificationExecutor<AclExamination> {
@Query(value = "select * from acl_examination where leader_id=:leaderId",nativeQuery = true)
public List<AclExamination> getExaminationMessageList(@Param("leaderId")Integer leaderId);
@Query(value = "select * from acl_examination where id=:examinationId",nativeQuery = true)
public AclExamination getExaminationMessage(@Param("examinationId")Integer examinationId);
}
4、表的映射類的相關(guān)注解
@Entity注解
@Table注解
@GeneratedValue
@Transient
@Id
@Temporal
@Entity注解:表示的是關(guān)于表映射的類的注解
@Table注解:類映射的表的表名
@GeneratedValue 注解:在表的映射類的主鍵上加入這個(gè)注解,那么在向表中創(chuàng)建這個(gè)對象的時(shí)候,就會自動創(chuàng)建主鍵id。
@Transient注解:在映射類中有的字段,但表中沒有,忽略注解下字段的映射。
@Id注解:這個(gè)屬性是表中的主鍵
@Temporal(TemporalType.TIMESTAMP)注解:
數(shù)據(jù)庫中的Date類型,取到頁面上是yyyy-MM-dd hh-mm-ss格式
利用@Temporal則可以獲取自己想要的格式類型
TIMESTAMP yyyy-MM-dd hh:mm:ss 2016-12-07 11:47:58.697這個(gè)是會顯示到毫秒的
DATE yyyy-MM-dd
TIME hh:mm:ss
例子如下:
@Entity
@Table(name="acl_role")
public class AclRole {
@Id
@Column(name = "id")
@GeneratedValue
private Integer id;
@Column(name = "role_name")
private String roleName;
@Column(name = "role_permission")
private String rolePermission;
@Transient private String sshKey;//該屬性不映射表中字段
.. .. .. .
@Temporal(TemporalType.TIMESTAMP)
@Column(name = "created_at")
private Date createdAt;
}
5、其它注解
@JsonProperty注解:通過前臺得到的字段根據(jù)這個(gè)注解匹配到相應(yīng)字段(如果沒有注解,會直接根據(jù)變量名匹配)。
寫這個(gè)注解的目的就是為了避免前臺書寫變量格式和后臺變量命名格式不統(tǒng)一的沖突!
public class DevopsExamineBacklogVO {
private String initiator;
private String type;
@JsonProperty("task_id")
private String taskId;
@JsonProperty("created_at")
private String createdAt;
}
@Component注解意思: 把普通pojo實(shí)例化到spring容器中,相當(dāng)于配置文件中的<bean id="" class=""/>
@PostConstruct注解:在當(dāng)前類構(gòu)造器初始化執(zhí)行執(zhí)行注解下的方法
@PostConstruct
private void init() {
this.gitlabAPI = GitlabAPI.connect(HOSTNAME,APITOKEN);
this.gitlabAPI.setRequestTimeout(REQUESTTIMEOUT);
}
@Bean注解:將方法返回值的bean對象注入spring容器中
@Bean
public RestTemplate restTemplate(){
return new BasicAuthRestTemplate(username, password);
}
作者:弈閣
鏈接:http://www.itdecent.cn/p/943a25dcbe96
來源:簡書