URL Hit Counter

Overview

The URL Hit Counter is a simple Spring Boot application that allows you to track the number of times a specific URL endpoint has been accessed. It also provides an additional feature to track hit counts for different usernames.

Technologies Used

Framework: Spring Boot
Language: Java
Build Tool: Maven

Data Flow

The URL Hit Counter application follows a structured data flow pattern to handle requests and manage data efficiently:

Controller

The Controller layer is responsible for handling incoming HTTP requests and delegating them to the appropriate services. It defines API endpoints for various operations, including adding visitors, retrieving hit counts, and updating counts for specific users. Each endpoint maps to a specific service method to ensure proper request handling and response generation.

@RestController
@RequestMapping("/api/v1/visitor-count-app")
public class UrlHitController {
    @Autowired
    private UrlHitService urlHitService;

    // Endpoint mappings for various operations
    // ...
}

Service

The Service layer encapsulates the core business logic and data processing. It interacts with the Repository layer to retrieve and store data. In this application, it handles operations like adding visitors, retrieving hit counts, and updating counts for users. The Service layer validates input data and performs necessary operations before returning results to the Controller.

@Service
public class UrlHitService {
    @Autowired
    private UrlHitRepo urlHitRepo;

    // Service methods for various operations
    // ...
}

Repository

The Repository layer manages data access to in-memory storage. It maintains a list of UrlHitCounter objects to store hit counts for visitors. While this in-memory storage is suitable for a simple application, in a production environment, a database should be used for data persistence.

@Repository
public class UrlHitRepo {
    @Autowired
    private List<UrlHitCounter> urlHitCounterList;

    // Repository methods for managing visitor data
    // ...
}

Database Design

The URL Hit Counter application utilizes a simple in-memory data structure to store hit counts. In a production environment, it is advisable to replace this in-memory storage with a relational or NoSQL database for better data persistence and scalability.

In-Memory Data Structure

The primary data structure used in this application is a List of UrlHitCounter objects. Each UrlHitCounter object represents a visitor and their hit count. This structure allows for easy manipulation of hit counts but is not suitable for long-term data storage.

@Data
@NoArgsConstructor
@AllArgsConstructor
public class UrlHitCounter {
    private String userName;
    private Integer counter;
}

Data Structures Used

List

The application utilizes the Java List data structure to maintain a collection of UrlHitCounter objects. This dynamic data structure allows for the storage and retrieval of visitor hit counts. However, please note that this implementation is limited to in-memory storage and is not suitable for persisting data in a production environment.

@Bean
public List<UrlHitCounter> getUrlHitCounterList(){
    return new ArrayList<>();
}

UrlHitCounter Class

The UrlHitCounter class defines the structure for storing visitor information. It includes two fields: userName (to identify the visitor) and counter (to track the hit count for that visitor). Instances of this class are used to represent visitors and manage their hit counts.

@Data
@NoArgsConstructor
@AllArgsConstructor
public class UrlHitCounter {
    private String userName;
    private Integer counter;
}

Endpoints

Get Total Hit Count

Endpoint: /api/v1/count
HTTP Method: GET
Description: Retrieves the total hit count for the default URL.

Get Hit Count for a Specific User

Endpoint: /api/v1/username/{username}/count
HTTP Method: GET
Description: Retrieves the hit count for a specific user identified by {username}.

Add a New Visitor

Endpoint: /visitor
HTTP Method: POST
Description: Adds a new visitor to the system.

Get All Visitors

Endpoint: /visitors
HTTP Method: GET
Description: Retrieves a list of all visitors and their hit counts.

Get the Number of Visitors

Endpoint: /visitor/count
HTTP Method: GET
Description: Retrieves the total number of visitors.

Increment Hit Count for a Specific User

Endpoint: /api/v1/count_update/username/{username}
HTTP Method: PUT
Description: Increments the hit count for a specific user identified by {username}.

Usage

Use a tool like Postman to make HTTP requests to the provided endpoints.
Create visitors using the "Add a New Visitor" endpoint with a POST request.
Retrieve hit counts and manage visitors using the provided endpoints.

Project Structure

The project follows a standard Spring Boot application structure with components organized into layers:

Controller: Handles incoming HTTP requests and defines API endpoints.
Service: Implements business logic and interacts with the repository.
Repository: Manages data access and storage.
Entity: Defines data models.
BeanManager: Contains Spring bean configurations.

Data Storage

Visitor hit counts are stored in-memory using a List. In a production environment, you should consider using a database for data persistence.

Contributing

Contributions to this project are welcome! If you have any suggestions, find issues, or want to enhance the functionality, please feel free to open an issue or submit a pull request.

License

This project is licensed under the GNU General Public License v3.0.

Acknowledgments

Thank you to the Spring Boot and Java communities for providing excellent tools and resources.

Contact

For questions or feedback, please contact Amit Ashok Swain.

Amit-Ashok-Swain/URL-Hit-Counter