Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ashiqyousuf/snippetbox

Snippetbox, like your pastebin
https://github.com/ashiqyousuf/snippetbox

Last synced: 27 days ago
JSON representation

Snippetbox, like your pastebin

Awesome Lists containing this project

README 

        
# Snippetbox



## Note:- This readme file contains the important concepts that I learnt while building this application.



### Servemux:



1. Router is equivalent to *servemux* in go. Usually we have one *servemux* for our app containing all our routes.



2. Request goes to the => Go Server (passes it to)  => *servemux's ServeHTTP() method*=> in-turn calls *handler's ServeHTTP() method*



3. *servemux* treats "/" as catch-all.



4. Goʼs *servemux* supports two different types of URL patterns: fixed paths (/api/users) *exact match* and subtree paths (/api/users/) *wildcard match*. Fixed paths donʼt end with a trailing slash, whereas subtree paths do end with a trailing slash.



5. So, for the sake of security, itʼs generally a good idea to avoid *DefaultServeMux*.



6. In Goʼs *servemux*, longer URL patterns always take precedence over shorter ones. Request URL paths are automatically sanitized. host-specific maths are precedenced than non-host specific patterns.



7. All incoming HTTP requests are served in their own goroutine. Go Server is Concurrent!



### Project Structure & Packaging



1. The cmd directory will contain the application-specific code for the executable applications in the project. It scales nicely to add another app later on (cmd/cli).

2. The ui directory will contain the user-interface assets used by the web app.

3. Packages which live in internal directory (helpers|db models) can only be imported by code inside our snippetbox project.



4. The go.sum file contains the cryptographic checksums representing the content of the required packages.

5. *go mod download* is used to download the exact versions of all the packages that your project needs.

6. *go mod verify* is to ensure that nothing in those downloaded packages has been changed unexpectedly.

7. To upgrade to latest available minor or patch release of a package, you can simply run *go get* with the -u flag.

8. *go mod tidy*, which will automatically remove any unused packages from your go.mod and go.sum files.



### Templating



1. {{template}} action is used to invoke one template from another. But Go also provides a {{block}}...{{end}} action which you can use instead.



### File Server



1. Go has built-in *http.FileServer* handler which you can use to serve files over HTTP from a specific dir.

2. It sanitizes all request paths by running them through the *path.Clean()* function before searching for a file.

3. Range requests are fully supported. This is great if your application is serving large files and you want to support resumable downloads.

4. The Last-Modified and If-Modified-Since headers are supported.



### Dependency Injection



1. Most web apps will have multiple dependencies that their handlers need to access (db conn, centralized err handlers...). How can we make any dependency available to our handlers?



i.  use global vars (❌)

ii. inject dependencies (✅).



For apps where all handlers are in the same package, a neat way to inject deps is to put them into a custom *application* struct, and then define your handler functions as methods against *application*.



### Mysql Database Driver



1. The sql.Open() function returns a sql.DB object. This isnʼt a database connection — itʼs a pool of many connections.

2. The connection pool is safe for concurrent access.

3. The connection pool is intended to be long-lived.

4. The sql.Open() function doesnʼt actually create any connections, all it does is initialize the pool for future use.

5. You can think of a Database model as a service layer or a data access layer.



### Queries

1. DB.Query() is used for SELECT queries which return multiple rows.

2. DB.QueryRow() is used for SELECT queries which return a single row.

3. DB.Exec() is used for statements which donʼt return rows (like INSERT and DELETE).



### Transactions

1. Itʼs important to realize that calls to Exec(), Query() and QueryRow() can use any connection from the sql.DB pool. Even if you have two calls to Exec() immediately next to each other in your code, there is no guarantee that they will use the same database connection.

2. Sometimes this isnʼt acceptable. For instance, if you lock a table with MySQLʼs LOCK TABLES command you must call UNLOCK TABLES on exactly the same connection to avoid a deadlock.

3. To guarantee that the same connection is used you can wrap multiple statements in a transaction.