In this article, I would explain step by step, how to enable Auditing in Spring Boot application. We would consider the following:<\/p>\n
<\/p>\n
1. Introduction to Auditing<\/strong><\/p>\n Auditing helps you track changes to a table. For example, yo need to know:<\/p>\n Before, now what I did was to add additional fields to my entities. So when a record is inserted, I have a code to insert the current time. Then I also insert the name of the current user. Now, you don’t have to worry about this. It is done automatically for you!<\/p>\n So let’s get started.<\/p>\n <\/p>\n <\/p>\n 2. Create the Auditable Class<\/strong><\/p>\n Here we would create an abstract class that holds the audit information. So any entity we would like to audit would extend this class. Follow the steps below:<\/p>\n Step 1:<\/strong>\u00a0 create an abstract class class Auditable. This should be in\u00a0the models package.\u00a0<\/span>This class would have the following fields:<\/span><\/p>\n TIMESTAMP\u00a0 is available with the namespace below:<\/p>\n <\/p>\n Step 2:<\/strong> Annotate the fields with annotations of the same name with the field. For example, CreatedBy is annotated with @CreatedBy<\/p>\n Step 3:<\/strong> Annotate the class with @MappedSuperclass annotation. This means that this class has not table created for it<\/p>\n Step 4:<\/strong> Annotate the class with @EntityListener annotation<\/p>\n Step 5:<\/strong> Generate the getters and the setters<\/p>\n At the end, the class would be as shown below (getters and setters are omitted for brevity):<\/p>\n <\/p>\n <\/p>\n <\/p>\n 3. Make the Classes Extend Auditable<\/strong><\/p>\n Now that we have the Auditable class, we can now extend it. So any entity we want to audit have to extend this class. Follow the steps:<\/p>\n Step 1:<\/strong> Modify the Post, User and Location file to make then extend Auditable<String><\/p>\n Step 2:<\/strong> Launch the application.<\/p>\n Step 3:<\/strong> Visit http:\/\/localhost:8080\/users. Check the the four additional field are now available.<\/p>\n Note:<\/strong> Follow step 4 if you have enabled h2-console<\/p>\n Step 4(Optional)<\/strong>: Visit http:\/\/localhost:8080\/h2-console. Check that the additional fields exist in the tables<\/p>\n <\/p>\n <\/p>\n 4. Implement the AuditorAware Interface<\/strong><\/p>\n Now, you need to create a class that implements the AuditorAware interface. This is the class the returns the current Auditor. That is the current user. Follow the steps below:<\/p>\n Step 1:<\/strong>\u00a0In the models package, create a class the implements AuditorAware<\/p>\n Step 2:<\/strong> Override the getCurrentAuditor method of this class. Just return a string which represents the current user<\/p>\n The class is as shown below:<\/p>\n <\/p>\n <\/p>\n 5. Create an AuditorAware Bean<\/strong><\/p>\n Finally, we need to create a bean of type AuditorAware.<\/p>\n Step 1<\/strong>: Annotate the main application class with @EnableJpaAuditing as shown below:<\/p>\n @EnableJpaAuditing(auditorAwareRef=”auditorAware”)<\/p>\n Step 2:<\/strong> Write a bean method that returns an AuditorAware object.\u00a0 At the end, the main application class would be as shown below:<\/p>\n <\/p>\n <\/p>\n <\/p>\n 6. Test the Application<\/strong><\/p>\n Step 1:<\/strong> Launch the application<\/p>\n Step 2:<\/strong> Open Advanced Rest Client (or PostMan Rest Client).<\/p>\n Step 3:<\/strong> Perform an insert operation in one of the tables and check the that audit data is added as well.<\/p>\n","protected":false},"excerpt":{"rendered":" In this article, I would explain step by step, how to enable Auditing in Spring Boot application. We would consider the following: Introduction to Auditing … <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"pagelayer_contact_templates":[],"_pagelayer_content":"","footnotes":""},"categories":[414],"tags":[],"class_list":["post-1947","post","type-post","status-publish","format-standard","hentry","category-programming"],"_links":{"self":[{"href":"https:\/\/kindsonthegenius.com\/blog\/wp-json\/wp\/v2\/posts\/1947","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/kindsonthegenius.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/kindsonthegenius.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/kindsonthegenius.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/kindsonthegenius.com\/blog\/wp-json\/wp\/v2\/comments?post=1947"}],"version-history":[{"count":1,"href":"https:\/\/kindsonthegenius.com\/blog\/wp-json\/wp\/v2\/posts\/1947\/revisions"}],"predecessor-version":[{"id":2115,"href":"https:\/\/kindsonthegenius.com\/blog\/wp-json\/wp\/v2\/posts\/1947\/revisions\/2115"}],"wp:attachment":[{"href":"https:\/\/kindsonthegenius.com\/blog\/wp-json\/wp\/v2\/media?parent=1947"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/kindsonthegenius.com\/blog\/wp-json\/wp\/v2\/categories?post=1947"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/kindsonthegenius.com\/blog\/wp-json\/wp\/v2\/tags?post=1947"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}\n
\n
import<\/span> static<\/span> javax.<\/span>persistence<\/span>.<\/span>TemporalType<\/span>.<\/span>TIMESTAMP<\/span>;<\/span>\n<\/pre>\n@MappedSuperclass<\/span>\n@EntityListeners<\/span>(<\/span>AuditingEntityListener.<\/span>class<\/span>)<\/span>\npublic<\/span> abstract<\/span> class<\/span> Auditable<\/span><<\/span>U><\/span> {<\/span>\n\n @CreatedBy<\/span>\n protected<\/span> U createdBy;<\/span>\n\n @CreatedDate<\/span>\n @Temporal<\/span>(<\/span>TIMESTAMP)<\/span>\n protected<\/span> Date createdDate;<\/span>\n\n @LastModifiedBy<\/span>\n protected<\/span> U lastModifiedBy;<\/span>\n\n @LastModifiedDate<\/span>\n @Temporal<\/span>(<\/span>TIMESTAMP)<\/span>\n protected<\/span> Date lastModifiedDate;<\/span>\n \n \/\/ getters and setter here<\/span>\n}<\/span>\n<\/pre>\npublic<\/span> class<\/span> SpringSecurityAuditorAware<\/span> implements<\/span> AuditorAware<<\/span>String><\/span> {<\/span>\n\n\t@Override<\/span>\n\tpublic<\/span> Optional<<\/span>String><\/span> getCurrentAuditor<\/span>()<\/span> {<\/span>\n\t\t\n\t\t\/\/ Just return a string representing the username<\/span>\n\t\treturn<\/span> Optional.<\/span>ofNullable<\/span>(<\/span>\"Kindson\"<\/span>).<\/span>filter<\/span>(<\/span>s -><\/span> !<\/span>s.<\/span>isEmpty<\/span>());<\/span>\n\t}<\/span>\n\t\n}<\/span>\n<\/pre>\n@EnableJpaAuditing<\/span>(<\/span>auditorAwareRef=<\/span>\"auditorAware\"<\/span>)<\/span>\n@SpringBootApplication<\/span>\npublic<\/span> class<\/span> RelationshipDemoApplication<\/span> {<\/span>\n\t\n\t@Bean<\/span>\n\tpublic<\/span> AuditorAware<<\/span>String><\/span> auditorAware<\/span>()<\/span> {<\/span>\n\t\treturn<\/span> new<\/span> SpringSecurityAuditorAware<\/span>();<\/span>\n\t}<\/span>\n\t\n\tpublic<\/span> static<\/span> void<\/span> main<\/span>(<\/span>String[]<\/span> args)<\/span> {<\/span>\n\t\tSpringApplication.<\/span>run<\/span>(<\/span>RelationshipDemoApplication.<\/span>class<\/span>,<\/span> args);<\/span>\n\t}<\/span>\n\n}<\/span>\n<\/pre>\n