| CS-665 | Software Design & Patterns |
|---|---|
| Name | Yueyihan Qi |
| Date | 03/06/2024 |
| Course | Spring |
| Assignment # | Assignment3 Email Generation |
A company serves various customer segments, including Business, Returning, Frequent, New, and VIP. The management requires an efficient solution to send personalized emails to their customers. To achieve this, they require a custom application that can automatically generate emails based on a base template, tailored to each type of customer.
For each assignment, please answer the following:
- Explain the level of flexibility in your implementation, including how new object types can be easily added or removed in the future.
This project uses the factory pattern, where the company acts as the factory and the different users are the products. The process of creating customer objects through abstraction increases project flexibility so that customer types can be added or modified seamlessly without affecting the rest of the code base. To add a new customer type, simply create a new class that implements the customer interface and provides the necessary logic for generating email appellations and personalized permissions. Similarly, to remove a customer type, simply delete the corresponding class implementation.
- Discuss the simplicity and understandability of your implementation, ensuring that it is easy for others to read and maintain.
Each class and method is appropriately named and encapsulates specific functionality, thus improving the readability of the code. And detailed comments are provided to explain the purpose and function of each component, which allows a good understanding of the code.
- Describe how you have avoided duplicated code and why it is important.
This program has been designed to minimize duplicate code. Common functions such as email generation and sending are encapsulated in the EmailGeneration class. Also, the use of the factory pattern helps avoid duplication by centralizing the creation of client objects, thus ensuring consistency and reducing the need for redundant code in various parts of the application.
- If applicable, mention any design patterns you have used and explain why they were chosen.
This project uses the factory pattern to create objects without specifying their specific classes. This pattern decouples the client code from the specific implementation of the objects it uses, thus increasing flexibility and making it easy to add or remove object types.
We'll use Apache Maven to compile and run this project. You'll need to install Apache Maven (https://maven.apache.org/) on your system.
Apache Maven is a build automation tool and a project management tool for Java-based projects. Maven provides a standardized way to build, package, and deploy Java applications.
Maven uses a Project Object Model (POM) file to manage the build process and its dependencies. The POM file contains information about the project, such as its dependencies, the build configuration, and the plugins used for building and packaging the project.
Maven provides a centralized repository for storing and accessing dependencies, which makes it easier to manage the dependencies of a project. It also provides a standardized way to build and deploy projects, which helps to ensure that builds are consistent and repeatable.
Maven also integrates with other development tools, such as IDEs and continuous integration systems, making it easier to use as part of a development workflow.
Maven provides a large number of plugins for various tasks, such as compiling code, running tests, generating reports, and creating JAR files. This makes it a versatile tool that can be used for many different types of Java projects.
Type on the command line:
mvn clean compileJUnit is a popular testing framework for Java. JUnit tests are automated tests that are written to verify that the behavior of a piece of code is as expected.
In JUnit, tests are written as methods within a test class. Each test method tests a specific aspect of the code and is annotated with the @Test annotation. JUnit provides a range of assertions that can be used to verify the behavior of the code being tested.
JUnit tests are executed automatically and the results of the tests are reported. This allows developers to quickly and easily check if their code is working as expected, and make any necessary changes to fix any issues that are found.
The use of JUnit tests is an important part of Test-Driven Development (TDD), where tests are written before the code they are testing is written. This helps to ensure that the code is written in a way that is easily testable and that all required functionality is covered by tests.
JUnit tests can be run as part of a continuous integration pipeline, where tests are automatically run every time changes are made to the code. This helps to catch any issues as soon as they are introduced, reducing the need for manual testing and making it easier to ensure that the code is always in a releasable state.
To run, use the following command:
mvn clean testSpotBugs is a static code analysis tool for Java that detects potential bugs in your code. It is an open-source tool that can be used as a standalone application or integrated into development tools such as Eclipse, IntelliJ, and Gradle.
SpotBugs performs an analysis of the bytecode generated from your Java source code and reports on any potential problems or issues that it finds. This includes things like null pointer exceptions, resource leaks, misused collections, and other common bugs.
The tool uses data flow analysis to examine the behavior of the code and detect issues that might not be immediately obvious from just reading the source code. SpotBugs is able to identify a wide range of issues and can be customized to meet the needs of your specific project.
Using SpotBugs can help to improve the quality and reliability of your code by catching potential bugs early in the development process. This can save time and effort in the long run by reducing the need for debugging and fixing issues later in the development cycle. SpotBugs can also help to ensure that your code is secure by identifying potential security vulnerabilities.
Use the following command:
mvn spotbugs:gui For more info see https://spotbugs.readthedocs.io/en/latest/maven.html
SpotBugs https://spotbugs.github.io/ is the spiritual successor of FindBugs.
Checkstyle is a development tool for checking Java source code against a set of coding standards. It is an open-source tool that can be integrated into various integrated development environments (IDEs), such as Eclipse and IntelliJ, as well as build tools like Maven and Gradle.
Checkstyle performs static code analysis, which means it examines the source code without executing it, and reports on any issues or violations of the coding standards defined in its configuration. This includes issues like code style, code indentation, naming conventions, code structure, and many others.
By using Checkstyle, developers can ensure that their code adheres to a consistent style and follows best practices, making it easier for other developers to read and maintain. It can also help to identify potential issues before the code is actually run, reducing the risk of runtime errors or unexpected behavior.
Checkstyle is highly configurable and can be customized to fit the needs of your team or organization. It supports a wide range of coding standards and can be integrated with other tools, such as code coverage and automated testing tools, to create a comprehensive and automated software development process.
The following command will generate a report in HTML format that you can open in a web browser.
mvn checkstyle:checkstyleThe HTML page will be found at the following location:
target/site/checkstyle.html